kotp
0.0.2indexedOTP generator implementing RFC 4226/6238 for HOTP and TOTP, with configurable HMAC algorithm, digit length, secret handling and adjustable time-step for time-based codes.
0
Stars
—
Used by
dependents
—
Health
/ 100
kotp - Kotlin OTP code generator
This project provides a Kotlin Multiplatform library for generating OTP codes.
It is an implementation of the RFC 4226 and the RFC 6238 and provides:
- HMAC-based One-Time Password (HOTP)
- Time-based One-Time Password (TOTP)
The multiplatform library currently supports:
- Linux (x64, ARM64)
- Window (x64 only)
- MacOS (Intel and Apple Silicon)
- Java 8+
- WasmJs (browser, nodejs, d8)
- Javascript (browser, nodejs)
Planned support:
- Android
Table of Contents
Dependency
This library is available on Maven Central:
Gradle
For multiplatform project:
kotlin {
sourceSets {
commonMain.dependencies {
implementation("dev.vicart.kotp:kotp:0.0.2")
}
}
}
For other platforms:
dependencies {
implementation("dev.vicart.kotp:kotp:0.0.2")
}
Maven
pom.xml
<dependency>
<groupId>dev.vicart.kotp</groupId>
<artifactId>kotp</artifactId>
<version>0.0.2</version>
</dependency>
HOTP vs TOTP
HMAC-based One-Time Password (HOTP) and Time-based One-Time Password (TOTP) are two methods of generating one-time passwords. Their goal is to provide a 2FA solution for securing access to sensitive data. Both of them are based on a secret key and a counter and use a HMAC function to generate a unique password. The secret key is usually a Base32-encoded string provided by the server.
HOTP
HOTP uses a 64-bit number as a value for the counter. This counter is aimed to be incremented after each use and must be synchronized between the client and the server.
TOTP
TOTP extends HOTP by using the time as a shared counter between the client and the server.
It can be configured for a code to be valid for a specific time interval (usually 30 seconds). However, a server may check the provided code against the previous and the next time interval for error correction.
Usage
HMAC-based One-Time Password generation
val configuration = HmacOneTimePasswordConfiguration(
secret = <encoded secret>,
digits = 6, //The number of digits in the code
hmacAlgorithm = HmacAlgorithm.SHA1 //The HMAC algorithm to use
)
val generator = HmacOneTimePasswordGenerator(configuration)
val counter = 0
val code = generator.generateCode(counter) //Returns "123456" for example
Time-based One-Time Password generation
val configuration = TimeOneTimePasswordConfiguration(
secret = <encoded secret>,
digits = 6,
hmacAlgorithm = HmacAlgorithm.SHA1,
timeStep = 30.seconds
)
val generator = TimeOneTimePasswordGenerator(configuration)
val code = generator.generateCode() //Returns "123456" for example
Documentation
You can find the documentation here