summaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: f403aab6da3bf62822720c8693932c47f11fa68d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
==========================================
PassLib |release| documentation
==========================================

Introduction
============
Passlib is a collection of routines for managing password hashes
in wide variety of different uses:

    * cross-platform replacement for stdlib ``crypt()``.
    * encrypting & verifying most known hash formats used by:
        - Linux & BSD shadow files
        - Apache htpasswd files
        - MySQL & PostgreSQL user account tables
    * drop-in secure hashing for new python applications
    * quickly building a configurable hashing policy
      for existing python applications and existing hashing schemes.

A quick sample of some of the more frequently used modules:

    * :mod:`passlib` -- password hashing algorithms
    * :mod:`passlib.hash` -- module containing all supported password hashes

    ... see the :doc:`library overview <overview>` for a complete list.

Quick Links
===========

.. raw:: html

  <table class="contentstable" align="center">
  <tr>
    <td width="50%" valign="top">
      <p class="biglink"><a class="biglink" href="contents.html">Table of Contents</a><br>
         <span class="linkdescr">lists all sections and subsections</span></p>

          <p class="biglink"><a class="biglink" href="overview.html">Library Overview</a><br>
         <span class="linkdescr">describes how BPS is laid out</span></p>

    </td><td width="50%">

      <p class="biglink"><a class="biglink" href="genindex.html">General Index</a><br>
         <span class="linkdescr">all functions, classes, terms</span></p>

      <p class="biglink"><a class="biglink" href="modindex.html">Module List</a><br>
         <span class="linkdescr">quick access to all modules</span></p>

      <p class="biglink"><a class="biglink" href="search.html">Search Page</a><br>
         <span class="linkdescr">search this documentation</span></p>

    </td></tr>
  </table>