1 .\" Automatically generated by Pod::Man 4.07 (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 "2017-12-07" "1.0.2n" "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_trusted_stack, X509_STORE_CTX_set_cert, X509_STORE_CTX_set_chain, X509_STORE_CTX_set0_crls, X509_STORE_CTX_get0_param, X509_STORE_CTX_set0_param, X509_STORE_CTX_set_default \- 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_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
153 \& void X509_STORE_CTX_set_cert(X509_STORE_CTX *ctx,X509 *x);
154 \& void X509_STORE_CTX_set_chain(X509_STORE_CTX *ctx,STACK_OF(X509) *sk);
155 \& void X509_STORE_CTX_set0_crls(X509_STORE_CTX *ctx, STACK_OF(X509_CRL) *sk);
157 \& X509_VERIFY_PARAM *X509_STORE_CTX_get0_param(X509_STORE_CTX *ctx);
158 \& void X509_STORE_CTX_set0_param(X509_STORE_CTX *ctx, X509_VERIFY_PARAM *param);
159 \& int X509_STORE_CTX_set_default(X509_STORE_CTX *ctx, const char *name);
162 .IX Header "DESCRIPTION"
163 These functions initialise an \fBX509_STORE_CTX\fR structure for subsequent use
164 by \fIX509_verify_cert()\fR.
166 \&\fIX509_STORE_CTX_new()\fR returns a newly initialised \fBX509_STORE_CTX\fR structure.
168 \&\fIX509_STORE_CTX_cleanup()\fR internally cleans up an \fBX509_STORE_CTX\fR structure.
169 The context can then be reused with an new call to \fIX509_STORE_CTX_init()\fR.
171 \&\fIX509_STORE_CTX_free()\fR completely frees up \fBctx\fR. After this call \fBctx\fR
174 \&\fIX509_STORE_CTX_init()\fR sets up \fBctx\fR for a subsequent verification operation.
175 It must be called before each call to \fIX509_verify_cert()\fR, i.e. a \fBctx\fR is only
176 good for one call to \fIX509_verify_cert()\fR; if you want to verify a second
177 certificate with the same \fBctx\fR then you must call \fIX509_STORE_CTX_cleanup()\fR
178 and then \fIX509_STORE_CTX_init()\fR again before the second call to
179 \&\fIX509_verify_cert()\fR. The trusted certificate store is set to \fBstore\fR, the end
180 entity certificate to be verified is set to \fBx509\fR and a set of additional
181 certificates (which will be untrusted but may be used to build the chain) in
182 \&\fBchain\fR. Any or all of the \fBstore\fR, \fBx509\fR and \fBchain\fR parameters can be
185 \&\fIX509_STORE_CTX_trusted_stack()\fR sets the set of trusted certificates of \fBctx\fR
186 to \fBsk\fR. This is an alternative way of specifying trusted certificates
187 instead of using an \fBX509_STORE\fR.
189 \&\fIX509_STORE_CTX_set_cert()\fR sets the certificate to be vertified in \fBctx\fR to
192 \&\fIX509_STORE_CTX_set_chain()\fR sets the additional certificate chain used by \fBctx\fR
195 \&\fIX509_STORE_CTX_set0_crls()\fR sets a set of CRLs to use to aid certificate
196 verification to \fBsk\fR. These CRLs will only be used if \s-1CRL\s0 verification is
197 enabled in the associated \fBX509_VERIFY_PARAM\fR structure. This might be
198 used where additional \*(L"useful\*(R" CRLs are supplied as part of a protocol,
199 for example in a PKCS#7 structure.
201 X509_VERIFY_PARAM *\fIX509_STORE_CTX_get0_param()\fR retrieves an intenal pointer
202 to the verification parameters associated with \fBctx\fR.
204 \&\fIX509_STORE_CTX_set0_param()\fR sets the intenal verification parameter pointer
205 to \fBparam\fR. After this call \fBparam\fR should not be used.
207 \&\fIX509_STORE_CTX_set_default()\fR looks up and sets the default verification
208 method to \fBname\fR. This uses the function \fIX509_VERIFY_PARAM_lookup()\fR to
209 find an appropriate set of parameters from \fBname\fR.
212 The certificates and CRLs in a store are used internally and should \fBnot\fR
213 be freed up until after the associated \fBX509_STORE_CTX\fR is freed. Legacy
214 applications might implicitly use an \fBX509_STORE_CTX\fR like this:
217 \& X509_STORE_CTX ctx;
218 \& X509_STORE_CTX_init(&ctx, store, cert, chain);
221 this is \fBnot\fR recommended in new applications they should instead do:
224 \& X509_STORE_CTX *ctx;
225 \& ctx = X509_STORE_CTX_new();
228 \& X509_STORE_CTX_init(ctx, store, cert, chain);
232 The certificates and CRLs in a context are used internally and should \fBnot\fR
233 be freed up until after the associated \fBX509_STORE_CTX\fR is freed. Copies
234 should be made or reference counts increased instead.
236 .IX Header "RETURN VALUES"
237 \&\fIX509_STORE_CTX_new()\fR returns an newly allocates context or \fB\s-1NULL\s0\fR is an
240 \&\fIX509_STORE_CTX_init()\fR returns 1 for success or 0 if an error occurred.
242 \&\fIX509_STORE_CTX_get0_param()\fR returns a pointer to an \fBX509_VERIFY_PARAM\fR
243 structure or \fB\s-1NULL\s0\fR if an error occurred.
245 \&\fIX509_STORE_CTX_cleanup()\fR, \fIX509_STORE_CTX_free()\fR, \fIX509_STORE_CTX_trusted_stack()\fR,
246 \&\fIX509_STORE_CTX_set_cert()\fR, \fIX509_STORE_CTX_set_chain()\fR,
247 \&\fIX509_STORE_CTX_set0_crls()\fR and \fIX509_STORE_CTX_set0_param()\fR do not return
250 \&\fIX509_STORE_CTX_set_default()\fR returns 1 for success or 0 if an error occurred.
252 .IX Header "SEE ALSO"
253 \&\fIX509_verify_cert\fR\|(3)
254 \&\fIX509_VERIFY_PARAM_set_flags\fR\|(3)
257 \&\fIX509_STORE_CTX_set0_crls()\fR was first added to OpenSSL 1.0.0