xref: /openbsd-src/lib/libcrypto/x509/x509_lib.c (revision f1843f451e6f293ca8d5a73694bb0d3b4ce3b7f1)
1 /* $OpenBSD: x509_lib.c,v 1.11 2023/04/16 12:05:31 tb Exp $ */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) 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 /* X509 v3 extension utilities */
59 
60 #include <stdio.h>
61 
62 #include <openssl/conf.h>
63 #include <openssl/err.h>
64 #include <openssl/x509v3.h>
65 
66 #include "x509_local.h"
67 
68 static STACK_OF(X509V3_EXT_METHOD) *ext_list = NULL;
69 
70 static int ext_cmp(const X509V3_EXT_METHOD * const *a,
71     const X509V3_EXT_METHOD * const *b);
72 static void ext_list_free(X509V3_EXT_METHOD *ext);
73 
74 extern X509V3_EXT_METHOD v3_bcons, v3_nscert, v3_key_usage, v3_ext_ku;
75 extern X509V3_EXT_METHOD v3_pkey_usage_period, v3_sxnet, v3_info, v3_sinfo;
76 extern X509V3_EXT_METHOD v3_ns_ia5_list[], v3_alt[], v3_skey_id, v3_akey_id;
77 extern X509V3_EXT_METHOD v3_crl_num, v3_crl_reason, v3_crl_invdate;
78 extern X509V3_EXT_METHOD v3_delta_crl, v3_cpols, v3_crld, v3_freshest_crl;
79 extern X509V3_EXT_METHOD v3_ocsp_nonce, v3_ocsp_accresp, v3_ocsp_acutoff;
80 extern X509V3_EXT_METHOD v3_ocsp_crlid, v3_ocsp_nocheck, v3_ocsp_serviceloc;
81 extern X509V3_EXT_METHOD v3_crl_hold;
82 extern X509V3_EXT_METHOD v3_policy_mappings, v3_policy_constraints;
83 extern X509V3_EXT_METHOD v3_name_constraints, v3_inhibit_anyp, v3_idp;
84 extern const X509V3_EXT_METHOD v3_addr, v3_asid;
85 extern const X509V3_EXT_METHOD v3_ct_scts[3];
86 
87 /*
88  * This table needs to be sorted by increasing ext_nid values for OBJ_bsearch_.
89  */
90 
91 static const X509V3_EXT_METHOD *standard_exts[] = {
92 	&v3_nscert,
93 	&v3_ns_ia5_list[0],
94 	&v3_ns_ia5_list[1],
95 	&v3_ns_ia5_list[2],
96 	&v3_ns_ia5_list[3],
97 	&v3_ns_ia5_list[4],
98 	&v3_ns_ia5_list[5],
99 	&v3_ns_ia5_list[6],
100 	&v3_skey_id,
101 	&v3_key_usage,
102 	&v3_pkey_usage_period,
103 	&v3_alt[0],
104 	&v3_alt[1],
105 	&v3_bcons,
106 	&v3_crl_num,
107 	&v3_cpols,
108 	&v3_akey_id,
109 	&v3_crld,
110 	&v3_ext_ku,
111 	&v3_delta_crl,
112 	&v3_crl_reason,
113 #ifndef OPENSSL_NO_OCSP
114 	&v3_crl_invdate,
115 #endif
116 	&v3_sxnet,
117 	&v3_info,
118 #ifndef OPENSSL_NO_RFC3779
119 	&v3_addr,
120 	&v3_asid,
121 #endif
122 #ifndef OPENSSL_NO_OCSP
123 	&v3_ocsp_nonce,
124 	&v3_ocsp_crlid,
125 	&v3_ocsp_accresp,
126 	&v3_ocsp_nocheck,
127 	&v3_ocsp_acutoff,
128 	&v3_ocsp_serviceloc,
129 #endif
130 	&v3_sinfo,
131 	&v3_policy_constraints,
132 #ifndef OPENSSL_NO_OCSP
133 	&v3_crl_hold,
134 #endif
135 	&v3_name_constraints,
136 	&v3_policy_mappings,
137 	&v3_inhibit_anyp,
138 	&v3_idp,
139 	&v3_alt[2],
140 	&v3_freshest_crl,
141 #ifndef OPENSSL_NO_CT
142 	&v3_ct_scts[0],
143 	&v3_ct_scts[1],
144 	&v3_ct_scts[2],
145 #endif
146 };
147 
148 #define STANDARD_EXTENSION_COUNT (sizeof(standard_exts) / sizeof(standard_exts[0]))
149 
150 int
151 X509V3_EXT_add(X509V3_EXT_METHOD *ext)
152 {
153 	if (!ext_list && !(ext_list = sk_X509V3_EXT_METHOD_new(ext_cmp))) {
154 		X509V3error(ERR_R_MALLOC_FAILURE);
155 		return 0;
156 	}
157 	if (!sk_X509V3_EXT_METHOD_push(ext_list, ext)) {
158 		X509V3error(ERR_R_MALLOC_FAILURE);
159 		return 0;
160 	}
161 	return 1;
162 }
163 LCRYPTO_ALIAS(X509V3_EXT_add);
164 
165 static int
166 ext_cmp(const X509V3_EXT_METHOD * const *a, const X509V3_EXT_METHOD * const *b)
167 {
168 	return ((*a)->ext_nid - (*b)->ext_nid);
169 }
170 
171 static int
172 ext_cmp_BSEARCH_CMP_FN(const void *a_, const void *b_)
173 {
174 	const X509V3_EXT_METHOD * const *a = a_;
175 	const X509V3_EXT_METHOD * const *b = b_;
176 	return ext_cmp(a, b);
177 }
178 
179 static const X509V3_EXT_METHOD **
180 OBJ_bsearch_ext(const X509V3_EXT_METHOD **key,
181     const X509V3_EXT_METHOD *const *base, int num)
182 {
183 	return (const X509V3_EXT_METHOD **)OBJ_bsearch_(key, base, num,
184 	    sizeof(const X509V3_EXT_METHOD *), ext_cmp_BSEARCH_CMP_FN);
185 }
186 
187 const X509V3_EXT_METHOD *
188 X509V3_EXT_get_nid(int nid)
189 {
190 	X509V3_EXT_METHOD tmp;
191 	const X509V3_EXT_METHOD *t = &tmp, * const *ret;
192 	int idx;
193 
194 	if (nid < 0)
195 		return NULL;
196 	tmp.ext_nid = nid;
197 	ret = OBJ_bsearch_ext(&t, standard_exts, STANDARD_EXTENSION_COUNT);
198 	if (ret)
199 		return *ret;
200 	if (!ext_list)
201 		return NULL;
202 	idx = sk_X509V3_EXT_METHOD_find(ext_list, &tmp);
203 	if (idx == -1)
204 		return NULL;
205 	return sk_X509V3_EXT_METHOD_value(ext_list, idx);
206 }
207 LCRYPTO_ALIAS(X509V3_EXT_get_nid);
208 
209 const X509V3_EXT_METHOD *
210 X509V3_EXT_get(X509_EXTENSION *ext)
211 {
212 	int nid;
213 
214 	if ((nid = OBJ_obj2nid(ext->object)) == NID_undef)
215 		return NULL;
216 	return X509V3_EXT_get_nid(nid);
217 }
218 LCRYPTO_ALIAS(X509V3_EXT_get);
219 
220 int
221 X509V3_EXT_add_list(X509V3_EXT_METHOD *extlist)
222 {
223 	for (; extlist->ext_nid!=-1; extlist++)
224 		if (!X509V3_EXT_add(extlist))
225 			return 0;
226 	return 1;
227 }
228 LCRYPTO_ALIAS(X509V3_EXT_add_list);
229 
230 int
231 X509V3_EXT_add_alias(int nid_to, int nid_from)
232 {
233 	const X509V3_EXT_METHOD *ext;
234 	X509V3_EXT_METHOD *tmpext;
235 
236 	if (!(ext = X509V3_EXT_get_nid(nid_from))) {
237 		X509V3error(X509V3_R_EXTENSION_NOT_FOUND);
238 		return 0;
239 	}
240 	if (!(tmpext = malloc(sizeof(X509V3_EXT_METHOD)))) {
241 		X509V3error(ERR_R_MALLOC_FAILURE);
242 		return 0;
243 	}
244 	*tmpext = *ext;
245 	tmpext->ext_nid = nid_to;
246 	tmpext->ext_flags |= X509V3_EXT_DYNAMIC;
247 	if (!X509V3_EXT_add(tmpext)) {
248 		free(tmpext);
249 		return 0;
250 	}
251 	return 1;
252 }
253 LCRYPTO_ALIAS(X509V3_EXT_add_alias);
254 
255 void
256 X509V3_EXT_cleanup(void)
257 {
258 	sk_X509V3_EXT_METHOD_pop_free(ext_list, ext_list_free);
259 	ext_list = NULL;
260 }
261 LCRYPTO_ALIAS(X509V3_EXT_cleanup);
262 
263 static void
264 ext_list_free(X509V3_EXT_METHOD *ext)
265 {
266 	if (ext->ext_flags & X509V3_EXT_DYNAMIC)
267 		free(ext);
268 }
269 
270 int
271 X509V3_add_standard_extensions(void)
272 {
273 	return 1;
274 }
275 LCRYPTO_ALIAS(X509V3_add_standard_extensions);
276 
277 /* Return an extension internal structure */
278 
279 void *
280 X509V3_EXT_d2i(X509_EXTENSION *ext)
281 {
282 	const X509V3_EXT_METHOD *method;
283 	const unsigned char *p;
284 
285 	if (!(method = X509V3_EXT_get(ext)))
286 		return NULL;
287 	p = ext->value->data;
288 	if (method->it)
289 		return ASN1_item_d2i(NULL, &p, ext->value->length,
290 		    method->it);
291 	return method->d2i(NULL, &p, ext->value->length);
292 }
293 LCRYPTO_ALIAS(X509V3_EXT_d2i);
294 
295 /* Get critical flag and decoded version of extension from a NID.
296  * The "idx" variable returns the last found extension and can
297  * be used to retrieve multiple extensions of the same NID.
298  * However multiple extensions with the same NID is usually
299  * due to a badly encoded certificate so if idx is NULL we
300  * choke if multiple extensions exist.
301  * The "crit" variable is set to the critical value.
302  * The return value is the decoded extension or NULL on
303  * error. The actual error can have several different causes,
304  * the value of *crit reflects the cause:
305  * >= 0, extension found but not decoded (reflects critical value).
306  * -1 extension not found.
307  * -2 extension occurs more than once.
308  */
309 
310 void *
311 X509V3_get_d2i(const STACK_OF(X509_EXTENSION) *x, int nid, int *crit, int *idx)
312 {
313 	int lastpos, i;
314 	X509_EXTENSION *ex, *found_ex = NULL;
315 
316 	if (!x) {
317 		if (idx)
318 			*idx = -1;
319 		if (crit)
320 			*crit = -1;
321 		return NULL;
322 	}
323 	if (idx)
324 		lastpos = *idx + 1;
325 	else
326 		lastpos = 0;
327 	if (lastpos < 0)
328 		lastpos = 0;
329 	for (i = lastpos; i < sk_X509_EXTENSION_num(x); i++) {
330 		ex = sk_X509_EXTENSION_value(x, i);
331 		if (OBJ_obj2nid(ex->object) == nid) {
332 			if (idx) {
333 				*idx = i;
334 				found_ex = ex;
335 				break;
336 			} else if (found_ex) {
337 				/* Found more than one */
338 				if (crit)
339 					*crit = -2;
340 				return NULL;
341 			}
342 			found_ex = ex;
343 		}
344 	}
345 	if (found_ex) {
346 		/* Found it */
347 		if (crit)
348 			*crit = X509_EXTENSION_get_critical(found_ex);
349 		return X509V3_EXT_d2i(found_ex);
350 	}
351 
352 	/* Extension not found */
353 	if (idx)
354 		*idx = -1;
355 	if (crit)
356 		*crit = -1;
357 	return NULL;
358 }
359 LCRYPTO_ALIAS(X509V3_get_d2i);
360 
361 /* This function is a general extension append, replace and delete utility.
362  * The precise operation is governed by the 'flags' value. The 'crit' and
363  * 'value' arguments (if relevant) are the extensions internal structure.
364  */
365 
366 int
367 X509V3_add1_i2d(STACK_OF(X509_EXTENSION) **x, int nid, void *value,
368     int crit, unsigned long flags)
369 {
370 	int extidx = -1;
371 	int errcode;
372 	X509_EXTENSION *ext, *extmp;
373 	unsigned long ext_op = flags & X509V3_ADD_OP_MASK;
374 
375 	/* If appending we don't care if it exists, otherwise
376 	 * look for existing extension.
377 	 */
378 	if (ext_op != X509V3_ADD_APPEND)
379 		extidx = X509v3_get_ext_by_NID(*x, nid, -1);
380 
381 	/* See if extension exists */
382 	if (extidx >= 0) {
383 		/* If keep existing, nothing to do */
384 		if (ext_op == X509V3_ADD_KEEP_EXISTING)
385 			return 1;
386 		/* If default then its an error */
387 		if (ext_op == X509V3_ADD_DEFAULT) {
388 			errcode = X509V3_R_EXTENSION_EXISTS;
389 			goto err;
390 		}
391 		/* If delete, just delete it */
392 		if (ext_op == X509V3_ADD_DELETE) {
393 			if ((extmp = sk_X509_EXTENSION_delete(*x, extidx)) == NULL)
394 				return -1;
395 			X509_EXTENSION_free(extmp);
396 			return 1;
397 		}
398 	} else {
399 		/* If replace existing or delete, error since
400 		 * extension must exist
401 		 */
402 		if ((ext_op == X509V3_ADD_REPLACE_EXISTING) ||
403 		    (ext_op == X509V3_ADD_DELETE)) {
404 			errcode = X509V3_R_EXTENSION_NOT_FOUND;
405 			goto err;
406 		}
407 	}
408 
409 	/* If we get this far then we have to create an extension:
410 	 * could have some flags for alternative encoding schemes...
411 	 */
412 
413 	ext = X509V3_EXT_i2d(nid, crit, value);
414 
415 	if (!ext) {
416 		X509V3error(X509V3_R_ERROR_CREATING_EXTENSION);
417 		return 0;
418 	}
419 
420 	/* If extension exists replace it.. */
421 	if (extidx >= 0) {
422 		extmp = sk_X509_EXTENSION_value(*x, extidx);
423 		X509_EXTENSION_free(extmp);
424 		if (!sk_X509_EXTENSION_set(*x, extidx, ext))
425 			return -1;
426 		return 1;
427 	}
428 
429 	if (!*x && !(*x = sk_X509_EXTENSION_new_null()))
430 		return -1;
431 	if (!sk_X509_EXTENSION_push(*x, ext))
432 		return -1;
433 
434 	return 1;
435 
436 err:
437 	if (!(flags & X509V3_ADD_SILENT))
438 		X509V3error(errcode);
439 	return 0;
440 }
441 LCRYPTO_ALIAS(X509V3_add1_i2d);
442