ParrotSec / encryptpad

Other
4 stars 1 forks source link

Build Status Build status

Screenshots and tutorials are at evpo.net/encryptpad/

EncryptPad

README.png

EncryptPad is an application for viewing and editing symmetrically encrypted text. Using a simple and convenient graphical and command line interface, EncryptPad provides a tool for encrypting and decrypting binary files on disk while offering effective measures for protecting information, and it uses the most widely chosen quality file format OpenPGP RFC 4880. Unlike other OpenPGP software which main purpose is asymmetric encryption, the primary focus of EncryptPad is symmetric encryption.

Table of Contents

Features

Supported platforms

Why use EncryptPad?

When do I need EncryptPad?

When can I not use EncryptPad?

File types

The format is determined by an extension of a file. Main extensions of encrypted files are GPG and EPD.

GPG

This file type conforms to OpenPGP format and it is compatible with other OpenPGP tools. Use it if you need to open a file where EncryptPad is not available. The format does not support double protection (key file + passphrase). So you need to choose between key file or passphrase and cannot use both. In addition, it cannot store file key path in the encrypted file. It means that every time you open a file encrypted with a key file, the application will ask you which key file to use.

EPD

EncryptPad specific format. Other OpenPGP software will not be able to open it unless the file was only protected with a passphrase. If passphrase only protection was used, the file is effectively a GPG file (see GPG section above). However, when a key file protection is involved, it is a GPG file in a WAD container. See the following chapter for details.

Feature support

TypeFeatureSupportedKey file path\*OpenPGP compatibleFile format
GPGPassphraseyesn/ayesOpenPGP file
GPGKey fileyesnoyesOpenPGP file
GPGKey file and passphrasenon/an/an/a
EPDPassphraseyesn/ayesOpenPGP file
EPDKey fileyesyesnoNested: WAD/OpenPGP
EPDKey file and passphraseyesyesnoNested: OpenPGP/WAD/OpenPGP

* Key file location is persisted in the header of an encrypted file so the user does not need to specify it when decrypting.

What is an EncryptPad key file?

In symmetric encryption the same sequence is used to encrypt and decrypt data. The user or another application usually provides this sequence in the form of an entered passphrase or a file. In addition to entered passphrases, EncryptPad generates files with random sequences called "key files".

When the user creates a key file, EncryptPad generates a random sequence of bytes, asks the user for a passphrase, encrypts the generated sequence and saves it to a file.

The format of the file is OpenPGP. Other OpenPGP implementations can also create and open EncryptPad key files as below shell commands demonstrate.

When EncryptPad generates a new key file, it is roughly equivalent to the following gpg2 command.

pwmake 1024 | gpg2 -c --armor --cipher-algo AES256 > ~/.encryptpad/foo.key

pwmake generates a random sequence, which gpg2 in-turn encrypts. It will ask for the passphrase to encrypt the sequence.

When you use this key to encrypt test3.txt, the equivalent gpg command is below:

gpg2 --decrypt ~/.encryptpad/foo.key \
| gpg2 --passphrase-fd 0 --batch -c --cipher-algo AES256 \
-o /tmp/test3.txt.gpg /tmp/test3.txt

The first gpg2 process decrypts foo.key and directs it to descriptor 0 of the second process through a pipe. gpg2 reads the sequence from the descriptor with --passphrase-fd 0.

When EncryptPad opens the encrypted file protected with foo.key, the equivalent gpg commands are:

gpg2 --decrypt ~/.encryptpad/foo.key \
| gpg2 --passphrase-fd 0 --batch --decrypt \
-o /tmp/test4.txt /tmp/test3.txt.gpg

As you see, other OpenPGP implementations can also use EncryptPad keys.

EPD file format when encrypting with a key

There are three different structures a saved file can have depending on protection mode:

  1. Passphrase only (passphrase is used to protect a file but no keys are specified). The file is an ordinary OpenPGP file.

  2. Key only (passphrase is not set but a key file is used for protection). The file is a WAD file. WAD is a simple format for combining multiple binary files in one. You can open a WAD file in Slade. It contains two files internally:

    • OpenPGP file encrypted with the key
    • __X2_KEY is a plain text file containing the path to the key if "Persistent key location in the encrypted file" is enabled. Otherwise, it has zero length.
  3. Protected with passphrase and key. The resulting file is an OpenPGP file containing a WAD file as explained in 2.

Use CURL to automatically download keys from a remote storage

If CURL URL is specified in Key File Path field in the Set Encryption Key dialogue, EncryptPad will attempt to start a curl process to download the key from a remote host. If you want to use this feature, you need to set the path to the CURL executable in the EncryptPad settings.

Consider this use case scenario: you travel with your laptop and open an encrypted file on the laptop. If you protect the file with a passphrase and a key and your laptop is lost or stolen, the perpetrator will be able to make a brute force attack on your file because the key is also stored on the laptop. To avoid this, EncryptPad takes the following steps:

  1. Encrypts the plain text file with the key
  2. Copies the encrypted file into a WAD file together with the unencrypted HTTPS or SFTP URL to the key file containing authentication parameters.
  3. Encrypts the WAD file from point 2 with the passphrase.

