Welcome to ``cryptography`` =========================== ``cryptography`` is a Python library which exposes cryptographic recipes and primitives. Our goal is for it to be your "cryptographic standard library". Installation ------------ You can install ``cryptography`` with ``pip``: .. code-block:: console $ pip install cryptography See :doc:`Installation ` for more information. Why a new crypto library for Python? ------------------------------------ If you've done cryptographic work in Python before, you've probably seen some other libraries in Python, such as *M2Crypto*, *PyCrypto*, or *PyOpenSSL*. In building ``cryptography`` we wanted to address a few issues we observed in the existing libraries: * 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 :class:`AES-GCM ` and :class:`~cryptography.hazmat.primitives.kdf.hkdf.HKDF`. * Poor introspectability, and thus poor testability. * Extremely error prone APIs, and bad defaults. Layout ------ ``cryptography`` is broadly divided into two levels. One with safe cryptographic recipes, "cryptography for humans" if you will. These are safe and easy to use and don't require developers to make many decisions. The other level is low-level cryptographic primitives. These are often dangerous and can be used incorrectly. They require making decisions and having an in-depth knowledge of the cryptographic concepts at work. Because of the potential danger in working at this level, this is referred to as the "hazardous materials" or "hazmat" layer. These live in the ``cryptography.hazmat`` package, and their documentation will always contain an admonition at the top. We recommend using the recipes layer whenever possible, and falling back to the hazmat layer only when necessary. The recipes layer ~~~~~~~~~~~~~~~~~ .. toctree:: :maxdepth: 2 fernet random-numbers exceptions glossary The hazardous materials layer ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. toctree:: :maxdepth: 2 hazmat/primitives/index hazmat/backends/index hazmat/bindings/index The ``cryptography`` open source project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. toctree:: :maxdepth: 2 installation development/index security api-stability doing-a-release changelog community .. _`pre-compiled binaries`: https://www.openssl.org/related/binaries.html 851bef63dd25aa6cc43ee498a49 (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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242