← Back to plugin index

SSI Passwordless Authentication Step

Description
The SSI passwordless authentication step identifies the user and stores all verified attributes in the flow session, from which they can be read using the 'SSI Verification Data Provider'.

The authentication step, passwordless authentication step, and verification step all use the same UI. If translations need to differentiate between them, use customization with the design kit.

This feature is incubating. Please consult the documentation for more information.

Type name
SsiPasswordlessAuthenticationStep
Class
com.airlock.iam.ssi.application.configuration.step.SsiPasswordlessAuthenticationStepConfig
May be used by
Properties
Service (service)
Description
The SSI service to be used by this step.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Proof Schema Name (proofSchemaName)
Description

Restricts credential to this proof schema name.

This schema name must exist on the configured service. The proof schema defines which attributes are requested from the user, see Procivis Documentation for more information.

Attributes
String
Mandatory
Example
Airlock Customer
Credential Schema Name (credentialSchemaName)
Description
Name of the credential schema from which to extract the username attribute.
Attributes
String
Mandatory
Example
Person with Age Check
Trusted Issuers (trustedIssuers)
Description
Restricts credential to these issuer DIDs. If left empty, a credential is accepted from any issuer.
Attributes
String-List
Optional
User Name Attribute (userNameAttribute)
Description
Attribute in the schema which identifies the user. The received attribute value can be transformed to a User ID with the username transformers configured for the authentication flow.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Username Transformation (usernameTransformers)
Description
Transforms the username obtained from the verifiable credential. The transformation precedes the flow's Username Transformation. If one of the transformers configured here interrupts the transformation chain, username transformations in the authentication flow's configuration will be skipped.
Attributes
Plugin-List
Optional
Assignable plugins
Additional Claims (additionalClaims)
Description
The list of additional claims to be requested from the holder. Each item in the list specifies the attributes and predicates to be obtained from a single verifiable credential.
Attributes
Plugin-List
Optional
Assignable plugins
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
SSI
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: SsiPasswordlessAuthenticationStep
id: SsiPasswordlessAuthenticationStep-xxxxxx
displayName: 
comment: 
properties:
  additionalClaims:
  authenticationMethodId: SSI
  credentialSchemaName:
  customFailureResponseAttributes:
  customResponseAttributes:
  dynamicStepActivations:
  interactiveGotoTargets:
  onFailureGotos:
  preCondition:
  proofSchemaName:
  requiresActivation: false
  service:
  skipCondition:
  stepId:
  tagsOnSuccess:
  trustedIssuers:
  userNameAttribute:
  usernameTransformers: