dev.turingcomplete.kotlinonetimepassword.HmacOneTimePasswordConfig.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-onetimepassword Show documentation
Show all versions of kotlin-onetimepassword Show documentation
A Kotlin one-time password library to generate "Google Authenticator", "Time-based One-time Password" (TOTP) and "HMAC-based One-time Password" (HOTP) codes based on RFC 4226 and 6238.
package dev.turingcomplete.kotlinonetimepassword
/**
* The configuration for the [HmacOneTimePasswordGenerator].
*
* @property codeDigits the length of the generated code. The RFC 4226 requires
* a code digits value between 6 and 8, to assure a good
* security trade-off. However, this library does not set
* any requirement for this property. But notice that through
* the design of the algorithm the maximum code value is
* 2,147,483,647. Which means that a larger code digits value
* than 10 just adds more trailing zeros to the code (and in
* case of 10 digits the first number is always 0, 1 or 2).
*
* @property hmacAlgorithm the "keyed-hash message authentication code" algorithm
* to use to generate the hash, from which the code is
* extracted (see [HmacAlgorithm] for available algorithms).
*/
open class HmacOneTimePasswordConfig(var codeDigits: Int, var hmacAlgorithm: HmacAlgorithm)