breeze/flake.nix

226 lines
6.9 KiB
Nix
Raw Normal View History

2024-06-16 17:09:06 -05:00
{
description = "breeze file server";
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
crane.url = "github:ipetkov/crane";
flake-utils.url = "github:numtide/flake-utils";
};
2024-09-21 17:36:43 -05:00
outputs = {
self,
nixpkgs,
crane,
flake-utils,
...
}:
flake-utils.lib.eachDefaultSystem (system: let
2024-09-07 18:29:29 -05:00
pkgs = nixpkgs.legacyPackages.${system};
2024-06-16 17:09:06 -05:00
2024-09-07 18:29:29 -05:00
craneLib = crane.mkLib pkgs;
2024-06-16 17:09:06 -05:00
2024-09-07 18:29:29 -05:00
# Common arguments can be set here to avoid repeating them later
# Note: changes here will rebuild all dependency crates
commonArgs = {
src = craneLib.cleanCargoSource ./.;
strictDeps = true;
2024-06-16 17:09:06 -05:00
2024-09-07 18:29:29 -05:00
buildInputs =
[
pkgs.openssl
]
++ pkgs.lib.optionals pkgs.stdenv.isDarwin [
# Additional darwin specific inputs can be set here
pkgs.libiconv
];
};
2024-06-16 17:09:06 -05:00
2024-09-07 18:29:29 -05:00
breeze = craneLib.buildPackage (commonArgs
// {
2024-09-21 17:36:43 -05:00
cargoArtifacts = craneLib.buildDepsOnly commonArgs;
# Additional environment variables or build phases/hooks can be set
# here *without* rebuilding all dependency crates
# MY_CUSTOM_VAR = "some value";
});
in {
2024-09-07 18:29:29 -05:00
checks = {
inherit breeze;
};
2024-06-16 17:09:06 -05:00
2024-09-07 18:29:29 -05:00
packages.default = breeze;
2024-06-16 17:09:06 -05:00
2024-09-07 18:29:29 -05:00
apps.default = flake-utils.lib.mkApp {
drv = breeze;
};
2024-06-16 17:09:06 -05:00
2024-09-07 18:29:29 -05:00
devShells.default = craneLib.devShell {
# Inherit inputs from checks.
checks = self.checks.${system};
2024-06-16 17:09:06 -05:00
2024-09-07 18:29:29 -05:00
# Additional dev-shell environment variables can be set directly
# MY_CUSTOM_DEVELOPMENT_VAR = "something else";
2024-06-16 17:09:06 -05:00
2024-09-07 18:29:29 -05:00
# Extra inputs can be added here; cargo and rustc are provided by default.
2024-09-08 17:36:44 -05:00
packages = with pkgs; [
alejandra
rewrk
2024-09-07 18:29:29 -05:00
];
};
2024-09-08 17:36:44 -05:00
2024-09-21 17:36:43 -05:00
nixosModules.breeze = {
config,
pkgs,
lib,
...
}:
with lib; let
cfg = config.services.breeze;
settingsFormat = pkgs.formats.toml {};
in {
options = {
services.breeze = {
enable = mkEnableOption "breeze file server";
package = mkOption {
type = types.package;
default = breeze;
description = "Package for `breeze` to use";
};
user = mkOption {
type = types.str;
default = "breeze";
description = "User that `breeze` will run under";
};
group = mkOption {
type = types.str;
default = "breeze";
description = "Group that `breeze` will run under";
};
extraGroups = mkOption {
type = types.listOf types.str;
default = [];
description = "Any supplementary groups for `breeze` to run under";
2024-09-08 17:36:44 -05:00
};
2024-09-21 17:36:43 -05:00
settings = mkOption {
type = settingsFormat.type;
default = {};
description = ''
The *.toml configuration to run `breeze` with.
There is no formal documentation, but there is an example in the [readme](https://git.min.rip/min/breeze/src/branch/main/README.md).
'';
2024-09-08 17:36:44 -05:00
};
2024-09-21 17:36:43 -05:00
configDir = mkOption {
type = types.path;
default = "/etc/breeze";
description = ''
The directory on disk to store the `breeze` config file in.
This does not load pre-existing config files, it only defines where the generated config is saved.
'';
};
uploadKeyFile = mkOption {
type = types.nullOr types.path;
default = null;
description = ''
File to load the `engine.upload_key` from, if desired.
This is useful for loading it from a secret management system.
'';
};
};
};
config = mkIf cfg.enable {
users.users.${cfg.user} = {
isSystemUser = true;
inherit (cfg) group;
};
users.groups.${cfg.group} = {};
systemd.tmpfiles.rules = [
"d '${cfg.configDir}' 0750 ${cfg.user} ${cfg.group} - -"
];
services.breeze.settings = mkMerge [
(mkIf (cfg.uploadKeyFile != null) {engine.upload_key = "@UPLOAD_KEY@";})
];
systemd.services.breeze = let
cfgFile = "${cfg.configDir}/breeze.toml";
in {
description = "breeze file server";
after = ["local-fs.target" "network.target"];
wantedBy = ["multi-user.target"];
preStart =
''
install -m 660 ${settingsFormat.generate "breeze.toml" cfg.settings} ${cfgFile}
''
+ lib.optionalString (cfg.uploadKeyFile != null) ''
${pkgs.replace-secret}/bin/replace-secret '@UPLOAD_KEY@' "${cfg.uploadKeyFile}" ${cfgFile}
'';
serviceConfig = rec {
User = cfg.user;
Group = cfg.group;
DynamicUser = false; # we write files, so don't do that
SupplementaryGroups = cfg.extraGroups;
StateDirectory = "breeze";
CacheDirectory = "breeze";
ExecStart = escapeShellArgs [
"${cfg.package}/bin/breeze"
"--config"
cfgFile
];
Restart = "on-failure";
# Security Options #
NoNewPrivileges = true; # implied by DynamicUser
RemoveIPC = true; # implied by DynamicUser
AmbientCapabilities = "";
CapabilityBoundingSet = "";
DeviceAllow = "";
LockPersonality = true;
PrivateTmp = true; # implied by DynamicUser
PrivateDevices = true;
PrivateUsers = true;
ProtectClock = true;
ProtectControlGroups = true;
ProtectHostname = true;
ProtectKernelLogs = true;
ProtectKernelModules = true;
ProtectKernelTunables = true;
RestrictNamespaces = true;
RestrictAddressFamilies = ["AF_INET" "AF_INET6" "AF_UNIX"];
RestrictRealtime = true;
RestrictSUIDSGID = true; # implied by DynamicUser
SystemCallArchitectures = "native";
SystemCallErrorNumber = "EPERM";
SystemCallFilter = [
"@system-service"
"~@keyring"
"~@memlock"
"~@privileged"
"~@setuid"
];
2024-09-08 17:36:44 -05:00
};
};
};
2024-09-21 17:36:43 -05:00
};
2024-09-07 18:29:29 -05:00
});
2024-06-16 17:09:06 -05:00
}