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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Crypto.Protocol.KDF</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Crypto-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a href="http://www.pycrypto.org/">PyCrypto.org</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Crypto-module.html">Package Crypto</a> ::
<a href="Crypto.Protocol-module.html">Package Protocol</a> ::
Module KDF
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Crypto.Protocol.KDF-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module KDF</h1><p class="nomargin-top"></p>
<p>This file contains a collection of standard key derivation functions.</p>
<p>A key derivation function derives one or more secondary secret keys from
one primary secret (a master key or a pass phrase).</p>
<p>This is typically done to insulate the secondary keys from each other,
to avoid that leakage of a secondary key compromises the security of the
master key, or to thwart attacks on pass phrases (e.g. via rainbow tables).</p>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Crypto.Protocol.KDF-module.html#PBKDF1" class="summary-sig-name">PBKDF1</a>(<span class="summary-sig-arg">password</span>,
<span class="summary-sig-arg">salt</span>,
<span class="summary-sig-arg">dkLen</span>,
<span class="summary-sig-arg">count</span>=<span class="summary-sig-default">1000</span>,
<span class="summary-sig-arg">hashAlgo</span>=<span class="summary-sig-default"><module 'Crypto.Hash.SHA' from '/home/dwon/Projects/pycrypto/b<code class="variable-ellipsis">...</code></span>)</span><br />
Derive one key from a password (or passphrase).</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Crypto.Protocol.KDF-module.html#PBKDF2" class="summary-sig-name">PBKDF2</a>(<span class="summary-sig-arg">password</span>,
<span class="summary-sig-arg">salt</span>,
<span class="summary-sig-arg">dkLen</span>=<span class="summary-sig-default">16</span>,
<span class="summary-sig-arg">count</span>=<span class="summary-sig-default">1000</span>,
<span class="summary-sig-arg">prf</span>=<span class="summary-sig-default">None</span>)</span><br />
Derive one or more keys from a password (or passphrase).</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'Crypto.Protocol'"><code class="variable-quote">'</code><code class="variable-string">Crypto.Protocol</code><code class="variable-quote">'</code></code>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="PBKDF1"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">PBKDF1</span>(<span class="sig-arg">password</span>,
<span class="sig-arg">salt</span>,
<span class="sig-arg">dkLen</span>,
<span class="sig-arg">count</span>=<span class="sig-default">1000</span>,
<span class="sig-arg">hashAlgo</span>=<span class="sig-default"><module 'Crypto.Hash.SHA' from '/home/dwon/Projects/pycrypto/b<code class="variable-ellipsis">...</code></span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Derive one key from a password (or passphrase).</p>
<p>This function performs key derivation according an old version of
the PKCS#5 standard (v1.5).</p>
<p>This algorithm is called <tt class="rst-docutils literal">PBKDF1</tt>. Even though it is still described
in the latest version of the PKCS#5 standard (version 2, or RFC2898),
newer applications should use the more secure and versatile <a href="Crypto.Protocol.KDF-module.html#PBKDF2" class="link">PBKDF2</a> instead.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>password</code></strong> (string) - The secret password or pass phrase to generate the key from.</li>
<li><strong class="pname"><code>salt</code></strong> (byte string) - An 8 byte string to use for better protection from dictionary attacks.
This value does not need to be kept secret, but it should be randomly
chosen for each derivation.</li>
<li><strong class="pname"><code>dkLen</code></strong> (integer) - The length of the desired key. Default is 16 bytes, suitable for instance for <a href="Crypto.Cipher.AES-module.html" class="link">Crypto.Cipher.AES</a>.</li>
<li><strong class="pname"><code>count</code></strong> (integer) - The number of iterations to carry out. It's recommended to use at least 1000.</li>
<li><strong class="pname"><code>hashAlgo</code></strong> (module) - The hash algorithm to use, as a module or an object from the <a href="Crypto.Hash-module.html" class="link">Crypto.Hash</a> package.
The digest length must be no shorter than <tt class="rst-docutils literal">dkLen</tt>.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>A byte string of length <code class="link">dkLen</code> that can be used as key.</dd>
</dl>
</td></tr></table>
</div>
<a name="PBKDF2"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">PBKDF2</span>(<span class="sig-arg">password</span>,
<span class="sig-arg">salt</span>,
<span class="sig-arg">dkLen</span>=<span class="sig-default">16</span>,
<span class="sig-arg">count</span>=<span class="sig-default">1000</span>,
<span class="sig-arg">prf</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Derive one or more keys from a password (or passphrase).</p>
<p>This performs key derivation according to the PKCS#5 standard (v2.0),
by means of the <tt class="rst-docutils literal">PBKDF2</tt> algorithm.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>password</code></strong> (string) - The secret password or pass phrase to generate the key from.</li>
<li><strong class="pname"><code>salt</code></strong> (string) - A string to use for better protection from dictionary attacks.
This value does not need to be kept secret, but it should be randomly
chosen for each derivation. It is recommended to be at least 8 bytes long.</li>
<li><strong class="pname"><code>dkLen</code></strong> (integer) - The cumulative length of the desired keys. Default is 16 bytes, suitable for instance for <a href="Crypto.Cipher.AES-module.html" class="link">Crypto.Cipher.AES</a>.</li>
<li><strong class="pname"><code>count</code></strong> (integer) - The number of iterations to carry out. It's recommended to use at least 1000.</li>
<li><strong class="pname"><code>prf</code></strong> (callable) - A pseudorandom function. It must be a function that returns a pseudorandom string
from two parameters: a secret and a salt. If not specified, HMAC-SHA1 is used.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>A byte string of length <code class="link">dkLen</code> that can be used as key material.
If you wanted multiple keys, just break up this string into segments of the desired length.</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Crypto-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a href="http://www.pycrypto.org/">PyCrypto.org</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Fri Jan 13 12:36:10 2012
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
