GH784: Better variable name
[openssl.git] / crypto / x509 / x509_trs.c
1 /*
2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
3  * 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
59 #include <stdio.h>
60 #include "internal/cryptlib.h"
61 #include <openssl/x509v3.h>
62 #include "internal/x509_int.h"
63
64 static int tr_cmp(const X509_TRUST *const *a, const X509_TRUST *const *b);
65 static void trtable_free(X509_TRUST *p);
66
67 static int trust_1oidany(X509_TRUST *trust, X509 *x, int flags);
68 static int trust_1oid(X509_TRUST *trust, X509 *x, int flags);
69 static int trust_compat(X509_TRUST *trust, X509 *x, int flags);
70
71 static int obj_trust(int id, X509 *x, int flags);
72 static int (*default_trust) (int id, X509 *x, int flags) = obj_trust;
73
74 /*
75  * WARNING: the following table should be kept in order of trust and without
76  * any gaps so we can just subtract the minimum trust value to get an index
77  * into the table
78  */
79
80 static X509_TRUST trstandard[] = {
81     {X509_TRUST_COMPAT, 0, trust_compat, "compatible", 0, NULL},
82     {X509_TRUST_SSL_CLIENT, 0, trust_1oidany, "SSL Client", NID_client_auth,
83      NULL},
84     {X509_TRUST_SSL_SERVER, 0, trust_1oidany, "SSL Server", NID_server_auth,
85      NULL},
86     {X509_TRUST_EMAIL, 0, trust_1oidany, "S/MIME email", NID_email_protect,
87      NULL},
88     {X509_TRUST_OBJECT_SIGN, 0, trust_1oidany, "Object Signer", NID_code_sign,
89      NULL},
90     {X509_TRUST_OCSP_SIGN, 0, trust_1oid, "OCSP responder", NID_OCSP_sign,
91      NULL},
92     {X509_TRUST_OCSP_REQUEST, 0, trust_1oid, "OCSP request", NID_ad_OCSP,
93      NULL},
94     {X509_TRUST_TSA, 0, trust_1oidany, "TSA server", NID_time_stamp, NULL}
95 };
96
97 #define X509_TRUST_COUNT        OSSL_NELEM(trstandard)
98
99 static STACK_OF(X509_TRUST) *trtable = NULL;
100
101 static int tr_cmp(const X509_TRUST *const *a, const X509_TRUST *const *b)
102 {
103     return (*a)->trust - (*b)->trust;
104 }
105
106 int (*X509_TRUST_set_default(int (*trust) (int, X509 *, int))) (int, X509 *,
107                                                                 int) {
108     int (*oldtrust) (int, X509 *, int);
109     oldtrust = default_trust;
110     default_trust = trust;
111     return oldtrust;
112 }
113
114 int X509_check_trust(X509 *x, int id, int flags)
115 {
116     X509_TRUST *pt;
117     int idx;
118
119     /* We get this as a default value */
120     if (id == X509_TRUST_DEFAULT)
121         return obj_trust(NID_anyExtendedKeyUsage, x,
122                          flags | X509_TRUST_DO_SS_COMPAT);
123     idx = X509_TRUST_get_by_id(id);
124     if (idx == -1)
125         return default_trust(id, x, flags);
126     pt = X509_TRUST_get0(idx);
127     return pt->check_trust(pt, x, flags);
128 }
129
130 int X509_TRUST_get_count(void)
131 {
132     if (!trtable)
133         return X509_TRUST_COUNT;
134     return sk_X509_TRUST_num(trtable) + X509_TRUST_COUNT;
135 }
136
137 X509_TRUST *X509_TRUST_get0(int idx)
138 {
139     if (idx < 0)
140         return NULL;
141     if (idx < (int)X509_TRUST_COUNT)
142         return trstandard + idx;
143     return sk_X509_TRUST_value(trtable, idx - X509_TRUST_COUNT);
144 }
145
146 int X509_TRUST_get_by_id(int id)
147 {
148     X509_TRUST tmp;
149     int idx;
150     if ((id >= X509_TRUST_MIN) && (id <= X509_TRUST_MAX))
151         return id - X509_TRUST_MIN;
152     tmp.trust = id;
153     if (!trtable)
154         return -1;
155     idx = sk_X509_TRUST_find(trtable, &tmp);
156     if (idx == -1)
157         return -1;
158     return idx + X509_TRUST_COUNT;
159 }
160
161 int X509_TRUST_set(int *t, int trust)
162 {
163     if (X509_TRUST_get_by_id(trust) == -1) {
164         X509err(X509_F_X509_TRUST_SET, X509_R_INVALID_TRUST);
165         return 0;
166     }
167     *t = trust;
168     return 1;
169 }
170
171 int X509_TRUST_add(int id, int flags, int (*ck) (X509_TRUST *, X509 *, int),
172                    char *name, int arg1, void *arg2)
173 {
174     int idx;
175     X509_TRUST *trtmp;
176     /*
177      * This is set according to what we change: application can't set it
178      */
179     flags &= ~X509_TRUST_DYNAMIC;
180     /* This will always be set for application modified trust entries */
181     flags |= X509_TRUST_DYNAMIC_NAME;
182     /* Get existing entry if any */
183     idx = X509_TRUST_get_by_id(id);
184     /* Need a new entry */
185     if (idx == -1) {
186         if ((trtmp = OPENSSL_malloc(sizeof(*trtmp))) == NULL) {
187             X509err(X509_F_X509_TRUST_ADD, ERR_R_MALLOC_FAILURE);
188             return 0;
189         }
190         trtmp->flags = X509_TRUST_DYNAMIC;
191     } else
192         trtmp = X509_TRUST_get0(idx);
193
194     /* OPENSSL_free existing name if dynamic */
195     if (trtmp->flags & X509_TRUST_DYNAMIC_NAME)
196         OPENSSL_free(trtmp->name);
197     /* dup supplied name */
198     if ((trtmp->name = OPENSSL_strdup(name)) == NULL) {
199         X509err(X509_F_X509_TRUST_ADD, ERR_R_MALLOC_FAILURE);
200         return 0;
201     }
202     /* Keep the dynamic flag of existing entry */
203     trtmp->flags &= X509_TRUST_DYNAMIC;
204     /* Set all other flags */
205     trtmp->flags |= flags;
206
207     trtmp->trust = id;
208     trtmp->check_trust = ck;
209     trtmp->arg1 = arg1;
210     trtmp->arg2 = arg2;
211
212     /* If its a new entry manage the dynamic table */
213     if (idx == -1) {
214         if (trtable == NULL
215             && (trtable = sk_X509_TRUST_new(tr_cmp)) == NULL) {
216             X509err(X509_F_X509_TRUST_ADD, ERR_R_MALLOC_FAILURE);
217             return 0;
218         }
219         if (!sk_X509_TRUST_push(trtable, trtmp)) {
220             X509err(X509_F_X509_TRUST_ADD, ERR_R_MALLOC_FAILURE);
221             return 0;
222         }
223     }
224     return 1;
225 }
226
227 static void trtable_free(X509_TRUST *p)
228 {
229     if (!p)
230         return;
231     if (p->flags & X509_TRUST_DYNAMIC) {
232         if (p->flags & X509_TRUST_DYNAMIC_NAME)
233             OPENSSL_free(p->name);
234         OPENSSL_free(p);
235     }
236 }
237
238 void X509_TRUST_cleanup(void)
239 {
240     unsigned int i;
241     for (i = 0; i < X509_TRUST_COUNT; i++)
242         trtable_free(trstandard + i);
243     sk_X509_TRUST_pop_free(trtable, trtable_free);
244     trtable = NULL;
245 }
246
247 int X509_TRUST_get_flags(X509_TRUST *xp)
248 {
249     return xp->flags;
250 }
251
252 char *X509_TRUST_get0_name(X509_TRUST *xp)
253 {
254     return xp->name;
255 }
256
257 int X509_TRUST_get_trust(X509_TRUST *xp)
258 {
259     return xp->trust;
260 }
261
262 static int trust_1oidany(X509_TRUST *trust, X509 *x, int flags)
263 {
264     /*
265      * Declare the chain verified if the desired trust OID is not rejected in
266      * any auxiliary trust info for this certificate, and the OID is either
267      * expressly trusted, or else either "anyEKU" is trusted, or the
268      * certificate is self-signed.
269      */
270     flags |= X509_TRUST_DO_SS_COMPAT | X509_TRUST_OK_ANY_EKU;
271     return obj_trust(trust->arg1, x, flags);
272 }
273
274 static int trust_1oid(X509_TRUST *trust, X509 *x, int flags)
275 {
276     /*
277      * Declare the chain verified only if the desired trust OID is not
278      * rejected and is expressly trusted.  Neither "anyEKU" nor "compat"
279      * trust in self-signed certificates apply.
280      */
281     flags &= ~(X509_TRUST_DO_SS_COMPAT | X509_TRUST_OK_ANY_EKU);
282     return obj_trust(trust->arg1, x, flags);
283 }
284
285 static int trust_compat(X509_TRUST *trust, X509 *x, int flags)
286 {
287     /* Call for side-effect of computing hash and caching extensions */
288     X509_check_purpose(x, -1, 0);
289     if ((flags & X509_TRUST_NO_SS_COMPAT) == 0 && x->ex_flags & EXFLAG_SS)
290         return X509_TRUST_TRUSTED;
291     else
292         return X509_TRUST_UNTRUSTED;
293 }
294
295 static int obj_trust(int id, X509 *x, int flags)
296 {
297     X509_CERT_AUX *ax = x->aux;
298     int i;
299
300     if (ax && ax->reject) {
301         for (i = 0; i < sk_ASN1_OBJECT_num(ax->reject); i++) {
302             ASN1_OBJECT *obj = sk_ASN1_OBJECT_value(ax->reject, i);
303             int nid = OBJ_obj2nid(obj);
304
305             if (nid == id || (nid == NID_anyExtendedKeyUsage &&
306                 (flags & X509_TRUST_OK_ANY_EKU)))
307                 return X509_TRUST_REJECTED;
308         }
309     }
310
311     if (ax && ax->trust) {
312         for (i = 0; i < sk_ASN1_OBJECT_num(ax->trust); i++) {
313             ASN1_OBJECT *obj = sk_ASN1_OBJECT_value(ax->trust, i);
314             int nid = OBJ_obj2nid(obj);
315
316             if (nid == id || (nid == NID_anyExtendedKeyUsage &&
317                 (flags & X509_TRUST_OK_ANY_EKU)))
318                 return X509_TRUST_TRUSTED;
319         }
320         /*
321          * Reject when explicit trust EKU are set and none match.
322          *
323          * Returning untrusted is enough for for full chains that end in
324          * self-signed roots, because when explicit trust is specified it
325          * suppresses the default blanket trust of self-signed objects.
326          *
327          * But for partial chains, this is not enough, because absent a similar
328          * trust-self-signed policy, non matching EKUs are indistinguishable
329          * from lack of EKU constraints.
330          *
331          * Therefore, failure to match any trusted purpose must trigger an
332          * explicit reject.
333          */
334         return X509_TRUST_REJECTED;
335     }
336
337     if ((flags & X509_TRUST_DO_SS_COMPAT) == 0)
338         return X509_TRUST_UNTRUSTED;
339
340     /*
341      * Not rejected, and there is no list of accepted uses, try compat.
342      */
343     return trust_compat(NULL, x, flags);
344 }