Authen::OATH(3pm)

🌸 NAME 🌸

Bestie, meet Authen::OATH(3pm) — from the User Contributed Perl Documentation, and it's all about OATH One Time Passwords. Iconic. 😌✨

✨ VERSION ✨

This one is version 2.0.1 — fresh-ish, cute, and ready, periodt. 💖

---

🦋 SYNOPSIS 🦋

Okay so first vibe check: load it and make an object, lowkey simple:

use Authen::OATH;

my $oath = Authen::OATH->new();
my $totp = $oath->totp( 'MySecretPassword' );
my $hotp = $oath->hotp( 'MyOtherSecretPassword' );

You can also override parameters when creating the new object — slay:

my $oath = Authen::OATH->new( digits => 8 );

The three parameters are digits, digest, and timestep — and timestep only applies to the totp() function. iykyk 💅

While strictly speaking this is outside the specifications of HOTP and TOTP, you can specify digests other than SHA1. For example:

my $oath = Authen::OATH->new(
    digits => 10,
    digest => 'Digest::MD6',
);

If you are using Google Authenticator, you'll want to decode your secret before passing it to the totp method. Do the little dance first:

use Convert::Base32 qw( decode_base32 );

my $oath = Authen::OATH->new;
my $secret = 'mySecret';
my $otp = $oath->totp(  decode_base32( $secret ) );

---

🌈 DESCRIPTION 🌈

Implementation of the HOTP and TOTP One Time Password algorithms as defined by OATH (http://www.openauthentication.org). No cap.

All necessary parameters are set by default, though these can be overridden. Both totp() and htop() — yep, that is exactly how that line is spelled on the page, don't @ me — have passed all of the test vectors defined in the RFC documents for TOTP and HOTP. Tested and blessed. ✅

totp() and hotp() both default to returning 6 digits and using SHA1. As such, both can be called by passing only the secret key and a valid OTP will be returned. One argument, valid OTP, main character energy. 👑

---

💅 SUBROUTINES/METHODS 💅

🔥 totp

my $otp = $oath->totp( $secret [, $manual_time ] );

Manual time is an optional parameter. If it is not passed, the current time is used. This is useful for testing purposes. Highkey perfect for time-travel testing, bestie. 🕰️

🔥 hotp

my $opt = $oath->hotp( $secret, $counter );

Both parameters are required. No skipping, no vibes-only calls. 😤

🔥 _process

This is an internal routine and is never called directly. Hands off the secret sauce. 🙈

---

🎀 CAVEATS 🎀

Please see the SYNOPSIS for how interaction with Google Authenticator. That's literally the whole caveat, bestie. 🫶

---

🌸 AUTHOR 🌸

Kurt Kincaid <kurt.kincaid@gmail.com> — the author, the icon, the legend. 👑

---

💜 COPYRIGHT AND LICENSE 💜

This software is copyright (c) 2010-2017 by Kurt Kincaid.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

---

Okay that's the whole page. It's Authen::OATH(3pm), from perl v5.34.0, dated 2022-06-08. Stay iconic, bye bestie! 💅✨