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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>M2Crypto.DSA — M2Crypto documentation</title>
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/language_data.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for M2Crypto.DSA</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span><span class="p">,</span> <span class="n">print_function</span>
<span class="sd">"""</span>
<span class="sd"> M2Crypto wrapper for OpenSSL DSA API.</span>
<span class="sd"> Copyright (c) 1999-2003 Ng Pheng Siong. All rights reserved.</span>
<span class="sd"> Portions created by Open Source Applications Foundation (OSAF) are</span>
<span class="sd"> Copyright (C) 2004 OSAF. All Rights Reserved.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">M2Crypto</span> <span class="k">import</span> <span class="n">BIO</span><span class="p">,</span> <span class="n">m2</span><span class="p">,</span> <span class="n">util</span>
<span class="k">if</span> <span class="n">util</span><span class="o">.</span><span class="n">py27plus</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="k">import</span> <span class="n">AnyStr</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Tuple</span> <span class="c1"># noqa</span>
<div class="viewcode-block" id="DSAError"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSAError">[docs]</a><span class="k">class</span> <span class="nc">DSAError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="k">pass</span></div>
<span class="n">m2</span><span class="o">.</span><span class="n">dsa_init</span><span class="p">(</span><span class="n">DSAError</span><span class="p">)</span>
<div class="viewcode-block" id="DSA"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA">[docs]</a><span class="k">class</span> <span class="nc">DSA</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This class is a context supporting DSA key and parameter</span>
<span class="sd"> values, signing and verifying.</span>
<span class="sd"> Simple example::</span>
<span class="sd"> from M2Crypto import EVP, DSA, util</span>
<span class="sd"> message = 'Kilroy was here!'</span>
<span class="sd"> md = EVP.MessageDigest('sha1')</span>
<span class="sd"> md.update(message)</span>
<span class="sd"> digest = md.final()</span>
<span class="sd"> dsa = DSA.gen_params(1024)</span>
<span class="sd"> dsa.gen_key()</span>
<span class="sd"> r, s = dsa.sign(digest)</span>
<span class="sd"> good = dsa.verify(digest, r, s)</span>
<span class="sd"> if good:</span>
<span class="sd"> print(' ** success **')</span>
<span class="sd"> else:</span>
<span class="sd"> print(' ** verification failed **')</span>
<span class="sd"> """</span>
<span class="n">m2_dsa_free</span> <span class="o">=</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_free</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dsa</span><span class="p">,</span> <span class="n">_pyfree</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="c1"># type: (bytes, int) -> None</span>
<span class="sd">"""</span>
<span class="sd"> Use one of the factory functions to create an instance.</span>
<span class="sd"> :param dsa: binary representation of OpenSSL DSA type</span>
<span class="sd"> """</span>
<span class="k">assert</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_type_check</span><span class="p">(</span><span class="n">dsa</span><span class="p">),</span> <span class="s2">"'dsa' type error"</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dsa</span> <span class="o">=</span> <span class="n">dsa</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_pyfree</span> <span class="o">=</span> <span class="n">_pyfree</span>
<span class="k">def</span> <span class="nf">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -> None</span>
<span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s1">'_pyfree'</span><span class="p">,</span> <span class="mi">0</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">m2_dsa_free</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -> int</span>
<span class="sd">"""</span>
<span class="sd"> Return the key length.</span>
<span class="sd"> :return: the DSA key length in bits</span>
<span class="sd"> """</span>
<span class="k">assert</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_type_check</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">),</span> <span class="s2">"'dsa' type error"</span>
<span class="k">return</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_keylen</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="c1"># type: (str) -> bytes</span>
<span class="sd">"""</span>
<span class="sd"> Return specified DSA parameters and key values.</span>
<span class="sd"> :param name: name of variable to be returned. Must be</span>
<span class="sd"> one of 'p', 'q', 'g', 'pub', 'priv'.</span>
<span class="sd"> :return: value of specified variable (a "byte string")</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'p'</span><span class="p">,</span> <span class="s1">'q'</span><span class="p">,</span> <span class="s1">'g'</span><span class="p">,</span> <span class="s1">'pub'</span><span class="p">,</span> <span class="s1">'priv'</span><span class="p">]:</span>
<span class="n">method</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">m2</span><span class="p">,</span> <span class="s1">'dsa_get_</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">name</span><span class="p">,))</span>
<span class="k">assert</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_type_check</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">),</span> <span class="s2">"'dsa' type error"</span>
<span class="k">return</span> <span class="n">method</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">AttributeError</span>
<span class="k">def</span> <span class="nf">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="c1"># type: (str, bytes) -> None</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'p'</span><span class="p">,</span> <span class="s1">'q'</span><span class="p">,</span> <span class="s1">'g'</span><span class="p">]:</span>
<span class="k">raise</span> <span class="n">DSAError</span><span class="p">(</span><span class="s1">'set (p, q, g) via set_params()'</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">name</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'pub'</span><span class="p">,</span> <span class="s1">'priv'</span><span class="p">]:</span>
<span class="k">raise</span> <span class="n">DSAError</span><span class="p">(</span><span class="s1">'generate (pub, priv) via gen_key()'</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="vm">__dict__</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<div class="viewcode-block" id="DSA.set_params"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA.set_params">[docs]</a> <span class="k">def</span> <span class="nf">set_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">g</span><span class="p">):</span>
<span class="c1"># type: (bytes, bytes, bytes) -> None</span>
<span class="sd">"""</span>
<span class="sd"> Set new parameters.</span>
<span class="sd"> :param p: MPI binary representation ... format that consists of</span>
<span class="sd"> the number's length in bytes represented as a 4-byte</span>
<span class="sd"> big-endian number, and the number itself in big-endian</span>
<span class="sd"> format, where the most significant bit signals</span>
<span class="sd"> a negative number (the representation of numbers with</span>
<span class="sd"> the MSB set is prefixed with null byte).</span>
<span class="sd"> :param q: ditto</span>
<span class="sd"> :param g: ditto</span>
<span class="sd"> @warning: This does not change the private key, so it may be</span>
<span class="sd"> unsafe to use this method. It is better to use</span>
<span class="sd"> gen_params function to create a new DSA object.</span>
<span class="sd"> """</span>
<span class="n">m2</span><span class="o">.</span><span class="n">dsa_set_pqg</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">g</span><span class="p">)</span></div>
<div class="viewcode-block" id="DSA.gen_key"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA.gen_key">[docs]</a> <span class="k">def</span> <span class="nf">gen_key</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -> None</span>
<span class="sd">"""</span>
<span class="sd"> Generate a key pair.</span>
<span class="sd"> """</span>
<span class="k">assert</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_type_check</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">),</span> <span class="s2">"'dsa' type error"</span>
<span class="n">m2</span><span class="o">.</span><span class="n">dsa_gen_key</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">)</span></div>
<div class="viewcode-block" id="DSA.save_params"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA.save_params">[docs]</a> <span class="k">def</span> <span class="nf">save_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
<span class="c1"># type: (AnyStr) -> int</span>
<span class="sd">"""</span>
<span class="sd"> Save the DSA parameters to a file.</span>
<span class="sd"> :param filename: Save the DSA parameters to this file.</span>
<span class="sd"> :return: 1 (true) if successful</span>
<span class="sd"> """</span>
<span class="k">with</span> <span class="n">BIO</span><span class="o">.</span><span class="n">openfile</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s1">'wb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">bio</span><span class="p">:</span>
<span class="n">ret</span> <span class="o">=</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_write_params_bio</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">,</span> <span class="n">bio</span><span class="o">.</span><span class="n">_ptr</span><span class="p">())</span>
<span class="k">return</span> <span class="n">ret</span></div>
<div class="viewcode-block" id="DSA.save_params_bio"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA.save_params_bio">[docs]</a> <span class="k">def</span> <span class="nf">save_params_bio</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bio</span><span class="p">):</span>
<span class="c1"># type: (BIO.BIO) -> int</span>
<span class="sd">"""</span>
<span class="sd"> Save DSA parameters to a BIO object.</span>
<span class="sd"> :param bio: Save DSA parameters to this object.</span>
<span class="sd"> :return: 1 (true) if successful</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_write_params_bio</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">,</span> <span class="n">bio</span><span class="o">.</span><span class="n">_ptr</span><span class="p">())</span></div>
<div class="viewcode-block" id="DSA.save_key"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA.save_key">[docs]</a> <span class="k">def</span> <span class="nf">save_key</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">cipher</span><span class="o">=</span><span class="s1">'aes_128_cbc'</span><span class="p">,</span>
<span class="n">callback</span><span class="o">=</span><span class="n">util</span><span class="o">.</span><span class="n">passphrase_callback</span><span class="p">):</span>
<span class="c1"># type: (AnyStr, str, Callable) -> int</span>
<span class="sd">"""</span>
<span class="sd"> Save the DSA key pair to a file.</span>
<span class="sd"> :param filename: Save the DSA key pair to this file.</span>
<span class="sd"> :param cipher: name of symmetric key algorithm and mode</span>
<span class="sd"> to encrypt the private key.</span>
<span class="sd"> :return: 1 (true) if successful</span>
<span class="sd"> """</span>
<span class="k">with</span> <span class="n">BIO</span><span class="o">.</span><span class="n">openfile</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s1">'wb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">bio</span><span class="p">:</span>
<span class="n">ret</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">save_key_bio</span><span class="p">(</span><span class="n">bio</span><span class="p">,</span> <span class="n">cipher</span><span class="p">,</span> <span class="n">callback</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ret</span></div>
<div class="viewcode-block" id="DSA.save_key_bio"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA.save_key_bio">[docs]</a> <span class="k">def</span> <span class="nf">save_key_bio</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bio</span><span class="p">,</span> <span class="n">cipher</span><span class="o">=</span><span class="s1">'aes_128_cbc'</span><span class="p">,</span>
<span class="n">callback</span><span class="o">=</span><span class="n">util</span><span class="o">.</span><span class="n">passphrase_callback</span><span class="p">):</span>
<span class="c1"># type: (BIO.BIO, str, Callable) -> int</span>
<span class="sd">"""</span>
<span class="sd"> Save DSA key pair to a BIO object.</span>
<span class="sd"> :param bio: Save DSA parameters to this object.</span>
<span class="sd"> :param cipher: name of symmetric key algorithm and mode</span>
<span class="sd"> to encrypt the private key.</span>
<span class="sd"> :return: 1 (true) if successful</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">cipher</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_write_key_bio_no_cipher</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">,</span>
<span class="n">bio</span><span class="o">.</span><span class="n">_ptr</span><span class="p">(),</span> <span class="n">callback</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">ciph</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">m2</span><span class="p">,</span> <span class="n">cipher</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">ciph</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">DSAError</span><span class="p">(</span><span class="s1">'no such cipher: </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">cipher</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">ciph</span> <span class="o">=</span> <span class="n">ciph</span><span class="p">()</span>
<span class="k">return</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_write_key_bio</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">,</span> <span class="n">bio</span><span class="o">.</span><span class="n">_ptr</span><span class="p">(),</span> <span class="n">ciph</span><span class="p">,</span> <span class="n">callback</span><span class="p">)</span></div>
<div class="viewcode-block" id="DSA.save_pub_key"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA.save_pub_key">[docs]</a> <span class="k">def</span> <span class="nf">save_pub_key</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
<span class="c1"># type: (AnyStr) -> int</span>
<span class="sd">"""</span>
<span class="sd"> Save the DSA public key (with parameters) to a file.</span>
<span class="sd"> :param filename: Save DSA public key (with parameters)</span>
<span class="sd"> to this file.</span>
<span class="sd"> :return: 1 (true) if successful</span>
<span class="sd"> """</span>
<span class="k">with</span> <span class="n">BIO</span><span class="o">.</span><span class="n">openfile</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s1">'wb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">bio</span><span class="p">:</span>
<span class="n">ret</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">save_pub_key_bio</span><span class="p">(</span><span class="n">bio</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ret</span></div>
<div class="viewcode-block" id="DSA.save_pub_key_bio"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA.save_pub_key_bio">[docs]</a> <span class="k">def</span> <span class="nf">save_pub_key_bio</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bio</span><span class="p">):</span>
<span class="c1"># type: (BIO.BIO) -> int</span>
<span class="sd">"""</span>
<span class="sd"> Save DSA public key (with parameters) to a BIO object.</span>
<span class="sd"> :param bio: Save DSA public key (with parameters)</span>
<span class="sd"> to this object.</span>
<span class="sd"> :return: 1 (true) if successful</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_write_pub_key_bio</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">,</span> <span class="n">bio</span><span class="o">.</span><span class="n">_ptr</span><span class="p">())</span></div>
<div class="viewcode-block" id="DSA.sign"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA.sign">[docs]</a> <span class="k">def</span> <span class="nf">sign</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">digest</span><span class="p">):</span>
<span class="c1"># type: (bytes) -> Tuple[bytes, bytes]</span>
<span class="sd">"""</span>
<span class="sd"> Sign the digest.</span>
<span class="sd"> :param digest: SHA-1 hash of message (same as output</span>
<span class="sd"> from MessageDigest, a "byte string")</span>
<span class="sd"> :return: DSA signature, a tuple of two values, r and s,</span>
<span class="sd"> both "byte strings".</span>
<span class="sd"> """</span>
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_key</span><span class="p">(),</span> <span class="s1">'key is not initialised'</span>
<span class="k">return</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_sign</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">,</span> <span class="n">digest</span><span class="p">)</span></div>
<div class="viewcode-block" id="DSA.verify"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA.verify">[docs]</a> <span class="k">def</span> <span class="nf">verify</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">digest</span><span class="p">,</span> <span class="n">r</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="c1"># type: (bytes, bytes, bytes) -> int</span>
<span class="sd">"""</span>
<span class="sd"> Verify a newly calculated digest against the signature</span>
<span class="sd"> values r and s.</span>
<span class="sd"> :param digest: SHA-1 hash of message (same as output</span>
<span class="sd"> from MessageDigest, a "byte string")</span>
<span class="sd"> :param r: r value of the signature, a "byte string"</span>
<span class="sd"> :param s: s value of the signature, a "byte string"</span>
<span class="sd"> :return: 1 (true) if verify succeeded, 0 if failed</span>
<span class="sd"> """</span>
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_key</span><span class="p">(),</span> <span class="s1">'key is not initialised'</span>
<span class="k">return</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_verify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">,</span> <span class="n">digest</span><span class="p">,</span> <span class="n">r</span><span class="p">,</span> <span class="n">s</span><span class="p">)</span></div>
<div class="viewcode-block" id="DSA.sign_asn1"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA.sign_asn1">[docs]</a> <span class="k">def</span> <span class="nf">sign_asn1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">digest</span><span class="p">):</span>
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_key</span><span class="p">(),</span> <span class="s1">'key is not initialised'</span>
<span class="k">return</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_sign_asn1</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">,</span> <span class="n">digest</span><span class="p">)</span></div>
<div class="viewcode-block" id="DSA.verify_asn1"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA.verify_asn1">[docs]</a> <span class="k">def</span> <span class="nf">verify_asn1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">digest</span><span class="p">,</span> <span class="n">blob</span><span class="p">):</span>
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_key</span><span class="p">(),</span> <span class="s1">'key is not initialised'</span>
<span class="k">return</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_verify_asn1</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">,</span> <span class="n">digest</span><span class="p">,</span> <span class="n">blob</span><span class="p">)</span></div>
<div class="viewcode-block" id="DSA.check_key"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA.check_key">[docs]</a> <span class="k">def</span> <span class="nf">check_key</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Check to be sure the DSA object has a valid private key.</span>
<span class="sd"> :return: 1 (true) if a valid private key</span>
<span class="sd"> """</span>
<span class="k">assert</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_type_check</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">),</span> <span class="s2">"'dsa' type error"</span>
<span class="k">return</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_check_key</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="DSA_pub"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA_pub">[docs]</a><span class="k">class</span> <span class="nc">DSA_pub</span><span class="p">(</span><span class="n">DSA</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This class is a DSA context that only supports a public key</span>
<span class="sd"> and verification. It does NOT support a private key or</span>
<span class="sd"> signing.</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="DSA_pub.sign"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA_pub.sign">[docs]</a> <span class="k">def</span> <span class="nf">sign</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">argv</span><span class="p">):</span>
<span class="c1"># type: (*Any) -> None</span>
<span class="k">raise</span> <span class="n">DSAError</span><span class="p">(</span><span class="s1">'DSA_pub object has no private key'</span><span class="p">)</span></div>
<span class="n">sign_asn1</span> <span class="o">=</span> <span class="n">sign</span>
<div class="viewcode-block" id="DSA_pub.check_key"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.DSA_pub.check_key">[docs]</a> <span class="k">def</span> <span class="nf">check_key</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># type: () -> int</span>
<span class="sd">"""</span>
<span class="sd"> :return: does DSA_pub contain a pub key?</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_check_pub_key</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dsa</span><span class="p">)</span></div>
<span class="n">save_key</span> <span class="o">=</span> <span class="n">DSA</span><span class="o">.</span><span class="n">save_pub_key</span>
<span class="n">save_key_bio</span> <span class="o">=</span> <span class="n">DSA</span><span class="o">.</span><span class="n">save_pub_key_bio</span></div>
<span class="c1"># --------------------------------------------------------------</span>
<span class="c1"># factories and other functions</span>
<div class="viewcode-block" id="gen_params"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.gen_params">[docs]</a><span class="k">def</span> <span class="nf">gen_params</span><span class="p">(</span><span class="n">bits</span><span class="p">,</span> <span class="n">callback</span><span class="o">=</span><span class="n">util</span><span class="o">.</span><span class="n">genparam_callback</span><span class="p">):</span>
<span class="c1"># type: (int, Callable) -> DSA</span>
<span class="sd">"""</span>
<span class="sd"> Factory function that generates DSA parameters and</span>
<span class="sd"> instantiates a DSA object from the output.</span>
<span class="sd"> :param bits: The length of the prime to be generated. If</span>
<span class="sd"> 'bits' < 512, it is set to 512.</span>
<span class="sd"> :param callback: A Python callback object that will be</span>
<span class="sd"> invoked during parameter generation; it usual</span>
<span class="sd"> purpose is to provide visual feedback.</span>
<span class="sd"> :return: instance of DSA.</span>
<span class="sd"> """</span>
<span class="n">dsa</span> <span class="o">=</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_generate_parameters</span><span class="p">(</span><span class="n">bits</span><span class="p">,</span> <span class="n">callback</span><span class="p">)</span>
<span class="k">return</span> <span class="n">DSA</span><span class="p">(</span><span class="n">dsa</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span></div>
<div class="viewcode-block" id="set_params"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.set_params">[docs]</a><span class="k">def</span> <span class="nf">set_params</span><span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">g</span><span class="p">):</span>
<span class="c1"># type: (bytes, bytes, bytes) -> DSA</span>
<span class="sd">"""</span>
<span class="sd"> Factory function that instantiates a DSA object with DSA</span>
<span class="sd"> parameters.</span>
<span class="sd"> :param p: value of p, a "byte string"</span>
<span class="sd"> :param q: value of q, a "byte string"</span>
<span class="sd"> :param g: value of g, a "byte string"</span>
<span class="sd"> :return: instance of DSA.</span>
<span class="sd"> """</span>
<span class="n">dsa</span> <span class="o">=</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_new</span><span class="p">()</span>
<span class="n">m2</span><span class="o">.</span><span class="n">dsa_set_pqg</span><span class="p">(</span><span class="n">dsa</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">g</span><span class="p">)</span>
<span class="k">return</span> <span class="n">DSA</span><span class="p">(</span><span class="n">dsa</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span></div>
<div class="viewcode-block" id="load_params"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.load_params">[docs]</a><span class="k">def</span> <span class="nf">load_params</span><span class="p">(</span><span class="n">file</span><span class="p">,</span> <span class="n">callback</span><span class="o">=</span><span class="n">util</span><span class="o">.</span><span class="n">passphrase_callback</span><span class="p">):</span>
<span class="c1"># type: (AnyStr, Callable) -> DSA</span>
<span class="sd">"""</span>
<span class="sd"> Factory function that instantiates a DSA object with DSA</span>
<span class="sd"> parameters from a file.</span>
<span class="sd"> :param file: Names the file (a path) that contains the PEM</span>
<span class="sd"> representation of the DSA parameters.</span>
<span class="sd"> :param callback: A Python callback object that will be</span>
<span class="sd"> invoked if the DSA parameters file is</span>
<span class="sd"> passphrase-protected.</span>
<span class="sd"> :return: instance of DSA.</span>
<span class="sd"> """</span>
<span class="k">with</span> <span class="n">BIO</span><span class="o">.</span><span class="n">openfile</span><span class="p">(</span><span class="n">file</span><span class="p">)</span> <span class="k">as</span> <span class="n">bio</span><span class="p">:</span>
<span class="n">ret</span> <span class="o">=</span> <span class="n">load_params_bio</span><span class="p">(</span><span class="n">bio</span><span class="p">,</span> <span class="n">callback</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ret</span></div>
<div class="viewcode-block" id="load_params_bio"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.load_params_bio">[docs]</a><span class="k">def</span> <span class="nf">load_params_bio</span><span class="p">(</span><span class="n">bio</span><span class="p">,</span> <span class="n">callback</span><span class="o">=</span><span class="n">util</span><span class="o">.</span><span class="n">passphrase_callback</span><span class="p">):</span>
<span class="c1"># type: (BIO.BIO, Callable) -> DSA</span>
<span class="sd">"""</span>
<span class="sd"> Factory function that instantiates a DSA object with DSA</span>
<span class="sd"> parameters from a M2Crypto.BIO object.</span>
<span class="sd"> :param bio: Contains the PEM representation of the DSA</span>
<span class="sd"> parameters.</span>
<span class="sd"> :param callback: A Python callback object that will be</span>
<span class="sd"> invoked if the DSA parameters file is</span>
<span class="sd"> passphrase-protected.</span>
<span class="sd"> :return: instance of DSA.</span>
<span class="sd"> """</span>
<span class="n">dsa</span> <span class="o">=</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_read_params</span><span class="p">(</span><span class="n">bio</span><span class="o">.</span><span class="n">_ptr</span><span class="p">(),</span> <span class="n">callback</span><span class="p">)</span>
<span class="k">return</span> <span class="n">DSA</span><span class="p">(</span><span class="n">dsa</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span></div>
<div class="viewcode-block" id="load_key"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.load_key">[docs]</a><span class="k">def</span> <span class="nf">load_key</span><span class="p">(</span><span class="n">file</span><span class="p">,</span> <span class="n">callback</span><span class="o">=</span><span class="n">util</span><span class="o">.</span><span class="n">passphrase_callback</span><span class="p">):</span>
<span class="c1"># type: (AnyStr, Callable) -> DSA</span>
<span class="sd">"""</span>
<span class="sd"> Factory function that instantiates a DSA object from a</span>
<span class="sd"> PEM encoded DSA key pair.</span>
<span class="sd"> :param file: Names the file (a path) that contains the PEM</span>
<span class="sd"> representation of the DSA key pair.</span>
<span class="sd"> :param callback: A Python callback object that will be</span>
<span class="sd"> invoked if the DSA key pair is</span>
<span class="sd"> passphrase-protected.</span>
<span class="sd"> :return: instance of DSA.</span>
<span class="sd"> """</span>
<span class="k">with</span> <span class="n">BIO</span><span class="o">.</span><span class="n">openfile</span><span class="p">(</span><span class="n">file</span><span class="p">)</span> <span class="k">as</span> <span class="n">bio</span><span class="p">:</span>
<span class="n">ret</span> <span class="o">=</span> <span class="n">load_key_bio</span><span class="p">(</span><span class="n">bio</span><span class="p">,</span> <span class="n">callback</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ret</span></div>
<div class="viewcode-block" id="load_key_bio"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.load_key_bio">[docs]</a><span class="k">def</span> <span class="nf">load_key_bio</span><span class="p">(</span><span class="n">bio</span><span class="p">,</span> <span class="n">callback</span><span class="o">=</span><span class="n">util</span><span class="o">.</span><span class="n">passphrase_callback</span><span class="p">):</span>
<span class="c1"># type: (BIO.BIO, Callable) -> DSA</span>
<span class="sd">"""</span>
<span class="sd"> Factory function that instantiates a DSA object from a</span>
<span class="sd"> PEM encoded DSA key pair.</span>
<span class="sd"> :param bio: Contains the PEM representation of the DSA</span>
<span class="sd"> key pair.</span>
<span class="sd"> :param callback: A Python callback object that will be</span>
<span class="sd"> invoked if the DSA key pair is</span>
<span class="sd"> passphrase-protected.</span>
<span class="sd"> :return: instance of DSA.</span>
<span class="sd"> """</span>
<span class="n">dsa</span> <span class="o">=</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_read_key</span><span class="p">(</span><span class="n">bio</span><span class="o">.</span><span class="n">_ptr</span><span class="p">(),</span> <span class="n">callback</span><span class="p">)</span>
<span class="k">return</span> <span class="n">DSA</span><span class="p">(</span><span class="n">dsa</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span></div>
<div class="viewcode-block" id="pub_key_from_params"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.pub_key_from_params">[docs]</a><span class="k">def</span> <span class="nf">pub_key_from_params</span><span class="p">(</span><span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">g</span><span class="p">,</span> <span class="n">pub</span><span class="p">):</span>
<span class="c1"># type: (bytes, bytes, bytes, bytes) -> DSA_pub</span>
<span class="sd">"""</span>
<span class="sd"> Factory function that instantiates a DSA_pub object using</span>
<span class="sd"> the parameters and public key specified.</span>
<span class="sd"> :param p: value of p</span>
<span class="sd"> :param q: value of q</span>
<span class="sd"> :param g: value of g</span>
<span class="sd"> :param pub: value of the public key</span>
<span class="sd"> :return: instance of DSA_pub.</span>
<span class="sd"> """</span>
<span class="n">dsa</span> <span class="o">=</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_new</span><span class="p">()</span>
<span class="n">m2</span><span class="o">.</span><span class="n">dsa_set_pqg</span><span class="p">(</span><span class="n">dsa</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">g</span><span class="p">)</span>
<span class="n">m2</span><span class="o">.</span><span class="n">dsa_set_pub</span><span class="p">(</span><span class="n">dsa</span><span class="p">,</span> <span class="n">pub</span><span class="p">)</span>
<span class="k">return</span> <span class="n">DSA_pub</span><span class="p">(</span><span class="n">dsa</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span></div>
<div class="viewcode-block" id="load_pub_key"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.load_pub_key">[docs]</a><span class="k">def</span> <span class="nf">load_pub_key</span><span class="p">(</span><span class="n">file</span><span class="p">,</span> <span class="n">callback</span><span class="o">=</span><span class="n">util</span><span class="o">.</span><span class="n">passphrase_callback</span><span class="p">):</span>
<span class="c1"># type: (AnyStr, Callable) -> DSA_pub</span>
<span class="sd">"""</span>
<span class="sd"> Factory function that instantiates a DSA_pub object using</span>
<span class="sd"> a DSA public key contained in PEM file. The PEM file</span>
<span class="sd"> must contain the parameters in addition to the public key.</span>
<span class="sd"> :param file: Names the file (a path) that contains the PEM</span>
<span class="sd"> representation of the DSA public key.</span>
<span class="sd"> :param callback: A Python callback object that will be</span>
<span class="sd"> invoked should the DSA public key be</span>
<span class="sd"> passphrase-protected.</span>
<span class="sd"> :return: instance of DSA_pub.</span>
<span class="sd"> """</span>
<span class="k">with</span> <span class="n">BIO</span><span class="o">.</span><span class="n">openfile</span><span class="p">(</span><span class="n">file</span><span class="p">)</span> <span class="k">as</span> <span class="n">bio</span><span class="p">:</span>
<span class="n">ret</span> <span class="o">=</span> <span class="n">load_pub_key_bio</span><span class="p">(</span><span class="n">bio</span><span class="p">,</span> <span class="n">callback</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ret</span></div>
<div class="viewcode-block" id="load_pub_key_bio"><a class="viewcode-back" href="../../M2Crypto.html#M2Crypto.DSA.load_pub_key_bio">[docs]</a><span class="k">def</span> <span class="nf">load_pub_key_bio</span><span class="p">(</span><span class="n">bio</span><span class="p">,</span> <span class="n">callback</span><span class="o">=</span><span class="n">util</span><span class="o">.</span><span class="n">passphrase_callback</span><span class="p">):</span>
<span class="c1"># type: (BIO.BIO, Callable) -> DSA_pub</span>
<span class="sd">"""</span>
<span class="sd"> Factory function that instantiates a DSA_pub object using</span>
<span class="sd"> a DSA public key contained in PEM format. The PEM</span>
<span class="sd"> must contain the parameters in addition to the public key.</span>
<span class="sd"> :param bio: Contains the PEM representation of the DSA</span>
<span class="sd"> public key (with params).</span>
<span class="sd"> :param callback: A Python callback object that will be</span>
<span class="sd"> invoked should the DSA public key be</span>
<span class="sd"> passphrase-protected.</span>
<span class="sd"> :return: instance of DSA_pub.</span>
<span class="sd"> """</span>
<span class="n">dsapub</span> <span class="o">=</span> <span class="n">m2</span><span class="o">.</span><span class="n">dsa_read_pub_key</span><span class="p">(</span><span class="n">bio</span><span class="o">.</span><span class="n">_ptr</span><span class="p">(),</span> <span class="n">callback</span><span class="p">)</span>
<span class="k">return</span> <span class="n">DSA_pub</span><span class="p">(</span><span class="n">dsapub</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">M2Crypto</a></h1>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../M2Crypto.html">M2Crypto Package</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2017, Matej Cepl <mcepl@cepl.eu>.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.5</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div>
</body>
</html>
|
