Un-delete still documented X509_STORE_CTX_set_verify
[openssl.git] / doc / crypto / X509_STORE_CTX_new.pod
1 =pod
2
3 =head1 NAME
4
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_set_verify,
15 X509_STORE_CTX_get_verify - X509_STORE_CTX initialisation
16
17 =head1 SYNOPSIS
18
19  #include <openssl/x509_vfy.h>
20
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);
24
25  int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
26                          X509 *x509, STACK_OF(X509) *chain);
27
28  void X509_STORE_CTX_set0_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
29
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);
34
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);
38
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);
41
42  int X509_STORE_CTX_get_num_untrusted(X509_STORE_CTX *ctx);
43
44  typedef int (*X509_STORE_CTX_verify_fn)(X509_STORE_CTX *);
45  X509_STORE_CTX_verify_fn X509_STORE_CTX_get_verify(X509_STORE_CTX *ctx);
46  void X509_STORE_CTX_set_verify(X509_STORE_CTX *ctx, X509_STORE_CTX_verify_fn verify);
47
48  void X509_STORE_set_verify(X509_STORE *ctx, X509_STORE_CTX_verify verify);
49
50 =head1 DESCRIPTION
51
52 These functions initialise an B<X509_STORE_CTX> structure for subsequent use
53 by X509_verify_cert().
54
55 X509_STORE_CTX_new() returns a newly initialised B<X509_STORE_CTX> structure.
56
57 X509_STORE_CTX_cleanup() internally cleans up an B<X509_STORE_CTX> structure.
58 The context can then be reused with an new call to X509_STORE_CTX_init().
59
60 X509_STORE_CTX_free() completely frees up B<ctx>. After this call B<ctx>
61 is no longer valid.
62 If B<ctx> is NULL nothing is done.
63
64 X509_STORE_CTX_init() sets up B<ctx> for a subsequent verification operation.
65 It must be called before each call to X509_verify_cert(), i.e. a B<ctx> is only
66 good for one call to X509_verify_cert(); if you want to verify a second
67 certificate with the same B<ctx> then you must call X509_XTORE_CTX_cleanup()
68 and then X509_STORE_CTX_init() again before the second call to
69 X509_verify_cert(). The trusted certificate store is set to B<store>, the end
70 entity certificate to be verified is set to B<x509> and a set of additional
71 certificates (which will be untrusted but may be used to build the chain) in
72 B<chain>. Any or all of the B<store>, B<x509> and B<chain> parameters can be
73 B<NULL>.
74
75 X509_STORE_CTX_set0_trusted_stack() sets the set of trusted certificates of
76 B<ctx> to B<sk>. This is an alternative way of specifying trusted certificates
77 instead of using an B<X509_STORE>.
78
79 X509_STORE_CTX_set_cert() sets the certificate to be verified in B<ctx> to
80 B<x>.
81
82 X509_STORE_CTX_set0_verified_chain() sets the validated chain used
83 by B<ctx> to be B<chain>.
84 Ownership of the chain is transferred to B<ctx> and should not be
85 free'd by the caller.
86 X509_STORE_CTX_get0_chain() returns a the internal pointer used by the
87 B<ctx> that contains the validated chain.
88
89 X509_STORE_CTX_set0_crls() sets a set of CRLs to use to aid certificate
90 verification to B<sk>. These CRLs will only be used if CRL verification is
91 enabled in the associated B<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
96 to the verification parameters associated with B<ctx>.
97
98 X509_STORE_CTX_get0_untrusted() retrieves an internal pointer to the
99 stack of untrusted certificates associated with B<ctx>.
100
101 X509_STORE_CTX_set0_untrusted() sets the internal point to the stack
102 of untrusted certificates associated with B<ctx> to B<sk>.
103
104 X509_STORE_CTX_set0_param() sets the internal verification parameter pointer
105 to B<param>. After this call B<param> should not be used.
106
107 X509_STORE_CTX_set_default() looks up and sets the default verification
108 method to B<name>. This uses the function X509_VERIFY_PARAM_lookup() to
109 find an appropriate set of parameters from B<name>.
110
111 X509_STORE_CTX_get_num_untrusted() returns the number of untrusted certificates
112 that were used in building the chain following a call to X509_verify_cert().
113
114 X509_STORE_CTX_set_verify() provides the capability for overriding the default
115 verify function. This function is responsible for verifying chain signatures and
116 expiration times. X509_STORE_CTX_get_verify() obtains the current verify
117 function being used.
118
119 X509_STORE_set_verify() works in the same way as for X509_STORE_CTX_set_verify()
120 but sets the default verify function to be used by all X509_STORE_CTX objects
121 created for this X509_STORE.
122
123 A verify function is defined as an X509_STORE_CTX_verify type which has the
124 following signature:
125
126  int (*verify)(X509_STORE_CTX *);
127
128 This function should receive the current X509_STORE_CTX as a parameter and
129 return 1 on success or 0 on failure.
130
131 =head1 NOTES
132
133 The certificates and CRLs in a store are used internally and should B<not>
134 be freed up until after the associated B<X509_STORE_CTX> is freed.
135
136 =head1 BUGS
137
138 The certificates and CRLs in a context are used internally and should B<not>
139 be freed up until after the associated B<X509_STORE_CTX> is freed. Copies
140 should be made or reference counts increased instead.
141
142 =head1 RETURN VALUES
143
144 X509_STORE_CTX_new() returns an newly allocates context or B<NULL> is an
145 error occurred.
146
147 X509_STORE_CTX_init() returns 1 for success or 0 if an error occurred.
148
149 X509_STORE_CTX_get0_param() returns a pointer to an B<X509_VERIFY_PARAM>
150 structure or B<NULL> if an error occurred.
151
152 X509_STORE_CTX_cleanup(), X509_STORE_CTX_free(),
153 X509_STORE_CTX_set0_trusted_stack(),
154 X509_STORE_CTX_set_cert(),
155 X509_STORE_CTX_set0_crls() and X509_STORE_CTX_set0_param() do not return
156 values.
157
158 X509_STORE_CTX_set_default() returns 1 for success or 0 if an error occurred.
159
160 X509_STORE_CTX_get_num_untrusted() returns the number of untrusted certificates
161 used.
162
163 X509_STORE_CTX_get_verify() returns the current verify function in use for this
164 X509_STORE_CTX.
165
166 =head1 SEE ALSO
167
168 L<X509_verify_cert(3)>
169 L<X509_VERIFY_PARAM_set_flags(3)>
170
171 =head1 HISTORY
172
173 X509_STORE_CTX_set0_crls() was first added to OpenSSL 1.0.0
174 X509_STORE_CTX_get_num_untrusted() was first added to OpenSSL 1.1.0
175 X509_STORE_set_verify() was first added to OpenSSL 1.1.0. It was previously
176 available as a macro X509_STORE_set_verify_func(). This macro still exists but
177 simply calls this function.
178
179 =head1 COPYRIGHT
180
181 Copyright 2009-2016 The OpenSSL Project Authors. All Rights Reserved.
182
183 Licensed under the OpenSSL license (the "License").  You may not use
184 this file except in compliance with the License.  You can obtain a copy
185 in the file LICENSE in the source distribution or at
186 L<https://www.openssl.org/source/license.html>.
187
188 =cut