feat: add NixOS module for declarative deployment

Adds nixos-module.nix with services.oubliette options (enable, package,
settings, configFile) and a hardened systemd service. Exposes the module
as nixosModules.default in flake.nix.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-02-14 17:01:31 +01:00
parent 8e8f5366be
commit 75bac814d4
3 changed files with 88 additions and 0 deletions

View File

@@ -46,3 +46,25 @@ Test with:
```sh
ssh -o StrictHostKeyChecking=no -p 2222 root@localhost
```
### NixOS Module
Add the flake as an input and enable the service:
```nix
{
services.oubliette = {
enable = true;
package = inputs.oubliette.packages.${system}.default;
settings = {
ssh.listen_addr = ":2222";
auth.accept_after = 10;
auth.static_credentials = [
{ username = "root"; password = "toor"; }
];
};
};
}
```
Alternatively, use `configFile` to pass a pre-written TOML file instead of `settings`.

View File

@@ -11,6 +11,8 @@
forAllSystems = nixpkgs.lib.genAttrs supportedSystems;
in
{
nixosModules.default = import ./nixos-module.nix;
packages = forAllSystems (system:
let
pkgs = nixpkgs.legacyPackages.${system};

64
nixos-module.nix Normal file
View File

@@ -0,0 +1,64 @@
{ config, lib, pkgs, ... }:
let
cfg = config.services.oubliette;
tomlFormat = pkgs.formats.toml { };
configFile =
if cfg.configFile != null
then cfg.configFile
else tomlFormat.generate "oubliette.toml" cfg.settings;
in
{
options.services.oubliette = {
enable = lib.mkEnableOption "Oubliette SSH honeypot";
package = lib.mkPackageOption pkgs "oubliette" { };
configFile = lib.mkOption {
type = lib.types.nullOr lib.types.path;
default = null;
description = ''
Path to a pre-written TOML configuration file.
Mutually exclusive with {option}`settings`.
'';
};
settings = lib.mkOption {
type = tomlFormat.type;
default = { };
description = ''
Configuration for Oubliette as a Nix attribute set.
Will be converted to TOML. Mutually exclusive with {option}`configFile`.
See oubliette.toml.example for available options.
'';
};
};
config = lib.mkIf cfg.enable {
assertions = [
{
assertion = !(cfg.configFile != null && cfg.settings != { });
message = "services.oubliette: `configFile` and `settings` are mutually exclusive.";
}
];
services.oubliette.settings.ssh.host_key_path = lib.mkDefault "/var/lib/oubliette/host_key";
systemd.services.oubliette = {
description = "Oubliette SSH Honeypot";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
serviceConfig = {
ExecStart = "${lib.getExe cfg.package} -config ${configFile}";
DynamicUser = true;
StateDirectory = "oubliette";
NoNewPrivileges = true;
ProtectSystem = "strict";
ProtectHome = true;
ReadWritePaths = [ "/var/lib/oubliette" ];
};
};
};
}