Mercurial > hg > nginx-site
comparison xml/en/docs/http/ngx_http_ssl_module.xml @ 1155:07402a11fd8d
Assigned IDs to tags describing variables.
author | Vladimir Homutov <vl@nginx.com> |
---|---|
date | Wed, 16 Apr 2014 13:55:53 +0400 |
parents | ac131944d349 |
children | cac06b81957c |
comparison
equal
deleted
inserted
replaced
1154:b0e56cc57867 | 1155:07402a11fd8d |
---|---|
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> | 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
9 | 9 |
10 <module name="Module ngx_http_ssl_module" | 10 <module name="Module ngx_http_ssl_module" |
11 link="/en/docs/http/ngx_http_ssl_module.html" | 11 link="/en/docs/http/ngx_http_ssl_module.html" |
12 lang="en" | 12 lang="en" |
13 rev="12"> | 13 rev="13"> |
14 | 14 |
15 <section id="summary"> | 15 <section id="summary"> |
16 | 16 |
17 <para> | 17 <para> |
18 The <literal>ngx_http_ssl_module</literal> module provides the | 18 The <literal>ngx_http_ssl_module</literal> module provides the |
659 <para> | 659 <para> |
660 The <literal>ngx_http_ssl_module</literal> module supports | 660 The <literal>ngx_http_ssl_module</literal> module supports |
661 several embedded variables: | 661 several embedded variables: |
662 <list type="tag"> | 662 <list type="tag"> |
663 | 663 |
664 <tag-name><var>$ssl_cipher</var></tag-name> | 664 <tag-name id="var_ssl_cipher"><var>$ssl_cipher</var></tag-name> |
665 <tag-desc> | 665 <tag-desc> |
666 returns the string of ciphers used | 666 returns the string of ciphers used |
667 for an established SSL connection; | 667 for an established SSL connection; |
668 </tag-desc> | 668 </tag-desc> |
669 | 669 |
670 <tag-name><var>$ssl_client_cert</var></tag-name> | 670 <tag-name id="var_ssl_client_cert"><var>$ssl_client_cert</var></tag-name> |
671 <tag-desc> | 671 <tag-desc> |
672 returns the client certificate in the PEM format | 672 returns the client certificate in the PEM format |
673 for an established SSL connection, with each line except the first | 673 for an established SSL connection, with each line except the first |
674 prepended with the tab character; | 674 prepended with the tab character; |
675 this is intended for the use in the | 675 this is intended for the use in the |
676 <link doc="ngx_http_proxy_module.xml" id="proxy_set_header"/> directive; | 676 <link doc="ngx_http_proxy_module.xml" id="proxy_set_header"/> directive; |
677 </tag-desc> | 677 </tag-desc> |
678 | 678 |
679 <tag-name><var>$ssl_client_raw_cert</var></tag-name> | 679 <tag-name id="var_ssl_client_raw_cert"><var>$ssl_client_raw_cert</var> |
680 </tag-name> | |
680 <tag-desc> | 681 <tag-desc> |
681 returns the client certificate in the PEM format | 682 returns the client certificate in the PEM format |
682 for an established SSL connection; | 683 for an established SSL connection; |
683 </tag-desc> | 684 </tag-desc> |
684 | 685 |
685 <tag-name><var>$ssl_client_serial</var></tag-name> | 686 <tag-name id="var_ssl_client_serial"><var>$ssl_client_serial</var></tag-name> |
686 <tag-desc> | 687 <tag-desc> |
687 returns the serial number of the client certificate | 688 returns the serial number of the client certificate |
688 for an established SSL connection; | 689 for an established SSL connection; |
689 </tag-desc> | 690 </tag-desc> |
690 | 691 |
691 <tag-name><var>$ssl_client_s_dn</var></tag-name> | 692 <tag-name id="var_ssl_client_s_dn"><var>$ssl_client_s_dn</var></tag-name> |
692 <tag-desc> | 693 <tag-desc> |
693 returns the “subject DN” string of the client certificate | 694 returns the “subject DN” string of the client certificate |
694 for an established SSL connection; | 695 for an established SSL connection; |
695 </tag-desc> | 696 </tag-desc> |
696 | 697 |
697 <tag-name><var>$ssl_client_i_dn</var></tag-name> | 698 <tag-name id="var_ssl_client_i_dn"><var>$ssl_client_i_dn</var></tag-name> |
698 <tag-desc> | 699 <tag-desc> |
699 returns the “issuer DN” string of the client certificate | 700 returns the “issuer DN” string of the client certificate |
700 for an established SSL connection; | 701 for an established SSL connection; |
701 </tag-desc> | 702 </tag-desc> |
702 | 703 |
703 <tag-name><var>$ssl_client_verify</var></tag-name> | 704 <tag-name id="var_ssl_client_verify"><var>$ssl_client_verify</var></tag-name> |
704 <tag-desc> | 705 <tag-desc> |
705 returns the result of client certificate verification: | 706 returns the result of client certificate verification: |
706 “<literal>SUCCESS</literal>”, “<literal>FAILED</literal>”, and | 707 “<literal>SUCCESS</literal>”, “<literal>FAILED</literal>”, and |
707 “<literal>NONE</literal>” if a certificate was not present; | 708 “<literal>NONE</literal>” if a certificate was not present; |
708 </tag-desc> | 709 </tag-desc> |
709 | 710 |
710 <tag-name><var>$ssl_protocol</var></tag-name> | 711 <tag-name id="var_ssl_protocol"><var>$ssl_protocol</var></tag-name> |
711 <tag-desc> | 712 <tag-desc> |
712 returns the protocol of an established SSL connection; | 713 returns the protocol of an established SSL connection; |
713 </tag-desc> | 714 </tag-desc> |
714 | 715 |
715 <tag-name><var>$ssl_session_id</var></tag-name> | 716 <tag-name id="var_ssl_session_id"><var>$ssl_session_id</var></tag-name> |
716 <tag-desc> | 717 <tag-desc> |
717 returns the session identifier of an established SSL connection; | 718 returns the session identifier of an established SSL connection; |
718 </tag-desc> | 719 </tag-desc> |
719 | 720 |
720 <tag-name><var>$ssl_session_reused</var></tag-name> | 721 <tag-name id="var_ssl_session_reused"><var>$ssl_session_reused</var></tag-name> |
721 <tag-desc> | 722 <tag-desc> |
722 returns “<literal>r</literal>” if an SSL session was reused, | 723 returns “<literal>r</literal>” if an SSL session was reused, |
723 or “<literal>.</literal>” otherwise (1.5.11). | 724 or “<literal>.</literal>” otherwise (1.5.11). |
724 </tag-desc> | 725 </tag-desc> |
725 | 726 |