X509_STORE_CTX_new.pod revision 325335 
1=pod
2
3=head1 NAME
4
5X509_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
6
7=head1 SYNOPSIS
8
9 #include <openssl/x509_vfy.h>
10
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);
14
15 int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
16			 X509 *x509, STACK_OF(X509) *chain);
17
18 void X509_STORE_CTX_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
19
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);
23
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);
27
28=head1 DESCRIPTION
29
30These functions initialise an B<X509_STORE_CTX> structure for subsequent use
31by X509_verify_cert().
32
33X509_STORE_CTX_new() returns a newly initialised B<X509_STORE_CTX> structure.
34
35X509_STORE_CTX_cleanup() internally cleans up an B<X509_STORE_CTX> structure.
36The context can then be reused with an new call to X509_STORE_CTX_init().
37
38X509_STORE_CTX_free() completely frees up B<ctx>. After this call B<ctx>
39is no longer valid.
40
41X509_STORE_CTX_init() sets up B<ctx> for a subsequent verification operation.
42It must be called before each call to X509_verify_cert(), i.e. a B<ctx> is only
43good for one call to X509_verify_cert(); if you want to verify a second
44certificate with the same B<ctx> then you must call X509_STORE_CTX_cleanup()
45and then X509_STORE_CTX_init() again before the second call to
46X509_verify_cert(). The trusted certificate store is set to B<store>, the end
47entity certificate to be verified is set to B<x509> and a set of additional
48certificates (which will be untrusted but may be used to build the chain) in
49B<chain>. Any or all of the B<store>, B<x509> and B<chain> parameters can be
50B<NULL>.
51
52X509_STORE_CTX_trusted_stack() sets the set of trusted certificates of B<ctx>
53to B<sk>. This is an alternative way of specifying trusted certificates 
54instead of using an B<X509_STORE>.
55
56X509_STORE_CTX_set_cert() sets the certificate to be vertified in B<ctx> to
57B<x>.
58
59X509_STORE_CTX_set_chain() sets the additional certificate chain used by B<ctx>
60to B<sk>.
61
62X509_STORE_CTX_set0_crls() sets a set of CRLs to use to aid certificate
63verification to B<sk>. These CRLs will only be used if CRL verification is
64enabled in the associated B<X509_VERIFY_PARAM> structure. This might be
65used where additional "useful" CRLs are supplied as part of a protocol,
66for example in a PKCS#7 structure.
67
68X509_VERIFY_PARAM *X509_STORE_CTX_get0_param() retrieves an intenal pointer
69to the verification parameters associated with B<ctx>.
70
71X509_STORE_CTX_set0_param() sets the intenal verification parameter pointer
72to B<param>. After this call B<param> should not be used.
73
74X509_STORE_CTX_set_default() looks up and sets the default verification
75method to B<name>. This uses the function X509_VERIFY_PARAM_lookup() to
76find an appropriate set of parameters from B<name>.
77
78=head1 NOTES
79
80The certificates and CRLs in a store are used internally and should B<not>
81be freed up until after the associated B<X509_STORE_CTX> is freed. Legacy
82applications might implicitly use an B<X509_STORE_CTX> like this:
83
84  X509_STORE_CTX ctx;
85  X509_STORE_CTX_init(&ctx, store, cert, chain);
86
87this is B<not> recommended in new applications they should instead do:
88
89  X509_STORE_CTX *ctx;
90  ctx = X509_STORE_CTX_new();
91  if (ctx == NULL)
92	/* Bad error */
93  X509_STORE_CTX_init(ctx, store, cert, chain);
94
95=head1 BUGS
96
97The certificates and CRLs in a context are used internally and should B<not>
98be freed up until after the associated B<X509_STORE_CTX> is freed. Copies
99should be made or reference counts increased instead.
100
101=head1 RETURN VALUES
102
103X509_STORE_CTX_new() returns an newly allocates context or B<NULL> is an
104error occurred.
105
106X509_STORE_CTX_init() returns 1 for success or 0 if an error occurred.
107
108X509_STORE_CTX_get0_param() returns a pointer to an B<X509_VERIFY_PARAM>
109structure or B<NULL> if an error occurred.
110
111X509_STORE_CTX_cleanup(), X509_STORE_CTX_free(), X509_STORE_CTX_trusted_stack(),
112X509_STORE_CTX_set_cert(), X509_STORE_CTX_set_chain(),
113X509_STORE_CTX_set0_crls() and X509_STORE_CTX_set0_param() do not return
114values.
115
116X509_STORE_CTX_set_default() returns 1 for success or 0 if an error occurred.
117
118=head1 SEE ALSO
119
120L<X509_verify_cert(3)|X509_verify_cert(3)>
121L<X509_VERIFY_PARAM_set_flags(3)|X509_VERIFY_PARAM_set_flags(3)>
122
123=head1 HISTORY
124
125X509_STORE_CTX_set0_crls() was first added to OpenSSL 1.0.0
126
127=cut
128