Alex Gaynor | 1abfac7 | 2013-08-07 12:59:04 -0700 | [diff] [blame] | 1 | Welcome to ``cryptography`` |
| 2 | =========================== |
| 3 | |
| 4 | .. warning:: |
| 5 | |
| 6 | ``cryptography`` is very young, and very incomplete. |
| 7 | |
| 8 | ``cryptography`` is a Python library which exposes cryptographic primitives and |
| 9 | recipes. |
Alex Gaynor | c62e91f | 2013-08-06 19:25:52 -0700 | [diff] [blame] | 10 | |
Alex Gaynor | 9f3468d | 2013-08-11 08:17:48 -0400 | [diff] [blame] | 11 | Why a new crypto library for Python? |
| 12 | ------------------------------------ |
| 13 | |
| 14 | We wanted to address a few issues with existing cryptography libraries in |
| 15 | Python: |
| 16 | |
Alex Gaynor | d8d91d4 | 2013-08-12 09:33:18 -0400 | [diff] [blame] | 17 | * Lack of PyPy and Python 3 support. |
Alex Gaynor | d6bef56 | 2013-08-11 09:09:28 -0400 | [diff] [blame] | 18 | * Lack of maintenance. |
Alex Gaynor | ec4ba73 | 2013-08-11 08:19:05 -0400 | [diff] [blame] | 19 | * Use of poor implementations of algorithms (i.e. ones with known side-channel |
Alex Gaynor | d6bef56 | 2013-08-11 09:09:28 -0400 | [diff] [blame] | 20 | 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 Gaynor | f0d139a | 2013-08-11 09:13:27 -0400 | [diff] [blame] | 24 | * Extremely error prone APIs, and bad defaults. |
Alex Gaynor | 9f3468d | 2013-08-11 08:17:48 -0400 | [diff] [blame] | 25 | |
| 26 | |
Alex Gaynor | 3538fdb | 2013-08-11 08:18:40 -0400 | [diff] [blame] | 27 | Contents |
| 28 | -------- |
Alex Gaynor | c62e91f | 2013-08-06 19:25:52 -0700 | [diff] [blame] | 29 | |
| 30 | .. toctree:: |
Alex Gaynor | 1abfac7 | 2013-08-07 12:59:04 -0700 | [diff] [blame] | 31 | :maxdepth: 2 |
| 32 | |
| 33 | architecture |
Alex Gaynor | f6c47e9 | 2013-08-08 07:16:01 -0700 | [diff] [blame] | 34 | primitives/index |
Alex Gaynor | 6d02e2d | 2013-09-30 10:37:22 -0700 | [diff] [blame] | 35 | bindings/index |
Alex Gaynor | c72e63f | 2013-09-09 21:44:26 -0700 | [diff] [blame] | 36 | contributing |
Alex Gaynor | ddd90c1 | 2013-08-07 13:10:32 -0700 | [diff] [blame] | 37 | community |