https://github.com/cjermain/gnome-gocryptfs
gocryptfs managed with the GNOME keyring (fork of gnome-encfs)
https://github.com/cjermain/gnome-gocryptfs
gnome gnome-gocryptfs gocryptfs keyring
Last synced: about 1 year ago
JSON representation
gocryptfs managed with the GNOME keyring (fork of gnome-encfs)
- Host: GitHub
- URL: https://github.com/cjermain/gnome-gocryptfs
- Owner: cjermain
- License: gpl-3.0
- Created: 2020-01-19T01:23:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-15T15:08:16.000Z (over 2 years ago)
- Last Synced: 2025-03-22T11:24:28.824Z (over 1 year ago)
- Topics: gnome, gnome-gocryptfs, gocryptfs, keyring
- Language: Python
- Homepage:
- Size: 131 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
gnome-gocryptfs
===============
*gnome-gocryptfs* integrates [gocryptfs][cfs] folders into the GNOME desktop by storing
their passwords in the [keyring][gkr] and optionally mounting them at login
using GNOME's autostart mechanism. This package is a fork of the [gnome-encfs][gef]
project.
*gnome-gocryptfs* allows you to use strong passwords for gocryptfs folders while still
mounting them painlessly (i.e. no password prompt). This is an advantage over
automount solutions like *pam-encfs* and *pam-mount* which require to use the
same password for gocryptfs folders as for your local user account. This is bad
because local account passwords usually are weaker than those one should use
for encrypting online stored data, e.g. in a [Dropbox][dbx].
Download
--------
Checkout the source:
$ git clone https://github.com/cjermain/gnome-gocryptfs
Installation
------------
$ cd /path/to/gnome-gocryptfs
$ install gnome-gocryptfs /usr/local/bin
**Note:** You can run *gnome-gocryptfs* right from the extracted package but to
make use of the automount feature at GNOME login, it must be placed somewhere
in *PATH* (as configured during a login to GNOME). Using the install command
above ensures this requirement is fulfilled.
Usage
-----
### Add a gocryptfs folder
Suppose you have a gocryptfs folder at `~/.Private.encrypted` which should get
mounted to `~/Private`. Make it known to *gnome-gocryptfs*:
$ gnome-gocryptfs add ~/.Private.encrypted ~/Private
gocryptfs config file [-]:
gocryptfs password:
Mount at login [Y/n]:
This adds the gocryptfs path, its mount location and password to the GNOME keyring
and sets up a GNOME autostart entry to mount it at GNOME login (if enabled).
### Mount a gocryptfs folder
If you said *y* above to the login mount question, the gocryptfs folder gets
mounted automatically at GNOME login. If you prefer to mount on demand, you do
that with
$ gnome-gocryptfs mount ~/Private
which looks up the password in the keyring and does the mounting without
the need to enter the password manually.
Unmount based on the path:
$ gnome-gocryptfs unmount ~/Private
which can also take the mount path. Without a path, the unmount command
unmounts all tracked gocryptfs folders.
### Other tasks
You can also show, edit and remove gocryptfs folders handled by *gnome-gocryptfs*:
$ gnome-gocryptfs -h
usage: gnome-gocryptfs [-h] [--version]
{list,mount,unmount,add,edit,remove} ...
Painlessly mount and manage gocryptfs folders using GNOME's keyring.
positional arguments:
{list,mount,unmount,add,edit,remove}
list List all gocryptfs items stored in the keyring
mount Mount all or selected paths stored in the keyring
unmount Unmount all or selected paths stored in the keyring
add Add a new gocryptfs path to the keyring
edit Edit a gocryptfs item in the keyring
remove Remove a gocryptfs item from the keyring
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
...
Usage should be straight forward - otherwise [submit an issue][itr].
### Automatically unmount gocryptfs folders on logout
Unfortunately there's no equivalent to GNOME's autostart scripts which could be
used to automatically unmount your gocryptfs folders on logout (without shutting
down). However, there's a manual solution using a [GDM hook script][gdm]:
`/etc/gdm/PostSession/Default`. Open this file in an editor (requires *root*
privileges) and add these lines:
mount -t fuse.gocryptfs | grep "user=$USER" | awk '{print $3}' | while read MPOINT ; do
sudo -u $USER fusermount -u "$MPOINT"
done
This script is executed whenever you logout from GNOME. With this line, it
looks for mounted gocryptfs folders of the user currently logging out. Then it
unmounts each, using the `fusermount` command (note that this command is
executed as *root*, that's why there is a `sudo -u $USER` before the
`fusermount` command).
This works independent of *gnome-gocryptfs*, i.e. it unmounts **any** gocryptfs folder
of the user logging out.
License
-------
*gnome-gocryptfs* is licensed as [GPL][gpl].
[gef]: https://hg.sr.ht/~obensonne/gnome-encfs
[dbx]: http://dropbox.com
[cfs]: https://nuetzlich.net/gocryptfs/
[gdm]: http://library.gnome.org/admin/gdm/stable/configuration.html
[gkr]: http://live.gnome.org/GnomeKeyring
[gpl]: http://www.gnu.org/licenses/gpl.html
[itr]: https://github.com/cjermain/gnome-gocryptfs/issues