kotlin-onetimepassword/dev.turingcomplete.kotlinonetimepassword/TimeBasedOneTimePasswordGenerator

TimeBasedOneTimePasswordGenerator

open class TimeBasedOneTimePasswordGenerator(secret: ByteArray, config: TimeBasedOneTimePasswordConfig)
Content copied to clipboard

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

Constructors

Link copied to clipboard
fun TimeBasedOneTimePasswordGenerator(secret: ByteArray, config: TimeBasedOneTimePasswordConfig)
Content copied to clipboard

Functions

Link copied to clipboard
fun counter(instant: Instant): Long
Content copied to clipboard
fun counter(date: Date): Long
Content copied to clipboard

Convenience method for counter.

fun counter(timestamp: Long = System.currentTimeMillis()): Long
Content copied to clipboard

Calculate the current time slot.

Link copied to clipboard
fun generate(instant: Instant): String
Content copied to clipboard
fun generate(date: Date): String
Content copied to clipboard

Convenience method for generate.

fun generate(timestamp: Long = System.currentTimeMillis()): String
Content copied to clipboard

Generates a code representing the time-based one-time password.

Link copied to clipboard
fun isValid(code: String, instant: Instant): Boolean
Content copied to clipboard
fun isValid(code: String, date: Date): Boolean
Content copied to clipboard

Convenience method for isValid.

fun isValid(code: String, timestamp: Long = System.currentTimeMillis()): Boolean
Content copied to clipboard

Validates the given code.

Link copied to clipboard
fun otpAuthUriBuilder(): OtpAuthUriBuilder.Totp
Content copied to clipboard

Creates an OtpAuthUriBuilder, which pre-configured with the secret, as well as the algorithm, code digits and time step from the config.

Link copied to clipboard
fun timeslotStart(counter: Long): Long
Content copied to clipboard

Calculates the start of the given time slot.