2 * Copyright 1999-2021 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* extension creation utilities */
13 #include "crypto/ctype.h"
14 #include "internal/cryptlib.h"
15 #include <openssl/conf.h>
16 #include <openssl/x509.h>
17 #include "crypto/x509.h"
18 #include <openssl/x509v3.h>
20 static int v3_check_critical(const char **value);
21 static int v3_check_generic(const char **value);
22 static X509_EXTENSION *do_ext_nconf(CONF *conf, X509V3_CTX *ctx, int ext_nid,
23 int crit, const char *value);
24 static X509_EXTENSION *v3_generic_extension(const char *ext, const char *value,
27 static char *conf_lhash_get_string(void *db, const char *section, const char *value);
28 static STACK_OF(CONF_VALUE) *conf_lhash_get_section(void *db, const char *section);
29 static X509_EXTENSION *do_ext_i2d(const X509V3_EXT_METHOD *method,
30 int ext_nid, int crit, void *ext_struc);
31 static unsigned char *generic_asn1(const char *value, X509V3_CTX *ctx,
34 static X509_EXTENSION *X509V3_EXT_nconf_int(CONF *conf, X509V3_CTX *ctx,
36 const char *name, const char *value)
42 crit = v3_check_critical(&value);
43 if ((ext_type = v3_check_generic(&value)))
44 return v3_generic_extension(name, value, crit, ext_type, ctx);
45 ret = do_ext_nconf(conf, ctx, OBJ_sn2nid(name), crit, value);
48 ERR_raise_data(ERR_LIB_X509V3, X509V3_R_ERROR_IN_EXTENSION,
49 "section=%s, name=%s, value=%s",
50 section, name, value);
52 ERR_raise_data(ERR_LIB_X509V3, X509V3_R_ERROR_IN_EXTENSION,
53 "name=%s, value=%s", name, value);
58 X509_EXTENSION *X509V3_EXT_nconf(CONF *conf, X509V3_CTX *ctx, const char *name,
61 return X509V3_EXT_nconf_int(conf, ctx, NULL, name, value);
64 X509_EXTENSION *X509V3_EXT_nconf_nid(CONF *conf, X509V3_CTX *ctx, int ext_nid,
70 crit = v3_check_critical(&value);
71 if ((ext_type = v3_check_generic(&value)))
72 return v3_generic_extension(OBJ_nid2sn(ext_nid),
73 value, crit, ext_type, ctx);
74 return do_ext_nconf(conf, ctx, ext_nid, crit, value);
77 /* CONF *conf: Config file */
78 /* char *value: Value */
79 static X509_EXTENSION *do_ext_nconf(CONF *conf, X509V3_CTX *ctx, int ext_nid,
80 int crit, const char *value)
82 const X509V3_EXT_METHOD *method;
84 STACK_OF(CONF_VALUE) *nval;
87 if (ext_nid == NID_undef) {
88 ERR_raise(ERR_LIB_X509V3, X509V3_R_UNKNOWN_EXTENSION_NAME);
91 if ((method = X509V3_EXT_get_nid(ext_nid)) == NULL) {
92 ERR_raise(ERR_LIB_X509V3, X509V3_R_UNKNOWN_EXTENSION);
95 /* Now get internal extension representation based on type */
98 nval = NCONF_get_section(conf, value + 1);
100 nval = X509V3_parse_list(value);
101 if (nval == NULL || sk_CONF_VALUE_num(nval) <= 0) {
102 ERR_raise_data(ERR_LIB_X509V3, X509V3_R_INVALID_EXTENSION_STRING,
103 "name=%s,section=%s", OBJ_nid2sn(ext_nid), value);
105 sk_CONF_VALUE_pop_free(nval, X509V3_conf_free);
108 ext_struc = method->v2i(method, ctx, nval);
110 sk_CONF_VALUE_pop_free(nval, X509V3_conf_free);
113 } else if (method->s2i) {
114 if ((ext_struc = method->s2i(method, ctx, value)) == NULL)
116 } else if (method->r2i) {
117 if (!ctx->db || !ctx->db_meth) {
118 ERR_raise(ERR_LIB_X509V3, X509V3_R_NO_CONFIG_DATABASE);
121 if ((ext_struc = method->r2i(method, ctx, value)) == NULL)
124 ERR_raise_data(ERR_LIB_X509V3, X509V3_R_EXTENSION_SETTING_NOT_SUPPORTED,
125 "name=%s", OBJ_nid2sn(ext_nid));
129 ext = do_ext_i2d(method, ext_nid, crit, ext_struc);
131 ASN1_item_free(ext_struc, ASN1_ITEM_ptr(method->it));
133 method->ext_free(ext_struc);
138 static X509_EXTENSION *do_ext_i2d(const X509V3_EXT_METHOD *method,
139 int ext_nid, int crit, void *ext_struc)
141 unsigned char *ext_der = NULL;
143 ASN1_OCTET_STRING *ext_oct = NULL;
146 /* Convert internal representation to DER */
150 ASN1_item_i2d(ext_struc, &ext_der, ASN1_ITEM_ptr(method->it));
156 ext_len = method->i2d(ext_struc, NULL);
159 if ((ext_der = OPENSSL_malloc(ext_len)) == NULL)
162 method->i2d(ext_struc, &p);
164 if ((ext_oct = ASN1_OCTET_STRING_new()) == NULL)
166 ext_oct->data = ext_der;
168 ext_oct->length = ext_len;
170 ext = X509_EXTENSION_create_by_NID(NULL, ext_nid, crit, ext_oct);
173 ASN1_OCTET_STRING_free(ext_oct);
178 ERR_raise(ERR_LIB_X509V3, ERR_R_MALLOC_FAILURE);
179 OPENSSL_free(ext_der);
180 ASN1_OCTET_STRING_free(ext_oct);
185 /* Given an internal structure, nid and critical flag create an extension */
187 X509_EXTENSION *X509V3_EXT_i2d(int ext_nid, int crit, void *ext_struc)
189 const X509V3_EXT_METHOD *method;
191 if ((method = X509V3_EXT_get_nid(ext_nid)) == NULL) {
192 ERR_raise(ERR_LIB_X509V3, X509V3_R_UNKNOWN_EXTENSION);
195 return do_ext_i2d(method, ext_nid, crit, ext_struc);
198 /* Check the extension string for critical flag */
199 static int v3_check_critical(const char **value)
201 const char *p = *value;
203 if ((strlen(p) < 9) || strncmp(p, "critical,", 9))
206 while (ossl_isspace(*p))
212 /* Check extension string for generic extension and return the type */
213 static int v3_check_generic(const char **value)
216 const char *p = *value;
218 if ((strlen(p) >= 4) && strncmp(p, "DER:", 4) == 0) {
221 } else if ((strlen(p) >= 5) && strncmp(p, "ASN1:", 5) == 0) {
227 while (ossl_isspace(*p))
233 /* Create a generic extension: for now just handle DER type */
234 static X509_EXTENSION *v3_generic_extension(const char *ext, const char *value,
235 int crit, int gen_type,
238 unsigned char *ext_der = NULL;
240 ASN1_OBJECT *obj = NULL;
241 ASN1_OCTET_STRING *oct = NULL;
242 X509_EXTENSION *extension = NULL;
244 if ((obj = OBJ_txt2obj(ext, 0)) == NULL) {
245 ERR_raise_data(ERR_LIB_X509V3, X509V3_R_EXTENSION_NAME_ERROR,
251 ext_der = OPENSSL_hexstr2buf(value, &ext_len);
252 else if (gen_type == 2)
253 ext_der = generic_asn1(value, ctx, &ext_len);
255 if (ext_der == NULL) {
256 ERR_raise_data(ERR_LIB_X509V3, X509V3_R_EXTENSION_VALUE_ERROR,
261 if ((oct = ASN1_OCTET_STRING_new()) == NULL) {
262 ERR_raise(ERR_LIB_X509V3, ERR_R_MALLOC_FAILURE);
267 oct->length = ext_len;
270 extension = X509_EXTENSION_create_by_OBJ(NULL, obj, crit, oct);
273 ASN1_OBJECT_free(obj);
274 ASN1_OCTET_STRING_free(oct);
275 OPENSSL_free(ext_der);
280 static unsigned char *generic_asn1(const char *value, X509V3_CTX *ctx,
284 unsigned char *ext_der = NULL;
286 typ = ASN1_generate_v3(value, ctx);
289 *ext_len = i2d_ASN1_TYPE(typ, &ext_der);
294 static void delete_ext(STACK_OF(X509_EXTENSION) *sk, X509_EXTENSION *dext)
299 obj = X509_EXTENSION_get_object(dext);
300 while ((idx = X509v3_get_ext_by_OBJ(sk, obj, -1)) >= 0)
301 X509_EXTENSION_free(X509v3_delete_ext(sk, idx));
305 * This is the main function: add a bunch of extensions based on a config
306 * file section to an extension STACK. Just check in case sk == NULL.
307 * Note that on error new elements may have been added to *sk if sk != NULL.
309 int X509V3_EXT_add_nconf_sk(CONF *conf, X509V3_CTX *ctx, const char *section,
310 STACK_OF(X509_EXTENSION) **sk)
313 STACK_OF(CONF_VALUE) *nval;
317 if ((nval = NCONF_get_section(conf, section)) == NULL)
319 for (i = 0; i < sk_CONF_VALUE_num(nval); i++) {
320 val = sk_CONF_VALUE_value(nval, i);
321 if ((ext = X509V3_EXT_nconf_int(conf, ctx, val->section,
322 val->name, val->value)) == NULL)
325 if (ctx->flags == X509V3_CTX_REPLACE)
326 delete_ext(*sk, ext);
327 if (X509v3_add_ext(sk, ext, -1) == NULL) {
328 X509_EXTENSION_free(ext);
332 X509_EXTENSION_free(ext);
338 * Add extensions to a certificate. Just check in case cert == NULL.
339 * Note that on error new elements may remain added to cert if cert != NULL.
341 int X509V3_EXT_add_nconf(CONF *conf, X509V3_CTX *ctx, const char *section,
344 STACK_OF(X509_EXTENSION) **sk = NULL;
346 sk = &cert->cert_info.extensions;
347 return X509V3_EXT_add_nconf_sk(conf, ctx, section, sk);
351 * Add extensions to a CRL. Just check in case crl == NULL.
352 * Note that on error new elements may remain added to crl if crl != NULL.
354 int X509V3_EXT_CRL_add_nconf(CONF *conf, X509V3_CTX *ctx, const char *section,
357 STACK_OF(X509_EXTENSION) **sk = NULL;
359 sk = &crl->crl.extensions;
360 return X509V3_EXT_add_nconf_sk(conf, ctx, section, sk);
364 * Add extensions to certificate request. Just check in case req is NULL.
365 * Note that on error new elements may remain added to req if req != NULL.
367 int X509V3_EXT_REQ_add_nconf(CONF *conf, X509V3_CTX *ctx, const char *section,
370 STACK_OF(X509_EXTENSION) *exts = NULL;
371 int ret = X509V3_EXT_add_nconf_sk(conf, ctx, section, &exts);
373 if (ret && req != NULL && exts != NULL)
374 ret = X509_REQ_add_extensions(req, exts);
375 sk_X509_EXTENSION_pop_free(exts, X509_EXTENSION_free);
379 /* Config database functions */
381 char *X509V3_get_string(X509V3_CTX *ctx, const char *name, const char *section)
383 if (!ctx->db || !ctx->db_meth || !ctx->db_meth->get_string) {
384 ERR_raise(ERR_LIB_X509V3, X509V3_R_OPERATION_NOT_DEFINED);
387 if (ctx->db_meth->get_string)
388 return ctx->db_meth->get_string(ctx->db, name, section);
392 STACK_OF(CONF_VALUE) *X509V3_get_section(X509V3_CTX *ctx, const char *section)
394 if (!ctx->db || !ctx->db_meth || !ctx->db_meth->get_section) {
395 ERR_raise(ERR_LIB_X509V3, X509V3_R_OPERATION_NOT_DEFINED);
398 if (ctx->db_meth->get_section)
399 return ctx->db_meth->get_section(ctx->db, section);
403 void X509V3_string_free(X509V3_CTX *ctx, char *str)
407 if (ctx->db_meth->free_string)
408 ctx->db_meth->free_string(ctx->db, str);
411 void X509V3_section_free(X509V3_CTX *ctx, STACK_OF(CONF_VALUE) *section)
415 if (ctx->db_meth->free_section)
416 ctx->db_meth->free_section(ctx->db, section);
419 static char *nconf_get_string(void *db, const char *section, const char *value)
421 return NCONF_get_string(db, section, value);
424 static STACK_OF(CONF_VALUE) *nconf_get_section(void *db, const char *section)
426 return NCONF_get_section(db, section);
429 static X509V3_CONF_METHOD nconf_method = {
436 void X509V3_set_nconf(X509V3_CTX *ctx, CONF *conf)
439 ERR_raise(ERR_LIB_X509V3, ERR_R_PASSED_NULL_PARAMETER);
442 ctx->db_meth = &nconf_method;
446 void X509V3_set_ctx(X509V3_CTX *ctx, X509 *issuer, X509 *subj, X509_REQ *req,
447 X509_CRL *crl, int flags)
450 ERR_raise(ERR_LIB_X509V3, ERR_R_PASSED_NULL_PARAMETER);
454 ctx->issuer_cert = issuer;
455 ctx->subject_cert = subj;
456 ctx->subject_req = req;
460 ctx->issuer_pkey = NULL;
463 /* For API backward compatibility, this is separate from X509V3_set_ctx() */
464 int X509V3_set_issuer_pkey(X509V3_CTX *ctx, EVP_PKEY *pkey)
467 ERR_raise(ERR_LIB_X509V3, ERR_R_PASSED_NULL_PARAMETER);
470 if (ctx->subject_cert == NULL && pkey != NULL) {
471 ERR_raise(ERR_LIB_X509V3, ERR_R_PASSED_INVALID_ARGUMENT);
474 ctx->issuer_pkey = pkey;
478 /* Old conf compatibility functions */
480 X509_EXTENSION *X509V3_EXT_conf(LHASH_OF(CONF_VALUE) *conf, X509V3_CTX *ctx,
481 const char *name, const char *value)
486 if ((ctmp = NCONF_new(NULL)) == NULL)
488 CONF_set_nconf(ctmp, conf);
489 ret = X509V3_EXT_nconf(ctmp, ctx, name, value);
490 CONF_set_nconf(ctmp, NULL);
495 X509_EXTENSION *X509V3_EXT_conf_nid(LHASH_OF(CONF_VALUE) *conf,
496 X509V3_CTX *ctx, int ext_nid, const char *value)
501 if ((ctmp = NCONF_new(NULL)) == NULL)
503 CONF_set_nconf(ctmp, conf);
504 ret = X509V3_EXT_nconf_nid(ctmp, ctx, ext_nid, value);
505 CONF_set_nconf(ctmp, NULL);
510 static char *conf_lhash_get_string(void *db, const char *section, const char *value)
512 return CONF_get_string(db, section, value);
515 static STACK_OF(CONF_VALUE) *conf_lhash_get_section(void *db, const char *section)
517 return CONF_get_section(db, section);
520 static X509V3_CONF_METHOD conf_lhash_method = {
521 conf_lhash_get_string,
522 conf_lhash_get_section,
527 void X509V3_set_conf_lhash(X509V3_CTX *ctx, LHASH_OF(CONF_VALUE) *lhash)
530 ERR_raise(ERR_LIB_X509V3, ERR_R_PASSED_NULL_PARAMETER);
533 ctx->db_meth = &conf_lhash_method;
537 int X509V3_EXT_add_conf(LHASH_OF(CONF_VALUE) *conf, X509V3_CTX *ctx,
538 const char *section, X509 *cert)
543 if ((ctmp = NCONF_new(NULL)) == NULL)
545 CONF_set_nconf(ctmp, conf);
546 ret = X509V3_EXT_add_nconf(ctmp, ctx, section, cert);
547 CONF_set_nconf(ctmp, NULL);
552 /* Same as above but for a CRL */
554 int X509V3_EXT_CRL_add_conf(LHASH_OF(CONF_VALUE) *conf, X509V3_CTX *ctx,
555 const char *section, X509_CRL *crl)
560 if ((ctmp = NCONF_new(NULL)) == NULL)
562 CONF_set_nconf(ctmp, conf);
563 ret = X509V3_EXT_CRL_add_nconf(ctmp, ctx, section, crl);
564 CONF_set_nconf(ctmp, NULL);
569 /* Add extensions to certificate request */
571 int X509V3_EXT_REQ_add_conf(LHASH_OF(CONF_VALUE) *conf, X509V3_CTX *ctx,
572 const char *section, X509_REQ *req)
577 if ((ctmp = NCONF_new(NULL)) == NULL)
579 CONF_set_nconf(ctmp, conf);
580 ret = X509V3_EXT_REQ_add_nconf(ctmp, ctx, section, req);
581 CONF_set_nconf(ctmp, NULL);