autodoc.git
/
traditional_manual
/
chapter_21.html
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/traditional_manual/chapter_21.html:3486:
<dd class='body--doc'><p>Signs the <code>message</code> with a PKCS-1 signature using hash algorithm <code>h</code>.</p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>pkcs_signature_algorithm_id</b></span> </dt>
-
<dd><p><code><code class='object unresolved'>Sequence</code> <b><span class='method'>pkcs_signature_algorithm_id</span>(</b><code class='object unresolved'>.Hash</code> <code class='argument'>hash</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='object unresolved'>Sequence</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>pkcs_signature_algorithm_id</span>(</b><code class='object unresolved'>.Hash</code> <code class='argument'>hash</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Returns the PKCS-1 algorithm identifier for DSA and the provided hash algorithm. Only <code>SHA1</code> supported.</p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span>
autodoc.git/traditional_manual/chapter_21.html:3664:
<dd class='body--doc'><p>Returns the PKCS-1 elliptic curve parameters for the curve. cf <b><a href='http://pike.lysator.liu.se/rfc5480.xml#2.1.1'>RFC 5480 section 2.1.1</a></b>.</p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>pkcs_named_curve_id</b></span> </dt>
-
<dd><p><code><code class='object unresolved'>Identifier</code> <b><span class='method'>pkcs_named_curve_id</span>(</b><b>)</b></code></p></dd>
+
<dd><p><code><code class='object unresolved'>Identifier</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>pkcs_named_curve_id</span>(</b><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Returns the PKCS-1 elliptic curve identifier for the curve. cf <b><a href='http://pike.lysator.liu.se/rfc5480.xml#2.1.1'>RFC 5480 section 2.1.1</a></b>.</p> </dd></dl> <dl><dt><h2 class='header'>Class <b class='ms datatype'>Crypto.ECC.Curve.ECDSA</b></h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Elliptic Curve Digital Signing Algorithm</p> </dd></dl>
autodoc.git/traditional_manual/chapter_21.html:3750:
</dt> <dd><p><code><span class='datatype'>inherit ECC_Curve::ECDSA</span> : <span class='inherit'>ECDSA</span></code></p></dd> </dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>jose_decode</b></span> </dt>
-
<dd><p><code><code class='datatype'>array</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>string(8bit)</code>) <b><span class='method'>jose_decode</span>(</b><code class='datatype'>string(7bit)</code> <code class='argument'>jws</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>array</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>string(8bit)</code>)
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>jose_decode</span>(</b><code class='datatype'>string(7bit)</code> <code class='argument'>jws</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Verify and decode a JOSE JWS ECDSA signed value.</p> </dd> <dt class='head--doc'><span id='p-jws'></span>Parameter <code class='parameter'>jws</code></dt> <dd></dd><dd class='body--doc'><p>A JSON Web Signature as returned by <code>jose_sign()</code>.</p> </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'><p>Returns <code class='expr'>0</code> (zero) on failure, and an array</p> <table class='box'><tr><td colspan='2'>Array</td></tr>
autodoc.git/traditional_manual/chapter_21.html:3777:
<dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>pkcs_verify()</code>, <b><a href='http://pike.lysator.liu.se/rfc7515.xml#3.5'>RFC 7515 section 3.5</a></b></p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>jose_sign</b></span> </dt>
-
<dd><p><code><code class='datatype'>string(7bit)</code> <b><span class='method'>jose_sign</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>message</code>, <code class='object unresolved'>.Hash</code>|<code class='datatype'>void</code> <code class='argument'>h</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>void</code> <code class='argument'>headers</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>string(7bit)</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>jose_sign</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>message</code>, <code class='object unresolved'>.Hash</code>|<code class='datatype'>void</code> <code class='argument'>h</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>void</code> <code class='argument'>headers</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Signs the <code>message</code> with a JOSE JWS ECDSA signature using hash algorithm <code>h</code>.</p> </dd> <dt class='head--doc'><span id='p-message'></span>Parameter <code class='parameter'>message</code></dt> <dd></dd><dd class='body--doc'><p>Message to sign.</p> </dd> <dt class='head--doc'><span id='p-h'></span>Parameter <code class='parameter'>h</code></dt> <dd></dd><dd class='body--doc'><p>Hash algorithm to use.</p>
autodoc.git/traditional_manual/chapter_21.html:3803:
<dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>pkcs_verify()</code>, <code>salt_size()</code>, <b><a href='http://pike.lysator.liu.se/rfc7515.xml'>RFC 7515</a></b></p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>jwa</b></span> </dt>
-
<dd><p><code><code class='datatype'>string(7bit)</code> <b><span class='method'>jwa</span>(</b><code class='object unresolved'>.Hash</code> <code class='argument'>hash</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>string(7bit)</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>jwa</span>(</b><code class='object unresolved'>.Hash</code> <code class='argument'>hash</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Get the JWS algorithm identifier for a hash.</p> </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'><p>Returns <code class='expr'>0</code> (zero) on failure.</p> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><p><b><a href='http://pike.lysator.liu.se/rfc7518.xml#3.1'>RFC 7518 section 3.1</a></b></p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>jwk</b></span> </dt>
-
<dd><p><code><code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>) <b><span class='method'>jwk</span>(</b><code class='datatype'>bool</code>|<code class='datatype'>void</code> <code class='argument'>private_key</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>)
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>jwk</span>(</b><code class='datatype'>bool</code>|<code class='datatype'>void</code> <code class='argument'>private_key</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Generate a JWK-style mapping of the object.</p> </dd> <dt class='head--doc'><span id='p-private_key'></span>Parameter <code class='parameter'>private_key</code></dt> <dd></dd><dd class='body--doc'><p>If true, include the private key in the result.</p> </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'><p>Returns a JWK-style mapping on success, and <code class='expr'>0</code> (zero) on failure.</p>
autodoc.git/traditional_manual/chapter_21.html:3894:
<dd class='body--doc'><p>Signs the <code>message</code> with a PKCS-1 signature using hash algorithm <code>h</code>.</p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>pkcs_signature_algorithm_id</b></span> </dt>
-
<dd><p><code><code class='object unresolved'>Sequence</code> <b><span class='method'>pkcs_signature_algorithm_id</span>(</b><code class='object unresolved'>.Hash</code> <code class='argument'>hash</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='object unresolved'>Sequence</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>pkcs_signature_algorithm_id</span>(</b><code class='object unresolved'>.Hash</code> <code class='argument'>hash</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Returns the PKCS-1 algorithm identifier for ECDSA and the provided hash algorithm. Only SHA-1 and SHA-2 based hashes are supported currently.</p> </dd></dl> <hr /> <dl class='group--doc'>
autodoc.git/traditional_manual/chapter_21.html:4159:
</dt> <dd><p><code><span class='datatype'>inherit Curve25519::EdDSA</span> : <span class='inherit'>EdDSA</span></code></p></dd> </dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>jose_decode</b></span> </dt>
-
<dd><p><code><code class='datatype'>array</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>string(8bit)</code>) <b><span class='method'>jose_decode</span>(</b><code class='datatype'>string(7bit)</code> <code class='argument'>jws</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>array</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>string(8bit)</code>)
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>jose_decode</span>(</b><code class='datatype'>string(7bit)</code> <code class='argument'>jws</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Verify and decode a JOSE JWS EdDSA signed value.</p> </dd> <dt class='head--doc'><span id='p-jws'></span>Parameter <code class='parameter'>jws</code></dt> <dd></dd><dd class='body--doc'><p>A JSON Web Signature as returned by <code>jose_sign()</code>.</p> </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'><p>Returns <code class='expr'>0</code> (zero) on failure, and an array</p> <table class='box'><tr><td colspan='2'>Array</td></tr>
autodoc.git/traditional_manual/chapter_21.html:4186:
<dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>pkcs_verify()</code>, <b><a href='http://pike.lysator.liu.se/rfc7515.xml#3.5'>RFC 7515 section 3.5</a></b></p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>jose_sign</b></span> </dt>
-
<dd><p><code><code class='datatype'>string(7bit)</code> <b><span class='method'>jose_sign</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>message</code>, <code class='object unresolved'>.Hash</code>|<code class='datatype'>void</code> <code class='argument'>h</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>void</code> <code class='argument'>headers</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>string(7bit)</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>jose_sign</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>message</code>, <code class='object unresolved'>.Hash</code>|<code class='datatype'>void</code> <code class='argument'>h</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>void</code> <code class='argument'>headers</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Signs the <code>message</code> with a JOSE JWS EdDSA signature.</p> </dd> <dt class='head--doc'><span id='p-message'></span>Parameter <code class='parameter'>message</code></dt> <dd></dd><dd class='body--doc'><p>Message to sign.</p> </dd> <dt class='head--doc'><span id='p-h'></span>Parameter <code class='parameter'>h</code></dt> <dd></dd><dd class='body--doc'><p>Hash algorithm to use; ignored for Ed25519.</p> </dd>
autodoc.git/traditional_manual/chapter_21.html:4232:
<dt class='head--doc'>See also</dt> <dd class='body--doc'><p><b><a href='http://pike.lysator.liu.se/rfc7518.xml#3.1'>RFC 7518 section 3.1</a></b></p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>jwk</b></span> </dt>
-
<dd><p><code><code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>) <b><span class='method'>jwk</span>(</b><code class='datatype'>bool</code>|<code class='datatype'>void</code> <code class='argument'>private_key</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>)
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>jwk</span>(</b><code class='datatype'>bool</code>|<code class='datatype'>void</code> <code class='argument'>private_key</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Generate a JWK-style mapping of the object.</p> </dd> <dt class='head--doc'><span id='p-private_key'></span>Parameter <code class='parameter'>private_key</code></dt> <dd></dd><dd class='body--doc'><p>If true, include the private key in the result.</p> </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'><p>Returns a JWK-style mapping on success, and <code class='expr'>0</code> (zero) on failure.</p>
autodoc.git/traditional_manual/chapter_21.html:4935:
will be used, which defaults to 65537. Keys must be at least 89 bits.</p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>get_d</b></span> </dt>
-
<dd><p><code><code class='object unresolved'>Gmp.mpz</code> <b><span class='method'>get_d</span>(</b><b>)</b></code></p></dd>
+
<dd><p><code><code class='object unresolved'>Gmp.mpz</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>get_d</span>(</b><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Returns the RSA private exponent (d), if known.</p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>get_e</b></span> </dt>
-
<dd><p><code><code class='object unresolved'>Gmp.mpz</code> <b><span class='method'>get_e</span>(</b><b>)</b></code></p></dd>
+
<dd><p><code><code class='object unresolved'>Gmp.mpz</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>get_e</span>(</b><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Returns the RSA public exponent (e).</p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>get_n</b></span> </dt>
-
<dd><p><code><code class='object unresolved'>Gmp.mpz</code> <b><span class='method'>get_n</span>(</b><b>)</b></code></p></dd>
+
<dd><p><code><code class='object unresolved'>Gmp.mpz</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>get_n</span>(</b><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Returns the RSA modulo (n).</p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>get_p</b></span> </dt>
-
<dd><p><code><code class='object unresolved'>Gmp.mpz</code> <b><span class='method'>get_p</span>(</b><b>)</b></code></p></dd>
+
<dd><p><code><code class='object unresolved'>Gmp.mpz</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>get_p</span>(</b><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Returns the first RSA prime (p), if known.</p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>get_q</b></span> </dt>
-
<dd><p><code><code class='object unresolved'>Gmp.mpz</code> <b><span class='method'>get_q</span>(</b><b>)</b></code></p></dd>
+
<dd><p><code><code class='object unresolved'>Gmp.mpz</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>get_q</span>(</b><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Returns the second RSA prime (q), if known.</p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Inherit</span> <span class='homogen--name'><b>State</b></span>
autodoc.git/traditional_manual/chapter_21.html:5022:
<dt class='head--doc'>See also</dt> <dd class='body--doc'><p><b><a href='http://pike.lysator.liu.se/rfc7518.xml#3.1'>RFC 7518 section 3.1</a></b></p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>jwk</b></span> </dt>
-
<dd><p><code><code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>) <b><span class='method'>jwk</span>(</b><code class='datatype'>bool</code>|<code class='datatype'>void</code> <code class='argument'>private_key</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>)
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>jwk</span>(</b><code class='datatype'>bool</code>|<code class='datatype'>void</code> <code class='argument'>private_key</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Generate a JWK-style mapping of the object.</p> </dd> <dt class='head--doc'><span id='p-private_key'></span>Parameter <code class='parameter'>private_key</code></dt> <dd></dd><dd class='body--doc'><p>If true, include the private key in the result. Note that if the private key isn't known, the function will fail (and return <code class='expr'>0</code>).</p> </dd> <dt class='head--doc'>Returns</dt>
autodoc.git/traditional_manual/chapter_21.html:5311:
</dt> <dd><p><code><span class='datatype'>inherit PSSState</span> : <span class='inherit'>PSSState</span></code></p></dd> </dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>jose_decode</b></span> </dt>
-
<dd><p><code><code class='datatype'>array</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>string(8bit)</code>) <b><span class='method'>jose_decode</span>(</b><code class='datatype'>string(7bit)</code> <code class='argument'>jws</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>array</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>string(8bit)</code>)
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>jose_decode</span>(</b><code class='datatype'>string(7bit)</code> <code class='argument'>jws</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Verify and decode a JOSE JWS RSASSA-PKCS-v1.5 signed value.</p> </dd> <dt class='head--doc'><span id='p-jws'></span>Parameter <code class='parameter'>jws</code></dt> <dd></dd><dd class='body--doc'><p>A JSON Web Signature as returned by <code>jose_sign()</code>.</p> </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'><p>Returns <code class='expr'>0</code> (zero) on failure, and an array</p> <table class='box'><tr><td colspan='2'>Array</td></tr>
autodoc.git/traditional_manual/chapter_21.html:5338:
<dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>pkcs_verify()</code>, <b><a href='http://pike.lysator.liu.se/rfc7515.xml#3.5'>RFC 7515 section 3.5</a></b></p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>jose_sign</b></span> </dt>
-
<dd><p><code><code class='datatype'>string(7bit)</code> <b><span class='method'>jose_sign</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>message</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>void</code> <code class='argument'>headers</code>, <code class='object unresolved'>.Hash</code>|<code class='datatype'>void</code> <code class='argument'>h</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>string(7bit)</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>jose_sign</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>message</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>void</code> <code class='argument'>headers</code>, <code class='object unresolved'>.Hash</code>|<code class='datatype'>void</code> <code class='argument'>h</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Signs the <code>message</code> with a JOSE JWS RSASSA-PKCS-v1.5 signature using hash algorithm <code>h</code>.</p> </dd> <dt class='head--doc'><span id='p-message'></span>Parameter <code class='parameter'>message</code></dt> <dd></dd><dd class='body--doc'><p>Message to sign.</p> </dd> <dt class='head--doc'><span id='p-headers'></span>Parameter <code class='parameter'>headers</code></dt> <dd></dd><dd class='body--doc'><p>JOSE headers to use. Typically a mapping with a single element
autodoc.git/traditional_manual/chapter_21.html:5369:
<dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>pkcs_verify()</code>, <code>salt_size()</code>, <b><a href='http://pike.lysator.liu.se/rfc7515.xml'>RFC 7515</a></b></p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>jwa</b></span> </dt>
-
<dd><p><code><code class='datatype'>string(7bit)</code> <b><span class='method'>jwa</span>(</b><code class='object unresolved'>.Hash</code> <code class='argument'>hash</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>string(7bit)</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>jwa</span>(</b><code class='object unresolved'>.Hash</code> <code class='argument'>hash</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Get the JWS algorithm identifier for a hash.</p> </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'><p>Returns <code class='expr'>0</code> (zero) on failure.</p> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><p><b><a href='http://pike.lysator.liu.se/rfc7518.xml#3.1'>RFC 7518 section 3.1</a></b></p> </dd></dl>
autodoc.git/traditional_manual/chapter_21.html:5506:
</td></tr> </table> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>rsa_unpad</b></span> </dt>
-
<dd><p><code><code class='datatype'>string(8bit)</code> <b><span class='method'>rsa_unpad</span>(</b><code class='object unresolved'>Gmp.mpz</code> <code class='argument'>block</code>, <code class='datatype'>int</code> <code class='argument'>type</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>string(8bit)</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>rsa_unpad</span>(</b><code class='object unresolved'>Gmp.mpz</code> <code class='argument'>block</code>, <code class='datatype'>int</code> <code class='argument'>type</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Reverse the effect of <code>rsa_pad</code>.</p> </dd></dl> </dd></dl><dl><dt><h2 class='header'>Class <b class='ms datatype'>Crypto.RSA.PSSState</b></h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'><p>RSA PSS signatures (<b><a href='http://pike.lysator.liu.se/rfc3447.xml#8.1'>RFC 3447 section 8.1</a></b>).</p> </dd> <dt class='head--doc'>See also</dt>
autodoc.git/traditional_manual/chapter_21.html:5549:
</dt> <dd><p><code><span class='datatype'>inherit OAEPState</span> : <span class='inherit'>OAEPState</span></code></p></dd> </dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>jose_decode</b></span> </dt>
-
<dd><p><code><code class='modifier'>local</code> <code class='datatype'>array</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>string(8bit)</code>) <b><span class='method'>jose_decode</span>(</b><code class='datatype'>string(7bit)</code> <code class='argument'>jws</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='modifier'>local</code> <code class='datatype'>array</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>string(8bit)</code>)
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>jose_decode</span>(</b><code class='datatype'>string(7bit)</code> <code class='argument'>jws</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Verify and decode a JOSE JWS RSASSA-PSS signed value.</p> </dd> <dt class='head--doc'><span id='p-jws'></span>Parameter <code class='parameter'>jws</code></dt> <dd></dd><dd class='body--doc'><p>A JSON Web Signature as returned by <code>jose_sign()</code>.</p> </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'><p>Returns <code class='expr'>0</code> (zero) on failure, and an array</p> <table class='box'><tr><td colspan='2'>Array</td></tr>
autodoc.git/traditional_manual/chapter_21.html:5576:
<dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>pkcs_verify()</code>, <b><a href='http://pike.lysator.liu.se/rfc7515.xml#3.5'>RFC 7515 section 3.5</a></b></p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>jose_sign</b></span> </dt>
-
<dd><p><code><code class='modifier'>local</code> <code class='datatype'>string(7bit)</code> <b><span class='method'>jose_sign</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>message</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>void</code> <code class='argument'>headers</code>, <code class='object unresolved'>.Hash</code>|<code class='datatype'>void</code> <code class='argument'>h</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='modifier'>local</code> <code class='datatype'>string(7bit)</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>jose_sign</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>message</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string(7bit)</code>:<code class='datatype'>string(7bit)</code>|<code class='datatype'>int</code>)|<code class='datatype'>void</code> <code class='argument'>headers</code>, <code class='object unresolved'>.Hash</code>|<code class='datatype'>void</code> <code class='argument'>h</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Signs the <code>message</code> with a JOSE JWS RSASSA-PSS signature using hash algorithm <code>h</code>.</p> </dd> <dt class='head--doc'><span id='p-message'></span>Parameter <code class='parameter'>message</code></dt> <dd></dd><dd class='body--doc'><p>Message to sign.</p> </dd> <dt class='head--doc'><span id='p-headers'></span>Parameter <code class='parameter'>headers</code></dt> <dd></dd><dd class='body--doc'><p>JOSE headers to use. Typically a mapping with a single element
autodoc.git/traditional_manual/chapter_21.html:5607:
<dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>pkcs_sign()</code>, <code>salt_size()</code>, <b><a href='http://pike.lysator.liu.se/rfc7515.xml#3.5'>RFC 7515 section 3.5</a></b></p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>jwa</b></span> </dt>
-
<dd><p><code><code class='modifier'>local</code> <code class='datatype'>string(7bit)</code> <b><span class='method'>jwa</span>(</b><code class='object unresolved'>.Hash</code> <code class='argument'>hash</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='modifier'>local</code> <code class='datatype'>string(7bit)</code>
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>jwa</span>(</b><code class='object unresolved'>.Hash</code> <code class='argument'>hash</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Get the JWS algorithm identifier for a hash.</p> </dd> <dt class='head--doc'>Returns</dt> <dd class='body--doc'><p>Returns <code class='expr'>0</code> (zero) on failure.</p> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><p><b><a href='http://pike.lysator.liu.se/rfc7518.xml#3.1'>RFC 7518 section 3.1</a></b></p> </dd></dl>