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.]
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
79
typedef struct x509_hash_dir_st
87
typedef struct x509_file_st
89
int num_paths; /* number of paths to files or directories */
91
char **paths; /* the list of paths or directories */
95
/*******************************/
103
SSL -> X509_STORE_CTX
106
The X509_STORE holds the tables etc for verification stuff.
107
A X509_STORE_CTX is used while validating a single certificate.
108
The X509_STORE has X509_LOOKUPs for looking up certs.
109
The X509_STORE then calls a function to actually verify the
113
#define X509_LU_RETRY -1
114
#define X509_LU_FAIL 0
115
#define X509_LU_X509 1
116
#define X509_LU_CRL 2
117
#define X509_LU_PKEY 3
119
typedef struct x509_object_st
121
/* one of the above types */
131
typedef struct x509_lookup_st X509_LOOKUP;
133
DECLARE_STACK_OF(X509_LOOKUP)
134
DECLARE_STACK_OF(X509_OBJECT)
136
/* This is a static that defines the function interface */
137
typedef struct x509_lookup_method_st
140
int (*new_item)(X509_LOOKUP *ctx);
141
void (*free)(X509_LOOKUP *ctx);
142
int (*init)(X509_LOOKUP *ctx);
143
int (*shutdown)(X509_LOOKUP *ctx);
144
int (*ctrl)(X509_LOOKUP *ctx,int cmd,const char *argc,long argl,
146
int (*get_by_subject)(X509_LOOKUP *ctx,int type,X509_NAME *name,
148
int (*get_by_issuer_serial)(X509_LOOKUP *ctx,int type,X509_NAME *name,
149
ASN1_INTEGER *serial,X509_OBJECT *ret);
150
int (*get_by_fingerprint)(X509_LOOKUP *ctx,int type,
151
unsigned char *bytes,int len,
153
int (*get_by_alias)(X509_LOOKUP *ctx,int type,char *str,int len,
155
} X509_LOOKUP_METHOD;
157
typedef struct x509_store_ctx_st X509_STORE_CTX;
159
/* This is used to hold everything. It is used for all certificate
160
* validation. Once we have a certificate chain, the 'verify'
161
* function is then called to actually check the cert chain. */
162
typedef struct x509_store_st
164
/* The following is a cache of trusted certs */
165
int cache; /* if true, stash any hits */
166
STACK_OF(X509_OBJECT) *objs; /* Cache of all objects */
168
/* These are external lookup methods */
169
STACK_OF(X509_LOOKUP) *get_cert_methods;
170
int (*verify)(X509_STORE_CTX *ctx); /* called to verify a certificate */
171
int (*verify_cb)(int ok,X509_STORE_CTX *ctx); /* error callback */
173
CRYPTO_EX_DATA ex_data;
175
int depth; /* how deep to look (still unused -- X509_STORE_CTX's depth is used) */
178
#define X509_STORE_set_depth(ctx,d) ((ctx)->depth=(d))
180
#define X509_STORE_set_verify_cb_func(ctx,func) ((ctx)->verify_cb=(func))
181
#define X509_STORE_set_verify_func(ctx,func) ((ctx)->verify=(func))
183
/* This is the functions plus an instance of the local variables. */
184
struct x509_lookup_st
186
int init; /* have we been started */
187
int skip; /* don't use us. */
188
X509_LOOKUP_METHOD *method; /* the functions */
189
char *method_data; /* method data */
191
X509_STORE *store_ctx; /* who owns us */
194
/* This is a used when verifying cert chains. Since the
195
* gathering of the cert chain can take some time (and have to be
196
* 'retried', this needs to be kept and passed around. */
197
struct x509_store_ctx_st /* X509_STORE_CTX */
200
int current_method; /* used when looking up certs */
202
/* The following are set by the caller */
203
X509 *cert; /* The cert to check */
204
STACK_OF(X509) *untrusted; /* chain of X509s - untrusted - passed in */
205
int purpose; /* purpose to check untrusted certificates */
206
int trust; /* trust setting to check */
207
time_t check_time; /* time to make verify at */
208
unsigned long flags; /* Various verify flags */
209
void *other_ctx; /* Other info for use with get_issuer() */
211
/* Callbacks for various operations */
212
int (*verify)(X509_STORE_CTX *ctx); /* called to verify a certificate */
213
int (*verify_cb)(int ok,X509_STORE_CTX *ctx); /* error callback */
214
int (*get_issuer)(X509 **issuer, X509_STORE_CTX *ctx, X509 *x); /* get issuers cert from ctx */
215
int (*check_issued)(X509_STORE_CTX *ctx, X509 *x, X509 *issuer); /* check issued */
216
int (*cleanup)(X509_STORE_CTX *ctx);
218
/* The following is built up */
219
int depth; /* how far to go looking up certs */
220
int valid; /* if 0, rebuild chain */
221
int last_untrusted; /* index of last untrusted cert */
222
STACK_OF(X509) *chain; /* chain of X509s - built up and trusted */
224
/* When something goes wrong, this is why */
228
X509 *current_issuer; /* cert currently being tested as valid issuer */
230
CRYPTO_EX_DATA ex_data;
233
#define X509_STORE_CTX_set_depth(ctx,d) ((ctx)->depth=(d))
235
#define X509_STORE_CTX_set_app_data(ctx,data) \
236
X509_STORE_CTX_set_ex_data(ctx,0,data)
237
#define X509_STORE_CTX_get_app_data(ctx) \
238
X509_STORE_CTX_get_ex_data(ctx,0)
240
#define X509_L_FILE_LOAD 1
241
#define X509_L_ADD_DIR 2
243
#define X509_LOOKUP_load_file(x,name,type) \
244
X509_LOOKUP_ctrl((x),X509_L_FILE_LOAD,(name),(long)(type),NULL)
246
#define X509_LOOKUP_add_dir(x,name,type) \
247
X509_LOOKUP_ctrl((x),X509_L_ADD_DIR,(name),(long)(type),NULL)
250
/* illegal error (for uninitialized values, to avoid X509_V_OK): 1 */
252
#define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT 2
253
#define X509_V_ERR_UNABLE_TO_GET_CRL 3
254
#define X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE 4
255
#define X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE 5
256
#define X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY 6
257
#define X509_V_ERR_CERT_SIGNATURE_FAILURE 7
258
#define X509_V_ERR_CRL_SIGNATURE_FAILURE 8
259
#define X509_V_ERR_CERT_NOT_YET_VALID 9
260
#define X509_V_ERR_CERT_HAS_EXPIRED 10
261
#define X509_V_ERR_CRL_NOT_YET_VALID 11
262
#define X509_V_ERR_CRL_HAS_EXPIRED 12
263
#define X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD 13
264
#define X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD 14
265
#define X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD 15
266
#define X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD 16
267
#define X509_V_ERR_OUT_OF_MEM 17
268
#define X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT 18
269
#define X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN 19
270
#define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY 20
271
#define X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE 21
272
#define X509_V_ERR_CERT_CHAIN_TOO_LONG 22
273
#define X509_V_ERR_CERT_REVOKED 23
274
#define X509_V_ERR_INVALID_CA 24
275
#define X509_V_ERR_PATH_LENGTH_EXCEEDED 25
276
#define X509_V_ERR_INVALID_PURPOSE 26
277
#define X509_V_ERR_CERT_UNTRUSTED 27
278
#define X509_V_ERR_CERT_REJECTED 28
279
/* These are 'informational' when looking for issuer cert */
280
#define X509_V_ERR_SUBJECT_ISSUER_MISMATCH 29
281
#define X509_V_ERR_AKID_SKID_MISMATCH 30
282
#define X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH 31
283
#define X509_V_ERR_KEYUSAGE_NO_CERTSIGN 32
285
/* The application is not happy */
286
#define X509_V_ERR_APPLICATION_VERIFICATION 50
288
/* Certificate verify flags */
290
#define X509_V_FLAG_CB_ISSUER_CHECK 0x1 /* Send issuer+subject checks to verify_cb */
291
#define X509_V_FLAG_USE_CHECK_TIME 0x2 /* Use check time instead of current time */
293
/* These functions are being redefined in another directory,
294
and clash when the linker is case-insensitive, so let's
295
hide them a little, by giving them an extra 'o' at the
296
beginning of the name... */
298
#undef X509v3_cleanup_extensions
299
#define X509v3_cleanup_extensions oX509v3_cleanup_extensions
300
#undef X509v3_add_extension
301
#define X509v3_add_extension oX509v3_add_extension
302
#undef X509v3_add_netscape_extensions
303
#define X509v3_add_netscape_extensions oX509v3_add_netscape_extensions
304
#undef X509v3_add_standard_extensions
305
#define X509v3_add_standard_extensions oX509v3_add_standard_extensions
308
int X509_OBJECT_idx_by_subject(STACK_OF(X509_OBJECT) *h, int type,
310
X509_OBJECT *X509_OBJECT_retrieve_by_subject(STACK_OF(X509_OBJECT) *h,int type,X509_NAME *name);
311
X509_OBJECT *X509_OBJECT_retrieve_match(STACK_OF(X509_OBJECT) *h, X509_OBJECT *x);
312
void X509_OBJECT_up_ref_count(X509_OBJECT *a);
313
void X509_OBJECT_free_contents(X509_OBJECT *a);
314
X509_STORE *X509_STORE_new(void );
315
void X509_STORE_free(X509_STORE *v);
317
X509_STORE_CTX *X509_STORE_CTX_new(void);
319
int X509_STORE_CTX_get1_issuer(X509 **issuer, X509_STORE_CTX *ctx, X509 *x);
321
void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
322
void X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
323
X509 *x509, STACK_OF(X509) *chain);
324
void X509_STORE_CTX_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
325
void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
327
X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m);
329
X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void);
330
X509_LOOKUP_METHOD *X509_LOOKUP_file(void);
332
int X509_STORE_add_cert(X509_STORE *ctx, X509 *x);
333
int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x);
335
int X509_STORE_get_by_subject(X509_STORE_CTX *vs,int type,X509_NAME *name,
338
int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc,
339
long argl, char **ret);
342
int X509_load_cert_file(X509_LOOKUP *ctx, const char *file, int type);
343
int X509_load_crl_file(X509_LOOKUP *ctx, const char *file, int type);
344
int X509_load_cert_crl_file(X509_LOOKUP *ctx, const char *file, int type);
348
X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method);
349
void X509_LOOKUP_free(X509_LOOKUP *ctx);
350
int X509_LOOKUP_init(X509_LOOKUP *ctx);
351
int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
353
int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
354
ASN1_INTEGER *serial, X509_OBJECT *ret);
355
int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
356
unsigned char *bytes, int len, X509_OBJECT *ret);
357
int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str,
358
int len, X509_OBJECT *ret);
359
int X509_LOOKUP_shutdown(X509_LOOKUP *ctx);
362
int X509_STORE_load_locations (X509_STORE *ctx,
363
const char *file, const char *dir);
364
int X509_STORE_set_default_paths(X509_STORE *ctx);
367
int X509_STORE_CTX_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
368
CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
369
int X509_STORE_CTX_set_ex_data(X509_STORE_CTX *ctx,int idx,void *data);
370
void * X509_STORE_CTX_get_ex_data(X509_STORE_CTX *ctx,int idx);
371
int X509_STORE_CTX_get_error(X509_STORE_CTX *ctx);
372
void X509_STORE_CTX_set_error(X509_STORE_CTX *ctx,int s);
373
int X509_STORE_CTX_get_error_depth(X509_STORE_CTX *ctx);
374
X509 * X509_STORE_CTX_get_current_cert(X509_STORE_CTX *ctx);
375
STACK_OF(X509) *X509_STORE_CTX_get_chain(X509_STORE_CTX *ctx);
376
STACK_OF(X509) *X509_STORE_CTX_get1_chain(X509_STORE_CTX *ctx);
377
void X509_STORE_CTX_set_cert(X509_STORE_CTX *c,X509 *x);
378
void X509_STORE_CTX_set_chain(X509_STORE_CTX *c,STACK_OF(X509) *sk);
379
int X509_STORE_CTX_set_purpose(X509_STORE_CTX *ctx, int purpose);
380
int X509_STORE_CTX_set_trust(X509_STORE_CTX *ctx, int trust);
381
int X509_STORE_CTX_purpose_inherit(X509_STORE_CTX *ctx, int def_purpose,
382
int purpose, int trust);
383
void X509_STORE_CTX_set_flags(X509_STORE_CTX *ctx, long flags);
384
void X509_STORE_CTX_set_time(X509_STORE_CTX *ctx, long flags, time_t t);