/usr/share/doc/python-crypto-doc/Crypto.PublicKey.RSA-module.html is in python-crypto-doc 2.6.1-4ubuntu0.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <?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.PublicKey.RSA</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.PublicKey-module.html">Package PublicKey</a> ::
Module RSA
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Crypto.PublicKey.RSA-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module RSA</h1><p class="nomargin-top"></p>
<p>RSA public-key cryptography algorithm (signature and encryption).</p>
<p><a class="rst-reference external" href="http://en.wikipedia.org/wiki/RSA_%28algorithm%29" target="_top">RSA</a> is the most widespread and used public key algorithm. Its security is
based on the difficulty of factoring large integers. The algorithm has
withstood attacks for 30 years, and it is therefore considered reasonably
secure for new designs.</p>
<p>The algorithm can be used for both confidentiality (encryption) and
authentication (digital signature). It is worth noting that signing and
decryption are significantly slower than verification and encryption.
The cryptograhic strength is primarily linked to the length of the modulus <em>n</em>.
In 2012, a sufficient length is deemed to be 2048 bits. For more information,
see the most recent <a class="rst-reference external" href="http://www.ecrypt.eu.org/documents/D.SPA.17.pdf" target="_top">ECRYPT</a> report.</p>
<p>Both RSA ciphertext and RSA signature are as big as the modulus <em>n</em> (256
bytes if <em>n</em> is 2048 bit long).</p>
<p>This module provides facilities for generating fresh, new RSA keys, constructing
them from known components, exporting them, and importing them.</p>
<blockquote>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">from</span> Crypto.PublicKey <span class="py-keyword">import</span> RSA
<span class="py-prompt">>>></span>
<span class="py-prompt">>>> </span>key = RSA.generate(2048)
<span class="py-prompt">>>> </span>f = open(<span class="py-string">'mykey.pem'</span>,<span class="py-string">'w'</span>)
<span class="py-prompt">>>> </span>f.write(RSA.exportKey(<span class="py-string">'PEM'</span>))
<span class="py-prompt">>>> </span>f.close()
<span class="py-more">...</span>
<span class="py-prompt">>>> </span>f = open(<span class="py-string">'mykey.pem'</span>,<span class="py-string">'r'</span>)
<span class="py-prompt">>>> </span>key = RSA.importKey(f.read())</pre>
</blockquote>
<p>Even though you may choose to directly use the methods of an RSA key object
to perform the primitive cryptographic operations (e.g. <a href="Crypto.PublicKey.RSA._RSAobj-class.html#encrypt" class="link">_RSAobj.encrypt</a>),
it is recommended to use one of the standardized schemes instead (like
<a href="Crypto.Cipher.PKCS1_v1_5-module.html" class="link">Crypto.Cipher.PKCS1_v1_5</a> or <a href="Crypto.Signature.PKCS1_v1_5-module.html" class="link">Crypto.Signature.PKCS1_v1_5</a>).</p>
<!-- ==================== 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 align="left" colspan="2" class="table-header">
<span class="table-header">Classes</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Crypto.PublicKey.RSA.error-class.html" class="summary-name">error</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Crypto.PublicKey.RSA._RSAobj-class.html" class="summary-name">_RSAobj</a><br />
Class defining an actual RSA key.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Crypto.PublicKey.RSA.RSAImplementation-class.html" class="summary-name">RSAImplementation</a><br />
An RSA key factory.
</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 align="left" colspan="2" class="table-header">
<span class="table-header">Functions</span></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.PublicKey.RSA-module.html#generate" class="summary-sig-name">generate</a>(<span class="summary-sig-arg">bits</span>,
<span class="summary-sig-arg">randfunc</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">progress_func</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">e</span>=<span class="summary-sig-default">65537</span>)</span><br />
Randomly generate a fresh, new RSA key object.</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.PublicKey.RSA-module.html#construct" class="summary-sig-name">construct</a>(<span class="summary-sig-arg">tup</span>)</span><br />
Construct an RSA key object from a tuple of valid RSA components.</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.PublicKey.RSA-module.html#importKey" class="summary-sig-name">importKey</a>(<span class="summary-sig-arg">externKey</span>,
<span class="summary-sig-arg">passphrase</span>=<span class="summary-sig-default">None</span>)</span><br />
Import an RSA key (public or private half), encoded in standard form.</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 align="left" colspan="2" class="table-header">
<span class="table-header">Function Details</span></td>
</tr>
</table>
<a name="generate"></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">generate</span>(<span class="sig-arg">bits</span>,
<span class="sig-arg">randfunc</span>=<span class="sig-default">None</span>,
<span class="sig-arg">progress_func</span>=<span class="sig-default">None</span>,
<span class="sig-arg">e</span>=<span class="sig-default">65537</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Randomly generate a fresh, new RSA key object.</p>
<p>See <a href="Crypto.PublicKey.RSA.RSAImplementation-class.html#generate" class="link">RSAImplementation.generate</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>bits</code></strong> (int) - Key length, or size (in bits) of the RSA modulus.
It must be a multiple of 256, and no smaller than 1024.</li>
<li><strong class="pname"><code>randfunc</code></strong> (callable) - Random number generation function; it should accept
a single integer N and return a string of random data
N bytes long.
If not specified, a new one will be instantiated
from <tt class="rst-docutils literal">Crypto.Random</tt>.</li>
<li><strong class="pname"><code>progress_func</code></strong> (callable) - Optional function that will be called with a short string
containing the key parameter currently being generated;
it's useful for interactive applications where a user is
waiting for a key to be generated.</li>
<li><strong class="pname"><code>e</code></strong> (int) - Public RSA exponent. It must be an odd positive integer.
It is typically a small number with very few ones in its
binary representation.
The default value 65537 (= <tt class="rst-docutils literal">0b10000000000000001</tt> ) is a safe
choice: other common values are 5, 7, 17, and 257.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>An RSA key object (<a href="Crypto.PublicKey.RSA._RSAobj-class.html" class="link">_RSAobj</a>).</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError</strong></code> - When <strong>bits</strong> is too little or not a multiple of 256, or when
<strong>e</strong> is not odd or smaller than 2.</li>
</ul></dd>
</dl>
<div class="fields"> <strong>Attention:</strong>
<ul class="nomargin-top">
<li>
You should always use a cryptographically secure random number generator,
such as the one defined in the <tt class="rst-docutils literal">Crypto.Random</tt> module; <strong>don't</strong> just use the
current time and the <tt class="rst-docutils literal">random</tt> module.
</li>
<li>
Exponent 3 is also widely used, but it requires very special care when padding
the message.
</li>
</ul>
</div></td></tr></table>
</div>
<a name="construct"></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">construct</span>(<span class="sig-arg">tup</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Construct an RSA key object from a tuple of valid RSA components.</p>
<p>See <a href="Crypto.PublicKey.RSA.RSAImplementation-class.html#construct" class="link">RSAImplementation.construct</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><p><strong class="pname"><code>tup</code></strong> (tuple) - A tuple of long integers, with at least 2 and no
more than 6 items. The items come in the following order:</p>
<ol class="rst-arabic simple">
<li>RSA modulus (n).</li>
<li>Public exponent (e).</li>
<li>Private exponent (d). Only required if the key is private.</li>
<li>First factor of n (p). Optional.</li>
<li>Second factor of n (q). Optional.</li>
<li>CRT coefficient, (1/p) mod q (u). Optional.</li>
</ol></li>
</ul></dd>
<dt>Returns:</dt>
<dd>An RSA key object (<a href="Crypto.PublicKey.RSA._RSAobj-class.html" class="link">_RSAobj</a>).</dd>
</dl>
</td></tr></table>
</div>
<a name="importKey"></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">importKey</span>(<span class="sig-arg">externKey</span>,
<span class="sig-arg">passphrase</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Import an RSA key (public or private half), encoded in standard form.</p>
<p>See <a href="Crypto.PublicKey.RSA.RSAImplementation-class.html#importKey" class="link">RSAImplementation.importKey</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><p><strong class="pname"><code>externKey</code></strong> (string) - The RSA key to import, encoded as a string.</p>
<p>An RSA public key can be in any of the following formats:</p>
<ul class="rst-simple">
<li>X.509 <code class="link">subjectPublicKeyInfo</code> DER SEQUENCE (binary or PEM encoding)</li>
<li><a class="rst-reference external" href="http://www.ietf.org/rfc/rfc3447.txt" target="_top">PKCS#1</a> <code class="link">RSAPublicKey</code> DER SEQUENCE (binary or PEM encoding)</li>
<li>OpenSSH (textual public key only)</li>
</ul>
<p>An RSA private key can be in any of the following formats:</p>
<ul class="rst-simple">
<li>PKCS#1 <code class="link">RSAPrivateKey</code> DER SEQUENCE (binary or PEM encoding)</li>
<li><a class="rst-reference external" href="http://www.ietf.org/rfc/rfc5208.txt" target="_top">PKCS#8</a> <code class="link">PrivateKeyInfo</code> DER SEQUENCE (binary or PEM encoding)</li>
<li>OpenSSH (textual public key only)</li>
</ul>
<p>For details about the PEM encoding, see <a class="rst-reference external" href="http://www.ietf.org/rfc/rfc1421.txt" target="_top">RFC1421</a>/<a class="rst-reference external" href="http://www.ietf.org/rfc/rfc1423.txt" target="_top">RFC1423</a>.</p>
<p>In case of PEM encoding, the private key can be encrypted with DES or 3TDES according to a certain <tt class="rst-docutils literal">pass phrase</tt>.
Only OpenSSL-compatible pass phrases are supported.</p></li>
<li><strong class="pname"><code>passphrase</code></strong> (string) - In case of an encrypted PEM key, this is the pass phrase from which the encryption key is derived.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>An RSA key object (<a href="Crypto.PublicKey.RSA._RSAobj-class.html" class="link">_RSAobj</a>).</dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'>ValueError/IndexError/TypeError</strong></code> - When the given key cannot be parsed (possibly because the pass phrase is wrong).</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> <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 Mar 30 15:40:57 2018
</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>
|