changeset 2807:4b73197f8ca9

Documented the $ssl_curve variable for http and stream.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 24 Nov 2021 20:28:57 +0000
parents 462ca0f20a3d
children 79ebb6a3812b
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, 64 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="55">
+        rev="56">
 
 <section id="summary">
 
@@ -1110,6 +1110,21 @@ did not contain the <value>reason</value
 </note>
 </tag-desc>
 
+<tag-name id="var_ssl_curve"><var>$ssl_curve</var></tag-name>
+<tag-desc>
+returns the negotiated curve used for
+SSL handshake key exchange process (1.21.5).
+Known curves are listed by names, unknown are shown in hexadecimal,
+for example:
+<example>
+prime256v1
+</example>
+<note>
+The variable is supported only when using OpenSSL version 3.0 or higher.
+With older versions, the variable value will be an empty string.
+</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).
--- 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="27">
+        rev="28">
 
 <section id="summary">
 
@@ -758,6 +758,21 @@ returns the result of client certificate
 and “<literal>NONE</literal>” if a certificate was not present;
 </tag-desc>
 
+<tag-name id="var_ssl_curve"><var>$ssl_curve</var></tag-name>
+<tag-desc>
+returns the negotiated curve used for
+SSL handshake key exchange process (1.21.5).
+Known curves are listed by names, unknown are shown in hexadecimal,
+for example:
+<example>
+prime256v1
+</example>
+<note>
+The variable is supported only when using OpenSSL version 3.0 or higher.
+With older versions, the variable value will be an empty string.
+</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).
--- 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="55">
+        rev="56">
 
 <section id="summary">
 
@@ -1117,6 +1117,21 @@ AES128-SHA:AES256-SHA:0x00ff
 </note>
 </tag-desc>
 
+<tag-name id="var_ssl_curve"><var>$ssl_curve</var></tag-name>
+<tag-desc>
+возвращает согласованную кривую, использованную для
+обмена ключами во время операции SSL handshake (1.21.5).
+Известные кривые указаны по имени, неизвестные указаны в шестнадцатеричном виде,
+например:
+<example>
+prime256v1
+</example>
+<note>
+Переменная поддерживается при использовании OpenSSL версии 3.0 и выше.
+При использовании более старых версий значением переменной будет пустая строка.
+</note>
+</tag-desc>
+
 <tag-name id="var_ssl_curves"><var>$ssl_curves</var></tag-name>
 <tag-desc>
 возвращает список кривых, поддерживаемых клиентом (1.11.7).
--- 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="27">
+        rev="28">
 
 <section id="summary">
 
@@ -763,6 +763,21 @@ AES128-SHA:AES256-SHA:0x00ff
 и, если сертификат не был предоставлен, “<literal>NONE</literal>”;
 </tag-desc>
 
+<tag-name id="var_ssl_curve"><var>$ssl_curve</var></tag-name>
+<tag-desc>
+возвращает согласованную кривую, использованную для
+обмена ключами во время операции SSL handshake (1.21.5).
+Известные кривые указаны по имени, неизвестные указаны в шестнадцатеричном виде,
+например:
+<example>
+prime256v1
+</example>
+<note>
+Переменная поддерживается при использовании OpenSSL версии 3.0 и выше.
+При использовании более старых версий значением переменной будет пустая строка.
+</note>
+</tag-desc>
+
 <tag-name id="var_ssl_curves"><var>$ssl_curves</var></tag-name>
 <tag-desc>
 возвращает список кривых, поддерживаемых клиентом (1.11.7).