diff options
author | tb <> | 2021-03-31 16:56:46 +0000 |
---|---|---|
committer | tb <> | 2021-03-31 16:56:46 +0000 |
commit | 9dc4e18bb8f3e7f98db4b8f92f512c88bf9b347c (patch) | |
tree | 8c97cafc2a8fefb83176c03c531744adf8bb24b6 | |
parent | fb0a1d3edd6908ac9563417b2b97ff6e4bda6c50 (diff) | |
download | openbsd-9dc4e18bb8f3e7f98db4b8f92f512c88bf9b347c.tar.gz openbsd-9dc4e18bb8f3e7f98db4b8f92f512c88bf9b347c.tar.bz2 openbsd-9dc4e18bb8f3e7f98db4b8f92f512c88bf9b347c.zip |
Document SSL_set_hostflags(3) and SSL_get0_peername(3)
ok bcook inoguchi jsing
-rw-r--r-- | src/lib/libssl/man/SSL_set1_host.3 | 22 |
1 files changed, 4 insertions, 18 deletions
diff --git a/src/lib/libssl/man/SSL_set1_host.3 b/src/lib/libssl/man/SSL_set1_host.3 index ba8b0564dd..2a3935c3f2 100644 --- a/src/lib/libssl/man/SSL_set1_host.3 +++ b/src/lib/libssl/man/SSL_set1_host.3 | |||
@@ -1,4 +1,4 @@ | |||
1 | .\" $OpenBSD: SSL_set1_host.3,v 1.3 2021/01/27 17:57:40 tb Exp $ | 1 | .\" $OpenBSD: SSL_set1_host.3,v 1.4 2021/03/31 16:56:46 tb Exp $ |
2 | .\" selective merge up to: OpenSSL 6328d367 Jul 4 21:58:30 2020 +0200 | 2 | .\" selective merge up to: OpenSSL 6328d367 Jul 4 21:58:30 2020 +0200 |
3 | .\" | 3 | .\" |
4 | .\" This file was written by Viktor Dukhovni <viktor@openssl.org> | 4 | .\" This file was written by Viktor Dukhovni <viktor@openssl.org> |
@@ -48,15 +48,13 @@ | |||
48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
50 | .\" | 50 | .\" |
51 | .Dd $Mdocdate: January 27 2021 $ | 51 | .Dd $Mdocdate: March 31 2021 $ |
52 | .Dt SSL_SET1_HOST 3 | 52 | .Dt SSL_SET1_HOST 3 |
53 | .Os | 53 | .Os |
54 | .Sh NAME | 54 | .Sh NAME |
55 | .Nm SSL_set1_host | 55 | .Nm SSL_set1_host , |
56 | .ig \" won't make Ox 6.8 but will appear in 6.9 | 56 | .Nm SSL_set_hostflags , |
57 | .Nm SSL_set_hostflags | ||
58 | .Nm SSL_get0_peername | 57 | .Nm SSL_get0_peername |
59 | .. | ||
60 | .Nd SSL server verification parameters | 58 | .Nd SSL server verification parameters |
61 | .Sh SYNOPSIS | 59 | .Sh SYNOPSIS |
62 | .In openssl/ssl.h | 60 | .In openssl/ssl.h |
@@ -65,7 +63,6 @@ | |||
65 | .Fa "SSL *ssl" | 63 | .Fa "SSL *ssl" |
66 | .Fa "const char *hostname" | 64 | .Fa "const char *hostname" |
67 | .Fc | 65 | .Fc |
68 | .ig | ||
69 | .Ft void | 66 | .Ft void |
70 | .Fo SSL_set_hostflags | 67 | .Fo SSL_set_hostflags |
71 | .Fa "SSL *ssl" | 68 | .Fa "SSL *ssl" |
@@ -75,7 +72,6 @@ | |||
75 | .Fo SSL_get0_peername | 72 | .Fo SSL_get0_peername |
76 | .Fa "SSL *ssl" | 73 | .Fa "SSL *ssl" |
77 | .Fc | 74 | .Fc |
78 | .. | ||
79 | .Sh DESCRIPTION | 75 | .Sh DESCRIPTION |
80 | .Fn SSL_set1_host | 76 | .Fn SSL_set1_host |
81 | configures a server hostname check in the | 77 | configures a server hostname check in the |
@@ -97,7 +93,6 @@ with | |||
97 | .Fa flags | 93 | .Fa flags |
98 | set to 0. | 94 | set to 0. |
99 | .Pp | 95 | .Pp |
100 | .ig | ||
101 | .Fn SSL_set_hostflags | 96 | .Fn SSL_set_hostflags |
102 | sets the flags that will be passed to | 97 | sets the flags that will be passed to |
103 | .Xr X509_check_host 3 | 98 | .Xr X509_check_host 3 |
@@ -124,14 +119,11 @@ object is cleared or freed, or if a renegotiation takes place. | |||
124 | Applications must not free the return value. | 119 | Applications must not free the return value. |
125 | .Pp | 120 | .Pp |
126 | SSL clients are advised to use these functions in preference to | 121 | SSL clients are advised to use these functions in preference to |
127 | .. | ||
128 | SSL clients are advised to use this function in preference to | ||
129 | explicitly calling | 122 | explicitly calling |
130 | .Xr X509_check_host 3 . | 123 | .Xr X509_check_host 3 . |
131 | .Sh RETURN VALUES | 124 | .Sh RETURN VALUES |
132 | .Fn SSL_set1_host | 125 | .Fn SSL_set1_host |
133 | returns 1 for success or 0 for failure. | 126 | returns 1 for success or 0 for failure. |
134 | .ig | ||
135 | .Pp | 127 | .Pp |
136 | .Fn SSL_get0_peername | 128 | .Fn SSL_get0_peername |
137 | returns the matched peername or | 129 | returns the matched peername or |
@@ -160,7 +152,6 @@ if (SSL_get_verify_result(ssl) == X509_V_OK) { | |||
160 | /* Name checks were in scope and matched the peername */ | 152 | /* Name checks were in scope and matched the peername */ |
161 | } | 153 | } |
162 | .Ed | 154 | .Ed |
163 | .. | ||
164 | .Sh SEE ALSO | 155 | .Sh SEE ALSO |
165 | .Xr ssl 3 , | 156 | .Xr ssl 3 , |
166 | .Xr SSL_CTX_set_verify 3 , | 157 | .Xr SSL_CTX_set_verify 3 , |
@@ -169,10 +160,6 @@ if (SSL_get_verify_result(ssl) == X509_V_OK) { | |||
169 | .Xr X509_check_host 3 , | 160 | .Xr X509_check_host 3 , |
170 | .Xr X509_VERIFY_PARAM_set1_host 3 | 161 | .Xr X509_VERIFY_PARAM_set1_host 3 |
171 | .Sh HISTORY | 162 | .Sh HISTORY |
172 | This function first appeared in OpenSSL 1.1.0 | ||
173 | and has been available since | ||
174 | .Ox 6.5 . | ||
175 | .ig | ||
176 | All three functions first appeared in OpenSSL 1.1.0. | 163 | All three functions first appeared in OpenSSL 1.1.0. |
177 | .Fn SSL_set1_host | 164 | .Fn SSL_set1_host |
178 | has been available since | 165 | has been available since |
@@ -183,4 +170,3 @@ and | |||
183 | .Fn SSL_get0_peername | 170 | .Fn SSL_get0_peername |
184 | since | 171 | since |
185 | .Ox 6.9 . | 172 | .Ox 6.9 . |
186 | .. | ||