huzpsb/GpgFrontend

A Powerful, Easy-to-Use, Compact, Cross-Platform and Installation-Free OpenPGP(pgp) Crypto Tool. Also, it's one of the excellent GUI Frontends for Modern GnuPG(gpg).

GpgFrontend

GpgFrontend is a Free, Open Source, Powerful, Easy-to-Use, Compact, Cross-Platform OpenPGP Crypt Tool. Also, it's one of the excellent GUI Frontends for Modern GnuPG (gpg).

By using GpgFrontend, you can quickly encrypt and decrypt text or files. You can also digitally sign your text or files. GpgFrontend does not need to depend on any server, therefore it may be one of the last lines of defense in protecting your privacy. Please use this tool to transmit or store information that you regard as very precious. You can also use it to guarantee the authenticity of your information.

Languages Supported by GpgFrontend that are widely used in most countries and regions around the world, including English, Chinese, French, Russian, German, Spanish, Portuguese, Arabic, etc.

GpgFrontend is permanently free, but you can also "donate" it through the STAR project. Thanks!

>> Download << | >> User Manual << | >> Developer Document <<

Table of Contents

• Usage
• User Manual
• Developer Document
• Build Source Code
• Languages Support
• Contract
• Licenses

Usage

Here are some common usages to help you understand what GpgFrontend does and where it comes in handy. The interface presented may not be exactly the same as the latest stable release.

Text Encryption

Encryption can be done in just a few clicks.

Text Decryption

I want to see what you wrote right away.

File Encryption & Sign

What about files?

User Manual

GpgFrontend provides detailed documentation on his main features. If you want to know how to install with it, please read the User Manual instead of README.

Developer Document

You can view the developer documentation that is synchronized with the current latest release code. This document will help you understand the source code and get involved more quickly in the process of contributing to open source.

Developer Document

Build Source Code

For some capable users, building Gpg Frontend from source code is a good option. We encourage people to freely build, package and distribute their own versions. The way we build in common systems is as follows:

Note: "$" Symbols indicate commands to be executed with a normal user. Before you start, please clone the latest stable version code for users around the world.

$ git clone --recurse-submodules https://github.com/saturneric/GpgFrontend.git

如果你在**大陆，可以使用这个仓库

$ git clone --recurse-submodules https://git.codesdream.com/GpgFrontend.git

For Windows

Before building, you need to install MSYS2. After installation, open the MSYS2 terminal (MSYS2 MinGW 64-bit), enter the MSYS2 directory, and execute the following commands:

pacman --noconfirm -S --needed mingw-w64-x86_64-gcc mingw-w64-x86_64-make mingw-w64-x86_64-cmake autoconf 
pacman --noconfirm -S --needed make texinfo mingw-w64-x86_64-libconfig mingw-w64-x86_64-boost automake 
pacman --noconfirm -S --needed mingw-w64-x86_64-qt5 libintl msys2-runtime-devel gettext-devel mingw-w64-x86_64-gpgme
pacman --noconfirm -S --needed mingw-w64-x86_64-ninja mingw-w64-x86_64-gnupg mingw-w64-x86_64-libarchive

After executing these commands, you will start compiling.

$ cd GpgFrontend
$ mkdir build && cd build
$ cmake -G Ninja  -DCMAKE_BUILD_TYPE="Release" ..
$ ninja

After compiling, a release directory will be generated, which contains executable files that can be run directly.

$ ./release/GpgFrontend.exe

For macOS

Install and compile dependencies.

$ brew install cmake git autoconf automake qt@5 texinfo gettext openssl@1.1 libarchive
$ brew install boost ninja
$ brew unlink gettext && brew link --force gettext
$ brew link qt@5

Build the code separately for debug.

$ cd GpgFrontend
$ mkdir build && cd build
$ cmake -G Ninja  -DCMAKE_BUILD_TYPE="Debug" -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl@1.1  ..
$ ninja
$ ./release/GpgFrontend # run the program

Build the code and make the App Bundle.

$ cd GpgFrontend
$ mkdir build && cd build
$ cmake -G Ninja  -DCMAKE_BUILD_TYPE="Release" -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl@1.1 ..
$ ninja
$ macdeployqt ./release/GpgFrontend.app

For Ubuntu 18.04 And Later

Install and compile dependencies.

