diff options
| -rw-r--r-- | lib/inets/doc/src/mod_esi.xml | 155 | ||||
| -rw-r--r-- | lib/public_key/doc/src/public_key.xml | 1 | ||||
| -rw-r--r-- | lib/ssl/doc/src/ssl.xml | 19 | ||||
| -rw-r--r-- | lib/ssl/doc/src/ssl_app.xml | 4 |
4 files changed, 92 insertions, 87 deletions
diff --git a/lib/inets/doc/src/mod_esi.xml b/lib/inets/doc/src/mod_esi.xml index deef010e54..8279fdc824 100644 --- a/lib/inets/doc/src/mod_esi.xml +++ b/lib/inets/doc/src/mod_esi.xml @@ -42,8 +42,7 @@ <taglist> <tag><c>env() = </c></tag> <item> <p><c>{EnvKey()::atom(), Value::term()}</c></p> - </item> - + <p>Currently supported key value pairs</p> <taglist> @@ -59,11 +58,12 @@ <tag><c>{server_protocol, string()}</c></tag> <item><p> HTTP version, currently "HTTP/1.1"</p></item> - <tag>{server_port, integer()}</tag> + <tag><c>{server_port, integer()}</c></tag> <item><p>Servers port number.</p></item> <tag><c>{request_method, "GET | "PUT" | "DELETE | "POST" | "PATCH"}</c></tag> - + <item><p>HTTP request method.</p></item> + <tag><c>{remote_adress, inet:ip_address()} </c></tag> <item><p>The clients ip address.</p></item> @@ -81,94 +81,97 @@ <tag><c>{http_LowerCaseHTTPHeaderName, string()}</c></tag> <item><p>example: {http_content_type, "text/html"}</p></item> - </taglist> - + </taglist> + </item> </taglist> + </section> - <funcs> - <func> - <name>deliver(SessionID, Data) -> ok | {error, Reason}</name> - <fsummary>Sends <c>Data</c> back to client.</fsummary> - <type> + <funcs> + <func> + <name>deliver(SessionID, Data) -> ok | {error, Reason}</name> + <fsummary>Sends <c>Data</c> back to client.</fsummary> + <type> <v>SessionID = term()</v> <v>Data = string() | io_list() | binary()</v> <v>Reason = term()</v> - </type> - <desc> - <marker id="deliver"></marker> - <p>This function is <em>only</em> intended to be used from - functions called by the Erl Scheme interface to deliver - parts of the content to the user.</p> - <p>Sends data from an Erl Scheme script back to the client.</p> + </type> + <desc> + <marker id="deliver"></marker> + <p>This function is <em>only</em> intended to be used from + functions called by the Erl Scheme interface to deliver + parts of the content to the user.</p> + <p>Sends data from an Erl Scheme script back to the client.</p> - <note> - <p>If any HTTP header fields are added by the - script, they must be in the first call to <c>deliver/2</c>, - and the data in the call must be a string. Calls after the headers - are complete can contain binary data to reduce copying - overhead. Do not assume anything about the data type of - <c>SessionID</c>. <c>SessionID</c> must be the value given - as input to the ESI callback function that you implemented.</p> - </note> - </desc> - </func> - </funcs> - </section> - <section> - <title>ESI Callback Functions</title> - </section> - <funcs> - <func> - <name>Module:Function(SessionID, Env, Input)-> _ </name> - <fsummary>Creates a dynamic web page and returns it chunk by chunk - to the server process by calling <c>mod_esi:deliver/2</c>.</fsummary> - <type> - <v>SessionID = term()</v> - <v>Env = env()</v> - <v>Input = string()</v> - </type> + <note> + <p>If any HTTP header fields are added by the + script, they must be in the first call to <c>deliver/2</c>, + and the data in the call must be a string. Calls after the headers + are complete can contain binary data to reduce copying + overhead. Do not assume anything about the data type of + <c>SessionID</c>. <c>SessionID</c> must be the value given + as input to the ESI callback function that you implemented.</p> + </note> + </desc> + </func> + </funcs> + + <section> + <title>ESI Callback Functions</title> + </section> + + <funcs> + <func> + <name>Module:Function(SessionID, Env, Input)-> _ </name> + <fsummary>Creates a dynamic web page and returns it chunk by chunk + to the server process by calling <c>mod_esi:deliver/2</c>.</fsummary> + <type> + <v>SessionID = term()</v> + <v>Env = env()</v> + <v>Input = string()</v> + </type> <desc> <p><c>Module</c> must be found in the code path and export - <c>Function</c> with an arity of three. An <c>erlScriptAlias</c> must - also be set up in the configuration file for the web server.</p> + <c>Function</c> with an arity of three. An <c>erlScriptAlias</c> must + also be set up in the configuration file for the web server.</p> <p>If the HTTP request is a 'post' request and a body is sent, - <c>content_length</c> is the length of the posted - data. If 'get' is used, <c>query_string</c> is the data after - <em>?</em> in the URL.</p> + <c>content_length</c> is the length of the posted + data. If 'get' is used, <c>query_string</c> is the data after + <em>?</em> in the URL.</p> <p><c>ParsedHeader</c> is the HTTP request as a key-value tuple - list. The keys in <c>ParsedHeader</c> are in lower case.</p> + list. The keys in <c>ParsedHeader</c> are in lower case.</p> <p><c>SessionID</c> is an identifier - the server uses when <c>deliver/2</c> is called. Do not - assume anything about the datatype.</p> + the server uses when <c>deliver/2</c> is called. Do not + assume anything about the datatype.</p> <p>Use this callback function to generate dynamic web - content dynamically. When a part of the page is generated, send the - data back to the client through <c>deliver/2</c>. Notice - that the first chunk of data sent to the client must at - least contain all HTTP header fields that the response - will generate. If the first chunk does not contain the - <em>end of HTTP header</em>, that is, <c>"\r\n\r\n",</c> - the server assumes that no HTTP header fields will be generated.</p> + content dynamically. When a part of the page is generated, send the + data back to the client through <c>deliver/2</c>. Notice + that the first chunk of data sent to the client must at + least contain all HTTP header fields that the response + will generate. If the first chunk does not contain the + <em>end of HTTP header</em>, that is, <c>"\r\n\r\n",</c> + the server assumes that no HTTP header fields will be generated.</p> </desc> - </func> - <func> - <name>Module:Function(Env, Input)-> Response </name> - <fsummary>Creates a dynamic web page and returns it as a list. - This function is deprecated and is only kept for backwards compatibility.</fsummary> - <type> - <v>Env = env()</v> - <v>Input = string()</v> - <v>Response = string()</v> - </type> + </func> + + <func> + <name>Module:Function(Env, Input)-> Response </name> + <fsummary>Creates a dynamic web page and returns it as a list. + This function is deprecated and is only kept for backwards compatibility.</fsummary> + <type> + <v>Env = env()</v> + <v>Input = string()</v> + <v>Response = string()</v> + </type> <desc> <p>This callback format consumes much memory, as the - whole response must be generated before it is sent to the - user. This function is deprecated and is only kept for backwards - compatibility. - For new development, use <c>Module:Function/3</c>.</p> + whole response must be generated before it is sent to the + user. This function is deprecated and is only kept for backwards + compatibility. + For new development, use <c>Module:Function/3</c>.</p> </desc> - </func> - </funcs> - + </func> + </funcs> + </erlref> diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml index 74bb06b9b2..385604677c 100644 --- a/lib/public_key/doc/src/public_key.xml +++ b/lib/public_key/doc/src/public_key.xml @@ -839,6 +839,7 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, <func> <name>short_name_hash(Name) -> string()</name> + <fsummary>Generates a short hash of an issuer name.</fsummary> <type> <v>Name = issuer_name()</v> </type> diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml index 4ea000802f..abba5aaf59 100644 --- a/lib/ssl/doc/src/ssl.xml +++ b/lib/ssl/doc/src/ssl.xml @@ -464,10 +464,12 @@ fun(srp, Username :: string(), UserState :: term()) -> <tag><c>{padding_check, boolean()}</c></tag> <item><p>Affects TLS-1.0 connections only. If set to <c>false</c>, it disables the block cipher padding check - to be able to interoperate with legacy software.</p></item> - - <warning><p>Using <c>{padding_check, boolean()}</c> makes TLS + to be able to interoperate with legacy software.</p> + <warning><p>Using <c>{padding_check, boolean()}</c> makes TLS vulnerable to the Poodle attack.</p></warning> + </item> + + <tag><c>{beast_mitigation, one_n_minus_one | zero_n | disabled}</c></tag> <item><p>Affects SSL-3.0 and TLS-1.0 connections only. Used to change the BEAST @@ -478,11 +480,12 @@ fun(srp, Username :: string(), UserState :: term()) -> <p><c>zero_n</c> - Perform 0/n BEAST mitigation.</p> - <p><c>disabled</c> - Disable BEAST mitigation.</p></item> + <p><c>disabled</c> - Disable BEAST mitigation.</p> - <warning><p>Using <c>{beast_mitigation, disabled}</c> makes SSL or TLS + <warning><p>Using <c>{beast_mitigation, disabled}</c> makes SSL or TLS vulnerable to the BEAST attack.</p></warning> - </taglist> + </item> + </taglist> </section> @@ -595,7 +598,7 @@ fun(srp, Username :: string(), UserState :: term()) -> TLS handshake. If no lower TLS versions than 1.2 are supported, the client will send a TLS signature algorithm extension with the algorithms specified by this option. - Defaults to + Defaults to</p> <code>[ %% SHA2 @@ -612,7 +615,7 @@ fun(srp, Username :: string(), UserState :: term()) -> {sha, rsa}, {sha, dsa}, ]</code> - +<p> The algorithms should be in the preferred order. Selected signature algorithm can restrict which hash functions that may be selected. Default support for {md5, rsa} removed in ssl-8.0 diff --git a/lib/ssl/doc/src/ssl_app.xml b/lib/ssl/doc/src/ssl_app.xml index e50ffdbfe6..0b3fa9a8a9 100644 --- a/lib/ssl/doc/src/ssl_app.xml +++ b/lib/ssl/doc/src/ssl_app.xml @@ -109,7 +109,7 @@ <item><p>List of extra user-defined arguments to the <c>init</c> function in the session cache callback module. Defaults to <c>[]</c>.</p></item> - <tag><c><![CDATA[session_cache_client_max = integer() <optional>]]></c><br/> + <tag><c><![CDATA[session_cache_client_max = integer() <optional>]]></c><br/></tag> <item><p>Limits the growth of the clients session cache, that is how many sessions towards servers that are cached to be used by new client connections. If the maximum number of sessions is @@ -142,8 +142,6 @@ shutdown gracefully. Defaults to 5000 milliseconds. </p> </item> - </tag> - </taglist> </section> |