05c785217aa70bf6c62805034774486ce7dba4c8
[oweals/openssl.git] / crypto / x509 / x509_vpm.c
1 /*
2  * Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (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
8  */
9
10 #include <stdio.h>
11
12 #include "internal/cryptlib.h"
13 #include <openssl/crypto.h>
14 #include <openssl/lhash.h>
15 #include <openssl/buffer.h>
16 #include <openssl/x509.h>
17 #include <openssl/x509v3.h>
18 #include "internal/x509_int.h"
19
20 #include "x509_lcl.h"
21
22 /* X509_VERIFY_PARAM functions */
23
24 #define SET_HOST 0
25 #define ADD_HOST 1
26
27 static char *str_copy(const char *s)
28 {
29     return OPENSSL_strdup(s);
30 }
31
32 static void str_free(char *s)
33 {
34     OPENSSL_free(s);
35 }
36
37 static int int_x509_param_set_hosts(X509_VERIFY_PARAM *vpm, int mode,
38                                     const char *name, size_t namelen)
39 {
40     char *copy;
41
42     /*
43      * Refuse names with embedded NUL bytes, except perhaps as final byte.
44      * XXX: Do we need to push an error onto the error stack?
45      */
46     if (namelen == 0 || name == NULL)
47         namelen = name ? strlen(name) : 0;
48     else if (name && memchr(name, '\0', namelen > 1 ? namelen - 1 : namelen))
49         return 0;
50     if (namelen > 0 && name[namelen - 1] == '\0')
51         --namelen;
52
53     if (mode == SET_HOST) {
54         sk_OPENSSL_STRING_pop_free(vpm->hosts, str_free);
55         vpm->hosts = NULL;
56     }
57     if (name == NULL || namelen == 0)
58         return 1;
59
60     copy = OPENSSL_strndup(name, namelen);
61     if (copy == NULL)
62         return 0;
63
64     if (vpm->hosts == NULL &&
65         (vpm->hosts = sk_OPENSSL_STRING_new_null()) == NULL) {
66         OPENSSL_free(copy);
67         return 0;
68     }
69
70     if (!sk_OPENSSL_STRING_push(vpm->hosts, copy)) {
71         OPENSSL_free(copy);
72         if (sk_OPENSSL_STRING_num(vpm->hosts) == 0) {
73             sk_OPENSSL_STRING_free(vpm->hosts);
74             vpm->hosts = NULL;
75         }
76         return 0;
77     }
78
79     return 1;
80 }
81
82 static void x509_verify_param_zero(X509_VERIFY_PARAM *param)
83 {
84     if (!param)
85         return;
86     param->name = NULL;
87     param->purpose = 0;
88     param->trust = X509_TRUST_DEFAULT;
89     /*
90      * param->inh_flags = X509_VP_FLAG_DEFAULT;
91      */
92     param->inh_flags = 0;
93     param->flags = 0;
94     param->depth = -1;
95     param->auth_level = -1; /* -1 means unset, 0 is explicit */
96     sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
97     param->policies = NULL;
98     sk_OPENSSL_STRING_pop_free(param->hosts, str_free);
99     param->hosts = NULL;
100     OPENSSL_free(param->peername);
101     param->peername = NULL;
102     OPENSSL_free(param->email);
103     param->email = NULL;
104     param->emaillen = 0;
105     OPENSSL_free(param->ip);
106     param->ip = NULL;
107     param->iplen = 0;
108 }
109
110 X509_VERIFY_PARAM *X509_VERIFY_PARAM_new(void)
111 {
112     X509_VERIFY_PARAM *param;
113
114     param = OPENSSL_zalloc(sizeof(*param));
115     if (param == NULL)
116         return NULL;
117     x509_verify_param_zero(param);
118     return param;
119 }
120
121 void X509_VERIFY_PARAM_free(X509_VERIFY_PARAM *param)
122 {
123     if (!param)
124         return;
125     x509_verify_param_zero(param);
126     OPENSSL_free(param);
127 }
128
129 /*-
130  * This function determines how parameters are "inherited" from one structure
131  * to another. There are several different ways this can happen.
132  *
133  * 1. If a child structure needs to have its values initialized from a parent
134  *    they are simply copied across. For example SSL_CTX copied to SSL.
135  * 2. If the structure should take on values only if they are currently unset.
136  *    For example the values in an SSL structure will take appropriate value
137  *    for SSL servers or clients but only if the application has not set new
138  *    ones.
139  *
140  * The "inh_flags" field determines how this function behaves.
141  *
142  * Normally any values which are set in the default are not copied from the
143  * destination and verify flags are ORed together.
144  *
145  * If X509_VP_FLAG_DEFAULT is set then anything set in the source is copied
146  * to the destination. Effectively the values in "to" become default values
147  * which will be used only if nothing new is set in "from".
148  *
149  * If X509_VP_FLAG_OVERWRITE is set then all value are copied across whether
150  * they are set or not. Flags is still Ored though.
151  *
152  * If X509_VP_FLAG_RESET_FLAGS is set then the flags value is copied instead
153  * of ORed.
154  *
155  * If X509_VP_FLAG_LOCKED is set then no values are copied.
156  *
157  * If X509_VP_FLAG_ONCE is set then the current inh_flags setting is zeroed
158  * after the next call.
159  */
160
161 /* Macro to test if a field should be copied from src to dest */
162
163 #define test_x509_verify_param_copy(field, def) \
164         (to_overwrite || \
165                 ((src->field != def) && (to_default || (dest->field == def))))
166
167 /* Macro to test and copy a field if necessary */
168
169 #define x509_verify_param_copy(field, def) \
170         if (test_x509_verify_param_copy(field, def)) \
171                 dest->field = src->field
172
173 int X509_VERIFY_PARAM_inherit(X509_VERIFY_PARAM *dest,
174                               const X509_VERIFY_PARAM *src)
175 {
176     unsigned long inh_flags;
177     int to_default, to_overwrite;
178     if (!src)
179         return 1;
180     inh_flags = dest->inh_flags | src->inh_flags;
181
182     if (inh_flags & X509_VP_FLAG_ONCE)
183         dest->inh_flags = 0;
184
185     if (inh_flags & X509_VP_FLAG_LOCKED)
186         return 1;
187
188     if (inh_flags & X509_VP_FLAG_DEFAULT)
189         to_default = 1;
190     else
191         to_default = 0;
192
193     if (inh_flags & X509_VP_FLAG_OVERWRITE)
194         to_overwrite = 1;
195     else
196         to_overwrite = 0;
197
198     x509_verify_param_copy(purpose, 0);
199     x509_verify_param_copy(trust, X509_TRUST_DEFAULT);
200     x509_verify_param_copy(depth, -1);
201     x509_verify_param_copy(auth_level, -1);
202
203     /* If overwrite or check time not set, copy across */
204
205     if (to_overwrite || !(dest->flags & X509_V_FLAG_USE_CHECK_TIME)) {
206         dest->check_time = src->check_time;
207         dest->flags &= ~X509_V_FLAG_USE_CHECK_TIME;
208         /* Don't need to copy flag: that is done below */
209     }
210
211     if (inh_flags & X509_VP_FLAG_RESET_FLAGS)
212         dest->flags = 0;
213
214     dest->flags |= src->flags;
215
216     if (test_x509_verify_param_copy(policies, NULL)) {
217         if (!X509_VERIFY_PARAM_set1_policies(dest, src->policies))
218             return 0;
219     }
220
221     /* Copy the host flags if and only if we're copying the host list */
222     if (test_x509_verify_param_copy(hosts, NULL)) {
223         sk_OPENSSL_STRING_pop_free(dest->hosts, str_free);
224         dest->hosts = NULL;
225         if (src->hosts) {
226             dest->hosts =
227                 sk_OPENSSL_STRING_deep_copy(src->hosts, str_copy, str_free);
228             if (dest->hosts == NULL)
229                 return 0;
230             dest->hostflags = src->hostflags;
231         }
232     }
233
234     if (test_x509_verify_param_copy(email, NULL)) {
235         if (!X509_VERIFY_PARAM_set1_email(dest, src->email, src->emaillen))
236             return 0;
237     }
238
239     if (test_x509_verify_param_copy(ip, NULL)) {
240         if (!X509_VERIFY_PARAM_set1_ip(dest, src->ip, src->iplen))
241             return 0;
242     }
243
244     return 1;
245 }
246
247 int X509_VERIFY_PARAM_set1(X509_VERIFY_PARAM *to,
248                            const X509_VERIFY_PARAM *from)
249 {
250     unsigned long save_flags = to->inh_flags;
251     int ret;
252     to->inh_flags |= X509_VP_FLAG_DEFAULT;
253     ret = X509_VERIFY_PARAM_inherit(to, from);
254     to->inh_flags = save_flags;
255     return ret;
256 }
257
258 static int int_x509_param_set1(char **pdest, size_t *pdestlen,
259                                const char *src, size_t srclen)
260 {
261     void *tmp;
262     if (src) {
263         if (srclen == 0)
264             srclen = strlen(src);
265
266         tmp = OPENSSL_memdup(src, srclen);
267         if (tmp == NULL)
268             return 0;
269     } else {
270         tmp = NULL;
271         srclen = 0;
272     }
273     OPENSSL_free(*pdest);
274     *pdest = tmp;
275     if (pdestlen != NULL)
276         *pdestlen = srclen;
277     return 1;
278 }
279
280 int X509_VERIFY_PARAM_set1_name(X509_VERIFY_PARAM *param, const char *name)
281 {
282     OPENSSL_free(param->name);
283     param->name = OPENSSL_strdup(name);
284     if (param->name)
285         return 1;
286     return 0;
287 }
288
289 int X509_VERIFY_PARAM_set_flags(X509_VERIFY_PARAM *param, unsigned long flags)
290 {
291     param->flags |= flags;
292     if (flags & X509_V_FLAG_POLICY_MASK)
293         param->flags |= X509_V_FLAG_POLICY_CHECK;
294     return 1;
295 }
296
297 int X509_VERIFY_PARAM_clear_flags(X509_VERIFY_PARAM *param,
298                                   unsigned long flags)
299 {
300     param->flags &= ~flags;
301     return 1;
302 }
303
304 unsigned long X509_VERIFY_PARAM_get_flags(X509_VERIFY_PARAM *param)
305 {
306     return param->flags;
307 }
308
309 int X509_VERIFY_PARAM_set_purpose(X509_VERIFY_PARAM *param, int purpose)
310 {
311     return X509_PURPOSE_set(&param->purpose, purpose);
312 }
313
314 int X509_VERIFY_PARAM_set_trust(X509_VERIFY_PARAM *param, int trust)
315 {
316     return X509_TRUST_set(&param->trust, trust);
317 }
318
319 void X509_VERIFY_PARAM_set_depth(X509_VERIFY_PARAM *param, int depth)
320 {
321     param->depth = depth;
322 }
323
324 void X509_VERIFY_PARAM_set_auth_level(X509_VERIFY_PARAM *param, int auth_level)
325 {
326     param->auth_level = auth_level;
327 }
328
329 void X509_VERIFY_PARAM_set_time(X509_VERIFY_PARAM *param, time_t t)
330 {
331     param->check_time = t;
332     param->flags |= X509_V_FLAG_USE_CHECK_TIME;
333 }
334
335 int X509_VERIFY_PARAM_add0_policy(X509_VERIFY_PARAM *param,
336                                   ASN1_OBJECT *policy)
337 {
338     if (!param->policies) {
339         param->policies = sk_ASN1_OBJECT_new_null();
340         if (!param->policies)
341             return 0;
342     }
343     if (!sk_ASN1_OBJECT_push(param->policies, policy))
344         return 0;
345     return 1;
346 }
347
348 int X509_VERIFY_PARAM_set1_policies(X509_VERIFY_PARAM *param,
349                                     STACK_OF(ASN1_OBJECT) *policies)
350 {
351     int i;
352     ASN1_OBJECT *oid, *doid;
353
354     if (!param)
355         return 0;
356     sk_ASN1_OBJECT_pop_free(param->policies, ASN1_OBJECT_free);
357
358     if (!policies) {
359         param->policies = NULL;
360         return 1;
361     }
362
363     param->policies = sk_ASN1_OBJECT_new_null();
364     if (!param->policies)
365         return 0;
366
367     for (i = 0; i < sk_ASN1_OBJECT_num(policies); i++) {
368         oid = sk_ASN1_OBJECT_value(policies, i);
369         doid = OBJ_dup(oid);
370         if (!doid)
371             return 0;
372         if (!sk_ASN1_OBJECT_push(param->policies, doid)) {
373             ASN1_OBJECT_free(doid);
374             return 0;
375         }
376     }
377     param->flags |= X509_V_FLAG_POLICY_CHECK;
378     return 1;
379 }
380
381 int X509_VERIFY_PARAM_set1_host(X509_VERIFY_PARAM *param,
382                                 const char *name, size_t namelen)
383 {
384     return int_x509_param_set_hosts(param, SET_HOST, name, namelen);
385 }
386
387 int X509_VERIFY_PARAM_add1_host(X509_VERIFY_PARAM *param,
388                                 const char *name, size_t namelen)
389 {
390     return int_x509_param_set_hosts(param, ADD_HOST, name, namelen);
391 }
392
393 void X509_VERIFY_PARAM_set_hostflags(X509_VERIFY_PARAM *param,
394                                      unsigned int flags)
395 {
396     param->hostflags = flags;
397 }
398
399 char *X509_VERIFY_PARAM_get0_peername(X509_VERIFY_PARAM *param)
400 {
401     return param->peername;
402 }
403
404 /*
405  * Move peername from one param structure to another, freeing any name present
406  * at the target.  If the source is a NULL parameter structure, free and zero
407  * the target peername.
408  */
409 void X509_VERIFY_PARAM_move_peername(X509_VERIFY_PARAM *to,
410                                      X509_VERIFY_PARAM *from)
411 {
412     char *peername = (from != NULL) ? from->peername : NULL;
413
414     if (to->peername != peername) {
415         OPENSSL_free(to->peername);
416         to->peername = peername;
417     }
418     if (from)
419         from->peername = NULL;
420 }
421
422 int X509_VERIFY_PARAM_set1_email(X509_VERIFY_PARAM *param,
423                                  const char *email, size_t emaillen)
424 {
425     return int_x509_param_set1(&param->email, &param->emaillen,
426                                email, emaillen);
427 }
428
429 int X509_VERIFY_PARAM_set1_ip(X509_VERIFY_PARAM *param,
430                               const unsigned char *ip, size_t iplen)
431 {
432     if (iplen != 0 && iplen != 4 && iplen != 16)
433         return 0;
434     return int_x509_param_set1((char **)&param->ip, &param->iplen,
435                                (char *)ip, iplen);
436 }
437
438 int X509_VERIFY_PARAM_set1_ip_asc(X509_VERIFY_PARAM *param, const char *ipasc)
439 {
440     unsigned char ipout[16];
441     size_t iplen;
442
443     iplen = (size_t)a2i_ipadd(ipout, ipasc);
444     if (iplen == 0)
445         return 0;
446     return X509_VERIFY_PARAM_set1_ip(param, ipout, iplen);
447 }
448
449 int X509_VERIFY_PARAM_get_depth(const X509_VERIFY_PARAM *param)
450 {
451     return param->depth;
452 }
453
454 int X509_VERIFY_PARAM_get_auth_level(const X509_VERIFY_PARAM *param)
455 {
456     return param->auth_level;
457 }
458
459 const char *X509_VERIFY_PARAM_get0_name(const X509_VERIFY_PARAM *param)
460 {
461     return param->name;
462 }
463
464 #define vpm_empty_id NULL, 0U, NULL, NULL, 0, NULL, 0
465
466 /*
467  * Default verify parameters: these are used for various applications and can
468  * be overridden by the user specified table. NB: the 'name' field *must* be
469  * in alphabetical order because it will be searched using OBJ_search.
470  */
471
472 static const X509_VERIFY_PARAM default_table[] = {
473     {
474      "default",                 /* X509 default parameters */
475      0,                         /* Check time */
476      0,                         /* internal flags */
477      X509_V_FLAG_TRUSTED_FIRST, /* flags */
478      0,                         /* purpose */
479      0,                         /* trust */
480      100,                       /* depth */
481      -1,                        /* auth_level */
482      NULL,                      /* policies */
483      vpm_empty_id},
484     {
485      "pkcs7",                   /* S/MIME sign parameters */
486      0,                         /* Check time */
487      0,                         /* internal flags */
488      0,                         /* flags */
489      X509_PURPOSE_SMIME_SIGN,   /* purpose */
490      X509_TRUST_EMAIL,          /* trust */
491      -1,                        /* depth */
492      -1,                        /* auth_level */
493      NULL,                      /* policies */
494      vpm_empty_id},
495     {
496      "smime_sign",              /* S/MIME sign parameters */
497      0,                         /* Check time */
498      0,                         /* internal flags */
499      0,                         /* flags */
500      X509_PURPOSE_SMIME_SIGN,   /* purpose */
501      X509_TRUST_EMAIL,          /* trust */
502      -1,                        /* depth */
503      -1,                        /* auth_level */
504      NULL,                      /* policies */
505      vpm_empty_id},
506     {
507      "ssl_client",              /* SSL/TLS client parameters */
508      0,                         /* Check time */
509      0,                         /* internal flags */
510      0,                         /* flags */
511      X509_PURPOSE_SSL_CLIENT,   /* purpose */
512      X509_TRUST_SSL_CLIENT,     /* trust */
513      -1,                        /* depth */
514      -1,                        /* auth_level */
515      NULL,                      /* policies */
516      vpm_empty_id},
517     {
518      "ssl_server",              /* SSL/TLS server parameters */
519      0,                         /* Check time */
520      0,                         /* internal flags */
521      0,                         /* flags */
522      X509_PURPOSE_SSL_SERVER,   /* purpose */
523      X509_TRUST_SSL_SERVER,     /* trust */
524      -1,                        /* depth */
525      -1,                        /* auth_level */
526      NULL,                      /* policies */
527      vpm_empty_id}
528 };
529
530 static STACK_OF(X509_VERIFY_PARAM) *param_table = NULL;
531
532 static int table_cmp(const X509_VERIFY_PARAM *a, const X509_VERIFY_PARAM *b)
533 {
534     return strcmp(a->name, b->name);
535 }
536
537 DECLARE_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
538 IMPLEMENT_OBJ_BSEARCH_CMP_FN(X509_VERIFY_PARAM, X509_VERIFY_PARAM, table);
539
540 static int param_cmp(const X509_VERIFY_PARAM *const *a,
541                      const X509_VERIFY_PARAM *const *b)
542 {
543     return strcmp((*a)->name, (*b)->name);
544 }
545
546 int X509_VERIFY_PARAM_add0_table(X509_VERIFY_PARAM *param)
547 {
548     int idx;
549     X509_VERIFY_PARAM *ptmp;
550     if (param_table == NULL) {
551         param_table = sk_X509_VERIFY_PARAM_new(param_cmp);
552         if (param_table == NULL)
553             return 0;
554     } else {
555         idx = sk_X509_VERIFY_PARAM_find(param_table, param);
556         if (idx != -1) {
557             ptmp = sk_X509_VERIFY_PARAM_value(param_table, idx);
558             X509_VERIFY_PARAM_free(ptmp);
559             (void)sk_X509_VERIFY_PARAM_delete(param_table, idx);
560         }
561     }
562     if (!sk_X509_VERIFY_PARAM_push(param_table, param))
563         return 0;
564     return 1;
565 }
566
567 int X509_VERIFY_PARAM_get_count(void)
568 {
569     int num = OSSL_NELEM(default_table);
570     if (param_table)
571         num += sk_X509_VERIFY_PARAM_num(param_table);
572     return num;
573 }
574
575 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_get0(int id)
576 {
577     int num = OSSL_NELEM(default_table);
578     if (id < num)
579         return default_table + id;
580     return sk_X509_VERIFY_PARAM_value(param_table, id - num);
581 }
582
583 const X509_VERIFY_PARAM *X509_VERIFY_PARAM_lookup(const char *name)
584 {
585     int idx;
586     X509_VERIFY_PARAM pm;
587
588     pm.name = (char *)name;
589     if (param_table) {
590         idx = sk_X509_VERIFY_PARAM_find(param_table, &pm);
591         if (idx != -1)
592             return sk_X509_VERIFY_PARAM_value(param_table, idx);
593     }
594     return OBJ_bsearch_table(&pm, default_table, OSSL_NELEM(default_table));
595 }
596
597 void X509_VERIFY_PARAM_table_cleanup(void)
598 {
599     sk_X509_VERIFY_PARAM_pop_free(param_table, X509_VERIFY_PARAM_free);
600     param_table = NULL;
601 }