changeset 1745:0dfb7628bfee

Documented variables in ngx_stream_ssl_module.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 05 Jul 2016 17:58:34 +0300
parents ab56dcd73af2
children 4d6ea4d94e20
files xml/en/docs/stream/ngx_stream_ssl_module.xml xml/ru/docs/stream/ngx_stream_ssl_module.xml
diffstat 2 files changed, 83 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_ssl_module.xml	Tue Jul 05 17:58:34 2016 +0300
+++ b/xml/en/docs/stream/ngx_stream_ssl_module.xml	Tue Jul 05 17:58:34 2016 +0300
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_ssl_module"
         link="/en/docs/stream/ngx_stream_ssl_module.html"
         lang="en"
-        rev="8">
+        rev="9">
 
 <section id="summary">
 
@@ -421,4 +421,45 @@
 
 </section>
 
+
+<section id="variables" name="Embedded Variables">
+
+<para>
+The <literal>ngx_http_ssl_module</literal> module supports variables
+since 1.11.2.
+<list type="tag">
+
+<tag-name id="var_ssl_cipher"><var>$ssl_cipher</var></tag-name>
+<tag-desc>
+returns the string of ciphers used
+for an established SSL connection;
+</tag-desc>
+
+<tag-name id="var_ssl_protocol"><var>$ssl_protocol</var></tag-name>
+<tag-desc>
+returns the protocol of an established SSL connection;
+</tag-desc>
+
+<tag-name id="var_ssl_server_name"><var>$ssl_server_name</var></tag-name>
+<tag-desc>
+returns the server name requested through
+<link url="http://en.wikipedia.org/wiki/Server_Name_Indication">SNI</link>;
+</tag-desc>
+
+<tag-name id="var_ssl_session_id"><var>$ssl_session_id</var></tag-name>
+<tag-desc>
+returns the session identifier of an established SSL connection;
+</tag-desc>
+
+<tag-name id="var_ssl_session_reused"><var>$ssl_session_reused</var></tag-name>
+<tag-desc>
+returns “<literal>r</literal>” if an SSL session was reused,
+or “<literal>.</literal>” otherwise.
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
 </module>
--- a/xml/ru/docs/stream/ngx_stream_ssl_module.xml	Tue Jul 05 17:58:34 2016 +0300
+++ b/xml/ru/docs/stream/ngx_stream_ssl_module.xml	Tue Jul 05 17:58:34 2016 +0300
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_stream_ssl_module"
         link="/ru/docs/stream/ngx_stream_ssl_module.html"
         lang="ru"
-        rev="8">
+        rev="9">
 
 <section id="summary">
 
@@ -420,4 +420,44 @@
 
 </section>
 
+
+<section id="variables" name="Встроенные переменные">
+
+<para>
+Модуль <literal>ngx_http_ssl_module</literal> поддерживает переменные
+начиная с версии 1.11.2.
+<list type="tag">
+
+<tag-name id="var_ssl_cipher"><var>$ssl_cipher</var></tag-name>
+<tag-desc>
+возвращает строку используемых шифров для установленного SSL-соединения;
+</tag-desc>
+
+<tag-name id="var_ssl_protocol"><var>$ssl_protocol</var></tag-name>
+<tag-desc>
+возвращает протокол установленного SSL-соединения;
+</tag-desc>
+
+<tag-name id="var_ssl_server_name"><var>$ssl_server_name</var></tag-name>
+<tag-desc>
+возвращает имя сервера, запрошенное через
+<link url="http://en.wikipedia.org/wiki/Server_Name_Indication">SNI</link>;
+</tag-desc>
+
+<tag-name id="var_ssl_session_id"><var>$ssl_session_id</var></tag-name>
+<tag-desc>
+возвращает идентификатор сессии установленного SSL-соединения;
+</tag-desc>
+
+<tag-name id="var_ssl_session_reused"><var>$ssl_session_reused</var></tag-name>
+<tag-desc>
+возвращает “<literal>r</literal>”, если сессия была использована повторно,
+иначе “<literal>.</literal>”.
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
 </module>