From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 3C945C4332F for ; Fri, 14 Oct 2022 06:17:28 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 949D384E53; Fri, 14 Oct 2022 08:17:25 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.b="CRpCPx42"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 2D3FF84F00; Fri, 14 Oct 2022 08:17:24 +0200 (CEST) Received: from mail-ed1-x52d.google.com (mail-ed1-x52d.google.com [IPv6:2a00:1450:4864:20::52d]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id E414484DF1 for ; Fri, 14 Oct 2022 08:17:20 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=ilias.apalodimas@linaro.org Received: by mail-ed1-x52d.google.com with SMTP id e18so5496680edj.3 for ; Thu, 13 Oct 2022 23:17:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=Sf5/1zIobuS7ex/IUq3glIB4eJUb+RZ1VH9S4RcG5Y8=; b=CRpCPx426c8mtVDRILoHcpx4JaWfU6PW12wtXT0f9P4jz7cP9M6Ku9Xu/2t6jfeW72 3o/aBM62PhOHQAKUXdaUixCPYKiiwyCYSeakBuq8/XiA0qkZKVXY9TgsNn1aVjeZmMFk bdQOhsjlVsdjG2yfnHhep/QWLvnbE3mtTvoDVv/jgumE2bsYLPyBcNdzN4p9uq4/LyQK DcLsH461fsVd4oUoITYNnowfPleO3DXnYg2QHvwoQMGlRIr3Si8+pOMW8r30jb6uYTpw zJySsu7uu7HUj297k32JHFJAFgAtQnzaR3mUzi9WobasTWYgnL5C5ObSwV0enaKXKNyD S/Lg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=Sf5/1zIobuS7ex/IUq3glIB4eJUb+RZ1VH9S4RcG5Y8=; b=QBcaV3l6m7ihaACNrJIpSFUDE/kHFWObX0Net2LcsV8UgFpU10wbHNTStXTx4KxKdF UuQaL+gc9208Pb9NwWzRtkQZSXzod0AL+bXBdq4WKVfibxo3Rf2oNu08oM4eZPJ06KsZ 5h63WZSX52J/1n3+SagSm1N2baVFRS6BJpc93ajOQIJoT5h/0widKE/kMQoJKnd8uM1S DR/bRyNkxCAGWt3VD0XEGIT6OLsfpGcIzIT/WfIMbNrx8iPcr0hfn9nnuDwf5JUYEB4E LgktrKpgdG/ASXX9sOfGxqenm4tzTX11VrSfM4BqofOlo/ddep0jK8DzmCZwgGZplOOU +Udg== X-Gm-Message-State: ACrzQf3RftI36b/BI6iTff1TU11uJBfgPvJOIF+K+fDqOd7YzyAek2IZ pa+vrQVOQLXjd89U4c/HBBkzog== X-Google-Smtp-Source: AMsMyM6P487aluQMh+KPlv5+4OgH/pM+QIAKoeSDEAPuHB6btkHia31sovNuNYhdV1Ysa41Eekizow== X-Received: by 2002:a50:ff09:0:b0:456:fd61:83b3 with SMTP id a9-20020a50ff09000000b00456fd6183b3mr2867374edu.166.1665728240455; Thu, 13 Oct 2022 23:17:20 -0700 (PDT) Received: from hera (ppp046103015185.access.hol.gr. [46.103.15.185]) by smtp.gmail.com with ESMTPSA id jz16-20020a170906bb1000b00787a6adab7csm978064ejb.147.2022.10.13.23.17.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Oct 2022 23:17:20 -0700 (PDT) Date: Fri, 14 Oct 2022 09:17:17 +0300 From: Ilias Apalodimas To: Sughosh Ganu Cc: u-boot@lists.denx.de, Heinrich Schuchardt , Takahiro Akashi , Patrick Delaunay , Patrice Chotard , Simon Glass , Bin Meng , Tom Rini , Etienne Carriere , Michal Simek , Jassi Brar Subject: Re: [PATCH v13 13/15] mkeficapsule: Add support for generating empty capsules Message-ID: References: <20221006090629.436518-1-sughosh.ganu@linaro.org> <20221006090629.436518-14-sughosh.ganu@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20221006090629.436518-14-sughosh.ganu@linaro.org> X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.6 at phobos.denx.de X-Virus-Status: Clean On Thu, Oct 06, 2022 at 02:36:27PM +0530, Sughosh Ganu wrote: > The Dependable Boot specification[1] describes the structure of the > firmware accept and revert capsules. These are empty capsules which > are used for signalling the acceptance or rejection of the updated > firmware by the OS. Add support for generating these empty capsules. > > [1] - https://git.codelinaro.org/linaro/dependable-boot/mbfw/uploads/6f7ddfe3be24e18d4319e108a758d02e/mbfw.pdf > > Signed-off-by: Sughosh Ganu > --- > Changes since V12: None > > doc/mkeficapsule.1 | 29 +++++++++---- > tools/eficapsule.h | 8 ++++ > tools/mkeficapsule.c | 96 ++++++++++++++++++++++++++++++++++++++++---- > 3 files changed, 119 insertions(+), 14 deletions(-) > > diff --git a/doc/mkeficapsule.1 b/doc/mkeficapsule.1 > index 09bdc24295..77ca061efd 100644 > --- a/doc/mkeficapsule.1 > +++ b/doc/mkeficapsule.1 > @@ -8,7 +8,7 @@ mkeficapsule \- Generate EFI capsule file for U-Boot > > .SH SYNOPSIS > .B mkeficapsule > -.RI [ options "] " image-blob " " capsule-file > +.RI [ options ] " " [ image-blob ] " " capsule-file > > .SH "DESCRIPTION" > .B mkeficapsule > @@ -23,8 +23,13 @@ Optionally, a capsule file can be signed with a given private key. > In this case, the update will be authenticated by verifying the signature > before applying. > > +Additionally, an empty capsule file can be generated for acceptance or > +rejection of firmware images by a governing component like an Operating > +System. The empty capsules do not require an image-blob input file. > + > + > .B mkeficapsule > -takes any type of image files, including: > +takes any type of image files when generating non empty capsules, including: > .TP > .I raw image > format is a single binary blob of any type of firmware. > @@ -36,18 +41,16 @@ multiple binary blobs in a single capsule file. > This type of image file can be generated by > .BR mkimage . > > -.PP > -If you want to use other types than above two, you should explicitly > -specify a guid for the FMP driver. > - > .SH "OPTIONS" > + > .TP > .BI "-g\fR,\fB --guid " guid-string > Specify guid for image blob type. The format is: > xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx > > The first three elements are in little endian, while the rest > -is in big endian. > +is in big endian. The option must be specified for all non empty and > +image acceptance capsules > > .TP > .BI "-i\fR,\fB --index " index > @@ -57,6 +60,18 @@ Specify an image index > .BI "-I\fR,\fB --instance " instance > Specify a hardware instance > > +.PP > +For generation of firmware accept empty capsule > +.BR --guid > +is mandatory > +.TP > +.BI "-A\fR,\fB --fw-accept " > +Generate a firmware acceptance empty capsule > + > +.TP > +.BI "-R\fR,\fB --fw-revert " > +Generate a firmware revert empty capsule > + > .TP > .BR -h ", " --help > Print a help message > diff --git a/tools/eficapsule.h b/tools/eficapsule.h > index d63b831443..072a4b5598 100644 > --- a/tools/eficapsule.h > +++ b/tools/eficapsule.h > @@ -41,6 +41,14 @@ typedef struct { > EFI_GUID(0x4aafd29d, 0x68df, 0x49ee, 0x8a, 0xa9, \ > 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7) > > +#define FW_ACCEPT_OS_GUID \ > + EFI_GUID(0x0c996046, 0xbcc0, 0x4d04, 0x85, 0xec, \ > + 0xe1, 0xfc, 0xed, 0xf1, 0xc6, 0xf8) > + > +#define FW_REVERT_OS_GUID \ > + EFI_GUID(0xacd58b4b, 0xc0e8, 0x475f, 0x99, 0xb5, \ > + 0x6b, 0x3f, 0x7e, 0x07, 0xaa, 0xf0) > + > /* flags */ > #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000 > > diff --git a/tools/mkeficapsule.c b/tools/mkeficapsule.c > index 5f74d23b9e..25bfb39e5b 100644 > --- a/tools/mkeficapsule.c > +++ b/tools/mkeficapsule.c > @@ -29,7 +29,13 @@ static const char *tool_name = "mkeficapsule"; > efi_guid_t efi_guid_fm_capsule = EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID; > efi_guid_t efi_guid_cert_type_pkcs7 = EFI_CERT_TYPE_PKCS7_GUID; > > -static const char *opts_short = "g:i:I:v:p:c:m:dh"; > +static const char *opts_short = "g:i:I:v:p:c:m:dhAR"; > + > +enum { > + CAPSULE_NORMAL_BLOB = 0, > + CAPSULE_ACCEPT, > + CAPSULE_REVERT, > +} capsule_type; > > static struct option options[] = { > {"guid", required_argument, NULL, 'g'}, > @@ -39,6 +45,8 @@ static struct option options[] = { > {"certificate", required_argument, NULL, 'c'}, > {"monotonic-count", required_argument, NULL, 'm'}, > {"dump-sig", no_argument, NULL, 'd'}, > + {"fw-accept", no_argument, NULL, 'A'}, > + {"fw-revert", no_argument, NULL, 'R'}, > {"help", no_argument, NULL, 'h'}, > {NULL, 0, NULL, 0}, > }; > @@ -55,6 +63,8 @@ static void print_usage(void) > "\t-c, --certificate signer's certificate file\n" > "\t-m, --monotonic-count monotonic count\n" > "\t-d, --dump_sig dump signature (*.p7)\n" > + "\t-A, --fw-accept firmware accept capsule, requires GUID, no image blob\n" > + "\t-R, --fw-revert firmware revert capsule, takes no GUID, no image blob\n" > "\t-h, --help print a help message\n", > tool_name); > } > @@ -564,6 +574,49 @@ void convert_uuid_to_guid(unsigned char *buf) > buf[7] = c; > } > > +static int create_empty_capsule(char *path, efi_guid_t *guid, bool fw_accept) > +{ > + struct efi_capsule_header header = { 0 }; > + FILE *f = NULL; > + int ret = -1; > + efi_guid_t fw_accept_guid = FW_ACCEPT_OS_GUID; > + efi_guid_t fw_revert_guid = FW_REVERT_OS_GUID; > + efi_guid_t capsule_guid; > + > + f = fopen(path, "w"); > + if (!f) { > + fprintf(stderr, "cannot open %s\n", path); > + goto err; > + } > + > + capsule_guid = fw_accept ? fw_accept_guid : fw_revert_guid; > + > + memcpy(&header.capsule_guid, &capsule_guid, sizeof(efi_guid_t)); > + header.header_size = sizeof(header); > + header.flags = 0; > + > + header.capsule_image_size = fw_accept ? > + sizeof(header) + sizeof(efi_guid_t) : sizeof(header); > + > + if (write_capsule_file(f, &header, sizeof(header), > + "Capsule header")) > + goto err; > + > + if (fw_accept) { > + if (write_capsule_file(f, guid, sizeof(*guid), > + "FW Accept Capsule Payload")) > + goto err; > + } > + > + ret = 0; > + > +err: > + if (f) > + fclose(f); > + > + return ret; > +} > + > /** > * main - main entry function of mkeficapsule > * @argc: Number of arguments > @@ -592,6 +645,7 @@ int main(int argc, char **argv) > privkey_file = NULL; > cert_file = NULL; > dump_sig = 0; > + capsule_type = CAPSULE_NORMAL_BLOB; > for (;;) { > c = getopt_long(argc, argv, opts_short, options, &idx); > if (c == -1) > @@ -639,22 +693,50 @@ int main(int argc, char **argv) > case 'd': > dump_sig = 1; > break; > - case 'h': > + case 'A': > + if (capsule_type) { > + fprintf(stderr, > + "Select either of Accept or Revert capsule generation\n"); > + exit(1); > + } > + capsule_type = CAPSULE_ACCEPT; > + break; > + case 'R': > + if (capsule_type) { > + fprintf(stderr, > + "Select either of Accept or Revert capsule generation\n"); > + exit(1); > + } > + capsule_type = CAPSULE_REVERT; > + break; > + default: > print_usage(); > exit(EXIT_SUCCESS); > } > } > > /* check necessary parameters */ > - if ((argc != optind + 2) || !guid || > - ((privkey_file && !cert_file) || > - (!privkey_file && cert_file))) { > + if ((capsule_type == CAPSULE_NORMAL_BLOB && > + ((argc != optind + 2) || !guid || > + ((privkey_file && !cert_file) || > + (!privkey_file && cert_file)))) || > + (capsule_type != CAPSULE_NORMAL_BLOB && > + ((argc != optind + 1) || > + ((capsule_type == CAPSULE_ACCEPT) && !guid) || > + ((capsule_type == CAPSULE_REVERT) && guid)))) { > print_usage(); > exit(EXIT_FAILURE); > } > > - if (create_fwbin(argv[argc - 1], argv[argc - 2], guid, index, instance, > - mcount, privkey_file, cert_file) < 0) { > + if (capsule_type != CAPSULE_NORMAL_BLOB) { > + if (create_empty_capsule(argv[argc - 1], guid, > + capsule_type == CAPSULE_ACCEPT) < 0) { > + fprintf(stderr, "Creating empty capsule failed\n"); > + exit(EXIT_FAILURE); > + } > + } else if (create_fwbin(argv[argc - 1], argv[argc - 2], guid, > + index, instance, mcount, privkey_file, > + cert_file) < 0) { > fprintf(stderr, "Creating firmware capsule failed\n"); > exit(EXIT_FAILURE); > } > -- > 2.34.1 > Acked-by: Ilias Apalodimas