Diff of autodoc.git/autodoc.xml (70cb50397ec0d629f3f829a3f24defee3aa43cc5 » 55306aef9c00572064922190670db8894f23c001)

autodoc.git/autodoc.xml:1720: <variable name='client_cert_distinguished_names'><type><array><valuetype><string/></valuetype></array></type></variable> </docgroup> <docgroup homogen-type='variable'><doc><text>Random cookies, sent and received with the hello-messages. </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>Whether this is the server end of the connection or not. </text></group><group><param name='ctx'/><text>The context for the connection. </text></group><group><param name='min_version'/><text>Minimum version of SSL to support. - Defaults to <ref resolved='predef::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>. + Defaults to <ref resolved='7.8::SSL.Constants.ProtocolVersion.PROTOCOL_SSL_3_0'>Constants.PROTOCOL_SSL_3_0</ref>. </text></group><group><param name='max_version'/><text>Maximum version of SSL to support. Defaults to <ref resolved='7.8::SSL.Constants.PROTOCOL_minor'>Constants.PROTOCOL_minor</ref>. </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>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/autodoc.xml:1887: <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>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>. </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>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>Sets the compression method. Currently only <ref resolved='7.8::SSL.Constants.CompressionType.COMPRESSION_null'>COMPRESSION_null</ref> is supported. </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>Interface similar to <ref resolved='7.8::Stdio.File'>Stdio.File</ref>.
autodoc.git/autodoc.xml:5251: <docgroup homogen-name='make_time' homogen-type='method'><doc><text>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>. </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>Returns a mapping similar to that returned by gmtime </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:5352: </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>optional </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>optional </text></group></doc> <variable name='issuer_id'><type><object resolved='predef::Standards.ASN1.Types.BitString'>BitString</object></type></variable> </docgroup>
autodoc.git/autodoc.xml:21891: </docgroup> </class> <class name='Promise'> <doc><text>Promise to provide a <ref resolved='predef::Concurrent.Future'>Future</ref> value. Objects of this class are typically kept internal to the code that provides the <ref resolved='predef::Concurrent.Future'>Future</ref> value. The only thing that is directly returned to the user is the return value from <ref resolved='predef::Concurrent.Promise.future'>future()</ref>. </text><group><seealso/><text><ref resolved='predef::Concurrent.Future'>Future</ref>, <ref resolved='predef::Concurrent.Promise.future'>future()</ref> </text></group></doc> + <docgroup homogen-name='apply_fold' homogen-type='method'><doc><group><param name='initial'/><text>Initial value of the accumulator. + </text></group><group><param name='fun'/><text>Function to apply. The first argument is the result of + one of the <ref>futures</ref>, the second the current accumulated + value, and any further from <ref resolved='predef::Concurrent.Promise.apply_fold.extra'>extra</ref>. + </text></group><group><note/><text>If <ref resolved='predef::Concurrent.Promise.apply_fold.fun'>fun</ref> throws an error it will fail the <ref resolved='predef::Concurrent.Future'>Future</ref>. + </text></group><group><note/><text><ref resolved='predef::Concurrent.Promise.apply_fold.fun'>fun</ref> may be called in any order, and will be called + once for every <ref resolved='predef::Concurrent.Future'>Future</ref> in <ref>futures</ref>, unless one of + calls fails in which case no further calls will be + performed. + </text></group><group><seealso/><text><ref resolved='predef::Concurrent.fold'>Concurrent.fold()</ref>, <ref resolved='predef::Concurrent.Promise.fold'>fold()</ref> + </text></group></doc> + <method name='apply_fold'> + <arguments><argument name='initial'><type><mixed/></type></argument><argument name='fun'><type><function><argtype><mixed/></argtype><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><mixed/></returntype></function></type></argument><argument name='extra'><type><varargs><mixed/></varargs></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> <docgroup homogen-name='create' homogen-type='method'><doc><text>Creates a new promise, optionally initialised from a traditional callback driven method via <expr>executor(resolve, reject, extra ... )</expr>. </text><group><seealso/><text><url>https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise</url> </text></group></doc> <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='executor'><type><or><void/><function><argtype><function><argtype><mixed/></argtype><returntype><void/></returntype></function></argtype><argtype><function><argtype><mixed/></argtype><returntype><void/></returntype></function></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><void/></returntype></function></or></type></argument><argument name='extra'><type><varargs><mixed/></varargs></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='depend' homogen-type='method'><doc><text>Add dependencies the current promise depends on.
autodoc.git/autodoc.xml:21928: callbacks to be called as soon as possible. </text></group><group><seealso/><text><ref resolved='predef::Concurrent.Promise.try_failure'>try_failure()</ref>, <ref resolved='predef::Concurrent.Promise.success'>success()</ref>, <ref resolved='predef::Concurrent.Future.on_failure'>on_failure()</ref> </text></group></doc> <method name='failure'> <arguments><argument name='value'><type><mixed/></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='fold' homogen-type='method'><doc><text>Add futures the current promise must accumulate. </text><group><param name='futures'/><text>The list of all the <expr>futures</expr> we must accumulate. - </text></group><group><seealso/><text><ref resolved='predef::Concurrent.fold'>Concurrent.fold()</ref>, <ref resolved='predef::Concurrent.Promise.fold_finish'>fold_finish()</ref> + </text></group><group><seealso/><text><ref resolved='predef::Concurrent.fold'>Concurrent.fold()</ref>, <ref resolved='predef::Concurrent.Promise.apply_fold'>apply_fold()</ref> </text></group></doc> <method name='fold'> <arguments><argument name='futures'><type><array><valuetype><object resolved='predef::Concurrent.Future'>Future</object></valuetype></array></type></argument></arguments> <returntype><void/></returntype> </method> <method name='fold'><modifiers><local/><variant/></modifiers> <arguments><argument name='futures'><type><varargs><object resolved='predef::Concurrent.Future'>Future</object></varargs></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> - <docgroup homogen-name='fold_finish' homogen-type='method'><doc><group><param name='initial'/><text>Initial value of the accumulator. - </text></group><group><param name='fun'/><text>Function to apply. The first argument is the result of - one of the <ref>futures</ref>, the second the current accumulated - value, and any further from <ref resolved='predef::Concurrent.Promise.fold_finish.extra'>extra</ref>. - </text></group><group><note/><text>If <ref resolved='predef::Concurrent.Promise.fold_finish.fun'>fun</ref> throws an error it will fail the <ref resolved='predef::Concurrent.Future'>Future</ref>. - </text></group><group><note/><text><ref resolved='predef::Concurrent.Promise.fold_finish.fun'>fun</ref> may be called in any order, and will be called - once for every <ref resolved='predef::Concurrent.Future'>Future</ref> in <ref>futures</ref>, unless one of - calls fails in which case no further calls will be - performed. - </text></group><group><seealso/><text><ref resolved='predef::Concurrent.fold'>Concurrent.fold()</ref>, <ref resolved='predef::Concurrent.Promise.fold'>fold()</ref> - </text></group></doc> - <method name='fold_finish'> - <arguments><argument name='initial'><type><mixed/></type></argument><argument name='fun'><type><function><argtype><mixed/></argtype><argtype><mixed/></argtype><argtype><varargs><mixed/></varargs></argtype><returntype><mixed/></returntype></function></type></argument><argument name='extra'><type><varargs><mixed/></varargs></type></argument></arguments> - <returntype><void/></returntype> - </method> - </docgroup> + <docgroup homogen-name='future' homogen-type='method'><doc><text>The future value that we promise. </text></doc> <method name='future'> <arguments/> <returntype><object resolved='predef::Concurrent.Future'>Future</object></returntype> </method> </docgroup> <docgroup homogen-name='Future' homogen-type='inherit'> <inherit name='Future'><classname resolved='predef::Concurrent.Future'>Future</classname></inherit> </docgroup>
autodoc.git/autodoc.xml:94805: <variable name='lr_error'><type><int/></type></variable> </docgroup> <docgroup homogen-name='make_parser' homogen-type='method'><doc><text>Compiles the parser-specification given in the first argument. Named actions are taken from the object if available, otherwise left as is. </text><group><bugs/><text>Returns error-code in both GrammarParser.error and return_value->lr_error. </text></group></doc> <method name='make_parser'> <arguments><argument name='str'><type><string/></type></argument><argument name='m'><type><or><object resolved='predef::Parser.LR.GrammarParser.make_parser'/><void/></or></type></argument></arguments> - <returntype><object resolved='predef::Parser.LR.Parser'>Parser</object></returntype> + <returntype><object resolved='predef::Parser'>Parser</object></returntype> </method> </docgroup> <docgroup homogen-name='make_parser_from_file' homogen-type='method'><doc><text>Compiles the file specified in the first argument into an LR parser. </text><group><seealso/><text><ref resolved='predef::Parser.LR.GrammarParser.make_parser'>make_parser</ref> </text></group></doc> <method name='make_parser_from_file'> <arguments><argument name='fname'><type><string/></type></argument><argument name='m'><type><or><object resolved='predef::Parser.LR.GrammarParser.make_parser_from_file'/><void/></or></type></argument></arguments> - <returntype><or><int/><object resolved='predef::Parser.LR.Parser'>Parser</object></or></returntype> + <returntype><or><int/><object resolved='predef::Parser'>Parser</object></or></returntype> </method> </docgroup> </module> <class name='Parser'> <doc><text>This object implements an LALR(1) parser and compiler. Normal use of this object would be: <pre> set_error_handler {add_rule, set_priority, set_associativity}* set_symbol_to_string
autodoc.git/autodoc.xml:121334: public keys must be set. </text></group><group><param name='name'/><text>The distinguished name for the certificate. </text></group><group><param name='attributes'/><text>Attributes from PKCS #9 to add to the certificate. </text></group><group><param name='hash'/><text>Hash algoritm to use for the CSR signature. Defaults to <ref resolved='predef::Crypto.SHA256'>Crypto.SHA256</ref>. </text></group><group><note/><text>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>. </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>Sign a <ref resolved='predef::Standards.PKCS.CSR.CRI'>CRI</ref> to generate a Certificate Signing Request.
autodoc.git/autodoc.xml:121784: Setting The signature. </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>Getting ASN.1 structure that has been signed. Setting ASN.1 structure that has been signed. </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>A mapping between country TLDs and the name of the country. </text></doc> <constant name='cc'/> </docgroup> <docgroup homogen-name='generic' homogen-type='variable'><doc><text>A multiset containing the generic TLDs, such as "com" and "info".
autodoc.git/autodoc.xml:122296: <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>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. </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>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>. </text><group><param name='c'/><text>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.
autodoc.git/autodoc.xml:122580: </docgroup> <docgroup homogen-name='ext_subjectKeyIdentifier' homogen-type='variable'><doc><text>Set to the value of the SubjectKeyIdentifier if the certificate contains the subjectKeyIdentifier extension. <rfc>3280:4.2.1.2</rfc>. </text></doc> <variable name='ext_subjectKeyIdentifier'><type><string/></type></variable> </docgroup> <docgroup homogen-name='extensions' homogen-type='variable'><doc><group><note/><text>optional </text></group><group><note/><text>Read only </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>Algorithm hash if known and supported. Otherwise <ref resolved='predef::.UNDEFINED'>UNDEFINED</ref>. </text><group><note/><text>Read only </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>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>. </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>optional </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>optional </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>Certificate issuer. </text></doc> <variable name='issuer'><type><void/></type></variable> </docgroup> <docgroup homogen-name='issuer_id' homogen-type='variable'><doc><group><note/><text>optional </text></group></doc> <variable name='issuer_id'><type><void/></type></variable> </docgroup> <docgroup homogen-name='keyinfo' homogen-type='variable'>

autodoc.git / autodoc.xml