kotlin-onetimepassword/dev.turingcomplete.kotlinonetimepassword

Package dev.turingcomplete.kotlinonetimepassword

Types

class GoogleAuthenticator(base32secret: ByteArray)

This class is a decorator of the TimeBasedOneTimePasswordGenerator that provides the default values used by the Google Authenticator:

HmacAlgorithm

enum HmacAlgorithm : Enum<HmacAlgorithm>

Available "keyed-hash message authentication code" (HMAC) algorithms. See: https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#Mac

HmacOneTimePasswordConfig

open class HmacOneTimePasswordConfig(val codeDigits: Int, val hmacAlgorithm: HmacAlgorithm)

The configuration for the HmacOneTimePasswordGenerator.

HmacOneTimePasswordGenerator

open class HmacOneTimePasswordGenerator(secret: ByteArray, config: HmacOneTimePasswordConfig)

Generator for the RFC 4226 "HOTP: An HMAC-Based One-Time Password Algorithm" (https://tools.ietf.org/html/rfc4226)

OtpAuthUriBuilder

open class OtpAuthUriBuilder<S : OtpAuthUriBuilder<S>>( type: String, base32Secret: ByteArray, removePaddingFromBase32Secret: Boolean = true, charset: Charset = StandardCharsets.UTF_8)

A builder to create an OTP Auth URI as defined in Key Uri Format. This URI contains all necessary information for a TOTP/HOTP client to set up the code generation.

RandomSecretGenerator

class RandomSecretGenerator

Generator to create a secure random secret via SecureRandom.

TimeBasedOneTimePasswordConfig

open class TimeBasedOneTimePasswordConfig( val timeStep: Long, val timeStepUnit: TimeUnit, val codeDigits: Int, val hmacAlgorithm: HmacAlgorithm) : HmacOneTimePasswordConfig

The configuration for the TimeBasedOneTimePasswordGenerator.

TimeBasedOneTimePasswordGenerator

open class TimeBasedOneTimePasswordGenerator(secret: ByteArray, config: TimeBasedOneTimePasswordConfig)

Generator for the RFC 6238 "TOTP: Time-Based One-Time Password Algorithm" (https://tools.ietf.org/html/rfc6238)