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
  84 /* V3 extension structure */
  85
  86 struct v3_ext_method {
  87 int ext_nid;
  88 int ext_flags;
  89 X509V3_EXT_NEW ext_new;
  90 X509V3_EXT_FREE ext_free;
  91 X509V3_EXT_D2I d2i;
  92 X509V3_EXT_I2D i2d;
  93
  94 /* The following pair is used for string extensions */
  95 X509V3_EXT_I2S i2s;
  96 X509V3_EXT_S2I s2i;
  97
  98 /* The following pair is used for multi-valued extensions */
  99 X509V3_EXT_I2V i2v;
 100 X509V3_EXT_V2I v2i;
 101
 102 /* The following is used for raw extensions */
 103 X509V3_EXT_I2R i2r;
 104
 105 char *usr_data; /* Any extension specific data */
 106 };
 107
 108
 109 /* Context specific info */
 110 struct v3_ext_ctx {
 111 #define CTX_TEST 0x1
 112 int flags;
 113 X509 *issuer_cert;
 114 X509 *subject_cert;
 115 X509_REQ *subject_req;
 116 X509_CRL *crl;
 117 /* Maybe more here */
 118 };
 119
 120 typedef struct v3_ext_method X509V3_EXT_METHOD;
 121 typedef struct v3_ext_ctx X509V3_CTX;
 122
 123 /* ext_flags values */
 124 #define X509V3_EXT_DYNAMIC 0x1
 125 #define X509V3_EXT_CTX_DEP 0x2
 126
 127 typedef struct {
 128 int bitnum;
 129 char *lname;
 130 char *sname;
 131 } BIT_STRING_BITNAME;
 132
 133 typedef struct {
 134 int ca;
 135 ASN1_INTEGER *pathlen;
 136 } BASIC_CONSTRAINTS;
 137
 138 typedef struct {
 139 ASN1_OCTET_STRING *keyid;
 140 STACK *issuer;
 141 ASN1_INTEGER *serial;
 142 } AUTHORITY_KEYID;
 143
 144 typedef struct {
 145
 146 #define GEN_OTHERNAME   (0|V_ASN1_CONTEXT_SPECIFIC)
 147 #define GEN_EMAIL       (1|V_ASN1_CONTEXT_SPECIFIC)
 148 #define GEN_DNS         (2|V_ASN1_CONTEXT_SPECIFIC)
 149 #define GEN_X400        (3|V_ASN1_CONTEXT_SPECIFIC)
 150 #define GEN_DIRNAME     (4|V_ASN1_CONTEXT_SPECIFIC)
 151 #define GEN_EDIPARTY    (5|V_ASN1_CONTEXT_SPECIFIC)
 152 #define GEN_URI         (6|V_ASN1_CONTEXT_SPECIFIC)
 153 #define GEN_IPADD       (7|V_ASN1_CONTEXT_SPECIFIC)
 154 #define GEN_RID         (8|V_ASN1_CONTEXT_SPECIFIC)
 155
 156 int type;
 157 union {
 158         char *ptr;
 159         ASN1_IA5STRING *ia5;/* rfc822Name, dNSName, uniformResourceIdentifier */
 160         ASN1_OCTET_STRING *ip; /* iPAddress */
 161         X509_NAME *dirn;                /* dirn */
 162         ASN1_OBJECT *rid; /* registeredID */
 163         ASN1_TYPE *other; /* otherName, ediPartyName, x400Address */
 164 } d;
 165 } GENERAL_NAME;
 166
 167
 168
 169
 170 #define X509V3_conf_err(val) ERR_add_error_data(6, "section:", val->section, \
 171 ",name:", val->name, ",value:", val->value);
 172
 173 #define EXT_BITSTRING(nid, table) { nid, 0, \
 174                         (X509V3_EXT_NEW)asn1_bit_string_new, ASN1_STRING_free, \
 175                         (X509V3_EXT_D2I)d2i_ASN1_BIT_STRING, \
 176                         i2d_ASN1_BIT_STRING, \
 177                         NULL, NULL, \
 178                         (X509V3_EXT_I2V)i2v_ASN1_BIT_STRING, \
 179                         (X509V3_EXT_V2I)v2i_ASN1_BIT_STRING, \
 180                         NULL, \
 181                         (char *)table}
 182
 183 #define EXT_IA5STRING(nid) { nid, 0, \
 184                         (X509V3_EXT_NEW)ia5string_new, ASN1_STRING_free, \
 185                         (X509V3_EXT_D2I)d2i_ASN1_IA5STRING, \
 186                         i2d_ASN1_IA5STRING, \
 187                         (X509V3_EXT_I2S)i2s_ASN1_IA5STRING, \
 188                         (X509V3_EXT_S2I)s2i_ASN1_IA5STRING, \
 189                         NULL, NULL, NULL, \
 190                         NULL}
 191
 192 #define EXT_END { -1, 0, NULL, NULL, NULL, NULL, NULL, NULL, \
 193                          NULL, NULL, NULL, \
 194                          NULL}
 195
 196 #ifndef NOPROTO
 197 void ERR_load_X509V3_strings(void);
 198 int i2d_BASIC_CONSTRAINTS(BASIC_CONSTRAINTS *a, unsigned char **pp);
 199 BASIC_CONSTRAINTS *d2i_BASIC_CONSTRAINTS(BASIC_CONSTRAINTS **a, unsigned char **pp, long length);
 200 BASIC_CONSTRAINTS *BASIC_CONSTRAINTS_new(void);
 201 void BASIC_CONSTRAINTS_free(BASIC_CONSTRAINTS *a);
 202
 203 int i2d_GENERAL_NAME(GENERAL_NAME *a, unsigned char **pp);
 204 GENERAL_NAME *d2i_GENERAL_NAME(GENERAL_NAME **a, unsigned char **pp, long length);
 205 GENERAL_NAME *GENERAL_NAME_new(void);
 206 void GENERAL_NAME_free(GENERAL_NAME *a);
 207 STACK *i2v_GENERAL_NAME(X509V3_EXT_METHOD *method, GENERAL_NAME *gen, STACK *ret);
 208
 209 int i2d_AUTHORITY_KEYID(AUTHORITY_KEYID *a, unsigned char **pp);
 210 AUTHORITY_KEYID *d2i_AUTHORITY_KEYID(AUTHORITY_KEYID **a, unsigned char **pp, long length);
 211 AUTHORITY_KEYID *AUTHORITY_KEYID_new(void);
 212 void AUTHORITY_KEYID_free(AUTHORITY_KEYID *a);
 213
 214 STACK *GENERAL_NAMES_new(void);
 215 void GENERAL_NAMES_free(STACK *a);
 216 STACK *d2i_GENERAL_NAMES(STACK **a, unsigned char **pp, long length);
 217 int i2d_GENERAL_NAMES(STACK *a, unsigned char **pp);
 218 STACK *i2v_GENERAL_NAMES(X509V3_EXT_METHOD *method, STACK *gen, STACK *extlist);
 219 STACK *v2i_GENERAL_NAMES(X509V3_EXT_METHOD *method, X509V3_CTX *ctx, STACK *nval);
 220
 221 char *i2s_ASN1_OCTET_STRING(X509V3_EXT_METHOD *method, ASN1_OCTET_STRING *ia5);
 222 ASN1_OCTET_STRING *s2i_ASN1_OCTET_STRING(X509V3_EXT_METHOD *method, X509V3_CTX *ctx, char *str);
 223
 224 int i2d_ext_ku(STACK *a, unsigned char **pp);
 225 STACK *d2i_ext_ku(STACK **a, unsigned char **pp, long length);
 226 void ext_ku_free(STACK *a);
 227 STACK *ext_ku_new(void);
 228
 229 #ifdef HEADER_CONF_H
 230 GENERAL_NAME *v2i_GENERAL_NAME(X509V3_EXT_METHOD *method, X509V3_CTX *ctx, CONF_VALUE *cnf);
 231 void X509V3_conf_free(CONF_VALUE *val);
 232 X509_EXTENSION *X509V3_EXT_conf_nid(LHASH *conf, X509V3_CTX *ctx, int ext_nid, char *value);
 233 X509_EXTENSION *X509V3_EXT_conf(LHASH *conf, X509V3_CTX *ctx, char *name, char *value);
 234 int X509V3_EXT_add_conf(LHASH *conf, X509V3_CTX *ctx, char *section, X509 *cert);
 235 int X509V3_EXT_check_conf(LHASH *conf, char *section);
 236 int X509V3_get_value_bool(CONF_VALUE *value, int *asn1_bool);
 237 int X509V3_get_value_int(CONF_VALUE *value, ASN1_INTEGER **aint);
 238 #endif
 239
 240 int X509V3_add_value(char *name, char *value, STACK **extlist);
 241 int X509V3_add_value_bool(char *name, int asn1_bool, STACK **extlist);
 242 int X509V3_add_value_int( char *name, ASN1_INTEGER *aint, STACK **extlist);
 243 int X509V3_EXT_add(X509V3_EXT_METHOD *ext);
 244 int X509V3_EXT_add_alias(int nid_to, int nid_from);
 245 void X509V3_EXT_cleanup(void);
 246
 247 X509V3_EXT_METHOD *X509V3_EXT_get(X509_EXTENSION *ext);
 248 X509V3_EXT_METHOD *X509V3_EXT_get_nid(int nid);
 249 int X509V3_add_standard_extensions(void);
 250 STACK *X509V3_parse_list(char *line);
 251
 252 char *hex_to_string(unsigned char *buffer, long len);
 253 unsigned char *string_to_hex(char *str, long *len);
 254 int name_cmp(char *name, char *cmp);
 255
 256 int X509V3_EXT_print(BIO *out, X509_EXTENSION *ext, int flag);
 257 int X509V3_EXT_print_fp(FILE *out, X509_EXTENSION *ext, int flag);
 258
 259 #else
 260
 261 void ERR_load_X509V3_strings();
 262 int i2d_BASIC_CONSTRAINTS();
 263 BASIC_CONSTRAINTS *d2i_BASIC_CONSTRAINTS();
 264 BASIC_CONSTRAINTS *BASIC_CONSTRAINTS_new();
 265 void BASIC_CONSTRAINTS_free();
 266
 267 int i2d_GENERAL_NAME();
 268 GENERAL_NAME *d2i_GENERAL_NAME();
 269 GENERAL_NAME *GENERAL_NAME_new();
 270 void GENERAL_NAME_free();
 271 STACK *i2v_GENERAL_NAME();
 272 GENERAL_NAME *v2i_GENERAL_NAME();
 273
 274 STACK *GENERAL_NAMES_new():
 275 void GENERAL_NAMES_free():
 276 STACK *d2i_GENERAL_NAMES();
 277 int i2d_GENERAL_NAMES();
 278 STACK *i2v_GENERAL_NAMES();
 279 STACK *v2i_GENERAL_NAMES();
 280
 281 char *i2s_ASN1_OCTET_STRING();
 282 ASN1_OCTET_STRING *s2i_ASN1_OCTET_STRING();
 283
 284 int i2d_ext_ku();
 285 STACK *d2i_ext_ku();
 286 void ext_ku_free();
 287 STACK *ext_ku_new();
 288
 289 #ifdef HEADER_CONF_H
 290 void X509V3_conf_free();
 291 X509_EXTENSION *X509V3_EXT_conf_nid();
 292 X509_EXTENSION *X509V3_EXT_conf();
 293 int X509V3_EXT_add_conf();
 294 int X509V3_EXT_check_conf();
 295 int X509V3_get_value_bool();
 296 int X509V3_get_value_int();
 297 #endif
 298
 299 int X509V3_add_value();
 300 int X509V3_add_value_bool();
 301 int X509V3_add_value_int();
 302 int X509V3_EXT_add();
 303 int X509V3_EXT_add_alias();
 304 void X509V3_EXT_cleanup();
 305
 306 X509V3_EXT_METHOD *X509V3_EXT_get();
 307 X509V3_EXT_METHOD *X509V3_EXT_get_nid();
 308 int X509V3_add_standard_extensions();
 309 STACK *X509V3_parse_list();
 310
 311 char *hex_to_string();
 312 unsigned char *string_to_hex();
 313 int name_cmp();
 314
 315 int X509V3_EXT_print();
 316 int X509V3_EXT_print_fp();
 317 #endif
 318
 319 /* BEGIN ERROR CODES */
 320 /* Error codes for the X509V3 functions. */
 321
 322 /* Function codes. */
 323 #define X509V3_F_HEX_TO_STRING                           111
 324 #define X509V3_F_S2I_ASN1_IA5STRING                      100
 325 #define X509V3_F_S2I_ASN1_OCTET_STRING                   112
 326 #define X509V3_F_S2I_ASN1_SKEY_ID                        114
 327 #define X509V3_F_S2I_S2I_SKEY_ID                         115
 328 #define X509V3_F_STRING_TO_HEX                           113
 329 #define X509V3_F_V2I_ASN1_BIT_STRING                     101
 330 #define X509V3_F_V2I_BASIC_CONSTRAINTS                   102
 331 #define X509V3_F_V2I_EXT_KU                              103
 332 #define X509V3_F_V2I_GENERAL_NAME                        117
 333 #define X509V3_F_V2I_GENERAL_NAMES                       118
 334 #define X509V3_F_V3_GENERIC_EXTENSION                    116
 335 #define X509V3_F_X509V3_ADD_EXT                          104
 336 #define X509V3_F_X509V3_ADD_VALUE                        105
 337 #define X509V3_F_X509V3_EXT_ADD_ALIAS                    106
 338 #define X509V3_F_X509V3_EXT_CONF                         107
 339 #define X509V3_F_X509V3_GET_VALUE_INT                    108
 340 #define X509V3_F_X509V3_PARSE_LIST                       109
 341 #define X509V3_F_X509V3_VALUE_GET_BOOL                   110
 342
 343 /* Reason codes. */
 344 #define X509V3_R_BAD_IP_ADDRESS                          118
 345 #define X509V3_R_BAD_OBJECT                              119
 346 #define X509V3_R_BN_DEC2BN_ERROR                         100
 347 #define X509V3_R_BN_TO_ASN1_INTEGER_ERROR                101
 348 #define X509V3_R_EXTENSION_NAME_ERROR                    115
 349 #define X509V3_R_EXTENSION_NOT_FOUND                     102
 350 #define X509V3_R_EXTENSION_SETTING_NOT_SUPPORTED         103
 351 #define X509V3_R_EXTENSION_VALUE_ERROR                   116
 352 #define X509V3_R_ILLEGAL_HEX_DIGIT                       113
 353 #define X509V3_R_INVALID_BOOLEAN_STRING                  104
 354 #define X509V3_R_INVALID_EXTENSION_STRING                105
 355 #define X509V3_R_INVALID_NAME                            106
 356 #define X509V3_R_INVALID_NULL_ARGUMENT                   107
 357 #define X509V3_R_INVALID_NULL_NAME                       108
 358 #define X509V3_R_INVALID_NULL_VALUE                      109
 359 #define X509V3_R_INVALID_OBJECT_IDENTIFIER               110
 360 #define X509V3_R_NO_PUBLIC_KEY                           114
 361 #define X509V3_R_ODD_NUMBER_OF_DIGITS                    112
 362 #define X509V3_R_UNKNOWN_BIT_STRING_ARGUMENT             111
 363 #define X509V3_R_UNSUPPORTED_OPTION                      117
 364
 365 #ifdef  __cplusplus
 366 }
 367 #endif
 368 #endif
 369