Skip to content

saturneric/GpgFrontend

Repository files navigation

GpgFrontend

Language License Codacy Badge Ask DeepWiki

A modern "Enigma" built on GnuPG. It brings easy and trustworthy to your privacy life.

GpgFrontend

Key Features

  • Easy: Encrypt and sign your texts, files and more.
  • Cross-platform: Native support for Windows, macOS and Linux.
  • Portable: Run directly from a USB drive and carry your keys.
  • Flexible: Manage keys separately through multiple key databases.
  • Privacy-focused: Using multiple approaches to enhance safety.

If you like GpgFrontend, you can give it a ⭐ on GitHub as donation. :)

Planned Next Release:

  • v2.1.x (Stable): Dedicated to maximum stability and reliability, this series will remain in maintenance mode with regular releases every two months. The focus is strictly on bug fixes and security updates, with no new major features or breaking changes planned.
  • v2.2.0+ (Mainline): Expected in the next 4–6 months, this version introduces an optional rpgp backend for OpenPGPv6 (RFC 9580) support. While this branch may be less stable due to its experimental nature, GnuPG remains our primary, long-term strategic backend and will continue as the default, fully-supported choice across all versions.

Table of Contents

User Manual

For detailed instructions on installation, usage, and troubleshooting, please refer to the User Manual. The User Manual is the primary and most up-to-date resource for all users who want to use GpgFrontend. It provides guidance and some introductions on basic concepts, ensuring you have the best practices at the most of the time.

The source code for the user manual is maintained in this repository.

Supported Languages

GpgFrontend currently supports an array of languages including:

  • English
  • Chinese
  • French
  • German
  • Italian
  • Spanish

And these translations are contributed by our community: SHOW

If you find an error in any of the translations or need to add a new one, we welcome you to join our translation work.

Modules

GpgFrontend supports extensive module development, allowing users to customize their experience or get rid of unwanted features. Modules can encapsulate functionality, enabling users to enable or disable features as needed. Users can refer to existing module code for guidance Module Repository to reach a broader audience.

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. If you don't have a GitHub account or prefer not to register, you are welcome to communicate with me via email.

Contributing Guide

For Developers

Although the GpgFrontend's UI looks simple, architecture and design behind it are actually not easy for beginners, especially for developers who are not familiar with C++, Qt, and multithreading. I was struggling hard in these areas since the beginning of the project as well. An AI-assisted Wiki has been created through analysis of the GpgFrontend source code. I've glanced through it and I would say that it can be of great help, but for some details, it's not entirely accurate. Therefore, I would recommend developers to read the source code with the help of the wiki, but not to rely on it completely. If you have any questions about the code, feel free to ask me directly or open an issue on GitHub.

For setting up the development environment, please refer to the Development Environment Setup Guide.

Project's Logo

Logo

Mission and Origins

GpgFrontend inherits the codebase from the discontinued but easy-to-use gpg4usb. As described in my blog post "The Past and Present of GpgFrontend: My Journey with an Open-Source Encryption Tool", the project began with a simple question:

"What if everyone could have a small, reliable, and secure 'crypto machine'. A tool that makes encryption as tangible and trustworthy as turning a key in a lock?"

Project Maintainer

@Saturneric

You can refer to HERE for my contact details.

LICENSES

GpgFrontend itself is licensed under the GPLv3.

FOSSA Status