Merge pull request #137 from ryantm/rtm-1-30-nix-format

contrib: format with Alejandra

.github/workflows/ci.yaml

@@ -4,20 +4,22 @@ on:
   push:
 jobs:
   tests-linux:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2.3.4
-    - uses: cachix/install-nix-action@v15
+    - uses: actions/checkout@v3
+    - uses: cachix/install-nix-action@v18
       with:
         extra_nix_config: "system-features = nixos-test benchmark big-parallel kvm"
     - run: nix build
+    - run: nix fmt . -- --check
     - run: nix flake check
   tests-darwin:
     runs-on: macos-11
     steps:
-    - uses: actions/checkout@v2.3.4
-    - uses: cachix/install-nix-action@v15
+    - uses: actions/checkout@v3
+    - uses: cachix/install-nix-action@v18
       with:
         extra_nix_config: "system-features = nixos-test benchmark big-parallel kvm"
     - run: nix build
+    - run: nix fmt . -- --check
     - run: nix flake check

README.md

@@ -25,6 +25,7 @@
   * [agenix CLI reference](#agenix-cli-reference)
 * [Community and Support](#community-and-support)
 * [Threat model/Warnings](#threat-modelwarnings)
+* [Contributing](#contributing)
 * [Acknowledgements](#acknowledgements)
 
 ## Problem and solution
@@ -536,6 +537,19 @@ authentication code (MAC) like other implementations like GPG or
 [sops](https://github.com/Mic92/sops-nix) have, however this was left
 out for simplicity in `age`.
 
+## Contributing
+
+* The main branch is protected against direct pushes
+* All changes must go through GitHub PR review and get at least one approval
+* PR titles and commit messages should be prefixed with at least one of these categories:
+  * contrib - things that make the project development better
+  * doc - documentation
+  * feature - new features
+  * fix - bug fixes
+* Please update or make integration tests for new features
+* Use `nix fmt` to format nix code
+
+
 ## Acknowledgements
 
 This project is based off of [sops-nix](https://github.com/Mic92/sops-nix) created Mic92. Thank you to Mic92 for inspiration and advice.

default.nix

@@ -1,4 +1,3 @@
-{ pkgs ? import <nixpkgs> {} }:
-{
+{pkgs ? import <nixpkgs> {}}: {
   agenix = pkgs.callPackage ./pkgs/agenix.nix {};
 }

example/secrets.nix

@@ -1,9 +1,8 @@
 let
   user1 = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIL0idNvgGiucWgup/mP78zyC23uFjYq0evcWdjGQUaBH";
   system1 = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIPJDyIr/FSz1cJdcoW69R+NrWzwGK/+3gJpqD1t8L2zE";
-in
-{
-  "secret1.age".publicKeys = [ user1 system1 ];
-  "secret2.age".publicKeys = [ user1 ];
-  "passwordfile-user1.age".publicKeys = [ user1 system1 ];
+in {
+  "secret1.age".publicKeys = [user1 system1];
+  "secret2.age".publicKeys = [user1];
+  "passwordfile-user1.age".publicKeys = [user1 system1];
 }

flake.nix

@@ -14,18 +14,23 @@
 
     overlays.default = import ./overlay.nix;
 
-    packages.aarch64-linux.agenix = agenix "aarch64-linux";
-    packages.aarch64-linux.default = self.packages.aarch64-linux.agenix;
-
-    packages.i686-linux.agenix = agenix "i686-linux";
-    packages.i686-linux.default = self.packages.i686-linux.agenix;
-
+    formatter.x86_64-darwin = nixpkgs.legacyPackages.x86_64-darwin.alejandra;
     packages.x86_64-darwin.agenix = agenix "x86_64-darwin";
     packages.x86_64-darwin.default = self.packages.x86_64-darwin.agenix;
 
+    formatter.aarch64-darwin = nixpkgs.legacyPackages.aarch64-darwin.alejandra;
     packages.aarch64-darwin.agenix = agenix "aarch64-darwin";
     packages.aarch64-darwin.default = self.packages.aarch64-darwin.agenix;
 
+    formatter.aarch64-linux = nixpkgs.legacyPackages.aarch64-linux.alejandra;
+    packages.aarch64-linux.agenix = agenix "aarch64-linux";
+    packages.aarch64-linux.default = self.packages.aarch64-linux.agenix;
+
+    formatter.i686-linux = nixpkgs.legacyPackages.i686-linux.alejandra;
+    packages.i686-linux.agenix = agenix "i686-linux";
+    packages.i686-linux.default = self.packages.i686-linux.agenix;
+
+    formatter.x86_64-linux = nixpkgs.legacyPackages.x86_64-linux.alejandra;
     packages.x86_64-linux.agenix = agenix "x86_64-linux";
     packages.x86_64-linux.default = self.packages.x86_64-linux.agenix;
     checks.x86_64-linux.integration = import ./test/integration.nix {

modules/age.nix

@@ -1,14 +1,17 @@
-{ config, options, lib, pkgs, ... }:
-
-with lib;
-
-let
+{
+  config,
+  options,
+  lib,
+  pkgs,
+  ...
+}:
+with lib; let
   cfg = config.age;
 
   # we need at least rage 0.5.0 to support ssh keys
   rage =
     if lib.versionOlder pkgs.rage.version "0.5.0"
-    then pkgs.callPackage ../pkgs/rage.nix { }
+    then pkgs.callPackage ../pkgs/rage.nix {}
     else pkgs.rage;
   ageBin = config.age.ageBin;
 
@@ -28,11 +31,15 @@ let
   identities = builtins.concatStringsSep " " (map (path: "-i ${path}") cfg.identityPaths);
 
   setTruePath = secretType: ''
-    ${if secretType.symlink then ''
+    ${
+      if secretType.symlink
+      then ''
         _truePath="${cfg.secretsMountPoint}/$_agenix_generation/${secretType.name}"
-    '' else ''
+      ''
+      else ''
         _truePath="${secretType.path}"
-    ''}
+      ''
+    }
   '';
 
   installSecret = secretType: ''
@@ -55,9 +62,11 @@ let
     ''}
   '';
 
-  testIdentities = map (path: ''
+  testIdentities =
+    map (path: ''
       test -f ${path} || echo '[agenix] WARNING: config.age.identityPaths entry ${path} not present!'
-  '') cfg.identityPaths;
+    '')
+    cfg.identityPaths;
 
   cleanupAndLink = ''
     _agenix_generation="$(basename "$(readlink ${cfg.secretsDir})" || echo 0)"
@@ -72,10 +81,10 @@ let
   '';
 
   installSecrets = builtins.concatStringsSep "\n" (
-    [ "echo '[agenix] decrypting secrets...'" ]
+    ["echo '[agenix] decrypting secrets...'"]
     ++ testIdentities
     ++ (map installSecret (builtins.attrValues cfg.secrets))
-    ++ [ cleanupAndLink ]
+    ++ [cleanupAndLink]
   );
 
   chownSecret = secretType: ''
@@ -90,11 +99,12 @@ let
   '';
 
   chownSecrets = builtins.concatStringsSep "\n" (
-    [ "echo '[agenix] chowning...'" ]
-    ++ [ chownMountPoint ]
-    ++ (map chownSecret (builtins.attrValues cfg.secrets)));
+    ["echo '[agenix] chowning...'"]
+    ++ [chownMountPoint]
+    ++ (map chownSecret (builtins.attrValues cfg.secrets))
+  );
 
-  secretType = types.submodule ({ config, ... }: {
+  secretType = types.submodule ({config, ...}: {
     options = {
       name = mkOption {
         type = types.str;
@@ -137,14 +147,12 @@ let
           Group of the decrypted secret.
         '';
       };
-      symlink = mkEnableOption "symlinking secrets to their destination" // { default = true; };
+      symlink = mkEnableOption "symlinking secrets to their destination" // {default = true;};
     };
   });
-in
-{
-
+in {
   imports = [
-    (mkRenamedOptionModule [ "age" "sshKeyPaths" ] [ "age" "identityPaths" ])
+    (mkRenamedOptionModule ["age" "sshKeyPaths"] ["age" "identityPaths"])
   ];
 
   options.age = {
@@ -157,7 +165,7 @@ in
     };
     secrets = mkOption {
       type = types.attrsOf secretType;
-      default = { };
+      default = {};
       description = ''
         Attrset of secrets.
       '';
@@ -170,11 +178,13 @@ in
       '';
     };
     secretsMountPoint = mkOption {
-      type = types.addCheck types.str
+      type =
+        types.addCheck types.str
         (s:
-          (builtins.match "[ \t\n]*" s) == null # non-empty
+          (builtins.match "[ \t\n]*" s)
+          == null # non-empty
           && (builtins.match ".+/" s) == null) # without trailing slash
-      // { description = "${types.str.description} (with check: non-empty without trailing slash)"; };
+        // {description = "${types.str.description} (with check: non-empty without trailing slash)";};
       default = "/run/agenix.d";
       defaultText = "/run/agenix.d";
       description = ''
@@ -184,20 +194,22 @@ in
     identityPaths = mkOption {
       type = types.listOf types.path;
       default =
-        if config.services.openssh.enable then
-          map (e: e.path) (lib.filter (e: e.type == "rsa" || e.type == "ed25519") config.services.openssh.hostKeys)
-        else [ ];
+        if config.services.openssh.enable
+        then map (e: e.path) (lib.filter (e: e.type == "rsa" || e.type == "ed25519") config.services.openssh.hostKeys)
+        else [];
       description = ''
         Path to SSH keys to be used as identities in age decryption.
       '';
     };
   };
 
-  config = mkIf (cfg.secrets != { }) {
-    assertions = [{
-      assertion = cfg.identityPaths != [ ];
+  config = mkIf (cfg.secrets != {}) {
+    assertions = [
+      {
+        assertion = cfg.identityPaths != [];
         message = "age.identityPaths must be set.";
-    }];
+      }
+    ];
 
     # Create a new directory full of secrets for symlinking (this helps
     # ensure removed secrets are actually removed, or at least become
@@ -218,7 +230,7 @@ in
     };
 
     # So user passwords can be encrypted.
-    system.activationScripts.users.deps = [ "agenixInstall" ];
+    system.activationScripts.users.deps = ["agenixInstall"];
 
     # Change ownership and group after users and groups are made.
     system.activationScripts.agenixChown = {
@@ -232,8 +244,7 @@ in
     # So other activation scripts can depend on agenix being done.
     system.activationScripts.agenix = {
       text = "";
-      deps = [ "agenixChown"];
+      deps = ["agenixChown"];
     };
   };
-
 }

overlay.nix

@@ -1,4 +1,3 @@
-final: prev:
-{
-  agenix = prev.callPackage ./pkgs/agenix.nix { };
+final: prev: {
+  agenix = prev.callPackage ./pkgs/agenix.nix {};
 }

pkgs/agenix.nix

@@ -13,20 +13,19 @@
     if rage.version < "0.5.0"
     then callPackage ./rage.nix {}
     else rage
-  }/bin/rage"
-} :
-let
+  }/bin/rage",
+}: let
   sedBin = "${gnused}/bin/sed";
   nixInstantiate = "${nix}/bin/nix-instantiate";
   mktempBin = "${mktemp}/bin/mktemp";
   diffBin = "${diffutils}/bin/diff";
 in
-lib.recursiveUpdate (writeShellScriptBin "agenix" ''
-set -Eeuo pipefail
+  lib.recursiveUpdate (writeShellScriptBin "agenix" ''
+    set -Eeuo pipefail
 
-PACKAGE="agenix"
+    PACKAGE="agenix"
 
-function show_help () {
+    function show_help () {
       echo "$PACKAGE - edit and rekey age secret files"
       echo " "
       echo "$PACKAGE -e FILE [-i PRIVATE_KEY]"
@@ -51,14 +50,14 @@ function show_help () {
       echo "agenix version: 0.13.0"
       echo "age binary path: ${ageBin}"
       echo "age version: $(${ageBin} --version)"
-}
+    }
 
-test $# -eq 0 && (show_help && exit 1)
+    test $# -eq 0 && (show_help && exit 1)
 
-REKEY=0
-DEFAULT_DECRYPT=(--decrypt)
+    REKEY=0
+    DEFAULT_DECRYPT=(--decrypt)
 
-while test $# -gt 0; do
+    while test $# -gt 0; do
       case "$1" in
         -h|--help)
           show_help
@@ -97,11 +96,11 @@ while test $# -gt 0; do
           exit 1
           ;;
       esac
-done
+    done
 
-RULES=''${RULES:-./secrets.nix}
+    RULES=''${RULES:-./secrets.nix}
 
-function cleanup {
+    function cleanup {
         if [ ! -z ''${CLEARTEXT_DIR+x} ]
         then
             rm -rf "$CLEARTEXT_DIR"
@@ -110,10 +109,10 @@ function cleanup {
         then
             rm -rf "$REENCRYPTED_DIR"
         fi
-}
-trap "cleanup" 0 2 3 15
+    }
+    trap "cleanup" 0 2 3 15
 
-function edit {
+    function edit {
         FILE=$1
         KEYS=$((${nixInstantiate} --eval -E "(let rules = import $RULES; in builtins.concatStringsSep \"\n\" rules.\"$FILE\".publicKeys)" | ${sedBin} 's/"//g' | ${sedBin} 's/\\n/\n/g') | ${sedBin} '/^$/d' || exit 1)
 
@@ -167,9 +166,9 @@ function edit {
         ${ageBin} "''${ENCRYPT[@]}" <"$CLEARTEXT_FILE" || exit 1
 
         mv -f "$REENCRYPTED_FILE" "$1"
-}
+    }
 
-function rekey {
+    function rekey {
         FILES=$((${nixInstantiate} --eval -E "(let rules = import $RULES; in builtins.concatStringsSep \"\n\" (builtins.attrNames rules))"  | ${sedBin} 's/"//g' | ${sedBin} 's/\\n/\n/g') || exit 1)
 
         for FILE in $FILES
@@ -178,12 +177,11 @@ function rekey {
             EDITOR=: edit "$FILE"
             cleanup
         done
-}
+    }
 
-[ $REKEY -eq 1 ] && rekey && exit 0
-edit "$FILE" && cleanup && exit 0
-'')
-
-{
+    [ $REKEY -eq 1 ] && rekey && exit 0
+    edit "$FILE" && cleanup && exit 0
+  '')
+  {
     meta.description = "age-encrypted secrets for NixOS";
-}
+  }

pkgs/rage.nix

@@ -1,5 +1,10 @@
-{ stdenv, rustPlatform, fetchFromGitHub, installShellFiles, darwin }:
-
+{
+  stdenv,
+  rustPlatform,
+  fetchFromGitHub,
+  installShellFiles,
+  darwin,
+}:
 rustPlatform.buildRustPackage rec {
   pname = "rage";
   version = "0.5.0";
@@ -13,9 +18,10 @@ rustPlatform.buildRustPackage rec {
 
   cargoSha256 = "sha256-GPr5zxeODAjD+ynp/nned9gZUiReYcdzosuEbLIKZSs=";
 
-  nativeBuildInputs = [ installShellFiles ];
+  nativeBuildInputs = [installShellFiles];
 
-  buildInputs = with darwin.apple_sdk.frameworks; stdenv.lib.optionals stdenv.isDarwin [
+  buildInputs = with darwin.apple_sdk.frameworks;
+    stdenv.lib.optionals stdenv.isDarwin [
       Security
       Foundation
     ];
@@ -37,7 +43,7 @@ rustPlatform.buildRustPackage rec {
     description = "A simple, secure and modern encryption tool with small explicit keys, no config options, and UNIX-style composability";
     homepage = "https://github.com/str4d/rage";
     changelog = "https://github.com/str4d/rage/releases/tag/v${version}";
-    license = with licenses; [ asl20 mit ]; # either at your option
-    maintainers = with maintainers; [ marsam ryantm ];
+    license = with licenses; [asl20 mit]; # either at your option
+    maintainers = with maintainers; [marsam ryantm];
   };
 }

test/install_ssh_host_keys.nix

@@ -1,6 +1,6 @@
 # Do not copy this! It is insecure. This is only okay because we are testing.
 {
-  system.activationScripts.agenixInstall.deps = [ "installSSHHostKeys" ];
+  system.activationScripts.agenixInstall.deps = ["installSSHHostKeys"];
 
   system.activationScripts.installSSHHostKeys.text = ''
     mkdir -p /etc/ssh

test/integration.nix

@@ -1,14 +1,20 @@
 {
-nixpkgs ? <nixpkgs>,
-pkgs ? import <nixpkgs> { inherit system; config = {}; },
-system ? builtins.currentSystem
-} @args:
-
-import "${nixpkgs}/nixos/tests/make-test-python.nix" ({ pkgs, ...}: {
+  nixpkgs ? <nixpkgs>,
+  pkgs ?
+    import <nixpkgs> {
+      inherit system;
+      config = {};
+    },
+  system ? builtins.currentSystem,
+} @ args:
+import "${nixpkgs}/nixos/tests/make-test-python.nix" ({pkgs, ...}: {
   name = "agenix-integration";
 
-  nodes.system1 = { config, lib, ... }: {
-
+  nodes.system1 = {
+    config,
+    lib,
+    ...
+  }: {
     imports = [
       ../modules/age.nix
       ./install_ssh_host_keys.nix
@@ -30,11 +36,9 @@ import "${nixpkgs}/nixos/tests/make-test-python.nix" ({ pkgs, ...}: {
         };
       };
     };
-
   };
 
-  testScript =
-  let
+  testScript = let
     user = "user1";
     password = "password1234";
   in ''
@@ -55,4 +59,5 @@ import "${nixpkgs}/nixos/tests/make-test-python.nix" ({ pkgs, ...}: {
     system1.wait_for_file("/tmp/1")
     assert "${user}" in system1.succeed("cat /tmp/1")
   '';
-}) args
+})
+args