c6f7a4824cb16dede74d671301fb34a97663599d
[openssl.git] / 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 ASN1_GENERALIZEDTIME *notBefore;
146 ASN1_GENERALIZEDTIME *notAfter;
147 } PKEY_USAGE_PERIOD;
148
149 typedef struct {
150
151 #define GEN_OTHERNAME   (0|V_ASN1_CONTEXT_SPECIFIC)
152 #define GEN_EMAIL       (1|V_ASN1_CONTEXT_SPECIFIC)
153 #define GEN_DNS         (2|V_ASN1_CONTEXT_SPECIFIC)
154 #define GEN_X400        (3|V_ASN1_CONTEXT_SPECIFIC)
155 #define GEN_DIRNAME     (4|V_ASN1_CONTEXT_SPECIFIC)
156 #define GEN_EDIPARTY    (5|V_ASN1_CONTEXT_SPECIFIC)
157 #define GEN_URI         (6|V_ASN1_CONTEXT_SPECIFIC)
158 #define GEN_IPADD       (7|V_ASN1_CONTEXT_SPECIFIC)
159 #define GEN_RID         (8|V_ASN1_CONTEXT_SPECIFIC)
160
161 int type;
162 union {
163         char *ptr;
164         ASN1_IA5STRING *ia5;/* rfc822Name, dNSName, uniformResourceIdentifier */
165         ASN1_OCTET_STRING *ip; /* iPAddress */
166         X509_NAME *dirn;                /* dirn */
167         ASN1_OBJECT *rid; /* registeredID */
168         ASN1_TYPE *other; /* otherName, ediPartyName, x400Address */
169 } d;
170 } GENERAL_NAME;
171
172
173
174
175 #define X509V3_conf_err(val) ERR_add_error_data(6, "section:", val->section, \
176 ",name:", val->name, ",value:", val->value);
177
178 #define EXT_BITSTRING(nid, table) { nid, 0, \
179                         (X509V3_EXT_NEW)asn1_bit_string_new, ASN1_STRING_free, \
180                         (X509V3_EXT_D2I)d2i_ASN1_BIT_STRING, \
181                         i2d_ASN1_BIT_STRING, \
182                         NULL, NULL, \
183                         (X509V3_EXT_I2V)i2v_ASN1_BIT_STRING, \
184                         (X509V3_EXT_V2I)v2i_ASN1_BIT_STRING, \
185                         NULL, \
186                         (char *)table}
187
188 #define EXT_IA5STRING(nid) { nid, 0, \
189                         (X509V3_EXT_NEW)ia5string_new, ASN1_STRING_free, \
190                         (X509V3_EXT_D2I)d2i_ASN1_IA5STRING, \
191                         i2d_ASN1_IA5STRING, \
192                         (X509V3_EXT_I2S)i2s_ASN1_IA5STRING, \
193                         (X509V3_EXT_S2I)s2i_ASN1_IA5STRING, \
194                         NULL, NULL, NULL, \
195                         NULL}
196
197 #define EXT_END { -1, 0, NULL, NULL, NULL, NULL, NULL, NULL, \
198                          NULL, NULL, NULL, \
199                          NULL}
200
201 #ifndef NOPROTO
202 void ERR_load_X509V3_strings(void);
203 int i2d_BASIC_CONSTRAINTS(BASIC_CONSTRAINTS *a, unsigned char **pp);
204 BASIC_CONSTRAINTS *d2i_BASIC_CONSTRAINTS(BASIC_CONSTRAINTS **a, unsigned char **pp, long length);
205 BASIC_CONSTRAINTS *BASIC_CONSTRAINTS_new(void);
206 void BASIC_CONSTRAINTS_free(BASIC_CONSTRAINTS *a);
207
208 int i2d_GENERAL_NAME(GENERAL_NAME *a, unsigned char **pp);
209 GENERAL_NAME *d2i_GENERAL_NAME(GENERAL_NAME **a, unsigned char **pp, long length);
210 GENERAL_NAME *GENERAL_NAME_new(void);
211 void GENERAL_NAME_free(GENERAL_NAME *a);
212 STACK *i2v_GENERAL_NAME(X509V3_EXT_METHOD *method, GENERAL_NAME *gen, STACK *ret);
213
214 int i2d_AUTHORITY_KEYID(AUTHORITY_KEYID *a, unsigned char **pp);
215 AUTHORITY_KEYID *d2i_AUTHORITY_KEYID(AUTHORITY_KEYID **a, unsigned char **pp, long length);
216 AUTHORITY_KEYID *AUTHORITY_KEYID_new(void);
217 void AUTHORITY_KEYID_free(AUTHORITY_KEYID *a);
218
219 int i2d_PKEY_USAGE_PERIOD(PKEY_USAGE_PERIOD *a, unsigned char **pp);
220 PKEY_USAGE_PERIOD *d2i_PKEY_USAGE_PERIOD(PKEY_USAGE_PERIOD **a, unsigned char **pp, long length);
221 PKEY_USAGE_PERIOD *PKEY_USAGE_PERIOD_new(void);
222 void PKEY_USAGE_PERIOD_free(PKEY_USAGE_PERIOD *a);
223
224 STACK *GENERAL_NAMES_new(void);
225 void GENERAL_NAMES_free(STACK *a);
226 STACK *d2i_GENERAL_NAMES(STACK **a, unsigned char **pp, long length);
227 int i2d_GENERAL_NAMES(STACK *a, unsigned char **pp);
228 STACK *i2v_GENERAL_NAMES(X509V3_EXT_METHOD *method, STACK *gen, STACK *extlist);
229 STACK *v2i_GENERAL_NAMES(X509V3_EXT_METHOD *method, X509V3_CTX *ctx, STACK *nval);
230
231 char *i2s_ASN1_OCTET_STRING(X509V3_EXT_METHOD *method, ASN1_OCTET_STRING *ia5);
232 ASN1_OCTET_STRING *s2i_ASN1_OCTET_STRING(X509V3_EXT_METHOD *method, X509V3_CTX *ctx, char *str);
233
234 int i2d_ext_ku(STACK *a, unsigned char **pp);
235 STACK *d2i_ext_ku(STACK **a, unsigned char **pp, long length);
236 void ext_ku_free(STACK *a);
237 STACK *ext_ku_new(void);
238
239 #ifdef HEADER_CONF_H
240 GENERAL_NAME *v2i_GENERAL_NAME(X509V3_EXT_METHOD *method, X509V3_CTX *ctx, CONF_VALUE *cnf);
241 void X509V3_conf_free(CONF_VALUE *val);
242 X509_EXTENSION *X509V3_EXT_conf_nid(LHASH *conf, X509V3_CTX *ctx, int ext_nid, char *value);
243 X509_EXTENSION *X509V3_EXT_conf(LHASH *conf, X509V3_CTX *ctx, char *name, char *value);
244 int X509V3_EXT_add_conf(LHASH *conf, X509V3_CTX *ctx, char *section, X509 *cert);
245 int X509V3_EXT_check_conf(LHASH *conf, char *section);
246 int X509V3_get_value_bool(CONF_VALUE *value, int *asn1_bool);
247 int X509V3_get_value_int(CONF_VALUE *value, ASN1_INTEGER **aint);
248 #endif
249
250 int X509V3_add_value(char *name, char *value, STACK **extlist);
251 int X509V3_add_value_bool(char *name, int asn1_bool, STACK **extlist);
252 int X509V3_add_value_int( char *name, ASN1_INTEGER *aint, STACK **extlist);
253 char * i2s_ASN1_INTEGER(X509V3_EXT_METHOD *meth, ASN1_INTEGER *aint);
254 int X509V3_EXT_add(X509V3_EXT_METHOD *ext);
255 int X509V3_EXT_add_alias(int nid_to, int nid_from);
256 void X509V3_EXT_cleanup(void);
257
258 X509V3_EXT_METHOD *X509V3_EXT_get(X509_EXTENSION *ext);
259 X509V3_EXT_METHOD *X509V3_EXT_get_nid(int nid);
260 int X509V3_add_standard_extensions(void);
261 STACK *X509V3_parse_list(char *line);
262 char *X509V3_EXT_d2i(X509_EXTENSION *ext);
263
264 char *hex_to_string(unsigned char *buffer, long len);
265 unsigned char *string_to_hex(char *str, long *len);
266 int name_cmp(char *name, char *cmp);
267
268 int X509V3_EXT_print(BIO *out, X509_EXTENSION *ext, int flag);
269 int X509V3_EXT_print_fp(FILE *out, X509_EXTENSION *ext, int flag);
270
271 #else
272
273 void ERR_load_X509V3_strings();
274 int i2d_BASIC_CONSTRAINTS();
275 BASIC_CONSTRAINTS *d2i_BASIC_CONSTRAINTS();
276 BASIC_CONSTRAINTS *BASIC_CONSTRAINTS_new();
277 void BASIC_CONSTRAINTS_free();
278
279 int i2d_GENERAL_NAME();
280 GENERAL_NAME *d2i_GENERAL_NAME();
281 GENERAL_NAME *GENERAL_NAME_new();
282 void GENERAL_NAME_free();
283 STACK *i2v_GENERAL_NAME();
284 GENERAL_NAME *v2i_GENERAL_NAME();
285
286 int i2d_PKEY_USAGE_PERIOD();
287 PKEY_USAGE_PERIOD *d2i_PKEY_USAGE_PERIOD();
288 PKEY_USAGE_PERIOD *PKEY_USAGE_PERIOD_new();
289 void PKEY_USAGE_PERIOD_free();
290
291 STACK *GENERAL_NAMES_new():
292 void GENERAL_NAMES_free():
293 STACK *d2i_GENERAL_NAMES();
294 int i2d_GENERAL_NAMES();
295 STACK *i2v_GENERAL_NAMES();
296 STACK *v2i_GENERAL_NAMES();
297
298 char *i2s_ASN1_OCTET_STRING();
299 ASN1_OCTET_STRING *s2i_ASN1_OCTET_STRING();
300
301 int i2d_ext_ku();
302 STACK *d2i_ext_ku();
303 void ext_ku_free();
304 STACK *ext_ku_new();
305
306 #ifdef HEADER_CONF_H
307 void X509V3_conf_free();
308 X509_EXTENSION *X509V3_EXT_conf_nid();
309 X509_EXTENSION *X509V3_EXT_conf();
310 int X509V3_EXT_add_conf();
311 int X509V3_EXT_check_conf();
312 int X509V3_get_value_bool();
313 int X509V3_get_value_int();
314 #endif
315
316 int X509V3_add_value();
317 int X509V3_add_value_bool();
318 int X509V3_add_value_int();
319 char *i2s_ASN1_INTEGER();
320 int X509V3_EXT_add();
321 int X509V3_EXT_add_alias();
322 void X509V3_EXT_cleanup();
323
324 X509V3_EXT_METHOD *X509V3_EXT_get();
325 X509V3_EXT_METHOD *X509V3_EXT_get_nid();
326 int X509V3_add_standard_extensions();
327 STACK *X509V3_parse_list();
328 char *X509V3_EXT_get_d2i();
329
330 char *hex_to_string();
331 unsigned char *string_to_hex();
332 int name_cmp();
333
334 int X509V3_EXT_print();
335 int X509V3_EXT_print_fp();
336 #endif
337
338 /* BEGIN ERROR CODES */
339 /* Error codes for the X509V3 functions. */
340
341 /* Function codes. */
342 #define X509V3_F_HEX_TO_STRING                           111
343 #define X509V3_F_I2S_ASN1_INTEGER                        120
344 #define X509V3_F_S2I_ASN1_IA5STRING                      100
345 #define X509V3_F_S2I_ASN1_OCTET_STRING                   112
346 #define X509V3_F_S2I_ASN1_SKEY_ID                        114
347 #define X509V3_F_S2I_S2I_SKEY_ID                         115
348 #define X509V3_F_STRING_TO_HEX                           113
349 #define X509V3_F_V2I_ASN1_BIT_STRING                     101
350 #define X509V3_F_V2I_AUTHORITY_KEYID                     119
351 #define X509V3_F_V2I_BASIC_CONSTRAINTS                   102
352 #define X509V3_F_V2I_EXT_KU                              103
353 #define X509V3_F_V2I_GENERAL_NAME                        117
354 #define X509V3_F_V2I_GENERAL_NAMES                       118
355 #define X509V3_F_V3_GENERIC_EXTENSION                    116
356 #define X509V3_F_X509V3_ADD_EXT                          104
357 #define X509V3_F_X509V3_ADD_VALUE                        105
358 #define X509V3_F_X509V3_EXT_ADD_ALIAS                    106
359 #define X509V3_F_X509V3_EXT_CONF                         107
360 #define X509V3_F_X509V3_GET_VALUE_INT                    108
361 #define X509V3_F_X509V3_PARSE_LIST                       109
362 #define X509V3_F_X509V3_VALUE_GET_BOOL                   110
363
364 /* Reason codes. */
365 #define X509V3_R_BAD_IP_ADDRESS                          118
366 #define X509V3_R_BAD_OBJECT                              119
367 #define X509V3_R_BN_DEC2BN_ERROR                         100
368 #define X509V3_R_BN_TO_ASN1_INTEGER_ERROR                101
369 #define X509V3_R_EXTENSION_NAME_ERROR                    115
370 #define X509V3_R_EXTENSION_NOT_FOUND                     102
371 #define X509V3_R_EXTENSION_SETTING_NOT_SUPPORTED         103
372 #define X509V3_R_EXTENSION_VALUE_ERROR                   116
373 #define X509V3_R_ILLEGAL_HEX_DIGIT                       113
374 #define X509V3_R_INVALID_BOOLEAN_STRING                  104
375 #define X509V3_R_INVALID_EXTENSION_STRING                105
376 #define X509V3_R_INVALID_NAME                            106
377 #define X509V3_R_INVALID_NULL_ARGUMENT                   107
378 #define X509V3_R_INVALID_NULL_NAME                       108
379 #define X509V3_R_INVALID_NULL_VALUE                      109
380 #define X509V3_R_INVALID_OBJECT_IDENTIFIER               110
381 #define X509V3_R_NO_ISSUER_CERTIFICATE                   121
382 #define X509V3_R_NO_PUBLIC_KEY                           114
383 #define X509V3_R_ODD_NUMBER_OF_DIGITS                    112
384 #define X509V3_R_UNABLE_TO_GET_ISSUER_DETAILS            122
385 #define X509V3_R_UNABLE_TO_GET_ISSUER_KEYID              123
386 #define X509V3_R_UNKNOWN_BIT_STRING_ARGUMENT             111
387 #define X509V3_R_UNKNOWN_OPTION                          120
388 #define X509V3_R_UNSUPPORTED_OPTION                      117
389  
390 #ifdef  __cplusplus
391 }
392 #endif
393 #endif
394