Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_ssl_module.xml @ 1857:0882ccb0c00f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented the $ssl_curves and $ssl_ciphers variables.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 08 Dec 2016 19:03:22 +0300
parents 7133004fa5b3
children fef4ab2d990c
comparison
equal deleted inserted replaced
1856:7133004fa5b3 1857:0882ccb0c00f
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_ssl_module" 10 <module name="Module ngx_http_ssl_module"
11 link="/en/docs/http/ngx_http_ssl_module.html" 11 link="/en/docs/http/ngx_http_ssl_module.html"
12 lang="en" 12 lang="en"
13 rev="27"> 13 rev="28">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_ssl_module</literal> module provides the 18 The <literal>ngx_http_ssl_module</literal> module provides the
760 <tag-desc> 760 <tag-desc>
761 returns the string of ciphers used 761 returns the string of ciphers used
762 for an established SSL connection; 762 for an established SSL connection;
763 </tag-desc> 763 </tag-desc>
764 764
765 <tag-name id="var_ssl_ciphers"><var>$ssl_ciphers</var></tag-name>
766 <tag-desc>
767 returns the list of ciphers supported by the client (1.11.7).
768 Known ciphers are listed by names, unknown are shown in hexadecimal,
769 for example:
770 <example>
771 AES128-SHA:AES256-SHA:0x00ff
772 </example>
773 <note>
774 The variable is fully supported only when using OpenSSL version 1.0.2 or higher.
775 With older versions, the variable is available
776 only for new sessions and lists only known ciphers.
777 </note>
778 </tag-desc>
779
765 <tag-name id="var_ssl_client_cert"><var>$ssl_client_cert</var></tag-name> 780 <tag-name id="var_ssl_client_cert"><var>$ssl_client_cert</var></tag-name>
766 <tag-desc> 781 <tag-desc>
767 returns the client certificate in the PEM format 782 returns the client certificate in the PEM format
768 for an established SSL connection, with each line except the first 783 for an established SSL connection, with each line except the first
769 prepended with the tab character; 784 prepended with the tab character;
847 Prior to version 1.11.7, the “<literal>FAILED</literal>” result 862 Prior to version 1.11.7, the “<literal>FAILED</literal>” result
848 did not contain the <value>reason</value> string. 863 did not contain the <value>reason</value> string.
849 </note> 864 </note>
850 </tag-desc> 865 </tag-desc>
851 866
867 <tag-name id="var_ssl_curves"><var>$ssl_curves</var></tag-name>
868 <tag-desc>
869 returns the list of curves supported by the client (1.11.7).
870 Known curves are listed by names, unknown are shown in hexadecimal,
871 for example:
872 <example>
873 0x001d:prime256v1:secp521r1:secp384r1
874 </example>
875 <note>
876 The variable is supported only when using OpenSSL version 1.0.2 or higher.
877 With older versions, the variable value will be an empty string.
878 </note>
879 <note>
880 The variable is available only for new sessions.
881 </note>
882 </tag-desc>
883
852 <tag-name id="var_ssl_protocol"><var>$ssl_protocol</var></tag-name> 884 <tag-name id="var_ssl_protocol"><var>$ssl_protocol</var></tag-name>
853 <tag-desc> 885 <tag-desc>
854 returns the protocol of an established SSL connection; 886 returns the protocol of an established SSL connection;
855 </tag-desc> 887 </tag-desc>
856 888