← Back to plugin index

Legacy Email OTP Authentication Step

Description

Configuration for an authentication flow step to check an OTP sent via email.

Note: Emails are neither confidential nor authentic (i.e. the user cannot be sure that the email is really from Airlock IAM and Airlock IAM cannot be sure that the email is delivered to the correct user). Therefore, this step must not be used for high-security applications.

Type name
LegacyEmailOtpAuthenticationStep
Class
com.airlock.iam.authentication.application.configuration.emailotp.LegacyEmailOtpAuthenticationStepConfig
May be used by
Properties
Email Service (emailService)
Description
Email service plugin. This defines what mail server is used for sending the email. It also defines the sender address and whether the email should be signed or not.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Message Template (messageTemplate)
Description
Message template used to create the message text sent to the user.

The string $TOKEN$ in the message template is mandatory and is replaced by the generated OTP.

If the message text is in HTML code, enable the property "Message Template Is HTML".

Attributes
String
Optional
Multi-line-text
Default value
$TOKEN$
Example
Authentication Code

In order to access our services, please provide the following security code: $TOKEN$

Best Regards,
Your Airlock IAM Server
Message Template Is HTML (messageTemplateIsHtml)
Description
Enable if the message template is HTML code.
Attributes
Boolean
Optional
Default value
true
Email Subject (emailSubject)
Description
The subject used in the email.
Attributes
String
Mandatory
Example
Security Code for Login
Ignore Case (ignoreCase)
Description
If enabled, the case of characters is ignored when checking OTPs.
Attributes
Boolean
Optional
Default value
false
Credential Persister (credentialPersister)
Description
Credential persister to load the email address of the user.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Masking Settings (maskingSettings)
Description
Settings for masking the email address in the REST API responses. Please refer to the REST API documentation for further details.

If left empty, the email address will not be masked.

Attributes
Plugin-Link
Optional
Assignable plugins
OTP Generator (otpGenerator)
Description
The string generator plugin to generate the OTP.
Attributes
Plugin-Link
Optional
Assignable plugins
OTP Validity [seconds] (otpValiditySeconds)
Description
The number of seconds for which an OTP is valid. If the OTP is entered correctly but after its expiration, authentication will fail. (TOKEN_EXPIRED).

The value 0 (zero) disables this feature, i.e. OTPs never expire (this is the default).

Attributes
Integer
Optional
Default value
0
Max Retries (maxRetries)
Description
The number of times the user may enter a wrong OTP before the authentication process is aborted. If set to zero (the default), only one attempt is possible. This is more secure but less user-friendly.
Attributes
Integer
Optional
Default value
0
Authentication Method ID (authenticationMethodId)
Description
The identifier of the authentication method for this step. Since the authentication method is also the identifier for failed login attempts for this step, distinct identifiers must be chosen if multiple instances of the same step type are used to check different credentials (e.g., two password step instances check two different passwords).

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.

Attributes
String
Optional
Length <= 23
Default value
EMAIL
Interactive Goto Targets (interactiveGotoTargets)
Description
Manually selectable Goto targets. These are steps to which the user can chose to jump when this is the current flow step.
Attributes
Plugin-List
Optional
Assignable plugins
Dynamic Step Activations (dynamicStepActivations)
Description
Steps that can be dynamically activated while in this step.
Attributes
Plugin-List
Optional
Assignable plugins
Skip Condition (skipCondition)
Description

If this condition is configured and fulfilled, the step is skipped and the flow execution continues with the subsequent step.

Attributes
Plugin-Link
Optional
Assignable plugins
Pre Condition (preCondition)
Description
This step is executed only if the configured pre condition is fulfilled. If the condition is not fulfilled, the step and flow execution fail immediately. The step is not initialized and no step method can be called. If no condition is configured, the behavior is that of a fulfilled pre condition.
Attributes
Plugin-Link
Optional
Assignable plugins
Requires Activation (requiresActivation)
Description
If enabled, this step is only executed if it has been dynamically activated from a previous step. If it has not been activated, the step is skipped (equivalent to when the skip condition is fulfilled).
Attributes
Boolean
Optional
Default value
false
Tags On Success (tagsOnSuccess)
Description
This step grants these tags if it completes successfully.
Attributes
Plugin-List
Optional
Assignable plugins
Step ID (stepId)
Description
ID of this step. This is only needed if this step is the target of a goto action or if this step requires activation.
Attributes
Plugin-Link
Optional
Assignable plugins
On Failure Gotos (onFailureGotos)
Description

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.

Attributes
Plugin-Map
Optional
Assignable plugins
Custom Response Attributes (customResponseAttributes)
Description

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.

Attributes
Plugin-List
Optional
Assignable plugins
YAML Template (with default values)

type: LegacyEmailOtpAuthenticationStep
id: LegacyEmailOtpAuthenticationStep-xxxxxx
displayName: 
comment: 
properties:
  authenticationMethodId: EMAIL
  credentialPersister:
  customFailureResponseAttributes:
  customResponseAttributes:
  dynamicStepActivations:
  emailService:
  emailSubject:
  ignoreCase: false
  interactiveGotoTargets:
  maskingSettings:
  maxRetries: 0
  messageTemplate: $TOKEN$
  messageTemplateIsHtml: true
  onFailureGotos:
  otpGenerator:
  otpValiditySeconds: 0
  preCondition:
  requiresActivation: false
  skipCondition:
  stepId:
  tagsOnSuccess: