diff options
Diffstat (limited to 'src/lib/libssl/man/SSL_set1_param.3')
-rw-r--r-- | src/lib/libssl/man/SSL_set1_param.3 | 137 |
1 files changed, 0 insertions, 137 deletions
diff --git a/src/lib/libssl/man/SSL_set1_param.3 b/src/lib/libssl/man/SSL_set1_param.3 deleted file mode 100644 index cd8ad40ad0..0000000000 --- a/src/lib/libssl/man/SSL_set1_param.3 +++ /dev/null | |||
@@ -1,137 +0,0 @@ | |||
1 | .\" $OpenBSD: SSL_set1_param.3,v 1.6 2022/09/10 10:22:46 jsg Exp $ | ||
2 | .\" full merge up to: | ||
3 | .\" OpenSSL man3/SSL_CTX_get0_param 99d63d46 Oct 26 13:56:48 2016 -0400 | ||
4 | .\" | ||
5 | .\" This file was written by Dr. Stephen Henson <steve@openssl.org>. | ||
6 | .\" Copyright (c) 2015 The OpenSSL Project. All rights reserved. | ||
7 | .\" | ||
8 | .\" Redistribution and use in source and binary forms, with or without | ||
9 | .\" modification, are permitted provided that the following conditions | ||
10 | .\" are met: | ||
11 | .\" | ||
12 | .\" 1. Redistributions of source code must retain the above copyright | ||
13 | .\" notice, this list of conditions and the following disclaimer. | ||
14 | .\" | ||
15 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
16 | .\" notice, this list of conditions and the following disclaimer in | ||
17 | .\" the documentation and/or other materials provided with the | ||
18 | .\" distribution. | ||
19 | .\" | ||
20 | .\" 3. All advertising materials mentioning features or use of this | ||
21 | .\" software must display the following acknowledgment: | ||
22 | .\" "This product includes software developed by the OpenSSL Project | ||
23 | .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | ||
24 | .\" | ||
25 | .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to | ||
26 | .\" endorse or promote products derived from this software without | ||
27 | .\" prior written permission. For written permission, please contact | ||
28 | .\" openssl-core@openssl.org. | ||
29 | .\" | ||
30 | .\" 5. Products derived from this software may not be called "OpenSSL" | ||
31 | .\" nor may "OpenSSL" appear in their names without prior written | ||
32 | .\" permission of the OpenSSL Project. | ||
33 | .\" | ||
34 | .\" 6. Redistributions of any form whatsoever must retain the following | ||
35 | .\" acknowledgment: | ||
36 | .\" "This product includes software developed by the OpenSSL Project | ||
37 | .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" | ||
38 | .\" | ||
39 | .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY | ||
40 | .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
41 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
42 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR | ||
43 | .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
44 | .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | ||
45 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
46 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
47 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
48 | .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
49 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | ||
50 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | ||
51 | .\" | ||
52 | .Dd $Mdocdate: September 10 2022 $ | ||
53 | .Dt SSL_SET1_PARAM 3 | ||
54 | .Os | ||
55 | .Sh NAME | ||
56 | .Nm SSL_CTX_get0_param , | ||
57 | .Nm SSL_get0_param , | ||
58 | .Nm SSL_CTX_set1_param , | ||
59 | .Nm SSL_set1_param | ||
60 | .Nd get and set verification parameters | ||
61 | .Sh SYNOPSIS | ||
62 | .In openssl/ssl.h | ||
63 | .Ft X509_VERIFY_PARAM * | ||
64 | .Fo SSL_CTX_get0_param | ||
65 | .Fa "SSL_CTX *ctx" | ||
66 | .Fc | ||
67 | .Ft X509_VERIFY_PARAM * | ||
68 | .Fo SSL_get0_param | ||
69 | .Fa "SSL *ssl" | ||
70 | .Fc | ||
71 | .Ft int | ||
72 | .Fo SSL_CTX_set1_param | ||
73 | .Fa "SSL_CTX *ctx" | ||
74 | .Fa "X509_VERIFY_PARAM *vpm" | ||
75 | .Fc | ||
76 | .Ft int | ||
77 | .Fo SSL_set1_param | ||
78 | .Fa "SSL *ssl" | ||
79 | .Fa "X509_VERIFY_PARAM *vpm" | ||
80 | .Fc | ||
81 | .Sh DESCRIPTION | ||
82 | .Fn SSL_CTX_get0_param | ||
83 | and | ||
84 | .Fn SSL_get0_param | ||
85 | retrieve an internal pointer to the verification parameters for | ||
86 | .Fa ctx | ||
87 | or | ||
88 | .Fa ssl , | ||
89 | respectively. | ||
90 | The returned pointer must not be freed by the calling application, | ||
91 | but the application can modify the parameters pointed to, | ||
92 | to suit its needs: for example to add a hostname check. | ||
93 | .Pp | ||
94 | .Fn SSL_CTX_set1_param | ||
95 | and | ||
96 | .Fn SSL_set1_param | ||
97 | set the verification parameters to | ||
98 | .Fa vpm | ||
99 | for | ||
100 | .Fa ctx | ||
101 | or | ||
102 | .Fa ssl . | ||
103 | .Sh RETURN VALUES | ||
104 | .Fn SSL_CTX_get0_param | ||
105 | and | ||
106 | .Fn SSL_get0_param | ||
107 | return a pointer to an | ||
108 | .Vt X509_VERIFY_PARAM | ||
109 | structure. | ||
110 | .Pp | ||
111 | .Fn SSL_CTX_set1_param | ||
112 | and | ||
113 | .Fn SSL_set1_param | ||
114 | return 1 for success or 0 for failure. | ||
115 | .Sh EXAMPLES | ||
116 | Check that the hostname matches | ||
117 | .Pa www.foo.com | ||
118 | in the peer certificate: | ||
119 | .Bd -literal -offset indent | ||
120 | X509_VERIFY_PARAM *vpm = SSL_get0_param(ssl); | ||
121 | X509_VERIFY_PARAM_set1_host(vpm, "www.foo.com", 0); | ||
122 | .Ed | ||
123 | .Sh SEE ALSO | ||
124 | .Xr ssl 3 , | ||
125 | .Xr X509_VERIFY_PARAM_set_flags 3 | ||
126 | .Sh HISTORY | ||
127 | .Fn SSL_CTX_set1_param | ||
128 | and | ||
129 | .Fn SSL_set1_param | ||
130 | first appeared in OpenSSL 1.0.0 and have been available since | ||
131 | .Ox 4.9 . | ||
132 | .Pp | ||
133 | .Fn SSL_CTX_get0_param | ||
134 | and | ||
135 | .Fn SSL_get0_param | ||
136 | first appeared in OpenSSL 1.0.2 and have been available since | ||
137 | .Ox 6.3 . | ||