1 /* crypto/x509/x509_vfy.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
60 #include <openssl/x509.h>
61 /* openssl/x509.h ends up #include-ing this file at about the only
62 * appropriate moment. */
65 #ifndef HEADER_X509_VFY_H
66 #define HEADER_X509_VFY_H
68 #ifndef OPENSSL_NO_LHASH
69 #include <openssl/lhash.h>
71 #include <openssl/bio.h>
72 #include <openssl/crypto.h>
73 #include <openssl/symhacks.h>
80 typedef struct x509_hash_dir_st
88 typedef struct x509_file_st
90 int num_paths; /* number of paths to files or directories */
92 char **paths; /* the list of paths or directories */
96 /*******************************/
104 SSL -> X509_STORE_CTX
107 The X509_STORE holds the tables etc for verification stuff.
108 A X509_STORE_CTX is used while validating a single certificate.
109 The X509_STORE has X509_LOOKUPs for looking up certs.
110 The X509_STORE then calls a function to actually verify the
114 #define X509_LU_RETRY -1
115 #define X509_LU_FAIL 0
116 #define X509_LU_X509 1
117 #define X509_LU_CRL 2
118 #define X509_LU_PKEY 3
120 typedef struct x509_object_st
122 /* one of the above types */
132 typedef struct x509_lookup_st X509_LOOKUP;
134 DECLARE_STACK_OF(X509_LOOKUP)
135 DECLARE_STACK_OF(X509_OBJECT)
137 /* This is a static that defines the function interface */
138 typedef struct x509_lookup_method_st
141 int (*new_item)(X509_LOOKUP *ctx);
142 void (*free)(X509_LOOKUP *ctx);
143 int (*init)(X509_LOOKUP *ctx);
144 int (*shutdown)(X509_LOOKUP *ctx);
145 int (*ctrl)(X509_LOOKUP *ctx,int cmd,const char *argc,long argl,
147 int (*get_by_subject)(X509_LOOKUP *ctx,int type,X509_NAME *name,
149 int (*get_by_issuer_serial)(X509_LOOKUP *ctx,int type,X509_NAME *name,
150 ASN1_INTEGER *serial,X509_OBJECT *ret);
151 int (*get_by_fingerprint)(X509_LOOKUP *ctx,int type,
152 unsigned char *bytes,int len,
154 int (*get_by_alias)(X509_LOOKUP *ctx,int type,char *str,int len,
156 } X509_LOOKUP_METHOD;
158 /* This is used to hold everything. It is used for all certificate
159 * validation. Once we have a certificate chain, the 'verify'
160 * function is then called to actually check the cert chain. */
163 /* The following is a cache of trusted certs */
164 int cache; /* if true, stash any hits */
165 STACK_OF(X509_OBJECT) *objs; /* Cache of all objects */
167 /* These are external lookup methods */
168 STACK_OF(X509_LOOKUP) *get_cert_methods;
170 /* The following fields are not used by X509_STORE but are
171 * inherited by X509_STORE_CTX when it is initialised.
174 unsigned long flags; /* Various verify flags */
177 /* Callbacks for various operations */
178 int (*verify)(X509_STORE_CTX *ctx); /* called to verify a certificate */
179 int (*verify_cb)(int ok,X509_STORE_CTX *ctx); /* error callback */
180 int (*get_issuer)(X509 **issuer, X509_STORE_CTX *ctx, X509 *x); /* get issuers cert from ctx */
181 int (*check_issued)(X509_STORE_CTX *ctx, X509 *x, X509 *issuer); /* check issued */
182 int (*check_revocation)(X509_STORE_CTX *ctx); /* Check revocation status of chain */
183 int (*get_crl)(X509_STORE_CTX *ctx, X509_CRL **crl, X509 *x); /* retrieve CRL */
184 int (*check_crl)(X509_STORE_CTX *ctx, X509_CRL *crl); /* Check CRL validity */
185 int (*cert_crl)(X509_STORE_CTX *ctx, X509_CRL *crl, X509 *x); /* Check certificate against CRL */
186 int (*cleanup)(X509_STORE_CTX *ctx);
188 CRYPTO_EX_DATA ex_data;
190 int depth; /* how deep to look (still unused -- X509_STORE_CTX's depth is used) */
193 #define X509_STORE_set_depth(ctx,d) ((ctx)->depth=(d))
195 #define X509_STORE_set_verify_cb_func(ctx,func) ((ctx)->verify_cb=(func))
196 #define X509_STORE_set_verify_func(ctx,func) ((ctx)->verify=(func))
198 /* This is the functions plus an instance of the local variables. */
199 struct x509_lookup_st
201 int init; /* have we been started */
202 int skip; /* don't use us. */
203 X509_LOOKUP_METHOD *method; /* the functions */
204 char *method_data; /* method data */
206 X509_STORE *store_ctx; /* who owns us */
209 /* This is a used when verifying cert chains. Since the
210 * gathering of the cert chain can take some time (and have to be
211 * 'retried', this needs to be kept and passed around. */
212 struct x509_store_ctx_st /* X509_STORE_CTX */
215 int current_method; /* used when looking up certs */
217 /* The following are set by the caller */
218 X509 *cert; /* The cert to check */
219 STACK_OF(X509) *untrusted; /* chain of X509s - untrusted - passed in */
220 int purpose; /* purpose to check untrusted certificates */
221 int trust; /* trust setting to check */
222 time_t check_time; /* time to make verify at */
223 unsigned long flags; /* Various verify flags */
224 void *other_ctx; /* Other info for use with get_issuer() */
226 /* Callbacks for various operations */
227 int (*verify)(X509_STORE_CTX *ctx); /* called to verify a certificate */
228 int (*verify_cb)(int ok,X509_STORE_CTX *ctx); /* error callback */
229 int (*get_issuer)(X509 **issuer, X509_STORE_CTX *ctx, X509 *x); /* get issuers cert from ctx */
230 int (*check_issued)(X509_STORE_CTX *ctx, X509 *x, X509 *issuer); /* check issued */
231 int (*check_revocation)(X509_STORE_CTX *ctx); /* Check revocation status of chain */
232 int (*get_crl)(X509_STORE_CTX *ctx, X509_CRL **crl, X509 *x); /* retrieve CRL */
233 int (*check_crl)(X509_STORE_CTX *ctx, X509_CRL *crl); /* Check CRL validity */
234 int (*cert_crl)(X509_STORE_CTX *ctx, X509_CRL *crl, X509 *x); /* Check certificate against CRL */
235 int (*cleanup)(X509_STORE_CTX *ctx);
237 /* The following is built up */
238 int depth; /* how far to go looking up certs */
239 int valid; /* if 0, rebuild chain */
240 int last_untrusted; /* index of last untrusted cert */
241 STACK_OF(X509) *chain; /* chain of X509s - built up and trusted */
243 /* When something goes wrong, this is why */
247 X509 *current_issuer; /* cert currently being tested as valid issuer */
248 X509_CRL *current_crl; /* current CRL */
250 CRYPTO_EX_DATA ex_data;
251 } /* X509_STORE_CTX */;
253 #define X509_STORE_CTX_set_depth(ctx,d) ((ctx)->depth=(d))
255 #define X509_STORE_CTX_set_app_data(ctx,data) \
256 X509_STORE_CTX_set_ex_data(ctx,0,data)
257 #define X509_STORE_CTX_get_app_data(ctx) \
258 X509_STORE_CTX_get_ex_data(ctx,0)
260 #define X509_L_FILE_LOAD 1
261 #define X509_L_ADD_DIR 2
263 #define X509_LOOKUP_load_file(x,name,type) \
264 X509_LOOKUP_ctrl((x),X509_L_FILE_LOAD,(name),(long)(type),NULL)
266 #define X509_LOOKUP_add_dir(x,name,type) \
267 X509_LOOKUP_ctrl((x),X509_L_ADD_DIR,(name),(long)(type),NULL)
270 /* illegal error (for uninitialized values, to avoid X509_V_OK): 1 */
272 #define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT 2
273 #define X509_V_ERR_UNABLE_TO_GET_CRL 3
274 #define X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE 4
275 #define X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE 5
276 #define X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY 6
277 #define X509_V_ERR_CERT_SIGNATURE_FAILURE 7
278 #define X509_V_ERR_CRL_SIGNATURE_FAILURE 8
279 #define X509_V_ERR_CERT_NOT_YET_VALID 9
280 #define X509_V_ERR_CERT_HAS_EXPIRED 10
281 #define X509_V_ERR_CRL_NOT_YET_VALID 11
282 #define X509_V_ERR_CRL_HAS_EXPIRED 12
283 #define X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD 13
284 #define X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD 14
285 #define X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD 15
286 #define X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD 16
287 #define X509_V_ERR_OUT_OF_MEM 17
288 #define X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT 18
289 #define X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN 19
290 #define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY 20
291 #define X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE 21
292 #define X509_V_ERR_CERT_CHAIN_TOO_LONG 22
293 #define X509_V_ERR_CERT_REVOKED 23
294 #define X509_V_ERR_INVALID_CA 24
295 #define X509_V_ERR_PATH_LENGTH_EXCEEDED 25
296 #define X509_V_ERR_INVALID_PURPOSE 26
297 #define X509_V_ERR_CERT_UNTRUSTED 27
298 #define X509_V_ERR_CERT_REJECTED 28
299 /* These are 'informational' when looking for issuer cert */
300 #define X509_V_ERR_SUBJECT_ISSUER_MISMATCH 29
301 #define X509_V_ERR_AKID_SKID_MISMATCH 30
302 #define X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH 31
303 #define X509_V_ERR_KEYUSAGE_NO_CERTSIGN 32
305 #define X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER 33
307 /* The application is not happy */
308 #define X509_V_ERR_APPLICATION_VERIFICATION 50
310 /* Certificate verify flags */
312 #define X509_V_FLAG_CB_ISSUER_CHECK 0x1 /* Send issuer+subject checks to verify_cb */
313 #define X509_V_FLAG_USE_CHECK_TIME 0x2 /* Use check time instead of current time */
314 #define X509_V_FLAG_CRL_CHECK 0x4 /* Lookup CRLs */
315 #define X509_V_FLAG_CRL_CHECK_ALL 0x8 /* Lookup CRLs for whole chain */
317 int X509_OBJECT_idx_by_subject(STACK_OF(X509_OBJECT) *h, int type,
319 X509_OBJECT *X509_OBJECT_retrieve_by_subject(STACK_OF(X509_OBJECT) *h,int type,X509_NAME *name);
320 X509_OBJECT *X509_OBJECT_retrieve_match(STACK_OF(X509_OBJECT) *h, X509_OBJECT *x);
321 void X509_OBJECT_up_ref_count(X509_OBJECT *a);
322 void X509_OBJECT_free_contents(X509_OBJECT *a);
323 X509_STORE *X509_STORE_new(void );
324 void X509_STORE_free(X509_STORE *v);
326 void X509_STORE_set_flags(X509_STORE *ctx, long flags);
327 int X509_STORE_set_purpose(X509_STORE *ctx, int purpose);
328 int X509_STORE_set_trust(X509_STORE *ctx, int trust);
330 X509_STORE_CTX *X509_STORE_CTX_new(void);
332 int X509_STORE_CTX_get1_issuer(X509 **issuer, X509_STORE_CTX *ctx, X509 *x);
334 void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
335 void X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
336 X509 *x509, STACK_OF(X509) *chain);
337 void X509_STORE_CTX_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
338 void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
340 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m);
342 X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void);
343 X509_LOOKUP_METHOD *X509_LOOKUP_file(void);
345 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x);
346 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x);
348 int X509_STORE_get_by_subject(X509_STORE_CTX *vs,int type,X509_NAME *name,
351 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc,
352 long argl, char **ret);
354 #ifndef OPENSSL_NO_STDIO
355 int X509_load_cert_file(X509_LOOKUP *ctx, const char *file, int type);
356 int X509_load_crl_file(X509_LOOKUP *ctx, const char *file, int type);
357 int X509_load_cert_crl_file(X509_LOOKUP *ctx, const char *file, int type);
361 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method);
362 void X509_LOOKUP_free(X509_LOOKUP *ctx);
363 int X509_LOOKUP_init(X509_LOOKUP *ctx);
364 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
366 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
367 ASN1_INTEGER *serial, X509_OBJECT *ret);
368 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
369 unsigned char *bytes, int len, X509_OBJECT *ret);
370 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str,
371 int len, X509_OBJECT *ret);
372 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx);
374 #ifndef OPENSSL_NO_STDIO
375 int X509_STORE_load_locations (X509_STORE *ctx,
376 const char *file, const char *dir);
377 int X509_STORE_set_default_paths(X509_STORE *ctx);
380 int X509_STORE_CTX_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
381 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
382 int X509_STORE_CTX_set_ex_data(X509_STORE_CTX *ctx,int idx,void *data);
383 void * X509_STORE_CTX_get_ex_data(X509_STORE_CTX *ctx,int idx);
384 int X509_STORE_CTX_get_error(X509_STORE_CTX *ctx);
385 void X509_STORE_CTX_set_error(X509_STORE_CTX *ctx,int s);
386 int X509_STORE_CTX_get_error_depth(X509_STORE_CTX *ctx);
387 X509 * X509_STORE_CTX_get_current_cert(X509_STORE_CTX *ctx);
388 STACK_OF(X509) *X509_STORE_CTX_get_chain(X509_STORE_CTX *ctx);
389 STACK_OF(X509) *X509_STORE_CTX_get1_chain(X509_STORE_CTX *ctx);
390 void X509_STORE_CTX_set_cert(X509_STORE_CTX *c,X509 *x);
391 void X509_STORE_CTX_set_chain(X509_STORE_CTX *c,STACK_OF(X509) *sk);
392 int X509_STORE_CTX_set_purpose(X509_STORE_CTX *ctx, int purpose);
393 int X509_STORE_CTX_set_trust(X509_STORE_CTX *ctx, int trust);
394 int X509_STORE_CTX_purpose_inherit(X509_STORE_CTX *ctx, int def_purpose,
395 int purpose, int trust);
396 void X509_STORE_CTX_set_flags(X509_STORE_CTX *ctx, long flags);
397 void X509_STORE_CTX_set_time(X509_STORE_CTX *ctx, long flags, time_t t);
398 void X509_STORE_CTX_set_verify_cb(X509_STORE_CTX *ctx,
399 int (*verify_cb)(int, X509_STORE_CTX *));