1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright 2018 Linaro Limited
4 * Author: AKASHI Takahiro
14 #include <linux/types.h>
17 #include <sys/types.h>
18 #include <uuid/uuid.h>
19 #include <linux/kconfig.h>
21 #include <gnutls/gnutls.h>
22 #include <gnutls/pkcs7.h>
23 #include <gnutls/abstract.h>
25 #include "eficapsule.h"
27 static const char *tool_name = "mkeficapsule";
29 efi_guid_t efi_guid_fm_capsule = EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID;
30 efi_guid_t efi_guid_cert_type_pkcs7 = EFI_CERT_TYPE_PKCS7_GUID;
32 static const char *opts_short = "g:i:I:v:p:c:m:o:dhAR";
35 CAPSULE_NORMAL_BLOB = 0,
40 static struct option options[] = {
41 {"guid", required_argument, NULL, 'g'},
42 {"index", required_argument, NULL, 'i'},
43 {"instance", required_argument, NULL, 'I'},
44 {"private-key", required_argument, NULL, 'p'},
45 {"certificate", required_argument, NULL, 'c'},
46 {"monotonic-count", required_argument, NULL, 'm'},
47 {"dump-sig", no_argument, NULL, 'd'},
48 {"fw-accept", no_argument, NULL, 'A'},
49 {"fw-revert", no_argument, NULL, 'R'},
50 {"capoemflag", required_argument, NULL, 'o'},
51 {"help", no_argument, NULL, 'h'},
55 static void print_usage(void)
57 fprintf(stderr, "Usage: %s [options] <image blob> <output file>\n"
60 "\t-g, --guid <guid string> guid for image blob type\n"
61 "\t-i, --index <index> update image index\n"
62 "\t-I, --instance <instance> update hardware instance\n"
63 "\t-p, --private-key <privkey file> private key file\n"
64 "\t-c, --certificate <cert file> signer's certificate file\n"
65 "\t-m, --monotonic-count <count> monotonic count\n"
66 "\t-d, --dump_sig dump signature (*.p7)\n"
67 "\t-A, --fw-accept firmware accept capsule, requires GUID, no image blob\n"
68 "\t-R, --fw-revert firmware revert capsule, takes no GUID, no image blob\n"
69 "\t-o, --capoemflag Capsule OEM Flag, an integer between 0x0000 and 0xffff\n"
70 "\t-h, --help print a help message\n",
75 * auth_context - authentication context
76 * @key_file: Path to a private key file
77 * @cert_file: Path to a certificate file
78 * @image_data: Pointer to firmware data
79 * @image_size: Size of firmware data
80 * @auth: Authentication header
81 * @sig_data: Signature data
82 * @sig_size: Size of signature data
84 * Data structure used in create_auth_data(). @key_file through
85 * @image_size are input parameters. @auth, @sig_data and @sig_size
86 * are filled in by create_auth_data().
93 struct efi_firmware_image_authentication auth;
101 * read_bin_file - read a firmware binary file
102 * @bin: Path to a firmware binary file
103 * @data: Pointer to pointer of allocated buffer
104 * @bin_size: Size of allocated buffer
106 * Read out a content of binary, @bin, into @data.
107 * A caller should free @data.
113 static int read_bin_file(char *bin, uint8_t **data, off_t *bin_size)
116 struct stat bin_stat;
123 fprintf(stderr, "cannot open %s\n", bin);
126 if (stat(bin, &bin_stat) < 0) {
127 fprintf(stderr, "cannot determine the size of %s\n", bin);
131 if (bin_stat.st_size > SIZE_MAX) {
132 fprintf(stderr, "file size is too large for malloc: %s\n", bin);
136 buf = malloc(bin_stat.st_size);
138 fprintf(stderr, "cannot allocate memory: %zx\n",
139 (size_t)bin_stat.st_size);
144 size = fread(buf, 1, bin_stat.st_size, g);
145 if (size < bin_stat.st_size) {
146 fprintf(stderr, "read failed (%zx)\n", size);
152 *bin_size = bin_stat.st_size;
160 * write_capsule_file - write a capsule file
162 * @data: Pointer to data
163 * @bin_size: Size of data
165 * Write out data, @data, with the size @bin_size.
171 static int write_capsule_file(FILE *f, void *data, size_t size, const char *msg)
175 size_written = fwrite(data, 1, size, f);
176 if (size_written < size) {
177 fprintf(stderr, "%s: write failed (%zx != %zx)\n", msg,
186 * create_auth_data - compose authentication data in capsule
187 * @auth_context: Pointer to authentication context
189 * Fill up an authentication header (.auth) and signature data (.sig_data)
190 * in @auth_context, using library functions from openssl.
191 * All the parameters in @auth_context must be filled in by a caller.
197 static int create_auth_data(struct auth_context *ctx)
202 gnutls_privkey_t pkey;
203 gnutls_x509_crt_t x509;
204 gnutls_pkcs7_t pkcs7;
206 gnutls_datum_t signature;
209 ret = read_bin_file(ctx->cert_file, &cert.data, &file_size);
212 if (file_size > UINT_MAX)
214 cert.size = file_size;
216 ret = read_bin_file(ctx->key_file, &key.data, &file_size);
219 if (file_size > UINT_MAX)
221 key.size = file_size;
225 * gnutls_global_set_time_function(mytime);
226 * gnutls_global_set_log_function(tls_log_func);
227 * gnutls_global_set_log_level(6);
230 ret = gnutls_privkey_init(&pkey);
232 fprintf(stderr, "error in gnutls_privkey_init(): %s\n",
233 gnutls_strerror(ret));
237 ret = gnutls_x509_crt_init(&x509);
239 fprintf(stderr, "error in gnutls_x509_crt_init(): %s\n",
240 gnutls_strerror(ret));
244 /* load a private key */
245 ret = gnutls_privkey_import_x509_raw(pkey, &key, GNUTLS_X509_FMT_PEM,
249 "error in gnutls_privkey_import_x509_raw(): %s\n",
250 gnutls_strerror(ret));
254 /* load x509 certificate */
255 ret = gnutls_x509_crt_import(x509, &cert, GNUTLS_X509_FMT_PEM);
257 fprintf(stderr, "error in gnutls_x509_crt_import(): %s\n",
258 gnutls_strerror(ret));
262 /* generate a PKCS #7 structure */
263 ret = gnutls_pkcs7_init(&pkcs7);
265 fprintf(stderr, "error in gnutls_pkcs7_init(): %s\n",
266 gnutls_strerror(ret));
276 * See EDK2's FmpAuthenticatedHandlerRsa2048Sha256()
278 data.size = ctx->image_size + sizeof(ctx->auth.monotonic_count);
279 data.data = malloc(data.size);
281 fprintf(stderr, "allocating memory (0x%x) failed\n", data.size);
284 memcpy(data.data, ctx->image_data, ctx->image_size);
285 memcpy(data.data + ctx->image_size, &ctx->auth.monotonic_count,
286 sizeof(ctx->auth.monotonic_count));
288 ret = gnutls_pkcs7_sign(pkcs7, x509, pkey, &data, NULL, NULL,
290 /* GNUTLS_PKCS7_EMBED_DATA? */
291 GNUTLS_PKCS7_INCLUDE_CERT |
292 GNUTLS_PKCS7_INCLUDE_TIME);
294 fprintf(stderr, "error in gnutls_pkcs7)sign(): %s\n",
295 gnutls_strerror(ret));
300 ret = gnutls_pkcs7_export2(pkcs7, GNUTLS_X509_FMT_DER, &signature);
302 fprintf(stderr, "error in gnutls_pkcs7_export2: %s\n",
303 gnutls_strerror(ret));
306 ctx->sig_data = signature.data;
307 ctx->sig_size = signature.size;
310 ctx->auth.auth_info.hdr.dwLength = sizeof(ctx->auth.auth_info)
312 ctx->auth.auth_info.hdr.wRevision = WIN_CERT_REVISION_2_0;
313 ctx->auth.auth_info.hdr.wCertificateType = WIN_CERT_TYPE_EFI_GUID;
314 memcpy(&ctx->auth.auth_info.cert_type, &efi_guid_cert_type_pkcs7,
315 sizeof(efi_guid_cert_type_pkcs7));
318 * For better clean-ups,
319 * gnutls_pkcs7_deinit(pkcs7);
320 * gnutls_privkey_deinit(pkey);
321 * gnutls_x509_crt_deinit(x509);
325 * gnutls_free(signature.data);
332 * dump_signature - dump out a signature
333 * @path: Path to a capsule file
334 * @signature: Signature data
335 * @sig_size: Size of signature data
337 * Signature data pointed to by @signature will be saved into
338 * a file whose file name is @path with ".p7" suffix.
344 static int dump_signature(const char *path, uint8_t *signature, size_t sig_size)
351 sig_path = malloc(strlen(path) + 3 + 1);
355 sprintf(sig_path, "%s.p7", path);
356 f = fopen(sig_path, "w");
360 size = fwrite(signature, 1, sig_size, f);
361 if (size == sig_size)
371 * free_sig_data - free out signature data
372 * @ctx: Pointer to authentication context
374 * Free signature data allocated in create_auth_data().
376 static void free_sig_data(struct auth_context *ctx)
379 gnutls_free(ctx->sig_data);
383 * create_fwbin - create an uefi capsule file
384 * @path: Path to a created capsule file
385 * @bin: Path to a firmware binary to encapsulate
386 * @guid: GUID of related FMP driver
387 * @index: Index number in capsule
388 * @instance: Instance number in capsule
389 * @mcount: Monotonic count in authentication information
390 * @private_file: Path to a private key file
391 * @cert_file: Path to a certificate file
392 * @oemflags: Capsule OEM Flags, bits 0-15
394 * This function actually does the job of creating an uefi capsule file.
395 * All the arguments must be supplied.
396 * If either @private_file ror @cert_file is NULL, the capsule file
403 static int create_fwbin(char *path, char *bin, efi_guid_t *guid,
404 unsigned long index, unsigned long instance,
405 uint64_t mcount, char *privkey_file, char *cert_file,
408 struct efi_capsule_header header;
409 struct efi_firmware_management_capsule_header capsule;
410 struct efi_firmware_management_capsule_image_header image;
411 struct auth_context auth_context;
419 fprintf(stderr, "For output: %s\n", path);
420 fprintf(stderr, "\tbin: %s\n\ttype: %pUl\n", bin, guid);
421 fprintf(stderr, "\tindex: %lu\n\tinstance: %lu\n", index, instance);
423 auth_context.sig_size = 0;
429 * read a firmware binary
431 if (read_bin_file(bin, &data, &bin_size))
434 /* first, calculate signature to determine its size */
435 if (privkey_file && cert_file) {
436 auth_context.key_file = privkey_file;
437 auth_context.cert_file = cert_file;
438 auth_context.auth.monotonic_count = mcount;
439 auth_context.image_data = data;
440 auth_context.image_size = bin_size;
442 if (create_auth_data(&auth_context)) {
443 fprintf(stderr, "Signing firmware image failed\n");
448 dump_signature(path, auth_context.sig_data,
449 auth_context.sig_size)) {
450 fprintf(stderr, "Creating signature file failed\n");
456 * write a capsule file
458 f = fopen(path, "w");
460 fprintf(stderr, "cannot open %s\n", path);
465 * capsule file header
467 header.capsule_guid = efi_guid_fm_capsule;
468 header.header_size = sizeof(header);
469 /* TODO: The current implementation ignores flags */
470 header.flags = CAPSULE_FLAGS_PERSIST_ACROSS_RESET;
472 header.flags |= oemflags;
473 header.capsule_image_size = sizeof(header)
474 + sizeof(capsule) + sizeof(uint64_t)
477 if (auth_context.sig_size)
478 header.capsule_image_size += sizeof(auth_context.auth)
479 + auth_context.sig_size;
480 if (write_capsule_file(f, &header, sizeof(header),
485 * firmware capsule header
486 * This capsule has only one firmware capsule image.
488 capsule.version = 0x00000001;
489 capsule.embedded_driver_count = 0;
490 capsule.payload_item_count = 1;
491 if (write_capsule_file(f, &capsule, sizeof(capsule),
492 "Firmware capsule header"))
495 offset = sizeof(capsule) + sizeof(uint64_t);
496 if (write_capsule_file(f, &offset, sizeof(offset),
497 "Offset to capsule image"))
501 * firmware capsule image header
503 image.version = 0x00000003;
504 memcpy(&image.update_image_type_id, guid, sizeof(*guid));
505 image.update_image_index = index;
506 image.reserved[0] = 0;
507 image.reserved[1] = 0;
508 image.reserved[2] = 0;
509 image.update_image_size = bin_size;
510 if (auth_context.sig_size)
511 image.update_image_size += sizeof(auth_context.auth)
512 + auth_context.sig_size;
513 image.update_vendor_code_size = 0; /* none */
514 image.update_hardware_instance = instance;
515 image.image_capsule_support = 0;
516 if (auth_context.sig_size)
517 image.image_capsule_support |= CAPSULE_SUPPORT_AUTHENTICATION;
518 if (write_capsule_file(f, &image, sizeof(image),
519 "Firmware capsule image header"))
525 if (auth_context.sig_size) {
526 if (write_capsule_file(f, &auth_context.auth,
527 sizeof(auth_context.auth),
528 "Authentication header"))
531 if (write_capsule_file(f, auth_context.sig_data,
532 auth_context.sig_size, "Signature"))
539 if (write_capsule_file(f, data, bin_size, "Firmware binary"))
546 free_sig_data(&auth_context);
553 * convert_uuid_to_guid() - convert UUID to GUID
556 * UUID and GUID have the same data structure, but their binary
557 * formats are different due to the endianness. See lib/uuid.c.
558 * Since uuid_parse() can handle only UUID, this function must
559 * be called to get correct data for GUID when parsing a string.
561 * The correct data will be returned in @buf.
563 void convert_uuid_to_guid(unsigned char *buf)
583 static int create_empty_capsule(char *path, efi_guid_t *guid, bool fw_accept)
585 struct efi_capsule_header header = { 0 };
588 efi_guid_t fw_accept_guid = FW_ACCEPT_OS_GUID;
589 efi_guid_t fw_revert_guid = FW_REVERT_OS_GUID;
590 efi_guid_t capsule_guid;
592 f = fopen(path, "w");
594 fprintf(stderr, "cannot open %s\n", path);
598 capsule_guid = fw_accept ? fw_accept_guid : fw_revert_guid;
600 memcpy(&header.capsule_guid, &capsule_guid, sizeof(efi_guid_t));
601 header.header_size = sizeof(header);
604 header.capsule_image_size = fw_accept ?
605 sizeof(header) + sizeof(efi_guid_t) : sizeof(header);
607 if (write_capsule_file(f, &header, sizeof(header),
612 if (write_capsule_file(f, guid, sizeof(*guid),
613 "FW Accept Capsule Payload"))
627 * main - main entry function of mkeficapsule
628 * @argc: Number of arguments
629 * @argv: Array of pointers to arguments
631 * Create an uefi capsule file, optionally signing it.
632 * Parse all the arguments and pass them on to create_fwbin().
638 int main(int argc, char **argv)
641 unsigned char uuid_buf[16];
642 unsigned long index, instance;
644 unsigned long oemflags;
645 char *privkey_file, *cert_file;
655 capsule_type = CAPSULE_NORMAL_BLOB;
658 c = getopt_long(argc, argv, opts_short, options, &idx);
666 "Image type already specified\n");
669 if (uuid_parse(optarg, uuid_buf)) {
670 fprintf(stderr, "Wrong guid format\n");
673 convert_uuid_to_guid(uuid_buf);
674 guid = (efi_guid_t *)uuid_buf;
677 index = strtoul(optarg, NULL, 0);
680 instance = strtoul(optarg, NULL, 0);
685 "Private Key already specified\n");
688 privkey_file = optarg;
693 "Certificate file already specified\n");
699 mcount = strtoul(optarg, NULL, 0);
707 "Select either of Accept or Revert capsule generation\n");
710 capsule_type = CAPSULE_ACCEPT;
715 "Select either of Accept or Revert capsule generation\n");
718 capsule_type = CAPSULE_REVERT;
721 oemflags = strtoul(optarg, NULL, 0);
722 if (oemflags > 0xffff) {
724 "oemflags must be between 0x0 and 0xffff\n");
734 /* check necessary parameters */
735 if ((capsule_type == CAPSULE_NORMAL_BLOB &&
736 ((argc != optind + 2) || !guid ||
737 ((privkey_file && !cert_file) ||
738 (!privkey_file && cert_file)))) ||
739 (capsule_type != CAPSULE_NORMAL_BLOB &&
740 ((argc != optind + 1) ||
741 ((capsule_type == CAPSULE_ACCEPT) && !guid) ||
742 ((capsule_type == CAPSULE_REVERT) && guid)))) {
747 if (capsule_type != CAPSULE_NORMAL_BLOB) {
748 if (create_empty_capsule(argv[argc - 1], guid,
749 capsule_type == CAPSULE_ACCEPT) < 0) {
750 fprintf(stderr, "Creating empty capsule failed\n");
753 } else if (create_fwbin(argv[argc - 1], argv[argc - 2], guid,
754 index, instance, mcount, privkey_file,
755 cert_file, (uint16_t)oemflags) < 0) {
756 fprintf(stderr, "Creating firmware capsule failed\n");