crypto/x509/x509_vfy.h

   1 /* crypto/x509/x509_vfy.h */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   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_H
  60 #include <openssl/x509.h>
  61 /* openssl/x509.h ends up #include-ing this file at about the only
  62  * appropriate moment. */
  63 #endif
  64
  65 #ifndef HEADER_X509_VFY_H
  66 #define HEADER_X509_VFY_H
  67
  68 #include <openssl/bio.h>
  69 #include <openssl/crypto.h>
  70
  71 #ifdef  __cplusplus
  72 extern "C" {
  73 #endif
  74
  75 /* Outer object */
  76 typedef struct x509_hash_dir_st
  77         {
  78         int num_dirs;
  79         char **dirs;
  80         int *dirs_type;
  81         int num_dirs_alloced;
  82         } X509_HASH_DIR_CTX;
  83
  84 typedef struct x509_file_st
  85         {
  86         int num_paths;  /* number of paths to files or directories */
  87         int num_alloced;
  88         char **paths;   /* the list of paths or directories */
  89         int *path_type;
  90         } X509_CERT_FILE_CTX;
  91
  92 /*******************************/
  93 /*
  94 SSL_CTX -> X509_STORE
  95                 -> X509_LOOKUP
  96                         ->X509_LOOKUP_METHOD
  97                 -> X509_LOOKUP
  98                         ->X509_LOOKUP_METHOD
  99
 100 SSL     -> X509_STORE_CTX
 101                 ->X509_STORE
 102
 103 The X509_STORE holds the tables etc for verification stuff.
 104 A X509_STORE_CTX is used while validating a single certificate.
 105 The X509_STORE has X509_LOOKUPs for looking up certs.
 106 The X509_STORE then calls a function to actually verify the
 107 certificate chain.
 108 */
 109
 110 #define X509_LU_RETRY           -1
 111 #define X509_LU_FAIL            0
 112 #define X509_LU_X509            1
 113 #define X509_LU_CRL             2
 114 #define X509_LU_PKEY            3
 115
 116 typedef struct x509_object_st
 117         {
 118         /* one of the above types */
 119         int type;
 120         union   {
 121                 char *ptr;
 122                 X509 *x509;
 123                 X509_CRL *crl;
 124                 EVP_PKEY *pkey;
 125                 } data;
 126         } X509_OBJECT;
 127
 128 typedef struct x509_lookup_st X509_LOOKUP;
 129
 130 DECLARE_STACK_OF(X509_LOOKUP)
 131 /* This block of defines is updated by a perl script, please do not touch! */
 132 #ifndef DEBUG_SAFESTACK
 133         #define sk_X509_LOOKUP_new(a) sk_new((int (*) \
 134                 (const char * const *, const char * const *))(a))
 135         #define sk_X509_LOOKUP_new_null() sk_new_null()
 136         #define sk_X509_LOOKUP_free(a) sk_free(a)
 137         #define sk_X509_LOOKUP_num(a) sk_num(a)
 138         #define sk_X509_LOOKUP_value(a,b) ((X509_LOOKUP *) \
 139                 sk_value((a),(b)))
 140         #define sk_X509_LOOKUP_set(a,b,c) ((X509_LOOKUP *) \
 141                 sk_set((a),(b),(char *)(c)))
 142         #define sk_X509_LOOKUP_zero(a) sk_zero(a)
 143         #define sk_X509_LOOKUP_push(a,b) sk_push((a),(char *)(b))
 144         #define sk_X509_LOOKUP_unshift(a,b) sk_unshift((a),(b))
 145         #define sk_X509_LOOKUP_find(a,b) sk_find((a), (char *)(b))
 146         #define sk_X509_LOOKUP_delete(a,b) ((X509_LOOKUP *) \
 147                 sk_delete((a),(b)))
 148         #define sk_X509_LOOKUP_delete_ptr(a,b) ((X509_LOOKUP *) \
 149                 sk_delete_ptr((a),(char *)(b)))
 150         #define sk_X509_LOOKUP_insert(a,b,c) sk_insert((a),(char *)(b),(c))
 151         #define sk_X509_LOOKUP_set_cmp_func(a,b) ((int (*) \
 152                 (const X509_LOOKUP * const *,const X509_LOOKUP * const *)) \
 153                 sk_set_cmp_func((a),(int (*) \
 154                 (const char * const *, const char * const *))(b)))
 155         #define sk_X509_LOOKUP_dup(a) sk_dup(a)
 156         #define sk_X509_LOOKUP_pop_free(a,b) sk_pop_free((a),(void (*)(void *))(b))
 157         #define sk_X509_LOOKUP_shift(a) ((X509_LOOKUP *)sk_shift(a))
 158         #define sk_X509_LOOKUP_pop(a) ((X509_LOOKUP *)sk_pop(a))
 159         #define sk_X509_LOOKUP_sort(a) sk_sort(a)
 160 #endif /* !DEBUG_SAFESTACK */
 161 /* End of perl script block, you may now edit :-) */
 162
 163 /* This is a static that defines the function interface */
 164 typedef struct x509_lookup_method_st
 165         {
 166         const char *name;
 167         int (*new_item)(X509_LOOKUP *ctx);
 168         void (*free)(X509_LOOKUP *ctx);
 169         int (*init)(X509_LOOKUP *ctx);
 170         int (*shutdown)(X509_LOOKUP *ctx);
 171         int (*ctrl)(X509_LOOKUP *ctx,int cmd,const char *argc,long argl,
 172                         char **ret);
 173         int (*get_by_subject)(X509_LOOKUP *ctx,int type,X509_NAME *name,
 174                               X509_OBJECT *ret);
 175         int (*get_by_issuer_serial)(X509_LOOKUP *ctx,int type,X509_NAME *name,
 176                                     ASN1_INTEGER *serial,X509_OBJECT *ret);
 177         int (*get_by_fingerprint)(X509_LOOKUP *ctx,int type,
 178                                   unsigned char *bytes,int len,
 179                                   X509_OBJECT *ret);
 180         int (*get_by_alias)(X509_LOOKUP *ctx,int type,char *str,int len,
 181                             X509_OBJECT *ret);
 182         } X509_LOOKUP_METHOD;
 183
 184 typedef struct x509_store_state_st X509_STORE_CTX;
 185
 186 /* This is used to hold everything.  It is used for all certificate
 187  * validation.  Once we have a certificate chain, the 'verify'
 188  * function is then called to actually check the cert chain. */
 189 typedef struct x509_store_st
 190         {
 191         /* The following is a cache of trusted certs */
 192         int cache;      /* if true, stash any hits */
 193 #ifdef HEADER_LHASH_H
 194         LHASH *certs;   /* cached certs; */
 195 #else
 196         char *certs;
 197 #endif
 198
 199         /* These are external lookup methods */
 200         STACK_OF(X509_LOOKUP) *get_cert_methods;
 201         int (*verify)(X509_STORE_CTX *ctx);     /* called to verify a certificate */
 202         int (*verify_cb)(int ok,X509_STORE_CTX *ctx);   /* error callback */
 203
 204         CRYPTO_EX_DATA ex_data;
 205         int references;
 206         int depth;              /* how deep to look (still unused -- X509_STORE_CTX's depth is used) */
 207         }  X509_STORE;
 208
 209 #define X509_STORE_set_depth(ctx,d)       ((ctx)->depth=(d))
 210
 211 #define X509_STORE_set_verify_cb_func(ctx,func) ((ctx)->verify_cb=(func))
 212 #define X509_STORE_set_verify_func(ctx,func)    ((ctx)->verify=(func))
 213
 214 /* This is the functions plus an instance of the local variables. */
 215 struct x509_lookup_st
 216         {
 217         int init;                       /* have we been started */
 218         int skip;                       /* don't use us. */
 219         X509_LOOKUP_METHOD *method;     /* the functions */
 220         char *method_data;              /* method data */
 221
 222         X509_STORE *store_ctx;  /* who owns us */
 223         };
 224
 225 /* This is a temporary used when processing cert chains.  Since the
 226  * gathering of the cert chain can take some time (and have to be
 227  * 'retried', this needs to be kept and passed around. */
 228 struct x509_store_state_st      /* X509_STORE_CTX */
 229         {
 230         X509_STORE *ctx;
 231         int current_method;     /* used when looking up certs */
 232
 233         /* The following are set by the caller */
 234         X509 *cert;             /* The cert to check */
 235         STACK_OF(X509) *untrusted;      /* chain of X509s - untrusted - passed in */
 236         int purpose;            /* purpose to check untrusted certificates */
 237         int trust;              /* trust setting to check */
 238
 239         /* The following is built up */
 240         int depth;              /* how far to go looking up certs */
 241         int valid;              /* if 0, rebuild chain */
 242         int last_untrusted;     /* index of last untrusted cert */
 243         STACK_OF(X509) *chain;          /* chain of X509s - built up and trusted */
 244
 245         /* When something goes wrong, this is why */
 246         int error_depth;
 247         int error;
 248         X509 *current_cert;
 249
 250         CRYPTO_EX_DATA ex_data;
 251         };
 252
 253 #define X509_STORE_CTX_set_depth(ctx,d)       ((ctx)->depth=(d))
 254
 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)
 259
 260 #define X509_L_FILE_LOAD        1
 261 #define X509_L_ADD_DIR          2
 262
 263 #define X509_LOOKUP_load_file(x,name,type) \
 264                 X509_LOOKUP_ctrl((x),X509_L_FILE_LOAD,(name),(long)(type),NULL)
 265
 266 #define X509_LOOKUP_add_dir(x,name,type) \
 267                 X509_LOOKUP_ctrl((x),X509_L_ADD_DIR,(name),(long)(type),NULL)
 268
 269 #define         X509_V_OK                                       0
 270 /* illegal error (for uninitialized values, to avoid X509_V_OK): 1 */
 271
 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
 300 /* The application is not happy */
 301 #define         X509_V_ERR_APPLICATION_VERIFICATION             50
 302
 303                   /* These functions are being redefined in another directory,
 304                      and clash when the linker is case-insensitive, so let's
 305                      hide them a little, by giving them an extra 'o' at the
 306                      beginning of the name... */
 307 #ifdef VMS
 308 #undef X509v3_cleanup_extensions
 309 #define X509v3_cleanup_extensions oX509v3_cleanup_extensions
 310 #undef X509v3_add_extension
 311 #define X509v3_add_extension oX509v3_add_extension
 312 #undef X509v3_add_netscape_extensions
 313 #define X509v3_add_netscape_extensions oX509v3_add_netscape_extensions
 314 #undef X509v3_add_standard_extensions
 315 #define X509v3_add_standard_extensions oX509v3_add_standard_extensions
 316 #endif
 317
 318 #ifdef HEADER_LHASH_H
 319 X509_OBJECT *X509_OBJECT_retrieve_by_subject(LHASH *h,int type,X509_NAME *name);
 320 #endif
 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);
 325
 326 X509_STORE_CTX *X509_STORE_CTX_new(void);
 327 void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
 328 void X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
 329                          X509 *x509, STACK_OF(X509) *chain);
 330 void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
 331
 332 X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *v, X509_LOOKUP_METHOD *m);
 333
 334 X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void);
 335 X509_LOOKUP_METHOD *X509_LOOKUP_file(void);
 336
 337 int X509_STORE_add_cert(X509_STORE *ctx, X509 *x);
 338 int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x);
 339
 340 int X509_STORE_get_by_subject(X509_STORE_CTX *vs,int type,X509_NAME *name,
 341         X509_OBJECT *ret);
 342
 343 int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc,
 344         long argl, char **ret);
 345
 346 #ifndef NO_STDIO
 347 int X509_load_cert_file(X509_LOOKUP *ctx, const char *file, int type);
 348 int X509_load_crl_file(X509_LOOKUP *ctx, const char *file, int type);
 349 int X509_load_cert_crl_file(X509_LOOKUP *ctx, const char *file, int type);
 350 #endif
 351
 352
 353 X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method);
 354 void X509_LOOKUP_free(X509_LOOKUP *ctx);
 355 int X509_LOOKUP_init(X509_LOOKUP *ctx);
 356 int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, int type, X509_NAME *name,
 357         X509_OBJECT *ret);
 358 int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, int type, X509_NAME *name,
 359         ASN1_INTEGER *serial, X509_OBJECT *ret);
 360 int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, int type,
 361         unsigned char *bytes, int len, X509_OBJECT *ret);
 362 int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, int type, char *str,
 363         int len, X509_OBJECT *ret);
 364 int X509_LOOKUP_shutdown(X509_LOOKUP *ctx);
 365
 366 #ifndef NO_STDIO
 367 int     X509_STORE_load_locations (X509_STORE *ctx,
 368                 const char *file, const char *dir);
 369 int     X509_STORE_set_default_paths(X509_STORE *ctx);
 370 #endif
 371
 372 int X509_STORE_CTX_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
 373         CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
 374 int     X509_STORE_CTX_set_ex_data(X509_STORE_CTX *ctx,int idx,void *data);
 375 void *  X509_STORE_CTX_get_ex_data(X509_STORE_CTX *ctx,int idx);
 376 int     X509_STORE_CTX_get_error(X509_STORE_CTX *ctx);
 377 void    X509_STORE_CTX_set_error(X509_STORE_CTX *ctx,int s);
 378 int     X509_STORE_CTX_get_error_depth(X509_STORE_CTX *ctx);
 379 X509 *  X509_STORE_CTX_get_current_cert(X509_STORE_CTX *ctx);
 380 STACK_OF(X509) *X509_STORE_CTX_get_chain(X509_STORE_CTX *ctx);
 381 STACK_OF(X509) *X509_STORE_CTX_get1_chain(X509_STORE_CTX *ctx);
 382 void    X509_STORE_CTX_set_cert(X509_STORE_CTX *c,X509 *x);
 383 void    X509_STORE_CTX_set_chain(X509_STORE_CTX *c,STACK_OF(X509) *sk);
 384 int X509_STORE_CTX_set_purpose(X509_STORE_CTX *ctx, int purpose);
 385 int X509_STORE_CTX_set_trust(X509_STORE_CTX *ctx, int trust);
 386 int X509_STORE_CTX_purpose_inherit(X509_STORE_CTX *ctx, int def_purpose,
 387                                 int purpose, int trust);
 388
 389 #ifdef  __cplusplus
 390 }
 391 #endif
 392 #endif
 393