changeset 2350:8e35f3af574b

Documented the "data:" syntax for ssl_certificate and key.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 26 Mar 2019 17:09:15 +0300
parents 0eabe2f4d365
children 3ef39edf4836
files xml/en/docs/http/ngx_http_ssl_module.xml xml/en/docs/mail/ngx_mail_ssl_module.xml xml/en/docs/stream/ngx_stream_ssl_module.xml xml/ru/docs/http/ngx_http_ssl_module.xml xml/ru/docs/mail/ngx_mail_ssl_module.xml xml/ru/docs/stream/ngx_stream_ssl_module.xml
diffstat 6 files changed, 133 insertions(+), 6 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="45">
+        rev="46">
 
 <section id="summary">
 
@@ -186,6 +186,17 @@ a certificate will be loaded for each SS
 and this may have a negative impact on performance.
 </para>
 
+<para id="ssl_certificate_data">
+The value
+<literal>data</literal>:<value>$variable</value>
+can be specified instead of the <value>file</value> (1.15.10),
+which loads a certificate from a variable
+without using intermediate files.
+Note that inappropriate use of this syntax may have its security implications,
+such as writing secret key data to
+<link doc="../ngx_core_module.xml" id="error_log">error log</link>.
+</para>
+
 <para>
 It should be kept in mind that due to the HTTPS protocol limitations
 for maximum interoperability virtual servers should listen on
@@ -215,6 +226,16 @@ which loads a secret key with a specifie
 from the OpenSSL engine <value>name</value>.
 </para>
 
+<para id="ssl_certificate_key_data">
+The value
+<literal>data</literal>:<value>$variable</value>
+can be specified instead of the <value>file</value> (1.15.10),
+which loads a secret key from a variable without using intermediate files.
+Note that inappropriate use of this syntax may have its security implications,
+such as writing secret key data to
+<link doc="../ngx_core_module.xml" id="error_log">error log</link>.
+</para>
+
 <para>
 Since version 1.15.9, variables can be used in the <value>file</value> name
 when using OpenSSL 1.0.2 or higher.
--- a/xml/en/docs/mail/ngx_mail_ssl_module.xml
+++ b/xml/en/docs/mail/ngx_mail_ssl_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_ssl_module"
         link="/en/docs/mail/ngx_mail_ssl_module.html"
         lang="en"
-        rev="19">
+        rev="20">
 
 <section id="summary">
 
@@ -141,6 +141,16 @@ With older versions, only one certificat
 </note>
 </para>
 
+<para id="ssl_certificate_data">
+The value
+<literal>data</literal>:<value>certificate</value>
+can be specified instead of the <value>file</value> (1.15.10),
+which loads a certificate without using intermediate files.
+Note that inappropriate use of this syntax may have its security implications,
+such as writing secret key data to
+<link doc="../ngx_core_module.xml" id="error_log">error log</link>.
+</para>
+
 </directive>
 
 
@@ -163,6 +173,16 @@ which loads a secret key with a specifie
 from the OpenSSL engine <value>name</value>.
 </para>
 
+<para id="ssl_certificate_key_data">
+The value
+<literal>data</literal>:<value>key</value>
+can be specified instead of the <value>file</value> (1.15.10),
+which loads a secret key without using intermediate files.
+Note that inappropriate use of this syntax may have its security implications,
+such as writing secret key data to
+<link doc="../ngx_core_module.xml" id="error_log">error log</link>.
+</para>
+
 </directive>
 
 
--- 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="20">
+        rev="21">
 
 <section id="summary">
 
@@ -130,6 +130,16 @@ a certificate will be loaded for each SS
 and this may have a negative impact on performance.
 </para>
 
+<para id="ssl_certificate_data">
+The value
+<literal>data</literal>:<value>$variable</value>
+can be specified instead of the <value>file</value> (1.15.10),
+which loads a certificate from a variable without using intermediate files.
+Note that inappropriate use of this syntax may have its security implications,
+such as writing secret key data to
+<link doc="../ngx_core_module.xml" id="error_log">error log</link>.
+</para>
+
 </directive>
 
 
@@ -152,6 +162,16 @@ which loads a secret key with a specifie
 from the OpenSSL engine <value>name</value>.
 </para>
 
+<para id="ssl_certificate_key_data">
+The value
+<literal>data</literal>:<value>$variable</value>
+can be specified instead of the <value>file</value> (1.15.10),
+which loads a secret key from a variable without using intermediate files.
+Note that inappropriate use of this syntax may have its security implications,
+such as writing secret key data to
+<link doc="../ngx_core_module.xml" id="error_log">error log</link>.
+</para>
+
 <para>
 Since version 1.15.9, variables can be used in the <value>file</value> name
 when using OpenSSL 1.0.2 or higher.
