GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  AUTHEN::OATH (3)

.ds Aq ’

NAME

Authen::OATH - OATH One Time Passwords

CONTENTS

VERSION

Version 1.0.0

SYNOPSIS

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

All necessary parameters are set by default, though these can be overridden. Both totp() and htop() have passed all of the test vectors defined in the RFC documents for TOTP and HOTP.

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.



    use Authen::OATH;

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



Parameters may be overridden when creating the new object:



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



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

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"
    );



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.

    hotp



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



Both parameters are required.

    _process

This is an internal routine and is never called directly.

AUTHOR

Kurt Kincaid, <kurt.kincaid at gmail.com>

BUGS

Please report any bugs or feature requests to bug-authen-totp at rt.cpan.org, or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Authen-OATH>. I will be notified, and then you’ll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.



    perldoc Authen::OATH



You can also look for information at:
o RT: CPAN’s request tracker

<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Authen-OATH>

o AnnoCPAN: Annotated CPAN documentation

<http://annocpan.org/dist/Authen-OATH>

o CPAN Ratings

<http://cpanratings.perl.org/d/Authen-OATH>

o Search CPAN

<http://search.cpan.org/dist/Authen-OATH/>

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2010 Kurt Kincaid.

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 http://dev.perl.org/licenses/ for more information.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 AUTHEN::OATH (3) 2010-05-25

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.