1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
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'.
60 . tm Index:\\$1\t\\n%\t"\\$2"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "X509_STORE_CTX_NEW 3"
132 .TH X509_STORE_CTX_NEW 3 "2018-09-11" "1.1.1" "OpenSSL"
133 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
138 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
140 .IX Header "SYNOPSIS"
142 \& #include <openssl/x509_vfy.h>
144 \& X509_STORE_CTX *X509_STORE_CTX_new(void);
145 \& void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
146 \& void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
148 \& int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
149 \& X509 *x509, STACK_OF(X509) *chain);
151 \& void X509_STORE_CTX_set0_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
153 \& void X509_STORE_CTX_set_cert(X509_STORE_CTX *ctx, X509 *x);
154 \& STACK_OF(X509) *X509_STORE_CTX_get0_chain(X609_STORE_CTX *ctx);
155 \& void X509_STORE_CTX_set0_verified_chain(X509_STORE_CTX *ctx, STACK_OF(X509) *chain);
156 \& void X509_STORE_CTX_set0_crls(X509_STORE_CTX *ctx, STACK_OF(X509_CRL) *sk);
158 \& X509_VERIFY_PARAM *X509_STORE_CTX_get0_param(X509_STORE_CTX *ctx);
159 \& void X509_STORE_CTX_set0_param(X509_STORE_CTX *ctx, X509_VERIFY_PARAM *param);
160 \& int X509_STORE_CTX_set_default(X509_STORE_CTX *ctx, const char *name);
162 \& STACK_OF(X509)* X509_STORE_CTX_get0_untrusted(X509_STORE_CTX *ctx);
163 \& void X509_STORE_CTX_set0_untrusted(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
165 \& int X509_STORE_CTX_get_num_untrusted(X509_STORE_CTX *ctx);
167 \& typedef int (*X509_STORE_CTX_verify_fn)(X509_STORE_CTX *);
168 \& void X509_STORE_CTX_set_verify(X509_STORE_CTX *ctx, X509_STORE_CTX_verify_fn verify);
171 .IX Header "DESCRIPTION"
172 These functions initialise an \fBX509_STORE_CTX\fR structure for subsequent use
173 by \fIX509_verify_cert()\fR.
175 \&\fIX509_STORE_CTX_new()\fR returns a newly initialised \fBX509_STORE_CTX\fR structure.
177 \&\fIX509_STORE_CTX_cleanup()\fR internally cleans up an \fBX509_STORE_CTX\fR structure.
178 The context can then be reused with an new call to \fIX509_STORE_CTX_init()\fR.
180 \&\fIX509_STORE_CTX_free()\fR completely frees up \fBctx\fR. After this call \fBctx\fR
182 If \fBctx\fR is \s-1NULL\s0 nothing is done.
184 \&\fIX509_STORE_CTX_init()\fR sets up \fBctx\fR for a subsequent verification operation.
185 It must be called before each call to \fIX509_verify_cert()\fR, i.e. a \fBctx\fR is only
186 good for one call to \fIX509_verify_cert()\fR; if you want to verify a second
187 certificate with the same \fBctx\fR then you must call \fIX509_STORE_CTX_cleanup()\fR
188 and then \fIX509_STORE_CTX_init()\fR again before the second call to
189 \&\fIX509_verify_cert()\fR. The trusted certificate store is set to \fBstore\fR, the end
190 entity certificate to be verified is set to \fBx509\fR and a set of additional
191 certificates (which will be untrusted but may be used to build the chain) in
192 \&\fBchain\fR. Any or all of the \fBstore\fR, \fBx509\fR and \fBchain\fR parameters can be
195 \&\fIX509_STORE_CTX_set0_trusted_stack()\fR sets the set of trusted certificates of
196 \&\fBctx\fR to \fBsk\fR. This is an alternative way of specifying trusted certificates
197 instead of using an \fBX509_STORE\fR.
199 \&\fIX509_STORE_CTX_set_cert()\fR sets the certificate to be verified in \fBctx\fR to
202 \&\fIX509_STORE_CTX_set0_verified_chain()\fR sets the validated chain used
203 by \fBctx\fR to be \fBchain\fR.
204 Ownership of the chain is transferred to \fBctx\fR and should not be
205 free'd by the caller.
206 \&\fIX509_STORE_CTX_get0_chain()\fR returns a the internal pointer used by the
207 \&\fBctx\fR that contains the validated chain.
209 \&\fIX509_STORE_CTX_set0_crls()\fR sets a set of CRLs to use to aid certificate
210 verification to \fBsk\fR. These CRLs will only be used if \s-1CRL\s0 verification is
211 enabled in the associated \fBX509_VERIFY_PARAM\fR structure. This might be
212 used where additional \*(L"useful\*(R" CRLs are supplied as part of a protocol,
213 for example in a PKCS#7 structure.
215 \&\fIX509_STORE_CTX_get0_param()\fR retrieves an internal pointer
216 to the verification parameters associated with \fBctx\fR.
218 \&\fIX509_STORE_CTX_get0_untrusted()\fR retrieves an internal pointer to the
219 stack of untrusted certificates associated with \fBctx\fR.
221 \&\fIX509_STORE_CTX_set0_untrusted()\fR sets the internal point to the stack
222 of untrusted certificates associated with \fBctx\fR to \fBsk\fR.
224 \&\fIX509_STORE_CTX_set0_param()\fR sets the internal verification parameter pointer
225 to \fBparam\fR. After this call \fBparam\fR should not be used.
227 \&\fIX509_STORE_CTX_set_default()\fR looks up and sets the default verification
228 method to \fBname\fR. This uses the function \fIX509_VERIFY_PARAM_lookup()\fR to
229 find an appropriate set of parameters from \fBname\fR.
231 \&\fIX509_STORE_CTX_get_num_untrusted()\fR returns the number of untrusted certificates
232 that were used in building the chain following a call to \fIX509_verify_cert()\fR.
234 \&\fIX509_STORE_CTX_set_verify()\fR provides the capability for overriding the default
235 verify function. This function is responsible for verifying chain signatures and
238 A verify function is defined as an X509_STORE_CTX_verify type which has the
242 \& int (*verify)(X509_STORE_CTX *);
245 This function should receive the current X509_STORE_CTX as a parameter and
246 return 1 on success or 0 on failure.
249 The certificates and CRLs in a store are used internally and should \fBnot\fR
250 be freed up until after the associated \fBX509_STORE_CTX\fR is freed.
253 The certificates and CRLs in a context are used internally and should \fBnot\fR
254 be freed up until after the associated \fBX509_STORE_CTX\fR is freed. Copies
255 should be made or reference counts increased instead.
257 .IX Header "RETURN VALUES"
258 \&\fIX509_STORE_CTX_new()\fR returns an newly allocates context or \fB\s-1NULL\s0\fR is an
261 \&\fIX509_STORE_CTX_init()\fR returns 1 for success or 0 if an error occurred.
263 \&\fIX509_STORE_CTX_get0_param()\fR returns a pointer to an \fBX509_VERIFY_PARAM\fR
264 structure or \fB\s-1NULL\s0\fR if an error occurred.
266 \&\fIX509_STORE_CTX_cleanup()\fR, \fIX509_STORE_CTX_free()\fR,
267 \&\fIX509_STORE_CTX_set0_trusted_stack()\fR,
268 \&\fIX509_STORE_CTX_set_cert()\fR,
269 \&\fIX509_STORE_CTX_set0_crls()\fR and \fIX509_STORE_CTX_set0_param()\fR do not return
272 \&\fIX509_STORE_CTX_set_default()\fR returns 1 for success or 0 if an error occurred.
274 \&\fIX509_STORE_CTX_get_num_untrusted()\fR returns the number of untrusted certificates
277 .IX Header "SEE ALSO"
278 \&\fIX509_verify_cert\fR\|(3)
279 \&\fIX509_VERIFY_PARAM_set_flags\fR\|(3)
282 \&\fIX509_STORE_CTX_set0_crls()\fR was first added to OpenSSL 1.0.0
283 \&\fIX509_STORE_CTX_get_num_untrusted()\fR was first added to OpenSSL 1.1.0
285 .IX Header "COPYRIGHT"
286 Copyright 2009\-2016 The OpenSSL Project Authors. All Rights Reserved.
288 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
289 this file except in compliance with the License. You can obtain a copy
290 in the file \s-1LICENSE\s0 in the source distribution or at
291 <https://www.openssl.org/source/license.html>.