The Passlib documentation has moved to https://passlib.readthedocs.io

You will be redirected to the new location in 10 seconds.

Table Of Contents

• Introduction
  • Welcome
  • Getting Started
  • Online Resources
• Walkthrough & Tutorials
  • Installation
    • Supported Platforms
    • Optional Libraries
    • Installation Instructions
    • Testing
    • Building the Documentation
  • Library Overview
    • Password Hashes
    • Password Contexts
    • Two-Factor Authentication
    • Application Helpers
  • New Application Quickstart Guide
    • Choosing a Hash
      • The Options
      • Detailed Comparison of Choices
      • Making a Decision
    • Creating and Using a CryptContext
  • PasswordHash Tutorial
    • Overview
    • Hashing & Verifying
      • Hashing
      • Verifying
      • Unicode & non-ASCII Characters
    • Customizing the Configuration
      • The using() Method
      • Usage Example
      • Other Keywords
    • Context Keywords
    • Identifying Hashes
    • Choosing the right rounds value
  • CryptContext Tutorial
    • Overview
    • Walkthrough Outline
    • Basic Usage
    • Using Default Settings
    • Loading & Saving a CryptContext
    • Deprecation & Hash Migration
      • Deprecating Algorithms
      • Integrating Hash Migration
      • Settings Rounds Limitations
    • Undocumented Features
    • Full Integration Example
      • Policy Configuration File
      • Initializing the CryptContext
      • Encrypting New Passwords
      • Verifying & Migrating Existing Passwords
  • TOTP Tutorial
    • Overview
    • Walkthrough
      • 1. Generate an Application Secret
      • 2. TOTP Factory Initialization
      • 3. Rate-Limiting & Cache Initialization
      • 4. Setting up TOTP for a User
      • 5. Storing the TOTP object
      • 6. Verifying a Token
      • 7. Reserializing Existing Objects
    • Creating TOTP Instances
      • Direct Creation
      • Using a Factory
    • Configuring Clients
      • Rendering URIs
      • Rendering QR Codes
      • Parsing URIs
    • Storing TOTP instances
      • JSON Serialization
      • Application Secrets
      • Encrypting Keys
    • Generating Tokens (Client-Side Only)
    • Verifying Tokens
      • Match & Verify
      • Preventing Token Reuse
      • Why Rate-Limiting is Critical
