changeset 1857:0882ccb0c00f

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 36cbfff92c6d
files xml/en/docs/http/ngx_http_ssl_module.xml xml/en/docs/stream/ngx_stream_ssl_module.xml xml/ru/docs/http/ngx_http_ssl_module.xml xml/ru/docs/stream/ngx_stream_ssl_module.xml
diffstat 4 files changed, 134 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_ssl_module.xml
+++ b/xml/en/docs/http/ngx_http_ssl_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_ssl_module"
         link="/en/docs/http/ngx_http_ssl_module.html"
         lang="en"
-        rev="27">
+        rev="28">
 
 <section id="summary">
 
@@ -762,6 +762,21 @@ returns the string of ciphers used
 for an established SSL connection;
 </tag-desc>
 
+<tag-name id="var_ssl_ciphers"><var>$ssl_ciphers</var></tag-name>
+<tag-desc>
+returns the list of ciphers supported by the client (1.11.7).
+Known ciphers are listed by names, unknown are shown in hexadecimal,
+for example:
+<example>
+AES128-SHA:AES256-SHA:0x00ff
+</example>
+<note>
+The variable is fully supported only when using OpenSSL version 1.0.2 or higher.
+With older versions, the variable is available
+only for new sessions and lists only known ciphers.
+</note>
+</tag-desc>
+
 <tag-name id="var_ssl_client_cert"><var>$ssl_client_cert</var></tag-name>
 <tag-desc>
 returns the client certificate in the PEM format
@@ -849,6 +864,23 @@ did not contain the <value>reason</value
 </note>
 </tag-desc>
 
+<tag-name id="var_ssl_curves"><var>$ssl_curves</var></tag-name>
+<tag-desc>
+returns the list of curves supported by the client (1.11.7).
+Known curves are listed by names, unknown are shown in hexadecimal,
+for example:
+<example>
+0x001d:prime256v1:secp521r1:secp384r1
+</example>
+<note>
+The variable is supported only when using OpenSSL version 1.0.2 or higher.
+With older versions, the variable value will be an empty string.
+</note>
+<note>
+The variable is available only for new sessions.
+</note>
+</tag-desc>
+
 <tag-name id="var_ssl_protocol"><var>$ssl_protocol</var></tag-name>
 <tag-desc>
 returns the protocol of an established SSL connection;
--- a/xml/en/docs/stream/ngx_stream_ssl_module.xml
+++ b/xml/en/docs/stream/ngx_stream_ssl_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_ssl_module"
         link="/en/docs/stream/ngx_stream_ssl_module.html"
         lang="en"
-        rev="11">
+        rev="12">
 
 <section id="summary">
 
@@ -435,6 +435,38 @@ returns the string of ciphers used
 for an established SSL connection;
 </tag-desc>
 
+<tag-name id="var_ssl_ciphers"><var>$ssl_ciphers</var></tag-name>
+<tag-desc>
+returns the list of ciphers supported by the client (1.11.7).
+Known ciphers are listed by names, unknown are shown in hexadecimal,
+for example:
+<example>
+AES128-SHA:AES256-SHA:0x00ff
+</example>
+<note>
+The variable is fully supported only when using OpenSSL version 1.0.2 or higher.
+With older versions, the variable is available
+only for new sessions and lists only known ciphers.
+</note>
+</tag-desc>
+
+<tag-name id="var_ssl_curves"><var>$ssl_curves</var></tag-name>
+<tag-desc>
+returns the list of curves supported by the client (1.11.7).
+Known curves are listed by names, unknown are shown in hexadecimal,
+for example:
+<example>
+0x001d:prime256v1:secp521r1:secp384r1
+</example>
+<note>
+The variable is supported only when using OpenSSL version 1.0.2 or higher.
+With older versions, the variable value will be an empty string.
+</note>
+<note>
+The variable is available only for new sessions.
+</note>
+</tag-desc>
+
 <tag-name id="var_ssl_protocol"><var>$ssl_protocol</var></tag-name>
 <tag-desc>
 returns the protocol of an established SSL connection;
