OATH

Configuration reference for validating TOTP and HOTP credentials with the OathValidation module.

Introduction

The OathValidation module validates a user's one-time passcode against registered TOTP or HOTP tokens. Other modules call its internal service with a user identifier and passcode and receive the validation result.

The legacy alias TokensValidationService is also accepted by the current module.

Configuration

Properties
Example

Name	Description	Default
`namespace`	Namespace shared by the token modules and their event-bus addresses.	`""`
`db_driver`	Fully qualified JDBC driver class name.	`""`
`jdbc.url`	JDBC connection URL for the token database.	`""`
`jdbc.username`	Database user name.	`""`
`jdbc.password`	Database password.	`""`
`encryption_key`	Secret used to initialize encryption for protected token data.	`""`
`totp_max_drift`	Maximum accepted TOTP time-step drift.	`""`
`hotp_max_lookahead`	Maximum number of future HOTP counter values checked during validation.	`""`

{
  "name": "OathValidation",
  "enabled": true,
  "config": {
    "namespace": "default",
    "totp_max_drift": 2,
    "hotp_max_lookahead": 2,
    "db_driver": "com.microsoft.sqlserver.jdbc.SQLServerDriver",
    "jdbc": {
      "url": "jdbc:sqlserver://db.example.com:1433;database=tokens;encrypt=true",
      "username": "tokens",
      "password": "<database password>"
    },
    "encryption_key": "<encryption key>"
  }
}