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.]
59 #ifndef PROTO_AMISSL_H
60 #include <proto/amissl.h>
61 #endif /* PROTO_AMISSL_H */
64 #include <openssl/x509.h>
65 /* openssl/x509.h ends up #include-ing this file at about the only
66 * appropriate moment. */
69 #ifndef HEADER_X509_VFY_H
70 #define HEADER_X509_VFY_H
72 #ifndef OPENSSL_NO_LHASH
73 #include <openssl/lhash.h>
75 #include <openssl/bio.h>
76 #include <openssl/crypto.h>
77 #include <openssl/symhacks.h>
84 typedef struct x509_hash_dir_st
92 typedef struct x509_file_st
94 int num_paths
; /* number of paths to files or directories */
96 char **paths
; /* the list of paths or directories */
100 /*******************************/
102 SSL_CTX -> X509_STORE
108 SSL -> X509_STORE_CTX
111 The X509_STORE holds the tables etc for verification stuff.
112 A X509_STORE_CTX is used while validating a single certificate.
113 The X509_STORE has X509_LOOKUPs for looking up certs.
114 The X509_STORE then calls a function to actually verify the
118 #define X509_LU_RETRY -1
119 #define X509_LU_FAIL 0
120 #define X509_LU_X509 1
121 #define X509_LU_CRL 2
122 #define X509_LU_PKEY 3
124 typedef struct x509_object_st
126 /* one of the above types */
136 typedef struct x509_lookup_st X509_LOOKUP
;
138 DECLARE_STACK_OF(X509_LOOKUP
)
139 DECLARE_STACK_OF(X509_OBJECT
)
141 /* This is a static that defines the function interface */
142 typedef struct x509_lookup_method_st
145 int (*new_item
)(X509_LOOKUP
*ctx
);
146 void (*free
)(X509_LOOKUP
*ctx
);
147 int (*init
)(X509_LOOKUP
*ctx
);
148 int (*shutdown
)(X509_LOOKUP
*ctx
);
149 int (*ctrl
)(X509_LOOKUP
*ctx
,int cmd
,const char *argc
,long argl
,
151 int (*get_by_subject
)(X509_LOOKUP
*ctx
,int type
,X509_NAME
*name
,
153 int (*get_by_issuer_serial
)(X509_LOOKUP
*ctx
,int type
,X509_NAME
*name
,
154 ASN1_INTEGER
*serial
,X509_OBJECT
*ret
);
155 int (*get_by_fingerprint
)(X509_LOOKUP
*ctx
,int type
,
156 unsigned char *bytes
,int len
,
158 int (*get_by_alias
)(X509_LOOKUP
*ctx
,int type
,char *str
,int len
,
160 } X509_LOOKUP_METHOD
;
162 /* This is used to hold everything. It is used for all certificate
163 * validation. Once we have a certificate chain, the 'verify'
164 * function is then called to actually check the cert chain. */
167 /* The following is a cache of trusted certs */
168 int cache
; /* if true, stash any hits */
169 STACK_OF(X509_OBJECT
) *objs
; /* Cache of all objects */
171 /* These are external lookup methods */
172 STACK_OF(X509_LOOKUP
) *get_cert_methods
;
174 /* The following fields are not used by X509_STORE but are
175 * inherited by X509_STORE_CTX when it is initialised.
178 unsigned long flags
; /* Various verify flags */
181 /* Callbacks for various operations */
182 int (*verify
)(X509_STORE_CTX
*ctx
); /* called to verify a certificate */
183 int (*verify_cb
)(int ok
,X509_STORE_CTX
*ctx
); /* error callback */
184 int (*get_issuer
)(X509
**issuer
, X509_STORE_CTX
*ctx
, X509
*x
); /* get issuers cert from ctx */
185 int (*check_issued
)(X509_STORE_CTX
*ctx
, X509
*x
, X509
*issuer
); /* check issued */
186 int (*check_revocation
)(X509_STORE_CTX
*ctx
); /* Check revocation status of chain */
187 int (*get_crl
)(X509_STORE_CTX
*ctx
, X509_CRL
**crl
, X509
*x
); /* retrieve CRL */
188 int (*check_crl
)(X509_STORE_CTX
*ctx
, X509_CRL
*crl
); /* Check CRL validity */
189 int (*cert_crl
)(X509_STORE_CTX
*ctx
, X509_CRL
*crl
, X509
*x
); /* Check certificate against CRL */
190 int (*cleanup
)(X509_STORE_CTX
*ctx
);
192 CRYPTO_EX_DATA ex_data
;
194 int depth
; /* how deep to look (still unused -- X509_STORE_CTX's depth is used) */
197 #define X509_STORE_set_depth(ctx,d) ((ctx)->depth=(d))
199 #define X509_STORE_set_verify_cb_func(ctx,func) ((ctx)->verify_cb=(func))
200 #define X509_STORE_set_verify_func(ctx,func) ((ctx)->verify=(func))
202 /* This is the functions plus an instance of the local variables. */
203 struct x509_lookup_st
205 int init
; /* have we been started */
206 int skip
; /* don't use us. */
207 X509_LOOKUP_METHOD
*method
; /* the functions */
208 char *method_data
; /* method data */
210 X509_STORE
*store_ctx
; /* who owns us */
213 /* This is a used when verifying cert chains. Since the
214 * gathering of the cert chain can take some time (and have to be
215 * 'retried', this needs to be kept and passed around. */
216 struct x509_store_ctx_st
/* X509_STORE_CTX */
219 int current_method
; /* used when looking up certs */
221 /* The following are set by the caller */
222 X509
*cert
; /* The cert to check */
223 STACK_OF(X509
) *untrusted
; /* chain of X509s - untrusted - passed in */
224 int purpose
; /* purpose to check untrusted certificates */
225 int trust
; /* trust setting to check */
226 time_t check_time
; /* time to make verify at */
227 unsigned long flags
; /* Various verify flags */
228 void *other_ctx
; /* Other info for use with get_issuer() */
230 /* Callbacks for various operations */
231 int (*verify
)(X509_STORE_CTX
*ctx
); /* called to verify a certificate */
232 int (*verify_cb
)(int ok
,X509_STORE_CTX
*ctx
); /* error callback */
233 int (*get_issuer
)(X509
**issuer
, X509_STORE_CTX
*ctx
, X509
*x
); /* get issuers cert from ctx */
234 int (*check_issued
)(X509_STORE_CTX
*ctx
, X509
*x
, X509
*issuer
); /* check issued */
235 int (*check_revocation
)(X509_STORE_CTX
*ctx
); /* Check revocation status of chain */
236 int (*get_crl
)(X509_STORE_CTX
*ctx
, X509_CRL
**crl
, X509
*x
); /* retrieve CRL */
237 int (*check_crl
)(X509_STORE_CTX
*ctx
, X509_CRL
*crl
); /* Check CRL validity */
238 int (*cert_crl
)(X509_STORE_CTX
*ctx
, X509_CRL
*crl
, X509
*x
); /* Check certificate against CRL */
239 int (*cleanup
)(X509_STORE_CTX
*ctx
);
241 /* The following is built up */
242 int depth
; /* how far to go looking up certs */
243 int valid
; /* if 0, rebuild chain */
244 int last_untrusted
; /* index of last untrusted cert */
245 STACK_OF(X509
) *chain
; /* chain of X509s - built up and trusted */
247 /* When something goes wrong, this is why */
251 X509
*current_issuer
; /* cert currently being tested as valid issuer */
252 X509_CRL
*current_crl
; /* current CRL */
254 CRYPTO_EX_DATA ex_data
;
255 } /* X509_STORE_CTX */;
257 #define X509_STORE_CTX_set_depth(ctx,d) ((ctx)->depth=(d))
259 #define X509_STORE_CTX_set_app_data(ctx,data) \
260 X509_STORE_CTX_set_ex_data(ctx,0,data)
261 #define X509_STORE_CTX_get_app_data(ctx) \
262 X509_STORE_CTX_get_ex_data(ctx,0)
264 #define X509_L_FILE_LOAD 1
265 #define X509_L_ADD_DIR 2
267 #define X509_LOOKUP_load_file(x,name,type) \
268 X509_LOOKUP_ctrl((x),X509_L_FILE_LOAD,(name),(long)(type),NULL)
270 #define X509_LOOKUP_add_dir(x,name,type) \
271 X509_LOOKUP_ctrl((x),X509_L_ADD_DIR,(name),(long)(type),NULL)
274 /* illegal error (for uninitialized values, to avoid X509_V_OK): 1 */
276 #define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT 2
277 #define X509_V_ERR_UNABLE_TO_GET_CRL 3
278 #define X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE 4
279 #define X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE 5
280 #define X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY 6
281 #define X509_V_ERR_CERT_SIGNATURE_FAILURE 7
282 #define X509_V_ERR_CRL_SIGNATURE_FAILURE 8
283 #define X509_V_ERR_CERT_NOT_YET_VALID 9
284 #define X509_V_ERR_CERT_HAS_EXPIRED 10
285 #define X509_V_ERR_CRL_NOT_YET_VALID 11
286 #define X509_V_ERR_CRL_HAS_EXPIRED 12
287 #define X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD 13
288 #define X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD 14
289 #define X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD 15
290 #define X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD 16
291 #define X509_V_ERR_OUT_OF_MEM 17
292 #define X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT 18
293 #define X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN 19
294 #define X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY 20
295 #define X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE 21
296 #define X509_V_ERR_CERT_CHAIN_TOO_LONG 22
297 #define X509_V_ERR_CERT_REVOKED 23
298 #define X509_V_ERR_INVALID_CA 24
299 #define X509_V_ERR_PATH_LENGTH_EXCEEDED 25
300 #define X509_V_ERR_INVALID_PURPOSE 26
301 #define X509_V_ERR_CERT_UNTRUSTED 27
302 #define X509_V_ERR_CERT_REJECTED 28
303 /* These are 'informational' when looking for issuer cert */
304 #define X509_V_ERR_SUBJECT_ISSUER_MISMATCH 29
305 #define X509_V_ERR_AKID_SKID_MISMATCH 30
306 #define X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH 31
307 #define X509_V_ERR_KEYUSAGE_NO_CERTSIGN 32
309 #define X509_V_ERR_UNABLE_TO_GET_CRL_ISSUER 33
310 #define X509_V_ERR_UNHANDLED_CRITICAL_EXTENSION 34
311 #define X509_V_ERR_KEYUSAGE_NO_CRL_SIGN 35
312 #define X509_V_ERR_UNHANDLED_CRITICAL_CRL_EXTENSION 36
313 #define X509_V_ERR_INVALID_NON_CA 37
314 #define X509_V_ERR_PROXY_PATH_LENGTH_EXCEEDED 38
315 #define X509_V_ERR_KEYUSAGE_NO_DIGITAL_SIGNATURE 39
316 #define X509_V_ERR_PROXY_CERTIFICATES_NOT_ALLOWED 40
318 /* The application is not happy */
319 #define X509_V_ERR_APPLICATION_VERIFICATION 50
321 /* Certificate verify flags */
323 /* Send issuer+subject checks to verify_cb */
324 #define X509_V_FLAG_CB_ISSUER_CHECK 0x1
325 /* Use check time instead of current time */
326 #define X509_V_FLAG_USE_CHECK_TIME 0x2
328 #define X509_V_FLAG_CRL_CHECK 0x4
329 /* Lookup CRLs for whole chain */
330 #define X509_V_FLAG_CRL_CHECK_ALL 0x8
331 /* Ignore unhandled critical extensions */
332 #define X509_V_FLAG_IGNORE_CRITICAL 0x10
333 /* Disable workarounds for broken certificates */
334 #define X509_V_FLAG_X509_STRICT 0x20
335 /* Enable proxy certificate validation */
336 #define X509_V_FLAG_ALLOW_PROXY_CERTS 0x40
338 int X509_OBJECT_idx_by_subject(STACK_OF(X509_OBJECT
) *h
, int type
,
340 X509_OBJECT
*X509_OBJECT_retrieve_by_subject(STACK_OF(X509_OBJECT
) *h
,int type
,X509_NAME
*name
);
341 X509_OBJECT
*X509_OBJECT_retrieve_match(STACK_OF(X509_OBJECT
) *h
, X509_OBJECT
*x
);
342 void X509_OBJECT_up_ref_count(X509_OBJECT
*a
);
343 void X509_OBJECT_free_contents(X509_OBJECT
*a
);
344 X509_STORE
*X509_STORE_new(void );
345 void X509_STORE_free(X509_STORE
*v
);
347 void X509_STORE_set_flags(X509_STORE
*ctx
, long flags
);
348 int X509_STORE_set_purpose(X509_STORE
*ctx
, int purpose
);
349 int X509_STORE_set_trust(X509_STORE
*ctx
, int trust
);
351 X509_STORE_CTX
*X509_STORE_CTX_new(void);
353 int X509_STORE_CTX_get1_issuer(X509
**issuer
, X509_STORE_CTX
*ctx
, X509
*x
);
355 void X509_STORE_CTX_free(X509_STORE_CTX
*ctx
);
356 int X509_STORE_CTX_init(X509_STORE_CTX
*ctx
, X509_STORE
*store
,
357 X509
*x509
, STACK_OF(X509
) *chain
);
358 void X509_STORE_CTX_trusted_stack(X509_STORE_CTX
*ctx
, STACK_OF(X509
) *sk
);
359 void X509_STORE_CTX_cleanup(X509_STORE_CTX
*ctx
);
361 X509_LOOKUP
*X509_STORE_add_lookup(X509_STORE
*v
, X509_LOOKUP_METHOD
*m
);
363 X509_LOOKUP_METHOD
*X509_LOOKUP_hash_dir(void);
364 X509_LOOKUP_METHOD
*X509_LOOKUP_file(void);
366 int X509_STORE_add_cert(X509_STORE
*ctx
, X509
*x
);
367 int X509_STORE_add_crl(X509_STORE
*ctx
, X509_CRL
*x
);
369 int X509_STORE_get_by_subject(X509_STORE_CTX
*vs
,int type
,X509_NAME
*name
,
372 int X509_LOOKUP_ctrl(X509_LOOKUP
*ctx
, int cmd
, const char *argc
,
373 long argl
, char **ret
);
375 #ifndef OPENSSL_NO_STDIO
376 int X509_load_cert_file(X509_LOOKUP
*ctx
, const char *file
, int type
);
377 int X509_load_crl_file(X509_LOOKUP
*ctx
, const char *file
, int type
);
378 int X509_load_cert_crl_file(X509_LOOKUP
*ctx
, const char *file
, int type
);
382 X509_LOOKUP
*X509_LOOKUP_new(X509_LOOKUP_METHOD
*method
);
383 void X509_LOOKUP_free(X509_LOOKUP
*ctx
);
384 int X509_LOOKUP_init(X509_LOOKUP
*ctx
);
385 int X509_LOOKUP_by_subject(X509_LOOKUP
*ctx
, int type
, X509_NAME
*name
,
387 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP
*ctx
, int type
, X509_NAME
*name
,
388 ASN1_INTEGER
*serial
, X509_OBJECT
*ret
);
389 int X509_LOOKUP_by_fingerprint(X509_LOOKUP
*ctx
, int type
,
390 unsigned char *bytes
, int len
, X509_OBJECT
*ret
);
391 int X509_LOOKUP_by_alias(X509_LOOKUP
*ctx
, int type
, char *str
,
392 int len
, X509_OBJECT
*ret
);
393 int X509_LOOKUP_shutdown(X509_LOOKUP
*ctx
);
395 #ifndef OPENSSL_NO_STDIO
396 int X509_STORE_load_locations (X509_STORE
*ctx
,
397 const char *file
, const char *dir
);
398 int X509_STORE_set_default_paths(X509_STORE
*ctx
);
401 int X509_STORE_CTX_get_ex_new_index(long argl
, void *argp
, CRYPTO_EX_new
*new_func
,
402 CRYPTO_EX_dup
*dup_func
, CRYPTO_EX_free
*free_func
);
403 int X509_STORE_CTX_set_ex_data(X509_STORE_CTX
*ctx
,int idx
,void *data
);
404 void * X509_STORE_CTX_get_ex_data(X509_STORE_CTX
*ctx
,int idx
);
405 int X509_STORE_CTX_get_error(X509_STORE_CTX
*ctx
);
406 void X509_STORE_CTX_set_error(X509_STORE_CTX
*ctx
,int s
);
407 int X509_STORE_CTX_get_error_depth(X509_STORE_CTX
*ctx
);
408 X509
* X509_STORE_CTX_get_current_cert(X509_STORE_CTX
*ctx
);
409 STACK_OF(X509
) *X509_STORE_CTX_get_chain(X509_STORE_CTX
*ctx
);
410 STACK_OF(X509
) *X509_STORE_CTX_get1_chain(X509_STORE_CTX
*ctx
);
411 void X509_STORE_CTX_set_cert(X509_STORE_CTX
*c
,X509
*x
);
412 void X509_STORE_CTX_set_chain(X509_STORE_CTX
*c
,STACK_OF(X509
) *sk
);
413 int X509_STORE_CTX_set_purpose(X509_STORE_CTX
*ctx
, int purpose
);
414 int X509_STORE_CTX_set_trust(X509_STORE_CTX
*ctx
, int trust
);
415 int X509_STORE_CTX_purpose_inherit(X509_STORE_CTX
*ctx
, int def_purpose
,
416 int purpose
, int trust
);
417 void X509_STORE_CTX_set_flags(X509_STORE_CTX
*ctx
, long flags
);
418 void X509_STORE_CTX_set_time(X509_STORE_CTX
*ctx
, long flags
, time_t t
);
419 void X509_STORE_CTX_set_verify_cb(X509_STORE_CTX
*ctx
,
420 int (*verify_cb
)(int, X509_STORE_CTX
*));