Skip to content

Nix module: secure config file#2699

Merged
eikek merged 1 commit intoeikek:masterfrom
ivanbrennan:nix-secure-config
Jul 8, 2024
Merged

Nix module: secure config file#2699
eikek merged 1 commit intoeikek:masterfrom
ivanbrennan:nix-secure-config

Conversation

@ivanbrennan
Copy link
Copy Markdown
Contributor

Update the NixOS module to handle config files more securely.

This addresses some of the low-hanging fruit identified in #2451

1) Stop writing config files to the world-readable nix store

Instead, write to /etc/docspell-restserver.conf and /etc/docspell-joex.conf readable only by the docspell user.

2) Provide a configFile option

Allow the user to specify the path to a config file. They can use this to point to a file they've secured with their preferred secret management scheme (to avoid leaking sensitive info in the nixos configuration itself).

Only generate a config file if this option is left unspecified.


Example usage:
https://codeberg.org/ivanbrennan/nixos-config/commit/0d34b183dfe3e04421cb6044e67d974b83260630

Stop writing docspell config files to the world-readable nix store,
since they contain sensitive info, e.g. database passwords.

Additionally, provide a `configFile` option so users may point to a file
they've secured using their prefered secret management strategy.
@eikek eikek added nix Things regarding nix/nixos setup enhancement New feature or request labels Jul 8, 2024
@eikek eikek added this to the Docspell 0.42.0 milestone Jul 8, 2024
@eikek
Copy link
Copy Markdown
Owner

eikek commented Jul 8, 2024

Thank you very much!

@eikek eikek merged commit 294b04e into eikek:master Jul 8, 2024
@ivanbrennan ivanbrennan deleted the nix-secure-config branch July 8, 2024 11:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request nix Things regarding nix/nixos setup

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants