1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* X.509 certificate parser
4 * Copyright (C) 2012 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
8 #define pr_fmt(fmt) "X.509: "fmt
9 #include <linux/kernel.h>
10 #include <linux/export.h>
11 #include <linux/slab.h>
12 #include <linux/err.h>
13 #include <linux/oid_registry.h>
14 #include <crypto/public_key.h>
15 #include "x509_parser.h"
16 #include "x509.asn1.h"
17 #include "x509_akid.asn1.h"
19 struct x509_parse_context
{
20 struct x509_certificate
*cert
; /* Certificate being constructed */
21 unsigned long data
; /* Start of data */
22 const void *cert_start
; /* Start of cert content */
23 const void *key
; /* Key data */
24 size_t key_size
; /* Size of key data */
25 const void *params
; /* Key parameters */
26 size_t params_size
; /* Size of key parameters */
27 enum OID key_algo
; /* Public key algorithm */
28 enum OID last_oid
; /* Last OID encountered */
29 enum OID algo_oid
; /* Algorithm OID */
30 unsigned char nr_mpi
; /* Number of MPIs stored */
31 u8 o_size
; /* Size of organizationName (O) */
32 u8 cn_size
; /* Size of commonName (CN) */
33 u8 email_size
; /* Size of emailAddress */
34 u16 o_offset
; /* Offset of organizationName (O) */
35 u16 cn_offset
; /* Offset of commonName (CN) */
36 u16 email_offset
; /* Offset of emailAddress */
37 unsigned raw_akid_size
;
38 const void *raw_akid
; /* Raw authorityKeyId in ASN.1 */
39 const void *akid_raw_issuer
; /* Raw directoryName in authorityKeyId */
40 unsigned akid_raw_issuer_size
;
44 * Free an X.509 certificate
46 void x509_free_certificate(struct x509_certificate
*cert
)
49 public_key_free(cert
->pub
);
50 public_key_signature_free(cert
->sig
);
58 EXPORT_SYMBOL_GPL(x509_free_certificate
);
61 * Parse an X.509 certificate
63 struct x509_certificate
*x509_cert_parse(const void *data
, size_t datalen
)
65 struct x509_certificate
*cert
;
66 struct x509_parse_context
*ctx
;
67 struct asymmetric_key_id
*kid
;
71 cert
= kzalloc(sizeof(struct x509_certificate
), GFP_KERNEL
);
74 cert
->pub
= kzalloc(sizeof(struct public_key
), GFP_KERNEL
);
77 cert
->sig
= kzalloc(sizeof(struct public_key_signature
), GFP_KERNEL
);
80 ctx
= kzalloc(sizeof(struct x509_parse_context
), GFP_KERNEL
);
85 ctx
->data
= (unsigned long)data
;
87 /* Attempt to decode the certificate */
88 ret
= asn1_ber_decoder(&x509_decoder
, ctx
, data
, datalen
);
92 /* Decode the AuthorityKeyIdentifier */
94 pr_devel("AKID: %u %*phN\n",
95 ctx
->raw_akid_size
, ctx
->raw_akid_size
, ctx
->raw_akid
);
96 ret
= asn1_ber_decoder(&x509_akid_decoder
, ctx
,
97 ctx
->raw_akid
, ctx
->raw_akid_size
);
99 pr_warn("Couldn't decode AuthKeyIdentifier\n");
105 cert
->pub
->key
= kmemdup(ctx
->key
, ctx
->key_size
, GFP_KERNEL
);
109 cert
->pub
->keylen
= ctx
->key_size
;
111 cert
->pub
->params
= kmemdup(ctx
->params
, ctx
->params_size
, GFP_KERNEL
);
112 if (!cert
->pub
->params
)
115 cert
->pub
->paramlen
= ctx
->params_size
;
116 cert
->pub
->algo
= ctx
->key_algo
;
118 /* Grab the signature bits */
119 ret
= x509_get_sig_params(cert
);
123 /* Generate cert issuer + serial number key ID */
124 kid
= asymmetric_key_generate_id(cert
->raw_serial
,
125 cert
->raw_serial_size
,
127 cert
->raw_issuer_size
);
134 /* Detect self-signed certificates */
135 ret
= x509_check_for_self_signed(cert
);
145 x509_free_certificate(cert
);
149 EXPORT_SYMBOL_GPL(x509_cert_parse
);
152 * Note an OID when we find one for later processing when we know how
155 int x509_note_OID(void *context
, size_t hdrlen
,
157 const void *value
, size_t vlen
)
159 struct x509_parse_context
*ctx
= context
;
161 ctx
->last_oid
= look_up_OID(value
, vlen
);
162 if (ctx
->last_oid
== OID__NR
) {
164 sprint_oid(value
, vlen
, buffer
, sizeof(buffer
));
165 pr_debug("Unknown OID: [%lu] %s\n",
166 (unsigned long)value
- ctx
->data
, buffer
);
172 * Save the position of the TBS data so that we can check the signature over it
175 int x509_note_tbs_certificate(void *context
, size_t hdrlen
,
177 const void *value
, size_t vlen
)
179 struct x509_parse_context
*ctx
= context
;
181 pr_debug("x509_note_tbs_certificate(,%zu,%02x,%ld,%zu)!\n",
182 hdrlen
, tag
, (unsigned long)value
- ctx
->data
, vlen
);
184 ctx
->cert
->tbs
= value
- hdrlen
;
185 ctx
->cert
->tbs_size
= vlen
+ hdrlen
;
190 * Record the public key algorithm
192 int x509_note_pkey_algo(void *context
, size_t hdrlen
,
194 const void *value
, size_t vlen
)
196 struct x509_parse_context
*ctx
= context
;
198 pr_debug("PubKey Algo: %u\n", ctx
->last_oid
);
200 switch (ctx
->last_oid
) {
201 case OID_md2WithRSAEncryption
:
202 case OID_md3WithRSAEncryption
:
204 return -ENOPKG
; /* Unsupported combination */
206 case OID_md4WithRSAEncryption
:
207 ctx
->cert
->sig
->hash_algo
= "md4";
210 case OID_sha1WithRSAEncryption
:
211 ctx
->cert
->sig
->hash_algo
= "sha1";
214 case OID_sha256WithRSAEncryption
:
215 ctx
->cert
->sig
->hash_algo
= "sha256";
218 case OID_sha384WithRSAEncryption
:
219 ctx
->cert
->sig
->hash_algo
= "sha384";
222 case OID_sha512WithRSAEncryption
:
223 ctx
->cert
->sig
->hash_algo
= "sha512";
226 case OID_sha224WithRSAEncryption
:
227 ctx
->cert
->sig
->hash_algo
= "sha224";
230 case OID_gost2012Signature256
:
231 ctx
->cert
->sig
->hash_algo
= "streebog256";
234 case OID_gost2012Signature512
:
235 ctx
->cert
->sig
->hash_algo
= "streebog512";
240 ctx
->cert
->sig
->pkey_algo
= "rsa";
241 ctx
->cert
->sig
->encoding
= "pkcs1";
242 ctx
->algo_oid
= ctx
->last_oid
;
245 ctx
->cert
->sig
->pkey_algo
= "ecrdsa";
246 ctx
->cert
->sig
->encoding
= "raw";
247 ctx
->algo_oid
= ctx
->last_oid
;
252 * Note the whereabouts and type of the signature.
254 int x509_note_signature(void *context
, size_t hdrlen
,
256 const void *value
, size_t vlen
)
258 struct x509_parse_context
*ctx
= context
;
260 pr_debug("Signature type: %u size %zu\n", ctx
->last_oid
, vlen
);
262 if (ctx
->last_oid
!= ctx
->algo_oid
) {
263 pr_warn("Got cert with pkey (%u) and sig (%u) algorithm OIDs\n",
264 ctx
->algo_oid
, ctx
->last_oid
);
268 if (strcmp(ctx
->cert
->sig
->pkey_algo
, "rsa") == 0 ||
269 strcmp(ctx
->cert
->sig
->pkey_algo
, "ecrdsa") == 0) {
270 /* Discard the BIT STRING metadata */
271 if (vlen
< 1 || *(const u8
*)value
!= 0)
278 ctx
->cert
->raw_sig
= value
;
279 ctx
->cert
->raw_sig_size
= vlen
;
284 * Note the certificate serial number
286 int x509_note_serial(void *context
, size_t hdrlen
,
288 const void *value
, size_t vlen
)
290 struct x509_parse_context
*ctx
= context
;
291 ctx
->cert
->raw_serial
= value
;
292 ctx
->cert
->raw_serial_size
= vlen
;
297 * Note some of the name segments from which we'll fabricate a name.
299 int x509_extract_name_segment(void *context
, size_t hdrlen
,
301 const void *value
, size_t vlen
)
303 struct x509_parse_context
*ctx
= context
;
305 switch (ctx
->last_oid
) {
308 ctx
->cn_offset
= (unsigned long)value
- ctx
->data
;
310 case OID_organizationName
:
312 ctx
->o_offset
= (unsigned long)value
- ctx
->data
;
314 case OID_email_address
:
315 ctx
->email_size
= vlen
;
316 ctx
->email_offset
= (unsigned long)value
- ctx
->data
;
326 * Fabricate and save the issuer and subject names
328 static int x509_fabricate_name(struct x509_parse_context
*ctx
, size_t hdrlen
,
330 char **_name
, size_t vlen
)
332 const void *name
, *data
= (const void *)ctx
->data
;
339 /* Empty name string if no material */
340 if (!ctx
->cn_size
&& !ctx
->o_size
&& !ctx
->email_size
) {
341 buffer
= kmalloc(1, GFP_KERNEL
);
348 if (ctx
->cn_size
&& ctx
->o_size
) {
349 /* Consider combining O and CN, but use only the CN if it is
350 * prefixed by the O, or a significant portion thereof.
352 namesize
= ctx
->cn_size
;
353 name
= data
+ ctx
->cn_offset
;
354 if (ctx
->cn_size
>= ctx
->o_size
&&
355 memcmp(data
+ ctx
->cn_offset
, data
+ ctx
->o_offset
,
357 goto single_component
;
358 if (ctx
->cn_size
>= 7 &&
360 memcmp(data
+ ctx
->cn_offset
, data
+ ctx
->o_offset
, 7) == 0)
361 goto single_component
;
363 buffer
= kmalloc(ctx
->o_size
+ 2 + ctx
->cn_size
+ 1,
369 data
+ ctx
->o_offset
, ctx
->o_size
);
370 buffer
[ctx
->o_size
+ 0] = ':';
371 buffer
[ctx
->o_size
+ 1] = ' ';
372 memcpy(buffer
+ ctx
->o_size
+ 2,
373 data
+ ctx
->cn_offset
, ctx
->cn_size
);
374 buffer
[ctx
->o_size
+ 2 + ctx
->cn_size
] = 0;
377 } else if (ctx
->cn_size
) {
378 namesize
= ctx
->cn_size
;
379 name
= data
+ ctx
->cn_offset
;
380 } else if (ctx
->o_size
) {
381 namesize
= ctx
->o_size
;
382 name
= data
+ ctx
->o_offset
;
384 namesize
= ctx
->email_size
;
385 name
= data
+ ctx
->email_offset
;
389 buffer
= kmalloc(namesize
+ 1, GFP_KERNEL
);
392 memcpy(buffer
, name
, namesize
);
393 buffer
[namesize
] = 0;
403 int x509_note_issuer(void *context
, size_t hdrlen
,
405 const void *value
, size_t vlen
)
407 struct x509_parse_context
*ctx
= context
;
408 ctx
->cert
->raw_issuer
= value
;
409 ctx
->cert
->raw_issuer_size
= vlen
;
410 return x509_fabricate_name(ctx
, hdrlen
, tag
, &ctx
->cert
->issuer
, vlen
);
413 int x509_note_subject(void *context
, size_t hdrlen
,
415 const void *value
, size_t vlen
)
417 struct x509_parse_context
*ctx
= context
;
418 ctx
->cert
->raw_subject
= value
;
419 ctx
->cert
->raw_subject_size
= vlen
;
420 return x509_fabricate_name(ctx
, hdrlen
, tag
, &ctx
->cert
->subject
, vlen
);
424 * Extract the parameters for the public key
426 int x509_note_params(void *context
, size_t hdrlen
,
428 const void *value
, size_t vlen
)
430 struct x509_parse_context
*ctx
= context
;
433 * AlgorithmIdentifier is used three times in the x509, we should skip
434 * first and ignore third, using second one which is after subject and
435 * before subjectPublicKey.
437 if (!ctx
->cert
->raw_subject
|| ctx
->key
)
439 ctx
->params
= value
- hdrlen
;
440 ctx
->params_size
= vlen
+ hdrlen
;
445 * Extract the data for the public key algorithm
447 int x509_extract_key_data(void *context
, size_t hdrlen
,
449 const void *value
, size_t vlen
)
451 struct x509_parse_context
*ctx
= context
;
453 ctx
->key_algo
= ctx
->last_oid
;
454 if (ctx
->last_oid
== OID_rsaEncryption
)
455 ctx
->cert
->pub
->pkey_algo
= "rsa";
456 else if (ctx
->last_oid
== OID_gost2012PKey256
||
457 ctx
->last_oid
== OID_gost2012PKey512
)
458 ctx
->cert
->pub
->pkey_algo
= "ecrdsa";
462 /* Discard the BIT STRING metadata */
463 if (vlen
< 1 || *(const u8
*)value
!= 0)
465 ctx
->key
= value
+ 1;
466 ctx
->key_size
= vlen
- 1;
470 /* The keyIdentifier in AuthorityKeyIdentifier SEQUENCE is tag(CONT,PRIM,0) */
471 #define SEQ_TAG_KEYID (ASN1_CONT << 6)
474 * Process certificate extensions that are used to qualify the certificate.
476 int x509_process_extension(void *context
, size_t hdrlen
,
478 const void *value
, size_t vlen
)
480 struct x509_parse_context
*ctx
= context
;
481 struct asymmetric_key_id
*kid
;
482 const unsigned char *v
= value
;
484 pr_debug("Extension: %u\n", ctx
->last_oid
);
486 if (ctx
->last_oid
== OID_subjectKeyIdentifier
) {
487 /* Get hold of the key fingerprint */
488 if (ctx
->cert
->skid
|| vlen
< 3)
490 if (v
[0] != ASN1_OTS
|| v
[1] != vlen
- 2)
495 ctx
->cert
->raw_skid_size
= vlen
;
496 ctx
->cert
->raw_skid
= v
;
497 kid
= asymmetric_key_generate_id(v
, vlen
, "", 0);
500 ctx
->cert
->skid
= kid
;
501 pr_debug("subjkeyid %*phN\n", kid
->len
, kid
->data
);
505 if (ctx
->last_oid
== OID_authorityKeyIdentifier
) {
506 /* Get hold of the CA key fingerprint */
508 ctx
->raw_akid_size
= vlen
;
516 * x509_decode_time - Decode an X.509 time ASN.1 object
517 * @_t: The time to fill in
518 * @hdrlen: The length of the object header
519 * @tag: The object tag
520 * @value: The object value
521 * @vlen: The size of the object value
523 * Decode an ASN.1 universal time or generalised time field into a struct the
524 * kernel can handle and check it for validity. The time is decoded thus:
526 * [RFC5280 ยง4.1.2.5]
527 * CAs conforming to this profile MUST always encode certificate validity
528 * dates through the year 2049 as UTCTime; certificate validity dates in
529 * 2050 or later MUST be encoded as GeneralizedTime. Conforming
530 * applications MUST be able to process validity dates that are encoded in
531 * either UTCTime or GeneralizedTime.
533 int x509_decode_time(time64_t
*_t
, size_t hdrlen
,
535 const unsigned char *value
, size_t vlen
)
537 static const unsigned char month_lengths
[] = { 31, 28, 31, 30, 31, 30,
538 31, 31, 30, 31, 30, 31 };
539 const unsigned char *p
= value
;
540 unsigned year
, mon
, day
, hour
, min
, sec
, mon_len
;
542 #define dec2bin(X) ({ unsigned char x = (X) - '0'; if (x > 9) goto invalid_time; x; })
543 #define DD2bin(P) ({ unsigned x = dec2bin(P[0]) * 10 + dec2bin(P[1]); P += 2; x; })
545 if (tag
== ASN1_UNITIM
) {
546 /* UTCTime: YYMMDDHHMMSSZ */
548 goto unsupported_time
;
554 } else if (tag
== ASN1_GENTIM
) {
555 /* GenTime: YYYYMMDDHHMMSSZ */
557 goto unsupported_time
;
558 year
= DD2bin(p
) * 100 + DD2bin(p
);
559 if (year
>= 1950 && year
<= 2049)
562 goto unsupported_time
;
572 goto unsupported_time
;
578 mon_len
= month_lengths
[mon
- 1];
582 if (year
% 100 == 0) {
590 if (day
< 1 || day
> mon_len
||
591 hour
> 24 || /* ISO 8601 permits 24:00:00 as midnight tomorrow */
593 sec
> 60) /* ISO 8601 permits leap seconds [X.680 46.3] */
596 *_t
= mktime64(year
, mon
, day
, hour
, min
, sec
);
600 pr_debug("Got unsupported time [tag %02x]: '%*phN'\n",
601 tag
, (int)vlen
, value
);
604 pr_debug("Got invalid time [tag %02x]: '%*phN'\n",
605 tag
, (int)vlen
, value
);
608 EXPORT_SYMBOL_GPL(x509_decode_time
);
610 int x509_note_not_before(void *context
, size_t hdrlen
,
612 const void *value
, size_t vlen
)
614 struct x509_parse_context
*ctx
= context
;
615 return x509_decode_time(&ctx
->cert
->valid_from
, hdrlen
, tag
, value
, vlen
);
618 int x509_note_not_after(void *context
, size_t hdrlen
,
620 const void *value
, size_t vlen
)
622 struct x509_parse_context
*ctx
= context
;
623 return x509_decode_time(&ctx
->cert
->valid_to
, hdrlen
, tag
, value
, vlen
);
627 * Note a key identifier-based AuthorityKeyIdentifier
629 int x509_akid_note_kid(void *context
, size_t hdrlen
,
631 const void *value
, size_t vlen
)
633 struct x509_parse_context
*ctx
= context
;
634 struct asymmetric_key_id
*kid
;
636 pr_debug("AKID: keyid: %*phN\n", (int)vlen
, value
);
638 if (ctx
->cert
->sig
->auth_ids
[1])
641 kid
= asymmetric_key_generate_id(value
, vlen
, "", 0);
644 pr_debug("authkeyid %*phN\n", kid
->len
, kid
->data
);
645 ctx
->cert
->sig
->auth_ids
[1] = kid
;
650 * Note a directoryName in an AuthorityKeyIdentifier
652 int x509_akid_note_name(void *context
, size_t hdrlen
,
654 const void *value
, size_t vlen
)
656 struct x509_parse_context
*ctx
= context
;
658 pr_debug("AKID: name: %*phN\n", (int)vlen
, value
);
660 ctx
->akid_raw_issuer
= value
;
661 ctx
->akid_raw_issuer_size
= vlen
;
666 * Note a serial number in an AuthorityKeyIdentifier
668 int x509_akid_note_serial(void *context
, size_t hdrlen
,
670 const void *value
, size_t vlen
)
672 struct x509_parse_context
*ctx
= context
;
673 struct asymmetric_key_id
*kid
;
675 pr_debug("AKID: serial: %*phN\n", (int)vlen
, value
);
677 if (!ctx
->akid_raw_issuer
|| ctx
->cert
->sig
->auth_ids
[0])
680 kid
= asymmetric_key_generate_id(value
,
682 ctx
->akid_raw_issuer
,
683 ctx
->akid_raw_issuer_size
);
687 pr_debug("authkeyid %*phN\n", kid
->len
, kid
->data
);
688 ctx
->cert
->sig
->auth_ids
[0] = kid
;