If this file gets into the hands of a wrongdoer, he or she will need to brute force the passphrase first to be able to obtain the key URL and the authentication parameters. Since a brute force attack takes a lot of time, the user will be able to remove the key or change the authentication so the previous parameters become obsolete.

Known weaknesses

Command line interface

encryptcli is the executable to encrypt / decrypt files in command line. Run it without arguments to see available parameters. Below is an example of encrypting a file with a key:

# generate a new key and protect it with the passphrase "key".
# --key-pwd-fd 0 for reading the key passphrase from descriptor 0
echo -n "key" | encryptcli --generate-key --key-pwd-fd 0 my_key.key

# encrypt plain_text.txt with my_key.key created above.
# The key passphrase is sent through file descriptor 3
cat plain_text.txt | encryptcli -e --key-file my_key.key \
--key-only --key-pwd-fd 3 -o plain_text.txt.gpg 3< <(echo -n "key")

Installing EncryptPad

Portable executable

Portable binaries are available for Windows and macOS. They can be copied on a memory stick or placed on a network share.

Arch Linux

Use fingerprints to receive gpg keys for EncryptPad and Botan.

gpg --recv-key 621DAF6411E1851C4CF9A2E16211EBF1EFBADFBC
gpg --recv-key 634BFC0CCC426C74389D89310F1CFF71A2813E85

Install the AUR packages below:

pacaur installs botan-stable automatically as encryptpad dependency.

Ubuntu or Linux Mint via PPA

Alin Andrei from webupd8.org kindly created EncryptPad packages for several distributions. See instructions below on how to install them.

Installation

Use the commands below to install the packages.

sudo add-apt-repository ppa:nilarimogard/webupd8
sudo apt update
sudo apt install encryptpad encryptcli

Integrity verification procedure

Below are steps to verify the SHA-1 hashes of the source files in Launchpad webupd8 PPA used for building the packages. Ideally, you need to be familiar with the PPA concepts.

1. Download one of the changes files below depending on your distribution. The package version was 0.3.2.5 at the moment of writing. Please replace it with the latest version you are installing.

2. Download the tarball with the verified "changes" files and its signature:

wget https://github.com/evpo/EncryptPad/releases/download/v0.3.2.5\
/encryptpad0_3_2_5_webupd8_ppa_changes.tar.gz

wget https://github.com/evpo/EncryptPad/releases/download/v0.3.2.5\
/encryptpad0_3_2_5_webupd8_ppa_changes.tar.gz.asc

3. Receive and verify the EncryptPad Release key:

gpg --recv-key 634BFC0CCC426C74389D89310F1CFF71A2813E85

4. Verify the signature on the tarball:

gpg --verify encryptpad0_3_2_5_webupd8_ppa_changes.tar.gz.asc

5. Extract the content:

tar -xf encryptpad0_3_2_5_webupd8_ppa_changes.tar.gz

6. Compare the "changes" file for your distribution with the file from step 1. The SHA hashes should match.

diff encryptpad_0.3.2.5-1~webupd8~yakkety1_source.changes \
encryptpad0_3_2_5_webupd8_ppa_changes/encryptpad_0.3.2.5-1~webupd8~yakkety1_source.changes

Compile EncryptPad on Windows

Prerequisites

  1. Qt framework based on MingW 32 bit (the latest build has been tested with Qt 5.10.1).
  2. MSYS: you can use one bundled with Git For Windows. You probably use Git anyway.
  3. Python: any recent version will work.

Steps

  1. Modify the session PATH environment variable to include the Qt build toolset and Python. mingw32-make, g++, qmake, python.exe should be in the global search path in your Git Bash session. I personally modify bash.bashrc and add a line like PATH=/c/Python35-32:/c/Qt/5.10.1/mingw53_32/bin:/c/Qt/Tools/mingw530_32/bin:/c/MinGW/msys/1.0/bin:/bin not to pollute the system wide PATH variable.

  2. Extract the EncryptPad source files to a directory.

  3. Run configure.py --help script to see available options. To build everything:

    ./configure.py --cpu x86 --os mingw --static make

The configure command will always work if your console is running with administrative privileges. If you don't want to run as administrator, add --link-method hardlink to the options. If the build is successful, you should see the executable ./bin/release/encryptpad.exe

Note that if you want EncryptPad to work as a single executable without dlls, you need to build Qt framework yourself statically. It takes a few hours. There are plenty of instructions on how to do this in the Internet. The most popular article recommends using a PowerShell script. While it is convenient and I did it once, sometimes you don't want to upgrade your PowerShell and install heavy dependencies coming with it. So the next time I had to do that, I read the script and did everything manually. Luckily there are not too many steps in it.

Compile EncryptPad on Mac/Linux

