autodoc.git / autodoc.xml

version» Context lines:

autodoc.git/autodoc.xml:5270:   <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/autodoc.xml:5371:   </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/autodoc.xml:73740:   <docgroup homogen-name='crc32' homogen-type='method'><doc><text><p>This function calculates the standard ISO3309 Cyclic Redundancy Check.</p>   </text></doc>   <method name='crc32'>   <arguments><argument name='data'><type><string><min>0</min><max>255</max></string></type></argument><argument name='start_value'><type><or><void/><int><min>0</min><max/></int></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='"___Gz"' homogen-type='inherit'> - <inherit name='"___Gz"'><classname>"___Gz"</classname></inherit> + <docgroup homogen-name='_Gz' homogen-type='inherit'> + <inherit name='_Gz'><classname>_Gz</classname></inherit>   </docgroup>   <docgroup homogen-name='uncompress' homogen-type='method'><doc><text><p>Uncompresses the <ref resolved='predef::Gz.uncompress.data'>data</ref> and returns it. The <ref resolved='predef::Gz.uncompress.raw'>raw</ref> parameter    tells the decoder that the indata lacks the data header and footer    defined in <rfc>1950</rfc>.</p>   </text></doc>   <method name='uncompress'>   <arguments><argument name='data'><type><or><string><min>0</min><max>255</max></string><object resolved='predef::String.Buffer'>String.Buffer</object><object resolved='predef::System.Memory'>System.Memory</object><object resolved='predef::Stdio.Buffer'>Stdio.Buffer</object></or></type></argument><argument name='raw'><type><or><void/><int><min>0</min><max>1</max></int></or></type></argument></arguments>   <returntype><string><min>0</min><max>255</max></string></returntype>   </method>   </docgroup>
autodoc.git/autodoc.xml:73819:    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>   </class> + <module name='Pipe'> + <class name='Compress'> + <doc><text><p>This module provides a gzip-compressing non-blocking pipe interface. +  Set it to a pool of dedicated backends to use more than one CPU core to +  compress data (use one thread per backend). +  Use it in conjunction with the Shuffler to scale to an unlimited number +  of CPU cores.</p> + </text></doc> + <docgroup homogen-name='close' homogen-type='method'> + <method name='close'> + <arguments/> + <returntype><int/></returntype> + </method> + </docgroup> + <docgroup homogen-name='create' homogen-type='method'><doc><text><p>Note that the Gz.deflate engine provided needs to be preconfigured +  using negative compression levels.</p> + </text></doc> + <method name='create'><modifiers><protected/></modifiers> + <arguments><argument name='engine'><type><or><object resolved='predef::Gz.deflate'>Gz.deflate</object><void/></or></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='engine' homogen-type='variable'><doc><group><note/><text><p>Read only</p> + </text></group></doc> + <variable name='engine'><type><object resolved='predef::Gz.deflate'>Gz.deflate</object></type></variable> + </docgroup> + <docgroup homogen-name='' homogen-type='import'> + <import name=''><classname resolved='predef::'>predef::</classname></import> + </docgroup> + <docgroup homogen-name='set_backend' homogen-type='method'> + <method name='set_backend'> + <arguments><argument name='_backend'><type><object resolved='predef::Pike.Backend'>Pike.Backend</object></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='set_close_callback' homogen-type='method'> + <method name='set_close_callback'> + <arguments><argument name='ccb'><type><function/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='set_nonblocking' homogen-type='method'> + <method name='set_nonblocking'> + <arguments><argument name='rcb'><type><function/></type></argument><argument name='wcb'><type><function/></type></argument><argument name='ccb'><type><function/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='set_read_callback' homogen-type='method'> + <method name='set_read_callback'> + <arguments><argument name='rcb'><type><function/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='set_write_callback' homogen-type='method'> + <method name='set_write_callback'> + <arguments><argument name='wcb'><type><function/></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='write' homogen-type='method'> + <method name='write'> + <arguments><argument name='data'><type><string/></type></argument></arguments> + <returntype><int/></returntype> + </method> + </docgroup> + </class> + </module>   <class name='_file'>   <doc><text><p>Low-level implementation of read/write support for GZip files</p>   </text></doc>   <docgroup homogen-name='close' homogen-type='method'><doc><text><p>closes the file</p>   </text><group><returns/><text><p>1 if successful</p>   </text></group></doc>   <method name='close'>   <arguments/>   <returntype><int/></returntype>   </method>
autodoc.git/autodoc.xml:73970:   <returntype><void/></returntype>   </method>   </docgroup>   <docgroup homogen-name='deflate' homogen-type='method'><doc><text><p>This function performs gzip style compression on a string <ref resolved='predef::Gz.deflate.deflate.data'>data</ref> and    returns the packed data. Streaming can be done by calling this    function several times and concatenating the returned data.</p>   <p> The optional argument <ref resolved='predef::Gz.deflate.deflate.flush'>flush</ref> should be one of the following:</p>   <int><group><value>Gz.NO_FLUSH</value><text><p>Only data that doesn't fit in the internal buffers is returned.</p>   </text></group><group><value>Gz.PARTIAL_FLUSH</value><text><p>All input is packed and returned.</p>   </text></group><group><value>Gz.SYNC_FLUSH</value><text><p>All input is packed and returned.</p> - </text></group><group><value>Gz.FINISH</value><text><p>All input is packed and an 'end of data' marker is appended.</p> + </text></group><group><value>Gz.FINISH</value><text><p>All input is packed and an 'end of data' marker is appended (default).</p>   </text></group></int>   </text><group><seealso/><text><p><ref resolved='predef::Gz.inflate.inflate'>Gz.inflate-&gt;inflate()</ref></p>   </text></group></doc>   <method name='deflate'>   <arguments><argument name='data'><type><or><string><min>0</min><max>255</max></string><object resolved='predef::String.Buffer'>String.Buffer</object><object resolved='predef::System.Memory'>System.Memory</object><object resolved='predef::Stdio.Buffer'>Stdio.Buffer</object></or></type></argument><argument name='flush'><type><or><int/><void/></or></type></argument></arguments>   <returntype><string><min>0</min><max>255</max></string></returntype>   </method>   </docgroup>   </class>   <class name='inflate'>
autodoc.git/autodoc.xml:124090:    public keys must be set.</p>   </text></group><group><param name='name'/><text><p>The distinguished name for the certificate.</p>   </text></group><group><param name='attributes'/><text><p>Attributes from PKCS #9 to add to the certificate.</p>   </text></group><group><param name='hash'/><text><p>Hash algoritm to use for the CSR signature.    Defaults to <ref resolved='predef::Crypto.SHA256'>Crypto.SHA256</ref>.</p>   </text></group><group><note/><text><p>Prior to Pike 8.0 this function only supported signing    with <ref resolved='predef::Crypto.RSA'>Crypto.RSA</ref> and the default (and only) hash was    <ref resolved='predef::Crypto.MD5'>Crypto.MD5</ref>.</p>   </text></group></doc>   <method name='build_csr'> - <arguments><argument name='sign'><type><object resolved='predef::Crypto.Sign'>Crypto.Sign</object></type></argument><argument name='name'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></argument><argument name='attributes'><type><mapping><indextype><string/></indextype><valuetype><array><valuetype><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></valuetype></array></valuetype></mapping></type></argument><argument name='hash'><type><or><object resolved='predef::Crypto.Hash'>Crypto.Hash</object><void/></or></type></argument></arguments> + <arguments><argument name='sign'><type><object resolved='predef::Crypto.Sign'>Crypto.Sign</object></type></argument><argument name='name'><type><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></type></argument><argument name='attributes'><type><mapping><indextype><string/></indextype><valuetype><array><valuetype><object resolved='predef::Object'>Object</object></valuetype></array></valuetype></mapping></type></argument><argument name='hash'><type><or><object resolved='predef::Crypto.Hash'>Crypto.Hash</object><void/></or></type></argument></arguments>   <returntype><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='Types' homogen-type='import'>   <import name='Types'><classname resolved='predef::Standards.ASN1.Types'>Standards.ASN1.Types</classname></import>   </docgroup>   <docgroup homogen-name='sign_cri' homogen-type='method'><doc><text><p>Sign a <ref resolved='predef::Standards.PKCS.CSR.CRI'>CRI</ref> to generate a Certificate Signing Request.</p>
autodoc.git/autodoc.xml:124540:   <p>Setting</p>   <p> The signature.</p>   </text></doc>   <variable name='signature'><type><object resolved='predef::Standards.ASN1.Types.BitString'>BitString</object></type></variable>   </docgroup>   <docgroup homogen-name='tbs' homogen-type='variable'><doc><text><p>Getting</p>   <p> ASN.1 structure that has been signed.</p>   <p>Setting</p>   <p> ASN.1 structure that has been signed.</p>   </text></doc> - <variable name='tbs'><type><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></type></variable> + <variable name='tbs'><type><object resolved='predef::Object'>Object</object></type></variable>   </docgroup>   </class>   </module>   </module>   <module name='TLD'>   <docgroup homogen-name='cc' homogen-type='constant'><doc><text><p>A mapping between country TLDs and the name of the country.</p>   </text></doc>   <constant name='cc'/>   </docgroup>   <docgroup homogen-name='generic' homogen-type='variable'><doc><text><p>A multiset containing the generic TLDs, such as "com" and "info".</p>
autodoc.git/autodoc.xml:125052:   <method name='load_authorities'>   <arguments><argument name='root_cert_dirs'><type><or><string/><array><valuetype><string/></valuetype></array><void/></or></type></argument><argument name='cache'><type><or><int><min>0</min><max>1</max></int><void/></or></type></argument></arguments>   <returntype><mapping><indextype><string/></indextype><valuetype><array><valuetype><object resolved='predef::Standards.X509.Verifier'>Verifier</object></valuetype></array></valuetype></mapping></returntype>   </method>   </docgroup>   <docgroup homogen-name='make_extension' homogen-type='method'><doc><text><p>Creates a certificate extension with the <ref resolved='predef::Standards.X509.make_extension.id'>id</ref> as identifier and    <ref resolved='predef::Standards.X509.make_extension.ext'>ext</ref> as the extension payload. If the <ref resolved='predef::Standards.X509.make_extension.critical'>critical</ref> flag is set    the extension will be marked as critical.</p>   </text></doc>   <method name='make_extension'> - <arguments><argument name='id'><type><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></type></argument><argument name='ext'><type><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></type></argument><argument name='critical'><type><or><void/><int/></or></type></argument></arguments> + <arguments><argument name='id'><type><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></type></argument><argument name='ext'><type><object resolved='predef::Object'>Object</object></type></argument><argument name='critical'><type><or><void/><int/></or></type></argument></arguments>   <returntype><object resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='make_selfsigned_certificate' homogen-type='method'><doc><text><p>Creates a selfsigned certificate, i.e. where issuer and subject    are the same entity. This entity is derived from the list of pairs    in <ref resolved='predef::Standards.X509.make_selfsigned_certificate.name'>name</ref>, which is encoded into an distinguished_name by    <ref resolved='predef::Standards.PKCS.Certificate.build_distinguished_name'>Standards.PKCS.Certificate.build_distinguished_name</ref>.</p>   </text><group><param name='c'/><text><p>The public key cipher used for the certificate, <ref resolved='predef::Crypto.RSA'>Crypto.RSA</ref>,    <ref resolved='predef::Crypto.DSA'>Crypto.DSA</ref> or <ref resolved='predef::Crypto.ECC.Curve.ECDSA'>Crypto.ECC.Curve.ECDSA</ref>. The object should be    initialized with both public and private keys.</p>
autodoc.git/autodoc.xml:125336:   </docgroup>   <docgroup homogen-name='ext_subjectKeyIdentifier' homogen-type='variable'><doc><text><p>Set to the value of the SubjectKeyIdentifier if the certificate    contains the subjectKeyIdentifier    extension. <rfc>3280:4.2.1.2</rfc>.</p>   </text></doc>   <variable name='ext_subjectKeyIdentifier'><type><string/></type></variable>   </docgroup>   <docgroup homogen-name='extensions' homogen-type='variable'><doc><group><note/><text><p>optional</p>   </text></group><group><note/><text><p>Read only</p>   </text></group></doc> - <variable name='extensions'><type><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></indextype><valuetype><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></valuetype></mapping></type></variable> + <variable name='extensions'><type><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></indextype><valuetype><object resolved='predef::Object'>Object</object></valuetype></mapping></type></variable>   </docgroup>   <docgroup homogen-name='hash' homogen-type='variable'><doc><text><p>Algorithm hash if known and supported.    Otherwise <ref resolved='predef::.UNDEFINED'>UNDEFINED</ref>.</p>   </text><group><note/><text><p>Read only</p>   </text></group></doc>   <variable name='hash'><type><object resolved='predef::Crypto.Hash'>Crypto.Hash</object></type></variable>   </docgroup>   <docgroup homogen-name='Sequence' homogen-type='inherit'>   <inherit name='Sequence'><classname resolved='predef::Standards.ASN1.Types.Sequence'>Sequence</classname></inherit>   </docgroup>   <docgroup homogen-name='init' homogen-type='method'><doc><text><p>Populates the object from a certificate decoded into an ASN.1    Object. Returns the object on success, otherwise <expr>0</expr>. You    probably want to call <ref resolved='predef::Standards.X509.decode_certificate'>decode_certificate</ref> or even    <ref resolved='predef::Standards.X509.verify_certificate'>verify_certificate</ref>.</p>   </text></doc>   <method name='init'> - <arguments><argument name='asn1'><type><or><array/><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></or></type></argument></arguments> + <arguments><argument name='asn1'><type><or><array/><object resolved='predef::Object'>Object</object></or></type></argument></arguments>   <returntype><object resolved='predef::Standards.X509.TBSCertificate'>this_program</object></returntype>   </method>   </docgroup>   <docgroup homogen-name='internal_critical' homogen-type='variable'><doc><group><note/><text><p>optional</p>   </text></group></doc>   <variable name='internal_critical'><modifiers><protected/></modifiers><type><multiset/></type></variable>   </docgroup>   <docgroup homogen-name='internal_extensions' homogen-type='variable'><doc><group><note/><text><p>optional</p>   </text></group></doc> - <variable name='internal_extensions'><modifiers><protected/></modifiers><type><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></indextype><valuetype><object resolved='predef::Standards.ASN1.Types.Object'>Object</object></valuetype></mapping></type></variable> + <variable name='internal_extensions'><modifiers><protected/></modifiers><type><mapping><indextype><object resolved='predef::Standards.ASN1.Types.Identifier'>Identifier</object></indextype><valuetype><object resolved='predef::Object'>Object</object></valuetype></mapping></type></variable>   </docgroup>   <docgroup homogen-name='issuer' homogen-type='variable'><doc><text><p>Certificate issuer.</p>   </text></doc>   <variable name='issuer'><type><void/></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><void/></type></variable>   </docgroup>   <docgroup homogen-name='keyinfo' homogen-type='variable'>