autodoc.git / modref.xml

version» Context lines:

autodoc.git/modref.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2022-10-22' version='Pike v8.1.18'> + <manual time-stamp='2022-10-25' version='Pike v8.1.18'>    <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:1130:   </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='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> +  <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>   </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:1747:   <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:1914:   <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='predef::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='7.8::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:129608:   <arguments/>   <returntype><int/></returntype>   </method>   </docgroup>   <docgroup homogen-name='read' homogen-type='method'>   <method name='read'>   <arguments><argument name='nbytes'><type><or><int><min>0</min><max/></int><void/></or></type></argument></arguments>   <returntype><string/></returntype>   </method>   </docgroup> + <docgroup homogen-name='read_function' homogen-type='method'><doc><text><p>Returns a function that when called will call <ref resolved='predef::Stdio.InputStream.read'>read</ref> with +  nbytes as argument. Can be used to get various callback +  functions, eg for the fourth argument to +  <ref resolved='predef::String.SplitIterator'>String.SplitIterator</ref>.</p> + </text></doc> + <method name='read_function'> + <arguments><argument name='nbytes'><type><int/></type></argument></arguments> + <returntype><function><returntype><string/></returntype></function></returntype> + </method> + </docgroup>   <docgroup homogen-type='method'>   <method name='read_oob'><modifiers><optional/></modifiers>   <arguments><argument name='nbytes'><type><or><int><min>0</min><max/></int><void/></or></type></argument></arguments>   <returntype><string/></returntype>   </method>   <method name='tcgetattr'><modifiers><optional/></modifiers>   <arguments/>   <returntype><or><mapping><indextype><string/></indextype><valuetype><int/></valuetype></mapping><zero/></or></returntype>   </method>   <method name='tcsetattr'><modifiers><optional/></modifiers>
autodoc.git/modref.xml:147929:    secret.</p>   </text><group><param name='secret'/><text><p>A shared secret between both parties. Typically the same size as    the hash output.</p>   </text></group><group><param name='factor'/><text><p>A moving factor. Defined in <rfc>4226</rfc> to be a counter    synchronized between both parties.</p>   </text></group><group><param name='length'/><text><p>The maximum number of digits of the one-time password. Defaults    to 6. Note that the result is usually 0-padded to this length    for user display purposes.</p>   </text></group></doc>   <method name='hotp'> - <arguments><argument name='secret'><type><string><min>0</min><max>255</max></string></type></argument><argument name='factor'><type><int/></type></argument><argument name='length'><type><or><void/><int/></or></type></argument></arguments> + <arguments><argument name='secret'><type><string><min>0</min><max>255</max></string></type></argument><argument name='factor'><type><int/></type></argument><argument name='length'><type><or><int><min>1</min><max/></int><void/></or></type></argument></arguments>   <returntype><int/></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='__Hash' homogen-type='inherit'>   <inherit name='__Hash'><classname resolved='predef::__builtin.Nettle.__Hash'>.__Hash</classname></inherit>   </docgroup>   <docgroup homogen-name='mgf1' homogen-type='method'><doc><text><p>This is the mask generation function <tt>MFG1</tt> from
autodoc.git/modref.xml:148016:    important differences. HKDF can use an "info" string that binds a    generated password to a specific use or application (e.g. port    number or cipher suite). It does not however support multiple    rounds of hashing to add computational cost to brute force    attacks.</p>   </text></doc>   <docgroup homogen-name='create' homogen-type='method'><doc><text><p>Initializes the HKDF object with a RFC 5869 2.2    HKDF-Extract(salt, IKM) call.</p>   </text></doc>   <method name='create'><modifiers><protected/></modifiers> - <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><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='expand' homogen-type='method'><doc><text><p>This is similar to the RFC 5869 2.3 HKDF-Expand(PRK, info, L)    function, but PRK is taken from the object.</p>   </text></doc>   <method name='expand'>   <arguments><argument name='info'><type><string><min>0</min><max>255</max></string></type></argument><argument name='bytes'><type><int/></type></argument></arguments>   <returntype><string><min>0</min><max>255</max></string></returntype>   </method>