diff options
Diffstat (limited to 'api/2.5/Crypto.Cipher.PKCS1_OAEP-module.html')
-rw-r--r-- | api/2.5/Crypto.Cipher.PKCS1_OAEP-module.html | 261 |
1 files changed, 261 insertions, 0 deletions
diff --git a/api/2.5/Crypto.Cipher.PKCS1_OAEP-module.html b/api/2.5/Crypto.Cipher.PKCS1_OAEP-module.html new file mode 100644 index 0000000..c4e2f94 --- /dev/null +++ b/api/2.5/Crypto.Cipher.PKCS1_OAEP-module.html @@ -0,0 +1,261 @@ +<?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.Cipher.PKCS1_OAEP</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.Cipher-module.html">Package Cipher</a> :: + Module PKCS1_OAEP + </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.Cipher.PKCS1_OAEP-module.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== MODULE DESCRIPTION ==================== --> +<h1 class="epydoc">Module PKCS1_OAEP</h1><p class="nomargin-top"></p> +<p>RSA encryption protocol according to PKCS#1 OAEP</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">RSAES-OAEP</span></tt>.</p> +<p>As an example, a sender may encrypt a message in this way:</p> +<blockquote> +<pre class="py-doctest"> +<span class="py-prompt">>>> </span><span class="py-keyword">from</span> Crypto.Cipher <span class="py-keyword">import</span> PKCS1_OAEP +<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>message = <span class="py-string">'To be encrypted'</span> +<span class="py-prompt">>>> </span>key = RSA.importKey(open(<span class="py-string">'pubkey.der'</span>).read()) +<span class="py-prompt">>>> </span>cipher = PKCS1_OAEP.new(key) +<span class="py-prompt">>>> </span>ciphertext = cipher.encrypt(message)</pre> +</blockquote> +<p>At the receiver side, decryption can be done using the private part of +the RSA key:</p> +<blockquote> +<pre class="py-doctest"> +<span class="py-prompt">>>> </span>key = RSA.importKey(open(<span class="py-string">'privkey.der'</span>).read()) +<span class="py-prompt">>>> </span>cipher = PKCS1_OAP.new(key) +<span class="py-prompt">>>> </span>message = cipher.decrypt(ciphertext)</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"> </span> + </td><td class="summary"> + <a href="Crypto.Cipher.PKCS1_OAEP.PKCS1OAEP_Cipher-class.html" class="summary-name" onclick="show_private();">PKCS1OAEP_Cipher</a><br /> + This cipher can perform PKCS#1 v1.5 OAEP encryption or decryption. + </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> + <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.Cipher.PKCS1_OAEP-module.html#new" class="summary-sig-name">new</a>(<span class="summary-sig-arg">key</span>, + <span class="summary-sig-arg">hashAlgo</span>=<span class="summary-sig-default">None</span>, + <span class="summary-sig-arg">mgfunc</span>=<span class="summary-sig-default">None</span>, + <span class="summary-sig-arg">label</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br /> + Return a cipher object <a href="Crypto.Cipher.PKCS1_OAEP.PKCS1OAEP_Cipher-class.html" class="link" onclick="show_private();">PKCS1OAEP_Cipher</a> that can be used to perform PKCS#1 OAEP encryption or decryption.</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="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 class="sig-arg">hashAlgo</span>=<span class="sig-default">None</span>, + <span class="sig-arg">mgfunc</span>=<span class="sig-default">None</span>, + <span class="sig-arg">label</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span> + </h3> + </td><td align="right" valign="top" + > + </td> + </tr></table> + + Return a cipher object <a href="Crypto.Cipher.PKCS1_OAEP.PKCS1OAEP_Cipher-class.html" class="link" onclick="show_private();">PKCS1OAEP_Cipher</a> that can be used to perform PKCS#1 OAEP encryption or decryption. + <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 encrypt or decrypt the message. This is a <a href="Crypto.PublicKey.RSA-module.html" class="link">Crypto.PublicKey.RSA</a> object. +Decryption is only possible if <em>key</em> is a private RSA key.</li> + <li><strong class="pname"><code>hashAlgo</code></strong> (hash object) - The hash function to use. This can be a module under <a href="Crypto.Hash-module.html" class="link">Crypto.Hash</a> +or an existing hash object created from any of such modules. If not specified, +<a href="Crypto.Hash.SHA-module.html" class="link">Crypto.Hash.SHA</a> (that is, SHA-1) is used.</li> + <li><strong class="pname"><code>mgfunc</code></strong> (callable) - A mask generation function that accepts two parameters: a string to +use as seed, and the lenth of the mask to generate, in bytes. +If not specified, the standard MGF1 is used (a safe choice).</li> + <li><strong class="pname"><code>label</code></strong> (string) - A label to apply to this particular encryption. If not specified, +an empty string is used. Specifying a label does not improve +security.</li> + </ul></dd> + </dl> +<div class="fields"> <p><strong>Attention:</strong> + Modify the mask generation function only if you know what you are doing. +Sender and receiver must use the same one. + </p> +</div></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> |