2e751c0772
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
135 lines
4.8 KiB
Nix
135 lines
4.8 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
format = pkgs.formats.yaml {};
|
|
in
|
|
{
|
|
options.services.pomerium = {
|
|
enable = mkEnableOption "the Pomerium authenticating reverse proxy";
|
|
|
|
configFile = mkOption {
|
|
type = with types; nullOr path;
|
|
default = null;
|
|
description = lib.mdDoc "Path to Pomerium config YAML. If set, overrides services.pomerium.settings.";
|
|
};
|
|
|
|
useACMEHost = mkOption {
|
|
type = with types; nullOr str;
|
|
default = null;
|
|
description = lib.mdDoc ''
|
|
If set, use a NixOS-generated ACME certificate with the specified name.
|
|
|
|
Note that this will require you to use a non-HTTP-based challenge, or
|
|
disable Pomerium's in-built HTTP redirect server by setting
|
|
http_redirect_addr to null and use a different HTTP server for serving
|
|
the challenge response.
|
|
|
|
If you're using an HTTP-based challenge, you should use the
|
|
Pomerium-native autocert option instead.
|
|
'';
|
|
};
|
|
|
|
settings = mkOption {
|
|
description = lib.mdDoc ''
|
|
The contents of Pomerium's config.yaml, in Nix expressions.
|
|
|
|
Specifying configFile will override this in its entirety.
|
|
|
|
See [the Pomerium
|
|
configuration reference](https://pomerium.io/reference/) for more information about what to put
|
|
here.
|
|
'';
|
|
default = {};
|
|
type = format.type;
|
|
};
|
|
|
|
secretsFile = mkOption {
|
|
type = with types; nullOr path;
|
|
default = null;
|
|
description = lib.mdDoc ''
|
|
Path to file containing secrets for Pomerium, in systemd
|
|
EnvironmentFile format. See the systemd.exec(5) man page.
|
|
'';
|
|
};
|
|
};
|
|
|
|
config = let
|
|
cfg = config.services.pomerium;
|
|
cfgFile = if cfg.configFile != null then cfg.configFile else (format.generate "pomerium.yaml" cfg.settings);
|
|
in mkIf cfg.enable ({
|
|
systemd.services.pomerium = {
|
|
description = "Pomerium authenticating reverse proxy";
|
|
wants = [ "network.target" ] ++ (optional (cfg.useACMEHost != null) "acme-finished-${cfg.useACMEHost}.target");
|
|
after = [ "network.target" ] ++ (optional (cfg.useACMEHost != null) "acme-finished-${cfg.useACMEHost}.target");
|
|
wantedBy = [ "multi-user.target" ];
|
|
environment = optionalAttrs (cfg.useACMEHost != null) {
|
|
CERTIFICATE_FILE = "fullchain.pem";
|
|
CERTIFICATE_KEY_FILE = "key.pem";
|
|
};
|
|
startLimitIntervalSec = 60;
|
|
script = ''
|
|
if [[ -v CREDENTIALS_DIRECTORY ]]; then
|
|
cd "$CREDENTIALS_DIRECTORY"
|
|
fi
|
|
exec "${pkgs.pomerium}/bin/pomerium" -config "${cfgFile}"
|
|
'';
|
|
|
|
serviceConfig = {
|
|
DynamicUser = true;
|
|
StateDirectory = [ "pomerium" ];
|
|
|
|
PrivateUsers = false; # breaks CAP_NET_BIND_SERVICE
|
|
MemoryDenyWriteExecute = false; # breaks LuaJIT
|
|
|
|
NoNewPrivileges = true;
|
|
PrivateTmp = true;
|
|
PrivateDevices = true;
|
|
DevicePolicy = "closed";
|
|
ProtectSystem = "strict";
|
|
ProtectHome = true;
|
|
ProtectControlGroups = true;
|
|
ProtectKernelModules = true;
|
|
ProtectKernelTunables = true;
|
|
ProtectKernelLogs = true;
|
|
RestrictAddressFamilies = "AF_UNIX AF_INET AF_INET6 AF_NETLINK";
|
|
RestrictNamespaces = true;
|
|
RestrictRealtime = true;
|
|
RestrictSUIDSGID = true;
|
|
LockPersonality = true;
|
|
SystemCallArchitectures = "native";
|
|
|
|
EnvironmentFile = cfg.secretsFile;
|
|
AmbientCapabilities = [ "CAP_NET_BIND_SERVICE" ];
|
|
CapabilityBoundingSet = [ "CAP_NET_BIND_SERVICE" ];
|
|
|
|
LoadCredential = optionals (cfg.useACMEHost != null) [
|
|
"fullchain.pem:/var/lib/acme/${cfg.useACMEHost}/fullchain.pem"
|
|
"key.pem:/var/lib/acme/${cfg.useACMEHost}/key.pem"
|
|
];
|
|
};
|
|
};
|
|
|
|
# postRun hooks on cert renew can't be used to restart Nginx since renewal
|
|
# runs as the unprivileged acme user. sslTargets are added to wantedBy + before
|
|
# which allows the acme-finished-$cert.target to signify the successful updating
|
|
# of certs end-to-end.
|
|
systemd.services.pomerium-config-reload = mkIf (cfg.useACMEHost != null) {
|
|
# TODO(lukegb): figure out how to make config reloading work with credentials.
|
|
|
|
wantedBy = [ "acme-finished-${cfg.useACMEHost}.target" "multi-user.target" ];
|
|
# Before the finished targets, after the renew services.
|
|
before = [ "acme-finished-${cfg.useACMEHost}.target" ];
|
|
after = [ "acme-${cfg.useACMEHost}.service" ];
|
|
# Block reloading if not all certs exist yet.
|
|
unitConfig.ConditionPathExists = [ "${config.security.acme.certs.${cfg.useACMEHost}.directory}/fullchain.pem" ];
|
|
serviceConfig = {
|
|
Type = "oneshot";
|
|
TimeoutSec = 60;
|
|
ExecCondition = "/run/current-system/systemd/bin/systemctl -q is-active pomerium.service";
|
|
ExecStart = "/run/current-system/systemd/bin/systemctl --no-block restart pomerium.service";
|
|
};
|
|
};
|
|
});
|
|
}
|