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 2D2B6C433F5 for ; Thu, 20 Jan 2022 02:13:59 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id BF48483434; Thu, 20 Jan 2022 03:13:56 +0100 (CET) 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="PE+AJ+w3"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id CF9AA8378B; Thu, 20 Jan 2022 03:13:55 +0100 (CET) Received: from mail-pf1-x429.google.com (mail-pf1-x429.google.com [IPv6:2607:f8b0:4864:20::429]) (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 85E7080FAE for ; Thu, 20 Jan 2022 03:13:52 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=takahiro.akashi@linaro.org Received: by mail-pf1-x429.google.com with SMTP id v74so767981pfc.1 for ; Wed, 19 Jan 2022 18:13:52 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:mail-followup-to:references :mime-version:content-disposition:in-reply-to; bh=2r75bgDnInQGhmqN3AaKHHWvRhslmvCwIBVCexoIRDE=; b=PE+AJ+w3coaVPqllq286Vky06UuHb0AeO22JLSn1QtBGiOSclhQARRiABAdBDmD11r O0SRZX+uMjndPG1zyWiSfgWS1VkZPcAuSHn6OnSOKXsHsKPscoXfVPDv7/Qrm3xrWPHE AVuv6iz85ZzhEvWHFNw/TNbgFI4l+y6ssU85xLgkHTil3Wxg/F7S4u13CtsHQ4rMDreg kZiL0qA8uRmwKR9rcJDljk6a7ChmP5fYRFwDAtoyDewdNY8E5hP8nYkXQDExXLx3ejFq d5/OzwyrCdnFTwy64CdZrRDPuEoqlAu+gM38y3lseGyimq0UkBCXUllKxi2ocqA4uAIA OFkA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:date:from:to:cc:subject:message-id :mail-followup-to:references:mime-version:content-disposition :in-reply-to; bh=2r75bgDnInQGhmqN3AaKHHWvRhslmvCwIBVCexoIRDE=; b=DEyt7/Q7ERPeXtKnxJ5HWixIB3Vlk87H9jqGouQhl3e+v0h3n+M7uqa2P91YuET1IY SO71gnTgQm+yoC0OCjzoRhR/ArQWxaFXvDEEyLab68Q+56upKjjTQnDfqe9YWxmAgn3w DrMgrdcfUXfFuGVbFAFVhys8B4vo3mXBRLAhSDvcbJygXftldQ8S/kt+FPHeh+9hJTPI QdFShFeCmyTmL0r8RcfktL6PzZh5jDoV8RYyPJLQhahPfqq/jaM14acAAKWR5WTjcsIf D/trOzbLf1uhXTjR61L/ZlcAQg7F5ahD2GhH6CoJiFGv7gvwjBJB84YwS6xx573xsgQ9 67zw== X-Gm-Message-State: AOAM532XLrszbuGKk7TZnw/ZR4h73p27F/YGWxgkmM6NC7F52Fh30/FS Jo0RBcWWEsUaRegKvUucdHfRug== X-Google-Smtp-Source: ABdhPJy9mSRCltOgzpt3JPAEGum00dPZQqtPBB87ZMfAyZXfbJrE6U5cOcBlp7XZlX+/XJ+9je9Hqg== X-Received: by 2002:a63:90c7:: with SMTP id a190mr318532pge.109.1642644830610; Wed, 19 Jan 2022 18:13:50 -0800 (PST) Received: from laputa ([2400:4050:c3e1:100:35ef:d002:eb6d:1b5]) by smtp.gmail.com with ESMTPSA id z21sm884871pfe.108.2022.01.19.18.13.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 19 Jan 2022 18:13:50 -0800 (PST) Date: Thu, 20 Jan 2022 11:13:44 +0900 From: AKASHI Takahiro To: Sughosh Ganu Cc: u-boot@lists.denx.de, Masami Hiramatsu , Patrick Delaunay , Patrice Chotard , Heinrich Schuchardt , Alexander Graf , Simon Glass , Bin Meng , Ilias Apalodimas , Jose Marinho , Grant Likely , Tom Rini , Etienne Carriere Subject: Re: [RFC PATCH v3 9/9] mkeficapsule: Add support for generating empty capsules Message-ID: <20220120021344.GB42867@laputa> Mail-Followup-To: AKASHI Takahiro , Sughosh Ganu , u-boot@lists.denx.de, Masami Hiramatsu , Patrick Delaunay , Patrice Chotard , Heinrich Schuchardt , Alexander Graf , Simon Glass , Bin Meng , Ilias Apalodimas , Jose Marinho , Grant Likely , Tom Rini , Etienne Carriere References: <20220119185548.16730-1-sughosh.ganu@linaro.org> <20220119185548.16730-10-sughosh.ganu@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20220119185548.16730-10-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.2 at phobos.denx.de X-Virus-Status: Clean Hi Sughosh, >From user's point of view, On Thu, Jan 20, 2022 at 12:25:48AM +0530, Sughosh Ganu wrote: > The Dependable Boot specification describes the structure of the May we have a pointer or reference to it? > 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. > > Signed-off-by: Sughosh Ganu > --- > > Changes since V2: > * New patch for generating empty capsules > > tools/eficapsule.h | 8 ++++ > tools/mkeficapsule.c | 102 ++++++++++++++++++++++++++++++++++++++----- > 2 files changed, 100 insertions(+), 10 deletions(-) > > diff --git a/tools/eficapsule.h b/tools/eficapsule.h > index 8c1560bb06..6001952bdc 100644 > --- a/tools/eficapsule.h > +++ b/tools/eficapsule.h > @@ -50,6 +50,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 161affdd15..643da3849d 100644 > --- a/tools/mkeficapsule.c > +++ b/tools/mkeficapsule.c > @@ -29,6 +29,7 @@ > #include "eficapsule.h" > > static const char *tool_name = "mkeficapsule"; > +static unsigned char empty_capsule; > > efi_guid_t efi_guid_fm_capsule = EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID; > efi_guid_t efi_guid_image_type_uboot_fit = > @@ -38,9 +39,9 @@ efi_guid_t efi_guid_image_type_uboot_raw = > efi_guid_t efi_guid_cert_type_pkcs7 = EFI_CERT_TYPE_PKCS7_GUID; > > #ifdef CONFIG_TOOLS_LIBCRYPTO > -static const char *opts_short = "frg:i:I:v:p:c:m:dh"; > +static const char *opts_short = "frg:i:I:v:p:c:m:dhAR"; > #else > -static const char *opts_short = "frg:i:I:v:h"; > +static const char *opts_short = "frg:i:I:v:hAR"; > #endif > > static struct option options[] = { > @@ -55,15 +56,23 @@ static struct option options[] = { > {"monotonic-count", required_argument, NULL, 'm'}, > {"dump-sig", no_argument, NULL, 'd'}, > #endif > + {"fw-accept", no_argument, NULL, 'A'}, > + {"fw-revert", no_argument, NULL, 'R'}, > {"help", no_argument, NULL, 'h'}, > {NULL, 0, NULL, 0}, > }; > > static void print_usage(void) > { > - fprintf(stderr, "Usage: %s [options] \n" > - "Options:\n" > + if (empty_capsule) { > + fprintf(stderr, "Usage: %s [options] \n", > + tool_name); > + } else { > + fprintf(stderr, "Usage: %s [options] \n", > + tool_name); > + } We should always show both cases regardless of "empty_capsule". Or if you have any restrictions on a combination of options, you'd better describe them more specifically in help message. I'd also like to encourage you to update the man page as well as uefi.rst. > + fprintf(stderr, "Options:\n" > "\t-f, --fit FIT image type\n" > "\t-r, --raw raw image type\n" > "\t-g, --guid guid for image blob type\n" > @@ -75,8 +84,9 @@ static void print_usage(void) > "\t-m, --monotonic-count monotonic count\n" > "\t-d, --dump_sig dump signature (*.p7)\n" > #endif > - "\t-h, --help print a help message\n", > - tool_name); > + "\t-A, --fw-accept firmware accept capsule\n" > + "\t-R, --fw-revert firmware revert capsule\n" > + "\t-h, --help print a help message\n"); > } > > /** > @@ -598,6 +608,59 @@ 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; > + FILE *f; > + int ret; > + efi_guid_t fw_accept_guid = FW_ACCEPT_OS_GUID; > + efi_guid_t fw_revert_guid = FW_REVERT_OS_GUID; > + efi_guid_t payload, capsule_guid; > + > + f = NULL; > + ret = -1; > + > + f = fopen(path, "w"); > + if (!f) { > + printf("cannot open %s\n", path); To stderr as Heinrich has requested. > + goto err; > + } > + > + if (fw_accept) > + capsule_guid = fw_accept_guid; > + else > + capsule_guid = fw_revert_guid; > + > + memcpy(&header.capsule_guid, &capsule_guid, sizeof(efi_guid_t)); > + header.header_size = sizeof(header); > + header.flags = 0; > + > + if (fw_accept) { > + header.capsule_image_size = sizeof(header) + sizeof(efi_guid_t); > + } else { > + header.capsule_image_size = sizeof(header); > + } I wonder why we don't need GUID in revert case (and why need GUID in fw case. Since we want to add A/B update, there seems to be no ambiguity. > + if (write_capsule_file(f, &header, sizeof(header), > + "Capsule header")) > + goto err; > + > + if (fw_accept) { > + memcpy(&payload, guid, sizeof(efi_guid_t)); > + if (write_capsule_file(f, &payload, sizeof(payload), > + "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 > @@ -616,6 +679,7 @@ int main(int argc, char **argv) > unsigned char uuid_buf[16]; > unsigned long index, instance; > uint64_t mcount; > + unsigned char accept_fw_capsule, revert_fw_capsule; > char *privkey_file, *cert_file; > int c, idx; > > @@ -625,6 +689,8 @@ int main(int argc, char **argv) > mcount = 0; > privkey_file = NULL; > cert_file = NULL; > + accept_fw_capsule = 0; > + revert_fw_capsule = 0; > dump_sig = 0; > for (;;) { > c = getopt_long(argc, argv, opts_short, options, &idx); > @@ -691,22 +757,38 @@ int main(int argc, char **argv) > dump_sig = 1; > break; > #endif /* CONFIG_TOOLS_LIBCRYPTO */ > + case 'A': > + accept_fw_capsule = 1; > + break; > + case 'R': > + revert_fw_capsule = 1; > + break; > case 'h': > print_usage(); > exit(EXIT_SUCCESS); > } > } > > + empty_capsule = (accept_fw_capsule || revert_fw_capsule); Please check that two options are exclusive here. > /* check necessary parameters */ > - if ((argc != optind + 2) || !guid || > - ((privkey_file && !cert_file) || > + if ((!empty_capsule && argc != optind + 2) || > + (empty_capsule && argc != optind + 1) || > + (!revert_fw_capsule && !guid) || ((privkey_file && !cert_file) || > (!privkey_file && cert_file))) { > print_usage(); > exit(EXIT_FAILURE); > } > > - if (create_fwbin(argv[argc - 1], argv[argc - 2], guid, index, instance, > - mcount, privkey_file, cert_file) < 0) { > + if (empty_capsule) { > + if (create_empty_capsule(argv[argc - 1], guid, > + accept_fw_capsule ? 1 : 0) < 0) { > + printf("Creating empty capsule failed\n"); To stderr -Takahiro Akashi > + 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.17.1 >