autodoc.git / autodoc.xml

version» Context lines:

autodoc.git/autodoc.xml:1126:   </docgroup>   </class>   <class name='DES3'>   <docgroup homogen-name='CBC' homogen-type='inherit'>   <inherit name='CBC'><classname resolved='8.0::Crypto.CBC'>Crypto.CBC</classname></inherit>   </docgroup>   </class>   <class name='DHKeyExchange'>   <doc><text><p>Implements Diffie-Hellman key-exchange.</p>   <p> The following key exchange methods are implemented here: -  <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dhe_dss'>KE_dhe_dss</ref>, <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dhe_rsa'>KE_dhe_rsa</ref> and <ref resolved='7.8::SSL.Constants.KeyExchangeType.KE_dh_anon'>KE_dh_anon</ref>.</p> +  <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dhe_dss'>KE_dhe_dss</ref>, <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dhe_rsa'>KE_dhe_rsa</ref> and <ref resolved='predef::SSL.Constants.KeyExchangeType.KE_dh_anon'>KE_dh_anon</ref>.</p>   </text></doc>   <docgroup homogen-name='create' homogen-type='method'>   <method name='create'><modifiers><protected/></modifiers>   <arguments><argument name='p'><type><object resolved='7.8::SSL.Cipher.DHParameters'>DHParameters</object></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   <class name='DHParameters'>   <doc><text><p>Diffie-Hellman parameters.</p>
autodoc.git/autodoc.xml:1910:   <variable name='rsa'><type><object resolved='7.8::Crypto.RSA'>Crypto.RSA</object></type></variable>   </docgroup>   <docgroup homogen-name='set_cipher_suite' homogen-type='method'><doc><text><p>Sets the proper authentication method and cipher specification    for the given cipher <ref resolved='7.8::SSL.session.set_cipher_suite.suite'>suite</ref> and <ref>verison</ref>.</p>   </text></doc>   <method name='set_cipher_suite'>   <arguments><argument name='suite'><type><int/></type></argument><argument name='version'><type><or><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object><int/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup> - <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text><p>Sets the compression method. Currently only <ref resolved='7.8::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is + <docgroup homogen-name='set_compression_method' homogen-type='method'><doc><text><p>Sets the compression method. Currently only <ref resolved='predef::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is    supported.</p>   </text></doc>   <method name='set_compression_method'>   <arguments><argument name='compr'><type><int/></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   </class>   <class name='sslfile'>   <doc><text><p>Interface similar to <ref resolved='7.8::Stdio.File'>Stdio.File</ref>.</p>
autodoc.git/autodoc.xml:24038:    <ref resolved='predef::Nettle'>Nettle</ref> enabled (this is the default).</p>   </text></group></doc>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='make_crypt_md5' homogen-type='method'><doc><text><p>Hashes a <ref resolved='predef::Crypto.make_crypt_md5.password'>password</ref> together with a <ref resolved='predef::Crypto.make_crypt_md5.salt'>salt</ref> with the    crypt_md5 algorithm and returns the result.</p>   </text><group><seealso/><text><p><ref resolved='predef::Crypto.verify_crypt_md5'>verify_crypt_md5</ref></p>   </text></group></doc>   <method name='make_crypt_md5'> - <arguments><argument name='password'><type><string><min>0</min><max>255</max></string></type></argument><argument name='salt'><type><or><void/><string><min>0</min><max>255</max></string></or></type></argument></arguments> + <arguments><argument name='password'><type><string><min>0</min><max>255</max></string></type></argument><argument name='salt'><type><or><string><min>0</min><max>255</max></string><void/></or></type></argument></arguments>   <returntype><string><min>0</min><max>255</max></string></returntype>   </method>   </docgroup>   <docgroup homogen-name='rot13' homogen-type='method'><doc><text><p>Convenience function that accesses the crypt function of a    substitution object keyed to perform standard ROT13 (de)ciphering.</p>   </text></doc>   <method name='rot13'>   <arguments><argument name='data'><type><string><min>0</min><max>255</max></string></type></argument></arguments>   <returntype><string><min>0</min><max>255</max></string></returntype>   </method>
autodoc.git/autodoc.xml:24727:   </text></doc>   <method name='public_key_equal'>   <arguments><argument name='dsa'><type><object resolved='predef::Crypto.DSA.State'>this_program</object></type></argument></arguments>   <returntype><int><min>0</min><max>1</max></int></returntype>   </method>   </docgroup>   <docgroup homogen-name='raw_sign' homogen-type='method'><doc><text><p>Sign the message <ref resolved='predef::Crypto.DSA.State.raw_sign.h'>h</ref>. Returns the signature as two <ref resolved='predef::Gmp.mpz'>Gmp.mpz</ref>    objects.</p>   </text></doc>   <method name='raw_sign'> - <arguments><argument name='h'><type><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></type></argument><argument name='k'><type><or><void/><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></or></type></argument></arguments> + <arguments><argument name='h'><type><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></type></argument><argument name='k'><type><or><object resolved='predef::Gmp.mpz'>Gmp.mpz</object><void/></or></type></argument></arguments>   <returntype><array><valuetype><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></valuetype></array></returntype>   </method>   </docgroup>   <docgroup homogen-name='raw_verify' homogen-type='method'><doc><text><p>Verify the signature <ref resolved='predef::Crypto.DSA.State.raw_verify.r'>r</ref>,<ref resolved='predef::Crypto.DSA.State.raw_verify.s'>s</ref> against the message <ref resolved='predef::Crypto.DSA.State.raw_verify.h'>h</ref>.</p>   </text></doc>   <method name='raw_verify'>   <arguments><argument name='h'><type><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></type></argument><argument name='r'><type><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></type></argument><argument name='s'><type><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></type></argument></arguments>   <returntype><int><min>0</min><max>1</max></int></returntype>   </method>   </docgroup>
autodoc.git/autodoc.xml:25536:   <docgroup homogen-name='decode_radix64' homogen-type='method'><doc><text><p>Decode ASCII armour.</p>   </text></doc>   <method name='decode_radix64'>   <arguments><argument name='data'><type><string/></type></argument></arguments>   <returntype><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping></returntype>   </method>   </docgroup>   <docgroup homogen-name='encode_radix64' homogen-type='method'><doc><text><p>Encode PGP data with ASCII armour.</p>   </text></doc>   <method name='encode_radix64'> - <arguments><argument name='data'><type><string/></type></argument><argument name='type'><type><string/></type></argument><argument name='extra'><type><or><void/><mapping><indextype><string/></indextype><valuetype><string/></valuetype></mapping></or></type></argument></arguments> + <arguments><argument name='data'><type><string/></type></argument><argument name='type'><type><string/></type></argument><argument name='extra'><type><or><mapping><indextype><string/></indextype><valuetype><string/></valuetype></mapping><void/></or></type></argument></arguments>   <returntype><string/></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='verify_signature' homogen-type='method'><doc><text><p>Verify <ref resolved='predef::Crypto.PGP.verify_signature.text'>text</ref> against signature <ref resolved='predef::Crypto.PGP.verify_signature.sig'>sig</ref> with the public key    <ref resolved='predef::Crypto.PGP.verify_signature.pubkey'>pubkey</ref>.</p>   </text></doc>   <method name='verify_signature'>
autodoc.git/autodoc.xml:25815:   <arguments><argument name='params'><type><or><mapping><indextype><string><min>0</min><max>255</max></string></indextype><valuetype><or><object resolved='predef::Gmp.mpz'>Gmp.mpz</object><int/><string><min>0</min><max>127</max></string></or></valuetype></mapping><void/></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='generate_key' homogen-type='method'><doc><text><p>Generate a valid RSA key pair with the size <ref resolved='predef::Crypto.RSA.LowState.generate_key.bits'>bits</ref> using the    random function set with <ref resolved='predef::Crypto.RSA.LowState.set_random'>set_random()</ref>. The public exponent <ref resolved='predef::Crypto.RSA.LowState.generate_key.e'>e</ref>    will be used, which defaults to 65537. Keys must be at least 89    bits.</p>   </text></doc>   <method name='generate_key'> - <arguments><argument name='bits'><type><int><min>128</min><max/></int></type></argument><argument name='e'><type><or><void/><int/><object resolved='predef::Gmp.mpz'>Gmp.mpz</object></or></type></argument></arguments> + <arguments><argument name='bits'><type><int><min>128</min><max/></int></type></argument><argument name='e'><type><or><int><min>1</min><max/></int><object resolved='predef::Gmp.mpz'>Gmp.mpz</object><void/></or></type></argument></arguments>   <returntype><object resolved='predef::Crypto.RSA.LowState'>this_program</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='get_d' homogen-type='method'><doc><text><p>Returns the RSA private exponent (d), if known.</p>   </text></doc>   <method name='get_d'>   <arguments/>   <returntype><or><object resolved='predef::Gmp.mpz'>Gmp.mpz</object><zero/></or></returntype>   </method>   </docgroup>
autodoc.git/autodoc.xml:26494:   </text></doc>   <method name='encrypt'>   <arguments><argument name='m'><type><string><min>0</min><max>255</max></string></type></argument></arguments>   <returntype><string><min>0</min><max>255</max></string></returntype>   </method>   </docgroup>   <docgroup homogen-name='filter' homogen-type='method'><doc><text><p>Removes characters not in the encryption key or in    the <ref resolved='predef::Crypto.Substitution.filter.save'>save</ref> multiset from the message <ref resolved='predef::Crypto.Substitution.filter.m'>m</ref>.</p>   </text></doc>   <method name='filter'> - <arguments><argument name='m'><type><string/></type></argument><argument name='save'><type><or><void/><multiset><indextype><int/></indextype></multiset></or></type></argument></arguments> + <arguments><argument name='m'><type><string/></type></argument><argument name='save'><type><or><multiset><indextype><int/></indextype></multiset><void/></or></type></argument></arguments>   <returntype><string/></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='set_ACA_K1_key' homogen-type='method'><doc><text><p>Sets the key according to ACA K1 key generation. The plaintext    alphabet is prepended with a keyword <ref resolved='predef::Crypto.Substitution.set_ACA_K1_key.key'>key</ref> 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 <ref resolved='predef::Crypto.Substitution.set_ACA_K1_key.offset'>offset</ref> number of steps.</p>   </text></doc>   <method name='set_ACA_K1_key'> - <arguments><argument name='key'><type><string/></type></argument><argument name='offset'><type><or><void/><int/></or></type></argument><argument name='alphabet'><type><or><void/><array><valuetype><string/></valuetype></array></or></type></argument></arguments> + <arguments><argument name='key'><type><string/></type></argument><argument name='offset'><type><or><void/><int/></or></type></argument><argument name='alphabet'><type><or><array><valuetype><string/></valuetype></array><void/></or></type></argument></arguments>   <returntype><object resolved='predef::Crypto.Substitution'>this_program</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='set_ACA_K2_key' homogen-type='method'><doc><text><p>Sets the key according to ACA K2 key generation. The cryptogram    alphabet is prepended with a keyword <ref resolved='predef::Crypto.Substitution.set_ACA_K2_key.key'>key</ref> 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 <ref resolved='predef::Crypto.Substitution.set_ACA_K2_key.offset'>offset</ref> number of steps.</p>   </text></doc>   <method name='set_ACA_K2_key'> - <arguments><argument name='key'><type><string/></type></argument><argument name='offset'><type><or><void/><int/></or></type></argument><argument name='alphabet'><type><or><void/><array><valuetype><string/></valuetype></array></or></type></argument></arguments> + <arguments><argument name='key'><type><string/></type></argument><argument name='offset'><type><or><void/><int/></or></type></argument><argument name='alphabet'><type><or><array><valuetype><string/></valuetype></array><void/></or></type></argument></arguments>   <returntype><object resolved='predef::Crypto.Substitution'>this_program</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='set_ACA_K3_key' homogen-type='method'><doc><text><p>Sets the key according to ACA K3 key generation. Both the plaintext    and the cryptogram alphabets are prepended with a keyword <ref resolved='predef::Crypto.Substitution.set_ACA_K3_key.key'>key</ref>,    which characters are removed from the rest of the alphabet. The    plaintext alphabet is then rotated <ref resolved='predef::Crypto.Substitution.set_ACA_K3_key.offset'>offset</ref> number of steps.</p>   </text></doc>   <method name='set_ACA_K3_key'> - <arguments><argument name='key'><type><string/></type></argument><argument name='offset'><type><int/></type></argument><argument name='alphabet'><type><or><void/><array><valuetype><string/></valuetype></array></or></type></argument></arguments> + <arguments><argument name='key'><type><string/></type></argument><argument name='offset'><type><int/></type></argument><argument name='alphabet'><type><or><array><valuetype><string/></valuetype></array><void/></or></type></argument></arguments>   <returntype><object resolved='predef::Crypto.Substitution'>this_program</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='set_ACA_K4_key' homogen-type='method'><doc><text><p>Sets the key according to ACA K4 key generation. Both the plaintext    and the cryptogram alphabets are prepended with the keywords <ref resolved='predef::Crypto.Substitution.set_ACA_K4_key.key1'>key1</ref>    and <ref resolved='predef::Crypto.Substitution.set_ACA_K4_key.key2'>key2</ref>. The plaintext alphabet is then rotated <ref resolved='predef::Crypto.Substitution.set_ACA_K4_key.offset'>offset</ref> number    of steps.</p>   </text></doc>   <method name='set_ACA_K4_key'> - <arguments><argument name='key1'><type><string/></type></argument><argument name='key2'><type><string/></type></argument><argument name='offset'><type><or><void/><int/></or></type></argument><argument name='alphabet'><type><or><void/><array><valuetype><string/></valuetype></array></or></type></argument></arguments> + <arguments><argument name='key1'><type><string/></type></argument><argument name='key2'><type><string/></type></argument><argument name='offset'><type><or><void/><int/></or></type></argument><argument name='alphabet'><type><or><array><valuetype><string/></valuetype></array><void/></or></type></argument></arguments>   <returntype><object resolved='predef::Crypto.Substitution'>this_program</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='set_key' homogen-type='method'><doc><text><p>Sets the encryption and decryption key. The decryption key is    derived from the encryption <ref resolved='predef::Crypto.Substitution.set_key.key'>key</ref> by reversing the mapping. If    one index maps to an array of strings, one element from the array    will be chosen at random in such substitution.</p>   </text><group><throws/><text><p>An error is thrown if the encryption key can not be made reversible.</p>   </text></group></doc>   <method name='set_key'>
autodoc.git/autodoc.xml:26572:   </method>   </docgroup>   <docgroup homogen-name='set_rot_key' homogen-type='method'><doc><text><p>Sets the key to a ROT substitution system. <ref resolved='predef::Crypto.Substitution.set_rot_key.steps'>steps</ref> defaults    to 13 and <ref resolved='predef::Crypto.Substitution.set_rot_key.alphabet'>alphabet</ref> 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>   </text></doc>   <method name='set_rot_key'> - <arguments><argument name='steps'><type><or><void/><int/></or></type></argument><argument name='alphabet'><type><or><void/><array><valuetype><string/></valuetype></array></or></type></argument></arguments> + <arguments><argument name='steps'><type><or><int><min>1</min><max/></int><void/></or></type></argument><argument name='alphabet'><type><or><void/><array><valuetype><string/></valuetype></array></or></type></argument></arguments>   <returntype><object resolved='predef::Crypto.Substitution'>this_program</object></returntype>   </method>   </docgroup>   </class>   <module name='Twofish'>   <doc><text><p>Another <ref resolved='predef::Crypto.AES'>AES</ref> finalist, this one designed by Bruce Schneier and    others.</p>   </text></doc>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>