]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/x509/x509_vfy.h
Add support for VISIBLESTRING and UTF8String
[thirdparty/openssl.git] / crypto / x509 / x509_vfy.h
CommitLineData
d02b48c6 1/* crypto/x509/x509_vfy.h */
58964a49 2/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
d02b48c6
RE
3 * All rights reserved.
4 *
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.
8 *
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).
15 *
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.
22 *
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
25 * are met:
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)"
40 *
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
51 * SUCH DAMAGE.
52 *
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.]
57 */
58
59#ifndef HEADER_X509_VFY_H
60#define HEADER_X509_VFY_H
61
62#ifdef __cplusplus
63extern "C" {
64#endif
65
58964a49
RE
66#include "bio.h"
67#include "crypto.h"
68
d02b48c6
RE
69/* Outer object */
70typedef struct x509_hash_dir_st
71 {
72 int num_dirs;
73 char **dirs;
74 int *dirs_type;
75 int num_dirs_alloced;
76 } X509_HASH_DIR_CTX;
77
78typedef struct x509_file_st
79 {
80 int num_paths; /* number of paths to files or directories */
81 int num_alloced;
82 char **paths; /* the list of paths or directories */
83 int *path_type;
84 } X509_CERT_FILE_CTX;
85
86/*******************************/
87/*
88SSL_CTX -> X509_STORE
89 -> X509_LOOKUP
90 ->X509_LOOKUP_METHOD
91 -> X509_LOOKUP
92 ->X509_LOOKUP_METHOD
93
94SSL -> X509_STORE_CTX
95 ->X509_STORE
96
97The X509_STORE holds the tables etc for verification stuff.
98A X509_STORE_CTX is used while validating a single certificate.
99The X509_STORE has X509_LOOKUPs for looking up certs.
100The X509_STORE then calls a function to actually verify the
101certificate chain.
102*/
103
104#define X509_LU_RETRY -1
105#define X509_LU_FAIL 0
106#define X509_LU_X509 1
107#define X509_LU_CRL 2
108#define X509_LU_PKEY 3
109
110typedef struct x509_object_st
111 {
112 /* one of the above types */
113 int type;
114 union {
115 char *ptr;
116 X509 *x509;
117 X509_CRL *crl;
118 EVP_PKEY *pkey;
119 } data;
120 } X509_OBJECT;
121
a6801a91
BL
122typedef struct x509_lookup_st X509_LOOKUP;
123
d02b48c6
RE
124/* This is a static that defines the function interface */
125typedef struct x509_lookup_method_st
126 {
127 char *name;
a6801a91
BL
128 int (*new_item)(X509_LOOKUP *ctx);
129 void (*free)(X509_LOOKUP *ctx);
130 int (*init)(X509_LOOKUP *ctx);
131 int (*shutdown)(X509_LOOKUP *ctx);
132 int (*ctrl)(X509_LOOKUP *ctx,int cmd,char *argc,long argl,char **ret);
133 int (*get_by_subject)(X509_LOOKUP *ctx,int type,X509_NAME *name,
134 X509_OBJECT *ret);
135 int (*get_by_issuer_serial)(X509_LOOKUP *ctx,int type,X509_NAME *name,
136 ASN1_INTEGER *serial,X509_OBJECT *ret);
137 int (*get_by_fingerprint)(X509_LOOKUP *ctx,int type,
138 unsigned char *bytes,int len,
139 X509_OBJECT *ret);
140 int (*get_by_alias)(X509_LOOKUP *ctx,int type,char *str,int len,
141 X509_OBJECT *ret);
d02b48c6
RE
142 } X509_LOOKUP_METHOD;
143
a6801a91
BL
144typedef struct x509_store_state_st X509_STORE_CTX;
145
d02b48c6
RE
146/* This is used to hold everything. It is used for all certificate
147 * validation. Once we have a certificate chain, the 'verify'
148 * function is then called to actually check the cert chain. */
149typedef struct x509_store_st
150 {
151 /* The following is a cache of trusted certs */
152 int cache; /* if true, stash any hits */
153#ifdef HEADER_LHASH_H
154 LHASH *certs; /* cached certs; */
155#else
156 char *certs;
157#endif
158
159 /* These are external lookup methods */
160 STACK *get_cert_methods;/* X509_LOOKUP */
a6801a91
BL
161 int (*verify)(X509_STORE_CTX *ctx); /* called to verify a certificate */
162 int (*verify_cb)(int ok,X509_STORE_CTX *ctx); /* error callback */
d02b48c6 163
58964a49 164 CRYPTO_EX_DATA ex_data;
d02b48c6 165 int references;
cb0f35d7 166 int depth; /* how deep to look (still unused) */
d02b48c6
RE
167 } X509_STORE;
168
58964a49 169#define X509_STORE_set_depth(ctx,d) ((ctx)->depth=(d))
d02b48c6
RE
170
171#define X509_STORE_set_verify_cb_func(ctx,func) ((ctx)->verify_cb=(func))
172#define X509_STORE_set_verify_func(ctx,func) ((ctx)->verify=(func))
173
174/* This is the functions plus an instance of the local variables. */
a6801a91 175struct x509_lookup_st
d02b48c6
RE
176 {
177 int init; /* have we been started */
178 int skip; /* don't use us. */
179 X509_LOOKUP_METHOD *method; /* the functions */
180 char *method_data; /* method data */
181
182 X509_STORE *store_ctx; /* who owns us */
a6801a91 183 };
d02b48c6
RE
184
185/* This is a temporary used when processing cert chains. Since the
186 * gathering of the cert chain can take some time (and have to be
187 * 'retried', this needs to be kept and passed around. */
a6801a91 188struct x509_store_state_st
d02b48c6
RE
189 {
190 X509_STORE *ctx;
191 int current_method; /* used when looking up certs */
192
193 /* The following are set by the caller */
194 X509 *cert; /* The cert to check */
f73e07cf 195 STACK_OF(X509) *untrusted; /* chain of X509s - untrusted - passed in */
d02b48c6
RE
196
197 /* The following is built up */
198 int depth; /* how far to go looking up certs */
199 int valid; /* if 0, rebuild chain */
200 int last_untrusted; /* index of last untrusted cert */
201 STACK *chain; /* chain of X509s - built up and trusted */
202
203 /* When something goes wrong, this is why */
204 int error_depth;
205 int error;
206 X509 *current_cert;
207
58964a49 208 CRYPTO_EX_DATA ex_data;
a6801a91 209 };
d02b48c6 210
58964a49
RE
211#define X509_STORE_CTX_set_app_data(ctx,data) \
212 X509_STORE_CTX_set_ex_data(ctx,0,data)
213#define X509_STORE_CTX_get_app_data(ctx) \
214 X509_STORE_CTX_get_ex_data(ctx,0)
d02b48c6
RE
215
216#define X509_L_FILE_LOAD 1
217#define X509_L_ADD_DIR 2
218
219X509_LOOKUP_METHOD *X509_LOOKUP_file();
220#define X509_LOOKUP_load_file(x,name,type) \
221 X509_LOOKUP_ctrl((x),X509_L_FILE_LOAD,(name),(long)(type),NULL)
222
223X509_LOOKUP_METHOD *X509_LOOKUP_dir();
224#define X509_LOOKUP_add_dir(x,name,type) \
225 X509_LOOKUP_ctrl((x),X509_L_ADD_DIR,(name),(long)(type),NULL)
226
227#define X509_V_OK 0
228
229#define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT 2
230#define X509_V_ERR_UNABLE_TO_GET_CRL 3
231#define X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE 4
232#define X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE 5
233#define X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY 6
234#define X509_V_ERR_CERT_SIGNATURE_FAILURE 7
235#define X509_V_ERR_CRL_SIGNATURE_FAILURE 8
236#define X509_V_ERR_CERT_NOT_YET_VALID 9
237#define X509_V_ERR_CERT_HAS_EXPIRED 10
238#define X509_V_ERR_CRL_NOT_YET_VALID 11
239#define X509_V_ERR_CRL_HAS_EXPIRED 12
240#define X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD 13
241#define X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD 14
58964a49
RE
242#define X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD 15
243#define X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD 16
d02b48c6
RE
244#define X509_V_ERR_OUT_OF_MEM 17
245#define X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT 18
246#define X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN 19
247#define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY 20
248#define X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE 21
249#define X509_V_ERR_CERT_CHAIN_TOO_LONG 22
58964a49
RE
250#define X509_V_ERR_CERT_REVOKED 23
251
252/* The application is not happy */
253#define X509_V_ERR_APPLICATION_VERIFICATION 50
d02b48c6
RE
254
255#ifndef NOPROTO
256#ifdef HEADER_LHASH_H
dfeab068 257X509_OBJECT *X509_OBJECT_retrieve_by_subject(LHASH *h,int type,X509_NAME *name);
d02b48c6
RE
258#endif
259void X509_OBJECT_up_ref_count(X509_OBJECT *a);
260void X509_OBJECT_free_contents(X509_OBJECT *a);
261X509_STORE *X509_STORE_new(void );
262void X509_STORE_free(X509_STORE *v);
263
264void X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
f73e07cf 265 X509 *x509, STACK_OF(X509) *chain);
d02b48c6
RE
266void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
267
268X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m);
269
270X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void);
271X509_LOOKUP_METHOD *X509_LOOKUP_file(void);
272
273int X509_STORE_add_cert(X509_STORE *ctx, X509 *x);
58964a49 274int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x);
d02b48c6
RE
275
276int X509_STORE_get_by_subject(X509_STORE_CTX *vs,int type,X509_NAME *name,
277 X509_OBJECT *ret);
278
279int X509_LOOKUP_ctrl(X509_LOOKUP *ctx,int cmd,char *argc,long argl,char **ret);
58964a49
RE
280
281#ifndef NO_STDIO
d02b48c6 282int X509_load_cert_file(X509_LOOKUP *ctx, char *file, int type);
58964a49
RE
283int X509_load_crl_file(X509_LOOKUP *ctx, char *file, int type);
284#endif
d02b48c6 285
d02b48c6
RE
286
287X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method);
288void X509_LOOKUP_free(X509_LOOKUP *ctx);
289int X509_LOOKUP_init(X509_LOOKUP *ctx);
290int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
291 X509_OBJECT *ret);
292int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
293 ASN1_INTEGER *serial, X509_OBJECT *ret);
294int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
295 unsigned char *bytes, int len, X509_OBJECT *ret);
296int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str,
297 int len, X509_OBJECT *ret);
298int X509_LOOKUP_shutdown(X509_LOOKUP *ctx);
299
58964a49 300#ifndef NO_STDIO
d02b48c6
RE
301int X509_STORE_load_locations (X509_STORE *ctx,
302 char *file, char *dir);
303int X509_STORE_set_default_paths(X509_STORE *ctx);
58964a49
RE
304#endif
305
306int X509_STORE_CTX_get_ex_new_index(long argl, char *argp, int (*new_func)(),
307 int (*dup_func)(), void (*free_func)());
c0035435
BL
308int X509_STORE_CTX_set_ex_data(X509_STORE_CTX *ctx,int idx,void *data);
309void * X509_STORE_CTX_get_ex_data(X509_STORE_CTX *ctx,int idx);
58964a49
RE
310int X509_STORE_CTX_get_error(X509_STORE_CTX *ctx);
311void X509_STORE_CTX_set_error(X509_STORE_CTX *ctx,int s);
312int X509_STORE_CTX_get_error_depth(X509_STORE_CTX *ctx);
313X509 * X509_STORE_CTX_get_current_cert(X509_STORE_CTX *ctx);
314STACK * X509_STORE_CTX_get_chain(X509_STORE_CTX *ctx);
315void X509_STORE_CTX_set_cert(X509_STORE_CTX *c,X509 *x);
f73e07cf 316void X509_STORE_CTX_set_chain(X509_STORE_CTX *c,STACK_OF(X509) *sk);
d02b48c6
RE
317
318#else
319
320#ifdef HEADER_LHASH_H
dfeab068 321X509_OBJECT *X509_OBJECT_retrieve_by_subject();
d02b48c6
RE
322#endif
323void X509_OBJECT_up_ref_count();
324void X509_OBJECT_free_contents();
325X509_STORE *X509_STORE_new();
326void X509_STORE_free();
327
328void X509_STORE_CTX_init();
329void X509_STORE_CTX_cleanup();
330
331X509_LOOKUP *X509_STORE_add_lookup();
332
333X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir();
334X509_LOOKUP_METHOD *X509_LOOKUP_file();
335
336int X509_STORE_add_cert();
58964a49 337int X509_STORE_add_crl();
d02b48c6
RE
338
339int X509_STORE_get_by_subject();
340
341int X509_LOOKUP_ctrl();
58964a49
RE
342
343#ifndef NO_STDIO
d02b48c6 344int X509_load_cert_file();
58964a49
RE
345int X509_load_crl_file();
346#endif
d02b48c6 347
d02b48c6
RE
348X509_LOOKUP *X509_LOOKUP_new();
349void X509_LOOKUP_free();
350int X509_LOOKUP_init();
351int X509_LOOKUP_by_subject();
352int X509_LOOKUP_by_issuer_serial();
353int X509_LOOKUP_by_fingerprint();
354int X509_LOOKUP_by_alias();
355int X509_LOOKUP_shutdown();
356
58964a49 357#ifndef NO_STDIO
d02b48c6
RE
358int X509_STORE_load_locations ();
359int X509_STORE_set_default_paths();
58964a49
RE
360#endif
361
dfeab068 362int X509_STORE_CTX_get_ex_new_index();
58964a49 363int X509_STORE_CTX_set_ex_data();
c0035435 364void * X509_STORE_CTX_get_ex_data();
58964a49
RE
365int X509_STORE_CTX_get_error();
366void X509_STORE_CTX_set_error();
367int X509_STORE_CTX_get_error_depth();
368X509 * X509_STORE_CTX_get_current_cert();
369STACK * X509_STORE_CTX_get_chain();
370void X509_STORE_CTX_set_cert();
371void X509_STORE_CTX_set_chain();
d02b48c6
RE
372
373#endif
374
375#ifdef __cplusplus
376}
377#endif
378#endif
379