1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Copyright (C) 2012 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
8 #define pr_fmt(fmt) "PKCS7: "fmt
9 #include <linux/kernel.h>
10 #include <linux/module.h>
11 #include <linux/export.h>
12 #include <linux/slab.h>
13 #include <linux/err.h>
14 #include <linux/oid_registry.h>
15 #include <crypto/public_key.h>
16 #include "pkcs7_parser.h"
17 #include "pkcs7.asn1.h"
19 MODULE_DESCRIPTION("PKCS#7 parser");
20 MODULE_AUTHOR("Red Hat, Inc.");
21 MODULE_LICENSE("GPL");
23 struct pkcs7_parse_context {
24 struct pkcs7_message *msg; /* Message being constructed */
25 struct pkcs7_signed_info *sinfo; /* SignedInfo being constructed */
26 struct pkcs7_signed_info **ppsinfo;
27 struct x509_certificate *certs; /* Certificate cache */
28 struct x509_certificate **ppcerts;
29 unsigned long data; /* Start of data */
30 enum OID last_oid; /* Last OID encountered */
33 const void *raw_serial;
34 unsigned raw_serial_size;
35 unsigned raw_issuer_size;
36 const void *raw_issuer;
38 unsigned raw_skid_size;
43 * Free a signed information block.
45 static void pkcs7_free_signed_info(struct pkcs7_signed_info *sinfo)
48 public_key_signature_free(sinfo->sig);
54 * pkcs7_free_message - Free a PKCS#7 message
55 * @pkcs7: The PKCS#7 message to free
57 void pkcs7_free_message(struct pkcs7_message *pkcs7)
59 struct x509_certificate *cert;
60 struct pkcs7_signed_info *sinfo;
63 while (pkcs7->certs) {
65 pkcs7->certs = cert->next;
66 x509_free_certificate(cert);
70 pkcs7->crl = cert->next;
71 x509_free_certificate(cert);
73 while (pkcs7->signed_infos) {
74 sinfo = pkcs7->signed_infos;
75 pkcs7->signed_infos = sinfo->next;
76 pkcs7_free_signed_info(sinfo);
81 EXPORT_SYMBOL_GPL(pkcs7_free_message);
84 * Check authenticatedAttributes are provided or not provided consistently.
86 static int pkcs7_check_authattrs(struct pkcs7_message *msg)
88 struct pkcs7_signed_info *sinfo;
91 sinfo = msg->signed_infos;
95 if (sinfo->authattrs) {
97 msg->have_authattrs = true;
100 for (sinfo = sinfo->next; sinfo; sinfo = sinfo->next)
101 if (!!sinfo->authattrs != want)
106 pr_warn("Inconsistently supplied authAttrs\n");
111 * pkcs7_parse_message - Parse a PKCS#7 message
112 * @data: The raw binary ASN.1 encoded message to be parsed
113 * @datalen: The size of the encoded message
115 struct pkcs7_message *pkcs7_parse_message(const void *data, size_t datalen)
117 struct pkcs7_parse_context *ctx;
118 struct pkcs7_message *msg = ERR_PTR(-ENOMEM);
121 ctx = kzalloc(sizeof(struct pkcs7_parse_context), GFP_KERNEL);
124 ctx->msg = kzalloc(sizeof(struct pkcs7_message), GFP_KERNEL);
127 ctx->sinfo = kzalloc(sizeof(struct pkcs7_signed_info), GFP_KERNEL);
130 ctx->sinfo->sig = kzalloc(sizeof(struct public_key_signature),
132 if (!ctx->sinfo->sig)
135 ctx->data = (unsigned long)data;
136 ctx->ppcerts = &ctx->certs;
137 ctx->ppsinfo = &ctx->msg->signed_infos;
139 /* Attempt to decode the signature */
140 ret = asn1_ber_decoder(&pkcs7_decoder, ctx, data, datalen);
146 ret = pkcs7_check_authattrs(ctx->msg);
157 struct x509_certificate *cert = ctx->certs;
158 ctx->certs = cert->next;
159 x509_free_certificate(cert);
162 pkcs7_free_signed_info(ctx->sinfo);
164 pkcs7_free_message(ctx->msg);
170 EXPORT_SYMBOL_GPL(pkcs7_parse_message);
173 * pkcs7_get_content_data - Get access to the PKCS#7 content
174 * @pkcs7: The preparsed PKCS#7 message to access
175 * @_data: Place to return a pointer to the data
176 * @_data_len: Place to return the data length
177 * @_headerlen: Size of ASN.1 header not included in _data
179 * Get access to the data content of the PKCS#7 message. The size of the
180 * header of the ASN.1 object that contains it is also provided and can be used
181 * to adjust *_data and *_data_len to get the entire object.
183 * Returns -ENODATA if the data object was missing from the message.
185 int pkcs7_get_content_data(const struct pkcs7_message *pkcs7,
186 const void **_data, size_t *_data_len,
192 *_data = pkcs7->data;
193 *_data_len = pkcs7->data_len;
195 *_headerlen = pkcs7->data_hdrlen;
198 EXPORT_SYMBOL_GPL(pkcs7_get_content_data);
201 * Note an OID when we find one for later processing when we know how
204 int pkcs7_note_OID(void *context, size_t hdrlen,
206 const void *value, size_t vlen)
208 struct pkcs7_parse_context *ctx = context;
210 ctx->last_oid = look_up_OID(value, vlen);
211 if (ctx->last_oid == OID__NR) {
213 sprint_oid(value, vlen, buffer, sizeof(buffer));
214 printk("PKCS7: Unknown OID: [%lu] %s\n",
215 (unsigned long)value - ctx->data, buffer);
221 * Note the digest algorithm for the signature.
223 int pkcs7_sig_note_digest_algo(void *context, size_t hdrlen,
225 const void *value, size_t vlen)
227 struct pkcs7_parse_context *ctx = context;
229 switch (ctx->last_oid) {
231 ctx->sinfo->sig->hash_algo = "sha1";
234 ctx->sinfo->sig->hash_algo = "sha256";
237 ctx->sinfo->sig->hash_algo = "sha384";
240 ctx->sinfo->sig->hash_algo = "sha512";
243 ctx->sinfo->sig->hash_algo = "sha224";
246 ctx->sinfo->sig->hash_algo = "sm3";
248 case OID_gost2012Digest256:
249 ctx->sinfo->sig->hash_algo = "streebog256";
251 case OID_gost2012Digest512:
252 ctx->sinfo->sig->hash_algo = "streebog512";
255 ctx->sinfo->sig->hash_algo = "sha3-256";
258 ctx->sinfo->sig->hash_algo = "sha3-384";
261 ctx->sinfo->sig->hash_algo = "sha3-512";
264 printk("Unsupported digest algo: %u\n", ctx->last_oid);
271 * Note the public key algorithm for the signature.
273 int pkcs7_sig_note_pkey_algo(void *context, size_t hdrlen,
275 const void *value, size_t vlen)
277 struct pkcs7_parse_context *ctx = context;
279 switch (ctx->last_oid) {
280 case OID_rsaEncryption:
281 ctx->sinfo->sig->pkey_algo = "rsa";
282 ctx->sinfo->sig->encoding = "pkcs1";
284 case OID_id_ecdsa_with_sha1:
285 case OID_id_ecdsa_with_sha224:
286 case OID_id_ecdsa_with_sha256:
287 case OID_id_ecdsa_with_sha384:
288 case OID_id_ecdsa_with_sha512:
289 case OID_id_ecdsa_with_sha3_256:
290 case OID_id_ecdsa_with_sha3_384:
291 case OID_id_ecdsa_with_sha3_512:
292 ctx->sinfo->sig->pkey_algo = "ecdsa";
293 ctx->sinfo->sig->encoding = "x962";
295 case OID_SM2_with_SM3:
296 ctx->sinfo->sig->pkey_algo = "sm2";
297 ctx->sinfo->sig->encoding = "raw";
299 case OID_gost2012PKey256:
300 case OID_gost2012PKey512:
301 ctx->sinfo->sig->pkey_algo = "ecrdsa";
302 ctx->sinfo->sig->encoding = "raw";
305 printk("Unsupported pkey algo: %u\n", ctx->last_oid);
312 * We only support signed data [RFC2315 sec 9].
314 int pkcs7_check_content_type(void *context, size_t hdrlen,
316 const void *value, size_t vlen)
318 struct pkcs7_parse_context *ctx = context;
320 if (ctx->last_oid != OID_signed_data) {
321 pr_warn("Only support pkcs7_signedData type\n");
329 * Note the SignedData version
331 int pkcs7_note_signeddata_version(void *context, size_t hdrlen,
333 const void *value, size_t vlen)
335 struct pkcs7_parse_context *ctx = context;
341 ctx->msg->version = version = *(const u8 *)value;
344 /* PKCS#7 SignedData [RFC2315 sec 9.1]
345 * CMS ver 1 SignedData [RFC5652 sec 5.1]
349 /* CMS ver 3 SignedData [RFC2315 sec 5.1] */
358 pr_warn("Unsupported SignedData version\n");
363 * Note the SignerInfo version
365 int pkcs7_note_signerinfo_version(void *context, size_t hdrlen,
367 const void *value, size_t vlen)
369 struct pkcs7_parse_context *ctx = context;
375 version = *(const u8 *)value;
378 /* PKCS#7 SignerInfo [RFC2315 sec 9.2]
379 * CMS ver 1 SignerInfo [RFC5652 sec 5.3]
381 if (ctx->msg->version != 1)
382 goto version_mismatch;
383 ctx->expect_skid = false;
386 /* CMS ver 3 SignerInfo [RFC2315 sec 5.3] */
387 if (ctx->msg->version == 1)
388 goto version_mismatch;
389 ctx->expect_skid = true;
398 pr_warn("Unsupported SignerInfo version\n");
401 pr_warn("SignedData-SignerInfo version mismatch\n");
406 * Extract a certificate and store it in the context.
408 int pkcs7_extract_cert(void *context, size_t hdrlen,
410 const void *value, size_t vlen)
412 struct pkcs7_parse_context *ctx = context;
413 struct x509_certificate *x509;
415 if (tag != ((ASN1_UNIV << 6) | ASN1_CONS_BIT | ASN1_SEQ)) {
416 pr_debug("Cert began with tag %02x at %lu\n",
417 tag, (unsigned long)ctx - ctx->data);
421 /* We have to correct for the header so that the X.509 parser can start
422 * from the beginning. Note that since X.509 stipulates DER, there
423 * probably shouldn't be an EOC trailer - but it is in PKCS#7 (which
429 if (((u8*)value)[1] == 0x80)
430 vlen += 2; /* Indefinite length - there should be an EOC */
432 x509 = x509_cert_parse(value, vlen);
434 return PTR_ERR(x509);
436 x509->index = ++ctx->x509_index;
437 pr_debug("Got cert %u for %s\n", x509->index, x509->subject);
438 pr_debug("- fingerprint %*phN\n", x509->id->len, x509->id->data);
440 *ctx->ppcerts = x509;
441 ctx->ppcerts = &x509->next;
446 * Save the certificate list
448 int pkcs7_note_certificate_list(void *context, size_t hdrlen,
450 const void *value, size_t vlen)
452 struct pkcs7_parse_context *ctx = context;
454 pr_devel("Got cert list (%02x)\n", tag);
456 *ctx->ppcerts = ctx->msg->certs;
457 ctx->msg->certs = ctx->certs;
459 ctx->ppcerts = &ctx->certs;
464 * Note the content type.
466 int pkcs7_note_content(void *context, size_t hdrlen,
468 const void *value, size_t vlen)
470 struct pkcs7_parse_context *ctx = context;
472 if (ctx->last_oid != OID_data &&
473 ctx->last_oid != OID_msIndirectData) {
474 pr_warn("Unsupported data type %d\n", ctx->last_oid);
478 ctx->msg->data_type = ctx->last_oid;
483 * Extract the data from the message and store that and its content type OID in
486 int pkcs7_note_data(void *context, size_t hdrlen,
488 const void *value, size_t vlen)
490 struct pkcs7_parse_context *ctx = context;
492 pr_debug("Got data\n");
494 ctx->msg->data = value;
495 ctx->msg->data_len = vlen;
496 ctx->msg->data_hdrlen = hdrlen;
501 * Parse authenticated attributes.
503 int pkcs7_sig_note_authenticated_attr(void *context, size_t hdrlen,
505 const void *value, size_t vlen)
507 struct pkcs7_parse_context *ctx = context;
508 struct pkcs7_signed_info *sinfo = ctx->sinfo;
509 enum OID content_type;
511 pr_devel("AuthAttr: %02x %zu [%*ph]\n", tag, vlen, (unsigned)vlen, value);
513 switch (ctx->last_oid) {
514 case OID_contentType:
515 if (__test_and_set_bit(sinfo_has_content_type, &sinfo->aa_set))
517 content_type = look_up_OID(value, vlen);
518 if (content_type != ctx->msg->data_type) {
519 pr_warn("Mismatch between global data type (%d) and sinfo %u (%d)\n",
520 ctx->msg->data_type, sinfo->index,
526 case OID_signingTime:
527 if (__test_and_set_bit(sinfo_has_signing_time, &sinfo->aa_set))
529 /* Should we check that the signing time is consistent
530 * with the signer's X.509 cert?
532 return x509_decode_time(&sinfo->signing_time,
533 hdrlen, tag, value, vlen);
535 case OID_messageDigest:
536 if (__test_and_set_bit(sinfo_has_message_digest, &sinfo->aa_set))
540 sinfo->msgdigest = value;
541 sinfo->msgdigest_len = vlen;
544 case OID_smimeCapabilites:
545 if (__test_and_set_bit(sinfo_has_smime_caps, &sinfo->aa_set))
547 if (ctx->msg->data_type != OID_msIndirectData) {
548 pr_warn("S/MIME Caps only allowed with Authenticode\n");
549 return -EKEYREJECTED;
553 /* Microsoft SpOpusInfo seems to be contain cont[0] 16-bit BE
554 * char URLs and cont[1] 8-bit char URLs.
556 * Microsoft StatementType seems to contain a list of OIDs that
557 * are also used as extendedKeyUsage types in X.509 certs.
559 case OID_msSpOpusInfo:
560 if (__test_and_set_bit(sinfo_has_ms_opus_info, &sinfo->aa_set))
562 goto authenticode_check;
563 case OID_msStatementType:
564 if (__test_and_set_bit(sinfo_has_ms_statement_type, &sinfo->aa_set))
567 if (ctx->msg->data_type != OID_msIndirectData) {
568 pr_warn("Authenticode AuthAttrs only allowed with Authenticode\n");
569 return -EKEYREJECTED;
571 /* I'm not sure how to validate these */
578 /* We permit max one item per AuthenticatedAttribute and no repeats */
579 pr_warn("Repeated/multivalue AuthAttrs not permitted\n");
580 return -EKEYREJECTED;
584 * Note the set of auth attributes for digestion purposes [RFC2315 sec 9.3]
586 int pkcs7_sig_note_set_of_authattrs(void *context, size_t hdrlen,
588 const void *value, size_t vlen)
590 struct pkcs7_parse_context *ctx = context;
591 struct pkcs7_signed_info *sinfo = ctx->sinfo;
593 if (!test_bit(sinfo_has_content_type, &sinfo->aa_set) ||
594 !test_bit(sinfo_has_message_digest, &sinfo->aa_set)) {
595 pr_warn("Missing required AuthAttr\n");
599 if (ctx->msg->data_type != OID_msIndirectData &&
600 test_bit(sinfo_has_ms_opus_info, &sinfo->aa_set)) {
601 pr_warn("Unexpected Authenticode AuthAttr\n");
605 /* We need to switch the 'CONT 0' to a 'SET OF' when we digest */
606 sinfo->authattrs = value - (hdrlen - 1);
607 sinfo->authattrs_len = vlen + (hdrlen - 1);
612 * Note the issuing certificate serial number
614 int pkcs7_sig_note_serial(void *context, size_t hdrlen,
616 const void *value, size_t vlen)
618 struct pkcs7_parse_context *ctx = context;
619 ctx->raw_serial = value;
620 ctx->raw_serial_size = vlen;
625 * Note the issuer's name
627 int pkcs7_sig_note_issuer(void *context, size_t hdrlen,
629 const void *value, size_t vlen)
631 struct pkcs7_parse_context *ctx = context;
632 ctx->raw_issuer = value;
633 ctx->raw_issuer_size = vlen;
638 * Note the issuing cert's subjectKeyIdentifier
640 int pkcs7_sig_note_skid(void *context, size_t hdrlen,
642 const void *value, size_t vlen)
644 struct pkcs7_parse_context *ctx = context;
646 pr_devel("SKID: %02x %zu [%*ph]\n", tag, vlen, (unsigned)vlen, value);
648 ctx->raw_skid = value;
649 ctx->raw_skid_size = vlen;
654 * Note the signature data
656 int pkcs7_sig_note_signature(void *context, size_t hdrlen,
658 const void *value, size_t vlen)
660 struct pkcs7_parse_context *ctx = context;
662 ctx->sinfo->sig->s = kmemdup(value, vlen, GFP_KERNEL);
663 if (!ctx->sinfo->sig->s)
666 ctx->sinfo->sig->s_size = vlen;
671 * Note a signature information block
673 int pkcs7_note_signed_info(void *context, size_t hdrlen,
675 const void *value, size_t vlen)
677 struct pkcs7_parse_context *ctx = context;
678 struct pkcs7_signed_info *sinfo = ctx->sinfo;
679 struct asymmetric_key_id *kid;
681 if (ctx->msg->data_type == OID_msIndirectData && !sinfo->authattrs) {
682 pr_warn("Authenticode requires AuthAttrs\n");
686 /* Generate cert issuer + serial number key ID */
687 if (!ctx->expect_skid) {
688 kid = asymmetric_key_generate_id(ctx->raw_serial,
689 ctx->raw_serial_size,
691 ctx->raw_issuer_size);
693 kid = asymmetric_key_generate_id(ctx->raw_skid,
700 pr_devel("SINFO KID: %u [%*phN]\n", kid->len, kid->len, kid->data);
702 sinfo->sig->auth_ids[0] = kid;
703 sinfo->index = ++ctx->sinfo_index;
704 *ctx->ppsinfo = sinfo;
705 ctx->ppsinfo = &sinfo->next;
706 ctx->sinfo = kzalloc(sizeof(struct pkcs7_signed_info), GFP_KERNEL);
709 ctx->sinfo->sig = kzalloc(sizeof(struct public_key_signature),
711 if (!ctx->sinfo->sig)