From 5559ef002306dde0093f3d329725259cada9ed41 Mon Sep 17 00:00:00 2001
From: Tobias Happ <Gerschtli@users.noreply.github.com>
Date: Tue, 16 Nov 2021 19:51:10 +0100
Subject: [PATCH] ssh: add includes option (#2453)

---
 modules/programs/ssh.nix                      | 25 ++++++++++++++++---
 .../programs/ssh/default-config-expected.conf |  2 --
 tests/modules/programs/ssh/default.nix        |  1 +
 ...ynamic-valid-bind-no-asserts-expected.conf |  3 ---
 tests/modules/programs/ssh/includes.nix       | 15 +++++++++++
 .../ssh/match-blocks-attrs-expected.conf      |  5 ----
 6 files changed, 38 insertions(+), 13 deletions(-)
 create mode 100644 tests/modules/programs/ssh/includes.nix

diff --git a/modules/programs/ssh.nix b/modules/programs/ssh.nix
index abbde3f41..b51ecedf4 100644
--- a/modules/programs/ssh.nix
+++ b/modules/programs/ssh.nix
@@ -414,6 +414,22 @@ in
       '';
     };
 
+    includes = mkOption {
+      type = types.listOf types.str;
+      default = [];
+      description = ''
+        File globs of ssh config files that should be included via the
+        <literal>Include</literal> directive.
+        </para><para>
+        See
+        <citerefentry>
+          <refentrytitle>ssh_config</refentrytitle>
+          <manvolnum>5</manvolnum>
+        </citerefentry>
+        for more information.
+      '';
+    };
+
     matchBlocks = mkOption {
       type = hm.types.listOrDagOf matchBlockModule;
       default = {};
@@ -474,9 +490,12 @@ in
           else abort "Dependency cycle in SSH match blocks: ${sortedMatchBlocksStr}";
       in ''
       ${concatStringsSep "\n" (
-        mapAttrsToList (n: v: "${n} ${v}") cfg.extraOptionOverrides)}
-
-      ${concatStringsSep "\n\n" (map (block: matchBlockStr block.data) matchBlocks)}
+        (mapAttrsToList (n: v: "${n} ${v}") cfg.extraOptionOverrides)
+        ++ (optional (cfg.includes != [ ]) ''
+          Include ${concatStringsSep " " cfg.includes}
+        '')
+        ++ (map (block: matchBlockStr block.data) matchBlocks)
+      )}
 
       Host *
         ForwardAgent ${yn cfg.forwardAgent}
diff --git a/tests/modules/programs/ssh/default-config-expected.conf b/tests/modules/programs/ssh/default-config-expected.conf
index 6885392b2..d205cab1e 100644
--- a/tests/modules/programs/ssh/default-config-expected.conf
+++ b/tests/modules/programs/ssh/default-config-expected.conf
@@ -1,7 +1,5 @@
 
 
-
-
 Host *
   ForwardAgent no
   Compression no
diff --git a/tests/modules/programs/ssh/default.nix b/tests/modules/programs/ssh/default.nix
index 507eef0bd..b2f832c91 100644
--- a/tests/modules/programs/ssh/default.nix
+++ b/tests/modules/programs/ssh/default.nix
@@ -1,5 +1,6 @@
 {
   ssh-defaults = ./default-config.nix;
+  ssh-includes = ./includes.nix;
   ssh-match-blocks = ./match-blocks-attrs.nix;
 
   ssh-forwards-dynamic-valid-bind-no-asserts =
diff --git a/tests/modules/programs/ssh/forwards-dynamic-valid-bind-no-asserts-expected.conf b/tests/modules/programs/ssh/forwards-dynamic-valid-bind-no-asserts-expected.conf
index 02268e8cb..a67a96ca4 100644
--- a/tests/modules/programs/ssh/forwards-dynamic-valid-bind-no-asserts-expected.conf
+++ b/tests/modules/programs/ssh/forwards-dynamic-valid-bind-no-asserts-expected.conf
@@ -1,8 +1,5 @@
-
-
 Host dynamicBindAddressWithPort
   DynamicForward [127.0.0.1]:3000
-
 Host dynamicBindPathNoPort
   DynamicForward /run/user/1000/gnupg/S.gpg-agent.extra
 
diff --git a/tests/modules/programs/ssh/includes.nix b/tests/modules/programs/ssh/includes.nix
new file mode 100644
index 000000000..12e2c6df8
--- /dev/null
+++ b/tests/modules/programs/ssh/includes.nix
@@ -0,0 +1,15 @@
+{ config, lib, pkgs, ... }:
+
+{
+  config = {
+    programs.ssh = {
+      enable = true;
+      includes = [ "config.d/*" "other/dir" ];
+    };
+
+    nmt.script = ''
+      assertFileExists home-files/.ssh/config
+      assertFileContains home-files/.ssh/config "Include config.d/* other/dir"
+    '';
+  };
+}
diff --git a/tests/modules/programs/ssh/match-blocks-attrs-expected.conf b/tests/modules/programs/ssh/match-blocks-attrs-expected.conf
index e2c329015..1a197b26f 100644
--- a/tests/modules/programs/ssh/match-blocks-attrs-expected.conf
+++ b/tests/modules/programs/ssh/match-blocks-attrs-expected.conf
@@ -1,13 +1,9 @@
-
-
 Host * !github.com
   Port 516
   IdentityFile file1
   IdentityFile file2
-
 Host abc
   ProxyJump jump-host
-
 Host xyz
   ServerAliveInterval 60
   ServerAliveCountMax 10
@@ -16,7 +12,6 @@ Host xyz
   RemoteForward [localhost]:8081 [10.0.0.2]:80
   RemoteForward /run/user/1000/gnupg/S.gpg-agent.extra /run/user/1000/gnupg/S.gpg-agent
   DynamicForward [localhost]:2839
-
 Host ordered
   Port 1