The OTPServer component checks the validity of one-time passwords.
A One-Time Password (OTP) is a password that is valid for only one session or transaction. OTPs were designed to overcome the weaknesses of traditional static passwords such as vulnerability to replay attacks. The OTPServer component can check the validity of HMAC-Based One-Time Passwords (HOTP) and Time-Based One-Time Passwords (TOTP).
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
|Config||Sets or retrieves a configuration setting.|
|DoAction||Performs an additional action.|
|IsHOTPPasswordValid||Validates a hash-based one-time password.|
|IsPasswordValid||Validates an OTP password for a user.|
|IsTOTPPasswordValid||Validates a time-based one-time password.|
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
|Error||Information about errors during one-time password (OTP) processing.|
|Notification||This event notifies the application about an underlying control flow event.|
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
|CheckKeyIntegrityBeforeUse||Enables or disable private key integrity check before use.|
|CookieCaching||Specifies whether a cookie cache should be used for HTTP(S) transports.|
|Cookies||Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).|
|DefDeriveKeyIterations||Specifies the default key derivation algorithm iteration count.|
|EnableClientSideSSLFFDHE||Enables or disables finite field DHE key exchange support in TLS clients.|
|GlobalCookies||Gets or sets global cookies for all the HTTP transports.|
|HttpUserAgent||Specifies the user agent name to be used by all HTTP clients.|
|LogDestination||Specifies the debug log destination.|
|LogDetails||Specifies the debug log details to dump.|
|LogFile||Specifies the debug log filename.|
|LogFilters||Specifies the debug log filters.|
|LogFlushMode||Specifies the log flush mode.|
|LogLevel||Specifies the debug log level.|
|LogMaxEventCount||Specifies the maximum number of events to cache before further action is taken.|
|LogRotationMode||Specifies the log rotation mode.|
|MaxASN1BufferLength||Specifies the maximal allowed length for ASN.1 primitive tag data.|
|MaxASN1TreeDepth||Specifies the maximal depth for processed ASN.1 trees.|
|OCSPHashAlgorithm||Specifies the hash algorithm to be used to identify certificates in OCSP requests.|
|StaticDNS||Specifies whether static DNS rules should be used.|
|StaticIPAddress[domain]||Gets or sets an IP address for the specified domain name.|
|StaticIPAddresses||Gets or sets all the static DNS rules.|
|Tag||Allows to store any custom data.|
|TLSSessionGroup||Specifies the group name of TLS sessions to be used for session resumption.|
|TLSSessionLifetime||Specifies lifetime in seconds of the cached TLS session.|
|TLSSessionPurgeInterval||Specifies how often the session cache should remove the expired TLS sessions.|
|UseOwnDNSResolver||Specifies whether the client components should use own DNS resolver.|
|UseSharedSystemStorages||Specifies whether the validation engine should use a global per-process copy of the system certificate stores.|
|UseSystemOAEPAndPSS||Enforces or disables the use of system-driven RSA OAEP and PSS computations.|
|UseSystemRandom||Enables or disables the use of the OS PRNG.|
FIPSMode Property (OTPServer Component)
property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;
This property is reserved for future use.
Users Property (OTPServer Component)
A database of users containing all the per-user password settings.
property Users: TsbxUserAccountList read get_Users write set_Users;
Use this property to provide a list of known users to the OTP server.
This property is not available at design time.Please refer to the UserAccount type for a complete list of fields.
Config Method (OTPServer Component)
Sets or retrieves a configuration setting.
function Config(ConfigurationString: String): String;
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
DoAction Method (OTPServer Component)
Performs an additional action.
function DoAction(ActionID: String; ActionParams: String): String;
DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insencitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
IsHOTPPasswordValid Method (OTPServer Component)
Validates a hash-based one-time password.
function IsHOTPPasswordValid(KeySecret: TBytes; PasswordLength: Integer; Counter: Integer; Password: String): Boolean;
Use this method to validate a hash-based one-time password (HOTP) by using explicit HOTP parameters. For this method to work, no user details need to be provided in Users collection.
IsPasswordValid Method (OTPServer Component)
Validates an OTP password for a user.
function IsPasswordValid(Username: String; Password: String): Boolean;
Use this method to check a one-time Password for a user specified by UserID. The known users' details need to be provided in Users list.
IsTOTPPasswordValid Method (OTPServer Component)
Validates a time-based one-time password.
function IsTOTPPasswordValid(KeySecret: TBytes; PasswordLength: Integer; TimeInterval: Integer; HashAlgorithm: String; Password: String): Boolean;
Use this method to validate a time-based one-time password (TOTP) by using explicit TOTP parameters. For this method to work, no user details need to be provided in Users collection.
Supported hash algorithms:
Error Event (OTPServer Component)
Information about errors during one-time password (OTP) processing.
type TErrorEvent = procedure ( Sender: TObject; ErrorCode: Integer; const Description: String ) of Object;
property OnError: TErrorEvent read FOnError write FOnError;
This event is fired in case of exceptional conditions during OTP checks.
ErrorCode contains an error code and Description contains a textual description of the error.
Notification Event (OTPServer Component)
This event notifies the application about an underlying control flow event.
type TNotificationEvent = procedure ( Sender: TObject; const EventID: String; const EventParam: String ) of Object;
property OnNotification: TNotificationEvent read FOnNotification write FOnNotification;
The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
A container for user account information.
UserAccount objects are used to store user account information, such as logins and passwords.
Creates a new UserAccount object.
Config Settings (OTPServer Component)The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
OTPServer Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
|systemlog||System Log (supported for Android only)|
|debugger||Debugger (supported for VCL for Windows and .Net)|
Supported values are:
Supported filter names are:
|exclude-package||Exclude a package specified in the value|
|exclude-module||Exclude a module specified in the value|
|exclude-class||Exclude a class specified in the value|
|exclude-method||Exclude a method specified in the value|
|include-package||Include a package specified in the value|
|include-module||Include a module specified in the value|
|include-class||Include a class specified in the value|
|include-method||Include a method specified in the value|
|none||No flush (caching only)|
|immediate||Immediate flush (real-time logging)|
|maxcount||Flush cached entries upon reaching LogMaxEventCount entries in the cache.|
Supported values are:
|none||None (by default)|
|fatal||Severe errors that cause premature termination.|
|error||Other runtime errors or unexpected conditions.|
|warning||Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".|
|info||Interesting runtime events (startup/shutdown).|
|debug||Detailed information on flow of through the system.|
|trace||More detailed information.|
The default value of this setting is 100.
|deleteolder||Delete older entries from the cache upon reaching LogMaxEventCount|
|keepolder||Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)|
Supported values are:
|none||No static DNS rules (default)|
|local||Local static DNS rules|
|global||Global static DNS rules|
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (OTPServer Component)
|1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER)|
|1048578 Component is configured incorrectly (SB_ERROR_INVALID_SETUP)|
|1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)|
|1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)|
|1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)|
|1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)|
|25165825 User not found (SB_ERROR_OTP_USER_NOT_FOUND)|