3 * Copyright (C) 2012 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public Licence
8 * as published by the Free Software Foundation; either version
9 * 2 of the Licence, or (at your option) any later version.
12 #define pr_fmt(fmt) "PKCS7: "fmt
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/export.h>
16 #include <linux/slab.h>
17 #include <linux/err.h>
18 #include <linux/oid_registry.h>
19 #include <crypto/public_key.h>
20 #include "pkcs7_parser.h"
21 #include "pkcs7.asn1.h"
23 MODULE_DESCRIPTION("PKCS#7 parser");
24 MODULE_AUTHOR("Red Hat, Inc.");
25 MODULE_LICENSE("GPL");
27 struct pkcs7_parse_context
{
28 struct pkcs7_message
*msg
; /* Message being constructed */
29 struct pkcs7_signed_info
*sinfo
; /* SignedInfo being constructed */
30 struct pkcs7_signed_info
**ppsinfo
;
31 struct x509_certificate
*certs
; /* Certificate cache */
32 struct x509_certificate
**ppcerts
;
33 unsigned long data
; /* Start of data */
34 enum OID last_oid
; /* Last OID encountered */
37 const void *raw_serial
;
38 unsigned raw_serial_size
;
39 unsigned raw_issuer_size
;
40 const void *raw_issuer
;
42 unsigned raw_skid_size
;
47 * Free a signed information block.
49 static void pkcs7_free_signed_info(struct pkcs7_signed_info
*sinfo
)
52 public_key_signature_free(sinfo
->sig
);
58 * pkcs7_free_message - Free a PKCS#7 message
59 * @pkcs7: The PKCS#7 message to free
61 void pkcs7_free_message(struct pkcs7_message
*pkcs7
)
63 struct x509_certificate
*cert
;
64 struct pkcs7_signed_info
*sinfo
;
67 while (pkcs7
->certs
) {
69 pkcs7
->certs
= cert
->next
;
70 x509_free_certificate(cert
);
74 pkcs7
->crl
= cert
->next
;
75 x509_free_certificate(cert
);
77 while (pkcs7
->signed_infos
) {
78 sinfo
= pkcs7
->signed_infos
;
79 pkcs7
->signed_infos
= sinfo
->next
;
80 pkcs7_free_signed_info(sinfo
);
85 EXPORT_SYMBOL_GPL(pkcs7_free_message
);
88 * Check authenticatedAttributes are provided or not provided consistently.
90 static int pkcs7_check_authattrs(struct pkcs7_message
*msg
)
92 struct pkcs7_signed_info
*sinfo
;
95 sinfo
= msg
->signed_infos
;
99 if (sinfo
->authattrs
) {
101 msg
->have_authattrs
= true;
104 for (sinfo
= sinfo
->next
; sinfo
; sinfo
= sinfo
->next
)
105 if (!!sinfo
->authattrs
!= want
)
110 pr_warn("Inconsistently supplied authAttrs\n");
115 * pkcs7_parse_message - Parse a PKCS#7 message
116 * @data: The raw binary ASN.1 encoded message to be parsed
117 * @datalen: The size of the encoded message
119 struct pkcs7_message
*pkcs7_parse_message(const void *data
, size_t datalen
)
121 struct pkcs7_parse_context
*ctx
;
122 struct pkcs7_message
*msg
= ERR_PTR(-ENOMEM
);
125 ctx
= kzalloc(sizeof(struct pkcs7_parse_context
), GFP_KERNEL
);
128 ctx
->msg
= kzalloc(sizeof(struct pkcs7_message
), GFP_KERNEL
);
131 ctx
->sinfo
= kzalloc(sizeof(struct pkcs7_signed_info
), GFP_KERNEL
);
134 ctx
->sinfo
->sig
= kzalloc(sizeof(struct public_key_signature
),
136 if (!ctx
->sinfo
->sig
)
139 ctx
->data
= (unsigned long)data
;
140 ctx
->ppcerts
= &ctx
->certs
;
141 ctx
->ppsinfo
= &ctx
->msg
->signed_infos
;
143 /* Attempt to decode the signature */
144 ret
= asn1_ber_decoder(&pkcs7_decoder
, ctx
, data
, datalen
);
150 ret
= pkcs7_check_authattrs(ctx
->msg
);
161 struct x509_certificate
*cert
= ctx
->certs
;
162 ctx
->certs
= cert
->next
;
163 x509_free_certificate(cert
);
166 pkcs7_free_signed_info(ctx
->sinfo
);
168 pkcs7_free_message(ctx
->msg
);
174 EXPORT_SYMBOL_GPL(pkcs7_parse_message
);
177 * pkcs7_get_content_data - Get access to the PKCS#7 content
178 * @pkcs7: The preparsed PKCS#7 message to access
179 * @_data: Place to return a pointer to the data
180 * @_data_len: Place to return the data length
181 * @_headerlen: Size of ASN.1 header not included in _data
183 * Get access to the data content of the PKCS#7 message. The size of the
184 * header of the ASN.1 object that contains it is also provided and can be used
185 * to adjust *_data and *_data_len to get the entire object.
187 * Returns -ENODATA if the data object was missing from the message.
189 int pkcs7_get_content_data(const struct pkcs7_message
*pkcs7
,
190 const void **_data
, size_t *_data_len
,
196 *_data
= pkcs7
->data
;
197 *_data_len
= pkcs7
->data_len
;
199 *_headerlen
= pkcs7
->data_hdrlen
;
202 EXPORT_SYMBOL_GPL(pkcs7_get_content_data
);
205 * Note an OID when we find one for later processing when we know how
208 int pkcs7_note_OID(void *context
, size_t hdrlen
,
210 const void *value
, size_t vlen
)
212 struct pkcs7_parse_context
*ctx
= context
;
214 ctx
->last_oid
= look_up_OID(value
, vlen
);
215 if (ctx
->last_oid
== OID__NR
) {
217 sprint_oid(value
, vlen
, buffer
, sizeof(buffer
));
218 printk("PKCS7: Unknown OID: [%lu] %s\n",
219 (unsigned long)value
- ctx
->data
, buffer
);
225 * Note the digest algorithm for the signature.
227 int pkcs7_sig_note_digest_algo(void *context
, size_t hdrlen
,
229 const void *value
, size_t vlen
)
231 struct pkcs7_parse_context
*ctx
= context
;
233 switch (ctx
->last_oid
) {
235 ctx
->sinfo
->sig
->hash_algo
= "md4";
238 ctx
->sinfo
->sig
->hash_algo
= "md5";
241 ctx
->sinfo
->sig
->hash_algo
= "sha1";
244 ctx
->sinfo
->sig
->hash_algo
= "sha256";
247 ctx
->sinfo
->sig
->hash_algo
= "sha384";
250 ctx
->sinfo
->sig
->hash_algo
= "sha512";
253 ctx
->sinfo
->sig
->hash_algo
= "sha224";
256 printk("Unsupported digest algo: %u\n", ctx
->last_oid
);
263 * Note the public key algorithm for the signature.
265 int pkcs7_sig_note_pkey_algo(void *context
, size_t hdrlen
,
267 const void *value
, size_t vlen
)
269 struct pkcs7_parse_context
*ctx
= context
;
271 switch (ctx
->last_oid
) {
272 case OID_rsaEncryption
:
273 ctx
->sinfo
->sig
->pkey_algo
= "rsa";
274 ctx
->sinfo
->sig
->encoding
= "pkcs1";
277 printk("Unsupported pkey algo: %u\n", ctx
->last_oid
);
284 * We only support signed data [RFC2315 sec 9].
286 int pkcs7_check_content_type(void *context
, size_t hdrlen
,
288 const void *value
, size_t vlen
)
290 struct pkcs7_parse_context
*ctx
= context
;
292 if (ctx
->last_oid
!= OID_signed_data
) {
293 pr_warn("Only support pkcs7_signedData type\n");
301 * Note the SignedData version
303 int pkcs7_note_signeddata_version(void *context
, size_t hdrlen
,
305 const void *value
, size_t vlen
)
307 struct pkcs7_parse_context
*ctx
= context
;
313 ctx
->msg
->version
= version
= *(const u8
*)value
;
316 /* PKCS#7 SignedData [RFC2315 sec 9.1]
317 * CMS ver 1 SignedData [RFC5652 sec 5.1]
321 /* CMS ver 3 SignedData [RFC2315 sec 5.1] */
330 pr_warn("Unsupported SignedData version\n");
335 * Note the SignerInfo version
337 int pkcs7_note_signerinfo_version(void *context
, size_t hdrlen
,
339 const void *value
, size_t vlen
)
341 struct pkcs7_parse_context
*ctx
= context
;
347 version
= *(const u8
*)value
;
350 /* PKCS#7 SignerInfo [RFC2315 sec 9.2]
351 * CMS ver 1 SignerInfo [RFC5652 sec 5.3]
353 if (ctx
->msg
->version
!= 1)
354 goto version_mismatch
;
355 ctx
->expect_skid
= false;
358 /* CMS ver 3 SignerInfo [RFC2315 sec 5.3] */
359 if (ctx
->msg
->version
== 1)
360 goto version_mismatch
;
361 ctx
->expect_skid
= true;
370 pr_warn("Unsupported SignerInfo version\n");
373 pr_warn("SignedData-SignerInfo version mismatch\n");
378 * Extract a certificate and store it in the context.
380 int pkcs7_extract_cert(void *context
, size_t hdrlen
,
382 const void *value
, size_t vlen
)
384 struct pkcs7_parse_context
*ctx
= context
;
385 struct x509_certificate
*x509
;
387 if (tag
!= ((ASN1_UNIV
<< 6) | ASN1_CONS_BIT
| ASN1_SEQ
)) {
388 pr_debug("Cert began with tag %02x at %lu\n",
389 tag
, (unsigned long)ctx
- ctx
->data
);
393 /* We have to correct for the header so that the X.509 parser can start
394 * from the beginning. Note that since X.509 stipulates DER, there
395 * probably shouldn't be an EOC trailer - but it is in PKCS#7 (which
401 if (((u8
*)value
)[1] == 0x80)
402 vlen
+= 2; /* Indefinite length - there should be an EOC */
404 x509
= x509_cert_parse(value
, vlen
);
406 return PTR_ERR(x509
);
408 x509
->index
= ++ctx
->x509_index
;
409 pr_debug("Got cert %u for %s\n", x509
->index
, x509
->subject
);
410 pr_debug("- fingerprint %*phN\n", x509
->id
->len
, x509
->id
->data
);
412 *ctx
->ppcerts
= x509
;
413 ctx
->ppcerts
= &x509
->next
;
418 * Save the certificate list
420 int pkcs7_note_certificate_list(void *context
, size_t hdrlen
,
422 const void *value
, size_t vlen
)
424 struct pkcs7_parse_context
*ctx
= context
;
426 pr_devel("Got cert list (%02x)\n", tag
);
428 *ctx
->ppcerts
= ctx
->msg
->certs
;
429 ctx
->msg
->certs
= ctx
->certs
;
431 ctx
->ppcerts
= &ctx
->certs
;
436 * Note the content type.
438 int pkcs7_note_content(void *context
, size_t hdrlen
,
440 const void *value
, size_t vlen
)
442 struct pkcs7_parse_context
*ctx
= context
;
444 if (ctx
->last_oid
!= OID_data
&&
445 ctx
->last_oid
!= OID_msIndirectData
) {
446 pr_warn("Unsupported data type %d\n", ctx
->last_oid
);
450 ctx
->msg
->data_type
= ctx
->last_oid
;
455 * Extract the data from the message and store that and its content type OID in
458 int pkcs7_note_data(void *context
, size_t hdrlen
,
460 const void *value
, size_t vlen
)
462 struct pkcs7_parse_context
*ctx
= context
;
464 pr_debug("Got data\n");
466 ctx
->msg
->data
= value
;
467 ctx
->msg
->data_len
= vlen
;
468 ctx
->msg
->data_hdrlen
= hdrlen
;
473 * Parse authenticated attributes.
475 int pkcs7_sig_note_authenticated_attr(void *context
, size_t hdrlen
,
477 const void *value
, size_t vlen
)
479 struct pkcs7_parse_context
*ctx
= context
;
480 struct pkcs7_signed_info
*sinfo
= ctx
->sinfo
;
481 enum OID content_type
;
483 pr_devel("AuthAttr: %02x %zu [%*ph]\n", tag
, vlen
, (unsigned)vlen
, value
);
485 switch (ctx
->last_oid
) {
486 case OID_contentType
:
487 if (__test_and_set_bit(sinfo_has_content_type
, &sinfo
->aa_set
))
489 content_type
= look_up_OID(value
, vlen
);
490 if (content_type
!= ctx
->msg
->data_type
) {
491 pr_warn("Mismatch between global data type (%d) and sinfo %u (%d)\n",
492 ctx
->msg
->data_type
, sinfo
->index
,
498 case OID_signingTime
:
499 if (__test_and_set_bit(sinfo_has_signing_time
, &sinfo
->aa_set
))
501 /* Should we check that the signing time is consistent
502 * with the signer's X.509 cert?
504 return x509_decode_time(&sinfo
->signing_time
,
505 hdrlen
, tag
, value
, vlen
);
507 case OID_messageDigest
:
508 if (__test_and_set_bit(sinfo_has_message_digest
, &sinfo
->aa_set
))
512 sinfo
->msgdigest
= value
;
513 sinfo
->msgdigest_len
= vlen
;
516 case OID_smimeCapabilites
:
517 if (__test_and_set_bit(sinfo_has_smime_caps
, &sinfo
->aa_set
))
519 if (ctx
->msg
->data_type
!= OID_msIndirectData
) {
520 pr_warn("S/MIME Caps only allowed with Authenticode\n");
521 return -EKEYREJECTED
;
525 /* Microsoft SpOpusInfo seems to be contain cont[0] 16-bit BE
526 * char URLs and cont[1] 8-bit char URLs.
528 * Microsoft StatementType seems to contain a list of OIDs that
529 * are also used as extendedKeyUsage types in X.509 certs.
531 case OID_msSpOpusInfo
:
532 if (__test_and_set_bit(sinfo_has_ms_opus_info
, &sinfo
->aa_set
))
534 goto authenticode_check
;
535 case OID_msStatementType
:
536 if (__test_and_set_bit(sinfo_has_ms_statement_type
, &sinfo
->aa_set
))
539 if (ctx
->msg
->data_type
!= OID_msIndirectData
) {
540 pr_warn("Authenticode AuthAttrs only allowed with Authenticode\n");
541 return -EKEYREJECTED
;
543 /* I'm not sure how to validate these */
550 /* We permit max one item per AuthenticatedAttribute and no repeats */
551 pr_warn("Repeated/multivalue AuthAttrs not permitted\n");
552 return -EKEYREJECTED
;
556 * Note the set of auth attributes for digestion purposes [RFC2315 sec 9.3]
558 int pkcs7_sig_note_set_of_authattrs(void *context
, size_t hdrlen
,
560 const void *value
, size_t vlen
)
562 struct pkcs7_parse_context
*ctx
= context
;
563 struct pkcs7_signed_info
*sinfo
= ctx
->sinfo
;
565 if (!test_bit(sinfo_has_content_type
, &sinfo
->aa_set
) ||
566 !test_bit(sinfo_has_message_digest
, &sinfo
->aa_set
)) {
567 pr_warn("Missing required AuthAttr\n");
571 if (ctx
->msg
->data_type
!= OID_msIndirectData
&&
572 test_bit(sinfo_has_ms_opus_info
, &sinfo
->aa_set
)) {
573 pr_warn("Unexpected Authenticode AuthAttr\n");
577 /* We need to switch the 'CONT 0' to a 'SET OF' when we digest */
578 sinfo
->authattrs
= value
- (hdrlen
- 1);
579 sinfo
->authattrs_len
= vlen
+ (hdrlen
- 1);
584 * Note the issuing certificate serial number
586 int pkcs7_sig_note_serial(void *context
, size_t hdrlen
,
588 const void *value
, size_t vlen
)
590 struct pkcs7_parse_context
*ctx
= context
;
591 ctx
->raw_serial
= value
;
592 ctx
->raw_serial_size
= vlen
;
597 * Note the issuer's name
599 int pkcs7_sig_note_issuer(void *context
, size_t hdrlen
,
601 const void *value
, size_t vlen
)
603 struct pkcs7_parse_context
*ctx
= context
;
604 ctx
->raw_issuer
= value
;
605 ctx
->raw_issuer_size
= vlen
;
610 * Note the issuing cert's subjectKeyIdentifier
612 int pkcs7_sig_note_skid(void *context
, size_t hdrlen
,
614 const void *value
, size_t vlen
)
616 struct pkcs7_parse_context
*ctx
= context
;
618 pr_devel("SKID: %02x %zu [%*ph]\n", tag
, vlen
, (unsigned)vlen
, value
);
620 ctx
->raw_skid
= value
;
621 ctx
->raw_skid_size
= vlen
;
626 * Note the signature data
628 int pkcs7_sig_note_signature(void *context
, size_t hdrlen
,
630 const void *value
, size_t vlen
)
632 struct pkcs7_parse_context
*ctx
= context
;
634 ctx
->sinfo
->sig
->s
= kmemdup(value
, vlen
, GFP_KERNEL
);
635 if (!ctx
->sinfo
->sig
->s
)
638 ctx
->sinfo
->sig
->s_size
= vlen
;
643 * Note a signature information block
645 int pkcs7_note_signed_info(void *context
, size_t hdrlen
,
647 const void *value
, size_t vlen
)
649 struct pkcs7_parse_context
*ctx
= context
;
650 struct pkcs7_signed_info
*sinfo
= ctx
->sinfo
;
651 struct asymmetric_key_id
*kid
;
653 if (ctx
->msg
->data_type
== OID_msIndirectData
&& !sinfo
->authattrs
) {
654 pr_warn("Authenticode requires AuthAttrs\n");
658 /* Generate cert issuer + serial number key ID */
659 if (!ctx
->expect_skid
) {
660 kid
= asymmetric_key_generate_id(ctx
->raw_serial
,
661 ctx
->raw_serial_size
,
663 ctx
->raw_issuer_size
);
665 kid
= asymmetric_key_generate_id(ctx
->raw_skid
,
672 pr_devel("SINFO KID: %u [%*phN]\n", kid
->len
, kid
->len
, kid
->data
);
674 sinfo
->sig
->auth_ids
[0] = kid
;
675 sinfo
->index
= ++ctx
->sinfo_index
;
676 *ctx
->ppsinfo
= sinfo
;
677 ctx
->ppsinfo
= &sinfo
->next
;
678 ctx
->sinfo
= kzalloc(sizeof(struct pkcs7_signed_info
), GFP_KERNEL
);
681 ctx
->sinfo
->sig
= kzalloc(sizeof(struct public_key_signature
),
683 if (!ctx
->sinfo
->sig
)