changeset 2027:dabca59da4ce

Documented the $ssl_client_escaped_cert variable.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 23 Aug 2017 21:49:06 +0300
parents af51ec6b5489
children 5c55b7054b58
files xml/en/docs/http/ngx_http_ssl_module.xml xml/ru/docs/http/ngx_http_ssl_module.xml
diffstat 2 files changed, 22 insertions(+), 2 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="34">
+        rev="35">
 
 <section id="summary">
 
@@ -779,6 +779,12 @@ only for new sessions and lists only kno
 </note>
 </tag-desc>
 
+<tag-name id="var_ssl_client_escaped_cert"><var>$ssl_client_escaped_cert</var></tag-name>
+<tag-desc>
+returns the client certificate in the PEM format (urlencoded)
+for an established SSL connection (1.13.5);
+</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
@@ -786,6 +792,10 @@ for an established SSL connection, with 
 prepended with the tab character;
 this is intended for the use in the
 <link doc="ngx_http_proxy_module.xml" id="proxy_set_header"/> directive;
+<note>
+The variable is deprecated,
+the <var>$ssl_client_escaped_cert</var> variable should be used instead.
+</note>
 </tag-desc>
 
 <tag-name id="var_ssl_client_fingerprint"><var>$ssl_client_fingerprint</var></tag-name>
--- 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="34">
+        rev="35">
 
 <section id="summary">
 
@@ -782,6 +782,12 @@ AES128-SHA:AES256-SHA:0x00ff
 </note>
 </tag-desc>
 
+<tag-name id="var_ssl_client_escaped_cert"><var>$ssl_client_escaped_cert</var></tag-name>
+<tag-desc>
+возвращает клиентский сертификат в формате PEM
+(закодирован в формате urlencode) для установленного SSL-соединения (1.13.5);
+</tag-desc>
+
 <tag-name id="var_ssl_client_cert"><var>$ssl_client_cert</var></tag-name>
 <tag-desc>
 возвращает клиентский сертификат
@@ -789,6 +795,10 @@ AES128-SHA:AES256-SHA:0x00ff
 перед каждой строкой которого, кроме первой, вставляется символ табуляции;
 предназначена для использования в директиве
 <link doc="ngx_http_proxy_module.xml" id="proxy_set_header"/>;
+<note>
+Переменная устарела, вместо неё следует использовать
+переменную <var>$ssl_client_escaped_cert</var>.
+</note>
 </tag-desc>
 
 <tag-name id="var_ssl_client_fingerprint"><var>$ssl_client_fingerprint</var></tag-name>