autodoc.git / modref.xml

version» Context lines:

autodoc.git/modref.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2016-12-26' version='Pike v8.1.6'> + <manual time-stamp='2016-12-29' version='Pike v8.1.6'>    <dir name='./ignored'>    <file name='./ignored/ignored'>    <chapter number='1' title='ignored'>    <autodoc>   <namespace name=''>   <doc><text><p>Symbols implicitly inherited from the virtual base class.</p>   <p> These symbols exist mainly to simplify implementation of    the corresponding lfuns.</p>   </text><group><seealso/><text><p><ref resolved='lfun::'>lfun::</ref></p>   </text></group></doc>
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='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>.</p> +  Defaults to <ref resolved='predef::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:1891:   <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/modref.xml:131858:   </docgroup>   <docgroup homogen-name='is_val_true' homogen-type='constant'><doc><text><p>Nonzero recognition constant.</p>   </text></doc>   <constant name='is_val_true'><type><int/></type></constant>   </docgroup>   </class>   </module>   <module name='Web'>   <doc><text><p>Modules implementing various web standards.</p>   </text></doc> + <docgroup homogen-name='decode_jwk' homogen-type='method'><doc><text><p>Decode a JSON Web Key (JWK).</p> + </text><group><returns/><text><p>Returns an initialized <ref>Crypto.Sign.State</ref> on success +  and <ref resolved='predef::.UNDEFINED'>UNDEFINED</ref> on failure.</p> + </text></group></doc> + <method name='decode_jwk'> + <arguments><argument name='jwk'><type><mapping><indextype><string><min>0</min><max>127</max></string></indextype><valuetype><string><min>0</min><max>127</max></string></valuetype></mapping></type></argument></arguments> + <returntype><object>Crypto.Sign.State</object></returntype> + </method> + </docgroup> + <docgroup homogen-name='decode_jwk_set' homogen-type='method'><doc><text><p>Decode a JSON Web Key (JWK) Set.</p> + </text><group><seealso/><text><p><rfc>7517:5</rfc>, <ref resolved='predef::Web.decode_jwk'>decode_jwk()</ref></p> + </text></group></doc> + <method name='decode_jwk_set'> + <arguments><argument name='jwk_set'><type><mapping><indextype><string><min>0</min><max>255</max></string></indextype><valuetype><array><valuetype><mapping><indextype><string><min>0</min><max>127</max></string></indextype><valuetype><string><min>0</min><max>127</max></string></valuetype></mapping></valuetype></array></valuetype></mapping></type></argument></arguments> + <returntype><array><valuetype><object>Crypto.Sign.State</object></valuetype></array></returntype> + </method> + </docgroup>   <docgroup homogen-name='decode_jwt' homogen-type='method'><doc><text><p>Decode a JSON Web Token (JWT).</p>   </text><group><param name='sign'/><text><p>The asymetric public or MAC key(s) to validate the jwt against.</p>   </text></group><group><param name='jwt'/><text><p>A JWT as eg returned by <ref resolved='predef::Web.encode_jwt'>encode_jwt()</ref>.</p>   </text></group><group><returns/><text><p>Returns <expr>0</expr> (zero) on validation failure (this    includes validation of expiry times).</p>   <p> Returns a mapping of the claims for the token on success.    See <rfc>7519:4</rfc>.</p>   </text></group><group><note/><text><p>The time check of the <expr>"nbf"</expr> value has a hard coded    60 second grace time (as allowed by <rfc>7519:4.1.5</rfc>).</p>   </text></group><group><seealso/><text><p><ref resolved='predef::Web.encode_jwt'>encode_jwt()</ref>, <rfc>7519:4</rfc></p>