Diff of autodoc.git/traditional.xml (b887c2d2ca5ca1df3428d610e4f6ecc211ca7c1c » ac4297b338278f5e25d059421a8d534a895a37c0)

autodoc.git/traditional.xml:1: <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2017-03-20' version='Pike v8.1.9'> + <manual time-stamp='2017-03-21' version='Pike v8.1.9'> <dir name='./traditional_manual'> <file name='./traditional_manual/index.html'> <chapter title='Table of Contents' unnumbered='1'> <dl><dt><url href='index.html'>Table of Contents</url></dt> <dt><url href='chapter_1.html'>1. Introduction</url></dt> <dd><url href='chapter_1.html#1'>1.1. Overview</url></dd> <dd><url href='chapter_1.html#2'>1.2. The history of Pike</url></dd> <dd><url href='chapter_1.html#3'>1.3. A comparison with other languages</url></dd> <dd><url href='chapter_1.html#4'>1.4. What is Pike</url></dd> <dd><url href='chapter_1.html#5'>1.5. Pike License</url></dd>
autodoc.git/traditional.xml:115007: </text><group><returns/><text>Returns a new point on the curve. </text></group></doc> <method name='`*'> <arguments><argument name='scalar'><type><string><min>0</min><max>255</max></string></type></argument></arguments> <returntype><object resolved='predef::Nettle.Curve25519.Point'>Point</object></returntype> </method> </docgroup> <docgroup homogen-name='ECC_Curve' homogen-type='inherit'> <inherit name='ECC_Curve'><classname resolved='predef::__builtin.Nettle.ECC_Curve'>__builtin.Nettle.ECC_Curve</classname></inherit> </docgroup> + <docgroup homogen-name='jose_name' homogen-type='method'><doc><text>Returns the name of the curve according to JOSE + (<rfc>8037:3.1</rfc>). + </text><group><returns/><text>Returns the string <expr>"X25519"</expr>. + </text></group><group><seealso/><text><ref resolved='predef::Nettle.Curve25519.name'>name()</ref> + </text></group></doc> + <method name='jose_name'> + <arguments/> + <returntype><string><min>0</min><max>127</max></string></returntype> + </method> + </docgroup> <docgroup homogen-name='name' homogen-type='method'><doc><text>Returns the name of the curve. </text></doc> <method name='name'> <arguments/> <returntype><string><min>0</min><max>127</max></string></returntype> </method> </docgroup> <docgroup homogen-name='new_scalar' homogen-type='method'><doc><group><param name='rnd'/><text>Randomness function to use as source. </text></group><group><returns/><text>Returns a random scalar suitable to use as an <ref>ECDSA</ref> private key or as an ECDH exponent.
autodoc.git/traditional.xml:115070: <returntype><string><min>0</min><max>255</max></string></returntype> </method> </docgroup> <docgroup homogen-name='get_x' homogen-type='method'><doc><text>Get the x coordinate of the public key. </text></doc> <method name='get_x'> <arguments/> <returntype><string><min>0</min><max>255</max></string></returntype> </method> </docgroup> + <docgroup homogen-name='Point' homogen-type='inherit'><doc><text>This point represents the public key. + </text></doc> + <inherit name='Point'><classname resolved='predef::Nettle.Curve25519.Point'>Point</classname></inherit> + </docgroup> <docgroup homogen-name='Sign' homogen-type='inherit'> <inherit name='Sign'><classname resolved='predef::__builtin.Nettle.Sign'>__builtin.Nettle.Sign</classname></inherit> </docgroup> - + <docgroup homogen-name='jose_name' homogen-type='method'><doc><text>Returns the string <expr>"Ed25519"</expr>. + </text></doc> + <method name='jose_name'> + <arguments/> + <returntype><string><min>0</min><max>127</max></string></returntype> + </method> + </docgroup> <docgroup homogen-name='name' homogen-type='method'><doc><text>Returns the string <expr>"EdDSA"</expr>. </text></doc> <method name='name'> <arguments/> <returntype><string><min>0</min><max>127</max></string></returntype> </method> </docgroup> <docgroup homogen-name='raw_sign' homogen-type='method'><doc><text>Sign the <ref resolved='predef::Nettle.Curve25519.EdDSA.raw_sign.message'>message</ref>. </text></doc> <method name='raw_sign'>
autodoc.git/traditional.xml:124908: 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::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::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> <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/traditional.xml:125340: 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::Object'>Object</object></type></variable> + <variable name='tbs'><type><object resolved='predef::Standards.ASN1.Types.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/traditional.xml:125851: <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::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::Standards.ASN1.Types.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/traditional.xml:126135: </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::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::Standards.ASN1.Types.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::Object'>Object</object></or></type></argument></arguments> + <arguments><argument name='asn1'><type><or><array/><object resolved='predef::Standards.ASN1.Types.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::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::Standards.ASN1.Types.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 / traditional.xml