changeset 2617:6684517c9d19

Documented the proxy_ssl_conf_command directive and friends.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 27 Oct 2020 22:03:37 +0000
parents d8bf37d20449
children 0b98a81f196b
files xml/en/docs/http/ngx_http_grpc_module.xml xml/en/docs/http/ngx_http_proxy_module.xml xml/en/docs/http/ngx_http_uwsgi_module.xml xml/en/docs/stream/ngx_stream_proxy_module.xml xml/ru/docs/http/ngx_http_grpc_module.xml xml/ru/docs/http/ngx_http_proxy_module.xml xml/ru/docs/http/ngx_http_uwsgi_module.xml xml/ru/docs/stream/ngx_stream_proxy_module.xml
diffstat 8 files changed, 294 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_grpc_module.xml
+++ b/xml/en/docs/http/ngx_http_grpc_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_grpc_module"
         link="/en/docs/http/ngx_http_grpc_module.html"
         lang="en"
-        rev="4">
+        rev="5">
 
 <section id="summary">
 
@@ -526,6 +526,42 @@ The full list can be viewed using the
 </directive>
 
 
+<directive name="grpc_ssl_conf_command">
+<syntax><value>command</value></syntax>
+<default/>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.19.4</appeared-in>
+
+<para>
+Sets arbitrary OpenSSL configuration
+<link url="https://www.openssl.org/docs/man1.1.1/man3/SSL_CONF_cmd.html">commands</link>
+when establishing a connection with the gRPC SSL server.
+<note>
+The directive is supported when using OpenSSL 1.0.2 or higher.
+</note>
+</para>
+
+<para>
+Several <literal>grpc_ssl_conf_command</literal> directives
+can be specified on the same level.
+These directives are inherited from the previous configuration level
+if and only if there are
+no <literal>grpc_ssl_conf_command</literal> directives
+defined on the current level.
+</para>
+
+<para>
+<note>
+Note that configuring OpenSSL directly
+might result in unexpected behavior.
+</note>
+</para>
+
+</directive>
+
+
 <directive name="grpc_ssl_crl">
 <syntax><value>file</value></syntax>
 <default/>
--- a/xml/en/docs/http/ngx_http_proxy_module.xml
+++ b/xml/en/docs/http/ngx_http_proxy_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_proxy_module"
         link="/en/docs/http/ngx_http_proxy_module.html"
         lang="en"
-        rev="69">
+        rev="70">
 
 <section id="summary">
 
@@ -1966,6 +1966,42 @@ The full list can be viewed using the
 </directive>
 
 
+<directive name="proxy_ssl_conf_command">
+<syntax><value>command</value></syntax>
+<default/>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.19.4</appeared-in>
+
+<para>
+Sets arbitrary OpenSSL configuration
+<link url="https://www.openssl.org/docs/man1.1.1/man3/SSL_CONF_cmd.html">commands</link>
+when establishing a connection with the proxied HTTPS server.
+<note>
+The directive is supported when using OpenSSL 1.0.2 or higher.
+</note>
+</para>
+
+<para>
+Several <literal>proxy_ssl_conf_command</literal> directives
+can be specified on the same level.
+These directives are inherited from the previous configuration level
+if and only if there are
+no <literal>proxy_ssl_conf_command</literal> directives
+defined on the current level.
+</para>
+
+<para>
+<note>
+Note that configuring OpenSSL directly
+might result in unexpected behavior.
+</note>
+</para>
+
+</directive>
+
+
 <directive name="proxy_ssl_crl">
 <syntax><value>file</value></syntax>
 <default/>
--- a/xml/en/docs/http/ngx_http_uwsgi_module.xml
+++ b/xml/en/docs/http/ngx_http_uwsgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_uwsgi_module"
         link="/en/docs/http/ngx_http_uwsgi_module.html"
         lang="en"
-        rev="45">
+        rev="46">
 
 <section id="summary">
 
@@ -1436,6 +1436,42 @@ The full list can be viewed using the
 </directive>
 
 
