/ 
URI-5.31
River stage five • 1930 direct dependents • 10412 total dependents
/ URI::otpauth

NAME

URI::otpauth - URI scheme for secret keys for OTP secrets. Usually found in QR codes

VERSION

Version 5.29

SYNOPSIS

use URI;

# optauth URI from textual uri
my $uri = URI->new( 'otpauth://totp/Example:[email protected]?secret=NFZS25DINFZV643VOAZXELLTGNRXEM3UH4&issuer=Example' );

# same URI but created from arguments
my $uri = URI::otpauth->new( type => 'totp', issuer => 'Example', account_name => '[email protected]', secret => 'is-this_sup3r-s3cr3t?' );

DESCRIPTION

This URI scheme is defined in https://github.com/google/google-authenticator/wiki/Key-Uri-Format/:

SUBROUTINES/METHODS

new

Create a new URI::otpauth. The available arguments are listed below;

  • account_name - this can be the account name (probably an email address) used when authenticating with this secret. It is an optional field.

  • algorithm - this is the cryptographic hash function that should be used. Current values are SHA1, SHA256 or SHA512. It is an optional field and will default to SHA1.

  • counter - this is only required when the type is HOTP.

  • digits - this determines the length of the code presented to the user. It is an optional field and will default to 6 digits.

  • issuer - this can be the application / system that this secret can be used to authenticate to. It is an optional field.

  • label - this is the issuer and the account name joined with a ":" character. It is an optional field.

  • period - this is the period that the TOTP code is valid for. It is an optional field and will default to 30 seconds.

  • secret - this is the key that the TOTP/HOTP algorithm uses to derive the value. It is an arbitrary byte string and must remain private. This field is mandatory.

  • type - this can be 'hotp' or 'totp'. This field will default to 'totp'.

algorithm

Get or set the algorithm of this otpauth URI.

account_name

Get or set the account_name of this otpauth URI.

counter

Get or set the counter of this otpauth URI.

digits

Get or set the digits of this otpauth URI.

issuer

Get or set the issuer of this otpauth URI.

label

Get or set the label of this otpauth URI.

period

Get or set the period of this otpauth URI.

secret

Get or set the secret of this otpauth URI.

type

Get or set the type of this otpauth URI.

my $type = $uri->type('hotp');

CONFIGURATION AND ENVIRONMENT

URI::otpauth requires no configuration files or environment variables.

DEPENDENCIES

URI

DIAGNOSTICS

secret is a mandatory parameter for URI::otpauth

The secret parameter was not detected for the URI::otpauth->new() method.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

To report a bug, or view the current list of bugs, please visit https://github.com/libwww-perl/URI/issues

AUTHOR

David Dick <[email protected]>

LICENSE AND COPYRIGHT

Copyright (c) 2024, David Dick <[email protected]>.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.