summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/X509_STORE_CTX_set_flags.3
diff options
context:
space:
mode:
authorschwarze <>2021-07-22 17:11:14 +0000
committerschwarze <>2021-07-22 17:11:14 +0000
commit8a2b2d46e4614778f81e571b6d148f20ded9db18 (patch)
tree812181472a93383900f4fa0737302c70b0b7d58b /src/lib/libcrypto/man/X509_STORE_CTX_set_flags.3
parent88e7569f0df9996c3b42ffff7d73a3a9b210faf0 (diff)
downloadopenbsd-8a2b2d46e4614778f81e571b6d148f20ded9db18.tar.gz
openbsd-8a2b2d46e4614778f81e571b6d148f20ded9db18.tar.bz2
openbsd-8a2b2d46e4614778f81e571b6d148f20ded9db18.zip
Split the functions operating on the X509_VERIFY_PARAM object out
of X509_STORE_CTX_new(3) because i'm about to document five additional functions of this kind and the page X509_STORE_CTX_new(3) is growing unwieldy. No text change yet, except that i added an introductory sentence to the beginning of the DESCRIPTION of the new page.
Diffstat (limited to 'src/lib/libcrypto/man/X509_STORE_CTX_set_flags.3')
-rw-r--r--src/lib/libcrypto/man/X509_STORE_CTX_set_flags.3166
1 files changed, 166 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/X509_STORE_CTX_set_flags.3 b/src/lib/libcrypto/man/X509_STORE_CTX_set_flags.3
new file mode 100644
index 0000000000..f15ec5f16f
--- /dev/null
+++ b/src/lib/libcrypto/man/X509_STORE_CTX_set_flags.3
@@ -0,0 +1,166 @@
1.\" $OpenBSD: X509_STORE_CTX_set_flags.3,v 1.1 2021/07/22 17:11:14 schwarze Exp $
2.\" full merge up to: OpenSSL aae41f8c Jun 25 09:47:15 2015 +0100
3.\" selective merge up to: OpenSSL 24a535ea Sep 22 13:14:20 2020 +0100
4.\"
5.\" This file is a derived work.
6.\" The changes are covered by the following Copyright and license:
7.\"
8.\" Copyright (c) 2019 Claudio Jeker <claudio@openbsd.org>
9.\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org>
10.\"
11.\" Permission to use, copy, modify, and distribute this software for any
12.\" purpose with or without fee is hereby granted, provided that the above
13.\" copyright notice and this permission notice appear in all copies.
14.\"
15.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
16.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
17.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
18.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
19.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
20.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
21.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22.\"
23.\" The original file was written by Dr. Stephen Henson <steve@openssl.org>.
24.\" Copyright (c) 2009 The OpenSSL Project. All rights reserved.
25.\"
26.\" Redistribution and use in source and binary forms, with or without
27.\" modification, are permitted provided that the following conditions
28.\" are met:
29.\"
30.\" 1. Redistributions of source code must retain the above copyright
31.\" notice, this list of conditions and the following disclaimer.
32.\"
33.\" 2. Redistributions in binary form must reproduce the above copyright
34.\" notice, this list of conditions and the following disclaimer in
35.\" the documentation and/or other materials provided with the
36.\" distribution.
37.\"
38.\" 3. All advertising materials mentioning features or use of this
39.\" software must display the following acknowledgment:
40.\" "This product includes software developed by the OpenSSL Project
41.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
42.\"
43.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
44.\" endorse or promote products derived from this software without
45.\" prior written permission. For written permission, please contact
46.\" openssl-core@openssl.org.
47.\"
48.\" 5. Products derived from this software may not be called "OpenSSL"
49.\" nor may "OpenSSL" appear in their names without prior written
50.\" permission of the OpenSSL Project.
51.\"
52.\" 6. Redistributions of any form whatsoever must retain the following
53.\" acknowledgment:
54.\" "This product includes software developed by the OpenSSL Project
55.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
56.\"
57.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
58.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
59.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
60.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
61.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
62.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
63.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
64.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
65.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
66.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
67.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
68.\" OF THE POSSIBILITY OF SUCH DAMAGE.
69.\"
70.Dd $Mdocdate: July 22 2021 $
71.Dt X509_STORE_CTX_SET_FLAGS 3
72.Os
73.Sh NAME
74.Nm X509_STORE_CTX_set_flags ,
75.Nm X509_STORE_CTX_get0_param ,
76.Nm X509_STORE_CTX_set0_param ,
77.Nm X509_STORE_CTX_set_default
78.Nd X509_STORE_CTX parameter initialisation
79.Sh SYNOPSIS
80.In openssl/x509_vfy.h
81.Ft void
82.Fo X509_STORE_CTX_set_flags
83.Fa "X509_STORE_CTX *ctx"
84.Fa "unsigned long flags"
85.Fc
86.Ft X509_VERIFY_PARAM *
87.Fo X509_STORE_CTX_get0_param
88.Fa "X509_STORE_CTX *ctx"
89.Fc
90.Ft void
91.Fo X509_STORE_CTX_set0_param
92.Fa "X509_STORE_CTX *ctx"
93.Fa "X509_VERIFY_PARAM *param"
94.Fc
95.Ft int
96.Fo X509_STORE_CTX_set_default
97.Fa "X509_STORE_CTX *ctx"
98.Fa "const char *name"
99.Fc
100.Sh DESCRIPTION
101These functions operate on the
102.Vt X509_VERIFY_PARAM
103object used by
104.Fa ctx .
105Usually,
106.Xr X509_STORE_CTX_init 3
107is called on
108.Fa ctx
109before these functions, and
110.Xr X509_verify_cert 3
111afterwards.
112.Pp
113.Fn X509_STORE_CTX_set_flags
114sets the internal verification parameter flags to
115.Fa flags .
116See
117.Xr X509_VERIFY_PARAM_set_flags 3
118for a description of the verification flags.
119.Pp
120.Fn X509_STORE_CTX_get0_param
121retrieves an internal pointer to the verification parameters associated
122with
123.Fa ctx .
124.Pp
125.Fn X509_STORE_CTX_set0_param
126sets the internal verification parameter pointer to
127.Fa param .
128After this call
129.Fa param
130should not be used.
131.Pp
132.Fn X509_STORE_CTX_set_default
133looks up and sets the default verification method to
134.Fa name .
135This uses the function
136.Xr X509_VERIFY_PARAM_lookup 3
137to find an appropriate set of parameters from
138.Fa name .
139.Sh RETURN VALUES
140.Fn X509_STORE_CTX_get0_param
141returns a pointer to an
142.Vt X509_VERIFY_PARAM
143structure or
144.Dv NULL
145if an error occurred.
146.Pp
147.Fn X509_STORE_CTX_set_default
148returns 1 for success or 0 if an error occurred.
149.Sh SEE ALSO
150.Xr X509_STORE_CTX_get_error 3 ,
151.Xr X509_STORE_CTX_new 3 ,
152.Xr X509_STORE_new 3 ,
153.Xr X509_STORE_set1_param 3 ,
154.Xr X509_verify_cert 3 ,
155.Xr X509_VERIFY_PARAM_set_flags 3
156.Sh HISTORY
157.Fn X509_STORE_CTX_set_flags
158first appeared in OpenSSL 0.9.6 and has been available since
159.Ox 2.9 .
160.Pp
161.Fn X509_STORE_CTX_get0_param ,
162.Fn X509_STORE_CTX_set0_param ,
163and
164.Fn X509_STORE_CTX_set_default
165first appeared in OpenSSL 0.9.8 and have been available since
166.Ox 4.5 .