[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
06/08: home: services: ssh: Add 'match-criteria' option.
From: |
guix-commits |
Subject: |
06/08: home: services: ssh: Add 'match-criteria' option. |
Date: |
Fri, 9 Jun 2023 17:44:51 -0400 (EDT) |
civodul pushed a commit to branch master
in repository guix.
commit 95853e61a74a285c3045cc3763dfafaa42af329d
Author: Nicolas Graves <ngraves@ngraves.fr>
AuthorDate: Mon Jun 5 14:34:46 2023 +0200
home: services: ssh: Add 'match-criteria' option.
* gnu/home/services/ssh.scm (serialize-address-family): Raise
'&formatted-message' instead of '&error'.
(ssh-match-keywords): New variable.
(match-criteria?): New procedure.
(match-criteria): New maybe type.
(openssh-host)[name]: Turn into 'maybe-string'.
[match-criteria]: New field.
(serialize-openssh-host): Adjust accordingly.
* doc/guix.texi (Secure Shell): Document it.
Signed-off-by: Ludovic Courtès <ludo@gnu.org>
---
doc/guix.texi | 12 +++++++++-
gnu/home/services/ssh.scm | 58 +++++++++++++++++++++++++++++++++++++++++------
2 files changed, 62 insertions(+), 8 deletions(-)
diff --git a/doc/guix.texi b/doc/guix.texi
index a71751142b..395fc25818 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -43100,11 +43100,21 @@ Available @code{openssh-host} fields are:
@table @asis
@item @code{name} (type: string)
-Name of this host declaration.
+Name of this host declaration. A @code{openssh-host} must define only
+@code{name} or @code{match-criteria}. Use host-name @code{\"*\"} for
+top-level options.
@item @code{host-name} (type: maybe-string)
Host name---e.g., @code{"foo.example.org"} or @code{"192.168.1.2"}.
+@item @code{match-criteria} (type: maybe-match-criteria)
+When specified, this string denotes the set of hosts to which the entry
+applies, superseding the @code{host-name} field. Its first element must be
+all or one of @code{ssh-match-keywords}. The rest of the elements are
+arguments for the keyword, or other criteria. A @code{openssh-host} must
+define only @code{name} or @code{match-criteria}. Other host configuration
+options will apply to all hosts matching @code{match-criteria}.
+
@item @code{address-family} (type: maybe-address-family)
Address family to use when connecting to this host: one of
@code{AF_INET} (for IPv4 only), @code{AF_INET6} (for IPv6 only).
diff --git a/gnu/home/services/ssh.scm b/gnu/home/services/ssh.scm
index c2c008f01c..a384373b81 100644
--- a/gnu/home/services/ssh.scm
+++ b/gnu/home/services/ssh.scm
@@ -49,6 +49,7 @@
openssh-host
openssh-host-host-name
+ openssh-host-match-criteria
openssh-host-identity-file
openssh-host-name
openssh-host-port
@@ -96,7 +97,11 @@
(cond ((= family AF_INET) "inet")
((= family AF_INET6) "inet6")
;; The 'else' branch is unreachable.
- (else (raise (condition (&error)))))
+ (else
+ (raise
+ (formatted-message
+ (G_ "~s: invalid address family value")
+ family))))
"\n")
""))
@@ -174,13 +179,40 @@
(configuration-field-error (source-properties->location properties)
'proxy-command value))
value))
+(define ssh-match-keywords
+ '(canonical final exec host originalhost user localuser))
+
+(define (match-criteria? str)
+ ;; Rule out the case of "all" keyword.
+ (if (member str '("all"
+ "canonical all"
+ "final all"))
+ #t
+ (let* ((first (string-take str (string-index str #\ )))
+ (keyword (string->symbol (if (string-prefix? "!" first)
+ (string-drop first 1)
+ first))))
+ (memq keyword ssh-match-keywords))))
+
+(define-maybe match-criteria)
+
(define-configuration openssh-host
(name
- (string)
- "Name of this host declaration.")
+ maybe-string
+ "Name of this host declaration. A @code{openssh-host} must define only
+@code{name} or @code{match-criteria}. Use host-name @code{\"*\"} for
+top-level options.")
(host-name
maybe-string
"Host name---e.g., @code{\"foo.example.org\"} or @code{\"192.168.1.2\"}.")
+ (match-criteria ;TODO implement stricter match-criteria rules
+ maybe-match-criteria
+ "When specified, this string denotes the set of hosts to which the entry
+applies, superseding the @code{host-name} field. Its first element must be
+all or one of @code{ssh-match-keywords}. The rest of the elements are
+arguments for the keyword, or other criteria. A @code{openssh-host} must
+define only @code{name} or @code{match-criteria}. Other host configuration
+options will apply to all hosts matching @code{match-criteria}.")
(address-family
maybe-address-family
"Address family to use when connecting to this host: one of
@@ -235,17 +267,29 @@ through before connecting to the server.")
@file{~/.ssh/config}."))
(define (serialize-openssh-host config)
- (define (openssh-host-name-field? field)
- (eq? (configuration-field-name field) 'name))
+ (define (openssh-host-name-or-match-field? field)
+ (or (eq? (configuration-field-name field) 'name)
+ (eq? (configuration-field-name field) 'match-criteria)))
(string-append
- "Host " (openssh-host-name config) "\n"
+ (if (maybe-value-set? (openssh-host-name config))
+ (if (maybe-value-set? (openssh-host-match-criteria config))
+ (raise
+ (formatted-message
+ (G_ "define either 'name' or 'match-criteria', not both")))
+ (string-append "Host " (openssh-host-name config) "\n"))
+ (if (maybe-value-set? (openssh-host-match-criteria config))
+ (string-append
+ "Match " (string-join (openssh-host-match-criteria config) " ")
"\n")
+ (raise
+ (formatted-message
+ (G_ "define either 'name' or 'match-criteria' once")))))
(string-concatenate
(map (lambda (field)
((configuration-field-serializer field)
(configuration-field-name field)
((configuration-field-getter field) config)))
- (remove openssh-host-name-field?
+ (remove openssh-host-name-or-match-field?
openssh-host-fields)))))
(define-record-type* <home-openssh-configuration>
- branch master updated (44bbfc24e4 -> 9504dd2c3e), guix-commits, 2023/06/09
- 05/08: home: services: ssh: Add 'add-keys-to-agent' field., guix-commits, 2023/06/09
- 02/08: gnu: i3-wm: Use new package style., guix-commits, 2023/06/09
- 06/08: home: services: ssh: Add 'match-criteria' option.,
guix-commits <=
- 01/08: gnu: guix: Update to 44bbfc2., guix-commits, 2023/06/09
- 04/08: gnu: obs-websocket: Deprecate in favor of "obs"., guix-commits, 2023/06/09
- 03/08: gnu: i3-wm: Add missing inputs for i3-save-tree., guix-commits, 2023/06/09
- 07/08: home: services: ssh: Export configuration predicates., guix-commits, 2023/06/09
- 08/08: home: services: ssh: Export home-ssh-agent variables., guix-commits, 2023/06/09