diff options
Diffstat (limited to 'api/2.6/Crypto.Protocol.AllOrNothing.AllOrNothing-class.html')
-rw-r--r-- | api/2.6/Crypto.Protocol.AllOrNothing.AllOrNothing-class.html | 277 |
1 files changed, 277 insertions, 0 deletions
diff --git a/api/2.6/Crypto.Protocol.AllOrNothing.AllOrNothing-class.html b/api/2.6/Crypto.Protocol.AllOrNothing.AllOrNothing-class.html new file mode 100644 index 0000000..11487ec --- /dev/null +++ b/api/2.6/Crypto.Protocol.AllOrNothing.AllOrNothing-class.html @@ -0,0 +1,277 @@ +<?xml version="1.0" encoding="ascii"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>Crypto.Protocol.AllOrNothing.AllOrNothing</title> + <link rel="stylesheet" href="epydoc.css" type="text/css" /> + <script type="text/javascript" src="epydoc.js"></script> +</head> + +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="Crypto-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <!-- Project homepage --> + <th class="navbar" align="right" width="100%"> + <table border="0" cellpadding="0" cellspacing="0"> + <tr><th class="navbar" align="center" + ><a href="http://www.pycrypto.org/">PyCrypto.org</a></th> + </tr></table></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <span class="breadcrumbs"> + <a href="Crypto-module.html">Package Crypto</a> :: + <a href="Crypto.Protocol-module.html">Package Protocol</a> :: + <a href="Crypto.Protocol.AllOrNothing-module.html">Module AllOrNothing</a> :: + Class AllOrNothing + </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.Protocol.AllOrNothing.AllOrNothing-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class AllOrNothing</h1><p class="nomargin-top"></p> +<p>Class implementing the All-or-Nothing package transform.</p> +<p>Methods for subclassing:</p> +<blockquote> +<dl class="rst-docutils"> +<dt>_inventkey(key_size):</dt> +<dd>Returns a randomly generated key. Subclasses can use this to +implement better random key generating algorithms. The default +algorithm is probably not very cryptographically secure.</dd> +</dl> +</blockquote> + +<!-- ==================== INSTANCE METHODS ==================== --> +<a name="section-InstanceMethods"></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">Instance Methods</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.Protocol.AllOrNothing.AllOrNothing-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">ciphermodule</span>, + <span class="summary-sig-arg">mode</span>=<span class="summary-sig-default">None</span>, + <span class="summary-sig-arg">IV</span>=<span class="summary-sig-default">None</span>)</span><br /> + ciphermodule is a module implementing the cipher algorithm to +use. It must provide the PEP272 interface.</td> + <td align="right" valign="top"> + + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="Crypto.Protocol.AllOrNothing.AllOrNothing-class.html#digest" class="summary-sig-name">digest</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">text</span>)</span><br /> + digest(text:string) : [string]</td> + <td align="right" valign="top"> + + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="Crypto.Protocol.AllOrNothing.AllOrNothing-class.html#undigest" class="summary-sig-name">undigest</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">blocks</span>)</span><br /> + undigest(blocks : [string]) : string</td> + <td align="right" valign="top"> + + + </td> + </tr> + </table> + + </td> + </tr> +</table> +<!-- ==================== METHOD DETAILS ==================== --> +<a name="section-MethodDetails"></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">Method Details</span></td> +</tr> +</table> +<a name="__init__"></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">__init__</span>(<span class="sig-arg">ciphermodule</span>, + <span class="sig-arg">mode</span>=<span class="sig-default">None</span>, + <span class="sig-arg">IV</span>=<span class="sig-default">None</span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + > + </td> + </tr></table> + + <p>ciphermodule is a module implementing the cipher algorithm to +use. It must provide the PEP272 interface.</p> +<p>Note that the encryption key is randomly generated +automatically when needed. Optional arguments mode and IV are +passed directly through to the ciphermodule.new() method; they +are the feedback mode and initialization vector to use. All +three arguments must be the same for the object used to create +the digest, and to undigest'ify the message blocks.</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="digest"></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">digest</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">text</span>)</span> + </h3> + </td><td align="right" valign="top" + > + </td> + </tr></table> + + <p>digest(text:string) : [string]</p> +<p>Perform the All-or-Nothing package transform on the given +string. Output is a list of message blocks describing the +transformed text, where each block is a string of bit length equal +to the ciphermodule's block_size.</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="undigest"></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">undigest</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">blocks</span>)</span> + </h3> + </td><td align="right" valign="top" + > + </td> + </tr></table> + + <p>undigest(blocks : [string]) : string</p> +<p>Perform the reverse package transformation on a list of message +blocks. Note that the ciphermodule used for both transformations +must be the same. blocks is a list of strings of bit length +equal to the ciphermodule's block_size.</p> + <dl class="fields"> + </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 Thu May 24 09:02:37 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> |