aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
blob: b9bf17351152ad509cc120c3bd7f870846eb906c (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
Welcome to ``cryptography``
===========================

.. warning::

    ``cryptography`` is very young, and very incomplete.

``cryptography`` is a Python library which exposes cryptographic recipes and
primitives.

Why a new crypto library for Python?
------------------------------------

We wanted to address a few issues with existing cryptography libraries in
Python:

* Lack of PyPy and Python 3 support.
* Lack of maintenance.
* Use of poor implementations of algorithms (i.e. ones with known side-channel
  attacks).
* Lack of high level, "Cryptography for humans", APIs.
* Absence of algorithms such as AES-GCM.
* Poor introspectability, and thus poor testability.
* Extremely error prone APIs, and bad defaults.


Contents
--------

.. toctree::
    :maxdepth: 2

    fernet
    architecture
    exceptions
    glossary
    contributing
    security
    community

Hazardous Materials
-------------------

.. toctree::
    :maxdepth: 2

    hazmat/primitives/index
    hazmat/bindings/index