Update README
- Simplify where possible. - Remove outdated parts. - Explain that only Python 3.9 is tested and supported. - Link to Lacre Webgate repository.
This commit is contained in:
parent
c8f6743768
commit
bcd0284eac
1 changed files with 43 additions and 28 deletions
71
README.md
71
README.md
|
|
@ -1,57 +1,72 @@
|
|||
# GPG Lacre Project
|
||||
# Lacre Project
|
||||
|
||||
GPG Lacre is a fork and continuation of original work of gpg-mailgate project:
|
||||
[gpg-mailgate](https://github.com/TheGreatGooo/gpg-mailgate). It is still
|
||||
actively developed and should be considered as beta -- with all APIs and
|
||||
internals being subject to change. Please only use this software if you know
|
||||
GnuPG well.
|
||||
Lacre is a fork of and continuation of the original work on
|
||||
[gpg-mailgate](https://github.com/TheGreatGooo/gpg-mailgate) project. It is
|
||||
still actively developed and should be considered as beta -- with all APIs and
|
||||
internals being subject to change. Please only use this software if you
|
||||
know GnuPG well and accept occasional failures.
|
||||
|
||||
**Lacre** (wax seal in Portuguese) is a
|
||||
[content filter](https://www.postfix.org/FILTER_README.html)
|
||||
for Postfix that automatically encrypts incoming email using GnuPG for
|
||||
recipients that have provided their public keys.
|
||||
|
||||
**GPG Lacre** (wax seal in Portuguese) is a content filter for Postfix that automatically encrypts unencrypted incoming email using PGP or S/MIME for select recipients.
|
||||
This project is the continuation of the work of "gpg-mailgate" on providing open source, GnuPG based email encryption for emails at rest. All incoming emails are automatically encrypted with user's public key before they are saved on the server. It is a server side encryption solution while the control of the encryption keys are fully at the hands of the end-user and private keys are never stored on the server.
|
||||
All incoming emails are automatically encrypted with users' public keys before
|
||||
they are saved in the inbox.
|
||||
|
||||
The scope of the project is to improve on the already existing code, provide easy to use key upload system (standalone as well as Roundcube plugin) and key discoverability. Beside providing a solution that is easy to use we will also provide easy to digest material about encryption, how it works and how to make use of it in situations other the just mailbox encryption. Understanding how encryption works is the key to self-determination and is therefore an important part of the project.
|
||||
# How it works
|
||||
|
||||
GPG Lacre will be battle tested on the email infrastructure of https://disroot.org (an ethical non-profit service provider).
|
||||
When Postfix receives a message, it "forwards" that message to Lacre.
|
||||
|
||||
Then, Lacre does the following:
|
||||
|
||||
1. If message already is encrypted, it just delivers the message immediately.
|
||||
2. Checks the list of recipients, finds their public keys if any were
|
||||
provided.
|
||||
3. Encrypts message if possible.
|
||||
4. Delivers the message.
|
||||
|
||||
---
|
||||
|
||||
The work on this project in 2021 is funded by https://nlnet.nl/thema/NGIZeroPET.html for which we are very thankful.
|
||||
|
||||
The scope of the work for 2021 is:
|
||||
- Rewrite code to python3
|
||||
- Improve standalone key upload website
|
||||
- Provide Roundcube plugin for key management
|
||||
- Improve key server features
|
||||
- Provide webiste with information and tutorials on how to use GPG in general and also **Lacre**
|
||||
- (Optional) provide Autocrypt support
|
||||
Work on this project in 2021 was funded by
|
||||
[NGI Zero PET](https://nlnet.nl/thema/NGIZeroPET.html)
|
||||
for which we are very thankful.
|
||||
|
||||
Made possible thanks to:<br>
|
||||
|
||||
|
||||
---
|
||||
|
||||
For installation instructions, please refer to the included **INSTALL** file.
|
||||
# Installation
|
||||
|
||||
For installation instructions, please refer to the included [INSTALL](INSTALL.md) file.
|
||||
|
||||
Please note Lacre is developed and tested with Python 3.9. Other versions
|
||||
might not work as expected and haven't been tested thoroughly.
|
||||
|
||||
---
|
||||
|
||||
# Features
|
||||
# Planned features
|
||||
|
||||
- Correctly displays attachments and general email content; currently will only display first part of multipart messages
|
||||
- Public keys are stored in a dedicated gpg-home-directory
|
||||
- Encrypts both matching incoming and outgoing mail (this means gpg-mailgate can be used to encrypt outgoing mail for software that doesn't support PGP or S/MIME)
|
||||
- Decrypts PGP encrypted mails for present private keys (but no signature check and it does not always work with PGP/INLINE encrypted mails)
|
||||
- Easy installation
|
||||
- gpg-mailgate-web extension is a web interface allowing any user to upload PGP keys so that emails sent to them from your mail server will be encrypted (see gpg-mailgate-web directory for details)
|
||||
- people can submit their public key like to any keyserver to gpg-mailgate with the gpg-mailgate-web extension
|
||||
- people can send an S/MIME signed email to register@yourdomain.tld to register their public key
|
||||
- people can send their public OpenPGP key as attachment or inline to register@yourdomain.tld to register it
|
||||
- People can submit their public key like to any keyserver to gpg-mailgate with the gpg-mailgate-web extension
|
||||
- People can send an S/MIME signed email to register@yourdomain.tld to register their public key
|
||||
- People can send their public OpenPGP key as attachment or inline to register@yourdomain.tld to register it
|
||||
|
||||
See also: [lacre-webgate](https://git.disroot.org/Lacre/lacre-webgate/) -- a
|
||||
web interface allowing any user to upload PGP keys so that emails sent to them
|
||||
from your mail server will be encrypted
|
||||
|
||||
This is forked from the original project at http://code.google.com/p/gpg-mailgate/
|
||||
|
||||
# Authors
|
||||
|
||||
This is a combined work of many developers and contributors. We would like to pay honours to original gpg mailbox developers for making this project happen, and providing solid solution for encryption emails at rest:
|
||||
This is a combined work of many developers and contributors. We would like to
|
||||
pay honours to original gpg mailbox developers for making this project happen,
|
||||
and providing solid solution for encryption emails at rest:
|
||||
|
||||
* mcmaster <mcmaster@aphrodite.hurricanelabs.rsoc>
|
||||
* Igor Rzegocki <ajgon@irgon.com> - [GitHub](https://github.com/ajgon/gpg-mailgate)
|
||||
|
|
@ -63,4 +78,4 @@ This is a combined work of many developers and contributors. We would like to pa
|
|||
* Bruce Markey - [GitHub](https://github.com/TheEd1tor)
|
||||
* Remko Tronçon - [GitHub](https://github.com/remko/phkp/)
|
||||
* Kiritan Flux [GitHub](https://github.com/kflux)
|
||||
* Fabian Krone [GitHub] (https://github.com/fkrone/gpg-mailgate)
|
||||
* Fabian Krone [GitHub](https://github.com/fkrone/gpg-mailgate)
|
||||
|
|
|
|||
Loading…
Reference in a new issue