aboutsummaryrefslogtreecommitdiff
path: root/readme.md
blob: 7733ab6d17a933b60cd39570bcfbb1ad04677fa6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# nm-pass

This is a simple daemon that registers a "[NetworkManager Secret
Agent][secret-agent]" D-Bus agent which reads network passwords from
[pass][password-store]. This can be used to ensure sensitive network passwords
are not saved in plain-text on disk.

When nmpassswd is able to provide a password for a network, the connection will
automatically be updated to not store its password under
`/etc/NetworkManager/system-connections`.

[secret-agent]: https://networkmanager.dev/docs/api/latest/gdbus-org.freedesktop.NetworkManager.SecretAgent.html
[password-store]: https://www.passwordstore.org

## setup

```
$ pip install .
```

And run

```
$ nmpassd
```

when starting your user session.

## configuration

The `NMPASS_FORMAT` environment variable can be set to configure the format
used to lookup passwords. The default format is `net/{ssid}`.