kotlin-onetimepassword/dev.turingcomplete.kotlinonetimepassword/OtpAuthUriBuilder/Totp

Totp

class Totp(base32Secret: ByteArray) : OtpAuthUriBuilder<OtpAuthUriBuilder.Totp>

A builder for a TOTP OTP Auth URI.

An instance should be created via forTotp or TimeBasedOneTimePasswordGenerator.otpAuthUriBuilder.

Constructors

fun Totp(base32Secret: ByteArray)

Functions

fun algorithm(algorithm: HmacAlgorithm): OtpAuthUriBuilder.Totp

Sets the algorithm query parameter, which is the uppercase name of the HMAC algorithms defined in HmacAlgorithm.

buildToByteArray

fun buildToByteArray(): ByteArray

Builds the final OTP Auth URI as a ByteArray.

fun buildToString(): String

Builds the final OTP Auth URI as a String.

fun buildToUri(): URI

Builds the final OTP Auth URI as a URI.

fun digits(digits: Int): OtpAuthUriBuilder.Totp

Sets the digits query parameter, which is the length of the generated code.

fun issuer(issuer: String): OtpAuthUriBuilder.Totp

Sets the issuer query parameter, which indicates the provider or service the account (for which the OTP code gets used) belongs to.

fun label( accountName: String, issuer: String?, encodeSeparator: Boolean = false): OtpAuthUriBuilder.Totp

Sets the label path part of the URI, which consist of an account name and an optional issuer. Both values will be separated by a colon (:), which can be URL encoded by setting the parameter encodeSeparator.

fun period(timeStep: Long, timeStepUnit: TimeUnit): OtpAuthUriBuilder.Totp

Sets the period query parameter, which defines the validity of a TOTP code in seconds.