autodoc.git / onepage.xml

version» Context lines:

autodoc.git/onepage.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2020-02-24' version='Pike v8.1.13'> + <manual time-stamp='2020-02-25' version='Pike v8.1.13'>    <dir name='./onepage'>    <file name='./onepage/manual.html'>    <chapter number='1' title='Control Structures'>      <p>In this chapter all the control structures in Pike will be   explained. Control structures are used to control the flow of the   program execution. Note that functions that make the program pause and   simple function calls are not qualified as control structures.</p>      <section number='1' title='Conditions'>
autodoc.git/onepage.xml:3472:   <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/onepage.xml:127647:   </docgroup>   <docgroup homogen-name='verify_ca_certificate' homogen-type='method'><doc><text><p>Verifies that all extensions mandated for certificate signing    certificates are present and valid.</p>   </text></doc>   <method name='verify_ca_certificate'>   <arguments><argument name='tbs'><type><or><string/><object resolved='predef::Standards.X509.TBSCertificate'>TBSCertificate</object></or></type></argument></arguments>   <returntype><object resolved='predef::Standards.X509.TBSCertificate'>TBSCertificate</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='verify_certificate' homogen-type='method'><doc><text><p>Decodes a certificate, checks the signature. Returns the -  TBSCertificate structure, or 0 if decoding or verification failes. +  TBSCertificate structure, or 0 if decoding or verification fails.    The valid time range for the certificate is not checked.</p>   </text><group><param name='authorities'/><text><p>A mapping from (DER-encoded) names to a verifiers.</p>   </text></group><group><param name='options'/><text><mapping><group><member><type><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Standards.ASN1.Types.Identifier</object></indextype><valuetype><object resolved='predef::Crypto.Hash'>Crypto.Hash</object></valuetype></mapping></type><index>"verifier_algorithms"</index></member><text><p>A mapping of verifier algorithm identifier to hash algorithm    implementation.</p>   </text></group></mapping>   </text></group><group><note/><text><p>This function allows self-signed certificates, and it doesn't    check that names or extensions make sense.</p>   </text></group></doc>   <method name='verify_certificate'>   <arguments><argument name='s'><type><string/></type></argument><argument name='authorities'><type><mapping><indextype><string/></indextype><valuetype><or><object resolved='predef::Standards.X509.Verifier'>Verifier</object><array><valuetype><object resolved='predef::Standards.X509.Verifier'>Verifier</object></valuetype></array></or></valuetype></mapping></type></argument><argument name='options'><type><or><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Standards.ASN1.Types.Identifier</object></indextype><valuetype><object resolved='predef::Crypto.Hash'>Crypto.Hash</object></valuetype></mapping><void/></or></type></argument></arguments>   <returntype><object resolved='predef::Standards.X509.TBSCertificate'>TBSCertificate</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='verify_certificate_chain' homogen-type='method'><doc><text><p>Decodes a certificate chain, ordered from leaf to root, and    checks the signatures. Verifies that the chain can be decoded    correctly, is unbroken, and that all certificates are in effect -  (time-wise.) and allowed to sign it's child certificate.</p> +  (time-wise.) and allowed to sign its child certificate.</p>   <p> No verifications are done on the leaf certificate to determine    what it can and can not be used for.</p>   <p> Returns a mapping with the following contents, depending    on the verification of the certificate chain:</p>   <mapping><group><member><type><int/></type><index>"error_code"</index></member><text><p>Error describing type of verification failures, if    verification failed. May be one of the following, OR:ed    together: <ref resolved='predef::Standards.X509.CertFailure.CERT_TOO_NEW'>CERT_TOO_NEW</ref>, <ref resolved='predef::Standards.X509.CertFailure.CERT_TOO_OLD'>CERT_TOO_OLD</ref>,    <ref resolved='predef::Standards.X509.CertFailure.CERT_ROOT_UNTRUSTED'>CERT_ROOT_UNTRUSTED</ref>, <ref resolved='predef::Standards.X509.CertFailure.CERT_BAD_SIGNATURE'>CERT_BAD_SIGNATURE</ref>,    <ref resolved='predef::Standards.X509.CertFailure.CERT_INVALID'>CERT_INVALID</ref>, <ref resolved='predef::Standards.X509.CertFailure.CERT_CHAIN_BROKEN'>CERT_CHAIN_BROKEN</ref>, <ref resolved='predef::Standards.X509.CertFailure.CERT_UNAUTHORIZED_CA'>CERT_UNAUTHORIZED_CA</ref>    or <ref resolved='predef::Standards.X509.CertFailure.CERT_EXCEEDED_PATH_LENGTH'>CERT_EXCEEDED_PATH_LENGTH</ref>.</p>
autodoc.git/onepage.xml:127729:   <constant name='CERT_TOO_NEW'/>   </docgroup>   <docgroup homogen-name='CERT_TOO_OLD' homogen-type='constant'>   <constant name='CERT_TOO_OLD'/>   </docgroup>   <docgroup homogen-name='CERT_UNAUTHORIZED_CA' homogen-type='constant'><doc><text><p>A CA certificate is not allowed by basic constraints to sign    another certificate.</p>   </text></doc>   <constant name='CERT_UNAUTHORIZED_CA'/>   </docgroup> - <docgroup homogen-name='CERT_UNAUTHORIZED_SIGNING' homogen-type='constant'><doc><text><p>The certificate is not allowed by it's key usage to sign data.</p> + <docgroup homogen-name='CERT_UNAUTHORIZED_SIGNING' homogen-type='constant'><doc><text><p>The certificate is not allowed by its key usage to sign data.</p>   </text></doc>   <constant name='CERT_UNAUTHORIZED_SIGNING'/>   </docgroup>   </enum>   <class name='IssuerId'>   <doc><text><p>Unique identifier for the certificate issuer.</p>   <p> X.509v2 (deprecated).</p>   </text></doc>   <docgroup homogen-name='BitString' homogen-type='inherit'>   <inherit name='BitString'><classname resolved='predef::Standards.ASN1.Types.BitString'>BitString</classname></inherit>