--- 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="45">
+        rev="46">
 
 <section id="summary">
 
@@ -188,6 +188,17 @@ ssl_certificate_key $ssl_server_name.key
 что может отрицательно влиять на производительность.
 </para>
 
+<para id="ssl_certificate_data">
+Вместо <value>файла</value> можно указать значение
+<literal>data</literal>:<value>$переменная</value> (1.15.10),
+при котором сертификат загружается из переменной
+без использования промежуточных файлов.
+При этом следует учитывать, что ненадлежащее использование
+подобного синтаксиса может быть небезопасно,
+например данные секретного ключа могут попасть в
+<link doc="../ngx_core_module.xml" id="error_log">лог ошибок</link>.
+</para>
+
 <para>
 Нужно иметь в виду, что из-за ограничения протокола HTTPS
 для максимальной совместимости виртуальные серверы должны слушать на
@@ -216,6 +227,17 @@ IP-адресах</link>.
 из OpenSSL engine с заданным <value>именем</value>.
 </para>
 
+<para id="ssl_certificate_key_data">
+Вместо <value>файла</value> можно указать значение
+<literal>data</literal>:<value>$переменная</value> (1.15.10),
+при котором секретный ключ загружается из переменной
+без использования промежуточных файлов.
+При этом следует учитывать, что ненадлежащее использование
+подобного синтаксиса может быть небезопасно,
+например данные секретного ключа могут попасть в
+<link doc="../ngx_core_module.xml" id="error_log">лог ошибок</link>.
+</para>
+
 <para>
 Начиная с версии 1.15.9 в имени файла можно использовать переменные
 при использовании OpenSSL 1.0.2 и выше.
--- a/xml/ru/docs/mail/ngx_mail_ssl_module.xml
+++ b/xml/ru/docs/mail/ngx_mail_ssl_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_ssl_module"
         link="/ru/docs/mail/ngx_mail_ssl_module.html"
         lang="ru"
-        rev="19">
+        rev="20">
 
 <section id="summary">
 
@@ -141,6 +141,17 @@ server {
 </note>
 </para>
 
+<para id="ssl_certificate_data">
+Вместо <value>файла</value> можно указать значение
+<literal>data</literal>:<value>сертификат</value> (1.15.10),
+при котором сертификат загружается
+без использования промежуточных файлов.
+При этом следует учитывать, что ненадлежащее использование
+подобного синтаксиса может быть небезопасно,
+например данные секретного ключа могут попасть в
+<link doc="../ngx_core_module.xml" id="error_log">лог ошибок</link>.
+</para>
+
 </directive>
 
 
@@ -162,6 +173,17 @@ server {
 из OpenSSL engine с заданным <value>именем</value>.
 </para>
 
+<para id="ssl_certificate_key_data">
+Вместо <value>файла</value> можно указать значение
+<literal>data</literal>:<value>ключ</value> (1.15.10),
+при котором секретный ключ загружается
+без использования промежуточных файлов.
+При этом следует учитывать, что ненадлежащее использование
+подобного синтаксиса может быть небезопасно,
+например данные секретного ключа могут попасть в
+<link doc="../ngx_core_module.xml" id="error_log">лог ошибок</link>.
+</para>
+
 </directive>
 
 
--- 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="20">
+        rev="21">
 
 <section id="summary">
 
@@ -130,6 +130,17 @@ ssl_certificate_key $ssl_server_name.key
 что может отрицательно влиять на производительность.
 </para>
 
+<para id="ssl_certificate_data">
+Вместо <value>файла</value> можно указать значение
+<literal>data</literal>:<value>$переменная</value> (1.15.10),
+при котором сертификат загружается из переменной
+без использования промежуточных файлов.
+При этом следует учитывать, что ненадлежащее использование
+подобного синтаксиса может быть небезопасно,
+например данные секретного ключа могут попасть в
+<link doc="../ngx_core_module.xml" id="error_log">лог ошибок</link>.
+</para>
+
 </directive>
 
 
@@ -151,6 +162,17 @@ ssl_certificate_key $ssl_server_name.key
 из OpenSSL engine с заданным <value>именем</value>.
 </para>
 
+<para id="ssl_certificate_key_data">
+Вместо <value>файла</value> можно указать значение
+<literal>data</literal>:<value>$переменная</value> (1.15.10),
+при котором секретный ключ загружается из переменной
+без использования промежуточных файлов.
+При этом следует учитывать, что ненадлежащее использование
+подобного синтаксиса может быть небезопасно,
+например данные секретного ключа могут попасть в
+<link doc="../ngx_core_module.xml" id="error_log">лог ошибок</link>.
+</para>
+
 <para>
 Начиная с версии 1.15.9 в имени файла можно использовать переменные
 при использовании OpenSSL 1.0.2 и выше.