@okta/okta-auth-js
Version:
The Okta Auth SDK
225 lines (207 loc) • 7.93 kB
JavaScript
;
exports.remediate = remediate;
var _errors = require("../errors");
var _remediators = require("./remediators");
var _util = require("./util");
/*!
* Copyright (c) 2015-present, Okta, Inc. and/or its affiliates. All rights reserved.
* The Okta software accompanied by this notice is provided pursuant to the Apache License, Version 2.0 (the "License.")
*
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
* See the License for the specific language governing permissions and limitations under the License.
*/
/* eslint-disable max-statements, max-depth, complexity */
function getActionFromValues(values, idxResponse) {
// Currently support resend actions only
return Object.keys(idxResponse.actions).find(action => !!values.resend && action.includes('-resend'));
}
function removeActionFromValues(values) {
// Currently support resend actions only
return {
...values,
resend: undefined
};
}
function removeActionFromOptions(options, actionName) {
let actions = options.actions || [];
actions = actions.filter(entry => {
if (typeof entry === 'string') {
return entry !== actionName;
}
return entry.name !== actionName;
});
return {
...options,
actions
};
}
function getGenericNextStep(authClient, idxResponse, options) {
// If the response contains an interaction code, there is no need to remediate
if (idxResponse.interactionCode) {
return {
idxResponse
};
}
if (options.enableLegacyMode) {
return {
idxResponse
};
}
const gr = new _remediators.GenericRemediator(idxResponse.neededToProceed[0], {}, options);
const nextStep = (0, _util.getNextStep)(authClient, gr, idxResponse);
return {
idxResponse,
nextStep
};
}
// This function is called recursively until it reaches success or cannot be remediated
async function remediate(authClient, idxResponse, values, options) {
let {
neededToProceed,
interactionCode
} = idxResponse;
const {
flow,
useGenericRemediator,
enableLegacyMode
} = options;
// references to the "new" defaut paradigm in v8.x - requires step/actions are provided
const isStepMode = enableLegacyMode !== true;
// If the response contains an interaction code, there is no need to remediate
if (interactionCode) {
return {
idxResponse
};
}
// Do not attempt to remediate if response is in terminal state
if ((0, _util.isTerminalResponse)(idxResponse)) {
return {
idxResponse,
terminal: true
};
}
// Try actions in idxResponse first
const actionFromValues = getActionFromValues(values, idxResponse);
const actionFromOptions = options.actions || [];
const actions = [...actionFromOptions, ...(actionFromValues && [actionFromValues] || [])];
if (actions.length > 0) {
for (let action of actions) {
// Action can either be specified as a string, or as an object with name and optional params
let params = {};
if (typeof action !== 'string') {
params = action.params || {};
action = action.name;
}
let valuesWithoutExecutedAction = removeActionFromValues(values);
let optionsWithoutExecutedAction = removeActionFromOptions(options, action);
if (typeof idxResponse.actions[action] === 'function') {
idxResponse = await idxResponse.actions[action](params);
if (idxResponse.requestDidSucceed === false) {
return (0, _util.handleFailedResponse)(authClient, idxResponse, options);
}
if (action === 'cancel') {
return {
idxResponse,
canceled: true
};
}
// don't recursively call `remediate` in non-legacy mode
if (isStepMode) {
return getGenericNextStep(authClient, idxResponse, options);
}
return remediate(authClient, idxResponse, valuesWithoutExecutedAction, optionsWithoutExecutedAction); // recursive call
}
// search for action in remediation list
const remediationAction = neededToProceed.find(({
name
}) => name === action);
if (remediationAction) {
idxResponse = await idxResponse.proceed(action, params);
if (idxResponse.requestDidSucceed === false) {
return (0, _util.handleFailedResponse)(authClient, idxResponse, options);
}
// don't recursively call `remediate` in non-legacy mode
if (isStepMode) {
return getGenericNextStep(authClient, idxResponse, options);
}
return remediate(authClient, idxResponse, values, optionsWithoutExecutedAction); // recursive call
}
}
// if `actions` were provided and no match was found after full loop iteration
// throw to provide a more specific error
if (isStepMode && !options.step) {
throw new _errors.AuthSdkError('Unable to proceed with provided actions');
}
}
// "non-legacy mode" requires either `actions` or `step` to be provided
// skip this condition if `GenericRemediator` is configured
if (!useGenericRemediator && isStepMode && !options.step) {
throw new _errors.AuthSdkError('No `step` or `action` provided');
}
const remediator = (0, _util.getRemediator)(idxResponse, values, options);
if (!remediator) {
// With options.step, remediator is not required
if (options.step) {
values = (0, _util.filterValuesForRemediation)(idxResponse, options.step, values); // include only requested values
idxResponse = await idxResponse.proceed(options.step, values);
if (idxResponse.requestDidSucceed === false) {
return (0, _util.handleFailedResponse)(authClient, idxResponse, options);
}
return getGenericNextStep(authClient, idxResponse, options);
}
// implied `isStepMode=false` at this point, step cannot be undefined otherwise
// With default flow, remediator is not required
if (flow === 'default') {
return {
idxResponse
};
}
throw new _errors.AuthSdkError(`
No remediation can match current flow, check policy settings in your org.
Remediations: [${neededToProceed.reduce((acc, curr) => acc ? acc + ' ,' + curr.name : curr.name, '')}]
`);
}
// Return next step to the caller
if (!remediator.canRemediate()) {
const nextStep = (0, _util.getNextStep)(authClient, remediator, idxResponse);
return {
idxResponse,
nextStep
};
}
const name = remediator.getName();
const data = remediator.getData();
idxResponse = await idxResponse.proceed(name, data);
if (idxResponse.requestDidSucceed === false) {
return (0, _util.handleFailedResponse)(authClient, idxResponse, options);
}
// do not continue recursively looping if response is terminal
if ((0, _util.isTerminalResponse)(idxResponse)) {
return {
idxResponse,
terminal: true
};
}
// NOTE: useGenericRemediator
// generic remediator should not auto proceed in pending status
// return nextStep directly
// NOTE: enableLegacyMode (via isStepMode)
// "non-legacy mode" should not auto remediate, therefore leverage the
// `GenericRemediator` to determine `nextStep` and return
if (useGenericRemediator || isStepMode) {
return getGenericNextStep(authClient, idxResponse, options);
}
// We may want to trim the values bag for the next remediation
// Let the remediator decide what the values should be (default to current values)
values = remediator.getValuesAfterProceed();
options = {
...options,
step: undefined
}; // do not re-use the step
return remediate(authClient, idxResponse, values, options); // recursive call
}
//# sourceMappingURL=remediate.js.map