VisualDreams::Yubikey::online - Yubikey online authentication


VisualDreams-Yubikey-online documentation  | view source Contained in the VisualDreams-Yubikey-online distribution.

Index


NAME

Top

VisualDreams::Yubikey::online - Yubikey online authentication

DESCRIPTION

Top

This module will authenticate with the online Yubico API authentication server and return its results in a HASH. This module is to be implemented in the VisualDreams engine.

VERSION

Top

Version 0.06

SYNOPSIS

Top

  use VisualDreams::Yubikey::online;

  my $yubify = VisualDreams::Yubikey::online->new("ID","Base64 encoded API key");

  my $yubirecord = $yubify->verifyOnline($otp);

  my $url = $yubify->createUrl($otp);
  my $signedurl = $yubify->createSignedUrl($otp);
  my $signUrl = $yubify->signUrl($url);

FUNCTIONS

Top

new

Input : API-ID and API-KEY

Initializes the module to standard API-ID, API-KEY and API-URL. WARNING: Signed messages will automagically work with a valid Base-64 API key!

signUrl

Signs the URL with API-ID, API-KEY and incoming url

Input : url Output : signed base-64 encoded hmac

createUrl

Create standard URL with API-ID and OTP

Input : otp Output : piece of url containing id and otp

createSignedUrl

Create Signed URL with API-ID, API-KEY and OTP

Input : otp Output : piece of url containing id, otp and base-64 hmac signature

verifyOnline

Verify the OTP with the Yubico server

Input : otp Output : record with hmac, status and timestamp

REQUIRES

Top

Perl 5, Digest::HMAC_SHA1, LWP::Simple, MIME::Base64, URI::Escape

SUPPORT

Top

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

    perldoc VisualDreams::Yubikey::online

EXPORT

None by default.

AUTHOR

Top

Gunther Voet, Freaking Wildchild: <oss@xsrv.net> and <gunther.voet@gmail.com>

VisualDreams

Top

Specifically created for the VisualDreams engine. More to come soon!

COPYRIGHT & LICENSE

Top


VisualDreams-Yubikey-online documentation  | view source Contained in the VisualDreams-Yubikey-online distribution.