02690c19a71173de9e0ca8abebfd5b70a17f4bec
[openssl.git] / crypto / ts / ts_rsp_verify.c
1 /*
2  * Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (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 #include "internal/cryptlib.h"
12 #include <openssl/objects.h>
13 #include <openssl/ts.h>
14 #include <openssl/pkcs7.h>
15 #include "ts_local.h"
16 #include "crypto/ess.h"
17
18 DEFINE_STACK_OF(PKCS7_SIGNER_INFO)
19 DEFINE_STACK_OF(ESS_CERT_ID)
20 DEFINE_STACK_OF(ESS_CERT_ID_V2)
21 DEFINE_STACK_OF(ASN1_UTF8STRING)
22
23 static int ts_verify_cert(X509_STORE *store, STACK_OF(X509) *untrusted,
24                           X509 *signer, STACK_OF(X509) **chain);
25 static int ts_check_signing_certs(PKCS7_SIGNER_INFO *si,
26                                   STACK_OF(X509) *chain);
27
28 static int int_ts_RESP_verify_token(TS_VERIFY_CTX *ctx,
29                                     PKCS7 *token, TS_TST_INFO *tst_info);
30 static int ts_check_status_info(TS_RESP *response);
31 static char *ts_get_status_text(STACK_OF(ASN1_UTF8STRING) *text);
32 static int ts_check_policy(const ASN1_OBJECT *req_oid,
33                            const TS_TST_INFO *tst_info);
34 static int ts_compute_imprint(BIO *data, TS_TST_INFO *tst_info,
35                               X509_ALGOR **md_alg,
36                               unsigned char **imprint, unsigned *imprint_len);
37 static int ts_check_imprints(X509_ALGOR *algor_a,
38                              const unsigned char *imprint_a, unsigned len_a,
39                              TS_TST_INFO *tst_info);
40 static int ts_check_nonces(const ASN1_INTEGER *a, TS_TST_INFO *tst_info);
41 static int ts_check_signer_name(GENERAL_NAME *tsa_name, X509 *signer);
42 static int ts_find_name(STACK_OF(GENERAL_NAME) *gen_names,
43                         GENERAL_NAME *name);
44
45 /*
46  * This must be large enough to hold all values in ts_status_text (with
47  * comma separator) or all text fields in ts_failure_info (also with comma).
48  */
49 #define TS_STATUS_BUF_SIZE      256
50
51 /*
52  * Local mapping between response codes and descriptions.
53  */
54 static const char *ts_status_text[] = {
55     "granted",
56     "grantedWithMods",
57     "rejection",
58     "waiting",
59     "revocationWarning",
60     "revocationNotification"
61 };
62
63 #define TS_STATUS_TEXT_SIZE     OSSL_NELEM(ts_status_text)
64
65 static struct {
66     int code;
67     const char *text;
68 } ts_failure_info[] = {
69     {TS_INFO_BAD_ALG, "badAlg"},
70     {TS_INFO_BAD_REQUEST, "badRequest"},
71     {TS_INFO_BAD_DATA_FORMAT, "badDataFormat"},
72     {TS_INFO_TIME_NOT_AVAILABLE, "timeNotAvailable"},
73     {TS_INFO_UNACCEPTED_POLICY, "unacceptedPolicy"},
74     {TS_INFO_UNACCEPTED_EXTENSION, "unacceptedExtension"},
75     {TS_INFO_ADD_INFO_NOT_AVAILABLE, "addInfoNotAvailable"},
76     {TS_INFO_SYSTEM_FAILURE, "systemFailure"}
77 };
78
79
80 /*-
81  * This function carries out the following tasks:
82  *      - Checks if there is one and only one signer.
83  *      - Search for the signing certificate in 'certs' and in the response.
84  *      - Check the extended key usage and key usage fields of the signer
85  *      certificate (done by the path validation).
86  *      - Build and validate the certificate path.
87  *      - Check if the certificate path meets the requirements of the
88  *      SigningCertificate ESS signed attribute.
89  *      - Verify the signature value.
90  *      - Returns the signer certificate in 'signer', if 'signer' is not NULL.
91  */
92 int TS_RESP_verify_signature(PKCS7 *token, STACK_OF(X509) *certs,
93                              X509_STORE *store, X509 **signer_out)
94 {
95     STACK_OF(PKCS7_SIGNER_INFO) *sinfos = NULL;
96     PKCS7_SIGNER_INFO *si;
97     STACK_OF(X509) *signers = NULL;
98     X509 *signer;
99     STACK_OF(X509) *chain = NULL;
100     char buf[4096];
101     int i, j = 0, ret = 0;
102     BIO *p7bio = NULL;
103
104     /* Some sanity checks first. */
105     if (!token) {
106         TSerr(TS_F_TS_RESP_VERIFY_SIGNATURE, TS_R_INVALID_NULL_POINTER);
107         goto err;
108     }
109     if (!PKCS7_type_is_signed(token)) {
110         TSerr(TS_F_TS_RESP_VERIFY_SIGNATURE, TS_R_WRONG_CONTENT_TYPE);
111         goto err;
112     }
113     sinfos = PKCS7_get_signer_info(token);
114     if (!sinfos || sk_PKCS7_SIGNER_INFO_num(sinfos) != 1) {
115         TSerr(TS_F_TS_RESP_VERIFY_SIGNATURE, TS_R_THERE_MUST_BE_ONE_SIGNER);
116         goto err;
117     }
118     si = sk_PKCS7_SIGNER_INFO_value(sinfos, 0);
119     if (PKCS7_get_detached(token)) {
120         TSerr(TS_F_TS_RESP_VERIFY_SIGNATURE, TS_R_NO_CONTENT);
121         goto err;
122     }
123
124     /*
125      * Get hold of the signer certificate, search only internal certificates
126      * if it was requested.
127      */
128     signers = PKCS7_get0_signers(token, certs, 0);
129     if (!signers || sk_X509_num(signers) != 1)
130         goto err;
131     signer = sk_X509_value(signers, 0);
132
133     if (!ts_verify_cert(store, certs, signer, &chain))
134         goto err;
135     if (!ts_check_signing_certs(si, chain))
136         goto err;
137     p7bio = PKCS7_dataInit(token, NULL);
138
139     /* We now have to 'read' from p7bio to calculate digests etc. */
140     while ((i = BIO_read(p7bio, buf, sizeof(buf))) > 0)
141         continue;
142
143     j = PKCS7_signatureVerify(p7bio, token, si, signer);
144     if (j <= 0) {
145         TSerr(TS_F_TS_RESP_VERIFY_SIGNATURE, TS_R_SIGNATURE_FAILURE);
146         goto err;
147     }
148
149     if (signer_out) {
150         *signer_out = signer;
151         X509_up_ref(signer);
152     }
153     ret = 1;
154
155  err:
156     BIO_free_all(p7bio);
157     sk_X509_pop_free(chain, X509_free);
158     sk_X509_free(signers);
159
160     return ret;
161 }
162
163 /*
164  * The certificate chain is returned in chain. Caller is responsible for
165  * freeing the vector.
166  */
167 static int ts_verify_cert(X509_STORE *store, STACK_OF(X509) *untrusted,
168                           X509 *signer, STACK_OF(X509) **chain)
169 {
170     X509_STORE_CTX *cert_ctx = NULL;
171     int i;
172     int ret = 0;
173
174     *chain = NULL;
175     cert_ctx = X509_STORE_CTX_new();
176     if (cert_ctx == NULL) {
177         TSerr(TS_F_TS_VERIFY_CERT, ERR_R_MALLOC_FAILURE);
178         goto err;
179     }
180     if (!X509_STORE_CTX_init(cert_ctx, store, signer, untrusted))
181         goto end;
182     X509_STORE_CTX_set_purpose(cert_ctx, X509_PURPOSE_TIMESTAMP_SIGN);
183     i = X509_verify_cert(cert_ctx);
184     if (i <= 0) {
185         int j = X509_STORE_CTX_get_error(cert_ctx);
186         TSerr(TS_F_TS_VERIFY_CERT, TS_R_CERTIFICATE_VERIFY_ERROR);
187         ERR_add_error_data(2, "Verify error:",
188                            X509_verify_cert_error_string(j));
189         goto err;
190     }
191     *chain = X509_STORE_CTX_get1_chain(cert_ctx);
192     ret = 1;
193     goto end;
194
195 err:
196     ret = 0;
197
198 end:
199     X509_STORE_CTX_free(cert_ctx);
200     return ret;
201 }
202
203 static int ts_check_signing_certs(PKCS7_SIGNER_INFO *si,
204                                   STACK_OF(X509) *chain)
205 {
206     ESS_SIGNING_CERT *ss = ESS_SIGNING_CERT_get(si);
207     STACK_OF(ESS_CERT_ID) *cert_ids = NULL;
208     ESS_SIGNING_CERT_V2 *ssv2 = ESS_SIGNING_CERT_V2_get(si);
209     STACK_OF(ESS_CERT_ID_V2) *cert_ids_v2 = NULL;
210     X509 *cert;
211     int i = 0;
212     int ret = 0;
213
214     if (ss != NULL) {
215         cert_ids = ss->cert_ids;
216         cert = sk_X509_value(chain, 0);
217         if (ess_find_cert(cert_ids, cert) != 0)
218             goto err;
219
220         /*
221          * Check the other certificates of the chain if there are more than one
222          * certificate ids in cert_ids.
223          */
224         if (sk_ESS_CERT_ID_num(cert_ids) > 1) {
225             for (i = 1; i < sk_X509_num(chain); ++i) {
226                 cert = sk_X509_value(chain, i);
227                 if (ess_find_cert(cert_ids, cert) < 0)
228                     goto err;
229             }
230         }
231     } else if (ssv2 != NULL) {
232         cert_ids_v2 = ssv2->cert_ids;
233         cert = sk_X509_value(chain, 0);
234         if (ess_find_cert_v2(cert_ids_v2, cert) != 0)
235             goto err;
236
237         /*
238          * Check the other certificates of the chain if there are more than one
239          * certificate ids in cert_ids.
240          */
241         if (sk_ESS_CERT_ID_V2_num(cert_ids_v2) > 1) {
242             for (i = 1; i < sk_X509_num(chain); ++i) {
243                 cert = sk_X509_value(chain, i);
244                 if (ess_find_cert_v2(cert_ids_v2, cert) < 0)
245                     goto err;
246             }
247         }
248     } else {
249         goto err;
250     }
251
252     ret = 1;
253  err:
254     if (!ret)
255         TSerr(TS_F_TS_CHECK_SIGNING_CERTS,
256               TS_R_ESS_SIGNING_CERTIFICATE_ERROR);
257     ESS_SIGNING_CERT_free(ss);
258     ESS_SIGNING_CERT_V2_free(ssv2);
259     return ret;
260 }
261
262 /*-
263  * Verifies whether 'response' contains a valid response with regards
264  * to the settings of the context:
265  *      - Gives an error message if the TS_TST_INFO is not present.
266  *      - Calls _TS_RESP_verify_token to verify the token content.
267  */
268 int TS_RESP_verify_response(TS_VERIFY_CTX *ctx, TS_RESP *response)
269 {
270     PKCS7 *token = response->token;
271     TS_TST_INFO *tst_info = response->tst_info;
272     int ret = 0;
273
274     if (!ts_check_status_info(response))
275         goto err;
276     if (!int_ts_RESP_verify_token(ctx, token, tst_info))
277         goto err;
278     ret = 1;
279
280  err:
281     return ret;
282 }
283
284 /*
285  * Tries to extract a TS_TST_INFO structure from the PKCS7 token and
286  * calls the internal int_TS_RESP_verify_token function for verifying it.
287  */
288 int TS_RESP_verify_token(TS_VERIFY_CTX *ctx, PKCS7 *token)
289 {
290     TS_TST_INFO *tst_info = PKCS7_to_TS_TST_INFO(token);
291     int ret = 0;
292     if (tst_info) {
293         ret = int_ts_RESP_verify_token(ctx, token, tst_info);
294         TS_TST_INFO_free(tst_info);
295     }
296     return ret;
297 }
298
299 /*-
300  * Verifies whether the 'token' contains a valid time stamp token
301  * with regards to the settings of the context. Only those checks are
302  * carried out that are specified in the context:
303  *      - Verifies the signature of the TS_TST_INFO.
304  *      - Checks the version number of the response.
305  *      - Check if the requested and returned policies math.
306  *      - Check if the message imprints are the same.
307  *      - Check if the nonces are the same.
308  *      - Check if the TSA name matches the signer.
309  *      - Check if the TSA name is the expected TSA.
310  */
311 static int int_ts_RESP_verify_token(TS_VERIFY_CTX *ctx,
312                                     PKCS7 *token, TS_TST_INFO *tst_info)
313 {
314     X509 *signer = NULL;
315     GENERAL_NAME *tsa_name = tst_info->tsa;
316     X509_ALGOR *md_alg = NULL;
317     unsigned char *imprint = NULL;
318     unsigned imprint_len = 0;
319     int ret = 0;
320     int flags = ctx->flags;
321
322     /* Some options require us to also check the signature */
323     if (((flags & TS_VFY_SIGNER) && tsa_name != NULL)
324             || (flags & TS_VFY_TSA_NAME)) {
325         flags |= TS_VFY_SIGNATURE;
326     }
327
328     if ((flags & TS_VFY_SIGNATURE)
329         && !TS_RESP_verify_signature(token, ctx->certs, ctx->store, &signer))
330         goto err;
331     if ((flags & TS_VFY_VERSION)
332         && TS_TST_INFO_get_version(tst_info) != 1) {
333         TSerr(TS_F_INT_TS_RESP_VERIFY_TOKEN, TS_R_UNSUPPORTED_VERSION);
334         goto err;
335     }
336     if ((flags & TS_VFY_POLICY)
337         && !ts_check_policy(ctx->policy, tst_info))
338         goto err;
339     if ((flags & TS_VFY_IMPRINT)
340         && !ts_check_imprints(ctx->md_alg, ctx->imprint, ctx->imprint_len,
341                               tst_info))
342         goto err;
343     if ((flags & TS_VFY_DATA)
344         && (!ts_compute_imprint(ctx->data, tst_info,
345                                 &md_alg, &imprint, &imprint_len)
346             || !ts_check_imprints(md_alg, imprint, imprint_len, tst_info)))
347         goto err;
348     if ((flags & TS_VFY_NONCE)
349         && !ts_check_nonces(ctx->nonce, tst_info))
350         goto err;
351     if ((flags & TS_VFY_SIGNER)
352         && tsa_name && !ts_check_signer_name(tsa_name, signer)) {
353         TSerr(TS_F_INT_TS_RESP_VERIFY_TOKEN, TS_R_TSA_NAME_MISMATCH);
354         goto err;
355     }
356     if ((flags & TS_VFY_TSA_NAME)
357         && !ts_check_signer_name(ctx->tsa_name, signer)) {
358         TSerr(TS_F_INT_TS_RESP_VERIFY_TOKEN, TS_R_TSA_UNTRUSTED);
359         goto err;
360     }
361     ret = 1;
362
363  err:
364     X509_free(signer);
365     X509_ALGOR_free(md_alg);
366     OPENSSL_free(imprint);
367     return ret;
368 }
369
370 static int ts_check_status_info(TS_RESP *response)
371 {
372     TS_STATUS_INFO *info = response->status_info;
373     long status = ASN1_INTEGER_get(info->status);
374     const char *status_text = NULL;
375     char *embedded_status_text = NULL;
376     char failure_text[TS_STATUS_BUF_SIZE] = "";
377
378     if (status == 0 || status == 1)
379         return 1;
380
381     /* There was an error, get the description in status_text. */
382     if (0 <= status && status < (long) OSSL_NELEM(ts_status_text))
383         status_text = ts_status_text[status];
384     else
385         status_text = "unknown code";
386
387     if (sk_ASN1_UTF8STRING_num(info->text) > 0
388         && (embedded_status_text = ts_get_status_text(info->text)) == NULL)
389         return 0;
390
391     /* Fill in failure_text with the failure information. */
392     if (info->failure_info) {
393         int i;
394         int first = 1;
395         for (i = 0; i < (int)OSSL_NELEM(ts_failure_info); ++i) {
396             if (ASN1_BIT_STRING_get_bit(info->failure_info,
397                                         ts_failure_info[i].code)) {
398                 if (!first)
399                     strcat(failure_text, ",");
400                 else
401                     first = 0;
402                 strcat(failure_text, ts_failure_info[i].text);
403             }
404         }
405     }
406     if (failure_text[0] == '\0')
407         strcpy(failure_text, "unspecified");
408
409     TSerr(TS_F_TS_CHECK_STATUS_INFO, TS_R_NO_TIME_STAMP_TOKEN);
410     ERR_add_error_data(6,
411                        "status code: ", status_text,
412                        ", status text: ", embedded_status_text ?
413                        embedded_status_text : "unspecified",
414                        ", failure codes: ", failure_text);
415     OPENSSL_free(embedded_status_text);
416
417     return 0;
418 }
419
420 static char *ts_get_status_text(STACK_OF(ASN1_UTF8STRING) *text)
421 {
422     return sk_ASN1_UTF8STRING2text(text, "/", TS_MAX_STATUS_LENGTH);
423 }
424
425 static int ts_check_policy(const ASN1_OBJECT *req_oid,
426                            const TS_TST_INFO *tst_info)
427 {
428     const ASN1_OBJECT *resp_oid = tst_info->policy_id;
429
430     if (OBJ_cmp(req_oid, resp_oid) != 0) {
431         TSerr(TS_F_TS_CHECK_POLICY, TS_R_POLICY_MISMATCH);
432         return 0;
433     }
434
435     return 1;
436 }
437
438 static int ts_compute_imprint(BIO *data, TS_TST_INFO *tst_info,
439                               X509_ALGOR **md_alg,
440                               unsigned char **imprint, unsigned *imprint_len)
441 {
442     TS_MSG_IMPRINT *msg_imprint = tst_info->msg_imprint;
443     X509_ALGOR *md_alg_resp = msg_imprint->hash_algo;
444     const EVP_MD *md;
445     EVP_MD_CTX *md_ctx = NULL;
446     unsigned char buffer[4096];
447     int length;
448
449     *md_alg = NULL;
450     *imprint = NULL;
451
452     if ((*md_alg = X509_ALGOR_dup(md_alg_resp)) == NULL)
453         goto err;
454     if ((md = EVP_get_digestbyobj((*md_alg)->algorithm)) == NULL) {
455         TSerr(TS_F_TS_COMPUTE_IMPRINT, TS_R_UNSUPPORTED_MD_ALGORITHM);
456         goto err;
457     }
458     length = EVP_MD_size(md);
459     if (length < 0)
460         goto err;
461     *imprint_len = length;
462     if ((*imprint = OPENSSL_malloc(*imprint_len)) == NULL) {
463         TSerr(TS_F_TS_COMPUTE_IMPRINT, ERR_R_MALLOC_FAILURE);
464         goto err;
465     }
466
467     md_ctx = EVP_MD_CTX_new();
468     if (md_ctx == NULL) {
469         TSerr(TS_F_TS_COMPUTE_IMPRINT, ERR_R_MALLOC_FAILURE);
470         goto err;
471     }
472     if (!EVP_DigestInit(md_ctx, md))
473         goto err;
474     while ((length = BIO_read(data, buffer, sizeof(buffer))) > 0) {
475         if (!EVP_DigestUpdate(md_ctx, buffer, length))
476             goto err;
477     }
478     if (!EVP_DigestFinal(md_ctx, *imprint, NULL))
479         goto err;
480     EVP_MD_CTX_free(md_ctx);
481
482     return 1;
483  err:
484     EVP_MD_CTX_free(md_ctx);
485     X509_ALGOR_free(*md_alg);
486     OPENSSL_free(*imprint);
487     *imprint_len = 0;
488     *imprint = 0;
489     return 0;
490 }
491
492 static int ts_check_imprints(X509_ALGOR *algor_a,
493                              const unsigned char *imprint_a, unsigned len_a,
494                              TS_TST_INFO *tst_info)
495 {
496     TS_MSG_IMPRINT *b = tst_info->msg_imprint;
497     X509_ALGOR *algor_b = b->hash_algo;
498     int ret = 0;
499
500     if (algor_a) {
501         if (OBJ_cmp(algor_a->algorithm, algor_b->algorithm))
502             goto err;
503
504         /* The parameter must be NULL in both. */
505         if ((algor_a->parameter
506              && ASN1_TYPE_get(algor_a->parameter) != V_ASN1_NULL)
507             || (algor_b->parameter
508                 && ASN1_TYPE_get(algor_b->parameter) != V_ASN1_NULL))
509             goto err;
510     }
511
512     ret = len_a == (unsigned)ASN1_STRING_length(b->hashed_msg) &&
513         memcmp(imprint_a, ASN1_STRING_get0_data(b->hashed_msg), len_a) == 0;
514  err:
515     if (!ret)
516         TSerr(TS_F_TS_CHECK_IMPRINTS, TS_R_MESSAGE_IMPRINT_MISMATCH);
517     return ret;
518 }
519
520 static int ts_check_nonces(const ASN1_INTEGER *a, TS_TST_INFO *tst_info)
521 {
522     const ASN1_INTEGER *b = tst_info->nonce;
523
524     if (!b) {
525         TSerr(TS_F_TS_CHECK_NONCES, TS_R_NONCE_NOT_RETURNED);
526         return 0;
527     }
528
529     /* No error if a nonce is returned without being requested. */
530     if (ASN1_INTEGER_cmp(a, b) != 0) {
531         TSerr(TS_F_TS_CHECK_NONCES, TS_R_NONCE_MISMATCH);
532         return 0;
533     }
534
535     return 1;
536 }
537
538 /*
539  * Check if the specified TSA name matches either the subject or one of the
540  * subject alternative names of the TSA certificate.
541  */
542 static int ts_check_signer_name(GENERAL_NAME *tsa_name, X509 *signer)
543 {
544     STACK_OF(GENERAL_NAME) *gen_names = NULL;
545     int idx = -1;
546     int found = 0;
547
548     if (tsa_name->type == GEN_DIRNAME
549         && X509_name_cmp(tsa_name->d.dirn, X509_get_subject_name(signer)) == 0)
550         return 1;
551     gen_names = X509_get_ext_d2i(signer, NID_subject_alt_name, NULL, &idx);
552     while (gen_names != NULL) {
553         found = ts_find_name(gen_names, tsa_name) >= 0;
554         if (found)
555             break;
556         /*
557          * Get the next subject alternative name, although there should be no
558          * more than one.
559          */
560         GENERAL_NAMES_free(gen_names);
561         gen_names = X509_get_ext_d2i(signer, NID_subject_alt_name, NULL, &idx);
562     }
563     GENERAL_NAMES_free(gen_names);
564
565     return found;
566 }
567
568 /* Returns 1 if name is in gen_names, 0 otherwise. */
569 static int ts_find_name(STACK_OF(GENERAL_NAME) *gen_names, GENERAL_NAME *name)
570 {
571     int i, found;
572     for (i = 0, found = 0; !found && i < sk_GENERAL_NAME_num(gen_names); ++i) {
573         GENERAL_NAME *current = sk_GENERAL_NAME_value(gen_names, i);
574         found = GENERAL_NAME_cmp(current, name) == 0;
575     }
576     return found ? i - 1 : -1;
577 }