--- a/xml/ru/docs/http/ngx_http_ssl_module.xml
+++ b/xml/ru/docs/http/ngx_http_ssl_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_ssl_module"
         link="/ru/docs/http/ngx_http_ssl_module.html"
         lang="ru"
-        rev="27">
+        rev="28">
 
 <section id="summary">
 
@@ -764,6 +764,22 @@ ssl_stapling_responder http://ocsp.examp
 возвращает строку используемых шифров для установленного SSL-соединения;
 </tag-desc>
 
+<tag-name id="var_ssl_ciphers"><var>$ssl_ciphers</var></tag-name>
+<tag-desc>
+возвращает список шифров, поддерживаемых клиентом (1.11.7).
+Известные шифры указаны по имени, неизвестные указаны в шестнадцатеричном виде,
+например:
+<example>
+AES128-SHA:AES256-SHA:0x00ff
+</example>
+<note>
+Переменная полностью поддерживается при использовании OpenSSL версии 1.0.2
+и выше.
+При использовании более старых версий переменная доступна
+только для новых сессий и может содержать только известные шифры.
+</note>
+</tag-desc>
+
 <tag-name id="var_ssl_client_cert"><var>$ssl_client_cert</var></tag-name>
 <tag-desc>
 возвращает клиентский сертификат
@@ -851,6 +867,23 @@ ssl_stapling_responder http://ocsp.examp
 </note>
 </tag-desc>
 
+<tag-name id="var_ssl_curves"><var>$ssl_curves</var></tag-name>
+<tag-desc>
+возвращает список кривых, поддерживаемых клиентом (1.11.7).
+Известные кривые указаны по имени, неизвестные указаны в шестнадцатеричном виде,
+например:
+<example>
+0x001d:prime256v1:secp521r1:secp384r1
+</example>
+<note>
+Переменная поддерживается при использовании OpenSSL версии 1.0.2 и выше.
+При использовании более старых версий значением переменной будет пустая строка.
+</note>
+<note>
+Переменная доступна только для новых сессий.
+</note>
+</tag-desc>
+
 <tag-name id="var_ssl_protocol"><var>$ssl_protocol</var></tag-name>
 <tag-desc>
 возвращает протокол установленного SSL-соединения;
--- a/xml/ru/docs/stream/ngx_stream_ssl_module.xml
+++ b/xml/ru/docs/stream/ngx_stream_ssl_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_stream_ssl_module"
         link="/ru/docs/stream/ngx_stream_ssl_module.html"
         lang="ru"
-        rev="11">
+        rev="12">
 
 <section id="summary">
 
@@ -433,6 +433,39 @@ openssl rand 48 > ticket.key
 возвращает строку используемых шифров для установленного SSL-соединения;
 </tag-desc>
 
+<tag-name id="var_ssl_ciphers"><var>$ssl_ciphers</var></tag-name>
+<tag-desc>
+возвращает список шифров, поддерживаемых клиентом (1.11.7).
+Известные шифры указаны по имени, неизвестные указаны в шестнадцатеричном виде,
+например:
+<example>
+AES128-SHA:AES256-SHA:0x00ff
+</example>
+<note>
+Переменная полностью поддерживается при использовании OpenSSL версии 1.0.2
+и выше.
+При использовании более старых версий переменная доступна
+только для новых сессий и может содержать только известные шифры.
+</note>
+</tag-desc>
+
+<tag-name id="var_ssl_curves"><var>$ssl_curves</var></tag-name>
+<tag-desc>
+возвращает список кривых, поддерживаемых клиентом (1.11.7).
+Известные кривые указаны по имени, неизвестные указаны в шестнадцатеричном виде,
+например:
+<example>
+0x001d:prime256v1:secp521r1:secp384r1
+</example>
+<note>
+Переменная поддерживается при использовании OpenSSL версии 1.0.2 и выше.
+При использовании более старых версий значением переменной будет пустая строка.
+</note>
+<note>
+Переменная доступна только для новых сессий.
+</note>
+</tag-desc>
+
 <tag-name id="var_ssl_protocol"><var>$ssl_protocol</var></tag-name>
 <tag-desc>
 возвращает протокол установленного SSL-соединения;