autodoc.git
/
autodoc.xml
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/autodoc.xml:1122:
</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><p>Implements Diffie-Hellman key-exchange.</p> <p> The following key exchange methods are implemented here:
-
<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>.</p>
+
<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>.</p>
</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><p>Diffie-Hellman parameters.</p>
autodoc.git/autodoc.xml:1906:
<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='
7.8
::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='
predef
::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/autodoc.xml:96438:
<variable name='lr_error'><type><int/></type></variable> </docgroup> <docgroup homogen-name='make_parser' homogen-type='method'><doc><text><p>Compiles the parser-specification given in the first argument. Named actions are taken from the object if available, otherwise left as is.</p> </text><group><bugs/><text><p>Returns error-code in both GrammarParser.error and return_value->lr_error.</p> </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><p>Compiles the file specified in the first argument into an LR parser.</p> </text><group><seealso/><text><p><ref resolved='predef::Parser.LR.GrammarParser.make_parser'>make_parser</ref></p> </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><p>This object implements an LALR(1) parser and compiler.</p> <p> Normal use of this object would be:</p> <p> <pre> set_error_handler {add_rule, set_priority, set_associativity}* set_symbol_to_string
autodoc.git/autodoc.xml:103882:
string c = auth->challenge(); request->response_and_finish( ([ "error":401, "extra_heads" : ([ "WWW-Authenticate":c, ]) ]) ); }); return authenticated; }</p> </text></group></doc> <docgroup homogen-name='authenticate' homogen-type='method'><doc><text><p>Authenticate a request.</p>
-
</text><group><param name='
string
'/><text><p>The value of the Authorization header. Zero is acceptable, but
+
</text><group><param name='
hdr
'/><text><p>The value of the Authorization header. Zero is acceptable, but
will produce an unconditional rejection.</p>
-
</text></group><group><param name='
string
'/><text><p>This is the HTTP method used, typically "GET" or "POST".</p>
-
</text></group><group><param name='
string
'/><text><p>This is the path of the request.</p>
+
</text></group><group><param name='
method
'/><text><p>This is the HTTP method used, typically "GET" or "POST".</p>
+
</text></group><group><param name='
path
'/><text><p>This is the path of the request.</p>
</text></group></doc> <method name='authenticate'> <arguments><argument name='hdr'><type><string/></type></argument><argument name='method'><type><string/></type></argument><argument name='path'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Concurrent.Future'>Concurrent.Future</object></returntype> </method> </docgroup> <docgroup homogen-name='challenge' homogen-type='method'><doc><text><p>Creates a challenge header value for the WWW-Authenticate header in 401 responses.</p> </text></doc> <method name='challenge'> <arguments/>
-
<returntype><string/></returntype>
+
<returntype><string
><min>0<
/
min
><
max>127<
/
max></string></
returntype>
</method> </docgroup>
-
<docgroup homogen-name='create' homogen-type='method'>
+
<docgroup homogen-name='create' homogen-type='method'>
<doc><group><param name='realm'/><text><p>The realm to be authenticated.</p>
+
</text></group><group><param name='key'/><text><p>If this key is set all challanges are verified against
+
signature using this key. The key can be any 8-bit string, but
+
should be the same across multiple instances on the same
+
domain, and over time.</p>
+
</text></group></doc>
<method name='create'><modifiers><protected/></modifiers>
-
<arguments><argument name='realm'><type><string/></type></argument></arguments>
+
<arguments><argument name='realm'><type><string
><min>0<
/
min
><
max>255<
/
max></string></
type></argument><
argument name='key'><type><or><void
/
><string><min>0</min><max>255</max></string></or></type></argument></
arguments>
<returntype><void/></returntype> </method> </docgroup> <docgroup homogen-name='get_hashed_password' homogen-type='method'><doc><text><p>Function intended to be overloaded that returns a future that will resolved to the given users hashed password. Overloading this function will prevent <ref resolved='predef::Protocols.HTTP.Authentication.DigestMD5.get_password'>get_password</ref> from being called.</p> </text></doc> <method name='get_hashed_password'> <arguments><argument name='user'><type><string/></type></argument><argument name='nonce'><type><string/></type></argument><argument name='cnonce'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Concurrent.Future'>Concurrent.Future</object></returntype>
autodoc.git/autodoc.xml:103924:
</docgroup> <docgroup homogen-name='get_password' homogen-type='method'><doc><text><p>Function intended to be overloaded that returns a future that will resolve to the given users password.</p> </text><group><seealso/><text><p><ref resolved='predef::Protocols.HTTP.Authentication.DigestMD5.get_hashed_password'>get_hashed_password</ref></p> </text></group></doc> <method name='get_password'> <arguments><argument name='user'><type><string/></type></argument></arguments> <returntype><object resolved='predef::Concurrent.Future'>Concurrent.Future</object></returntype> </method> </docgroup>
-
<docgroup homogen-name='realm' homogen-type='variable'>
-
<variable name='realm'><type><string/></type></variable>
-
</docgroup>
+
<docgroup homogen-name='split_response' homogen-type='method'><doc><text><p>Split client generated Authorization header into its parts.</p> </text></doc> <method name='split_response'> <arguments><argument name='hdr'><type><string/></type></argument></arguments> <returntype><mapping><indextype><string/></indextype><valuetype><string/></valuetype></mapping></returntype> </method> </docgroup> </class> </module> <module name='Promise'>