mirror of
https://github.com/jmcorgan/fips.git
synced 2026-08-10 08:37:02 +00:00
Follow the macOS install layout for config, ACL, and identity paths
The macOS packaging installs config under /usr/local/etc/fips, wired through the launchd plist and build-pkg.sh, but the default-path constants and the config search path were hardcoded to /etc/fips for all Unix. On macOS the daemon and fipsctl therefore looked in a directory that does not exist: the ACL and host-map loaders hit their NotFound no-op arm and returned empty state, so a populated peers.deny reported effective_mode "default_open" with enforcement inactive, and host-file aliases went unloaded, with no error. The peers.allow, peers.deny and hosts defaults now follow the platform's packaging, and fipsctl keygen writes its identity there too. The config search path keeps probing /etc/fips first and adds /usr/local/etc/fips after it, so an existing install keeps working across the upgrade and the packaged file still wins over a stale leftover. Both the macOS search-path entry and the keygen output directory read one SYSTEM_CONFIG_DIR constant, so they cannot drift apart. At startup the daemon warns once about hosts, peers.allow or peers.deny stranded at the old location; the config file is deliberately excluded, since both directories stay on the search path and a config left behind is still read. The control-socket snapshot tests repoint the ACL reloader at non-existent paths under the temp dir, so the snapshot no longer reflects whatever ACL files happen to exist on the machine running the tests. Platform-gated unit tests pin both layouts, so a future refactor cannot silently drift either one. Linux and Windows behavior is unchanged. Adding a second system config directory moves the directory the daemon derives the identity key path from, since that comes from whichever config file loaded last. A host carrying fips.yaml at both locations would have resolved fips.key to the new directory, found none, and under persistent generated a fresh identity, silently changing its npub, routing address and mesh IPv6 with no migration path. The daemon now adopts a key stranded at the legacy path and warns to move it rather than generating one. The fallback is confined to keys resolved from the system config directory, so a run using ./fips.yaml or a user config is never redirected to a system key. Co-authored-by: Johnathan Corgan <johnathan@corganlabs.com>
This commit is contained in:
committed by
Johnathan Corgan
co-authored by
Johnathan Corgan
parent
0155345984
commit
cdb03c76b0
@@ -72,6 +72,49 @@ present after the first successful daemon start. If the daemon never
|
||||
came up cleanly (config error, permission problem), the key files
|
||||
will be missing.
|
||||
|
||||
### macOS note
|
||||
|
||||
The macOS package (`.pkg`) installs config and keys under
|
||||
`/usr/local/etc/fips/` instead of `/etc/fips/`. The paths above become:
|
||||
|
||||
| Linux / other Unix | macOS |
|
||||
| --- | --- |
|
||||
| `/etc/fips/fips.yaml` | `/usr/local/etc/fips/fips.yaml` |
|
||||
| `/etc/fips/fips.key` | `/usr/local/etc/fips/fips.key` |
|
||||
| `/etc/fips/fips.pub` | `/usr/local/etc/fips/fips.pub` |
|
||||
|
||||
`fipsctl keygen` writes to `/usr/local/etc/fips/` by default on macOS.
|
||||
The daemon still probes `/etc/fips/fips.yaml` as a fallback (so an
|
||||
existing install is not broken by an upgrade), but the macOS packaging
|
||||
only installs files under `/usr/local/etc/fips/`.
|
||||
|
||||
If you have files in `/etc/fips/` from a manual install, move them:
|
||||
|
||||
```sh
|
||||
sudo mv /etc/fips/fips.yaml /usr/local/etc/fips/fips.yaml
|
||||
sudo mv /etc/fips/fips.key /usr/local/etc/fips/fips.key
|
||||
sudo mv /etc/fips/fips.pub /usr/local/etc/fips/fips.pub
|
||||
sudo mv /etc/fips/peers.allow /usr/local/etc/fips/peers.allow 2>/dev/null || true
|
||||
sudo mv /etc/fips/peers.deny /usr/local/etc/fips/peers.deny 2>/dev/null || true
|
||||
sudo mv /etc/fips/hosts /usr/local/etc/fips/hosts 2>/dev/null || true
|
||||
```
|
||||
|
||||
The daemon logs a warning at startup if any of `peers.allow`, `peers.deny`,
|
||||
or `hosts` exist at the old `/etc/fips/` path but not at
|
||||
`/usr/local/etc/fips/`. `fips.yaml` is deliberately not included: both
|
||||
directories stay on the config search path, so a config file left at
|
||||
`/etc/fips/` is still read and is not a stranded file.
|
||||
|
||||
`fips.key` is handled differently again, because losing it is worse than
|
||||
not reading it. The daemon derives the key directory from whichever config
|
||||
file loaded last, so a host carrying `fips.yaml` at both locations resolves
|
||||
the key to `/usr/local/etc/fips/`. If no key is there and one exists at
|
||||
`/etc/fips/fips.key`, the daemon **uses the old key and warns**, rather than
|
||||
generating a new identity: a fresh keypair would change the node's npub,
|
||||
routing address and mesh IPv6 with no migration path. Move the key when you
|
||||
see that warning; the fallback exists to make the upgrade survivable, not
|
||||
to be relied on.
|
||||
|
||||
### File layout and permissions
|
||||
|
||||
| Path | Mode | Owner | Contents |
|
||||
|
||||
@@ -66,7 +66,7 @@ highest-priority value wins.
|
||||
|
||||
| Priority | Path | Purpose |
|
||||
| -------- | ---- | ------- |
|
||||
| 1 | `/etc/fips/fips.yaml` | System-wide defaults |
|
||||
| 1 | `/usr/local/etc/fips/fips.yaml` (macOS), `/etc/fips/fips.yaml` (other Unix) | System-wide defaults |
|
||||
| 2 | `~/.config/fips/fips.yaml` | User preferences |
|
||||
| 3 | `~/.fips.yaml` | Legacy user config |
|
||||
| 4 | `./fips.yaml` | Deployment-specific overrides |
|
||||
|
||||
@@ -89,7 +89,7 @@ daemon.
|
||||
|
||||
| Flag | Argument | Default | Description |
|
||||
| ---- | -------- | ------- | ----------- |
|
||||
| `-d`, `--dir` | `DIR` | `/etc/fips` (Unix), `%APPDATA%\fips` (Windows) | Output directory for `fips.key` and `fips.pub`. |
|
||||
| `-d`, `--dir` | `DIR` | `/usr/local/etc/fips` (macOS), `/etc/fips` (other Unix), `%APPDATA%\fips` (Windows) | Output directory for `fips.key` and `fips.pub`. Matches the directory the platform's packaging installs config into, which is where the daemon derives the key paths from. |
|
||||
| `-f`, `--force` | — | off | Overwrite an existing `fips.key`. |
|
||||
| `-s`, `--stdout` | — | off | Print `nsec` then `npub` to stdout instead of writing files. |
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ locations, lowest to highest priority:
|
||||
|
||||
| Priority | Path | Purpose |
|
||||
|----------|------|---------|
|
||||
| 1 (lowest) | `/etc/fips/fips.yaml` | System-wide defaults |
|
||||
| 1 (lowest) | `/usr/local/etc/fips/fips.yaml` (macOS), `/etc/fips/fips.yaml` (other Unix) | System-wide defaults |
|
||||
| 2 | `~/.config/fips/fips.yaml` | User preferences |
|
||||
| 3 | `~/.fips.yaml` | Legacy user config |
|
||||
| 4 (highest) | `./fips.yaml` | Deployment-specific overrides |
|
||||
|
||||
Reference in New Issue
Block a user