mark all block comments that need format preserving so that
[openssl.git] / crypto / x509v3 / v3_conf.c
1 /* v3_conf.c */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
3  * project 1999.
4  */
5 /* ====================================================================
6  * Copyright (c) 1999-2002 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 /* extension creation utilities */
59
60
61
62 #include <stdio.h>
63 #include <ctype.h>
64 #include "cryptlib.h"
65 #include <openssl/conf.h>
66 #include <openssl/x509.h>
67 #include <openssl/x509v3.h>
68
69 static int v3_check_critical(char **value);
70 static int v3_check_generic(char **value);
71 static X509_EXTENSION *do_ext_nconf(CONF *conf, X509V3_CTX *ctx, int ext_nid, int crit, char *value);
72 static X509_EXTENSION *v3_generic_extension(const char *ext, char *value, int crit, int type, X509V3_CTX *ctx);
73 static char *conf_lhash_get_string(void *db, char *section, char *value);
74 static STACK_OF(CONF_VALUE) *conf_lhash_get_section(void *db, char *section);
75 static X509_EXTENSION *do_ext_i2d(const X509V3_EXT_METHOD *method, int ext_nid,
76                                   int crit, void *ext_struc);
77 static unsigned char *generic_asn1(char *value, X509V3_CTX *ctx, long *ext_len);
78 /* CONF *conf:  Config file    */
79 /* char *name:  Name    */
80 /* char *value:  Value    */
81 X509_EXTENSION *X509V3_EXT_nconf(CONF *conf, X509V3_CTX *ctx, char *name,
82                                  char *value)
83         {
84         int crit;
85         int ext_type;
86         X509_EXTENSION *ret;
87         crit = v3_check_critical(&value);
88         if ((ext_type = v3_check_generic(&value))) 
89                 return v3_generic_extension(name, value, crit, ext_type, ctx);
90         ret = do_ext_nconf(conf, ctx, OBJ_sn2nid(name), crit, value);
91         if (!ret)
92                 {
93                 X509V3err(X509V3_F_X509V3_EXT_NCONF,X509V3_R_ERROR_IN_EXTENSION);
94                 ERR_add_error_data(4,"name=", name, ", value=", value);
95                 }
96         return ret;
97         }
98
99 /* CONF *conf:  Config file    */
100 /* char *value:  Value    */
101 X509_EXTENSION *X509V3_EXT_nconf_nid(CONF *conf, X509V3_CTX *ctx, int ext_nid,
102                                      char *value)
103         {
104         int crit;
105         int ext_type;
106         crit = v3_check_critical(&value);
107         if ((ext_type = v3_check_generic(&value))) 
108                 return v3_generic_extension(OBJ_nid2sn(ext_nid),
109                                                  value, crit, ext_type, ctx);
110         return do_ext_nconf(conf, ctx, ext_nid, crit, value);
111         }
112
113 /* CONF *conf:  Config file    */
114 /* char *value:  Value    */
115 static X509_EXTENSION *do_ext_nconf(CONF *conf, X509V3_CTX *ctx, int ext_nid,
116                                     int crit, char *value)
117         {
118         const X509V3_EXT_METHOD *method;
119         X509_EXTENSION *ext;
120         STACK_OF(CONF_VALUE) *nval;
121         void *ext_struc;
122         if (ext_nid == NID_undef)
123                 {
124                 X509V3err(X509V3_F_DO_EXT_NCONF,X509V3_R_UNKNOWN_EXTENSION_NAME);
125                 return NULL;
126                 }
127         if (!(method = X509V3_EXT_get_nid(ext_nid)))
128                 {
129                 X509V3err(X509V3_F_DO_EXT_NCONF,X509V3_R_UNKNOWN_EXTENSION);
130                 return NULL;
131                 }
132         /* Now get internal extension representation based on type */
133         if (method->v2i)
134                 {
135                 if(*value == '@') nval = NCONF_get_section(conf, value + 1);
136                 else nval = X509V3_parse_list(value);
137                 if(sk_CONF_VALUE_num(nval) <= 0)
138                         {
139                         X509V3err(X509V3_F_DO_EXT_NCONF,X509V3_R_INVALID_EXTENSION_STRING);
140                         ERR_add_error_data(4, "name=", OBJ_nid2sn(ext_nid), ",section=", value);
141                         return NULL;
142                         }
143                 ext_struc = method->v2i(method, ctx, nval);
144                 if(*value != '@') sk_CONF_VALUE_pop_free(nval,
145                                                          X509V3_conf_free);
146                 if(!ext_struc) return NULL;
147                 }
148         else if(method->s2i)
149                 {
150                 if(!(ext_struc = method->s2i(method, ctx, value))) return NULL;
151                 }
152         else if(method->r2i)
153                 {
154                 if(!ctx->db || !ctx->db_meth)
155                         {
156                         X509V3err(X509V3_F_DO_EXT_NCONF,X509V3_R_NO_CONFIG_DATABASE);
157                         return NULL;
158                         }
159                 if(!(ext_struc = method->r2i(method, ctx, value))) return NULL;
160                 }
161         else
162                 {
163                 X509V3err(X509V3_F_DO_EXT_NCONF,X509V3_R_EXTENSION_SETTING_NOT_SUPPORTED);
164                 ERR_add_error_data(2, "name=", OBJ_nid2sn(ext_nid));
165                 return NULL;
166                 }
167
168         ext  = do_ext_i2d(method, ext_nid, crit, ext_struc);
169         if(method->it) ASN1_item_free(ext_struc, ASN1_ITEM_ptr(method->it));
170         else method->ext_free(ext_struc);
171         return ext;
172
173         }
174
175 static X509_EXTENSION *do_ext_i2d(const X509V3_EXT_METHOD *method, int ext_nid,
176                                   int crit, void *ext_struc)
177         {
178         unsigned char *ext_der = NULL;
179         int ext_len;
180         ASN1_OCTET_STRING *ext_oct = NULL;
181         X509_EXTENSION *ext;
182         /* Convert internal representation to DER */
183         if (method->it)
184                 {
185                 ext_der = NULL;
186                 ext_len = ASN1_item_i2d(ext_struc, &ext_der, ASN1_ITEM_ptr(method->it));
187                 if (ext_len < 0) goto merr;
188                 }
189          else
190                 {
191                 unsigned char *p;
192                 ext_len = method->i2d(ext_struc, NULL);
193                 if(!(ext_der = OPENSSL_malloc(ext_len))) goto merr;
194                 p = ext_der;
195                 method->i2d(ext_struc, &p);
196                 }
197         if (!(ext_oct = M_ASN1_OCTET_STRING_new())) goto merr;
198         ext_oct->data = ext_der;
199         ext_der = NULL;
200         ext_oct->length = ext_len;
201
202         ext = X509_EXTENSION_create_by_NID(NULL, ext_nid, crit, ext_oct);
203         if (!ext) goto merr;
204         M_ASN1_OCTET_STRING_free(ext_oct);
205
206         return ext;
207
208         merr:
209         X509V3err(X509V3_F_DO_EXT_I2D,ERR_R_MALLOC_FAILURE);
210         if (ext_der != NULL)
211                 OPENSSL_free(ext_der);
212         if (ext_oct != NULL)
213                 M_ASN1_OCTET_STRING_free(ext_oct);
214         return NULL;
215
216         }
217
218 /* Given an internal structure, nid and critical flag create an extension */
219
220 X509_EXTENSION *X509V3_EXT_i2d(int ext_nid, int crit, void *ext_struc)
221         {
222         const X509V3_EXT_METHOD *method;
223         if (!(method = X509V3_EXT_get_nid(ext_nid))) {
224                 X509V3err(X509V3_F_X509V3_EXT_I2D,X509V3_R_UNKNOWN_EXTENSION);
225                 return NULL;
226         }
227         return do_ext_i2d(method, ext_nid, crit, ext_struc);
228 }
229
230 /* Check the extension string for critical flag */
231 static int v3_check_critical(char **value)
232 {
233         char *p = *value;
234         if ((strlen(p) < 9) || strncmp(p, "critical,", 9)) return 0;
235         p+=9;
236         while(isspace((unsigned char)*p)) p++;
237         *value = p;
238         return 1;
239 }
240
241 /* Check extension string for generic extension and return the type */
242 static int v3_check_generic(char **value)
243 {
244         int gen_type = 0;
245         char *p = *value;
246         if ((strlen(p) >= 4) && !strncmp(p, "DER:", 4))
247                 {
248                 p+=4;
249                 gen_type = 1;
250                 }
251         else if ((strlen(p) >= 5) && !strncmp(p, "ASN1:", 5))
252                 {
253                 p+=5;
254                 gen_type = 2;
255                 }
256         else
257                 return 0;
258
259         while (isspace((unsigned char)*p)) p++;
260         *value = p;
261         return gen_type;
262 }
263
264 /* Create a generic extension: for now just handle DER type */
265 static X509_EXTENSION *v3_generic_extension(const char *ext, char *value,
266                                             int crit, int gen_type,
267                                             X509V3_CTX *ctx)
268         {
269         unsigned char *ext_der=NULL;
270         long ext_len;
271         ASN1_OBJECT *obj=NULL;
272         ASN1_OCTET_STRING *oct=NULL;
273         X509_EXTENSION *extension=NULL;
274         if (!(obj = OBJ_txt2obj(ext, 0)))
275                 {
276                 X509V3err(X509V3_F_V3_GENERIC_EXTENSION,X509V3_R_EXTENSION_NAME_ERROR);
277                 ERR_add_error_data(2, "name=", ext);
278                 goto err;
279                 }
280
281         if (gen_type == 1)
282                 ext_der = string_to_hex(value, &ext_len);
283         else if (gen_type == 2)
284                 ext_der = generic_asn1(value, ctx, &ext_len);
285
286         if (ext_der == NULL)
287                 {
288                 X509V3err(X509V3_F_V3_GENERIC_EXTENSION,X509V3_R_EXTENSION_VALUE_ERROR);
289                 ERR_add_error_data(2, "value=", value);
290                 goto err;
291                 }
292
293         if (!(oct = M_ASN1_OCTET_STRING_new()))
294                 {
295                 X509V3err(X509V3_F_V3_GENERIC_EXTENSION,ERR_R_MALLOC_FAILURE);
296                 goto err;
297                 }
298
299         oct->data = ext_der;
300         oct->length = ext_len;
301         ext_der = NULL;
302
303         extension = X509_EXTENSION_create_by_OBJ(NULL, obj, crit, oct);
304
305         err:
306         ASN1_OBJECT_free(obj);
307         M_ASN1_OCTET_STRING_free(oct);
308         if(ext_der) OPENSSL_free(ext_der);
309         return extension;
310
311         }
312
313 static unsigned char *generic_asn1(char *value, X509V3_CTX *ctx, long *ext_len)
314         {
315         ASN1_TYPE *typ;
316         unsigned char *ext_der = NULL;
317         typ = ASN1_generate_v3(value, ctx);
318         if (typ == NULL)
319                 return NULL;
320         *ext_len = i2d_ASN1_TYPE(typ, &ext_der);
321         ASN1_TYPE_free(typ);
322         return ext_der;
323         }
324
325 static void delete_ext(STACK_OF(X509_EXTENSION) *sk, X509_EXTENSION *dext)
326         {
327         int idx;
328         ASN1_OBJECT *obj;
329         obj = X509_EXTENSION_get_object(dext);
330         while ((idx = X509v3_get_ext_by_OBJ(sk, obj, -1)) >= 0)
331                 {
332                 X509_EXTENSION *tmpext = X509v3_get_ext(sk, idx);
333                 X509v3_delete_ext(sk, idx);
334                 X509_EXTENSION_free(tmpext);
335                 }
336         }
337
338 /* This is the main function: add a bunch of extensions based on a config file
339  * section to an extension STACK.
340  */
341
342
343 int X509V3_EXT_add_nconf_sk(CONF *conf, X509V3_CTX *ctx, char *section,
344                             STACK_OF(X509_EXTENSION) **sk)
345         {
346         X509_EXTENSION *ext;
347         STACK_OF(CONF_VALUE) *nval;
348         CONF_VALUE *val;        
349         int i;
350         if (!(nval = NCONF_get_section(conf, section))) return 0;
351         for (i = 0; i < sk_CONF_VALUE_num(nval); i++)
352                 {
353                 val = sk_CONF_VALUE_value(nval, i);
354                 if (!(ext = X509V3_EXT_nconf(conf, ctx, val->name, val->value)))
355                                                                 return 0;
356                 if (ctx->flags == X509V3_CTX_REPLACE)   
357                         delete_ext(*sk, ext);
358                 if (sk) X509v3_add_ext(sk, ext, -1);
359                 X509_EXTENSION_free(ext);
360                 }
361         return 1;
362         }
363
364 /* Convenience functions to add extensions to a certificate, CRL and request */
365
366 int X509V3_EXT_add_nconf(CONF *conf, X509V3_CTX *ctx, char *section,
367                          X509 *cert)
368         {
369         STACK_OF(X509_EXTENSION) **sk = NULL;
370         if (cert)
371                 sk = &cert->cert_info->extensions;
372         return X509V3_EXT_add_nconf_sk(conf, ctx, section, sk);
373         }
374
375 /* Same as above but for a CRL */
376
377 int X509V3_EXT_CRL_add_nconf(CONF *conf, X509V3_CTX *ctx, char *section,
378                              X509_CRL *crl)
379         {
380         STACK_OF(X509_EXTENSION) **sk = NULL;
381         if (crl)
382                 sk = &crl->crl->extensions;
383         return X509V3_EXT_add_nconf_sk(conf, ctx, section, sk);
384         }
385
386 /* Add extensions to certificate request */
387
388 int X509V3_EXT_REQ_add_nconf(CONF *conf, X509V3_CTX *ctx, char *section,
389              X509_REQ *req)
390         {
391         STACK_OF(X509_EXTENSION) *extlist = NULL, **sk = NULL;
392         int i;
393         if (req)
394                 sk = &extlist;
395         i = X509V3_EXT_add_nconf_sk(conf, ctx, section, sk);
396         if (!i || !sk)
397                 return i;
398         i = X509_REQ_add_extensions(req, extlist);
399         sk_X509_EXTENSION_pop_free(extlist, X509_EXTENSION_free);
400         return i;
401         }
402
403 /* Config database functions */
404
405 char * X509V3_get_string(X509V3_CTX *ctx, char *name, char *section)
406         {
407         if(!ctx->db || !ctx->db_meth || !ctx->db_meth->get_string)
408                 {
409                 X509V3err(X509V3_F_X509V3_GET_STRING,X509V3_R_OPERATION_NOT_DEFINED);
410                 return NULL;
411                 }
412         if (ctx->db_meth->get_string)
413                         return ctx->db_meth->get_string(ctx->db, name, section);
414         return NULL;
415         }
416
417 STACK_OF(CONF_VALUE) * X509V3_get_section(X509V3_CTX *ctx, char *section)
418         {
419         if(!ctx->db || !ctx->db_meth || !ctx->db_meth->get_section)
420                 {
421                 X509V3err(X509V3_F_X509V3_GET_SECTION,X509V3_R_OPERATION_NOT_DEFINED);
422                 return NULL;
423                 }
424         if (ctx->db_meth->get_section)
425                         return ctx->db_meth->get_section(ctx->db, section);
426         return NULL;
427         }
428
429 void X509V3_string_free(X509V3_CTX *ctx, char *str)
430         {
431         if (!str) return;
432         if (ctx->db_meth->free_string)
433                         ctx->db_meth->free_string(ctx->db, str);
434         }
435
436 void X509V3_section_free(X509V3_CTX *ctx, STACK_OF(CONF_VALUE) *section)
437         {
438         if (!section) return;
439         if (ctx->db_meth->free_section)
440                         ctx->db_meth->free_section(ctx->db, section);
441         }
442
443 static char *nconf_get_string(void *db, char *section, char *value)
444         {
445         return NCONF_get_string(db, section, value);
446         }
447
448 static STACK_OF(CONF_VALUE) *nconf_get_section(void *db, char *section)
449         {
450         return NCONF_get_section(db, section);
451         }
452
453 static X509V3_CONF_METHOD nconf_method = {
454 nconf_get_string,
455 nconf_get_section,
456 NULL,
457 NULL
458 };
459
460 void X509V3_set_nconf(X509V3_CTX *ctx, CONF *conf)
461         {
462         ctx->db_meth = &nconf_method;
463         ctx->db = conf;
464         }
465
466 void X509V3_set_ctx(X509V3_CTX *ctx, X509 *issuer, X509 *subj, X509_REQ *req,
467                     X509_CRL *crl, int flags)
468         {
469         ctx->issuer_cert = issuer;
470         ctx->subject_cert = subj;
471         ctx->crl = crl;
472         ctx->subject_req = req;
473         ctx->flags = flags;
474         }
475
476 /* Old conf compatibility functions */
477
478 X509_EXTENSION *X509V3_EXT_conf(LHASH_OF(CONF_VALUE) *conf, X509V3_CTX *ctx,
479                                 char *name, char *value)
480         {
481         CONF ctmp;
482         CONF_set_nconf(&ctmp, conf);
483         return X509V3_EXT_nconf(&ctmp, ctx, name, value);
484         }
485
486 /* LHASH *conf:  Config file    */
487 /* char *value:  Value    */
488 X509_EXTENSION *X509V3_EXT_conf_nid(LHASH_OF(CONF_VALUE) *conf, X509V3_CTX *ctx,
489                                     int ext_nid, char *value)
490         {
491         CONF ctmp;
492         CONF_set_nconf(&ctmp, conf);
493         return X509V3_EXT_nconf_nid(&ctmp, ctx, ext_nid, value);
494         }
495
496 static char *conf_lhash_get_string(void *db, char *section, char *value)
497         {
498         return CONF_get_string(db, section, value);
499         }
500
501 static STACK_OF(CONF_VALUE) *conf_lhash_get_section(void *db, char *section)
502         {
503         return CONF_get_section(db, section);
504         }
505
506 static X509V3_CONF_METHOD conf_lhash_method = {
507 conf_lhash_get_string,
508 conf_lhash_get_section,
509 NULL,
510 NULL
511 };
512
513 void X509V3_set_conf_lhash(X509V3_CTX *ctx, LHASH_OF(CONF_VALUE) *lhash)
514         {
515         ctx->db_meth = &conf_lhash_method;
516         ctx->db = lhash;
517         }
518
519 int X509V3_EXT_add_conf(LHASH_OF(CONF_VALUE) *conf, X509V3_CTX *ctx,
520                         char *section, X509 *cert)
521         {
522         CONF ctmp;
523         CONF_set_nconf(&ctmp, conf);
524         return X509V3_EXT_add_nconf(&ctmp, ctx, section, cert);
525         }
526
527 /* Same as above but for a CRL */
528
529 int X509V3_EXT_CRL_add_conf(LHASH_OF(CONF_VALUE) *conf, X509V3_CTX *ctx,
530                             char *section, X509_CRL *crl)
531         {
532         CONF ctmp;
533         CONF_set_nconf(&ctmp, conf);
534         return X509V3_EXT_CRL_add_nconf(&ctmp, ctx, section, crl);
535         }
536
537 /* Add extensions to certificate request */
538
539 int X509V3_EXT_REQ_add_conf(LHASH_OF(CONF_VALUE) *conf, X509V3_CTX *ctx,
540                             char *section, X509_REQ *req)
541         {
542         CONF ctmp;
543         CONF_set_nconf(&ctmp, conf);
544         return X509V3_EXT_REQ_add_nconf(&ctmp, ctx, section, req);
545         }