xref: /openbsd-src/lib/libcrypto/objects/obj_dat.c (revision cefe4e31b43cb0d696fc1665b2b49475d35fc314)
1 /* $OpenBSD: obj_dat.c,v 1.67 2023/12/14 14:02:57 tb Exp $ */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 
59 #include <ctype.h>
60 #include <limits.h>
61 #include <stdio.h>
62 #include <stdlib.h>
63 #include <string.h>
64 
65 #include <openssl/opensslconf.h>
66 
67 #include <openssl/asn1.h>
68 #include <openssl/bn.h>
69 #include <openssl/err.h>
70 #include <openssl/lhash.h>
71 #include <openssl/objects.h>
72 
73 #include "asn1_local.h"
74 
75 /* obj_dat.h is generated from objects.h by obj_dat.pl */
76 #include "obj_dat.h"
77 
78 #define ADDED_DATA	0
79 #define ADDED_SNAME	1
80 #define ADDED_LNAME	2
81 #define ADDED_NID	3
82 
83 typedef struct added_obj_st {
84 	int type;
85 	ASN1_OBJECT *obj;
86 } ADDED_OBJ;
87 DECLARE_LHASH_OF(ADDED_OBJ);
88 
89 static int new_nid = NUM_NID;
90 static LHASH_OF(ADDED_OBJ) *added = NULL;
91 
92 static unsigned long
93 added_obj_hash(const ADDED_OBJ *ca)
94 {
95 	const ASN1_OBJECT *a;
96 	int i;
97 	unsigned long ret = 0;
98 	unsigned char *p;
99 
100 	a = ca->obj;
101 	switch (ca->type) {
102 	case ADDED_DATA:
103 		ret = a->length << 20L;
104 		p = (unsigned char *)a->data;
105 		for (i = 0; i < a->length; i++)
106 			ret ^= p[i] << ((i * 3) % 24);
107 		break;
108 	case ADDED_SNAME:
109 		ret = lh_strhash(a->sn);
110 		break;
111 	case ADDED_LNAME:
112 		ret = lh_strhash(a->ln);
113 		break;
114 	case ADDED_NID:
115 		ret = a->nid;
116 		break;
117 	default:
118 		return 0;
119 	}
120 	ret &= 0x3fffffffL;
121 	ret |= ca->type << 30L;
122 	return (ret);
123 }
124 static IMPLEMENT_LHASH_HASH_FN(added_obj, ADDED_OBJ)
125 
126 static int
127 added_obj_cmp(const ADDED_OBJ *ca, const ADDED_OBJ *cb)
128 {
129 	const ASN1_OBJECT *a, *b;
130 	int cmp;
131 
132 	if ((cmp = ca->type - cb->type) != 0)
133 		return cmp;
134 
135 	a = ca->obj;
136 	b = cb->obj;
137 	switch (ca->type) {
138 	case ADDED_DATA:
139 		return OBJ_cmp(a, b);
140 	case ADDED_SNAME:
141 		if (a->sn == NULL)
142 			return -1;
143 		if (b->sn == NULL)
144 			return 1;
145 		return strcmp(a->sn, b->sn);
146 	case ADDED_LNAME:
147 		if (a->ln == NULL)
148 			return -1;
149 		if (b->ln == NULL)
150 			return 1;
151 		return strcmp(a->ln, b->ln);
152 	case ADDED_NID:
153 		return a->nid - b->nid;
154 	default:
155 		return 0;
156 	}
157 }
158 static IMPLEMENT_LHASH_COMP_FN(added_obj, ADDED_OBJ)
159 
160 static void
161 cleanup1_doall(ADDED_OBJ *a)
162 {
163 	a->obj->nid = 0;
164 	a->obj->flags |= ASN1_OBJECT_FLAG_DYNAMIC |
165 	    ASN1_OBJECT_FLAG_DYNAMIC_STRINGS |
166 	    ASN1_OBJECT_FLAG_DYNAMIC_DATA;
167 }
168 
169 static void cleanup2_doall(ADDED_OBJ *a)
170 {
171 	a->obj->nid++;
172 }
173 
174 static void
175 cleanup3_doall(ADDED_OBJ *a)
176 {
177 	if (--a->obj->nid == 0)
178 		ASN1_OBJECT_free(a->obj);
179 	free(a);
180 }
181 
182 static IMPLEMENT_LHASH_DOALL_FN(cleanup1, ADDED_OBJ)
183 static IMPLEMENT_LHASH_DOALL_FN(cleanup2, ADDED_OBJ)
184 static IMPLEMENT_LHASH_DOALL_FN(cleanup3, ADDED_OBJ)
185 
186 /* The purpose of obj_cleanup_defer is to avoid EVP_cleanup() attempting
187  * to use freed up OIDs. If necessary the actual freeing up of OIDs is
188  * delayed.
189  */
190 
191 int obj_cleanup_defer = 0;
192 
193 void
194 check_defer(int nid)
195 {
196 	if (!obj_cleanup_defer && nid >= NUM_NID)
197 		obj_cleanup_defer = 1;
198 }
199 
200 void
201 OBJ_cleanup(void)
202 {
203 	if (obj_cleanup_defer) {
204 		obj_cleanup_defer = 2;
205 		return;
206 	}
207 	if (added == NULL)
208 		return;
209 	lh_ADDED_OBJ_down_load(added) = 0;
210 	lh_ADDED_OBJ_doall(added, LHASH_DOALL_FN(cleanup1)); /* zero counters */
211 	lh_ADDED_OBJ_doall(added, LHASH_DOALL_FN(cleanup2)); /* set counters */
212 	lh_ADDED_OBJ_doall(added, LHASH_DOALL_FN(cleanup3)); /* free objects */
213 	lh_ADDED_OBJ_free(added);
214 	added = NULL;
215 }
216 LCRYPTO_ALIAS(OBJ_cleanup);
217 
218 int
219 OBJ_new_nid(int num)
220 {
221 	int i;
222 
223 	i = new_nid;
224 	new_nid += num;
225 	return (i);
226 }
227 LCRYPTO_ALIAS(OBJ_new_nid);
228 
229 int
230 OBJ_add_object(const ASN1_OBJECT *obj)
231 {
232 	ASN1_OBJECT *o = NULL;
233 	ADDED_OBJ *ao[4] = {NULL, NULL, NULL, NULL}, *aop;
234 	int i;
235 
236 	if (added == NULL)
237 		added = lh_ADDED_OBJ_new();
238 	if (added == NULL)
239 		goto err;
240 	if (obj == NULL || obj->nid == NID_undef)
241 		goto err;
242 	if ((o = OBJ_dup(obj)) == NULL)
243 		goto err;
244 	if (!(ao[ADDED_NID] = malloc(sizeof(ADDED_OBJ))))
245 		goto err2;
246 	if ((o->length != 0) && (obj->data != NULL))
247 		if (!(ao[ADDED_DATA] = malloc(sizeof(ADDED_OBJ))))
248 			goto err2;
249 	if (o->sn != NULL)
250 		if (!(ao[ADDED_SNAME] = malloc(sizeof(ADDED_OBJ))))
251 			goto err2;
252 	if (o->ln != NULL)
253 		if (!(ao[ADDED_LNAME] = malloc(sizeof(ADDED_OBJ))))
254 			goto err2;
255 
256 	for (i = ADDED_DATA; i <= ADDED_NID; i++) {
257 		if (ao[i] != NULL) {
258 			ao[i]->type = i;
259 			ao[i]->obj = o;
260 			aop = lh_ADDED_OBJ_insert(added, ao[i]);
261 			/* memory leak, but should not normally matter */
262 			free(aop);
263 		}
264 	}
265 	o->flags &= ~(ASN1_OBJECT_FLAG_DYNAMIC |
266 	    ASN1_OBJECT_FLAG_DYNAMIC_STRINGS |
267 	    ASN1_OBJECT_FLAG_DYNAMIC_DATA);
268 
269 	return (o->nid);
270 
271  err2:
272 	OBJerror(ERR_R_MALLOC_FAILURE);
273  err:
274 	for (i = ADDED_DATA; i <= ADDED_NID; i++)
275 		free(ao[i]);
276 	ASN1_OBJECT_free(o);
277 	return (NID_undef);
278 }
279 LCRYPTO_ALIAS(OBJ_add_object);
280 
281 ASN1_OBJECT *
282 OBJ_nid2obj(int n)
283 {
284 	ADDED_OBJ ad, *adp;
285 	ASN1_OBJECT ob;
286 
287 	if ((n >= 0) && (n < NUM_NID)) {
288 		if ((n != NID_undef) && (nid_objs[n].nid == NID_undef)) {
289 			OBJerror(OBJ_R_UNKNOWN_NID);
290 			return (NULL);
291 		}
292 		return ((ASN1_OBJECT *)&(nid_objs[n]));
293 	} else if (added == NULL)
294 		return (NULL);
295 	else {
296 		ad.type = ADDED_NID;
297 		ad.obj = &ob;
298 		ob.nid = n;
299 		adp = lh_ADDED_OBJ_retrieve(added, &ad);
300 		if (adp != NULL)
301 			return (adp->obj);
302 		else {
303 			OBJerror(OBJ_R_UNKNOWN_NID);
304 			return (NULL);
305 		}
306 	}
307 }
308 LCRYPTO_ALIAS(OBJ_nid2obj);
309 
310 const char *
311 OBJ_nid2sn(int nid)
312 {
313 	if (nid >= 0 && nid < NUM_NID) {
314 		if (nid == NID_undef || nid_objs[nid].nid != NID_undef)
315 			return nid_objs[nid].sn;
316 
317 		goto unknown;
318 	}
319 
320 	/* XXX - locking. */
321 	if (added != NULL) {
322 		ASN1_OBJECT aobj = {
323 			.nid = nid,
324 		};
325 		ADDED_OBJ needle = {
326 			.type = ADDED_NID,
327 			.obj = &aobj,
328 		};
329 		ADDED_OBJ *found;
330 
331 		if ((found = lh_ADDED_OBJ_retrieve(added, &needle)) != NULL)
332 			return found->obj->sn;
333 	}
334 
335  unknown:
336 	OBJerror(OBJ_R_UNKNOWN_NID);
337 
338 	return NULL;
339 }
340 LCRYPTO_ALIAS(OBJ_nid2sn);
341 
342 const char *
343 OBJ_nid2ln(int nid)
344 {
345 	if (nid >= 0 && nid < NUM_NID) {
346 		if (nid == NID_undef || nid_objs[nid].nid != NID_undef)
347 			return nid_objs[nid].ln;
348 
349 		goto unknown;
350 	}
351 
352 	/* XXX - locking. */
353 	if (added != NULL) {
354 		ASN1_OBJECT aobj = {
355 			.nid = nid,
356 		};
357 		ADDED_OBJ needle = {
358 			.type = ADDED_NID,
359 			.obj = &aobj,
360 		};
361 		ADDED_OBJ *found;
362 
363 		if ((found = lh_ADDED_OBJ_retrieve(added, &needle)) != NULL)
364 			return found->obj->ln;
365 	}
366 
367  unknown:
368 	OBJerror(OBJ_R_UNKNOWN_NID);
369 
370 	return NULL;
371 }
372 LCRYPTO_ALIAS(OBJ_nid2ln);
373 
374 static int
375 obj_objs_cmp(const void *aobj, const void *b)
376 {
377 	const unsigned int *nid = b;
378 
379 	return OBJ_cmp(aobj, &nid_objs[*nid]);
380 }
381 
382 int
383 OBJ_obj2nid(const ASN1_OBJECT *aobj)
384 {
385 	const unsigned int *nid;
386 
387 	if (aobj == NULL || aobj->length == 0)
388 		return NID_undef;
389 
390 	if (aobj->nid != NID_undef)
391 		return aobj->nid;
392 
393 	/* XXX - locking. OpenSSL 3 moved this after built-in object lookup. */
394 	if (added != NULL) {
395 		ADDED_OBJ needle = {
396 			.type = ADDED_DATA,
397 			.obj = (ASN1_OBJECT *)aobj,
398 		};
399 		ADDED_OBJ *found;
400 
401 		if ((found = lh_ADDED_OBJ_retrieve(added, &needle)) != NULL)
402 			return found->obj->nid;
403 	}
404 
405 	/* obj_objs holds built-in obj NIDs in ascending OBJ_cmp() order. */
406 	nid = bsearch(aobj, obj_objs, NUM_OBJ, sizeof(unsigned int), obj_objs_cmp);
407 	if (nid != NULL)
408 		return *nid;
409 
410 	return NID_undef;
411 }
412 LCRYPTO_ALIAS(OBJ_obj2nid);
413 
414 /* Convert an object name into an ASN1_OBJECT
415  * if "noname" is not set then search for short and long names first.
416  * This will convert the "dotted" form into an object: unlike OBJ_txt2nid
417  * it can be used with any objects, not just registered ones.
418  */
419 
420 ASN1_OBJECT *
421 OBJ_txt2obj(const char *s, int no_name)
422 {
423 	int nid;
424 
425 	if (!no_name) {
426 		if ((nid = OBJ_sn2nid(s)) != NID_undef ||
427 		    (nid = OBJ_ln2nid(s)) != NID_undef)
428 			return OBJ_nid2obj(nid);
429 	}
430 
431 	return t2i_ASN1_OBJECT_internal(s);
432 }
433 LCRYPTO_ALIAS(OBJ_txt2obj);
434 
435 int
436 OBJ_obj2txt(char *buf, int buf_len, const ASN1_OBJECT *aobj, int no_name)
437 {
438 	return i2t_ASN1_OBJECT_internal(aobj, buf, buf_len, no_name);
439 }
440 LCRYPTO_ALIAS(OBJ_obj2txt);
441 
442 int
443 OBJ_txt2nid(const char *s)
444 {
445 	ASN1_OBJECT *obj;
446 	int nid;
447 
448 	obj = OBJ_txt2obj(s, 0);
449 	nid = OBJ_obj2nid(obj);
450 	ASN1_OBJECT_free(obj);
451 	return nid;
452 }
453 LCRYPTO_ALIAS(OBJ_txt2nid);
454 
455 static int
456 ln_objs_cmp(const void *ln, const void *b)
457 {
458 	const unsigned int *nid = b;
459 
460 	return strcmp(ln, nid_objs[*nid].ln);
461 }
462 
463 int
464 OBJ_ln2nid(const char *ln)
465 {
466 	const unsigned int *nid;
467 
468 	/* XXX - locking. OpenSSL 3 moved this after built-in object lookup. */
469 	if (added != NULL) {
470 		ASN1_OBJECT aobj = {
471 			.ln = ln,
472 		};
473 		ADDED_OBJ needle = {
474 			.type = ADDED_LNAME,
475 			.obj = &aobj,
476 		};
477 		ADDED_OBJ *found;
478 
479 		if ((found = lh_ADDED_OBJ_retrieve(added, &needle)) != NULL)
480 			return found->obj->nid;
481 	}
482 
483 	/* ln_objs holds NIDs in ascending alphabetical order of LN. */
484 	nid = bsearch(ln, ln_objs, NUM_LN, sizeof(unsigned int), ln_objs_cmp);
485 	if (nid != NULL)
486 		return *nid;
487 
488 	return NID_undef;
489 }
490 LCRYPTO_ALIAS(OBJ_ln2nid);
491 
492 static int
493 sn_objs_cmp(const void *sn, const void *b)
494 {
495 	const unsigned int *nid = b;
496 
497 	return strcmp(sn, nid_objs[*nid].sn);
498 }
499 
500 int
501 OBJ_sn2nid(const char *sn)
502 {
503 	const unsigned int *nid;
504 
505 	/* XXX - locking. OpenSSL 3 moved this after built-in object lookup. */
506 	if (added != NULL) {
507 		ASN1_OBJECT aobj = {
508 			.sn = sn,
509 		};
510 		ADDED_OBJ needle = {
511 			.type = ADDED_SNAME,
512 			.obj = &aobj,
513 		};
514 		ADDED_OBJ *found;
515 
516 		if ((found = lh_ADDED_OBJ_retrieve(added, &needle)) != NULL)
517 			return found->obj->nid;
518 	}
519 
520 	/* sn_objs holds NIDs in ascending alphabetical order of SN. */
521 	nid = bsearch(sn, sn_objs, NUM_SN, sizeof(unsigned int), sn_objs_cmp);
522 	if (nid != NULL)
523 		return *nid;
524 
525 	return NID_undef;
526 }
527 LCRYPTO_ALIAS(OBJ_sn2nid);
528 
529 const void *
530 OBJ_bsearch_(const void *key, const void *base, int num, int size,
531     int (*cmp)(const void *, const void *))
532 {
533 	return OBJ_bsearch_ex_(key, base, num, size, cmp, 0);
534 }
535 LCRYPTO_ALIAS(OBJ_bsearch_);
536 
537 const void *
538 OBJ_bsearch_ex_(const void *key, const void *base_, int num, int size,
539     int (*cmp)(const void *, const void *), int flags)
540 {
541 	const char *base = base_;
542 	int l, h, i = 0, c = 0;
543 	const char *p = NULL;
544 
545 	if (num == 0)
546 		return (NULL);
547 	l = 0;
548 	h = num;
549 	while (l < h) {
550 		i = (l + h) / 2;
551 		p = &(base[i * size]);
552 		c = (*cmp)(key, p);
553 		if (c < 0)
554 			h = i;
555 		else if (c > 0)
556 			l = i + 1;
557 		else
558 			break;
559 	}
560 	if (c != 0 && !(flags & OBJ_BSEARCH_VALUE_ON_NOMATCH))
561 		p = NULL;
562 	else if (c == 0 && (flags & OBJ_BSEARCH_FIRST_VALUE_ON_MATCH)) {
563 		while (i > 0 && (*cmp)(key, &(base[(i - 1) * size])) == 0)
564 			i--;
565 		p = &(base[i * size]);
566 	}
567 	return (p);
568 }
569 
570 int
571 OBJ_create_objects(BIO *in)
572 {
573 	char buf[512];
574 	int i, num = 0;
575 	char *o, *s, *l = NULL;
576 
577 	for (;;) {
578 		s = o = NULL;
579 		i = BIO_gets(in, buf, 512);
580 		if (i <= 0)
581 			return (num);
582 		buf[i - 1] = '\0';
583 		if (!isalnum((unsigned char)buf[0]))
584 			return (num);
585 		o = s=buf;
586 		while (isdigit((unsigned char)*s) || (*s == '.'))
587 			s++;
588 		if (*s != '\0') {
589 			*(s++) = '\0';
590 			while (isspace((unsigned char)*s))
591 				s++;
592 			if (*s == '\0')
593 				s = NULL;
594 			else {
595 				l = s;
596 				while ((*l != '\0') &&
597 				    !isspace((unsigned char)*l))
598 					l++;
599 				if (*l != '\0') {
600 					*(l++) = '\0';
601 					while (isspace((unsigned char)*l))
602 						l++;
603 					if (*l == '\0')
604 						l = NULL;
605 				} else
606 					l = NULL;
607 			}
608 		} else
609 			s = NULL;
610 		if ((o == NULL) || (*o == '\0'))
611 			return (num);
612 		if (!OBJ_create(o, s, l))
613 			return (num);
614 		num++;
615 	}
616 	/* return(num); */
617 }
618 LCRYPTO_ALIAS(OBJ_create_objects);
619 
620 int
621 OBJ_create(const char *oid, const char *sn, const char *ln)
622 {
623 	int ok = 0;
624 	ASN1_OBJECT *op = NULL;
625 	unsigned char *buf;
626 	int i;
627 
628 	i = a2d_ASN1_OBJECT(NULL, 0, oid, -1);
629 	if (i <= 0)
630 		return (0);
631 
632 	if ((buf = malloc(i)) == NULL) {
633 		OBJerror(ERR_R_MALLOC_FAILURE);
634 		return (0);
635 	}
636 	i = a2d_ASN1_OBJECT(buf, i, oid, -1);
637 	if (i == 0)
638 		goto err;
639 	op = (ASN1_OBJECT *)ASN1_OBJECT_create(OBJ_new_nid(1), buf, i, sn, ln);
640 	if (op == NULL)
641 		goto err;
642 	ok = OBJ_add_object(op);
643 
644  err:
645 	ASN1_OBJECT_free(op);
646 	free(buf);
647 	return (ok);
648 }
649 LCRYPTO_ALIAS(OBJ_create);
650 
651 size_t
652 OBJ_length(const ASN1_OBJECT *obj)
653 {
654 	if (obj == NULL)
655 		return 0;
656 
657 	if (obj->length < 0)
658 		return 0;
659 
660 	return obj->length;
661 }
662 LCRYPTO_ALIAS(OBJ_length);
663 
664 const unsigned char *
665 OBJ_get0_data(const ASN1_OBJECT *obj)
666 {
667 	if (obj == NULL)
668 		return NULL;
669 
670 	return obj->data;
671 }
672 LCRYPTO_ALIAS(OBJ_get0_data);
673