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