1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
62 . tm Index:\\$1\t\\n%\t"\\$2"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
133 .\" ========================================================================
135 .IX Title "X509_STORE_CTX_NEW 3"
136 .TH X509_STORE_CTX_NEW 3 "2021-03-25" "1.1.1k" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 X509_STORE_CTX_new, X509_STORE_CTX_cleanup, X509_STORE_CTX_free, X509_STORE_CTX_init, X509_STORE_CTX_set0_trusted_stack, X509_STORE_CTX_set_cert, X509_STORE_CTX_set0_crls, X509_STORE_CTX_get0_chain, X509_STORE_CTX_set0_verified_chain, X509_STORE_CTX_get0_param, X509_STORE_CTX_set0_param, X509_STORE_CTX_get0_untrusted, X509_STORE_CTX_set0_untrusted, X509_STORE_CTX_get_num_untrusted, X509_STORE_CTX_set_default, X509_STORE_CTX_set_verify, X509_STORE_CTX_verify_fn \&\- X509_STORE_CTX initialisation
144 .IX Header "SYNOPSIS"
146 \& #include <openssl/x509_vfy.h>
148 \& X509_STORE_CTX *X509_STORE_CTX_new(void);
149 \& void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
150 \& void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
152 \& int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
153 \& X509 *x509, STACK_OF(X509) *chain);
155 \& void X509_STORE_CTX_set0_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
157 \& void X509_STORE_CTX_set_cert(X509_STORE_CTX *ctx, X509 *x);
158 \& STACK_OF(X509) *X509_STORE_CTX_get0_chain(X509_STORE_CTX *ctx);
159 \& void X509_STORE_CTX_set0_verified_chain(X509_STORE_CTX *ctx, STACK_OF(X509) *chain);
160 \& void X509_STORE_CTX_set0_crls(X509_STORE_CTX *ctx, STACK_OF(X509_CRL) *sk);
162 \& X509_VERIFY_PARAM *X509_STORE_CTX_get0_param(X509_STORE_CTX *ctx);
163 \& void X509_STORE_CTX_set0_param(X509_STORE_CTX *ctx, X509_VERIFY_PARAM *param);
164 \& int X509_STORE_CTX_set_default(X509_STORE_CTX *ctx, const char *name);
166 \& STACK_OF(X509)* X509_STORE_CTX_get0_untrusted(X509_STORE_CTX *ctx);
167 \& void X509_STORE_CTX_set0_untrusted(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
169 \& int X509_STORE_CTX_get_num_untrusted(X509_STORE_CTX *ctx);
171 \& typedef int (*X509_STORE_CTX_verify_fn)(X509_STORE_CTX *);
172 \& void X509_STORE_CTX_set_verify(X509_STORE_CTX *ctx, X509_STORE_CTX_verify_fn verify);
175 .IX Header "DESCRIPTION"
176 These functions initialise an \fBX509_STORE_CTX\fR structure for subsequent use
177 by \fBX509_verify_cert()\fR.
179 \&\fBX509_STORE_CTX_new()\fR returns a newly initialised \fBX509_STORE_CTX\fR structure.
181 \&\fBX509_STORE_CTX_cleanup()\fR internally cleans up an \fBX509_STORE_CTX\fR structure.
182 The context can then be reused with a new call to \fBX509_STORE_CTX_init()\fR.
184 \&\fBX509_STORE_CTX_free()\fR completely frees up \fBctx\fR. After this call \fBctx\fR
186 If \fBctx\fR is \s-1NULL\s0 nothing is done.
188 \&\fBX509_STORE_CTX_init()\fR sets up \fBctx\fR for a subsequent verification operation.
189 It must be called before each call to \fBX509_verify_cert()\fR, i.e. a \fBctx\fR is only
190 good for one call to \fBX509_verify_cert()\fR; if you want to verify a second
191 certificate with the same \fBctx\fR then you must call \fBX509_STORE_CTX_cleanup()\fR
192 and then \fBX509_STORE_CTX_init()\fR again before the second call to
193 \&\fBX509_verify_cert()\fR. The trusted certificate store is set to \fBstore\fR, the end
194 entity certificate to be verified is set to \fBx509\fR and a set of additional
195 certificates (which will be untrusted but may be used to build the chain) in
196 \&\fBchain\fR. Any or all of the \fBstore\fR, \fBx509\fR and \fBchain\fR parameters can be
199 \&\fBX509_STORE_CTX_set0_trusted_stack()\fR sets the set of trusted certificates of
200 \&\fBctx\fR to \fBsk\fR. This is an alternative way of specifying trusted certificates
201 instead of using an \fBX509_STORE\fR.
203 \&\fBX509_STORE_CTX_set_cert()\fR sets the certificate to be verified in \fBctx\fR to
206 \&\fBX509_STORE_CTX_set0_verified_chain()\fR sets the validated chain used
207 by \fBctx\fR to be \fBchain\fR.
208 Ownership of the chain is transferred to \fBctx\fR and should not be
209 free'd by the caller.
210 \&\fBX509_STORE_CTX_get0_chain()\fR returns the internal pointer used by the
211 \&\fBctx\fR that contains the validated chain.
213 \&\fBX509_STORE_CTX_set0_crls()\fR sets a set of CRLs to use to aid certificate
214 verification to \fBsk\fR. These CRLs will only be used if \s-1CRL\s0 verification is
215 enabled in the associated \fBX509_VERIFY_PARAM\fR structure. This might be
216 used where additional \*(L"useful\*(R" CRLs are supplied as part of a protocol,
217 for example in a PKCS#7 structure.
219 \&\fBX509_STORE_CTX_get0_param()\fR retrieves an internal pointer
220 to the verification parameters associated with \fBctx\fR.
222 \&\fBX509_STORE_CTX_get0_untrusted()\fR retrieves an internal pointer to the
223 stack of untrusted certificates associated with \fBctx\fR.
225 \&\fBX509_STORE_CTX_set0_untrusted()\fR sets the internal point to the stack
226 of untrusted certificates associated with \fBctx\fR to \fBsk\fR.
228 \&\fBX509_STORE_CTX_set0_param()\fR sets the internal verification parameter pointer
229 to \fBparam\fR. After this call \fBparam\fR should not be used.
231 \&\fBX509_STORE_CTX_set_default()\fR looks up and sets the default verification
232 method to \fBname\fR. This uses the function \fBX509_VERIFY_PARAM_lookup()\fR to
233 find an appropriate set of parameters from \fBname\fR.
235 \&\fBX509_STORE_CTX_get_num_untrusted()\fR returns the number of untrusted certificates
236 that were used in building the chain following a call to \fBX509_verify_cert()\fR.
238 \&\fBX509_STORE_CTX_set_verify()\fR provides the capability for overriding the default
239 verify function. This function is responsible for verifying chain signatures and
242 A verify function is defined as an X509_STORE_CTX_verify type which has the
246 \& int (*verify)(X509_STORE_CTX *);
249 This function should receive the current X509_STORE_CTX as a parameter and
250 return 1 on success or 0 on failure.
253 The certificates and CRLs in a store are used internally and should \fBnot\fR
254 be freed up until after the associated \fBX509_STORE_CTX\fR is freed.
257 The certificates and CRLs in a context are used internally and should \fBnot\fR
258 be freed up until after the associated \fBX509_STORE_CTX\fR is freed. Copies
259 should be made or reference counts increased instead.
261 .IX Header "RETURN VALUES"
262 \&\fBX509_STORE_CTX_new()\fR returns a newly allocated context or \fB\s-1NULL\s0\fR if an
265 \&\fBX509_STORE_CTX_init()\fR returns 1 for success or 0 if an error occurred.
267 \&\fBX509_STORE_CTX_get0_param()\fR returns a pointer to an \fBX509_VERIFY_PARAM\fR
268 structure or \fB\s-1NULL\s0\fR if an error occurred.
270 \&\fBX509_STORE_CTX_cleanup()\fR, \fBX509_STORE_CTX_free()\fR,
271 \&\fBX509_STORE_CTX_set0_trusted_stack()\fR,
272 \&\fBX509_STORE_CTX_set_cert()\fR,
273 \&\fBX509_STORE_CTX_set0_crls()\fR and \fBX509_STORE_CTX_set0_param()\fR do not return
276 \&\fBX509_STORE_CTX_set_default()\fR returns 1 for success or 0 if an error occurred.
278 \&\fBX509_STORE_CTX_get_num_untrusted()\fR returns the number of untrusted certificates
281 .IX Header "SEE ALSO"
282 \&\fBX509_verify_cert\fR\|(3)
283 \&\fBX509_VERIFY_PARAM_set_flags\fR\|(3)
286 The \fBX509_STORE_CTX_set0_crls()\fR function was added in OpenSSL 1.0.0.
287 The \fBX509_STORE_CTX_get_num_untrusted()\fR function was added in OpenSSL 1.1.0.
289 .IX Header "COPYRIGHT"
290 Copyright 2009\-2020 The OpenSSL Project Authors. All Rights Reserved.
292 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
293 this file except in compliance with the License. You can obtain a copy
294 in the file \s-1LICENSE\s0 in the source distribution or at
295 <https://www.openssl.org/source/license.html>.