From patchwork Wed Mar 13 17:42:19 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Ludovic_Court=C3=A8s?= X-Patchwork-Id: 61786 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 14A4227BBEB; Wed, 13 Mar 2024 17:46:05 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 9F02027BBE9 for ; Wed, 13 Mar 2024 17:46:03 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rkSfT-0000WJ-RZ; Wed, 13 Mar 2024 13:45:31 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rkSfQ-0000Vp-IM for guix-patches@gnu.org; Wed, 13 Mar 2024 13:45:28 -0400 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rkSfP-0001mU-VQ; Wed, 13 Mar 2024 13:45:28 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rkSfy-0008K8-VW; Wed, 13 Mar 2024 13:46:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#69780] [PATCH 1/4] git authenticate: Record introduction and keyring in =?utf-8?b?4oCYLmdpdC9jb25maWfigJku?= Resent-From: Ludovic =?utf-8?q?Court=C3=A8s?= Original-Sender: "Debbugs-submit" Resent-CC: guix@cbaines.net, dev@jpoiret.xyz, ludo@gnu.org, othacehe@gnu.org, rekado@elephly.net, zimon.toutoune@gmail.com, me@tobias.gr, guix-patches@gnu.org Resent-Date: Wed, 13 Mar 2024 17:46:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 69780 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 69780@debbugs.gnu.org Cc: Ludovic =?utf-8?q?Court=C3=A8s?= , Christopher Baines , Josselin Poiret , Ludovic =?utf-8?q?Court=C3=A8s?= , Mathieu Othacehe , Ricardo Wurmus , Simon Tournier , Tobias Geerinckx-Rice X-Debbugs-Original-Xcc: Christopher Baines , Josselin Poiret , Ludovic =?utf-8?q?Court=C3=A8s?= , Mathieu Othacehe , Ricardo Wurmus , Simon Tournier , Tobias Geerinckx-Rice Received: via spool by 69780-submit@debbugs.gnu.org id=B69780.171035194731951 (code B ref 69780); Wed, 13 Mar 2024 17:46:02 +0000 Received: (at 69780) by debbugs.gnu.org; 13 Mar 2024 17:45:47 +0000 Received: from localhost ([127.0.0.1]:47360 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rkSfU-0008Iz-IX for submit@debbugs.gnu.org; Wed, 13 Mar 2024 13:45:47 -0400 Received: from eggs.gnu.org ([209.51.188.92]:48740) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rkSfQ-0008IH-6s for 69780@debbugs.gnu.org; Wed, 13 Mar 2024 13:45:29 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rkSce-0000vN-Jr; Wed, 13 Mar 2024 13:42:36 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:References:In-Reply-To:Date:Subject:To: From; bh=YvXcRRDgEoNDdlU53IdnOj4kZdeeqjFBZC/dS6UTqkw=; b=Txy1ADQCEp0jeutXgq6F zXFXDjKlYbkS+WVyQAk6QupjE3ESQLRS5Baf/7IN1/PkHj0yMTLvnyqpY4l8L924482PIdPxG3WZJ PHhqesDfe9pCP0usXfvJdb6wVRF29hxanujX3Mdn0bMn4B5/ZrW02pX/j/pTJJ7aEIwQ4NuID6tk4 v2p7zJEfkDjO+71I+IZpDbzMDQ2hxOHP9qpGlQbR0kS2JyOi4quZ+c1K/vA95/5VFykSAxYDZloz1 5Hutxm+yr8l65dHMEoKVP7lY8pM/KmbS8gW0pXVIxy8BCs5nyQpuljYTDDuYrHT7cTfJUXnJSq0uJ MF1MmsZq60M9nw==; From: Ludovic =?utf-8?q?Court=C3=A8s?= Date: Wed, 13 Mar 2024 18:42:19 +0100 Message-ID: <40858e56cf55b27711d23add5f3cd2ccc6ea5c58.1710351278.git.ludo@gnu.org> X-Mailer: git-send-email 2.41.0 In-Reply-To: References: MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches * guix/scripts/git/authenticate.scm (%default-options): Remove ‘keyring-reference’. (config-value, configured-introduction, configured-keyring-reference) (configured?, record-configuration): New procedures. (guix-git-authenticate)[missing-arguments]: New procedure. Use ‘configured-introduction’ when zero arguments are given. Use ‘configured-keyring-reference’ when ‘-k’ is not passed. Add call to ‘record-configuration’. * doc/guix.texi (Invoking guix git authenticate): Document it. Change-Id: I66e111a83f50407b52da71662629947f83a78bbc --- doc/guix.texi | 12 ++- guix/scripts/git/authenticate.scm | 128 ++++++++++++++++++++++-------- tests/guix-git-authenticate.sh | 9 ++- 3 files changed, 112 insertions(+), 37 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 858d5751bf..ac0766b98c 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -7615,8 +7615,16 @@ Invoking guix git authenticate and non-zero on failure. @var{commit} above denotes the first commit where authentication takes place, and @var{signer} is the OpenPGP fingerprint of public key used to sign @var{commit}. Together, they -form a ``channel introduction'' (@pxref{channel-authentication, channel -introduction}). The options below allow you to fine-tune the process. +form a @dfn{channel introduction} (@pxref{channel-authentication, channel +introduction}). On your first successful run, the introduction is +recorded in the @file{.git/config} file of your checkout, allowing you +to omit them from subsequent invocations: + +@example +guix git authenticate [@var{options}@dots{}] +@end example + +The options below allow you to fine-tune the process. @table @code @item --repository=@var{directory} diff --git a/guix/scripts/git/authenticate.scm b/guix/scripts/git/authenticate.scm index 6ff5cee682..d3cc4065df 100644 --- a/guix/scripts/git/authenticate.scm +++ b/guix/scripts/git/authenticate.scm @@ -31,6 +31,7 @@ (define-module (guix scripts git authenticate) #:use-module (srfi srfi-1) #:use-module (srfi srfi-26) #:use-module (srfi srfi-37) + #:use-module (srfi srfi-71) #:use-module (ice-9 format) #:use-module (ice-9 match) #:export (guix-git-authenticate)) @@ -73,8 +74,60 @@ (define %options (alist-cons 'show-stats? #t result))))) (define %default-options - '((directory . ".") - (keyring-reference . "keyring"))) + '((directory . "."))) + +(define (config-value config key) + "Return the config value associated with KEY, or #f if no such config was +found." + (catch 'git-error + (lambda () + (config-entry-value (config-get-entry config key))) + (const #f))) + +(define (configured-introduction repository) + "Return two values: the commit and signer fingerprint (strings) as +configured in REPOSITORY. Error out if one or both were missing." + (let* ((config (repository-config repository)) + (commit (config-value config "guix.authentication.introduction-commit")) + (signer (config-value config "guix.authentication.introduction-signer"))) + (unless (and commit signer) + (leave (G_ "unknown introductory commit and signer~%"))) + (values commit signer))) + +(define (configured-keyring-reference repository) + "Return the keyring reference configured in REPOSITORY or #f if missing." + (let ((config (repository-config repository))) + (config-value config "guix.authentication.keyring"))) + +(define (configured? repository) + "Return true if REPOSITORY already container introduction info in its +'config' file." + (let ((config (repository-config repository))) + (and (config-value config "guix.authentication.introduction-commit") + (config-value config "guix.authentication.introduction-signer")))) + +(define* (record-configuration repository + #:key commit signer keyring-reference) + "Record COMMIT, SIGNER, and KEYRING-REFERENCE in the 'config' file of +REPOSITORY." + (define directory + (repository-directory repository)) + + (define config-file + (in-vicinity directory "config")) + + (call-with-port (open-file config-file "a") + (lambda (port) + (format port " +# Added by 'guix git authenticate'. +[guix \"authentication\"] + introduction-commit = ~a + introduction-signer = ~a + keyring = ~a~%" + commit signer keyring-reference))) + + (info (G_ "introduction and keyring configuration recorded in '~a'~%") + config-file)) (define (show-stats stats) "Display STATS, an alist containing commit signing stats as returned by @@ -156,35 +209,48 @@ (define (guix-git-authenticate . args) (progress-reporter/bar (length commits)) progress-reporter/silent)) + (define (missing-arguments) + (leave (G_ "wrong number of arguments; \ +expected COMMIT and SIGNER~%"))) + (with-error-handling (with-git-error-handling - (match (command-line-arguments options) - ((commit signer) - (let* ((directory (assoc-ref options 'directory)) - (show-stats? (assoc-ref options 'show-stats?)) - (keyring (assoc-ref options 'keyring-reference)) - (repository (repository-open directory)) - (end (match (assoc-ref options 'end-commit) - (#f (reference-target - (repository-head repository))) - (oid oid))) - (history (match (assoc-ref options 'historical-authorizations) - (#f '()) - (file (call-with-input-file file - read-authorizations)))) - (cache-key (or (assoc-ref options 'cache-key) - (repository-cache-key repository)))) - (define stats - (authenticate-repository repository (string->oid commit) - (openpgp-fingerprint* signer) - #:end end - #:keyring-reference keyring - #:historical-authorizations history - #:cache-key cache-key - #:make-reporter make-reporter)) + (let* ((directory (assoc-ref options 'directory)) + (show-stats? (assoc-ref options 'show-stats?)) + (repository (repository-open directory)) + (commit signer (match (command-line-arguments options) + ((commit signer) + (values commit signer)) + (() + (configured-introduction repository)) + (_ + (missing-arguments)))) + (keyring (or (assoc-ref options 'keyring-reference) + (configured-keyring-reference repository) + "keyring")) + (end (match (assoc-ref options 'end-commit) + (#f (reference-target + (repository-head repository))) + (oid oid))) + (history (match (assoc-ref options 'historical-authorizations) + (#f '()) + (file (call-with-input-file file + read-authorizations)))) + (cache-key (or (assoc-ref options 'cache-key) + (repository-cache-key repository)))) + (define stats + (authenticate-repository repository (string->oid commit) + (openpgp-fingerprint* signer) + #:end end + #:keyring-reference keyring + #:historical-authorizations history + #:cache-key cache-key + #:make-reporter make-reporter)) - (when (and show-stats? (not (null? stats))) - (show-stats stats)))) - (_ - (leave (G_ "wrong number of arguments; \ -expected COMMIT and SIGNER~%"))))))) + (unless (configured? repository) + (record-configuration repository + #:commit commit #:signer signer + #:keyring-reference keyring)) + + (when (and show-stats? (not (null? stats))) + (show-stats stats)))))) diff --git a/tests/guix-git-authenticate.sh b/tests/guix-git-authenticate.sh index ec89f941e6..db60816d45 100644 --- a/tests/guix-git-authenticate.sh +++ b/tests/guix-git-authenticate.sh @@ -1,5 +1,5 @@ # GNU Guix --- Functional package management for GNU -# Copyright © 2020, 2022 Ludovic Courtès +# Copyright © 2020, 2022, 2024 Ludovic Courtès # # This file is part of GNU Guix. # @@ -40,10 +40,11 @@ guix git authenticate "$intro_commit" "$intro_signer" \ --end=9549f0283a78fe36f2d4ff2a04ef8ad6b0c02604 && false # The v1.2.0 commit is a descendant of $intro_commit and it satisfies the -# authorization invariant. +# authorization invariant. No need to repeat $intro_commit and $intro_signer +# because it should have been recorded in '.git/config'. v1_2_0_commit="a099685659b4bfa6b3218f84953cbb7ff9e88063" -guix git authenticate "$intro_commit" "$intro_signer" \ - --cache-key="$cache_key" --stats \ +guix git authenticate \ + --cache-key="$cache_key" --stats \ --end="$v1_2_0_commit" rm "$XDG_CACHE_HOME/guix/authentication/$cache_key"