Restore OCSP_basic_verify() error return semantics
[openssl.git] / crypto / ocsp / ocsp_vfy.c
1 /*
2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
3  * 2000.
4  */
5 /* ====================================================================
6  * Copyright (c) 2000-2016 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 <openssl/ocsp.h>
60 #include "ocsp_lcl.h"
61 #include <openssl/err.h>
62 #include <string.h>
63
64 static int ocsp_find_signer(X509 **psigner, OCSP_BASICRESP *bs,
65                             STACK_OF(X509) *certs, unsigned long flags);
66 static X509 *ocsp_find_signer_sk(STACK_OF(X509) *certs, OCSP_RESPID *id);
67 static int ocsp_check_issuer(OCSP_BASICRESP *bs, STACK_OF(X509) *chain);
68 static int ocsp_check_ids(STACK_OF(OCSP_SINGLERESP) *sresp,
69                           OCSP_CERTID **ret);
70 static int ocsp_match_issuerid(X509 *cert, OCSP_CERTID *cid,
71                                STACK_OF(OCSP_SINGLERESP) *sresp);
72 static int ocsp_check_delegated(X509 *x);
73 static int ocsp_req_find_signer(X509 **psigner, OCSP_REQUEST *req,
74                                 X509_NAME *nm, STACK_OF(X509) *certs,
75                                 unsigned long flags);
76
77 /* Verify a basic response message */
78
79 int OCSP_basic_verify(OCSP_BASICRESP *bs, STACK_OF(X509) *certs,
80                       X509_STORE *st, unsigned long flags)
81 {
82     X509 *signer, *x;
83     STACK_OF(X509) *chain = NULL;
84     STACK_OF(X509) *untrusted = NULL;
85     X509_STORE_CTX *ctx = NULL;
86     int i, ret = ocsp_find_signer(&signer, bs, certs, flags);
87
88     if (!ret) {
89         OCSPerr(OCSP_F_OCSP_BASIC_VERIFY,
90                 OCSP_R_SIGNER_CERTIFICATE_NOT_FOUND);
91         goto end;
92     }
93     ctx = X509_STORE_CTX_new();
94     if (ctx == NULL) {
95         OCSPerr(OCSP_F_OCSP_BASIC_VERIFY, ERR_R_MALLOC_FAILURE);
96         goto f_err;
97     }
98     if ((ret == 2) && (flags & OCSP_TRUSTOTHER))
99         flags |= OCSP_NOVERIFY;
100     if (!(flags & OCSP_NOSIGS)) {
101         EVP_PKEY *skey;
102         skey = X509_get0_pubkey(signer);
103         if (skey == NULL) {
104             OCSPerr(OCSP_F_OCSP_BASIC_VERIFY, OCSP_R_NO_SIGNER_KEY);
105             goto err;
106         }
107         ret = OCSP_BASICRESP_verify(bs, skey, 0);
108         if (ret <= 0) {
109             OCSPerr(OCSP_F_OCSP_BASIC_VERIFY, OCSP_R_SIGNATURE_FAILURE);
110             goto end;
111         }
112     }
113     if (!(flags & OCSP_NOVERIFY)) {
114         int init_res;
115         if (flags & OCSP_NOCHAIN) {
116             untrusted = NULL;
117         } else if (bs->certs && certs) {
118             untrusted = sk_X509_dup(bs->certs);
119             for (i = 0; i < sk_X509_num(certs); i++) {
120                 if (!sk_X509_push(untrusted, sk_X509_value(certs, i))) {
121                     OCSPerr(OCSP_F_OCSP_BASIC_VERIFY, ERR_R_MALLOC_FAILURE);
122                     goto f_err;
123                 }
124             }
125         } else {
126             untrusted = bs->certs;
127         }
128         init_res = X509_STORE_CTX_init(ctx, st, signer, untrusted);
129         if (!init_res) {
130             OCSPerr(OCSP_F_OCSP_BASIC_VERIFY, ERR_R_X509_LIB);
131             goto f_err;
132         }
133
134         X509_STORE_CTX_set_purpose(ctx, X509_PURPOSE_OCSP_HELPER);
135         ret = X509_verify_cert(ctx);
136         chain = X509_STORE_CTX_get1_chain(ctx);
137         if (ret <= 0) {
138             i = X509_STORE_CTX_get_error(ctx);
139             OCSPerr(OCSP_F_OCSP_BASIC_VERIFY,
140                     OCSP_R_CERTIFICATE_VERIFY_ERROR);
141             ERR_add_error_data(2, "Verify error:",
142                                X509_verify_cert_error_string(i));
143             goto end;
144         }
145         if (flags & OCSP_NOCHECKS) {
146             ret = 1;
147             goto end;
148         }
149         /*
150          * At this point we have a valid certificate chain need to verify it
151          * against the OCSP issuer criteria.
152          */
153         ret = ocsp_check_issuer(bs, chain);
154
155         /* If fatal error or valid match then finish */
156         if (ret != 0)
157             goto end;
158
159         /*
160          * Easy case: explicitly trusted. Get root CA and check for explicit
161          * trust
162          */
163         if (flags & OCSP_NOEXPLICIT)
164             goto end;
165
166         x = sk_X509_value(chain, sk_X509_num(chain) - 1);
167         if (X509_check_trust(x, NID_OCSP_sign, 0) != X509_TRUST_TRUSTED) {
168             OCSPerr(OCSP_F_OCSP_BASIC_VERIFY, OCSP_R_ROOT_CA_NOT_TRUSTED);
169             goto err;
170         }
171         ret = 1;
172     }
173  end:
174     X509_STORE_CTX_free(ctx);
175     sk_X509_pop_free(chain, X509_free);
176     if (bs->certs && certs)
177         sk_X509_free(untrusted);
178     return ret;
179     goto end;
180
181  err:
182     ret = 0;
183     goto end;
184  f_err:
185     ret = -1;
186     goto end;
187 }
188
189 static int ocsp_find_signer(X509 **psigner, OCSP_BASICRESP *bs,
190                             STACK_OF(X509) *certs, unsigned long flags)
191 {
192     X509 *signer;
193     OCSP_RESPID *rid = &bs->tbsResponseData.responderId;
194     if ((signer = ocsp_find_signer_sk(certs, rid))) {
195         *psigner = signer;
196         return 2;
197     }
198     if (!(flags & OCSP_NOINTERN) &&
199         (signer = ocsp_find_signer_sk(bs->certs, rid))) {
200         *psigner = signer;
201         return 1;
202     }
203     /* Maybe lookup from store if by subject name */
204
205     *psigner = NULL;
206     return 0;
207 }
208
209 static X509 *ocsp_find_signer_sk(STACK_OF(X509) *certs, OCSP_RESPID *id)
210 {
211     int i;
212     unsigned char tmphash[SHA_DIGEST_LENGTH], *keyhash;
213     X509 *x;
214
215     /* Easy if lookup by name */
216     if (id->type == V_OCSP_RESPID_NAME)
217         return X509_find_by_subject(certs, id->value.byName);
218
219     /* Lookup by key hash */
220
221     /* If key hash isn't SHA1 length then forget it */
222     if (id->value.byKey->length != SHA_DIGEST_LENGTH)
223         return NULL;
224     keyhash = id->value.byKey->data;
225     /* Calculate hash of each key and compare */
226     for (i = 0; i < sk_X509_num(certs); i++) {
227         x = sk_X509_value(certs, i);
228         X509_pubkey_digest(x, EVP_sha1(), tmphash, NULL);
229         if (!memcmp(keyhash, tmphash, SHA_DIGEST_LENGTH))
230             return x;
231     }
232     return NULL;
233 }
234
235 static int ocsp_check_issuer(OCSP_BASICRESP *bs, STACK_OF(X509) *chain)
236 {
237     STACK_OF(OCSP_SINGLERESP) *sresp;
238     X509 *signer, *sca;
239     OCSP_CERTID *caid = NULL;
240     int i;
241     sresp = bs->tbsResponseData.responses;
242
243     if (sk_X509_num(chain) <= 0) {
244         OCSPerr(OCSP_F_OCSP_CHECK_ISSUER, OCSP_R_NO_CERTIFICATES_IN_CHAIN);
245         return -1;
246     }
247
248     /* See if the issuer IDs match. */
249     i = ocsp_check_ids(sresp, &caid);
250
251     /* If ID mismatch or other error then return */
252     if (i <= 0)
253         return i;
254
255     signer = sk_X509_value(chain, 0);
256     /* Check to see if OCSP responder CA matches request CA */
257     if (sk_X509_num(chain) > 1) {
258         sca = sk_X509_value(chain, 1);
259         i = ocsp_match_issuerid(sca, caid, sresp);
260         if (i < 0)
261             return i;
262         if (i) {
263             /* We have a match, if extensions OK then success */
264             if (ocsp_check_delegated(signer))
265                 return 1;
266             return 0;
267         }
268     }
269
270     /* Otherwise check if OCSP request signed directly by request CA */
271     return ocsp_match_issuerid(signer, caid, sresp);
272 }
273
274 /*
275  * Check the issuer certificate IDs for equality. If there is a mismatch with
276  * the same algorithm then there's no point trying to match any certificates
277  * against the issuer. If the issuer IDs all match then we just need to check
278  * equality against one of them.
279  */
280
281 static int ocsp_check_ids(STACK_OF(OCSP_SINGLERESP) *sresp, OCSP_CERTID **ret)
282 {
283     OCSP_CERTID *tmpid, *cid;
284     int i, idcount;
285
286     idcount = sk_OCSP_SINGLERESP_num(sresp);
287     if (idcount <= 0) {
288         OCSPerr(OCSP_F_OCSP_CHECK_IDS,
289                 OCSP_R_RESPONSE_CONTAINS_NO_REVOCATION_DATA);
290         return -1;
291     }
292
293     cid = sk_OCSP_SINGLERESP_value(sresp, 0)->certId;
294
295     *ret = NULL;
296
297     for (i = 1; i < idcount; i++) {
298         tmpid = sk_OCSP_SINGLERESP_value(sresp, i)->certId;
299         /* Check to see if IDs match */
300         if (OCSP_id_issuer_cmp(cid, tmpid)) {
301             /* If algorithm mismatch let caller deal with it */
302             if (OBJ_cmp(tmpid->hashAlgorithm.algorithm,
303                         cid->hashAlgorithm.algorithm))
304                 return 2;
305             /* Else mismatch */
306             return 0;
307         }
308     }
309
310     /* All IDs match: only need to check one ID */
311     *ret = cid;
312     return 1;
313 }
314
315 static int ocsp_match_issuerid(X509 *cert, OCSP_CERTID *cid,
316                                STACK_OF(OCSP_SINGLERESP) *sresp)
317 {
318     /* If only one ID to match then do it */
319     if (cid) {
320         const EVP_MD *dgst;
321         X509_NAME *iname;
322         int mdlen;
323         unsigned char md[EVP_MAX_MD_SIZE];
324         if ((dgst = EVP_get_digestbyobj(cid->hashAlgorithm.algorithm))
325                 == NULL) {
326             OCSPerr(OCSP_F_OCSP_MATCH_ISSUERID,
327                     OCSP_R_UNKNOWN_MESSAGE_DIGEST);
328             return -1;
329         }
330
331         mdlen = EVP_MD_size(dgst);
332         if (mdlen < 0)
333             return -1;
334         if ((cid->issuerNameHash.length != mdlen) ||
335             (cid->issuerKeyHash.length != mdlen))
336             return 0;
337         iname = X509_get_subject_name(cert);
338         if (!X509_NAME_digest(iname, dgst, md, NULL))
339             return -1;
340         if (memcmp(md, cid->issuerNameHash.data, mdlen))
341             return 0;
342         X509_pubkey_digest(cert, dgst, md, NULL);
343         if (memcmp(md, cid->issuerKeyHash.data, mdlen))
344             return 0;
345
346         return 1;
347
348     } else {
349         /* We have to match the whole lot */
350         int i, ret;
351         OCSP_CERTID *tmpid;
352         for (i = 0; i < sk_OCSP_SINGLERESP_num(sresp); i++) {
353             tmpid = sk_OCSP_SINGLERESP_value(sresp, i)->certId;
354             ret = ocsp_match_issuerid(cert, tmpid, NULL);
355             if (ret <= 0)
356                 return ret;
357         }
358         return 1;
359     }
360
361 }
362
363 static int ocsp_check_delegated(X509 *x)
364 {
365     if ((X509_get_extension_flags(x) & EXFLAG_XKUSAGE)
366         && (X509_get_extended_key_usage(x) & XKU_OCSP_SIGN))
367         return 1;
368     OCSPerr(OCSP_F_OCSP_CHECK_DELEGATED, OCSP_R_MISSING_OCSPSIGNING_USAGE);
369     return 0;
370 }
371
372 /*
373  * Verify an OCSP request. This is fortunately much easier than OCSP response
374  * verify. Just find the signers certificate and verify it against a given
375  * trust value.
376  */
377
378 int OCSP_request_verify(OCSP_REQUEST *req, STACK_OF(X509) *certs,
379                         X509_STORE *store, unsigned long flags)
380 {
381     X509 *signer;
382     X509_NAME *nm;
383     GENERAL_NAME *gen;
384     int ret = 0;
385     X509_STORE_CTX *ctx = X509_STORE_CTX_new();
386
387     if (ctx == NULL) {
388         OCSPerr(OCSP_F_OCSP_REQUEST_VERIFY, ERR_R_MALLOC_FAILURE);
389         goto err;
390     }
391
392     if (!req->optionalSignature) {
393         OCSPerr(OCSP_F_OCSP_REQUEST_VERIFY, OCSP_R_REQUEST_NOT_SIGNED);
394         goto err;
395     }
396     gen = req->tbsRequest.requestorName;
397     if (!gen || gen->type != GEN_DIRNAME) {
398         OCSPerr(OCSP_F_OCSP_REQUEST_VERIFY,
399                 OCSP_R_UNSUPPORTED_REQUESTORNAME_TYPE);
400         goto err;
401     }
402     nm = gen->d.directoryName;
403     ret = ocsp_req_find_signer(&signer, req, nm, certs, flags);
404     if (ret <= 0) {
405         OCSPerr(OCSP_F_OCSP_REQUEST_VERIFY,
406                 OCSP_R_SIGNER_CERTIFICATE_NOT_FOUND);
407         goto err;
408     }
409     if ((ret == 2) && (flags & OCSP_TRUSTOTHER))
410         flags |= OCSP_NOVERIFY;
411     if (!(flags & OCSP_NOSIGS)) {
412         EVP_PKEY *skey;
413         skey = X509_get0_pubkey(signer);
414         ret = OCSP_REQUEST_verify(req, skey);
415         if (ret <= 0) {
416             OCSPerr(OCSP_F_OCSP_REQUEST_VERIFY, OCSP_R_SIGNATURE_FAILURE);
417             goto err;
418         }
419     }
420     if (!(flags & OCSP_NOVERIFY)) {
421         int init_res;
422         if (flags & OCSP_NOCHAIN)
423             init_res = X509_STORE_CTX_init(ctx, store, signer, NULL);
424         else
425             init_res = X509_STORE_CTX_init(ctx, store, signer,
426                                            req->optionalSignature->certs);
427         if (!init_res) {
428             OCSPerr(OCSP_F_OCSP_REQUEST_VERIFY, ERR_R_X509_LIB);
429             goto err;
430         }
431
432         X509_STORE_CTX_set_purpose(ctx, X509_PURPOSE_OCSP_HELPER);
433         X509_STORE_CTX_set_trust(ctx, X509_TRUST_OCSP_REQUEST);
434         ret = X509_verify_cert(ctx);
435         if (ret <= 0) {
436             ret = X509_STORE_CTX_get_error(ctx);
437             OCSPerr(OCSP_F_OCSP_REQUEST_VERIFY,
438                     OCSP_R_CERTIFICATE_VERIFY_ERROR);
439             ERR_add_error_data(2, "Verify error:",
440                                X509_verify_cert_error_string(ret));
441             goto err;
442         }
443     }
444     ret = 1;
445     goto end;
446
447 err:
448     ret = 0;
449 end:
450     X509_STORE_CTX_free(ctx);
451     return ret;
452
453 }
454
455 static int ocsp_req_find_signer(X509 **psigner, OCSP_REQUEST *req,
456                                 X509_NAME *nm, STACK_OF(X509) *certs,
457                                 unsigned long flags)
458 {
459     X509 *signer;
460     if (!(flags & OCSP_NOINTERN)) {
461         signer = X509_find_by_subject(req->optionalSignature->certs, nm);
462         if (signer) {
463             *psigner = signer;
464             return 1;
465         }
466     }
467
468     signer = X509_find_by_subject(certs, nm);
469     if (signer) {
470         *psigner = signer;
471         return 2;
472     }
473     return 0;
474 }