autodoc.git / onepage / manual.html

version» Context lines:

autodoc.git/onepage/manual.html:84:    break;       case constant2:    statement2;    break;       case constant3 .. constant4:    statement3;    break;    +  case constant5 +  case constant6: +  statement4; +  // Fallthrough +     default:    statement5;   }   </pre><p></p>   <p>As you can see, a switch statement is a bit more complicated than an   if statement. It is still fairly simple however. It starts by evaluating   the expression it then searches all the <tt>case</tt> statements in the   following block. If one is found to be equal to the value returned by   the expression, Pike will continue executing the code directly following   that <tt>case</tt> statement. When a <tt>break</tt> is encountered Pike
autodoc.git/onepage/manual.html:39943:   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>This module is only available if Pike has been compiled with    <code>Nettle</code> enabled (this is the default).</p>   </dd></dl>      <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>make_crypt_md5</b></span>   </dt> - <dd><p><code><code class='datatype'>string(8bit)</code> <b><span class='method'>make_crypt_md5</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>password</code>, <code class='datatype'>void</code>|<code class='datatype'>string(8bit)</code> <code class='argument'>salt</code><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>string(8bit)</code> <b><span class='method'>make_crypt_md5</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>password</code>, <code class='datatype'>string(8bit)</code>|<code class='datatype'>void</code> <code class='argument'>salt</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Hashes a <code>password</code> together with a <code>salt</code> with the    crypt_md5 algorithm and returns the result.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>verify_crypt_md5</code></p>   </dd></dl>      
autodoc.git/onepage/manual.html:40266:   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Encrypts the message <code>m</code>.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>filter</b></span>   </dt> - <dd><p><code><code class='datatype'>string</code> <b><span class='method'>filter</span>(</b><code class='datatype'>string</code> <code class='argument'>m</code>, <code class='datatype'>void</code>|<code class='datatype'>multiset</code>(<code class='datatype'>int</code>) <code class='argument'>save</code><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>string</code> <b><span class='method'>filter</span>(</b><code class='datatype'>string</code> <code class='argument'>m</code>, <code class='datatype'>multiset</code>(<code class='datatype'>int</code>)|<code class='datatype'>void</code> <code class='argument'>save</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Removes characters not in the encryption key or in    the <code>save</code> multiset from the message <code>m</code>.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>set_ACA_K1_key</b></span>   </dt> - <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>set_ACA_K1_key</span>(</b><code class='datatype'>string</code> <code class='argument'>key</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>offset</code>, <code class='datatype'>void</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>alphabet</code><b>)</b></code></p></dd> + <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>set_ACA_K1_key</span>(</b><code class='datatype'>string</code> <code class='argument'>key</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>offset</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>void</code> <code class='argument'>alphabet</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Sets the key according to ACA K1 key generation. The plaintext    alphabet is prepended with a keyword <code>key</code> that shifts the alphabet    positions compared to the cryptogram alphabet. The plaintext    alphabet is then reduced with the characters in the keyword. It is    also optionally rotated <code>offset</code> number of steps.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>set_ACA_K2_key</b></span>   </dt> - <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>set_ACA_K2_key</span>(</b><code class='datatype'>string</code> <code class='argument'>key</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>offset</code>, <code class='datatype'>void</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>alphabet</code><b>)</b></code></p></dd> + <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>set_ACA_K2_key</span>(</b><code class='datatype'>string</code> <code class='argument'>key</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>offset</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>void</code> <code class='argument'>alphabet</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Sets the key according to ACA K2 key generation. The cryptogram    alphabet is prepended with a keyword <code>key</code> that shifts the alphabet    positions compared to the plaintext alphabet. The cryptogram    alphabet is then reduced with the characters in the keyword. It is    als optionally reotated <code>offset</code> number of steps.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>set_ACA_K3_key</b></span>   </dt> - <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>set_ACA_K3_key</span>(</b><code class='datatype'>string</code> <code class='argument'>key</code>, <code class='datatype'>int</code> <code class='argument'>offset</code>, <code class='datatype'>void</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>alphabet</code><b>)</b></code></p></dd> + <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>set_ACA_K3_key</span>(</b><code class='datatype'>string</code> <code class='argument'>key</code>, <code class='datatype'>int</code> <code class='argument'>offset</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>void</code> <code class='argument'>alphabet</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Sets the key according to ACA K3 key generation. Both the plaintext    and the cryptogram alphabets are prepended with a keyword <code>key</code>,    which characters are removed from the rest of the alphabet. The    plaintext alphabet is then rotated <code>offset</code> number of steps.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>set_ACA_K4_key</b></span>   </dt> - <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>set_ACA_K4_key</span>(</b><code class='datatype'>string</code> <code class='argument'>key1</code>, <code class='datatype'>string</code> <code class='argument'>key2</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>offset</code>, <code class='datatype'>void</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>alphabet</code><b>)</b></code></p></dd> + <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>set_ACA_K4_key</span>(</b><code class='datatype'>string</code> <code class='argument'>key1</code>, <code class='datatype'>string</code> <code class='argument'>key2</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>offset</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>void</code> <code class='argument'>alphabet</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Sets the key according to ACA K4 key generation. Both the plaintext    and the cryptogram alphabets are prepended with the keywords <code>key1</code>    and <code>key2</code>. The plaintext alphabet is then rotated <code>offset</code> number    of steps.</p>   </dd></dl>         <hr />
autodoc.git/onepage/manual.html:40378:   <dt class='head--doc'><span id='p-chars'></span>Parameter <code class='parameter'>chars</code></dt>   <dd></dd><dd class='body--doc'><p>An array of one character strings.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>set_rot_key</b></span>   </dt> - <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>set_rot_key</span>(</b><code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>steps</code>, <code class='datatype'>void</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>alphabet</code><b>)</b></code></p></dd> + <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>set_rot_key</span>(</b><code class='datatype'>int(1..)</code>|<code class='datatype'>void</code> <code class='argument'>steps</code>, <code class='datatype'>void</code>|<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>alphabet</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Sets the key to a ROT substitution system. <code>steps</code> defaults    to 13 and <code>alphabet</code> defaults to A-Z, i.e. this function    defaults to set the substitution crypto to be ROT13. If no    alphabet is given the key will be case insensitive, e.g. the    key will really be two ROT13 alphabets, one a-z and one A-Z,    used simultaneously.</p>   </dd></dl>   </dd></dl><dl><dt><h2 class='header'>Module <b class='ms datatype'>Crypto.AES</b></h2>
autodoc.git/onepage/manual.html:41433:   <dd class='body--doc'><p>Compares the public key in this object with that in the provided    DSA object.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>raw_sign</b></span>   </dt> - <dd><p><code><code class='datatype'>array</code>(<code class='object unresolved'>Gmp.mpz</code>) <b><span class='method'>raw_sign</span>(</b><code class='object unresolved'>Gmp.mpz</code> <code class='argument'>h</code>, <code class='datatype'>void</code>|<code class='object unresolved'>Gmp.mpz</code> <code class='argument'>k</code><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>array</code>(<code class='object unresolved'>Gmp.mpz</code>) <b><span class='method'>raw_sign</span>(</b><code class='object unresolved'>Gmp.mpz</code> <code class='argument'>h</code>, <code class='object unresolved'>Gmp.mpz</code>|<code class='datatype'>void</code> <code class='argument'>k</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Sign the message <code>h</code>. Returns the signature as two <code>Gmp.mpz</code>    objects.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>
autodoc.git/onepage/manual.html:42695:   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Decode ASCII armour.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>encode_radix64</b></span>   </dt> - <dd><p><code><code class='datatype'>string</code> <b><span class='method'>encode_radix64</span>(</b><code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>string</code> <code class='argument'>type</code>, <code class='datatype'>void</code>|<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>) <code class='argument'>extra</code><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>string</code> <b><span class='method'>encode_radix64</span>(</b><code class='datatype'>string</code> <code class='argument'>data</code>, <code class='datatype'>string</code> <code class='argument'>type</code>, <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>string</code>)|<code class='datatype'>void</code> <code class='argument'>extra</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Encode PGP data with ASCII armour.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>verify_signature</b></span>
autodoc.git/onepage/manual.html:43104:   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>jwk()</code></p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>generate_key</b></span>   </dt> - <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>generate_key</span>(</b><code class='datatype'>int(128..)</code> <code class='argument'>bits</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code>|<code class='object unresolved'>Gmp.mpz</code> <code class='argument'>e</code><b>)</b></code></p></dd> + <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>generate_key</span>(</b><code class='datatype'>int(128..)</code> <code class='argument'>bits</code>, <code class='datatype'>int(1..)</code>|<code class='object unresolved'>Gmp.mpz</code>|<code class='datatype'>void</code> <code class='argument'>e</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Generate a valid RSA key pair with the size <code>bits</code> using the    random function set with <code>set_random()</code>. The public exponent <code>e</code>    will be used, which defaults to 65537. Keys must be at least 89    bits.</p>   </dd></dl>         <hr />