crypto/x509v3/x509v3.h

   1 /* x509v3.h */
   2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
   3  * project 1999.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in
  17  *    the documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  * 3. All advertising materials mentioning features or use of this
  21  *    software must display the following acknowledgment:
  22  *    "This product includes software developed by the OpenSSL Project
  23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  24  *
  25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26  *    endorse or promote products derived from this software without
  27  *    prior written permission. For written permission, please contact
  28  *    licensing@OpenSSL.org.
  29  *
  30  * 5. Products derived from this software may not be called "OpenSSL"
  31  *    nor may "OpenSSL" appear in their names without prior written
  32  *    permission of the OpenSSL Project.
  33  *
  34  * 6. Redistributions of any form whatsoever must retain the following
  35  *    acknowledgment:
  36  *    "This product includes software developed by the OpenSSL Project
  37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  38  *
  39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51  * ====================================================================
  52  *
  53  * This product includes cryptographic software written by Eric Young
  54  * (eay@cryptsoft.com).  This product includes software written by Tim
  55  * Hudson (tjh@cryptsoft.com).
  56  *
  57  */
  58 #ifndef HEADER_X509V3_H
  59 #define HEADER_X509V3_H
  60
  61 #ifdef __cplusplus
  62 extern "C" {
  63 #endif
  64
  65 #include "bio.h"
  66 #include "x509.h"
  67
  68 /* Forward reference */
  69 struct v3_ext_method;
  70 struct v3_ext_ctx;
  71
  72 /* Useful typedefs */
  73
  74 typedef char * (*X509V3_EXT_NEW)();
  75 typedef void (*X509V3_EXT_FREE)();
  76 typedef char * (*X509V3_EXT_D2I)();
  77 typedef int (*X509V3_EXT_I2D)();
  78 typedef STACK * (*X509V3_EXT_I2V)(struct v3_ext_method *method, char *ext, STACK *extlist);
  79 typedef char * (*X509V3_EXT_V2I)(struct v3_ext_method *method, struct v3_ext_ctx *ctx, STACK *values);
  80 typedef char * (*X509V3_EXT_I2S)(struct v3_ext_method *method, char *ext);
  81 typedef char * (*X509V3_EXT_S2I)(struct v3_ext_method *method, struct v3_ext_ctx *ctx, char *str);
  82 typedef int (*X509V3_EXT_I2R)(struct v3_ext_method *method, char *ext, BIO *out);
  83 typedef char *(*X509V3_EXT_R2I)(struct v3_ext_method *method, char *db, char *value);
  84
  85 /* V3 extension structure */
  86
  87 struct v3_ext_method {
  88 int ext_nid;
  89 int ext_flags;
  90 X509V3_EXT_NEW ext_new;
  91 X509V3_EXT_FREE ext_free;
  92 X509V3_EXT_D2I d2i;
  93 X509V3_EXT_I2D i2d;
  94
  95 /* The following pair is used for string extensions */
  96 X509V3_EXT_I2S i2s;
  97 X509V3_EXT_S2I s2i;
  98
  99 /* The following pair is used for multi-valued extensions */
 100 X509V3_EXT_I2V i2v;
 101 X509V3_EXT_V2I v2i;
 102
 103 /* The following are used for raw extensions */
 104 X509V3_EXT_I2R i2r;
 105 X509V3_EXT_R2I r2i;     /* Doesn't do anything *YET* */
 106
 107 char *usr_data; /* Any extension specific data */
 108 };
 109
 110
 111 /* Context specific info */
 112 struct v3_ext_ctx {
 113 #define CTX_TEST 0x1
 114 int flags;
 115 X509 *issuer_cert;
 116 X509 *subject_cert;
 117 X509_REQ *subject_req;
 118 X509_CRL *crl;
 119 /* Maybe more here */
 120 };
 121
 122 typedef struct v3_ext_method X509V3_EXT_METHOD;
 123 typedef struct v3_ext_ctx X509V3_CTX;
 124
 125 /* ext_flags values */
 126 #define X509V3_EXT_DYNAMIC 0x1
 127 #define X509V3_EXT_CTX_DEP 0x2
 128
 129 typedef struct {
 130 int bitnum;
 131 char *lname;
 132 char *sname;
 133 } BIT_STRING_BITNAME;
 134
 135 typedef BIT_STRING_BITNAME ENUMERATED_NAMES;
 136
 137 typedef struct {
 138 int ca;
 139 ASN1_INTEGER *pathlen;
 140 } BASIC_CONSTRAINTS;
 141
 142 typedef struct {
 143 ASN1_OCTET_STRING *keyid;
 144 STACK *issuer;
 145 ASN1_INTEGER *serial;
 146 } AUTHORITY_KEYID;
 147
 148 typedef struct {
 149 ASN1_GENERALIZEDTIME *notBefore;
 150 ASN1_GENERALIZEDTIME *notAfter;
 151 } PKEY_USAGE_PERIOD;
 152
 153 typedef struct {
 154
 155 #define GEN_OTHERNAME   (0|V_ASN1_CONTEXT_SPECIFIC)
 156 #define GEN_EMAIL       (1|V_ASN1_CONTEXT_SPECIFIC)
 157 #define GEN_DNS         (2|V_ASN1_CONTEXT_SPECIFIC)
 158 #define GEN_X400        (3|V_ASN1_CONTEXT_SPECIFIC)
 159 #define GEN_DIRNAME     (4|V_ASN1_CONTEXT_SPECIFIC)
 160 #define GEN_EDIPARTY    (5|V_ASN1_CONTEXT_SPECIFIC)
 161 #define GEN_URI         (6|V_ASN1_CONTEXT_SPECIFIC)
 162 #define GEN_IPADD       (7|V_ASN1_CONTEXT_SPECIFIC)
 163 #define GEN_RID         (8|V_ASN1_CONTEXT_SPECIFIC)
 164
 165 int type;
 166 union {
 167         char *ptr;
 168         ASN1_IA5STRING *ia5;/* rfc822Name, dNSName, uniformResourceIdentifier */
 169         ASN1_OCTET_STRING *ip; /* iPAddress */
 170         X509_NAME *dirn;                /* dirn */
 171         ASN1_OBJECT *rid; /* registeredID */
 172         ASN1_TYPE *other; /* otherName, ediPartyName, x400Address */
 173 } d;
 174 } GENERAL_NAME;
 175
 176
 177
 178
 179 #define X509V3_conf_err(val) ERR_add_error_data(6, "section:", val->section, \
 180 ",name:", val->name, ",value:", val->value);
 181
 182 #define EXT_BITSTRING(nid, table) { nid, 0, \
 183                         (X509V3_EXT_NEW)asn1_bit_string_new, ASN1_STRING_free, \
 184                         (X509V3_EXT_D2I)d2i_ASN1_BIT_STRING, \
 185                         i2d_ASN1_BIT_STRING, \
 186                         NULL, NULL, \
 187                         (X509V3_EXT_I2V)i2v_ASN1_BIT_STRING, \
 188                         (X509V3_EXT_V2I)v2i_ASN1_BIT_STRING, \
 189                         NULL, NULL, \
 190                         (char *)table}
 191
 192 #define EXT_IA5STRING(nid) { nid, 0, \
 193                         (X509V3_EXT_NEW)ia5string_new, ASN1_STRING_free, \
 194                         (X509V3_EXT_D2I)d2i_ASN1_IA5STRING, \
 195                         i2d_ASN1_IA5STRING, \
 196                         (X509V3_EXT_I2S)i2s_ASN1_IA5STRING, \
 197                         (X509V3_EXT_S2I)s2i_ASN1_IA5STRING, \
 198                         NULL, NULL, NULL, NULL, \
 199                         NULL}
 200
 201 #define EXT_END { -1, 0, NULL, NULL, NULL, NULL, NULL, NULL, \
 202                          NULL, NULL, NULL, NULL, \
 203                          NULL}
 204
 205 #ifndef NOPROTO
 206 void ERR_load_X509V3_strings(void);
 207 int i2d_BASIC_CONSTRAINTS(BASIC_CONSTRAINTS *a, unsigned char **pp);
 208 BASIC_CONSTRAINTS *d2i_BASIC_CONSTRAINTS(BASIC_CONSTRAINTS **a, unsigned char **pp, long length);
 209 BASIC_CONSTRAINTS *BASIC_CONSTRAINTS_new(void);
 210 void BASIC_CONSTRAINTS_free(BASIC_CONSTRAINTS *a);
 211
 212 int i2d_GENERAL_NAME(GENERAL_NAME *a, unsigned char **pp);
 213 GENERAL_NAME *d2i_GENERAL_NAME(GENERAL_NAME **a, unsigned char **pp, long length);
 214 GENERAL_NAME *GENERAL_NAME_new(void);
 215 void GENERAL_NAME_free(GENERAL_NAME *a);
 216 STACK *i2v_GENERAL_NAME(X509V3_EXT_METHOD *method, GENERAL_NAME *gen, STACK *ret);
 217
 218 int i2d_AUTHORITY_KEYID(AUTHORITY_KEYID *a, unsigned char **pp);
 219 AUTHORITY_KEYID *d2i_AUTHORITY_KEYID(AUTHORITY_KEYID **a, unsigned char **pp, long length);
 220 AUTHORITY_KEYID *AUTHORITY_KEYID_new(void);
 221 void AUTHORITY_KEYID_free(AUTHORITY_KEYID *a);
 222
 223 int i2d_PKEY_USAGE_PERIOD(PKEY_USAGE_PERIOD *a, unsigned char **pp);
 224 PKEY_USAGE_PERIOD *d2i_PKEY_USAGE_PERIOD(PKEY_USAGE_PERIOD **a, unsigned char **pp, long length);
 225 PKEY_USAGE_PERIOD *PKEY_USAGE_PERIOD_new(void);
 226 void PKEY_USAGE_PERIOD_free(PKEY_USAGE_PERIOD *a);
 227
 228 STACK *GENERAL_NAMES_new(void);
 229 void GENERAL_NAMES_free(STACK *a);
 230 STACK *d2i_GENERAL_NAMES(STACK **a, unsigned char **pp, long length);
 231 int i2d_GENERAL_NAMES(STACK *a, unsigned char **pp);
 232 STACK *i2v_GENERAL_NAMES(X509V3_EXT_METHOD *method, STACK *gen, STACK *extlist);
 233 STACK *v2i_GENERAL_NAMES(X509V3_EXT_METHOD *method, X509V3_CTX *ctx, STACK *nval);
 234
 235 char *i2s_ASN1_OCTET_STRING(X509V3_EXT_METHOD *method, ASN1_OCTET_STRING *ia5);
 236 ASN1_OCTET_STRING *s2i_ASN1_OCTET_STRING(X509V3_EXT_METHOD *method, X509V3_CTX *ctx, char *str);
 237
 238 int i2d_ext_ku(STACK *a, unsigned char **pp);
 239 STACK *d2i_ext_ku(STACK **a, unsigned char **pp, long length);
 240 void ext_ku_free(STACK *a);
 241 STACK *ext_ku_new(void);
 242
 243 #ifdef HEADER_CONF_H
 244 GENERAL_NAME *v2i_GENERAL_NAME(X509V3_EXT_METHOD *method, X509V3_CTX *ctx, CONF_VALUE *cnf);
 245 void X509V3_conf_free(CONF_VALUE *val);
 246 X509_EXTENSION *X509V3_EXT_conf_nid(LHASH *conf, X509V3_CTX *ctx, int ext_nid, char *value);
 247 X509_EXTENSION *X509V3_EXT_conf(LHASH *conf, X509V3_CTX *ctx, char *name, char *value);
 248 int X509V3_EXT_add_conf(LHASH *conf, X509V3_CTX *ctx, char *section, X509 *cert);
 249 int X509V3_EXT_check_conf(LHASH *conf, char *section);
 250 int X509V3_get_value_bool(CONF_VALUE *value, int *asn1_bool);
 251 int X509V3_get_value_int(CONF_VALUE *value, ASN1_INTEGER **aint);
 252 #endif
 253
 254 int X509V3_add_value(char *name, char *value, STACK **extlist);
 255 int X509V3_add_value_bool(char *name, int asn1_bool, STACK **extlist);
 256 int X509V3_add_value_int( char *name, ASN1_INTEGER *aint, STACK **extlist);
 257 char * i2s_ASN1_INTEGER(X509V3_EXT_METHOD *meth, ASN1_INTEGER *aint);
 258 char * i2s_ASN1_ENUMERATED(X509V3_EXT_METHOD *meth, ASN1_ENUMERATED *aint);
 259 char * i2s_ASN1_ENUMERATED_TABLE(X509V3_EXT_METHOD *meth, ASN1_ENUMERATED *aint);
 260 int X509V3_EXT_add(X509V3_EXT_METHOD *ext);
 261 int X509V3_EXT_add_alias(int nid_to, int nid_from);
 262 void X509V3_EXT_cleanup(void);
 263
 264 X509V3_EXT_METHOD *X509V3_EXT_get(X509_EXTENSION *ext);
 265 X509V3_EXT_METHOD *X509V3_EXT_get_nid(int nid);
 266 int X509V3_add_standard_extensions(void);
 267 STACK *X509V3_parse_list(char *line);
 268 char *X509V3_EXT_d2i(X509_EXTENSION *ext);
 269
 270 char *hex_to_string(unsigned char *buffer, long len);
 271 unsigned char *string_to_hex(char *str, long *len);
 272 int name_cmp(char *name, char *cmp);
 273
 274 int X509V3_EXT_print(BIO *out, X509_EXTENSION *ext, int flag);
 275 int X509V3_EXT_print_fp(FILE *out, X509_EXTENSION *ext, int flag);
 276
 277 #else
 278
 279 void ERR_load_X509V3_strings();
 280 int i2d_BASIC_CONSTRAINTS();
 281 BASIC_CONSTRAINTS *d2i_BASIC_CONSTRAINTS();
 282 BASIC_CONSTRAINTS *BASIC_CONSTRAINTS_new();
 283 void BASIC_CONSTRAINTS_free();
 284
 285 int i2d_GENERAL_NAME();
 286 GENERAL_NAME *d2i_GENERAL_NAME();
 287 GENERAL_NAME *GENERAL_NAME_new();
 288 void GENERAL_NAME_free();
 289 STACK *i2v_GENERAL_NAME();
 290 GENERAL_NAME *v2i_GENERAL_NAME();
 291
 292 int i2d_PKEY_USAGE_PERIOD();
 293 PKEY_USAGE_PERIOD *d2i_PKEY_USAGE_PERIOD();
 294 PKEY_USAGE_PERIOD *PKEY_USAGE_PERIOD_new();
 295 void PKEY_USAGE_PERIOD_free();
 296
 297 STACK *GENERAL_NAMES_new():
 298 void GENERAL_NAMES_free():
 299 STACK *d2i_GENERAL_NAMES();
 300 int i2d_GENERAL_NAMES();
 301 STACK *i2v_GENERAL_NAMES();
 302 STACK *v2i_GENERAL_NAMES();
 303
 304 char *i2s_ASN1_OCTET_STRING();
 305 ASN1_OCTET_STRING *s2i_ASN1_OCTET_STRING();
 306
 307 int i2d_ext_ku();
 308 STACK *d2i_ext_ku();
 309 void ext_ku_free();
 310 STACK *ext_ku_new();
 311
 312 #ifdef HEADER_CONF_H
 313 void X509V3_conf_free();
 314 X509_EXTENSION *X509V3_EXT_conf_nid();
 315 X509_EXTENSION *X509V3_EXT_conf();
 316 int X509V3_EXT_add_conf();
 317 int X509V3_EXT_check_conf();
 318 int X509V3_get_value_bool();
 319 int X509V3_get_value_int();
 320 #endif
 321
 322 int X509V3_add_value();
 323 int X509V3_add_value_bool();
 324 int X509V3_add_value_int();
 325 char *i2s_ASN1_INTEGER();
 326 char * i2s_ASN1_ENUMERATED();
 327 char * i2s_ASN1_ENUMERATED_TABLE();
 328 int X509V3_EXT_add();
 329 int X509V3_EXT_add_alias();
 330 void X509V3_EXT_cleanup();
 331
 332 X509V3_EXT_METHOD *X509V3_EXT_get();
 333 X509V3_EXT_METHOD *X509V3_EXT_get_nid();
 334 int X509V3_add_standard_extensions();
 335 STACK *X509V3_parse_list();
 336 char *X509V3_EXT_d2i();
 337
 338 char *hex_to_string();
 339 unsigned char *string_to_hex();
 340 int name_cmp();
 341
 342 int X509V3_EXT_print();
 343 int X509V3_EXT_print_fp();
 344 #endif
 345
 346 /* BEGIN ERROR CODES */
 347 /* Error codes for the X509V3 functions. */
 348
 349 /* Function codes. */
 350 #define X509V3_F_COPY_EMAIL                              122
 351 #define X509V3_F_COPY_ISSUER                             123
 352 #define X509V3_F_DO_EXT_CONF                             124
 353 #define X509V3_F_HEX_TO_STRING                           111
 354 #define X509V3_F_I2S_ASN1_ENUMERATED                     121
 355 #define X509V3_F_I2S_ASN1_INTEGER                        120
 356 #define X509V3_F_S2I_ASN1_IA5STRING                      100
 357 #define X509V3_F_S2I_ASN1_OCTET_STRING                   112
 358 #define X509V3_F_S2I_ASN1_SKEY_ID                        114
 359 #define X509V3_F_S2I_S2I_SKEY_ID                         115
 360 #define X509V3_F_STRING_TO_HEX                           113
 361 #define X509V3_F_V2I_ASN1_BIT_STRING                     101
 362 #define X509V3_F_V2I_AUTHORITY_KEYID                     119
 363 #define X509V3_F_V2I_BASIC_CONSTRAINTS                   102
 364 #define X509V3_F_V2I_EXT_KU                              103
 365 #define X509V3_F_V2I_GENERAL_NAME                        117
 366 #define X509V3_F_V2I_GENERAL_NAMES                       118
 367 #define X509V3_F_V3_GENERIC_EXTENSION                    116
 368 #define X509V3_F_X509V3_ADD_EXT                          104
 369 #define X509V3_F_X509V3_ADD_VALUE                        105
 370 #define X509V3_F_X509V3_EXT_ADD_ALIAS                    106
 371 #define X509V3_F_X509V3_EXT_CONF                         107
 372 #define X509V3_F_X509V3_GET_VALUE_INT                    108
 373 #define X509V3_F_X509V3_PARSE_LIST                       109
 374 #define X509V3_F_X509V3_VALUE_GET_BOOL                   110
 375
 376 /* Reason codes. */
 377 #define X509V3_R_BAD_IP_ADDRESS                          118
 378 #define X509V3_R_BAD_OBJECT                              119
 379 #define X509V3_R_BN_DEC2BN_ERROR                         100
 380 #define X509V3_R_BN_TO_ASN1_INTEGER_ERROR                101
 381 #define X509V3_R_ERROR_IN_EXTENSION                      128
 382 #define X509V3_R_EXTENSION_NAME_ERROR                    115
 383 #define X509V3_R_EXTENSION_NOT_FOUND                     102
 384 #define X509V3_R_EXTENSION_SETTING_NOT_SUPPORTED         103
 385 #define X509V3_R_EXTENSION_VALUE_ERROR                   116
 386 #define X509V3_R_ILLEGAL_HEX_DIGIT                       113
 387 #define X509V3_R_INVALID_BOOLEAN_STRING                  104
 388 #define X509V3_R_INVALID_EXTENSION_STRING                105
 389 #define X509V3_R_INVALID_NAME                            106
 390 #define X509V3_R_INVALID_NULL_ARGUMENT                   107
 391 #define X509V3_R_INVALID_NULL_NAME                       108
 392 #define X509V3_R_INVALID_NULL_VALUE                      109
 393 #define X509V3_R_INVALID_OBJECT_IDENTIFIER               110
 394 #define X509V3_R_ISSUER_DECODE_ERROR                     126
 395 #define X509V3_R_MISSING_VALUE                           124
 396 #define X509V3_R_NO_ISSUER_CERTIFICATE                   121
 397 #define X509V3_R_NO_ISSUER_DETAILS                       127
 398 #define X509V3_R_NO_PUBLIC_KEY                           114
 399 #define X509V3_R_NO_SUBJECT_DETAILS                      125
 400 #define X509V3_R_ODD_NUMBER_OF_DIGITS                    112
 401 #define X509V3_R_UNABLE_TO_GET_ISSUER_DETAILS            122
 402 #define X509V3_R_UNABLE_TO_GET_ISSUER_KEYID              123
 403 #define X509V3_R_UNKNOWN_BIT_STRING_ARGUMENT             111
 404 #define X509V3_R_UNKNOWN_EXTENSION                       129
 405 #define X509V3_R_UNKNOWN_EXTENSION_NAME                  130
 406 #define X509V3_R_UNKNOWN_OPTION                          120
 407 #define X509V3_R_UNSUPPORTED_OPTION                      117
 408
 409 #ifdef  __cplusplus
 410 }
 411 #endif
 412 #endif
 413