io.github.eendroroy.kotp.config.TOTPConfig.kt Maven / Gradle / Ivy

Go to download
package io.github.eendroroy.kotp.config

import io.github.eendroroy.kotp.Algorithm
import io.github.eendroroy.kotp.exception.RadixValueOutOfRange

/**
 * TOTP Configurations
 *
 * @param secret    [Secret]
 * @param issuer    name of the issuer
 * @param length    length of the otp, default: 6
 * @param interval  interval in seconds to generate new OTP, default: 30
 * @param algorithm algorithm to use, default: [Algorithm.SHA1]
 * @param radix     radix/base of the OTP value, default: 10 (decimal)
 *
 * @author indrajit
 *
 * @since 1.0.1
 */
data class TOTPConfig(
    val secret: Secret,
    val issuer: String,
    val length: Int = 6,
    val interval: Int = 30,
    val algorithm: Algorithm = Algorithm.SHA1,
    val radix: Int = 10
) {
    init {
        RadixValueOutOfRange.passOrThrow(radix)
    }

    /**
     * @param secret    plain secret string
     * @param issuer    name of the issuer
     * @param length    length of the otp, default: 6
     * @param interval  interval in seconds to generate new OTP, default: 30
     * @param algorithm algorithm to use, default: [Algorithm.SHA1]
     * @param radix     radix/base of the OTP value, default: 10 (decimal)
     *
     * @author indrajit
     *
     * @since 0.1.2
     */
    constructor(
        secret: String,
        issuer: String,
        length: Int = 6,
        interval: Int = 30,
        algorithm: Algorithm = Algorithm.SHA1,
        radix: Int = 10
    ) : this(Secret(secret), issuer, length, interval, algorithm, radix)
}