autodoc.git / modref.xml

autodoc.git/modref.xml:1107:   </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/modref.xml:1724:   <variable name='client_cert_distinguished_names'><type><array><valuetype><string/></valuetype></array></type></variable>   </docgroup>   <docgroup homogen-type='variable'><doc><text><p>Random cookies, sent and received with the hello-messages.</p>   </text></doc>   <variable name='client_random'><type><string/></type></variable>   <variable name='server_random'><type><string/></type></variable>   </docgroup>   <docgroup homogen-name='create' homogen-type='method'><doc><group><param name='is_server'/><text><p>Whether this is the server end of the connection or not.</p>   </text></group><group><param name='ctx'/><text><p>The context for the connection.</p>   </text></group><group><param name='min_version'/><text><p>Minimum version of SSL to support. -  Defaults to <ref resolved='predef::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p> +  Defaults to <ref resolved='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p>   </text></group><group><param name='max_version'/><text><p>Maximum version of SSL to support.    Defaults to <ref resolved='7.8::SSL.Constants.PROTOCOL_minor'>Constants.PROTOCOL_minor</ref>.</p>   </text></group></doc>   <method name='create'>   <arguments><argument name='is_server'><type><int/></type></argument><argument name='ctx'><type><or><void/><object resolved='7.8::SSL.context'>SSL.context</object></or></type></argument><argument name='min_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument><argument name='max_version'><type><or><void/><object resolved='7.8::SSL.Constants.ProtocolVersion'>ProtocolVersion</object></or></type></argument></arguments>   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='handle_handshake' homogen-type='method'><doc><text><p>Do handshake processing. Type is one of HANDSHAKE_*, data is the    contents of the packet, and raw is the raw packet received (needed
autodoc.git/modref.xml:5255:   <docgroup homogen-name='make_time' homogen-type='method'><doc><text><p>Creates a <ref resolved='predef::Standards.ASN1.Types.UTC'>Standards.ASN1.Types.UTC</ref> object from the posix    time <ref resolved='8.0::Tools.X509.make_time.t'>t</ref>.</p>   </text></doc>   <method name='make_time'>   <arguments><argument name='t'><type><int/></type></argument></arguments>   <returntype><object resolved='predef::Standards.ASN1.Types.UTC'>UTC</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='make_verifier' homogen-type='method'>   <method name='make_verifier'> - <arguments><argument name='_keyinfo'><type><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></type></argument></arguments> + <arguments><argument name='_keyinfo'><type><object resolved='predef::Object'>Object</object></type></argument></arguments>   <returntype><object>Verifier</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='parse_time' homogen-type='method'><doc><text><p>Returns a mapping similar to that returned by gmtime</p>   </text><group><returns/><text><mapping><group><member><type><int/></type><index>"year"</index></member><member><type><int/></type><index>"mon"</index></member><member><type><int/></type><index>"mday"</index></member><member><type><int/></type><index>"hour"</index></member><member><type><int/></type><index>"min"</index></member><member><type><int/></type><index>"sec"</index></member></group></mapping>   </text></group></doc>   <method name='parse_time'>   <arguments><argument name='asn1'><type><object resolved='predef::Standards.ASN1.Types.UTC'>UTC</object></type></argument></arguments>   <returntype><mapping><indextype><string/></indextype><valuetype><int/></valuetype></mapping></returntype>   </method>
autodoc.git/modref.xml:5356:   </docgroup>   <docgroup homogen-name='der' homogen-type='variable'>   <variable name='der'><type><string/></type></variable>   </docgroup>   <docgroup homogen-name='extensions' homogen-type='variable'><doc><group><note/><text><p>optional</p>   </text></group></doc>   <variable name='extensions'><type><object resolved='8.0::Tools.X509.TBSCertificate'/></type></variable>   </docgroup>   <docgroup homogen-name='init' homogen-type='method'>   <method name='init'> - <arguments><argument name='asn1'><type><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></type></argument></arguments> + <arguments><argument name='asn1'><type><object resolved='predef::Object'>Object</object></type></argument></arguments>   <returntype><object resolved='8.0::Tools.X509.TBSCertificate'>this_program</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='issuer' homogen-type='variable'>   <variable name='issuer'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></variable>   </docgroup>   <docgroup homogen-name='issuer_id' homogen-type='variable'><doc><group><note/><text><p>optional</p>   </text></group></doc>   <variable name='issuer_id'><type><object resolved='predef::Standards.ASN1.Types.BitString'>BitString</object></type></variable>   </docgroup>
autodoc.git/modref.xml:23642:   </text></doc>   <method name='_equal'><modifiers><protected/></modifiers>   <arguments><argument name='other'><type><mixed/></type></argument></arguments>   <returntype><int><min>0</min><max>1</max></int></returntype>   </method>   </docgroup>   <docgroup homogen-name='create' homogen-type='method'><doc><text><p>Can be initialized with a mapping with the elements n, e, d, p and q.</p>   <p> The mapping can either contain integer values, or be an <rfc>7517</rfc>    JWK-style mapping with <tt>kty</tt> set to <expr>"RSA"</expr> and contain    <ref resolved='predef::MIME.encode_base64url'>MIME.encode_base64url()</ref>-encoded values.</p> - </text></doc> + </text><group><seealso/><text><p><ref resolved='predef::Crypto.RSA.LowState.jwk'>jwk()</ref></p> + </text></group></doc>   <method name='create'><modifiers><protected/></modifiers>   <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>
autodoc.git/modref.xml:23705:   </docgroup>   <docgroup homogen-name='jwa' homogen-type='method'><doc><text><p>Get the JWS algorithm identifier for a hash.</p>   </text><group><returns/><text><p>Returns <expr>0</expr> (zero) on failure.</p>   </text></group><group><seealso/><text><p><rfc>7518:3.1</rfc></p>   </text></group></doc>   <method name='jwa'>   <arguments><argument name='hash'><type><object resolved='predef::Crypto.Hash'>.Hash</object></type></argument></arguments>   <returntype><string><min>0</min><max>127</max></string></returntype>   </method>   </docgroup> + <docgroup homogen-name='jwk' homogen-type='method'><doc><text><p>Generate a JWK-style mapping of the object.</p> + </text><group><param name='private_key'/><text><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 <expr>0</expr>).</p> + </text></group><group><returns/><text><p>Returns a JWK-style mapping on success, and <expr>0</expr> (zero) +  on failure.</p> + </text></group><group><seealso/><text><p><ref resolved='predef::Crypto.RSA.LowState.create'>create()</ref>, <ref resolved='predef::Web.encode_jwk'>Web.encode_jwk()</ref>, <rfc>7517:4</rfc>, <rfc>7518:6.3</rfc></p> + </text></group></doc> + <method name='jwk'> + <arguments><argument name='private_key'><type><or><int><min>0</min><max>1</max></int><void/></or></type></argument></arguments> + <returntype><mapping><indextype><string><min>0</min><max>127</max></string></indextype><valuetype><string><min>0</min><max>127</max></string></valuetype></mapping></returntype> + </method> + </docgroup>   <docgroup homogen-name='key_size' homogen-type='method'><doc><text><p>Returns the size of the key in terms of number of bits.</p>   </text></doc>   <method name='key_size'>   <arguments/>   <returntype><int><min>0</min><max/></int></returntype>   </method>   </docgroup>   <docgroup homogen-name='name' homogen-type='method'><doc><text><p>Returns the string <expr>"RSA"</expr>.</p>   </text></doc>   <method name='name'>