nixos/go-neb: secret support

This commit is contained in:
Jörg Thalheim 2021-06-22 09:07:50 +02:00
parent 00ead2addd
commit 34d1c55580
No known key found for this signature in database
GPG key ID: B3F5D81B0C6967C4
2 changed files with 36 additions and 10 deletions

View file

@ -5,7 +5,8 @@ with lib;
let
cfg = config.services.go-neb;
configFile = pkgs.writeText "config.yml" (builtins.toJSON cfg.config);
settingsFormat = pkgs.formats.yaml {};
configFile = settingsFormat.generate "config.yaml" cfg.config;
in {
options.services.go-neb = {
enable = mkEnableOption "Extensible matrix bot written in Go";
@ -16,13 +17,26 @@ in {
default = ":4050";
};
secretFile = mkOption {
type = types.nullOr types.path;
default = null;
example = "/run/keys/go-neb.env";
description = ''
Environment variables from this file will be interpolated into the
final config file using envsubst with this syntax: <literal>$ENVIRONMENT</literal>
or <literal>''${VARIABLE}</literal>.
The file should contain lines formatted as <literal>SECRET_VAR=SECRET_VALUE</literal>.
This is useful to avoid putting secrets into the nix store.
'';
};
baseUrl = mkOption {
type = types.str;
description = "Public-facing endpoint that can receive webhooks.";
};
config = mkOption {
type = types.uniq types.attrs;
inherit (settingsFormat) type;
description = ''
Your <filename>config.yaml</filename> as a Nix attribute set.
See <link xlink:href="https://github.com/matrix-org/go-neb/blob/master/config.sample.yaml">config.sample.yaml</link>
@ -32,18 +46,30 @@ in {
};
config = mkIf cfg.enable {
systemd.services.go-neb = {
systemd.services.go-neb = let
finalConfigFile = if cfg.secretFile == null then configFile else "/var/run/go-neb/config.yaml";
in {
description = "Extensible matrix bot written in Go";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
environment = {
BASE_URL = cfg.baseUrl;
BIND_ADDRESS = cfg.bindAddress;
CONFIG_FILE = configFile;
CONFIG_FILE = finalConfigFile;
};
serviceConfig = {
ExecStartPre = lib.optional (cfg.secretFile != null)
(pkgs.writeShellScript "pre-start" ''
umask 077
export $(xargs < ${cfg.secretFile})
${pkgs.envsubst}/bin/envsubst -i "${configFile}" > ${finalConfigFile}
chown go-neb ${finalConfigFile}
'');
PermissionsStartOnly = true;
RuntimeDirectory = "go-neb";
ExecStart = "${pkgs.go-neb}/bin/go-neb";
User = "go-neb";
DynamicUser = true;
};
};

View file

@ -10,10 +10,11 @@ import ./make-test-python.nix ({ pkgs, ... }:
services.go-neb = {
enable = true;
baseUrl = "http://localhost";
secretFile = pkgs.writeText "secrets" "ACCESS_TOKEN=changeme";
config = {
clients = [ {
UserId = "@test:localhost";
AccessToken = "changeme";
AccessToken = "$ACCESS_TOKEN";
HomeServerUrl = "http://localhost";
Sync = false;
AutoJoinRooms = false;
@ -33,11 +34,10 @@ import ./make-test-python.nix ({ pkgs, ... }:
testScript = ''
start_all()
server.wait_for_unit("go-neb.service")
server.wait_until_succeeds(
"curl -fL http://localhost:4050/services/hooks/d2lraXBlZGlhX3NlcnZpY2U"
)
server.wait_until_succeeds(
"journalctl -eu go-neb -o cat | grep -q service_id=wikipedia_service"
server.wait_until_succeeds("curl -fL http://localhost:4050/services/hooks/d2lraXBlZGlhX3NlcnZpY2U")
server.succeed(
"journalctl -eu go-neb -o cat | grep -q service_id=wikipedia_service",
"grep -q changeme /var/run/go-neb/config.yaml",
)
'';