diff options
Diffstat (limited to 'old/api/2.6/Crypto.Util.asn1.DerObject-class.html')
| -rw-r--r-- | old/api/2.6/Crypto.Util.asn1.DerObject-class.html | 327 |
1 files changed, 327 insertions, 0 deletions
diff --git a/old/api/2.6/Crypto.Util.asn1.DerObject-class.html b/old/api/2.6/Crypto.Util.asn1.DerObject-class.html new file mode 100644 index 0000000..a3325fe --- /dev/null +++ b/old/api/2.6/Crypto.Util.asn1.DerObject-class.html @@ -0,0 +1,327 @@ +<?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.Util.asn1.DerObject</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.Util-module.html">Package Util</a> :: + <a href="Crypto.Util.asn1-module.html">Module asn1</a> :: + Class DerObject + </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.Util.asn1.DerObject-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class DerObject</h1><p class="nomargin-top"></p> +<dl><dt>Known Subclasses:</dt> +<dd> + <ul class="subclass-list"> +<li><a href="Crypto.Util.asn1.DerInteger-class.html">DerInteger</a></li><li>, <a href="Crypto.Util.asn1.DerNull-class.html">DerNull</a></li><li>, <a href="Crypto.Util.asn1.DerObjectId-class.html">DerObjectId</a></li><li>, <a href="Crypto.Util.asn1.DerOctetString-class.html">DerOctetString</a></li><li>, <a href="Crypto.Util.asn1.DerSequence-class.html">DerSequence</a></li> </ul> +</dd></dl> + +<hr /> +<p>Base class for defining a single DER object.</p> +<p>Instantiate this class ONLY when you have to decode a DER element.</p> + +<!-- ==================== 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.Util.asn1.DerObject-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">ASN1Type</span>=<span class="summary-sig-default">None</span>, + <span class="summary-sig-arg">payload</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br /> + Initialize the DER object according to a specific type.</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 name="isType"></a><span class="summary-sig-name">isType</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">ASN1Type</span>)</span></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 name="encode"></a><span class="summary-sig-name">encode</span>(<span class="summary-sig-arg">self</span>)</span><br /> + Return a complete DER element, fully encoded as a TLV.</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.Util.asn1.DerObject-class.html#decode" class="summary-sig-name">decode</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">derEle</span>, + <span class="summary-sig-arg">noLeftOvers</span>=<span class="summary-sig-default">0</span>)</span><br /> + Decode a complete DER element, and re-initializes this +object with it.</td> + <td align="right" valign="top"> + + + </td> + </tr> + </table> + + </td> + </tr> +</table> +<!-- ==================== CLASS VARIABLES ==================== --> +<a name="section-ClassVariables"></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">Class Variables</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.Util.asn1.DerObject-class.html#typeTags" class="summary-name">typeTags</a> = <code title="{'BIT STRING': 3, + 'INTEGER': 2, + 'NULL': 5, + 'OBJECT IDENTIFIER': 6, + 'OCTET STRING': 4, + 'SEQUENCE': 48}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">BIT STRING</code><code class="variable-quote">'</code><code class="variable-op">: </code>3<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">INTEGER</code><code class="variable-quote">'</code><code class="variable-op">: </code>2<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">NULL</code><code class="variable-quote">'</code><code class="variable-op">: </code>5<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">OBJECT </code><code class="variable-ellipsis">...</code></code> + </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">self</span>, + <span class="sig-arg">ASN1Type</span>=<span class="sig-default">None</span>, + <span class="sig-arg">payload</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + > + </td> + </tr></table> + + <p>Initialize the DER object according to a specific type.</p> +<p>The ASN.1 type is either specified as the ASN.1 string (e.g. +'SEQUENCE'), directly with its numerical tag or with no tag +at all (None).</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="decode"></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">decode</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">derEle</span>, + <span class="sig-arg">noLeftOvers</span>=<span class="sig-default">0</span>)</span> + </h3> + </td><td align="right" valign="top" + > + </td> + </tr></table> + + <p>Decode a complete DER element, and re-initializes this +object with it.</p> +<dl class="rst-docutils"> +<dt>@param derEle A complete DER element. It must start with a DER T</dt> +<dd>tag.</dd> +<dt>@param noLeftOvers Indicate whether it is acceptable to complete the</dt> +<dd>parsing of the DER element and find that not all +bytes in derEle have been used.</dd> +</dl> +<p>@return Index of the first unused byte in the given DER element.</p> +<p>Raises a ValueError exception in case of parsing errors. +Raises an IndexError exception if the DER element is too short.</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<br /> +<!-- ==================== CLASS VARIABLE DETAILS ==================== --> +<a name="section-ClassVariableDetails"></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">Class Variable Details</span></td> +</tr> +</table> +<a name="typeTags"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <h3 class="epydoc">typeTags</h3> + + <dl class="fields"> + </dl> + <dl class="fields"> + <dt>Value:</dt> + <dd><table><tr><td><pre class="variable"> +<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">BIT STRING</code><code class="variable-quote">'</code><code class="variable-op">: </code>3<code class="variable-op">,</code> + <code class="variable-quote">'</code><code class="variable-string">INTEGER</code><code class="variable-quote">'</code><code class="variable-op">: </code>2<code class="variable-op">,</code> + <code class="variable-quote">'</code><code class="variable-string">NULL</code><code class="variable-quote">'</code><code class="variable-op">: </code>5<code class="variable-op">,</code> + <code class="variable-quote">'</code><code class="variable-string">OBJECT IDENTIFIER</code><code class="variable-quote">'</code><code class="variable-op">: </code>6<code class="variable-op">,</code> + <code class="variable-quote">'</code><code class="variable-string">OCTET STRING</code><code class="variable-quote">'</code><code class="variable-op">: </code>4<code class="variable-op">,</code> + <code class="variable-quote">'</code><code class="variable-string">SEQUENCE</code><code class="variable-quote">'</code><code class="variable-op">: </code>48<code class="variable-group">}</code> +</pre></td></tr></table> +</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 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> |