$ sudo apt-get update
$ sudo apt-get -y install build-essential binutils git autoconf automake gettext texinfo
$ sudo apt-get -y install gcc-8 g++-8 ninja-build
$ sudo apt-get -y install libconfig++-dev libboost-all-dev libarchive-dev libssl-dev
$ sudo apt-get -y install gpg # If you need to run directly after building.

Compile and install libgpg-error/libassuan/gpgme. Notice: These in third_party directory is newer than those in apt.

# libgpg-error
$ cd GpgFrontend
$ cd  ./third_party/libgpg-error
$ ./autogen.sh
$ ./configure --enable-maintainer-mode && make
$ sudo make install
# libassuan
$ cd GpgFrontend
$ cd  ./third_party/libassuan
$ ./autogen.sh
$ ./configure --enable-maintainer-mode && make
$ sudo make install
# gpgme
$ cd GpgFrontend
$ cd  ./third_party/gpgme
$ ./autogen.sh
$ ./configure --enable-maintainer-mode --enable-languages=cpp && make
$ sudo make install

Build the code and make the deb package(Please use Ubuntu 20.04 or later).

$ cd GpgFrontend
$ mkdir build && cd build
$ cmake -G Ninja  -DCMAKE_BUILD_TYPE="Release" -DGPGFRONTEND_GENERATE_LINUX_INSTALL_SOFTWARE=ON ..
$ ninja
$ ninja package

Build the code separately for debug(Please use ubuntu 18.04 or later).

$ cd GpgFrontend
$ mkdir build && cd build
$ cmake -G Ninja  -DCMAKE_BUILD_TYPE="Debug" ..
$ ninja
$ ./release/GpgFrontend # run the program

Package the AppImage(Should use ubuntu 18.04).

$ cd GpgFrontend
$ mkdir build && cd build
$ cmake -G Ninja  -DCMAKE_BUILD_TYPE="Release" ..
$ ninja
$ mkdir ./AppImageOut
$ cd ./AppImageOut
$ wget -c -nv https://github.com/probonopd/linuxdeployqt/releases/download/continuous/linuxdeployqt-continuous-x86_64.AppImage
$ chmod u+x linuxdeployqt-continuous-x86_64.AppImage
$ ./linuxdeployqt-continuous-x86_64.AppImage ../release/gpgfrontend/usr/share/applications/*.desktop -appimage

Languages Support

The supported languages are listed here. Some languages use machine translation and have not been verified. If you want to join translation and verification work, please refer to here.

Supported Languages

'zh_CN', 'zh_TW', 'zh_HK', 'es_ES', 'fr_FR', 'de_DE', 'pl_PL', 'ru_RU', 'ja_JP', 'it_IT', 'ko_KR', 'pt_BR', 'ar_SA', 'ar_IQ', 'hi_IN', 'af_ZA', 'sq_AL', 'be_BY', 'bg_BG', 'ca_ES', 'hr_HR', 'cs_CZ', 'da_DK', 'nl_NL', 'et_EE', 'fa_IR', 'fi_FI', 'fr_CA', 'he_IL', 'id_ID', 'lt_LT', 'de_AT', 'de_CH', 'el_GR', 'es_MX', 'iw_IL', 'uk_UA', 'en_US', 'en_GB', 'en_AU',

Notice: Most translations are generated by Google's automatic translation machine.If you find that a certain translation is wrong, you are welcome to join the translation work to provide a more suitable human translation.

Contract

Please refer to here for my contact details.

Contributing & Bugs Report

Feel free to dive in! Open an issue or submit PRs if you prefer to use GitHub. For anonymous users, Git patches can be delivered by mail.

Project Maintainer

@Saturneric

Project's LOGO

LICENSES

GpgFrontend itself is licensed under the GPLv3.

Dependency

There are some libraries and binary included in the zip-file which (may) have different licenses, for more information check their homepages. You can also obtain the sources from there.

gnupg: https://gnupg.org

gpgme: https://gnupg.org/software/gpgme/index.html

Qt(opensource): https://www.qt.io

MSYS2: https://www.msys2.org

mingw-w64: http://mingw-w64.org/doku.php

AppImage: https://appimage.org

JSON for Modern C++: https://github.com/nlohmann/json

Qt-AES: https://github.com/saturneric/Qt-AES

MacOS Application Bundles: Link

The icons of this software use materials from Alibaba Iconfont. The Alibaba vector icon library is free to use. The icons in the free library aren't registered as trademarks. There is no copyright issue involved and can be used commercially.