1X509_STORE_CTX_NEW(3)               OpenSSL              X509_STORE_CTX_NEW(3)
2
3
4

NAME

6       X509_STORE_CTX_new, X509_STORE_CTX_cleanup, X509_STORE_CTX_free,
7       X509_STORE_CTX_init, X509_STORE_CTX_set0_trusted_stack,
8       X509_STORE_CTX_set_cert, X509_STORE_CTX_set0_crls,
9       X509_STORE_CTX_get0_chain, X509_STORE_CTX_set0_verified_chain,
10       X509_STORE_CTX_get0_param, X509_STORE_CTX_set0_param,
11       X509_STORE_CTX_get0_untrusted, X509_STORE_CTX_set0_untrusted,
12       X509_STORE_CTX_get_num_untrusted, X509_STORE_CTX_set_default,
13       X509_STORE_CTX_set_verify, X509_STORE_CTX_verify_fn,
14       X509_STORE_CTX_set_purpose, X509_STORE_CTX_set_trust,
15       X509_STORE_CTX_purpose_inherit - X509_STORE_CTX initialisation
16

SYNOPSIS

18        #include <openssl/x509_vfy.h>
19
20        X509_STORE_CTX *X509_STORE_CTX_new(void);
21        void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
22        void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
23
24        int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
25                                X509 *x509, STACK_OF(X509) *chain);
26
27        void X509_STORE_CTX_set0_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
28
29        void X509_STORE_CTX_set_cert(X509_STORE_CTX *ctx, X509 *x);
30        STACK_OF(X509) *X509_STORE_CTX_get0_chain(X509_STORE_CTX *ctx);
31        void X509_STORE_CTX_set0_verified_chain(X509_STORE_CTX *ctx, STACK_OF(X509) *chain);
32        void X509_STORE_CTX_set0_crls(X509_STORE_CTX *ctx, STACK_OF(X509_CRL) *sk);
33
34        X509_VERIFY_PARAM *X509_STORE_CTX_get0_param(X509_STORE_CTX *ctx);
35        void X509_STORE_CTX_set0_param(X509_STORE_CTX *ctx, X509_VERIFY_PARAM *param);
36        int X509_STORE_CTX_set_default(X509_STORE_CTX *ctx, const char *name);
37
38        STACK_OF(X509)* X509_STORE_CTX_get0_untrusted(X509_STORE_CTX *ctx);
39        void X509_STORE_CTX_set0_untrusted(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
40
41        int X509_STORE_CTX_get_num_untrusted(X509_STORE_CTX *ctx);
42
43        typedef int (*X509_STORE_CTX_verify_fn)(X509_STORE_CTX *);
44        void X509_STORE_CTX_set_verify(X509_STORE_CTX *ctx, X509_STORE_CTX_verify_fn verify);
45
46        int X509_STORE_CTX_set_purpose(X509_STORE_CTX *ctx, int purpose);
47        int X509_STORE_CTX_set_trust(X509_STORE_CTX *ctx, int trust);
48        int X509_STORE_CTX_purpose_inherit(X509_STORE_CTX *ctx, int def_purpose,
49                                           int purpose, int trust);
50

DESCRIPTION

52       These functions initialise an X509_STORE_CTX structure for subsequent
53       use by X509_verify_cert().
54
55       X509_STORE_CTX_new() returns a newly initialised X509_STORE_CTX
56       structure.
57
58       X509_STORE_CTX_cleanup() internally cleans up an X509_STORE_CTX
59       structure.  The context can then be reused with a new call to
60       X509_STORE_CTX_init().
61
62       X509_STORE_CTX_free() completely frees up ctx. After this call ctx is
63       no longer valid.  If ctx is NULL nothing is done.
64
65       X509_STORE_CTX_init() sets up ctx for a subsequent verification
66       operation.  It must be called before each call to X509_verify_cert(),
67       i.e. a ctx is only good for one call to X509_verify_cert(); if you want
68       to verify a second certificate with the same ctx then you must call
69       X509_STORE_CTX_cleanup() and then X509_STORE_CTX_init() again before
70       the second call to X509_verify_cert(). The trusted certificate store is
71       set to store, the end entity certificate to be verified is set to x509
72       and a set of additional certificates (which will be untrusted but may
73       be used to build the chain) in chain. Any or all of the store, x509 and
74       chain parameters can be NULL.
75
76       X509_STORE_CTX_set0_trusted_stack() sets the set of trusted
77       certificates of ctx to sk. This is an alternative way of specifying
78       trusted certificates instead of using an X509_STORE.
79
80       X509_STORE_CTX_set_cert() sets the certificate to be verified in ctx to
81       x.
82
83       X509_STORE_CTX_set0_verified_chain() sets the validated chain used by
84       ctx to be chain.  Ownership of the chain is transferred to ctx and
85       should not be free'd by the caller.  X509_STORE_CTX_get0_chain()
86       returns the internal pointer used by the ctx that contains the
87       validated chain.
88
89       X509_STORE_CTX_set0_crls() sets a set of CRLs to use to aid certificate
90       verification to sk. These CRLs will only be used if CRL verification is
91       enabled in the associated X509_VERIFY_PARAM structure. This might be
92       used where additional "useful" CRLs are supplied as part of a protocol,
93       for example in a PKCS#7 structure.
94
95       X509_STORE_CTX_get0_param() retrieves an internal pointer to the
96       verification parameters associated with ctx.
97
98       X509_STORE_CTX_get0_untrusted() retrieves an internal pointer to the
99       stack of untrusted certificates associated with ctx.
100
101       X509_STORE_CTX_set0_untrusted() sets the internal point to the stack of
102       untrusted certificates associated with ctx to sk.
103
104       X509_STORE_CTX_set0_param() sets the internal verification parameter
105       pointer to param. After this call param should not be used.
106
107       X509_STORE_CTX_set_default() looks up and sets the default verification
108       method to name. This uses the function X509_VERIFY_PARAM_lookup() to
109       find an appropriate set of parameters from name.
110
111       X509_STORE_CTX_get_num_untrusted() returns the number of untrusted
112       certificates that were used in building the chain following a call to
113       X509_verify_cert().
114
115       X509_STORE_CTX_set_verify() provides the capability for overriding the
116       default verify function. This function is responsible for verifying
117       chain signatures and expiration times.
118
119       A verify function is defined as an X509_STORE_CTX_verify type which has
120       the following signature:
121
122        int (*verify)(X509_STORE_CTX *);
123
124       This function should receive the current X509_STORE_CTX as a parameter
125       and return 1 on success or 0 on failure.
126
127       X509 certificates may contain information about what purposes keys
128       contained within them can be used for. For example "TLS WWW Server
129       Authentication" or "Email Protection". This "key usage" information is
130       held internally to the certificate itself. In addition the trust store
131       containing trusted certificates can declare what purposes we trust
132       different certificates for. This "trust" information is not held within
133       the certificate itself but is "meta" information held alongside it.
134       This "meta" information is associated with the certificate after it is
135       issued and could be determined by a system administrator. For example a
136       certificate might declare that it is suitable for use for both "TLS WWW
137       Server Authentication" and "TLS Client Authentication", but a system
138       administrator might only trust it for the former. An X.509 certificate
139       extension exists that can record extended key usage information to
140       supplement the purpose information described above. This extended
141       mechanism is arbitrarily extensible and not well suited for a generic
142       library API; applications that need to validate extended key usage
143       information in certifiates will need to define a custom "purpose" (see
144       below) or supply a nondefault verification callback
145       (X509_STORE_set_verify_cb_func(3)).
146
147       X509_STORE_CTX_set_purpose() sets the purpose for the target
148       certificate being verified in the ctx. Built-in available values for
149       the purpose argument are X509_PURPOSE_SSL_CLIENT,
150       X509_PURPOSE_SSL_SERVER, X509_PURPOSE_NS_SSL_SERVER,
151       X509_PURPOSE_SMIME_SIGN, X509_PURPOSE_SMIME_ENCRYPT,
152       X509_PURPOSE_CRL_SIGN, X509_PURPOSE_ANY, X509_PURPOSE_OCSP_HELPER and
153       X509_PURPOSE_TIMESTAMP_SIGN. It is also possible to create a custom
154       purpose value. Setting a purpose will ensure that the key usage
155       declared within certificates in the chain being verified is consistent
156       with that purpose as well as, potentially, other checks. Every purpose
157       also has an associated default trust value which will also be set at
158       the same time. During verification this trust setting will be verified
159       to check it is consistent with the trust set by the system
160       administrator for certificates in the chain.
161
162       X509_STORE_CTX_set_trust() sets the trust value for the target
163       certificate being verified in the ctx. Built-in available values for
164       the trust argument are X509_TRUST_COMPAT, X509_TRUST_SSL_CLIENT,
165       X509_TRUST_SSL_SERVER, X509_TRUST_EMAIL, X509_TRUST_OBJECT_SIGN,
166       X509_TRUST_OCSP_SIGN, X509_TRUST_OCSP_REQUEST and X509_TRUST_TSA. It is
167       also possible to create a custom trust value. Since
168       X509_STORE_CTX_set_purpose() also sets the trust value it is normally
169       sufficient to only call that function.  If both are called then
170       X509_STORE_CTX_set_trust() should be called after
171       X509_STORE_CTX_set_purpose() since the trust setting of the last call
172       will be used.
173
174       It should not normally be necessary for end user applications to call
175       X509_STORE_CTX_purpose_inherit() directly. Typically applications
176       should call X509_STORE_CTX_set_purpose() or X509_STORE_CTX_set_trust()
177       instead. Using this function it is possible to set the purpose and
178       trust values for the ctx at the same time. The def_purpose and purpose
179       arguments can have the same purpose values as described for
180       X509_STORE_CTX_set_purpose() above. The trust argument can have the
181       same trust values as described in X509_STORE_CTX_set_trust() above. Any
182       of the def_purpose, purpose or trust values may also have the value 0
183       to indicate that the supplied parameter should be ignored. After
184       calling this function the purpose to be used for verification is set
185       from the purpose argument, and the trust is set from the trust
186       argument. If trust is 0 then the trust value will be set from the
187       default trust value for purpose. If the default trust value for the
188       purpose is X509_TRUST_DEFAULT and trust is 0 then the default trust
189       value associated with the def_purpose value is used for the trust
190       setting instead.
191

NOTES

193       The certificates and CRLs in a store are used internally and should not
194       be freed up until after the associated X509_STORE_CTX is freed.
195

BUGS

197       The certificates and CRLs in a context are used internally and should
198       not be freed up until after the associated X509_STORE_CTX is freed.
199       Copies should be made or reference counts increased instead.
200

RETURN VALUES

202       X509_STORE_CTX_new() returns a newly allocated context or NULL if an
203       error occurred.
204
205       X509_STORE_CTX_init() returns 1 for success or 0 if an error occurred.
206
207       X509_STORE_CTX_get0_param() returns a pointer to an X509_VERIFY_PARAM
208       structure or NULL if an error occurred.
209
210       X509_STORE_CTX_cleanup(), X509_STORE_CTX_free(),
211       X509_STORE_CTX_set0_trusted_stack(), X509_STORE_CTX_set_cert(),
212       X509_STORE_CTX_set0_crls() and X509_STORE_CTX_set0_param() do not
213       return values.
214
215       X509_STORE_CTX_set_default() returns 1 for success or 0 if an error
216       occurred.
217
218       X509_STORE_CTX_get_num_untrusted() returns the number of untrusted
219       certificates used.
220

SEE ALSO

222       X509_verify_cert(3) X509_VERIFY_PARAM_set_flags(3)
223

HISTORY

225       The X509_STORE_CTX_set0_crls() function was added in OpenSSL 1.0.0.
226       The X509_STORE_CTX_get_num_untrusted() function was added in OpenSSL
227       1.1.0.
228
230       Copyright 2009-2022 The OpenSSL Project Authors. All Rights Reserved.
231
232       Licensed under the OpenSSL license (the "License").  You may not use
233       this file except in compliance with the License.  You can obtain a copy
234       in the file LICENSE in the source distribution or at
235       <https://www.openssl.org/source/license.html>.
236
237
238
2391.1.1q                            2022-07-21             X509_STORE_CTX_NEW(3)
Impressum