dev.turingcomplete.kotlinonetimepassword.GoogleAuthenticator.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

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.

The newest version!

package dev.turingcomplete.kotlinonetimepassword

import org.apache.commons.codec.binary.Base32
import java.util.*
import java.util.concurrent.TimeUnit

/**
 * This class is a decorator of the [TimeBasedOneTimePasswordGenerator] that
 * provides the default values used by the Google Authenticator:
 * - HMAC algorithm: SHA1;
 * - time step: 30 seconds;
 * - and code digits: 6.
 *
 * @param base32secret the shared Base32-encoded-encoded secret.
 */
class GoogleAuthenticator(private val base32secret: ByteArray) {
  // -- Companion Object -------------------------------------------------------------------------------------------- //

  companion object {
    /**
     * Generates a 16-byte secret as a Base32-encoded string.
     *
     * Due to the overhead of 160% of the Base32 encoding, only 10 bytes are
     * needed for the random secret to generate a 16-byte array.
     */
    @Deprecated("Use ByteArray representation",
                replaceWith = ReplaceWith("createRandomSecretAsByteArray()"))
    fun createRandomSecret(): String {
      val randomSecret = RandomSecretGenerator().createRandomSecret(10)
      return Base32().encodeAsString(randomSecret)
    }

    /**
     * Generates a 16-byte secret as a Base32-encoded [ByteArray].
     *
     * Due to the overhead of 160% of the Base32 encoding, only 10 bytes are
     * needed for the random secret to generate a 16-byte array.
     */
    fun createRandomSecretAsByteArray(): ByteArray {
      val randomSecret = RandomSecretGenerator().createRandomSecret(10)
      return Base32().encode(randomSecret)
    }

    val CONFIG = TimeBasedOneTimePasswordConfig(30, TimeUnit.SECONDS, 6, HmacAlgorithm.SHA1)
  }

  // -- Properties -------------------------------------------------------------------------------------------------- //

  private val timeBasedOneTimePasswordGenerator: TimeBasedOneTimePasswordGenerator

  // -- Initialization ---------------------------------------------------------------------------------------------- //

  init {
    timeBasedOneTimePasswordGenerator = TimeBasedOneTimePasswordGenerator(Base32().decode(base32secret), CONFIG)
  }

  @Deprecated("Use ByteArray representation",
              replaceWith = ReplaceWith("GoogleAuthenticator(ByteArray)"))
  constructor(base32secret: String) : this(base32secret.toByteArray())

  // -- Exposed Methods --------------------------------------------------------------------------------------------- //

  /**
   * Generates a code as a TOTP one-time password.
   *
   * @param timestamp the challenge for the code. The default value is the
   *                  current system time from [System.currentTimeMillis].
   */
  fun generate(timestamp: Date = Date(System.currentTimeMillis())): String {
    return timeBasedOneTimePasswordGenerator.generate(timestamp)
  }

  /**
   * Validates the given code.
   *
   * @param code the code calculated from the challenge to validate.
   * @param timestamp the used challenge for the code. The default value is the
   *                  current system time from [System.currentTimeMillis].
   */
  fun isValid(code: String, timestamp: Date = Date(System.currentTimeMillis())): Boolean {
    return code == generate(timestamp)
  }

  /**
   * Creates an [OtpAuthUriBuilder], which pre-configured with the secret, as
   * well as the fixed Google authenticator configuration for the algorithm,
   * code digits and time step.
   */
  fun otpAuthUriBuilder(): OtpAuthUriBuilder.Totp = timeBasedOneTimePasswordGenerator.otpAuthUriBuilder()

  // -- Private Methods --------------------------------------------------------------------------------------------- //
  // -- Inner Type -------------------------------------------------------------------------------------------------- //
}