1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
=encoding utf8
=head1 NAME
Pass::OTP - Perl implementation of HOTP / TOTP algorithms
=head1 SYNOPSIS
use Pass::OTP qw(otp);
use Pass::OTP::URI qw(parse);
my $uri = "otpauth://totp/ACME:john.doe@email.com?secret=HXDMVJECJJWSRB3HWIZR4IFUGFTMXBOZ&issuer=ACME&digits=6";
my $otp_code = otp(parse($uri));
=head1 DESCRIPTION
The C<Pass::OTP> module provides implementation of HOTP and TOTP algorithms according to the RFC 4226 and RFC 6238.
=head1 FUNCTIONS
=over 4
=item hotp(%options)
Computes HMAC-based One-time Password (RFC 4226).
HOTP(K,C) = Truncate(HMAC-SHA-1(K,C))
Step 1: Generate an HMAC-SHA-1 value
Let HS = HMAC-SHA-1(K,C)
Step 2: Generate a 4-byte string (Dynamic Truncation)
Let Sbits = DT(HS)
Step 3: Compute an HOTP value
Let Snum = StToNum(Sbits) # Convert S to a number in 0..2^{31}-1
Return D = Snum mod 10^Digit # D us a number in the range 0..10^{Digit}-1
=item totp(%options)
Computes Time-based One-time Password (RFC 6238).
TOTP = HOTP(K,T)
T = (Current Unix time - T0) / X
=item otp(%options)
Convenience wrapper which calls totp/hotp according to options.
=back
=head1 SEE ALSO
L<Digest::HMAC>
L<oathtool(1)>
RFC 4226
RFC 6238
L<https://github.com/google/google-authenticator/wiki/Key-Uri-Format>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2024 Jan Baier
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See L<http://dev.perl.org/licenses/> for more information.
|
