.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Authen::OATH 3pm"
.TH Authen::OATH 3pm "2017-10-23" "perl v5.26.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Authen::OATH \- OATH One Time Passwords
.SH "VERSION"
.IX Header "VERSION"
version 2.0.1
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Authen::OATH;
\&
\&    my $oath = Authen::OATH\->new();
\&    my $totp = $oath\->totp( \*(AqMySecretPassword\*(Aq );
\&    my $hotp = $oath\->hotp( \*(AqMyOtherSecretPassword\*(Aq );
.Ve
.PP
Parameters may be overridden when creating the new object:
.PP
.Vb 1
\&    my $oath = Authen::OATH\->new( digits => 8 );
.Ve
.PP
The three parameters are \*(L"digits\*(R", \*(L"digest\*(R", and \*(L"timestep.\*(R"
Timestep only applies to the \fItotp()\fR function.
.PP
While strictly speaking this is outside the specifications of
\&\s-1HOTP\s0 and \s-1TOTP,\s0 you can specify digests other than \s-1SHA1.\s0 For example:
.PP
.Vb 4
\&    my $oath = Authen::OATH\->new(
\&        digits => 10,
\&        digest => \*(AqDigest::MD6\*(Aq,
\&    );
.Ve
.PP
If you are using Google Authenticator, you'll want to decode your secret
*before* passing it to the \f(CW\*(C`totp\*(C'\fR method:
.PP
.Vb 1
\&    use Convert::Base32 qw( decode_base32 );
\&
\&    my $oath = Authen::OATH\->new;
\&    my $secret = \*(AqmySecret\*(Aq;
\&    my $otp = $oath\->totp(  decode_base32( $secret ) );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Implementation of the \s-1HOTP\s0 and \s-1TOTP\s0 One Time Password algorithms
as defined by \s-1OATH\s0 (http://www.openauthentication.org)
.PP
All necessary parameters are set by default, though these can be
overridden. Both \fItotp()\fR and \fIhtop()\fR have passed all of the test
vectors defined in the \s-1RFC\s0 documents for \s-1TOTP\s0 and \s-1HOTP.\s0
.PP
\&\fItotp()\fR and \fIhotp()\fR both default to returning 6 digits and using \s-1SHA1.\s0
As such, both can be called by passing only the secret key and a
valid \s-1OTP\s0 will be returned.
.SH "SUBROUTINES/METHODS"
.IX Header "SUBROUTINES/METHODS"
.SS "totp"
.IX Subsection "totp"
.Vb 1
\&    my $otp = $oath\->totp( $secret [, $manual_time ] );
.Ve
.PP
Manual time is an optional parameter. If it is not passed, the current
time is used. This is useful for testing purposes.
.SS "hotp"
.IX Subsection "hotp"
.Vb 1
\&    my $opt = $oath\->hotp( $secret, $counter );
.Ve
.PP
Both parameters are required.
.SS "_process"
.IX Subsection "_process"
This is an internal routine and is never called directly.
.SH "CAVEATS"
.IX Header "CAVEATS"
Please see the \s-1SYNOPSIS\s0 for how interaction with Google Authenticator.
.SH "AUTHOR"
.IX Header "AUTHOR"
Kurt Kincaid <kurt.kincaid@gmail.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2010\-2017 by Kurt Kincaid.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.