SecureBlackbox 2020 macOS Edition

Questions / Feedback?

OTPClient Module

Properties   Methods   Events   Configuration Settings   Errors  

The OTPClient component generates one-time passwords.

Syntax

nsoftware.SecureBlackbox.Otpclient

Remarks

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 OTPClient class can generate HMAC-Based One-Time Passwords (HOTP) and Time-Based One-Time Passwords (TOTP), in accordance with Requests For Comments RFC 4226 and RFC 6238.

Property List


The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

KeySecretThe OTP key secret.
PasswordLengthSpecifies the length of the password to generate.

Method List


The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
GenerateHOTPPasswordGenerates a new hash-based one-time password.
GenerateTOTPPasswordGenerates a new time-based one-time password.

Event List


The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

ErrorReports errors during one-time password (OTP) generation.
NotificationThis event notifies the application about an underlying control flow event.

Configuration Settings


The following is a list of configuration settings for the module with short descriptions. Click on the links for further details.

BaseTime.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client components should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 macOS Edition - Version 20.0 [Build 8165]