5 X509_STORE_CTX_new, X509_STORE_CTX_cleanup, X509_STORE_CTX_free,
6 X509_STORE_CTX_init, X509_STORE_CTX_set0_trusted_stack, X509_STORE_CTX_set_cert,
7 X509_STORE_CTX_set0_crls,
8 X509_STORE_CTX_get0_chain, X509_STORE_CTX_set0_verified_chain,
9 X509_STORE_CTX_get0_param, X509_STORE_CTX_set0_param,
10 X509_STORE_CTX_get0_untrusted, X509_STORE_CTX_set0_untrusted,
11 X509_STORE_CTX_get_num_untrusted,
12 X509_STORE_CTX_set_default,
13 X509_STORE_CTX_set_verify,
14 X509_STORE_CTX_verify_fn
15 - X509_STORE_CTX initialisation
19 #include <openssl/x509_vfy.h>
21 X509_STORE_CTX *X509_STORE_CTX_new(void);
22 void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
23 void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
25 int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
26 X509 *x509, STACK_OF(X509) *chain);
28 void X509_STORE_CTX_set0_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
30 void X509_STORE_CTX_set_cert(X509_STORE_CTX *ctx, X509 *x);
31 STACK_OF(X509) *X509_STORE_CTX_get0_chain(X609_STORE_CTX *ctx);
32 void X509_STORE_CTX_set0_verified_chain(X509_STORE_CTX *ctx, STACK_OF(X509) *chain);
33 void X509_STORE_CTX_set0_crls(X509_STORE_CTX *ctx, STACK_OF(X509_CRL) *sk);
35 X509_VERIFY_PARAM *X509_STORE_CTX_get0_param(X509_STORE_CTX *ctx);
36 void X509_STORE_CTX_set0_param(X509_STORE_CTX *ctx, X509_VERIFY_PARAM *param);
37 int X509_STORE_CTX_set_default(X509_STORE_CTX *ctx, const char *name);
39 STACK_OF(X509)* X509_STORE_CTX_get0_untrusted(X509_STORE_CTX *ctx);
40 void X509_STORE_CTX_set0_untrusted(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
42 int X509_STORE_CTX_get_num_untrusted(X509_STORE_CTX *ctx);
44 typedef int (*X509_STORE_CTX_verify_fn)(X509_STORE_CTX *);
45 void X509_STORE_CTX_set_verify(X509_STORE_CTX *ctx, X509_STORE_CTX_verify_fn verify);
49 These functions initialise an B<X509_STORE_CTX> structure for subsequent use
50 by X509_verify_cert().
52 X509_STORE_CTX_new() returns a newly initialised B<X509_STORE_CTX> structure.
54 X509_STORE_CTX_cleanup() internally cleans up an B<X509_STORE_CTX> structure.
55 The context can then be reused with an new call to X509_STORE_CTX_init().
57 X509_STORE_CTX_free() completely frees up B<ctx>. After this call B<ctx>
59 If B<ctx> is NULL nothing is done.
61 X509_STORE_CTX_init() sets up B<ctx> for a subsequent verification operation.
62 It must be called before each call to X509_verify_cert(), i.e. a B<ctx> is only
63 good for one call to X509_verify_cert(); if you want to verify a second
64 certificate with the same B<ctx> then you must call X509_STORE_CTX_cleanup()
65 and then X509_STORE_CTX_init() again before the second call to
66 X509_verify_cert(). The trusted certificate store is set to B<store>, the end
67 entity certificate to be verified is set to B<x509> and a set of additional
68 certificates (which will be untrusted but may be used to build the chain) in
69 B<chain>. Any or all of the B<store>, B<x509> and B<chain> parameters can be
72 X509_STORE_CTX_set0_trusted_stack() sets the set of trusted certificates of
73 B<ctx> to B<sk>. This is an alternative way of specifying trusted certificates
74 instead of using an B<X509_STORE>.
76 X509_STORE_CTX_set_cert() sets the certificate to be verified in B<ctx> to
79 X509_STORE_CTX_set0_verified_chain() sets the validated chain used
80 by B<ctx> to be B<chain>.
81 Ownership of the chain is transferred to B<ctx> and should not be
83 X509_STORE_CTX_get0_chain() returns a the internal pointer used by the
84 B<ctx> that contains the validated chain.
86 X509_STORE_CTX_set0_crls() sets a set of CRLs to use to aid certificate
87 verification to B<sk>. These CRLs will only be used if CRL verification is
88 enabled in the associated B<X509_VERIFY_PARAM> structure. This might be
89 used where additional "useful" CRLs are supplied as part of a protocol,
90 for example in a PKCS#7 structure.
92 X509_STORE_CTX_get0_param() retrieves an internal pointer
93 to the verification parameters associated with B<ctx>.
95 X509_STORE_CTX_get0_untrusted() retrieves an internal pointer to the
96 stack of untrusted certificates associated with B<ctx>.
98 X509_STORE_CTX_set0_untrusted() sets the internal point to the stack
99 of untrusted certificates associated with B<ctx> to B<sk>.
101 X509_STORE_CTX_set0_param() sets the internal verification parameter pointer
102 to B<param>. After this call B<param> should not be used.
104 X509_STORE_CTX_set_default() looks up and sets the default verification
105 method to B<name>. This uses the function X509_VERIFY_PARAM_lookup() to
106 find an appropriate set of parameters from B<name>.
108 X509_STORE_CTX_get_num_untrusted() returns the number of untrusted certificates
109 that were used in building the chain following a call to X509_verify_cert().
111 X509_STORE_CTX_set_verify() provides the capability for overriding the default
112 verify function. This function is responsible for verifying chain signatures and
115 A verify function is defined as an X509_STORE_CTX_verify type which has the
118 int (*verify)(X509_STORE_CTX *);
120 This function should receive the current X509_STORE_CTX as a parameter and
121 return 1 on success or 0 on failure.
125 The certificates and CRLs in a store are used internally and should B<not>
126 be freed up until after the associated B<X509_STORE_CTX> is freed.
130 The certificates and CRLs in a context are used internally and should B<not>
131 be freed up until after the associated B<X509_STORE_CTX> is freed. Copies
132 should be made or reference counts increased instead.
136 X509_STORE_CTX_new() returns an newly allocates context or B<NULL> is an
139 X509_STORE_CTX_init() returns 1 for success or 0 if an error occurred.
141 X509_STORE_CTX_get0_param() returns a pointer to an B<X509_VERIFY_PARAM>
142 structure or B<NULL> if an error occurred.
144 X509_STORE_CTX_cleanup(), X509_STORE_CTX_free(),
145 X509_STORE_CTX_set0_trusted_stack(),
146 X509_STORE_CTX_set_cert(),
147 X509_STORE_CTX_set0_crls() and X509_STORE_CTX_set0_param() do not return
150 X509_STORE_CTX_set_default() returns 1 for success or 0 if an error occurred.
152 X509_STORE_CTX_get_num_untrusted() returns the number of untrusted certificates
157 L<X509_verify_cert(3)>
158 L<X509_VERIFY_PARAM_set_flags(3)>
162 X509_STORE_CTX_set0_crls() was first added to OpenSSL 1.0.0
163 X509_STORE_CTX_get_num_untrusted() was first added to OpenSSL 1.1.0
167 Copyright 2009-2016 The OpenSSL Project Authors. All Rights Reserved.
169 Licensed under the OpenSSL license (the "License"). You may not use
170 this file except in compliance with the License. You can obtain a copy
171 in the file LICENSE in the source distribution or at
172 L<https://www.openssl.org/source/license.html>.