• API Reference
  • passlib.apache - Apache Password Files
    • Htpasswd Files
    • Htdigest Files
  • passlib.apps - Helpers for various applications
    • Usage Example
    • Django
    • LDAP
    • MySQL
    • PHPass
    • PostgreSQL
    • Roundup
    • Custom Applications
  • passlib.context - CryptContext Hash Manager
    • The CryptContext Class
      • Constructor Keywords
      • Primary Methods
      • Hash Migration
      • Disabled Hash Managment
      • Alternate Constructors
      • Changing the Configuration
      • Examining the Configuration
      • Saving the Configuration
      • Configuration Errors
    • Other Helpers
    • The CryptPolicy Class (deprecated)
  • passlib.crypto - Cryptographic Helper Functions
    • passlib.crypto.digest - Hash & Related Helpers
      • Hash Functions
      • PKCS#5 Key Derivation Functions
    • passlib.crypto.des - DES routines
  • passlib.exc - Exceptions and warnings
    • Exceptions
      • TOTP Exceptions
    • Warnings
      • Minor Warnings
      • Critical Warnings
  • passlib.ext.django - Django Password Hashing Plugin
    • Installation
    • Configuration
    • Module Contents
  • passlib.hash - Password Hashing Schemes
    • Overview
    • Unix Hashes
      • Active Unix Hashes
      • Deprecated Unix Hashes
      • Archaic Unix Hashes
    • Other “Modular Crypt” Hashes
      • Active Hashes
      • Deprecated Hashes
    • LDAP / RFC2307 Hashes
      • Standard LDAP Schemes
      • Non-Standard LDAP Schemes
    • SQL Database Hashes
      • passlib.hash.mssql2000 - MS SQL 2000 password hash
      • passlib.hash.mssql2005 - MS SQL 2005 password hash
      • passlib.hash.mysql323 - MySQL 3.2.3 password hash
      • passlib.hash.mysql41 - MySQL 4.1 password hash
      • passlib.hash.postgres_md5 - PostgreSQL MD5 password hash
      • passlib.hash.oracle10 - Oracle 10g password hash
      • passlib.hash.oracle11 - Oracle 11g password hash
    • MS Windows Hashes
      • passlib.hash.lmhash - LanManager Hash
      • passlib.hash.nthash - Windows’ NT-HASH
      • passlib.hash.msdcc - Windows’ Domain Cached Credentials
      • passlib.hash.msdcc2 - Windows’ Domain Cached Credentials v2
    • Cisco Hashes
      • passlib.hash.cisco_type7 - Cisco “Type 7” hash
      • passlib.hash.cisco_pix - Cisco PIX MD5 hash
      • passlib.hash.cisco_asa - Cisco ASA MD5 hash
    • Other Hashes
      • passlib.hash.django_digest - Django-specific Hashes
      • passlib.hash.grub_pbkdf2_sha512 - Grub’s PBKDF2 Hash
      • passlib.hash.hex_digest - Generic Hexadecimal Digests
      • passlib.hash.plaintext - Plaintext
  • passlib.hosts - OS Password Handling
    • Usage Example
    • Unix Password Hashes
      • Predefined Contexts
      • Current Host OS
  • passlib.ifc – Password Hash Interface
    • PasswordHash API
    • Base Abstract Class
    • Hashing & Verification Methods
    • Crypt Methods
    • Factory Creation
    • Hash Inspection Methods
    • General Informational Attributes
    • Salt Information Attributes
    • Rounds Information Attributes
  • passlib.pwd – Password generation helpers
    • Password Generation
    • Predefined Symbol Sets
    • Password Strength Estimation
  • passlib.registry - Password Handler Registry
    • Interface
    • Usage
  • passlib.totp – TOTP / Two Factor Authentication
    • Overview
    • TOTP Class
    • Alternate Constructors
    • Factory Creation
    • Basic Attributes
    • Token Generation
      • TotpToken
    • Token Matching / Verification
      • TotpMatch
    • Client Configuration Methods
    • Serialization Methods
    • Helper Methods
    • AppWallet
    • Support Functions
    • Deviations
  • passlib.utils - Helper Functions
    • Constants
    • Unicode Helpers
    • Bytes Helpers
    • Encoding Helpers
    • Randomness
    • Interface Tests
    • Submodules
      • passlib.utils.handlers - Framework for writing password hashes
      • passlib.utils.binary - Binary Helper Functions
      • passlib.utils.des - DES routines [deprecated]
      • passlib.utils.pbkdf2 - PBKDF2 key derivation algorithm [deprecated]
• Other Documentation
  • Frequently Asked Questions
  • Modular Crypt Format
    • Overview
    • History
    • Requirements
    • Identifiers & Platform Support
      • OS Defined Hashes
      • Additional Platforms
      • Application-Defined Hashes
  • Release History
    • 1.7 Series
      • 1.7.2 (NOT YET RELEASED)
      • 1.7.1 (2017-1-30)
      • 1.7.0 (2016-11-22)
    • 1.6 Series
      • 1.6.5 (2015-08-04)
      • 1.6.4 (2015-07-25)
      • 1.6.3 (2015-07-25)
      • 1.6.2 (2013-12-26)
      • 1.6.1 (2012-08-02)
      • 1.6.0 (2012-05-01)
    • 1.5 Series
      • 1.5.3 (2011-10-08)
      • 1.5.2 (2011-09-19)
      • 1.5.1 (2011-08-17)
      • 1.5.0 (2011-07-11)
    • 1.4 & Earlier
      • 1.4 (2011-05-04)
      • 1.3.1 (2011-03-28)
      • 1.3 (2011-03-25)
      • 1.2 (2011-01-06)
      • 1.0 (2009-12-11)
      • 0.5 (2008-05-10)
  • Copyrights & Licenses
    • Credits
    • License for Passlib
    • Licenses for incorporated software
      • MD5-Crypt
      • DES
      • jBCrypt
      • Wordsets

• General Index
• Module List