mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-12-15 10:12:58 +00:00
c0846f900a
New module to run the python-matter-server executable as a sandboxed system service.
126 lines
3.6 KiB
Nix
126 lines
3.6 KiB
Nix
{ lib
|
|
, pkgs
|
|
, config
|
|
, ...
|
|
}:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.matter-server;
|
|
storageDir = "matter-server";
|
|
storagePath = "/var/lib/${storageDir}";
|
|
vendorId = "4939"; # home-assistant vendor ID
|
|
in
|
|
|
|
{
|
|
meta.maintainers = with lib.maintainers; [ leonm1 ];
|
|
|
|
options.services.matter-server = with types; {
|
|
enable = mkEnableOption (lib.mdDoc "Matter-server");
|
|
|
|
package = mkPackageOptionMD pkgs "python-matter-server" { };
|
|
|
|
port = mkOption {
|
|
type = types.port;
|
|
default = 5580;
|
|
description = "Port to expose the matter-server service on.";
|
|
};
|
|
|
|
logLevel = mkOption {
|
|
type = types.enum [ "critical" "error" "warning" "info" "debug" ];
|
|
default = "info";
|
|
description = "Verbosity of logs from the matter-server";
|
|
};
|
|
|
|
extraArgs = mkOption {
|
|
type = listOf str;
|
|
default = [];
|
|
description = ''
|
|
Extra arguments to pass to the matter-server executable.
|
|
See https://github.com/home-assistant-libs/python-matter-server?tab=readme-ov-file#running-the-development-server for options.
|
|
'';
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
systemd.services.matter-server = {
|
|
after = [ "network-online.target" ];
|
|
before = [ "home-assistant.service" ];
|
|
wants = [ "network-online.target" ];
|
|
wantedBy = [ "multi-user.target" ];
|
|
description = "Matter Server";
|
|
environment.HOME = storagePath;
|
|
serviceConfig = {
|
|
ExecStart = (concatStringsSep " " [
|
|
"${cfg.package}/bin/matter-server"
|
|
"--port" (toString cfg.port)
|
|
"--vendorid" vendorId
|
|
"--storage-path" storagePath
|
|
"--log-level" "${cfg.logLevel}"
|
|
"${escapeShellArgs cfg.extraArgs}"
|
|
]);
|
|
# Start with a clean root filesystem, and allowlist what the container
|
|
# is permitted to access.
|
|
TemporaryFileSystem = "/";
|
|
# Allowlist /nix/store (to allow the binary to find its dependencies)
|
|
# and dbus.
|
|
ReadOnlyPaths = "/nix/store /run/dbus";
|
|
# Let systemd manage `/var/lib/matter-server` for us inside the
|
|
# ephemeral TemporaryFileSystem.
|
|
StateDirectory = storageDir;
|
|
# `python-matter-server` writes to /data even when a storage-path is
|
|
# specified. This bind-mount points /data at the systemd-managed
|
|
# /var/lib/matter-server, so all files get dropped into the state
|
|
# directory.
|
|
BindPaths = "${storagePath}:/data";
|
|
|
|
# Hardening bits
|
|
AmbientCapabilities = "";
|
|
CapabilityBoundingSet = "";
|
|
DevicePolicy = "closed";
|
|
DynamicUser = true;
|
|
LockPersonality = true;
|
|
MemoryDenyWriteExecute = true;
|
|
NoNewPrivileges = true;
|
|
PrivateDevices = true;
|
|
PrivateTmp = true;
|
|
PrivateUsers = true;
|
|
ProcSubset = "pid";
|
|
ProtectClock = true;
|
|
ProtectControlGroups = true;
|
|
ProtectHome = true;
|
|
ProtectHostname = true;
|
|
ProtectKernelLogs = true;
|
|
ProtectKernelModules = true;
|
|
ProtectKernelTunables = true;
|
|
ProtectProc = "invisible";
|
|
RestrictAddressFamilies = [
|
|
"AF_INET"
|
|
"AF_INET6"
|
|
"AF_NETLINK"
|
|
];
|
|
RestrictNamespaces = true;
|
|
RestrictRealtime = true;
|
|
RestrictSUIDSGID = true;
|
|
SystemCallFilter = concatStringsSep " " [
|
|
"~" # Blocklist
|
|
"@clock"
|
|
"@cpu-emulation"
|
|
"@debug"
|
|
"@module"
|
|
"@mount"
|
|
"@obsolete"
|
|
"@privileged"
|
|
"@raw-io"
|
|
"@reboot"
|
|
"@resources"
|
|
"@swap"
|
|
];
|
|
UMask = "0077";
|
|
};
|
|
};
|
|
};
|
|
}
|
|
|