From nobody Sun Feb 8 16:31:44 2026 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id CD26EC6FD1D for ; Tue, 21 Mar 2023 19:35:08 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230374AbjCUTfH (ORCPT ); Tue, 21 Mar 2023 15:35:07 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50370 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230304AbjCUTez (ORCPT ); Tue, 21 Mar 2023 15:34:55 -0400 Received: from mail-pg1-x536.google.com (mail-pg1-x536.google.com [IPv6:2607:f8b0:4864:20::536]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E1C8D57D17 for ; Tue, 21 Mar 2023 12:34:22 -0700 (PDT) Received: by mail-pg1-x536.google.com with SMTP id h31so9247669pgl.6 for ; Tue, 21 Mar 2023 12:34:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; t=1679427231; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=yt1FiyCAq19UTY6Dgky638GY7WS05mpX7yYj+tKdXNE=; b=G4DGe8D49ZyzRrUhrQQPanlfHBcdpW5j9vA12O4p5GFkxEj8KfOPNduDd8eJDDmi4R /Y0CLxN44hQgnYW6d5krQNwnoMuICMjIL4YfI/VhQo7zUjkUoF7Xq7PwdgtSkp0ullne pNiy1gFBn4bJZ3T5Jzs54jqpYLJyeUIr/0HcCsdr6KNwTx++OlSa3kgg99Ziat8HpkdZ nzj163HyhmTE/B8FuXw83S5U7UQ7fXGIMeqXRy18MZkfzIjcp6eXAOLvJN40IYcT9aU9 9x7XYA+BMCrVGu0bFtpzJefsURaLx0LsbUYeXCwu9QMJC9ZPsvwuv3NnO1c9zpuFfxnT eenA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1679427231; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=yt1FiyCAq19UTY6Dgky638GY7WS05mpX7yYj+tKdXNE=; b=hRMU1A0Va/f/cF3tGsO0pROp3W0oX5N70f/i4mF218WiBE8GK0I0b16/UMuH0kZkZa Zf3Ad1MCRRCF7YsPQB3sDQtkDwzXN/GJPKwfEgMjbfpbaA866FZC+CvvhZ2Q/ygr5trf LuLUnu966xv4tgxICs25uOBO5Yt+luTJw3oYO3QbAwxJ+v5kdaXGuvq/Shqf8zh8DvM9 9sVbHXsAeBMfJbDdtH0VDLGNu0HNLtEHizMISAczF+HOWfyt/0AVm2i8MW7HiHa1tdrS KBHN376g7A/pcqKrDGLwlxC9ymRH5D/oGfEsiGzMvA3CWO9298NEwNHRXch/on7f34rW PkUg== X-Gm-Message-State: AO0yUKXuLeFwdcF0FJWYJvMiz5kbC+gIf3LOx7zNep7lluGxSxsv1gOQ DaQlenQyKbwDvdBZms6/rsM= X-Google-Smtp-Source: AK7set97hMjW3d32KCMpBcN+FBysPgtZHd/LBwqEusd8tRW8cRVK+BxeW3s5Nhi9cycbhhpO2MPr1A== X-Received: by 2002:a62:38d0:0:b0:625:e192:1c7f with SMTP id f199-20020a6238d0000000b00625e1921c7fmr932785pfa.18.1679427231248; Tue, 21 Mar 2023 12:33:51 -0700 (PDT) Received: from f37.eng.vmware.com ([66.170.99.1]) by smtp.googlemail.com with ESMTPSA id k23-20020aa790d7000000b006247123adf1sm8843044pfk.143.2023.03.21.12.33.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 21 Mar 2023 12:33:50 -0700 (PDT) From: Shreenidhi Shedi X-Google-Original-From: Shreenidhi Shedi To: gregkh@linuxfoundation.org, dhowells@redhat.com, dwmw2@infradead.org Cc: linux-kernel@vger.kernel.org, sshedi@vmware.com, yesshedi@gmail.com Subject: [PATCH v6 5/7] sign-file: improve help message Date: Wed, 22 Mar 2023 01:03:39 +0530 Message-Id: <20230321193341.87997-6-sshedi@vmware.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230321193341.87997-1-sshedi@vmware.com> References: <20230321193341.87997-1-sshedi@vmware.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" From: Shreenidhi Shedi Add a proper help message with examples on how to use this tool. Signed-off-by: Shreenidhi Shedi --- scripts/sign-file.c | 48 ++++++++++++++++++++++++++++++++++++++------- 1 file changed, 41 insertions(+), 7 deletions(-) diff --git a/scripts/sign-file.c b/scripts/sign-file.c index 0a275256ca16..d3abc5721a7e 100644 --- a/scripts/sign-file.c +++ b/scripts/sign-file.c @@ -74,12 +74,43 @@ struct module_signature { static char magic_number[] =3D "~Module signature appended~\n"; =20 static __attribute__((noreturn)) -void format(void) +void print_usage(void) { - fprintf(stderr, - "Usage: scripts/sign-file [-dp] []\n"); - fprintf(stderr, - " scripts/sign-file -s []\n"); + fprintf(stderr, "Usage: scripts/sign-file [OPTIONS]... [MODULE]...\n"); + fprintf(stderr, "Available options:\n"); + fprintf(stderr, "-h, --help Print this help message and exit\= n"); + + fprintf(stderr, "\nOptional args:\n"); + fprintf(stderr, "-s, --rawsig Raw signature\n"); + fprintf(stderr, "-p, --savesig Save signature\n"); + fprintf(stderr, "-d, --signonly Sign only\n"); +#ifndef USE_PKCS7 + fprintf(stderr, "-k, --usekeyid Use key ID\n"); +#endif + fprintf(stderr, "-b, --bulksign Sign modules in bulk\n"); + fprintf(stderr, "-r, --replaceorig Replace original\n"); + fprintf(stderr, "-t, --dest Destination path "); + fprintf(stderr, "(Exclusive with bulk option)\n"); + + fprintf(stderr, "\nMandatory args:\n"); + fprintf(stderr, "-i, --privkey Private key\n"); + fprintf(stderr, "-a, --hashalgo Hash algorithm\n"); + fprintf(stderr, "-x, --x509 X509\n"); + + fprintf(stderr, "\nExamples:\n"); + + fprintf(stderr, "\n Regular signing:\n"); + fprintf(stderr, " scripts/sign-file -a sha512 -i certs/signing_key.pe= m "); + fprintf(stderr, "-x certs/signing_key.x509 \n"); + + fprintf(stderr, "\n Signing with destination path:\n"); + fprintf(stderr, " scripts/sign-file -a sha512 -i certs/signing_key.pe= m "); + fprintf(stderr, "-x certs/signing_key.x509 -t \n"); + + fprintf(stderr, "\n Signing modules in bulk:\n"); + fprintf(stderr, " scripts/sign-file -a sha512 -i certs/signing_key.pe= m "); + fprintf(stderr, "-x certs/signing_key.x509 -b ...\n"); + exit(2); } =20 @@ -281,7 +312,7 @@ static void parse_args(int argc, char **argv, struct cm= d_opts *opts) #endif =20 case 'h': - format(); + print_usage(); break; =20 case 'i': @@ -312,7 +343,7 @@ static void parse_args(int argc, char **argv, struct cm= d_opts *opts) break; =20 default: - format(); + print_usage(); break; } } while (opt !=3D -1); @@ -472,6 +503,9 @@ int main(int argc, char **argv) argc -=3D optind; argv +=3D optind; =20 + if ((opts.bulk_sign && opts.dest_name) || (!opts.bulk_sign && argc !=3D 1= )) + print_usage(); + OpenSSL_add_all_algorithms(); ERR_load_crypto_strings(); ERR_clear_error(); --=20 2.39.2