blob: 1b88e24e7f8e2050f893986686924deb682c6847 [file] [log] [blame]
Alex Gaynor1abfac72013-08-07 12:59:04 -07001Welcome to ``cryptography``
2===========================
3
4.. warning::
5
6 ``cryptography`` is very young, and very incomplete.
7
Alex Gaynor66ba6012013-10-28 10:11:21 -07008``cryptography`` is a Python library which exposes cryptographic recipes and
9primitives.
Alex Gaynorc62e91f2013-08-06 19:25:52 -070010
Alex Gaynor9f3468d2013-08-11 08:17:48 -040011Why a new crypto library for Python?
12------------------------------------
13
14We wanted to address a few issues with existing cryptography libraries in
15Python:
16
Alex Gaynord8d91d42013-08-12 09:33:18 -040017* Lack of PyPy and Python 3 support.
Alex Gaynord6bef562013-08-11 09:09:28 -040018* Lack of maintenance.
Alex Gaynorec4ba732013-08-11 08:19:05 -040019* Use of poor implementations of algorithms (i.e. ones with known side-channel
Alex Gaynord6bef562013-08-11 09:09:28 -040020 attacks).
21* Lack of high level, "Cryptography for humans", APIs.
22* Absence of algorithms such as AES-GCM.
23* Poor introspectability, and thus poor testability.
Alex Gaynorf0d139a2013-08-11 09:13:27 -040024* Extremely error prone APIs, and bad defaults.
Alex Gaynor9f3468d2013-08-11 08:17:48 -040025
26
Alex Gaynor3538fdb2013-08-11 08:18:40 -040027Contents
28--------
Alex Gaynorc62e91f2013-08-06 19:25:52 -070029
30.. toctree::
Alex Gaynor1abfac72013-08-07 12:59:04 -070031 :maxdepth: 2
32
33 architecture
Alex Gaynorf1a3fc02013-11-02 14:03:34 -070034 exceptions
Alex Gaynor8c9dcb32013-11-03 13:10:57 -080035 glossary
Alex Gaynorc72e63f2013-09-09 21:44:26 -070036 contributing
Alex Gaynor99b69d92013-10-19 17:52:58 -070037 security
Alex Gaynorddd90c12013-08-07 13:10:32 -070038 community
Donald Stufftf04317a2013-10-27 16:44:30 -040039
Donald Stufft0a1550e2013-10-28 12:13:33 -040040Hazardous Materials
41-------------------
Donald Stufftf04317a2013-10-27 16:44:30 -040042
43.. toctree::
44 :maxdepth: 2
45
46 hazmat/primitives/index
Donald Stufftce0d7812013-10-27 16:52:33 -040047 hazmat/bindings/index