2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
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 * ====================================================================
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).
58 #ifndef HEADER_X509V3_H
59 #define HEADER_X509V3_H
68 /* Forward reference */
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, int indent);
83 typedef char * (*X509V3_EXT_R2I)(struct v3_ext_method *method, struct v3_ext_ctx *ctx, char *str);
85 /* V3 extension structure */
87 struct v3_ext_method {
90 X509V3_EXT_NEW ext_new;
91 X509V3_EXT_FREE ext_free;
95 /* The following pair is used for string extensions */
99 /* The following pair is used for multi-valued extensions */
103 /* The following are used for raw extensions */
107 char *usr_data; /* Any extension specific data */
110 typedef struct X509V3_CONF_METHOD_st {
111 char * (*get_string)(void *db, char *section, char *value);
112 STACK * (*get_section)(void *db, char *section);
113 void (*free_string)(void *db, char * string);
114 void (*free_section)(void *db, STACK *section);
115 } X509V3_CONF_METHOD;
117 /* Context specific info */
123 X509_REQ *subject_req;
125 X509V3_CONF_METHOD *db_meth;
127 /* Maybe more here */
130 typedef struct v3_ext_method X509V3_EXT_METHOD;
131 typedef struct v3_ext_ctx X509V3_CTX;
133 /* ext_flags values */
134 #define X509V3_EXT_DYNAMIC 0x1
135 #define X509V3_EXT_CTX_DEP 0x2
136 #define X509V3_EXT_MULTILINE 0x4
138 typedef struct BIT_STRING_BITNAME_st {
142 } BIT_STRING_BITNAME;
144 typedef BIT_STRING_BITNAME ENUMERATED_NAMES;
146 typedef struct BASIC_CONSTRAINTS_st {
148 ASN1_INTEGER *pathlen;
151 typedef struct AUTHORITY_KEYID_st {
152 ASN1_OCTET_STRING *keyid;
154 ASN1_INTEGER *serial;
157 typedef struct PKEY_USAGE_PERIOD_st {
158 ASN1_GENERALIZEDTIME *notBefore;
159 ASN1_GENERALIZEDTIME *notAfter;
162 typedef struct GENERAL_NAME_st {
164 #define GEN_OTHERNAME (0|V_ASN1_CONTEXT_SPECIFIC)
165 #define GEN_EMAIL (1|V_ASN1_CONTEXT_SPECIFIC)
166 #define GEN_DNS (2|V_ASN1_CONTEXT_SPECIFIC)
167 #define GEN_X400 (3|V_ASN1_CONTEXT_SPECIFIC)
168 #define GEN_DIRNAME (4|V_ASN1_CONTEXT_SPECIFIC)
169 #define GEN_EDIPARTY (5|V_ASN1_CONTEXT_SPECIFIC)
170 #define GEN_URI (6|V_ASN1_CONTEXT_SPECIFIC)
171 #define GEN_IPADD (7|V_ASN1_CONTEXT_SPECIFIC)
172 #define GEN_RID (8|V_ASN1_CONTEXT_SPECIFIC)
177 ASN1_IA5STRING *ia5;/* rfc822Name, dNSName, uniformResourceIdentifier */
178 ASN1_OCTET_STRING *ip; /* iPAddress */
179 X509_NAME *dirn; /* dirn */
180 ASN1_OBJECT *rid; /* registeredID */
181 ASN1_TYPE *other; /* otherName, ediPartyName, x400Address */
185 /* Strong extranet structures */
187 typedef struct SXNET_ID_st {
189 ASN1_OCTET_STRING *user;
192 DECLARE_STACK_OF(SXNETID)
193 DECLARE_ASN1_SET_OF(SXNETID)
195 typedef struct SXNET_st {
196 ASN1_INTEGER *version;
197 STACK_OF(SXNETID) *ids;
200 #define X509V3_conf_err(val) ERR_add_error_data(6, "section:", val->section, \
201 ",name:", val->name, ",value:", val->value);
203 #define EXT_BITSTRING(nid, table) { nid, 0, \
204 (X509V3_EXT_NEW)asn1_bit_string_new, ASN1_STRING_free, \
205 (X509V3_EXT_D2I)d2i_ASN1_BIT_STRING, \
206 i2d_ASN1_BIT_STRING, \
208 (X509V3_EXT_I2V)i2v_ASN1_BIT_STRING, \
209 (X509V3_EXT_V2I)v2i_ASN1_BIT_STRING, \
213 #define EXT_IA5STRING(nid) { nid, 0, \
214 (X509V3_EXT_NEW)ia5string_new, ASN1_STRING_free, \
215 (X509V3_EXT_D2I)d2i_ASN1_IA5STRING, \
216 i2d_ASN1_IA5STRING, \
217 (X509V3_EXT_I2S)i2s_ASN1_IA5STRING, \
218 (X509V3_EXT_S2I)s2i_ASN1_IA5STRING, \
219 NULL, NULL, NULL, NULL, \
222 #define EXT_END { -1, 0, NULL, NULL, NULL, NULL, NULL, NULL, \
223 NULL, NULL, NULL, NULL, \
227 void ERR_load_X509V3_strings(void);
228 int i2d_BASIC_CONSTRAINTS(BASIC_CONSTRAINTS *a, unsigned char **pp);
229 BASIC_CONSTRAINTS *d2i_BASIC_CONSTRAINTS(BASIC_CONSTRAINTS **a, unsigned char **pp, long length);
230 BASIC_CONSTRAINTS *BASIC_CONSTRAINTS_new(void);
231 void BASIC_CONSTRAINTS_free(BASIC_CONSTRAINTS *a);
233 int i2d_GENERAL_NAME(GENERAL_NAME *a, unsigned char **pp);
234 GENERAL_NAME *d2i_GENERAL_NAME(GENERAL_NAME **a, unsigned char **pp, long length);
235 GENERAL_NAME *GENERAL_NAME_new(void);
236 void GENERAL_NAME_free(GENERAL_NAME *a);
237 STACK *i2v_GENERAL_NAME(X509V3_EXT_METHOD *method, GENERAL_NAME *gen, STACK *ret);
239 int i2d_SXNET(SXNET *a, unsigned char **pp);
240 SXNET *d2i_SXNET(SXNET **a, unsigned char **pp, long length);
241 SXNET *SXNET_new(void);
242 void SXNET_free(SXNET *a);
244 int i2d_SXNETID(SXNETID *a, unsigned char **pp);
245 SXNETID *d2i_SXNETID(SXNETID **a, unsigned char **pp, long length);
246 SXNETID *SXNETID_new(void);
247 void SXNETID_free(SXNETID *a);
249 int SXNET_add_id_asc(SXNET **psx, char *zone, unsigned char *user, int userlen);
250 int SXNET_add_id_ulong(SXNET **psx, unsigned long lzone, unsigned char *user, int userlen);
251 int SXNET_add_id_INTEGER(SXNET **psx, ASN1_INTEGER *izone, unsigned char *user, int userlen);
253 ASN1_OCTET_STRING *SXNET_get_id_asc(SXNET *sx, char *zone);
254 ASN1_OCTET_STRING *SXNET_get_id_ulong(SXNET *sx, unsigned long lzone);
255 ASN1_OCTET_STRING *SXNET_get_id_INTEGER(SXNET *sx, ASN1_INTEGER *zone);
257 int i2d_AUTHORITY_KEYID(AUTHORITY_KEYID *a, unsigned char **pp);
258 AUTHORITY_KEYID *d2i_AUTHORITY_KEYID(AUTHORITY_KEYID **a, unsigned char **pp, long length);
259 AUTHORITY_KEYID *AUTHORITY_KEYID_new(void);
260 void AUTHORITY_KEYID_free(AUTHORITY_KEYID *a);
262 int i2d_PKEY_USAGE_PERIOD(PKEY_USAGE_PERIOD *a, unsigned char **pp);
263 PKEY_USAGE_PERIOD *d2i_PKEY_USAGE_PERIOD(PKEY_USAGE_PERIOD **a, unsigned char **pp, long length);
264 PKEY_USAGE_PERIOD *PKEY_USAGE_PERIOD_new(void);
265 void PKEY_USAGE_PERIOD_free(PKEY_USAGE_PERIOD *a);
267 STACK *GENERAL_NAMES_new(void);
268 void GENERAL_NAMES_free(STACK *a);
269 STACK *d2i_GENERAL_NAMES(STACK **a, unsigned char **pp, long length);
270 int i2d_GENERAL_NAMES(STACK *a, unsigned char **pp);
271 STACK *i2v_GENERAL_NAMES(X509V3_EXT_METHOD *method, STACK *gen, STACK *extlist);
272 STACK *v2i_GENERAL_NAMES(X509V3_EXT_METHOD *method, X509V3_CTX *ctx, STACK *nval);
274 char *i2s_ASN1_OCTET_STRING(X509V3_EXT_METHOD *method, ASN1_OCTET_STRING *ia5);
275 ASN1_OCTET_STRING *s2i_ASN1_OCTET_STRING(X509V3_EXT_METHOD *method, X509V3_CTX *ctx, char *str);
277 int i2d_ext_ku(STACK *a, unsigned char **pp);
278 STACK *d2i_ext_ku(STACK **a, unsigned char **pp, long length);
279 void ext_ku_free(STACK *a);
280 STACK *ext_ku_new(void);
283 GENERAL_NAME *v2i_GENERAL_NAME(X509V3_EXT_METHOD *method, X509V3_CTX *ctx, CONF_VALUE *cnf);
284 void X509V3_conf_free(CONF_VALUE *val);
285 X509_EXTENSION *X509V3_EXT_conf_nid(LHASH *conf, X509V3_CTX *ctx, int ext_nid, char *value);
286 X509_EXTENSION *X509V3_EXT_conf(LHASH *conf, X509V3_CTX *ctx, char *name, char *value);
287 int X509V3_EXT_add_conf(LHASH *conf, X509V3_CTX *ctx, char *section, X509 *cert);
288 int X509V3_EXT_CRL_add_conf(LHASH *conf, X509V3_CTX *ctx, char *section, X509_CRL *crl);
289 int X509V3_EXT_check_conf(LHASH *conf, char *section);
290 int X509V3_get_value_bool(CONF_VALUE *value, int *asn1_bool);
291 int X509V3_get_value_int(CONF_VALUE *value, ASN1_INTEGER **aint);
292 void X509V3_set_conf_lhash(X509V3_CTX *ctx, LHASH *lhash);
295 char * X509V3_get_string(X509V3_CTX *ctx, char *name, char *section);
296 STACK * X509V3_get_section(X509V3_CTX *ctx, char *section);
297 void X509V3_free_string(X509V3_CTX *ctx, char *str);
298 void X509V3_free_section( X509V3_CTX *ctx, STACK *section);
299 void X509V3_set_ctx(X509V3_CTX *ctx, X509 *issuer, X509 *subject,
300 X509_REQ *req, X509_CRL *crl, int flags);
302 int X509V3_add_value(char *name, char *value, STACK **extlist);
303 int X509V3_add_value_bool(char *name, int asn1_bool, STACK **extlist);
304 int X509V3_add_value_int( char *name, ASN1_INTEGER *aint, STACK **extlist);
305 char * i2s_ASN1_INTEGER(X509V3_EXT_METHOD *meth, ASN1_INTEGER *aint);
306 ASN1_INTEGER * s2i_ASN1_INTEGER(X509V3_EXT_METHOD *meth, char *value);
307 char * i2s_ASN1_ENUMERATED(X509V3_EXT_METHOD *meth, ASN1_ENUMERATED *aint);
308 char * i2s_ASN1_ENUMERATED_TABLE(X509V3_EXT_METHOD *meth, ASN1_ENUMERATED *aint);
309 int X509V3_EXT_add(X509V3_EXT_METHOD *ext);
310 int X509V3_EXT_add_alias(int nid_to, int nid_from);
311 void X509V3_EXT_cleanup(void);
313 X509V3_EXT_METHOD *X509V3_EXT_get(X509_EXTENSION *ext);
314 X509V3_EXT_METHOD *X509V3_EXT_get_nid(int nid);
315 int X509V3_add_standard_extensions(void);
316 STACK *X509V3_parse_list(char *line);
317 char *X509V3_EXT_d2i(X509_EXTENSION *ext);
319 char *hex_to_string(unsigned char *buffer, long len);
320 unsigned char *string_to_hex(char *str, long *len);
321 int name_cmp(char *name, char *cmp);
323 int X509V3_EXT_print(BIO *out, X509_EXTENSION *ext, int flag, int indent);
324 int X509V3_EXT_print_fp(FILE *out, X509_EXTENSION *ext, int flag, int indent);
328 void ERR_load_X509V3_strings();
329 int i2d_BASIC_CONSTRAINTS();
330 BASIC_CONSTRAINTS *d2i_BASIC_CONSTRAINTS();
331 BASIC_CONSTRAINTS *BASIC_CONSTRAINTS_new();
332 void BASIC_CONSTRAINTS_free();
334 int i2d_GENERAL_NAME();
335 GENERAL_NAME *d2i_GENERAL_NAME();
336 GENERAL_NAME *GENERAL_NAME_new();
337 void GENERAL_NAME_free();
338 STACK *i2v_GENERAL_NAME();
339 GENERAL_NAME *v2i_GENERAL_NAME();
347 SXNETID *d2i_SXNETID();
348 SXNETID *SXNETID_new();
350 int SXNET_add_id_asc();
351 int SXNET_add_id_ulong();
352 int SXNET_add_id_INTEGER();
353 ASN1_OCTET_STRING *SXNET_get_id_asc();
354 ASN1_OCTET_STRING *SXNET_get_id_ulong();
355 ASN1_OCTET_STRING *SXNET_get_id_INTEGER();
357 int i2d_AUTHORITY_KEYID();
358 AUTHORITY_KEYID *d2i_AUTHORITY_KEYID();
359 AUTHORITY_KEYID *AUTHORITY_KEYID_new();
360 void AUTHORITY_KEYID_free();
362 int i2d_PKEY_USAGE_PERIOD();
363 PKEY_USAGE_PERIOD *d2i_PKEY_USAGE_PERIOD();
364 PKEY_USAGE_PERIOD *PKEY_USAGE_PERIOD_new();
365 void PKEY_USAGE_PERIOD_free();
367 STACK *GENERAL_NAMES_new():
368 void GENERAL_NAMES_free():
369 STACK *d2i_GENERAL_NAMES();
370 int i2d_GENERAL_NAMES();
371 STACK *i2v_GENERAL_NAMES();
372 STACK *v2i_GENERAL_NAMES();
374 char *i2s_ASN1_OCTET_STRING();
375 ASN1_OCTET_STRING *s2i_ASN1_OCTET_STRING();
383 void X509V3_conf_free();
384 X509_EXTENSION *X509V3_EXT_conf_nid();
385 X509_EXTENSION *X509V3_EXT_conf();
386 int X509V3_EXT_add_conf();
387 int X509V3_EXT_check_conf();
388 int X509V3_get_value_bool();
389 int X509V3_get_value_int();
390 void X509V3_set_conf_lhash();
393 char * X509V3_get_string();
394 STACK * X509V3_get_section();
395 void X509V3_free_string();
396 void X509V3_free_section();
397 void X509V3_set_ctx();
399 int X509V3_add_value();
400 int X509V3_add_value_bool();
401 int X509V3_add_value_int();
402 char *i2s_ASN1_INTEGER();
403 ASN1_INTEGER * s2i_ASN1_INTEGER();
404 char * i2s_ASN1_ENUMERATED();
405 char * i2s_ASN1_ENUMERATED_TABLE();
406 int X509V3_EXT_add();
407 int X509V3_EXT_CRL_add_conf();
408 int X509V3_EXT_add_alias();
409 void X509V3_EXT_cleanup();
411 X509V3_EXT_METHOD *X509V3_EXT_get();
412 X509V3_EXT_METHOD *X509V3_EXT_get_nid();
413 int X509V3_add_standard_extensions();
414 STACK *X509V3_parse_list();
415 char *X509V3_EXT_d2i();
417 char *hex_to_string();
418 unsigned char *string_to_hex();
421 int X509V3_EXT_print();
422 int X509V3_EXT_print_fp();
425 /* BEGIN ERROR CODES */
426 /* Error codes for the X509V3 functions. */
428 /* Function codes. */
429 #define X509V3_F_COPY_EMAIL 122
430 #define X509V3_F_COPY_ISSUER 123
431 #define X509V3_F_DO_EXT_CONF 124
432 #define X509V3_F_HEX_TO_STRING 111
433 #define X509V3_F_I2S_ASN1_ENUMERATED 121
434 #define X509V3_F_I2S_ASN1_INTEGER 120
435 #define X509V3_F_S2I_ASN1_IA5STRING 100
436 #define X509V3_F_S2I_ASN1_INTEGER 108
437 #define X509V3_F_S2I_ASN1_OCTET_STRING 112
438 #define X509V3_F_S2I_ASN1_SKEY_ID 114
439 #define X509V3_F_S2I_S2I_SKEY_ID 115
440 #define X509V3_F_STRING_TO_HEX 113
441 #define X509V3_F_SXNET_ADD_ASC 125
442 #define X509V3_F_SXNET_ADD_ID_INTEGER 126
443 #define X509V3_F_SXNET_ADD_ID_ULONG 127
444 #define X509V3_F_SXNET_GET_ID_ASC 128
445 #define X509V3_F_SXNET_GET_ID_ULONG 129
446 #define X509V3_F_V2I_ASN1_BIT_STRING 101
447 #define X509V3_F_V2I_AUTHORITY_KEYID 119
448 #define X509V3_F_V2I_BASIC_CONSTRAINTS 102
449 #define X509V3_F_V2I_EXT_KU 103
450 #define X509V3_F_V2I_GENERAL_NAME 117
451 #define X509V3_F_V2I_GENERAL_NAMES 118
452 #define X509V3_F_V3_GENERIC_EXTENSION 116
453 #define X509V3_F_X509V3_EXT_ADD 104
454 #define X509V3_F_X509V3_ADD_VALUE 105
455 #define X509V3_F_X509V3_EXT_ADD_ALIAS 106
456 #define X509V3_F_X509V3_EXT_CONF 107
457 #define X509V3_F_X509V3_PARSE_LIST 109
458 #define X509V3_F_X509V3_GET_VALUE_BOOL 110
461 #define X509V3_R_BAD_IP_ADDRESS 118
462 #define X509V3_R_BAD_OBJECT 119
463 #define X509V3_R_BN_DEC2BN_ERROR 100
464 #define X509V3_R_BN_TO_ASN1_INTEGER_ERROR 101
465 #define X509V3_R_DUPLICATE_ZONE_ID 133
466 #define X509V3_R_ERROR_CONVERTING_ZONE 131
467 #define X509V3_R_ERROR_IN_EXTENSION 128
468 #define X509V3_R_EXTENSION_NAME_ERROR 115
469 #define X509V3_R_EXTENSION_NOT_FOUND 102
470 #define X509V3_R_EXTENSION_SETTING_NOT_SUPPORTED 103
471 #define X509V3_R_EXTENSION_VALUE_ERROR 116
472 #define X509V3_R_ILLEGAL_HEX_DIGIT 113
473 #define X509V3_R_INVALID_BOOLEAN_STRING 104
474 #define X509V3_R_INVALID_EXTENSION_STRING 105
475 #define X509V3_R_INVALID_NAME 106
476 #define X509V3_R_INVALID_NULL_ARGUMENT 107
477 #define X509V3_R_INVALID_NULL_NAME 108
478 #define X509V3_R_INVALID_NULL_VALUE 109
479 #define X509V3_R_INVALID_OBJECT_IDENTIFIER 110
480 #define X509V3_R_ISSUER_DECODE_ERROR 126
481 #define X509V3_R_MISSING_VALUE 124
482 #define X509V3_R_NO_ISSUER_CERTIFICATE 121
483 #define X509V3_R_NO_ISSUER_DETAILS 127
484 #define X509V3_R_NO_PUBLIC_KEY 114
485 #define X509V3_R_NO_SUBJECT_DETAILS 125
486 #define X509V3_R_ODD_NUMBER_OF_DIGITS 112
487 #define X509V3_R_UNABLE_TO_GET_ISSUER_DETAILS 122
488 #define X509V3_R_UNABLE_TO_GET_ISSUER_KEYID 123
489 #define X509V3_R_UNKNOWN_BIT_STRING_ARGUMENT 111
490 #define X509V3_R_UNKNOWN_EXTENSION 129
491 #define X509V3_R_UNKNOWN_EXTENSION_NAME 130
492 #define X509V3_R_UNKNOWN_OPTION 120
493 #define X509V3_R_UNSUPPORTED_OPTION 117
494 #define X509V3_R_USER_TOO_LONG 132