Skip to content
Python based Gui wrapper for encfs volumes
Python Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bitmaps
.gitignore
LICENSE
README.md
cconfig.py
cgetmasterkey.py
cmountpassword.py
cnewmasterkey.py
csettings.py
cvolume.py
encfsgui.py
encfsgui_globals.py
encfsgui_helper.py
encfsgui_main.ui
encfsgui_masterkey.ui
encfsgui_newmasterkey.ui
encfsgui_password.ui
encfsgui_settings.ui
encfsgui_volume.ui
pyencfsgui.sh

README.md

pyencfsgui

What is pyencfsgui?

pyencfsgui is a Qt based GUI/wrapper around encfs, encfsctl, mount and umount, written in python3, and relies on OSXFuse to provide a filesystem.
In other words, it relies entirely on those utilities, the ability to interact with those tools and to capture & parse the output from those tools.
As a result, the EncFSGui source code is pretty easy to understand, as it does not contain any crypto or other black magic to do its job.
The downside is that it is a wrapper and may break if tools start behaving in a different way.
pyencfsgui was developed and tested on OSX High Sierra, Mojave and OSX Catalina, using encfs versions 1.8.x and 1.9.x.
(It can open existing volumes that have been created with older versions of encfs too)

Dependencies

In order to use pyencfsgui, you need to install the following dependencies:

  • python3
  • python3 libraries: PyQT5, pycrypto
  • OSXFuse
  • encfs (1.9.x)

Installing dependencies on OSX

1. Install Homebrew

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
sudo chown -R $(whoami) /usr/local/lib/pkgconfig
brew doctor

2. Install OSXFuse

Download the latest dmg installer image from https://osxfuse.github.io/ and run the installer.

If you're running Catalina (or any OSX version that doesn't have a working OSXFuse installer yet), you'll have to install osxfuse using brew:

brew tap homebrew/cask
brew cask install osxfuse

Make sure to enable the kernel extension in System Preferences → Security & Privacy → General if/as requested Reboot for osxfuse to work correctly.

3. Install encfs

brew update

Check if everything is ok and install encfs

brew doctor
brew install encfs

Check if encfs works:

encfs    

4. Install python3

brew install python3

5. Install PyQt5

pip3 install --upgrade pip --user
python3 -m pip install PyQt5 --user

6. Install pycrypto

python3 -m pip install pycrypto --user

Running pyencfsgui

  • Clone the git project onto your machine
  • Open a Terminal, go to the folder
  • run python3 encfsgui.py
  • Check/edit the settings as needed
  • Create a new volume (or add an existing one to the application)
  • Enjoy!

Can I add a shortcut to the app in my Dock?

Sure! Simply follow these steps:

  • Edit file pyencfsgui.sh and replace path_to_pyencfsgui_here (first line) with the full path to the folder where you have put the pyencfsgui repository
  • Open a Terminal and go to the folder than contains the pyencfsgui repository
  • Make the script executable:
    chmod +x pyencfsgui.sh
    
  • Rename the script to pyencfsgui.app
    mv pyencfsgui.sh pyencfsgui.app
    
  • Open Finder, go to the folder that contains the repository, and drag the .app file into your dock
  • In Terminal, rename the file back to .sh
    mv pyencfsgui.app pyencfsgui.sh
    
  • Open Finder, go to the folder that contains the repository, select the pyencfsgui.sh script, right-click and choose "Get Info"
  • Make sure the script will open with "Terminal"

(it might be a good idea to also check/confirm that Terminal will close itself when the script exits)

Bonus: if you would like to use the encfsgui icon for the shortcut in Dock, follow these steps:

  • Open "encfsgui.png" in the bitmaps folder
  • Use Cmd+A to select the image, and then Cmd+C to copy it to clipboard
  • Launch finder, open the folder that contains the pyencfsgui.sh script. Select the file, right-click and choose "Get Info"
  • Select the icon in the upper left corner of the Info window. Then press Cmd+V to paste the image.
You can’t perform that action at this time.