otp_auth 1.0.0

A Dart package for generating and verifying HOTP and TOTP one-time passwords using RFC 4226 and RFC 6238.

otp_auth

A Dart package for generating and verifying HOTP and TOTP one-time passwords using RFC 4226 and RFC 6238.

Quick start

dependencies:
  otp_auth: ^1.0.0

import 'package:otp_auth/otp_auth.dart';

final totp = TOTP(secret: 'JBSWY3DPEHPK3PXP');
print(totp.now());              // '492039'
print(TOTP.format(totp.now())); // '492 039'
print(totp.remaining);          // seconds until expiry
print(totp.verify('492039'));    // true or false

API

Class	Description
TOTP	Time-based one-time password (RFC 6238). now(), at(DateTime), verify(), remaining, format().
HOTP	Counter-based one-time password (RFC 4226). at(int), verify().
OTPUri	Parses and builds otpauth:// URIs. parse(), extractSecret(), toTOTP(), toHOTP().
Base32	RFC 4648 Base32 codec. encode(), decode().
OTPAlgorithm	sha1, sha256, sha512.

Parameters

TOTP

Parameter	Type	Default	Description
secret	String	required	Base32-encoded shared secret
digits	int	6	Number of digits in the output code
algorithm	OTPAlgorithm	sha1	Hash algorithm
period	int	30	Time step in seconds

HOTP

Parameter	Type	Default	Description
secret	String	required	Base32-encoded shared secret
digits	int	6	Number of digits in the output code
algorithm	OTPAlgorithm	sha1	Hash algorithm

Both TOTP and HOTP accept raw bytes via .fromBytes(secret: Uint8List).

URI parsing

final uri = OTPUri.parse(
  'otpauth://totp/GitHub:[e-mail]?secret=JBSWY3DPEHPK3PXP&issuer=GitHub',
);
print(uri.issuer);  // 'GitHub'
print(uri.account); // '[e-mail]'

final totp = uri.toTOTP();
print(totp.now());

// Extract just the secret from any otpauth:// URI
final secret = OTPUri.extractSecret('otpauth://totp/...?secret=ABC123');

RFC compliance

Standard	Title
RFC 4226	HOTP: An HMAC-Based One-Time Password Algorithm
RFC 6238	TOTP: Time-Based One-Time Password Algorithm
RFC 4648	Base16, Base32, and Base64 Data Encodings

Validated against official test vectors from RFC 4226 Appendix D and RFC 6238 Appendix B.

Requirements

Dart SDK: >=3.0.0

Author

Soroush Yousefpour