summaryrefslogtreecommitdiff
path: root/old/api/2.5/Crypto.Signature.PKCS1_v1_5-module.html
blob: 3c28ea72542d960122b828daee79543cb014de57 (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
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
<?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.Signature.PKCS1_v1_5</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>&nbsp;&nbsp;&nbsp;<a
        href="Crypto-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;Crypto</a> ::
        <a href="Crypto.Signature-module.html">Package&nbsp;Signature</a> ::
        Module&nbsp;PKCS1_v1_5
      </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&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="Crypto.Signature.PKCS1_v1_5-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module PKCS1_v1_5</h1><p class="nomargin-top"></p>
<p>RSA digital signature protocol according to PKCS#1 v1.5</p>
<p>See <a class="rst-reference external" href="http://www.ietf.org/rfc/rfc3447.txt" target="_top">RFC3447</a> or the <a class="rst-reference external" href="http://www.rsa.com/rsalabs/node.asp?id=2125" target="_top">original RSA Labs specification</a>.</p>
<p>This scheme is more properly called <tt class="rst-docutils literal"><span class="pre">RSASSA-PKCS1-v1_5</span></tt>.</p>
<p>For example, a sender may authenticate a message using SHA-1 like
this:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span><span class="py-keyword">from</span> Crypto.Signature <span class="py-keyword">import</span> PKCS1_v1_5
<span class="py-prompt">&gt;&gt;&gt; </span><span class="py-keyword">from</span> Crypto.Hash <span class="py-keyword">import</span> SHA
<span class="py-prompt">&gt;&gt;&gt; </span><span class="py-keyword">from</span> Crypto.PublicKey <span class="py-keyword">import</span> RSA
<span class="py-prompt">&gt;&gt;&gt;</span>
<span class="py-prompt">&gt;&gt;&gt; </span>message = <span class="py-string">'To be signed'</span>
<span class="py-prompt">&gt;&gt;&gt; </span>key = RSA.importKey(open(<span class="py-string">'privkey.der'</span>).read())
<span class="py-prompt">&gt;&gt;&gt; </span>h = SHA.new(message)
<span class="py-prompt">&gt;&gt;&gt; </span>signer = PKCS1_v1_5.new(key)
<span class="py-prompt">&gt;&gt;&gt; </span>signature = signer.sign(h)</pre>
</blockquote>
<p>At the receiver side, verification can be done using the public part of
the RSA key:</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>key = RSA.importKey(open(<span class="py-string">'pubkey.der'</span>).read())
<span class="py-prompt">&gt;&gt;&gt; </span>h = SHA.new(message)
<span class="py-prompt">&gt;&gt;&gt; </span>verifier = PKCS1_v1_5.new(key)
<span class="py-prompt">&gt;&gt;&gt; </span><span class="py-keyword">if</span> verifier.verify(h, signature):
<span class="py-prompt">&gt;&gt;&gt; </span>   <span class="py-keyword">print</span> <span class="py-string">&quot;The signature is authentic.&quot;</span>
<span class="py-prompt">&gt;&gt;&gt; </span><span class="py-keyword">else</span>:
<span class="py-prompt">&gt;&gt;&gt; </span>   <span class="py-keyword">print</span> <span class="py-string">&quot;The signature is not authentic.&quot;</span></pre>
</blockquote>

<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></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">Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Classes"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="Crypto.Signature.PKCS1_v1_5.PKCS115_SigScheme-class.html" class="summary-name" onclick="show_private();">PKCS115_SigScheme</a><br />
      This signature scheme can perform PKCS#1 v1.5 RSA signature or verification.
    </td>
  </tr>
</table>
<!-- ==================== 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 class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Crypto.Signature.PKCS1_v1_5-module.html#EMSA_PKCS1_V1_5_ENCODE" class="summary-sig-name" onclick="show_private();">EMSA_PKCS1_V1_5_ENCODE</a>(<span class="summary-sig-arg">hash</span>,
        <span class="summary-sig-arg">emLen</span>)</span><br />
      Implement the <tt class="rst-docutils literal"><span class="pre">EMSA-PKCS1-V1_5-ENCODE</span></tt> function, as defined
in PKCS#1 v2.1 (RFC3447, 9.2).</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">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Crypto.Signature.PKCS1_v1_5-module.html#new" class="summary-sig-name">new</a>(<span class="summary-sig-arg">key</span>)</span><br />
      Return a signature scheme object <a href="Crypto.Signature.PKCS1_v1_5.PKCS115_SigScheme-class.html" class="link" onclick="show_private();">PKCS115_SigScheme</a> that
can be used to perform PKCS#1 v1.5 signature or verification.</td>
          <td align="right" valign="top">
            
            
          </td>
        </tr>
      </table>
      
    </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="EMSA_PKCS1_V1_5_ENCODE"></a>
<div class="private">
<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">EMSA_PKCS1_V1_5_ENCODE</span>(<span class="sig-arg">hash</span>,
        <span class="sig-arg">emLen</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  <p>Implement the <tt class="rst-rst-docutils literal rst-docutils literal"><span class="pre">EMSA-PKCS1-V1_5-ENCODE</span></tt> function, as defined
in PKCS#1 v2.1 (RFC3447, 9.2).</p>
<p><tt class="rst-docutils literal"><span class="pre">EMSA-PKCS1-V1_5-ENCODE</span></tt> actually accepts the message <tt class="rst-docutils literal">M</tt> as input,
and hash it internally. Here, we expect that the message has already
been hashed instead.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>hash</code></strong> (hash object) - The hash object that holds the digest of the message being signed.</li>
        <li><strong class="pname"><code>emLen</code></strong> (int) - The length the final encoding must have, in bytes.</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>An <tt class="rst-docutils literal">emLen</tt> byte long string that encodes the hash.</dd>
  </dl>
<div class="fields">      <strong>Attention:</strong>
      <ul class="nomargin-top">
        <li>
        the early standard (RFC2313) stated that <tt class="rst-docutils literal">DigestInfo</tt>
had to be BER-encoded. This means that old signatures
might have length tags in indefinite form, which
is not supported in DER. Such encoding cannot be
reproduced by this function.
        </li>
        <li>
        the same standard defined <tt class="rst-docutils literal">DigestAlgorithm</tt> to be
of <tt class="rst-docutils literal">AlgorithmIdentifier</tt> type, where the PARAMETERS
item is optional. Encodings for <tt class="rst-docutils literal">MD2/4/5</tt> without
<tt class="rst-docutils literal">PARAMETERS</tt> cannot be reproduced by this function.
        </li>
      </ul>
</div></td></tr></table>
</div>
<a name="new"></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">new</span>(<span class="sig-arg">key</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    >&nbsp;
    </td>
  </tr></table>
  
  Return a signature scheme object <a href="Crypto.Signature.PKCS1_v1_5.PKCS115_SigScheme-class.html" class="link" onclick="show_private();">PKCS115_SigScheme</a> that
can be used to perform PKCS#1 v1.5 signature or verification.
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>key</code></strong> (RSA key object) - The key to use to sign or verify the message. This is a <a href="Crypto.PublicKey.RSA-module.html" class="link">Crypto.PublicKey.RSA</a> object.
Signing is only possible if <em>key</em> is a private RSA key.</li>
    </ul></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>&nbsp;&nbsp;&nbsp;<a
        href="Crypto-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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:11 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>