All you need is to install Qt, Python and run:

export PATH=$HOME/Qt/5.10.1/clang_64/bin/:$PATH
./configure.py --build-botan --ldflags "-mmacosx-version-min=10.10" --cxxflags "-mmacosx-version-min=10.10"
make

Change the Qt path and replace the minimal macOS versions as needed. The command will work without them but the result will be limited to the current version.

Fedora

Install dependencies and tools:

dnf install gcc make qt5-qtbase-devel gcc-c++ python libstdc++-static glibc-static
PATH=$PATH:/usr/lib64/qt5/bin/
export PATH

Open the EncryptPad directory:

./configure.py --build-botan --build-zlib
make

For a dynamic build with using the system libraries:

dnf install botan-devel
./configure.py
make

Ubuntu

Install dependencies and tools:

apt-get install qtbase5-dev qt5-default gcc g++ make python pkg-config zlib1g-dev libbotan-2-dev

Open the EncryptPad source directory:

./configure.py --build-bzip2
make

Debian

Install dependencies and tools:

apt-get install qtbase5-dev qt5-default gcc g++ make python zlib1g-dev pkg-config

Open the EncryptPad source directory:

./configure.py --build-botan --build-zlib
make

You can also use the system libbotan-2-dev instead of building it. If libbotan-2-dev is not available, add stretch-backports to the repository:

echo "deb http://deb.debian.org/debian/ stretch-backports main" >> /etc/apt/sources.list

apt-get install libbotan-2-dev

./configure.py
make

openSUSE

Install dependencies and tools:

zypper install gcc gcc-c++ make python pkg-config zlib-devel libqt5-qtbase-devel
ln -s qmake-qt5 /usr/bin/qmake

You can also install later compiler versions and link them to the default commands:

zypper install gcc7 gcc7-c++
ln -sf gcc-7 /usr/bin/gcc
ln -sf g++-7 /usr/bin/g++

Open the EncryptPad source directory:

./configure.py --build-botan --build-zlib
make

FreeBSD

Install dependencies and tools:

pkg install python pkgconf botan2 qt5

Open the EncryptPad source directory:

./configure.py
make

Portable mode

EncryptPad checks the executable directory for a sub-directory called encryptpad_repository. If exists, it is used for key files and settings. The directory .encryptpad in the user's profile is then ignored. The EncryptPad executable and encryptpad_repository can both be copied to a removable media and used on multiple computers. It should be noted that keeping encrypted material with the key files on the same removable media is less secure. Separate them if possible.

Does EncryptPad store passphrases in the memory to reopen files?

No, it does not. After being entered, a passphrase and random salt are hashed with an S2K algorithm. The result is used as the encryption key to encrypt or decrypt the file. A pool of these S2K results is generated every time the user enters a new passphrase. It allows to save and load files protected with this passphrase multiple times without having the passphrase. The size of the pool can be changed in the Preferences dialogue. The latest version at the moment of writing has this number set to 8 by default. It means that you can save a file 8 times before EncryptPad will ask you to enter the passphrase again. You can increase this number but it will have an impact on the performance because S2K algorithms with many iterations are slow by design.

Acknowledgements

EncryptPad uses the following frameworks and libraries:

  1. Qt Framework
  2. Botan
  3. stlplus
  4. Makefiles
  5. zlib
  6. gtest
  7. famfamfam Silk iconset 1.3
  8. plog

EncryptPad integrity verification

OpenPGP signing and certification authority

All EncryptPad related downloads are signed with the following OpenPGP key.

EncryptPad (Releases) 2048R/A2813E85

software@evpo.net

Key fingerprint = 634B FC0C CC42 6C74 389D 8931 0F1C FF71 A281 3E85

I also have a code signing certificate issued by a certification authority (CA). To establish a connection between my CA certificate and the above OpenPGP key, I created an executable signed with the CA certificate containing fingerprints and the OpenPGP key. You can find ca_signed_pgp_signing_instructions in downloads. Effectively I created a bridge of trust between my CA certificate and the OpenPGP key.

There is a few reasons why I did not simply use the CA certificate:

  1. EncryptPad is based on the OpenPGP standard and promotes it.
  2. OpenPGP signing is more flexible.
  3. There is no yearly CA certification running cost.

Step by step verification process

  1. Download packages and their detached OpenPGP signatures.
  2. Import the EncryptPad (Releases) key to your GPG keyring.
  3. Ensure that it is the valid EncryptPad (Releases) key by checking its fingerprint with ca_signed_pgp_signing_instructions.
  4. Verify signatures on the downloaded files with GPG.

License

EncryptPad is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

EncryptPad is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Contact and feedback

If your question is related to EncryptPad, send it to the mailing list: encryptpad@googlegroups.com linked to the public discussion group.

Bug tracker and contributions: github.com/evpo/EncryptPad/issues

For other matters, please contact Evgeny Pokhilko software@evpo.net

http://www.evpo.net/encryptpad