5 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
9 #include <openssl/x509_vfy.h>
11 X509_STORE_CTX *X509_STORE_CTX_new(void);
12 void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
13 void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
15 int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
16 X509 *x509, STACK_OF(X509) *chain);
18 void X509_STORE_CTX_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
20 void X509_STORE_CTX_set_cert(X509_STORE_CTX *ctx,X509 *x);
21 void X509_STORE_CTX_set_chain(X509_STORE_CTX *ctx,STACK_OF(X509) *sk);
22 void X509_STORE_CTX_set0_crls(X509_STORE_CTX *ctx, STACK_OF(X509_CRL) *sk);
24 X509_VERIFY_PARAM *X509_STORE_CTX_get0_param(X509_STORE_CTX *ctx);
25 void X509_STORE_CTX_set0_param(X509_STORE_CTX *ctx, X509_VERIFY_PARAM *param);
26 int X509_STORE_CTX_set_default(X509_STORE_CTX *ctx, const char *name);
30 These functions initialise an B<X509_STORE_CTX> structure for subsequent use
31 by X509_verify_cert().
33 X509_STORE_CTX_new() returns a newly initialised B<X509_STORE_CTX> structure.
35 X509_STORE_CTX_cleanup() internally cleans up an B<X509_STORE_CTX> structure.
36 The context can then be reused with an new call to X509_STORE_CTX_init().
38 X509_STORE_CTX_free() completely frees up B<ctx>. After this call B<ctx>
41 X509_STORE_CTX_init() sets up B<ctx> for a subsequent verification operation.
42 It must be called before each call to X509_verify_cert(), i.e. a B<ctx> is only
43 good for one call to X509_verify_cert(); if you want to verify a second
44 certificate with the same B<ctx> then you must call X509_STORE_CTX_cleanup()
45 and then X509_STORE_CTX_init() again before the second call to
46 X509_verify_cert(). The trusted certificate store is set to B<store>, the end
47 entity certificate to be verified is set to B<x509> and a set of additional
48 certificates (which will be untrusted but may be used to build the chain) in
49 B<chain>. Any or all of the B<store>, B<x509> and B<chain> parameters can be
52 X509_STORE_CTX_trusted_stack() sets the set of trusted certificates of B<ctx>
53 to B<sk>. This is an alternative way of specifying trusted certificates
54 instead of using an B<X509_STORE>.
56 X509_STORE_CTX_set_cert() sets the certificate to be vertified in B<ctx> to
59 X509_STORE_CTX_set_chain() sets the additional certificate chain used by B<ctx>
62 X509_STORE_CTX_set0_crls() sets a set of CRLs to use to aid certificate
63 verification to B<sk>. These CRLs will only be used if CRL verification is
64 enabled in the associated B<X509_VERIFY_PARAM> structure. This might be
65 used where additional "useful" CRLs are supplied as part of a protocol,
66 for example in a PKCS#7 structure.
68 X509_VERIFY_PARAM *X509_STORE_CTX_get0_param() retrieves an intenal pointer
69 to the verification parameters associated with B<ctx>.
71 X509_STORE_CTX_set0_param() sets the intenal verification parameter pointer
72 to B<param>. After this call B<param> should not be used.
74 X509_STORE_CTX_set_default() looks up and sets the default verification
75 method to B<name>. This uses the function X509_VERIFY_PARAM_lookup() to
76 find an appropriate set of parameters from B<name>.
80 The certificates and CRLs in a store are used internally and should B<not>
81 be freed up until after the associated B<X509_STORE_CTX> is freed. Legacy
82 applications might implicitly use an B<X509_STORE_CTX> like this:
85 X509_STORE_CTX_init(&ctx, store, cert, chain);
87 this is B<not> recommended in new applications they should instead do:
90 ctx = X509_STORE_CTX_new();
93 X509_STORE_CTX_init(ctx, store, cert, chain);
97 The certificates and CRLs in a context are used internally and should B<not>
98 be freed up until after the associated B<X509_STORE_CTX> is freed. Copies
99 should be made or reference counts increased instead.
103 X509_STORE_CTX_new() returns an newly allocates context or B<NULL> is an
106 X509_STORE_CTX_init() returns 1 for success or 0 if an error occurred.
108 X509_STORE_CTX_get0_param() returns a pointer to an B<X509_VERIFY_PARAM>
109 structure or B<NULL> if an error occurred.
111 X509_STORE_CTX_cleanup(), X509_STORE_CTX_free(), X509_STORE_CTX_trusted_stack(),
112 X509_STORE_CTX_set_cert(), X509_STORE_CTX_set_chain(),
113 X509_STORE_CTX_set0_crls() and X509_STORE_CTX_set0_param() do not return
116 X509_STORE_CTX_set_default() returns 1 for success or 0 if an error occurred.
120 L<X509_verify_cert(3)|X509_verify_cert(3)>
121 L<X509_VERIFY_PARAM_set_flags(3)|X509_VERIFY_PARAM_set_flags(3)>
125 X509_STORE_CTX_set0_crls() was first added to OpenSSL 1.0.0