]> git.ipfire.org Git - thirdparty/openssl.git/blob - crypto/x509/x509_vpm.c
Identify and move common internal libcrypto header files
[thirdparty/openssl.git] / crypto / x509 / x509_vpm.c
1 /* x509_vpm.c */
2 /*
3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
4 * 2004.
5 */
6 /* ====================================================================
7 * Copyright (c) 2004 The OpenSSL Project. All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 *
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
30 *
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
34 *
35 * 6. Redistributions of any form whatsoever must retain the following
36 * acknowledgment:
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
53 *
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
57 *
58 */
59
60 #include <stdio.h>
61
62 #include "internal/cryptlib.h"
63 #include <openssl/crypto.h>
64 #include <openssl/lhash.h>
65 #include <openssl/buffer.h>
66 #include <openssl/x509.h>
67 #include <openssl/x509v3.h>
68
69 #include "x509_lcl.h"
70
71 /* X509_VERIFY_PARAM functions */
72
73 #define SET_HOST 0
74 #define ADD_HOST 1
75
76 static char *str_copy(const char *s)
77 {
78 return OPENSSL_strdup(s);
79 }
80
81 static void str_free(char *s)
82 {
83 OPENSSL_free(s);
84 }
85
86 static int int_x509_param_set_hosts(X509_VERIFY_PARAM_ID *id, int mode,
87 const char *name, size_t namelen)
88 {
89 char *copy;
90
91 /*
92 * Refuse names with embedded NUL bytes, except perhaps as final byte.
93 * XXX: Do we need to push an error onto the error stack?
94 */
95 if (namelen == 0)
96 namelen = name ? strlen(name) : 0;
97 else if (name && memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen))
98 return 0;
99 if (name && name[namelen - 1] == '\0')
100 --namelen;
101
102 if (mode == SET_HOST) {
103 sk_OPENSSL_STRING_pop_free(id->hosts, str_free);
104 id->hosts = NULL;
105 }
106 if (name == NULL || namelen == 0)
107 return 1;
108
109 copy = BUF_strndup(name, namelen);
110 if (copy == NULL)
111 return 0;
112
113 if (id->hosts == NULL &&
114 (id->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
115 OPENSSL_free(copy);
116 return 0;
117 }
118
119 if (!sk_OPENSSL_STRING_push(id->hosts, copy)) {
120 OPENSSL_free(copy);
121 if (sk_OPENSSL_STRING_num(id->hosts) == 0) {
122 sk_OPENSSL_STRING_free(id->hosts);
123 id->hosts = NULL;
124 }
125 return 0;
126 }
127
128 return 1;
129 }
130
131 static void x509_verify_param_zero(X509_VERIFY_PARAM *param)
132 {
133 X509_VERIFY_PARAM_ID *paramid;
134 if (!param)
135 return;
136 param->name = NULL;
137 param->purpose = 0;
138 param->trust = 0;
139 /*
140 * param->inh_flags = X509_VP_FLAG_DEFAULT;
141 */
142 param->inh_flags = 0;
143 param->flags = 0;
144 param->depth = -1;
145 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
146 param->policies = NULL;
147 paramid = param->id;
148 sk_OPENSSL_STRING_pop_free(paramid->hosts, str_free);
149 paramid->hosts = NULL;
150 OPENSSL_free(paramid->peername);
151 OPENSSL_free(paramid->email);
152 paramid->email = NULL;
153 paramid->emaillen = 0;
154 OPENSSL_free(paramid->ip);
155 paramid->ip = NULL;
156 paramid->iplen = 0;
157 }
158
159 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
160 {
161 X509_VERIFY_PARAM *param;
162 X509_VERIFY_PARAM_ID *paramid;
163
164 param = OPENSSL_malloc(sizeof(*param));
165 if (!param)
166 return NULL;
167 paramid = OPENSSL_malloc(sizeof(*paramid));
168 if (!paramid) {
169 OPENSSL_free(param);
170 return NULL;
171 }
172 memset(param, 0, sizeof(*param));
173 memset(paramid, 0, sizeof(*paramid));
174 param->id = paramid;
175 x509_verify_param_zero(param);
176 return param;
177 }
178
179 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
180 {
181 if (!param)
182 return;
183 x509_verify_param_zero(param);
184 OPENSSL_free(param->id);
185 OPENSSL_free(param);
186 }
187
188 /*-
189 * This function determines how parameters are "inherited" from one structure
190 * to another. There are several different ways this can happen.
191 *
192 * 1. If a child structure needs to have its values initialized from a parent
193 * they are simply copied across. For example SSL_CTX copied to SSL.
194 * 2. If the structure should take on values only if they are currently unset.
195 * For example the values in an SSL structure will take appropriate value
196 * for SSL servers or clients but only if the application has not set new
197 * ones.
198 *
199 * The "inh_flags" field determines how this function behaves.
200 *
201 * Normally any values which are set in the default are not copied from the
202 * destination and verify flags are ORed together.
203 *
204 * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
205 * to the destination. Effectively the values in "to" become default values
206 * which will be used only if nothing new is set in "from".
207 *
208 * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
209 * they are set or not. Flags is still Ored though.
210 *
211 * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
212 * of ORed.
213 *
214 * If X509_VP_FLAG_LOCKED is set then no values are copied.
215 *
216 * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
217 * after the next call.
218 */
219
220 /* Macro to test if a field should be copied from src to dest */
221
222 #define test_x509_verify_param_copy(field, def) \
223 (to_overwrite || \
224 ((src->field != def) && (to_default || (dest->field == def))))
225
226 /* As above but for ID fields */
227
228 #define test_x509_verify_param_copy_id(idf, def) \
229 test_x509_verify_param_copy(id->idf, def)
230
231 /* Macro to test and copy a field if necessary */
232
233 #define x509_verify_param_copy(field, def) \
234 if (test_x509_verify_param_copy(field, def)) \
235 dest->field = src->field
236
237 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
238 const X509_VERIFY_PARAM *src)
239 {
240 unsigned long inh_flags;
241 int to_default, to_overwrite;
242 X509_VERIFY_PARAM_ID *id;
243 if (!src)
244 return 1;
245 id = src->id;
246 inh_flags = dest->inh_flags | src->inh_flags;
247
248 if (inh_flags & X509_VP_FLAG_ONCE)
249 dest->inh_flags = 0;
250
251 if (inh_flags & X509_VP_FLAG_LOCKED)
252 return 1;
253
254 if (inh_flags & X509_VP_FLAG_DEFAULT)
255 to_default = 1;
256 else
257 to_default = 0;
258
259 if (inh_flags & X509_VP_FLAG_OVERWRITE)
260 to_overwrite = 1;
261 else
262 to_overwrite = 0;
263
264 x509_verify_param_copy(purpose, 0);
265 x509_verify_param_copy(trust, 0);
266 x509_verify_param_copy(depth, -1);
267
268 /* If overwrite or check time not set, copy across */
269
270 if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
271 dest->check_time = src->check_time;
272 dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
273 /* Don't need to copy flag: that is done below */
274 }
275
276 if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
277 dest->flags = 0;
278
279 dest->flags |= src->flags;
280
281 if (test_x509_verify_param_copy(policies, NULL)) {
282 if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
283 return 0;
284 }
285
286 /* Copy the host flags if and only if we're copying the host list */
287 if (test_x509_verify_param_copy_id(hosts, NULL)) {
288 sk_OPENSSL_STRING_pop_free(dest->id->hosts, str_free);
289 dest->id->hosts = NULL;
290 if (id->hosts) {
291 dest->id->hosts =
292 sk_OPENSSL_STRING_deep_copy(id->hosts, str_copy, str_free);
293 if (dest->id->hosts == NULL)
294 return 0;
295 dest->id->hostflags = id->hostflags;
296 }
297 }
298
299 if (test_x509_verify_param_copy_id(email, NULL)) {
300 if (!X509_VERIFY_PARAM_set1_email(dest, id->email, id->emaillen))
301 return 0;
302 }
303
304 if (test_x509_verify_param_copy_id(ip, NULL)) {
305 if (!X509_VERIFY_PARAM_set1_ip(dest, id->ip, id->iplen))
306 return 0;
307 }
308
309 return 1;
310 }
311
312 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
313 const X509_VERIFY_PARAM *from)
314 {
315 unsigned long save_flags = to->inh_flags;
316 int ret;
317 to->inh_flags |= X509_VP_FLAG_DEFAULT;
318 ret = X509_VERIFY_PARAM_inherit(to, from);
319 to->inh_flags = save_flags;
320 return ret;
321 }
322
323 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
324 const char *src, size_t srclen)
325 {
326 void *tmp;
327 if (src) {
328 if (srclen == 0) {
329 tmp = BUF_strdup(src);
330 srclen = strlen(src);
331 } else
332 tmp = BUF_memdup(src, srclen);
333 if (!tmp)
334 return 0;
335 } else {
336 tmp = NULL;
337 srclen = 0;
338 }
339 OPENSSL_free(*pdest);
340 *pdest = tmp;
341 if (pdestlen)
342 *pdestlen = srclen;
343 return 1;
344 }
345
346 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
347 {
348 OPENSSL_free(param->name);
349 param->name = BUF_strdup(name);
350 if (param->name)
351 return 1;
352 return 0;
353 }
354
355 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
356 {
357 param->flags |= flags;
358 if (flags & X509_V_FLAG_POLICY_MASK)
359 param->flags |= X509_V_FLAG_POLICY_CHECK;
360 return 1;
361 }
362
363 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
364 unsigned long flags)
365 {
366 param->flags &= ~flags;
367 return 1;
368 }
369
370 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
371 {
372 return param->flags;
373 }
374
375 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
376 {
377 return X509_PURPOSE_set(&param->purpose, purpose);
378 }
379
380 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
381 {
382 return X509_TRUST_set(&param->trust, trust);
383 }
384
385 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
386 {
387 param->depth = depth;
388 }
389
390 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
391 {
392 param->check_time = t;
393 param->flags |= X509_V_FLAG_USE_CHECK_TIME;
394 }
395
396 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
397 ASN1_OBJECT *policy)
398 {
399 if (!param->policies) {
400 param->policies = sk_ASN1_OBJECT_new_null();
401 if (!param->policies)
402 return 0;
403 }
404 if (!sk_ASN1_OBJECT_push(param->policies, policy))
405 return 0;
406 return 1;
407 }
408
409 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
410 STACK_OF(ASN1_OBJECT) *policies)
411 {
412 int i;
413 ASN1_OBJECT *oid, *doid;
414
415 if (!param)
416 return 0;
417 sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
418
419 if (!policies) {
420 param->policies = NULL;
421 return 1;
422 }
423
424 param->policies = sk_ASN1_OBJECT_new_null();
425 if (!param->policies)
426 return 0;
427
428 for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
429 oid = sk_ASN1_OBJECT_value(policies, i);
430 doid = OBJ_dup(oid);
431 if (!doid)
432 return 0;
433 if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
434 ASN1_OBJECT_free(doid);
435 return 0;
436 }
437 }
438 param->flags |= X509_V_FLAG_POLICY_CHECK;
439 return 1;
440 }
441
442 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
443 const char *name, size_t namelen)
444 {
445 return int_x509_param_set_hosts(param->id, SET_HOST, name, namelen);
446 }
447
448 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
449 const char *name, size_t namelen)
450 {
451 return int_x509_param_set_hosts(param->id, ADD_HOST, name, namelen);
452 }
453
454 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
455 unsigned int flags)
456 {
457 param->id->hostflags = flags;
458 }
459
460 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param)
461 {
462 return param->id->peername;
463 }
464
465 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
466 const char *email, size_t emaillen)
467 {
468 return int_x509_param_set1(&param->id->email, &param->id->emaillen,
469 email, emaillen);
470 }
471
472 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
473 const unsigned char *ip, size_t iplen)
474 {
475 if (iplen != 0 && iplen != 4 && iplen != 16)
476 return 0;
477 return int_x509_param_set1((char **)&param->id->ip, &param->id->iplen,
478 (char *)ip, iplen);
479 }
480
481 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
482 {
483 unsigned char ipout[16];
484 size_t iplen;
485
486 iplen = (size_t)a2i_ipadd(ipout, ipasc);
487 if (iplen == 0)
488 return 0;
489 return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
490 }
491
492 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
493 {
494 return param->depth;
495 }
496
497 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
498 {
499 return param->name;
500 }
501
502 static X509_VERIFY_PARAM_ID _empty_id = { NULL, 0U, NULL, NULL, 0, NULL, 0 };
503
504 #define vpm_empty_id (X509_VERIFY_PARAM_ID *)&_empty_id
505
506 /*
507 * Default verify parameters: these are used for various applications and can
508 * be overridden by the user specified table. NB: the 'name' field *must* be
509 * in alphabetical order because it will be searched using OBJ_search.
510 */
511
512 static const X509_VERIFY_PARAM default_table[] = {
513 {
514 "default", /* X509 default parameters */
515 0, /* Check time */
516 0, /* internal flags */
517 0, /* flags */
518 0, /* purpose */
519 0, /* trust */
520 100, /* depth */
521 NULL, /* policies */
522 vpm_empty_id},
523 {
524 "pkcs7", /* S/MIME sign parameters */
525 0, /* Check time */
526 0, /* internal flags */
527 0, /* flags */
528 X509_PURPOSE_SMIME_SIGN, /* purpose */
529 X509_TRUST_EMAIL, /* trust */
530 -1, /* depth */
531 NULL, /* policies */
532 vpm_empty_id},
533 {
534 "smime_sign", /* S/MIME sign parameters */
535 0, /* Check time */
536 0, /* internal flags */
537 0, /* flags */
538 X509_PURPOSE_SMIME_SIGN, /* purpose */
539 X509_TRUST_EMAIL, /* trust */
540 -1, /* depth */
541 NULL, /* policies */
542 vpm_empty_id},
543 {
544 "ssl_client", /* SSL/TLS client parameters */
545 0, /* Check time */
546 0, /* internal flags */
547 0, /* flags */
548 X509_PURPOSE_SSL_CLIENT, /* purpose */
549 X509_TRUST_SSL_CLIENT, /* trust */
550 -1, /* depth */
551 NULL, /* policies */
552 vpm_empty_id},
553 {
554 "ssl_server", /* SSL/TLS server parameters */
555 0, /* Check time */
556 0, /* internal flags */
557 0, /* flags */
558 X509_PURPOSE_SSL_SERVER, /* purpose */
559 X509_TRUST_SSL_SERVER, /* trust */
560 -1, /* depth */
561 NULL, /* policies */
562 vpm_empty_id}
563 };
564
565 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
566
567 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
568 {
569 return strcmp(a->name, b->name);
570 }
571
572 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
573 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
574
575 static int param_cmp(const X509_VERIFY_PARAM *const *a,
576 const X509_VERIFY_PARAM *const *b)
577 {
578 return strcmp((*a)->name, (*b)->name);
579 }
580
581 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
582 {
583 int idx;
584 X509_VERIFY_PARAM *ptmp;
585 if (!param_table) {
586 param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
587 if (!param_table)
588 return 0;
589 } else {
590 idx = sk_X509_VERIFY_PARAM_find(param_table, param);
591 if (idx != -1) {
592 ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
593 X509_VERIFY_PARAM_free(ptmp);
594 (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
595 }
596 }
597 if (!sk_X509_VERIFY_PARAM_push(param_table, param))
598 return 0;
599 return 1;
600 }
601
602 int X509_VERIFY_PARAM_get_count(void)
603 {
604 int num = OSSL_NELEM(default_table);
605 if (param_table)
606 num += sk_X509_VERIFY_PARAM_num(param_table);
607 return num;
608 }
609
610 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
611 {
612 int num = OSSL_NELEM(default_table);
613 if (id < num)
614 return default_table + id;
615 return sk_X509_VERIFY_PARAM_value(param_table, id - num);
616 }
617
618 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
619 {
620 int idx;
621 X509_VERIFY_PARAM pm;
622
623 pm.name = (char *)name;
624 if (param_table) {
625 idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
626 if (idx != -1)
627 return sk_X509_VERIFY_PARAM_value(param_table, idx);
628 }
629 return OBJ_bsearch_table(&pm, default_table, OSSL_NELEM(default_table));
630 }
631
632 void X509_VERIFY_PARAM_table_cleanup(void)
633 {
634 sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);
635 param_table = NULL;
636 }