Diff of autodoc.git/autodoc.xml (f5e28b216dba362fedb8466a16733876d647eb9e » 7eef6596669de7517bfe2312a73d6e539ed845da)

autodoc.git/autodoc.xml:1103: </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>Implements Diffie-Hellman key-exchange. 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>. + <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>. </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>Diffie-Hellman parameters.
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: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::Object'>Object</object></type></argument></arguments> + <arguments><argument name='_keyinfo'><type><object resolved='predef::Standards.ASN1.Types.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::Object'>Object</object></type></argument></arguments> + <arguments><argument name='asn1'><type><object resolved='predef::Standards.ASN1.Types.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:11033: except for characters 0xfffe and 0xffff. Characters in range 0x010000 - 0x10ffff are encoded using surrogates. </text></group><group><seealso/><text><ref resolved='predef::Charset.decoder'>Charset.decoder()</ref>, <ref resolved='predef::string_to_utf8'>string_to_utf8()</ref>, <ref resolved='predef::unicode_to_string'>unicode_to_string()</ref>, <ref resolved='predef::utf8_to_string'>utf8_to_string()</ref> </text></group></doc> <method name='string_to_unicode'> <arguments><argument name='s'><type><string/></type></argument><argument name='byteorder'><type><or><int><min>0</min><max>2</max></int><void/></or></type></argument></arguments> <returntype><string><min>0</min><max>255</max></string></returntype> </method> </docgroup> - <docgroup homogen-name='string_to_utf8' homogen-type='method'><doc><text>Converts a string into an UTF-8 compliant byte-stream. - </text><group><note/><text>Throws an error if characters not valid in an UTF-8 stream are + <docgroup homogen-name='string_to_utf8' homogen-type='method'><doc><text>Convert a string into a UTF-8 compliant byte-stream. + </text><group><param name='s'/><text>String to encode into UTF-8. + </text></group><group><param name='extended'/><text>Bitmask with extension options. + <int><group><value>1</value><text>Accept and encode the characters outside the valid ranges + using the same algorithm. Such encoded characters are + however not UTF-8 compliant. + </text></group><group><value>2</value><text>Encode characters outside the BMP with UTF-8 encoded UTF-16 + (ie split them into surrogate pairs and encode). + </text></group></int> + </text></group><group><note/><text>Throws an error if characters not valid in an UTF-8 stream are encountered. Valid characters are in the ranges <expr>0x00000000-0x0000d7ff</expr> and <expr>0x0000e000-0x0010ffff</expr>. - If <ref resolved='predef::string_to_utf8.extended'>extended</ref> is 1 then characters outside the valid ranges are - accepted too and encoded using the same algorithm. Such encoded - characters are however not UTF-8 compliant. + </text></group><group><seealso/><text><ref resolved='predef::Charset.encoder'>Charset.encoder()</ref>, <ref resolved='predef::string_to_unicode'>string_to_unicode()</ref>, <ref resolved='predef::unicode_to_string'>unicode_to_string()</ref>, <ref resolved='predef::utf8_to_string'>utf8_to_string()</ref> </text></group></doc> <method name='string_to_utf8'> <arguments><argument name='s'><type><string/></type></argument></arguments> <returntype><object>utf8_string</object></returntype> </method> <method name='string_to_utf8'> <arguments><argument name='s'><type><string/></type></argument><argument name='extended'><type><int/></type></argument></arguments> <returntype><object>utf8_string</object></returntype>
autodoc.git/autodoc.xml:95651: <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:122790: 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:123240: 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:123752: <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:124036: </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:128978: </method> </docgroup> </class> <class name='Termcap'> <doc><text>Termcap terminal description object. </text></doc> <docgroup homogen-name='aliases' homogen-type='variable'> <variable name='aliases'><type><array><valuetype><string/></valuetype></array></type></variable> </docgroup> <docgroup homogen-name='create' homogen-type='method'> - <method name='create'> + <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='cap'><type><string/></type></argument><argument name='tcdb'><type><or><object resolved='predef::Stdio.Terminfo.TermcapDB'>TermcapDB</object><void/></or></type></argument><argument name='maxrecurse'><type><or><int/><void/></or></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='TermMachine' homogen-type='inherit'> <inherit name='TermMachine'><classname>TermMachine</classname></inherit> </docgroup> <docgroup homogen-name='tputs' homogen-type='method'><doc><text>Put termcap string </text></doc> <method name='tputs'>
autodoc.git/autodoc.xml:129005: <doc><text>Termcap database </text></doc> </class> <class name='Terminfo'> <doc><text>Terminfo terminal description object </text></doc> <docgroup homogen-name='aliases' homogen-type='variable'> <variable name='aliases'><type><array><valuetype><string/></valuetype></array></type></variable> </docgroup> <docgroup homogen-name='create' homogen-type='method'> - <method name='create'> + <method name='create'><modifiers><protected/></modifiers> <arguments><argument name='filename'><type><string/></type></argument></arguments> <returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='TermMachine' homogen-type='inherit'> <inherit name='TermMachine'><classname>TermMachine</classname></inherit> </docgroup> <docgroup homogen-name='tputs' homogen-type='method'><doc><group><fixme/><text>Document this function </text></group></doc> <method name='tputs'>

autodoc.git / autodoc.xml