+<directive name="uwsgi_ssl_conf_command">
+<syntax><value>command</value></syntax>
+<default/>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.19.4</appeared-in>
+
+<para>
+Sets arbitrary OpenSSL configuration
+<link url="https://www.openssl.org/docs/man1.1.1/man3/SSL_CONF_cmd.html">commands</link>
+when establishing a connection with the secured uwsgi server.
+<note>
+The directive is supported when using OpenSSL 1.0.2 or higher.
+</note>
+</para>
+
+<para>
+Several <literal>uwsgi_ssl_conf_command</literal> directives
+can be specified on the same level.
+These directives are inherited from the previous configuration level
+if and only if there are
+no <literal>uwsgi_ssl_conf_command</literal> directives
+defined on the current level.
+</para>
+
+<para>
+<note>
+Note that configuring OpenSSL directly
+might result in unexpected behavior.
+</note>
+</para>
+
+</directive>
+
+
 <directive name="uwsgi_ssl_crl">
 <syntax><value>file</value></syntax>
 <default/>
--- a/xml/en/docs/stream/ngx_stream_proxy_module.xml
+++ b/xml/en/docs/stream/ngx_stream_proxy_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_proxy_module"
         link="/en/docs/stream/ngx_stream_proxy_module.html"
         lang="en"
-        rev="25">
+        rev="26">
 
 <section id="summary">
 
@@ -422,6 +422,41 @@ The full list can be viewed using the
 </directive>
 
 
+<directive name="proxy_ssl_conf_command">
+<syntax><value>command</value></syntax>
+<default/>
+<context>stream</context>
+<context>server</context>
+<appeared-in>1.19.4</appeared-in>
+
+<para>
+Sets arbitrary OpenSSL configuration
+<link url="https://www.openssl.org/docs/man1.1.1/man3/SSL_CONF_cmd.html">commands</link>
+when establishing a connection with the proxied server.
+<note>
+The directive is supported when using OpenSSL 1.0.2 or higher.
+</note>
+</para>
+
+<para>
+Several <literal>proxy_ssl_conf_command</literal> directives
+can be specified on the same level.
+These directives are inherited from the previous configuration level
+if and only if there are
+no <literal>proxy_ssl_conf_command</literal> directives
+defined on the current level.
+</para>
+
+<para>
+<note>
+Note that configuring OpenSSL directly
+might result in unexpected behavior.
+</note>
+</para>
+
+</directive>
+
+
 <directive name="proxy_ssl_crl">
 <syntax><value>file</value></syntax>
 <default/>
--- a/xml/ru/docs/http/ngx_http_grpc_module.xml
+++ b/xml/ru/docs/http/ngx_http_grpc_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_grpc_module"
         link="/ru/docs/http/ngx_http_grpc_module.html"
         lang="ru"
-        rev="4">
+        rev="5">
 
 <section id="summary">
 
@@ -525,6 +525,42 @@ grpc_set_header Accept-Encoding "";
 </directive>
 
 
+<directive name="grpc_ssl_conf_command">
+<syntax><value>command</value></syntax>
+<default/>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.19.4</appeared-in>
+
+<para>
+Задаёт произвольные конфигурационные
+<link url="https://www.openssl.org/docs/man1.1.1/man3/SSL_CONF_cmd.html">команды</link>
+OpenSSL
+при установлении соединения с gRPC SSL-сервером.
+<note>
+Директива поддерживается при использовании OpenSSL 1.0.2 и выше.
+</note>
+</para>
+
+<para>
+На одном уровне может быть указано
+несколько директив <literal>grpc_ssl_conf_command</literal>.
+Директивы наследуются с предыдущего уровня конфигурации при условии, что
+на данном уровне не описаны
+свои директивы <literal>grpc_ssl_conf_command</literal>.
+</para>
+
+<para>
+<note>
+Следует учитывать, что изменение настроек OpenSSL напрямую
+может привести к неожиданному поведению.
+</note>
+</para>
+
+</directive>
+
+
 <directive name="grpc_ssl_crl">
 <syntax><value>файл</value></syntax>
 <default/>
--- a/xml/ru/docs/http/ngx_http_proxy_module.xml
+++ b/xml/ru/docs/http/ngx_http_proxy_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_proxy_module"
         link="/ru/docs/http/ngx_http_proxy_module.html"
         lang="ru"
-        rev="69">
+        rev="70">
 
 <section id="summary">
 
@@ -1967,6 +1967,42 @@ proxy_set_header Accept-Encoding "";
 </directive>
 
 
