← Back to plugin index

Token IAK Handler

Description
Handles activation codes (IAK) using a token data provider.
Type name
TokenIakHandler
Class
com.airlock.iam.core.misc.impl.authen.TokenIakHandler
May be used by
Properties
Token Data Provider (tokenDataProvider)
Description
Provider to handle token-related tasks.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Password Hash (passwordHash)
Description
Hash function to hash the IAKs.

NOTE: Some password hashes, such as SHA 256 Password Hash or Scrypt Password Hash, produce binary output. If one of these is used, make sure the persistence layer supports binary data in the hash field and the corresponding persistence plugins (e.g. Database User Store or Ldap Connector) are configured to treat hash values as binary values.
In case the persistence layer expects a string, encode the password hash by wrapping it with an encoder. To achieve this, use the Password Hash Configuration plugin and specify the hash function (such as Scrypt Password Hash) together with the desired encoder. We recommend using the Base64 Password Hash Encoder.

Attributes
Plugin-Link
Mandatory
Assignable plugins
Code Generator (codeGenerator)
Description
Secret string generator to create device activation codes.
Attributes
Plugin-Link
Mandatory
Assignable plugins
Validity Time (validityTime)
Description
The validity time (in hours) of the activation code, i.e. how long the activation code is valid and can be used to activate a new device. If set to 0, the validity time is not limited.
Attributes
Integer
Mandatory
Allowed Failed Attempts (allowedFailedAttempts)
Description

The number of times the user is allowed to enter a wrong activation code.

A value of 0 (zero) means the user has no retries (thus only one attempt).

Attributes
Integer
Mandatory
YAML Template (with default values)

type: TokenIakHandler
id: TokenIakHandler-xxxxxx
displayName: 
comment: 
properties:
  allowedFailedAttempts:
  codeGenerator:
  passwordHash:
  tokenDataProvider:
  validityTime: