Installation¶

Installing otpauth is simple with pip:

$ pip install otpauth

or, with easy_install:

$ easy_install otpauth

Usage¶

Generate and validate an otp code is very simple:

>>> from otpauth import OtpAuth
>>> auth = OtpAuth('secret')  # a secret string
>>> auth.hotp()  # generate a count based code, default count is 4
330810
>>> auth.valid_hotp(330810)
4
>>> auth.hotp(2)  # generate a count based code, count is 2
720111
>>> auth.valid_hotp(720111)
2
>>> auth.totp()  # generate a time based code
828657
>>> auth.valid_totp(828657)
True

Authenticator¶

You can create a QR code for Google Authenticator to scan:

>>> from otpauth import OtpAuth
>>> auth = OtpAuth('secret')  # a secret string
>>> s = auth.to_uri('totp', 'Example:foo@bar.baz', 'Foo')
>>> import qrcode
>>> img = qrcode.make(s)

Developer Guide¶

Here is the API reference for otpauth.

class otpauth. OtpAuth ( secret ) ¶

One Time Password Authentication.

Parameters:	secret – A secret token for the authentication.

hotp ( counter=4 ) ¶

Generate a HOTP code.

Parameters:	counter – HOTP is a counter based algorithm.

to_google ( type, label, issuer, counter=None ) ¶

Generate the otpauth protocal string for Google Authenticator.

Deprecated since version 0.2.0: Use to_uri() instead.

to_uri ( type, label, issuer, counter=None ) ¶

Generate the otpauth protocal string.

Parameters:	type – Algorithm type, hotp or totp. label – Label of the identifier. issuer – The company, the organization or something else. counter – Counter of the HOTP algorithm.

totp ( period=30, timestamp=None ) ¶

Generate a TOTP code.

A TOTP code is an extension of HOTP algorithm.

Parameters:	period – A period that a TOTP code is valid in seconds timestamp – Create TOTP at this given timestamp

valid_hotp ( code, last=0, trials=100 ) ¶

Valid a HOTP code.

Parameters:	code – A number that is less than 6 characters. last – Guess HOTP code from last + 1 range. trials – Guest HOTP code end at last + trials + 1.

valid_totp ( code, period=30, timestamp=None ) ¶

Valid a TOTP code.

Parameters:	code – A number that is less than 6 characters. period – A period that a TOTP code is valid in seconds timestamp – Validate TOTP at this given timestamp

otpauth. generate_hotp ( secret, counter=4 ) ¶

Generate a HOTP code.

Parameters:	secret – A secret token for the authentication. counter – HOTP is a counter based algorithm.

otpauth. generate_totp ( secret, period=30, timestamp=None ) ¶

Generate a TOTP code.

A TOTP code is an extension of HOTP algorithm.

Parameters:	secret – A secret token for the authentication. period – A period that a TOTP code is valid in seconds timestamp – Current time stamp.

Changelog¶

Here is the full history of otpauth.