# pyotp

> Python One Time Password Library

- **URL**: https://www.freshcrate.ai/projects/pyotp
- **Author**: PyOTP contributors
- **Category**: Security
- **Latest version**: `2.9.0` (2026-04-21)
- **License**: MIT License
- **Source**: https://github.com/pyauth/pyotp/blob/master/Changes.rst
- **Homepage**: https://github.com/pyotp/pyotp
- **Language**: Python
- **GitHub**: 3,295 stars, 350 forks
- **Registry**: pypi (`pyotp`)
- **Tags**: `pypi`

## Description

PyOTP - The Python One-Time Password Library
============================================

PyOTP is a Python library for generating and verifying one-time passwords. It can be used to implement two-factor (2FA)
or multi-factor (MFA) authentication methods in web applications and in other systems that require users to log in.

Open MFA standards are defined in `RFC 4226 <https://tools.ietf.org/html/rfc4226>`_ (HOTP: An HMAC-Based One-Time
Password Algorithm) and in `RFC 6238 <https://tools.ietf.org/html/rfc6238>`_ (TOTP: Time-Based One-Time Password
Algorithm). PyOTP implements server-side support for both of these standards. Client-side support can be enabled by
sending authentication codes to users over SMS or email (HOTP) or, for TOTP, by instructing users to use `Google
Authenticator <https://en.wikipedia.org/wiki/Google_Authenticator>`_, `Authy <https://www.authy.com/>`_, or another
compatible app. Users can set up auth tokens in their apps easily by using their phone camera to scan `otpauth://
<https://github.com/google/google-authenticator/wiki/Key-Uri-Format>`_ QR codes provided by PyOTP.

Implementers should read and follow the `HOTP security requirements <https://tools.ietf.org/html/rfc4226#section-7>`_
and `TOTP security considerations <https://tools.ietf.org/html/rfc6238#section-5>`_ sections of the relevant RFCs. At
minimum, application implementers should follow this checklist:

- Ensure transport confidentiality by using HTTPS
- Ensure HOTP/TOTP secret confidentiality by storing secrets in a controlled access database
- Deny replay attacks by rejecting one-time passwords that have been used by the client (this requires storing the most
  recently authenticated timestamp, OTP, or hash of the OTP in your database, and rejecting the OTP when a match is
  seen)
- Throttle (rate limit) brute-force attacks against your application's login functionality (see RFC 4226, section 7.3)
- When implementing a "greenfield" application, consider supporting
  `FIDO U2F <https://en.wikipedia.org/wiki/Universal_2nd_Factor>`_/`WebAuthn <https://www.w3.org/TR/webauthn/>`_ in
  addition to HOTP/TOTP. U2F uses asymmetric cryptography to avoid using a shared secret design, which strengthens your
  MFA solution against server-side attacks. Hardware U2F also sequesters the client secret in a dedicated single-purpose
  device, which strengthens your clients against client-side attacks. And by automating scoping of credentials to
  relying party IDs (application origin/domain names), U2F adds protection against phishing attacks. One implementation
  of FIDO U2F/WebAuthn is PyOTP's sister project, `PyWARP <https://github.com/pyauth/pywarp>`_.

We also recommend that implementers read the
`OWASP Authentication Cheat Sheet
<https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Authentication_Cheat_Sheet.md>`_ and
`NIST SP 800-63-3: Digital Authentication Guideline <https://pages.nist.gov/800-63-3/>`_ for a high level overview of
authentication best practices.

Quick overview of using One Time Passwords on your phone
--------------------------------------------------------

* OTPs involve a shared secret, stored both on the phone and the server
* OTPs can be generated on a phone without internet connectivity
* OTPs should always be used as a second factor of authentication (if your phone is lost, you account is still secured
  with a password)
* Google Authenticator and other OTP client apps allow you to store multiple OTP secrets and provision those using a QR
  Code

Installation
------------
::

    pip install pyotp

Usage
-----

Time-based OTPs
~~~~~~~~~~~~~~~
::

    import pyotp
    import time

    totp = pyotp.TOTP('base32secret3232')
    totp.now() # => '492039'

    # OTP verified for current time
    totp.verify('492039') # => True
    time.sleep(30)
    totp.verify('492039') # => False

Counter-based OTPs
~~~~~~~~~~~~~~~~~~
::

    import pyotp
    
    hotp = pyotp.HOTP('base32secret3232')
    hotp.at(0) # => '260182'
    hotp.at(1) # => '055283'
    hotp.at(1401) # => '316439'

    # OTP verified with a counter
    hotp.verify('316439', 1401) # => True
    hotp.verify('316439', 1402) # => False

Generating a Secret Key
~~~~~~~~~~~~~~~~~~~~~~~
A helper function is provided to generate a 32-character base32 secret, compatible with Google Authenticator and other
OTP apps::

    pyotp.random_base32()

Some applications want the secret key to be formatted as a hex-encoded string::

    pyotp.random_hex()  # returns a 40-character hex-encoded secret

Google Authenticator Compatible
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

PyOTP works with the Google Authenticator iPhone and Android app, as well as other OTP apps like Authy. PyOTP includes
the ability to generate provisioning URIs for use with the QR Code scanner built into these MFA client apps::

    pyotp.totp.TOTP('JBSWY3DPEHPK3PXP').provisioning_uri(name='alice@google.com', issuer_name='Secure App')

    >>> 'otpauth://totp/Secure%20App:alice%40google.com?se

## Recent releases

| Version | Date | Urgency | Changes |
| --- | --- | --- | --- |
| `2.9.0` | 2026-04-21 | Low | Imported from PyPI (2.9.0) |
| `v2.9.0` | 2023-07-27 | Low | - Add `parse_uri()` support for Steam TOTP (#153)  - Test and documentation improvements |
| `v2.9.0` | 2023-07-27 | Low | - Add `parse_uri()` support for Steam TOTP (#153)  - Test and documentation improvements |
| `v2.9.0` | 2023-07-27 | Low | - Add `parse_uri()` support for Steam TOTP (#153)  - Test and documentation improvements |
| `v2.9.0` | 2023-07-27 | Low | - Add `parse_uri()` support for Steam TOTP (#153)  - Test and documentation improvements |
| `v2.9.0` | 2023-07-27 | Low | - Add `parse_uri()` support for Steam TOTP (#153)  - Test and documentation improvements |
| `v2.9.0` | 2023-07-27 | Low | - Add `parse_uri()` support for Steam TOTP (#153)  - Test and documentation improvements |
| `v2.9.0` | 2023-07-27 | Low | - Add `parse_uri()` support for Steam TOTP (#153)  - Test and documentation improvements |
| `v2.9.0` | 2023-07-27 | Low | - Add `parse_uri()` support for Steam TOTP (#153)  - Test and documentation improvements |
| `v2.9.0` | 2023-07-27 | Low | - Add `parse_uri()` support for Steam TOTP (#153)  - Test and documentation improvements |

## Citation

- HTML: https://www.freshcrate.ai/projects/pyotp
- Markdown: https://www.freshcrate.ai/projects/pyotp.md
- Dependencies JSON: https://www.freshcrate.ai/api/projects/pyotp/deps

_Generated by freshcrate.ai. Indexes pypi releases for AI-agent ecosystem packages._