+<directive name="proxy_ssl_conf_command">
+<syntax><value>command</value></syntax>
+<default/>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.19.4</appeared-in>
+
+<para>
+Задаёт произвольные конфигурационные
+<link url="https://www.openssl.org/docs/man1.1.1/man3/SSL_CONF_cmd.html">команды</link>
+OpenSSL
+при установлении соединения с проксируемым HTTPS-сервером.
+<note>
+Директива поддерживается при использовании OpenSSL 1.0.2 и выше.
+</note>
+</para>
+
+<para>
+На одном уровне может быть указано
+несколько директив <literal>proxy_ssl_conf_command</literal>.
+Директивы наследуются с предыдущего уровня конфигурации при условии, что
+на данном уровне не описаны
+свои директивы <literal>proxy_ssl_conf_command</literal>.
+</para>
+
+<para>
+<note>
+Следует учитывать, что изменение настроек OpenSSL напрямую
+может привести к неожиданному поведению.
+</note>
+</para>
+
+</directive>
+
+
 <directive name="proxy_ssl_crl">
 <syntax><value>файл</value></syntax>
 <default/>
--- a/xml/ru/docs/http/ngx_http_uwsgi_module.xml
+++ b/xml/ru/docs/http/ngx_http_uwsgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_uwsgi_module"
         link="/ru/docs/http/ngx_http_uwsgi_module.html"
         lang="ru"
-        rev="45">
+        rev="46">
 
 <section id="summary">
 
@@ -1432,6 +1432,42 @@ uwsgi-сервер.
 </directive>
 
 
+<directive name="uwsgi_ssl_conf_command">
+<syntax><value>command</value></syntax>
+<default/>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.19.4</appeared-in>
+
+<para>
+Задаёт произвольные конфигурационные
+<link url="https://www.openssl.org/docs/man1.1.1/man3/SSL_CONF_cmd.html">команды</link>
+OpenSSL
+при установлении соединения с suwsgi-сервером.
+<note>
+Директива поддерживается при использовании OpenSSL 1.0.2 и выше.
+</note>
+</para>
+
+<para>
+На одном уровне может быть указано
+несколько директив <literal>uwsgi_ssl_conf_command</literal>.
+Директивы наследуются с предыдущего уровня конфигурации при условии, что
+на данном уровне не описаны
+свои директивы <literal>uwsgi_ssl_conf_command</literal>.
+</para>
+
+<para>
+<note>
+Следует учитывать, что изменение настроек OpenSSL напрямую
+может привести к неожиданному поведению.
+</note>
+</para>
+
+</directive>
+
+
 <directive name="uwsgi_ssl_crl">
 <syntax><value>файл</value></syntax>
 <default/>
--- a/xml/ru/docs/stream/ngx_stream_proxy_module.xml
+++ b/xml/ru/docs/stream/ngx_stream_proxy_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_stream_proxy_module"
         link="/ru/docs/stream/ngx_stream_proxy_module.html"
         lang="ru"
-        rev="25">
+        rev="26">
 
 <section id="summary">
 
@@ -421,6 +421,41 @@ Cессия завершится после отправки всех принятых датаграмм
 </directive>
 
 
+<directive name="proxy_ssl_conf_command">
+<syntax><value>command</value></syntax>
+<default/>
+<context>stream</context>
+<context>server</context>
+<appeared-in>1.19.4</appeared-in>
+
+<para>
+Задаёт произвольные конфигурационные
+<link url="https://www.openssl.org/docs/man1.1.1/man3/SSL_CONF_cmd.html">команды</link>
+OpenSSL
+при установлении соединения с проксируемым сервером.
+<note>
+Директива поддерживается при использовании OpenSSL 1.0.2 и выше.
+</note>
+</para>
+
+<para>
+На одном уровне может быть указано
+несколько директив <literal>proxy_ssl_conf_command</literal>.
+Директивы наследуются с предыдущего уровня конфигурации при условии, что
+на данном уровне не описаны
+свои директивы <literal>proxy_ssl_conf_command</literal>.
+</para>
+
+<para>
+<note>
+Следует учитывать, что изменение настроек OpenSSL напрямую
+может привести к неожиданному поведению.
+</note>
+</para>
+
+</directive>
+
+
 <directive name="proxy_ssl_crl">
 <syntax><value>файл</value></syntax>
 <default/>