Matrix Checking Step
tanService) tanListType) - Indexed TAN list: A token list with an index next to each token. The tokens are queried in random order.
- Matrix card: A matrix card with the tokens organized in rows and columns. The tokens are queried in random order.
tokenListRenderer) This property is only required if "TAN List Type" is set to Matrix card.
authenticationMethodId) Example: a system tracks two passwords per user. Password 1 is used in flow A, password 2 in flow B. These two steps must have distinct 'Authentication Method Ids', e.g. PASSWORD1 and PASSWORD2.
If only one identifier (e.g. "PASSWORD") is used, this may allow brute force attacks on the password as follows. Assuming an attacker knows the user's password 1, they get an unlimited number of attempts on flow B, as the 'PASSWORD' counter can repeatedly be reset to 0 by performing a successful login on flow A.To prevent such attacks, use two different counters by setting the authentication methods, for example, to PASSWORD1 and PASSWORD2, respectively.
startIndex) If the "TAN List Type" is not "Indexed TAN list", this property is ignored.
responseValidityMillis) If not set, this feature is disabled, i.e. challenges never expire (this is the default).
maxRetries) The number of times a wrong response can be sent before the flow is aborted. If set to zero (the default), only one attempt is possible.
The purpose of this settings is usability. The failed attempts counter is always increased upon receiving a wrong response and the user is locked when the global failed attempts limit is exceeded.
newChallengeOnRetry) countUnansweredChallenges) If enabled, any pending challenge that is abandoned will be counted as an unanswered challenge. After too many unanswered challenges (see the "Max Unanswered Challenges" property), further attempts will always fail. This prevents an attacker from being able to "wait" for a specific challenge that has been leaked.
Important: This feature requires the properties 'Col Challenge Open Since' and 'Col Unanswered Challenges' on the Token List Persister to be configured, otherwise it will not work properly.
unansweredChallengeTimeout) maxUnansweredChallenges) interactiveGotoTargets) dynamicStepActivations) skipCondition) If this condition is configured and fulfilled, the step is skipped and the flow execution continues with the subsequent step.
preCondition) requiresActivation) tagsOnSuccess) stepId) onFailureGotos) If the step fails (no retry) and a goto target for the error code is defined here, the flow does not fail and instead a "goto" to the specified target step is executed. Note that even when the "goto" is executed, any error codes that are considered a failed factor attempt will still increment the "failed attempts" counter, and may lead to the user being locked. Therefore, this may still result in a failed flow.
A typical application of this feature is switching to an alternative authentication factor step, if an external service (e.g. Futurae server, SMS gateway) is not available (error code EXTERNAL_SERVICE_UNAVAILABLE with "Strict Counting" disabled, which will not increment the "failed attempts" counter). Other error codes can be found in the IAM REST documentation, in both the general "Error Codes" section and in the documentation of specific endpoints.
customResponseAttributes) A list of custom attributes that are returned in the REST response in addition to the standard attributes the step already returns. The custom attributes defined here are only returned if the step result does not lead to an error response.
Custom attributes are added to the response when a step is initialized and when actions are executed on the step. They will therefore be available in the response leading to this step, and in any responses from endpoints specific to this step. For non-interactive steps, custom attributes are accumulated and added to the response leading to the next interactive step.
Custom attributes are not returned for 'retrieve' endpoints.
customFailureResponseAttributes)
type: MatrixAuthStep
id: MatrixAuthStep-xxxxxx
displayName:
comment:
properties:
authenticationMethodId: MATRIX
countUnansweredChallenges: true
customFailureResponseAttributes:
customResponseAttributes:
dynamicStepActivations:
interactiveGotoTargets:
maxRetries: 0
maxUnansweredChallenges: 3
newChallengeOnRetry: true
onFailureGotos:
preCondition:
requiresActivation: false
responseValidityMillis:
skipCondition:
startIndex: 1
stepId:
tagsOnSuccess:
tanListType:
tanService:
tokenListRenderer:
unansweredChallengeTimeout: 12