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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6C9E5C636CC for ; Mon, 13 Feb 2023 18:51:07 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230239AbjBMSvF (ORCPT ); Mon, 13 Feb 2023 13:51:05 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45440 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230063AbjBMSup (ORCPT ); Mon, 13 Feb 2023 13:50:45 -0500 Received: from mail-pl1-x633.google.com (mail-pl1-x633.google.com [IPv6:2607:f8b0:4864:20::633]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A2ACC1CF77 for ; Mon, 13 Feb 2023 10:50:32 -0800 (PST) Received: by mail-pl1-x633.google.com with SMTP id w5so14453155plg.8 for ; Mon, 13 Feb 2023 10:50:32 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; 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=q/XMzJ+L5J3d0/+ssV6BRnN4NRVloomzU3VBGcZ4wik=; b=KhdeTFjVn62yGlGeO0UlCLlRdy1lL4f/HH3KtvyPQpZqb9ysc8seDOZ1COaU9pQLaw 0V/kx7cErOHN3vSLcUnQQDn9VbyuFlIE8yXGWRDRtLrBOfi12uuMPsxC6PK+74DZVVIP DMkvz045TEEEjSce4O5n7Q0B/fxDkCEAiAnYOSfozdMEwmmavyAzPUhD/Az38oRMutdQ R5oH2Km/4OmUpiLfQGTPA+K9dn8A07kaKUbQzkIdbYrudeXttcEwB2kL7APHbMtVxI0T zU+845c6U01o0HU7Ffqi8vt2wR2c9SgtPHjG3viTxYFuUGWIRGsAsipHG+OVu6vVgAxu HK8Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; 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=q/XMzJ+L5J3d0/+ssV6BRnN4NRVloomzU3VBGcZ4wik=; b=MXlr6+L0+KZEc1Vfy1dtBsQQso7Vn3P99xjZjQUea0i1mY7SX1+9OopyzBmwncg+IF SJCGGN0/nZSb82ownebhc5Qdz93YfduxL+aYlwUD+dDLEVOZ7rAM7gcihNaXpRrPwHWs 5/fSxSMZOAZ+jOYovLZ9uhofZI3slZeDDSHOFfuRNktxYnwOrw1PdSQfbYOq5s78xZYX QRp92e7F/mQRrvvxZrS0JKVowz9l0O0e2s/K3eMhfMmMAJmt9qEuPYDSXyFX1T4kng/Q 6YCvrMJHC4OdgR/SjbKeRxEIpTnImCdnqoa33ADU+LfF0PhjRJ9+wyDWO3oFh3sAn63Z gnCQ== X-Gm-Message-State: AO0yUKVXbBcivglllov6FeF927zb+FUgDifpR6VJqAFpXm5LG0SAnDB0 ij6lHGgDxZHZeYQTZX/rOWU= X-Google-Smtp-Source: AK7set+4RFdyqlfahmB2Q1NGruBzWd4fNQlD/W8SOBCur3GY6BNMQt39wOUauyvDbHLcpi29ucc71Q== X-Received: by 2002:a17:902:cacb:b0:19a:b427:230a with SMTP id y11-20020a170902cacb00b0019ab427230amr503834pld.63.1676314232143; Mon, 13 Feb 2023 10:50:32 -0800 (PST) Received: from f37.eng.vmware.com ([66.170.99.1]) by smtp.googlemail.com with ESMTPSA id p14-20020a170902a40e00b00198f256a192sm8535036plq.171.2023.02.13.10.50.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 13 Feb 2023 10:50:31 -0800 (PST) From: Shreenidhi Shedi X-Google-Original-From: Shreenidhi Shedi To: dhowells@redhat.com, dwmw2@infradead.org, gregkh@linuxfoundation.org Cc: linux-kernel@vger.kernel.org, Shreenidhi Shedi Subject: [PATCH v2 6/6] sign-file: improve help message Date: Tue, 14 Feb 2023 00:20:19 +0530 Message-Id: <20230213185019.56902-7-sshedi@vmware.com> X-Mailer: git-send-email 2.39.1 In-Reply-To: <20230213185019.56902-1-sshedi@vmware.com> References: <20230213185019.56902-1-sshedi@vmware.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Add a proper help message with examples on how to use this tool. Signed-off-by: Shreenidhi Shedi --- scripts/sign-file.c | 49 ++++++++++++++++++++++++++++++++++++--------- 1 file changed, 40 insertions(+), 9 deletions(-) diff --git a/scripts/sign-file.c b/scripts/sign-file.c index 0729d8df5660..d9499ea5c8cc 100644 --- a/scripts/sign-file.c +++ b/scripts/sign-file.c @@ -74,13 +74,44 @@ struct module_signature { static const char magic_number[] = "~Module signature appended~\n"; static __attribute__((noreturn)) -void format(void) +void print_usage(int retval) { - fprintf(stderr, - "Usage: scripts/sign-file [-dp] []\n"); - fprintf(stderr, - " scripts/sign-file -s []\n"); - exit(2); + 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, --savesig Save signature\n"); + fprintf(stderr, "-o, --signonly Sign only\n"); + fprintf(stderr, "-b, --bulksign Sign modules in bulk\n"); + fprintf(stderr, "-l, --replaceorig Replace original\n"); +#ifndef USE_PKCS7 + fprintf(stderr, "-k, --usekeyid Use key ID\n"); +#endif + fprintf(stderr, "-r, --rawsig Raw signature\n"); + fprintf(stderr, "-d, --dest Destination path "); + fprintf(stderr, "(Exclusive with bulk option)\n"); + + fprintf(stderr, "\nMandatory args:\n"); + fprintf(stderr, "-p, --privkey Private key\n"); + fprintf(stderr, "-a, --hashalgo Hash algorithm\n"); + fprintf(stderr, "-x, --x509 X509\n"); + + fprintf(stderr, "\nExamples:\n"); + + fprintf(stderr, "\nRegular signing:\n"); + fprintf(stderr, "scripts/sign-file -a sha512 -p certs/signing_key.pem "); + fprintf(stderr, "-x certs/signing_key.x509 \n"); + + fprintf(stderr, "\nSigning with destination path:\n"); + fprintf(stderr, "scripts/sign-file -a sha512 -p certs/signing_key.pem "); + fprintf(stderr, "-x certs/signing_key.x509 -d \n"); + + fprintf(stderr, "\nSigning modules in bulk:\n"); + fprintf(stderr, "scripts/sign-file -a sha512 -p certs/signing_key.pem "); + fprintf(stderr, "-x certs/signing_key.x509 -b ...\n"); + + exit(retval); } static void display_openssl_errors(int l) @@ -264,7 +295,7 @@ static void parse_args(int argc, char **argv, struct cmd_opts *opts) #endif switch (opt) { case 'h': - format(); + print_usage(0); break; case 'r': @@ -315,7 +346,7 @@ static void parse_args(int argc, char **argv, struct cmd_opts *opts) break; default: - format(); + print_usage(2); break; } } while (opt != -1); @@ -355,7 +386,7 @@ int sign_file(int argc, char **argv, struct cmd_opts *opts) #endif if ((bulk_sign && dest_name) || (!bulk_sign && argc != 1)) - format(); + print_usage(2); if (dest_name && strcmp(argv[0], dest_name)) { replace_orig = false; -- 2.39.1