Bug fixes for broken html

.gitignore

@@ -26,6 +26,18 @@ pip-log.txt
 .tox
 nosetests.xml
 
+# GPG-Mailgate test files
+test/logs
+test/tmp
+test/gpg-mailgate.conf
+test/keyhome/random_seed
+
+# Emacs files
+*~
+TAGS
+TAGS-Python
+TAGS-PHP
+
 # Translations
 *.mo
 

GnuPG/__init__.py

@@ -23,9 +23,20 @@
 import shutil
 import random
 import string
+import sys
+
+
+LINE_FINGERPRINT = 'fpr'
+LINE_USER_ID = 'uid'
+
+POS_FINGERPRINT = 9
+
+def build_command(key_home, *args, **kwargs):
+	cmd = ["gpg", '--homedir', key_home] + list(args)
+	return cmd
 
 def private_keys( keyhome ):
-	cmd = ['/usr/bin/gpg', '--homedir', keyhome, '--list-secret-keys', '--with-colons']
+	cmd = build_command(keyhome, '--list-secret-keys', '--with-colons')
 	p = subprocess.Popen( cmd, stdin=None, stdout=subprocess.PIPE, stderr=subprocess.PIPE )
 	p.wait()
 	keys = dict()
@@ -39,17 +50,25 @@ def private_keys( keyhome ):
 	return keys
 
 def public_keys( keyhome ):
-	cmd = ['/usr/bin/gpg', '--homedir', keyhome, '--list-keys', '--with-colons']
+	cmd = build_command(keyhome, '--list-keys', '--with-colons')
 	p = subprocess.Popen( cmd, stdin=None, stdout=subprocess.PIPE, stderr=subprocess.PIPE )
 	p.wait()
+
 	keys = dict()
+	fingerprint = None
+	email = None
 	for line in p.stdout.readlines():
-		if line[0:3] == 'uid' or line[0:3] == 'pub':
+		line = line.decode('utf-8')
+		if line[0:3] == LINE_FINGERPRINT:
+			fingerprint = line.split(':')[POS_FINGERPRINT]
+		if line[0:3] == LINE_USER_ID:
 			if ('<' not in line or '>' not in line):
 				continue
 			email = line.split('<')[1].split('>')[0]
-			fingerprint = line.split(':')[4]
+		if not (fingerprint is None or email is None):
 			keys[fingerprint] = email
+			fingerprint = None
+			email = None
 	return keys
 
 # confirms a key has a given email address
@@ -64,7 +83,7 @@ def confirm_key( content, email ):
 	os.mkdir(tmpkeyhome)
 	localized_env = os.environ.copy()
 	localized_env["LANG"] = "C"
-	p = subprocess.Popen( ['/usr/bin/gpg', '--homedir', tmpkeyhome, '--import', '--batch'], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=localized_env )
+	p = subprocess.Popen( build_command(tmpkeyhome, '--import', '--batch'), stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=localized_env )
 	result = p.communicate(input=content)[1]
 	confirmed = False
 
@@ -83,7 +102,7 @@ def confirm_key( content, email ):
 
 # adds a key and ensures it has the given email address
 def add_key( keyhome, content ):
-	p = subprocess.Popen( ['/usr/bin/gpg', '--homedir', keyhome, '--import', '--batch'], stdin=subprocess.PIPE, stdout=subprocess.PIPE,stderr=subprocess.PIPE )
+	p = subprocess.Popen( build_command(keyhome, '--import', '--batch'), stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE )
 	p.communicate(input=content)
 	p.wait()
 
@@ -93,7 +112,7 @@ def delete_key( keyhome, email ):
 
 	if result[1]:
 		# delete all keys matching this email address
-		p = subprocess.Popen( ['/usr/bin/gpg', '--homedir', keyhome, '--delete-key', '--batch', '--yes', result[1]], stdin=None, stdout=subprocess.PIPE, stderr=subprocess.PIPE )
+		p = subprocess.Popen( build_command(keyhome, '--delete-key', '--batch', '--yes', result[1]), stdin=None, stdout=subprocess.PIPE, stderr=subprocess.PIPE )
 		p.wait()
 		return True
 
@@ -102,7 +121,7 @@ def delete_key( keyhome, email ):
 class GPGEncryptor:
 	def __init__(self, keyhome, recipients = None, charset = None):
 		self._keyhome = keyhome
-		self._message = ''
+		self._message = b''
 		self._recipients = list()
 		self._charset = charset
 		if recipients != None:
@@ -112,12 +131,12 @@ def update(self, message):
 		self._message += message
 
 	def encrypt(self):
-		p = subprocess.Popen( self._command(), stdin=subprocess.PIPE, stdout=subprocess.PIPE,stderr=subprocess.PIPE )
+		p = subprocess.Popen( self._command(), stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE )
 		encdata = p.communicate(input=self._message)[0]
 		return (encdata, p.returncode)
 
 	def _command(self):
-		cmd = ["/usr/bin/gpg", "--trust-model", "always", "--homedir", self._keyhome, "--batch", "--yes", "--pgp7", "--no-secmem-warning", "-a", "-e"]
+		cmd = build_command(self._keyhome, "--trust-model", "always", "--batch", "--yes", "--pgp7", "--no-secmem-warning", "-a", "-e")
 
 		# add recipients
 		for recipient in self._recipients:
@@ -140,11 +159,9 @@ def update(self, message):
 		self._message += message
 
 	def decrypt(self):
-		p = subprocess.Popen( self._command(), stdin=subprocess.PIPE, stdout=subprocess.PIPE,stderr=subprocess.PIPE )
+		p = subprocess.Popen( self._command(), stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE )
 		decdata = p.communicate(input=self._message)[0]
 		return (decdata, p.returncode)
 
 	def _command(self):
-		cmd = ["/usr/bin/gpg", "--trust-model", "always", "--homedir", self._keyhome, "--batch", "--yes", "--no-secmem-warning", "-a", "-d"]
-
-		return cmd
+		return build_command(self._keyhome, "--trust-model", "always", "--batch", "--yes", "--no-secmem-warning", "-a", "-d")

INSTALL.md

@@ -63,8 +63,12 @@ These instructions are based on an installation on an Ubuntu 14.04 LTS virtual m
 8. Add the following line to `/etc/postfix/main.cf`
 
         content_filter = gpg-mailgate
-
-9. Restart Postfix
+
+9. Optional: GPG can automatically download new public keys for automatic signature verification. To enable automatic create the file `/var/gpgmailgate/.gnupg/gpg.conf`. Add the following line to the file:
+
+        keyserver-options auto-key-retrieve
+
+10. Restart Postfix
 
 You are now ready to go. To add a public key for encryption just use the following command:
 

Makefile

@@ -0,0 +1,42 @@
+.POSIX:
+.PHONY: test unittest pre-clean clean
+
+#
+# On systems where Python 3.x binary has a different name, just
+# overwrite the name/path on the command line, like:
+#
+#     make test PYTHON=/usr/local/bin/python3.8
+#
+# This marco is passed via environment to test/e2e_test.py, where it's
+# used to compute further commands.
+#
+PYTHON = python3
+
+#
+# Run a set of end-to-end tests.
+#
+# Test scenarios are described and configured by the test/e2e.ini
+# file.  Basically this is just a script that feeds GPG Mailgate with
+# known input and checks whether output meets expectations.
+#
+test: test/tmp test/logs pre-clean
+	$(PYTHON) test/e2e_test.py
+
+#
+# Run unit tests
+#
+unittest:
+	$(PYTHON) -m unittest discover -s test
+
+pre-clean:
+	rm -fv test/gpg-mailgate.conf
+	rm -f test/logs/*.log
+
+test/tmp:
+	mkdir test/tmp
+
+test/logs:
+	mkdir test/logs
+
+clean: pre-clean
+	rm -rfv test/tmp test/logs

README.md

@@ -1,8 +1,34 @@
-# gpg-mailgate
+# GPG Lacre Project
 
-gpg-mailgate is a content filter for Postfix that automatically encrypts unencrypted incoming email using PGP or S/MIME for select recipients. It is also able to decrypt incoming PGP mails.
+Fork and continuation of original work of gpg-mailgate project: https://github.com/fkrone/gpg-mailgate
 
-For installation instructions, please refer to the included INSTALL file.
+
+**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.
+
+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.
+
+GPG Lacre will be battle tested on the email infrastructure of https://disroot.org (an ethical non-profit service provider).
+
+---
+
+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
+
+Made possible thanks to:<br>
+![](https://nlnet.nl/logo/banner.png)
+
+---
+For installation instructions, please refer to the included **INSTALL** file.
+
+---
 
 # Features
 - Correctly displays attachments and general email content; currently will only display first part of multipart messages
@@ -19,7 +45,7 @@ This is forked from the original project at http://code.google.com/p/gpg-mailgat
 
 # Authors
 
-This is a combined work of many developers and contributors:
+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 <[email protected]>
 * Igor Rzegocki <[email protected]> - [GitHub](https://github.com/ajgon/gpg-mailgate)
@@ -32,9 +58,3 @@ This is a combined work of many developers and contributors:
 * 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)
-
-# To Do
-
-* rename from gpg-mailgate to openpgp-s-mime-mailgate or something.....
-* find a better solution for an own user instead of the user `nobody`
-* make PGP/INLINE decryption more reliable

doc/testing.md

@@ -0,0 +1,40 @@
+# Testing
+
+First tests have been set up to cover GPG Mailgate with at least basic test
+that would be easy to run.  The tests are called "end-to-end", meaning that we
+feed some input to GPG Mailgate and inspect the output.
+
+## Running tests
+
+To run tests, use command `make test` or `make unittest`.
+
+Tests produce some helpful logs, so inspect contents of `test/logs` directory
+if something goes wrong.
+
+If your system's Python binary isn't found in your `$PATH` or you want to use
+a specific binary, use make's macro overriding: `make test
+PYTHON=/path/to/python`.
+
+## Key building blocks
+
+- *Test Script* (`test/e2e_test.py`) that orchestrates the other components.
+  It performs test cases described in the *Test Configuration*.  It spawns
+  *Test Mail Relay* and *GPG Mailgate* in appropriate order.
+- *Test Mail Relay* (`test/relay.py`), a simplistic mail daemon that only
+  supports the happy path.  It accepts a mail message and prints it to
+  stdandard output.
+- *Test Configuration* (`test/e2e.ini`) specifies test cases: their input,
+  expected results and helpful documentation.  It also specifies the port that
+  the *Test Mail Relay* should listen on.
+
+## Limitations
+
+Currently tests only check if the message has been encrypted, without
+verifying that the correct key has been used.  That's because we don't know
+(yet) how to have a reproducible encrypted message.  Option
+`--faked-system-time` wasn't enough to produce identical output.
+
+## Troubleshooting
+
+When things go wrong, be sure to study `test/logs/e2e.log` and
+`test/logs/gpg-mailgate.log` files -- they contain some useful information.

gpg-mailgate-web/cron.py

@@ -19,7 +19,7 @@
 #	along with gpg-mailgate source code. If not, see <http://www.gnu.org/licenses/>.
 #
 
-from ConfigParser import RawConfigParser
+from configparser import RawConfigParser
 import GnuPG
 import MySQLdb
 import smtplib
@@ -64,7 +64,7 @@ def send_msg( mailsubject, messagefile, recipients = None ):
 	for (name, value) in _cfg.items(sect):
 		cfg[sect][name] = value
 
-if cfg.has_key('database') and cfg['database'].has_key('enabled') and cfg['database']['enabled'] == 'yes' and cfg['database'].has_key('name') and cfg['database'].has_key('host') and cfg['database'].has_key('username') and cfg['database'].has_key('password'):
+if 'database' in cfg and 'enabled' in cfg['database'] and cfg['database']['enabled'] == 'yes' and 'name' in cfg['database'] and 'host' in cfg['database'] and 'username' in cfg['database'] and 'password' in cfg['database']:
 	connection = MySQLdb.connect(host = cfg['database']['host'], user = cfg['database']['username'], passwd = cfg['database']['password'], db = cfg['database']['name'], port = 3306)
 	cursor = connection.cursor()
 
@@ -83,17 +83,17 @@ def send_msg( mailsubject, messagefile, recipients = None ):
 				GnuPG.add_key(cfg['gpg']['keyhome'], row[0]) # import the key to gpg
 				cursor.execute("UPDATE gpgmw_keys SET status = 1 WHERE id = %s", (row[1],)) # mark key as accepted
 				appendLog('Imported key from <' + row[2] + '>')
-				if cfg['cron'].has_key('send_email') and cfg['cron']['send_email'] == 'yes':
+				if 'send_email' in cfg['cron'] and cfg['cron']['send_email'] == 'yes':
 					send_msg( "PGP key registration successful", "registrationSuccess.md", row[2] )
 			else:
 				cursor.execute("DELETE FROM gpgmw_keys WHERE id = %s", (row[1],)) # delete key
 				appendLog('Import confirmation failed for <' + row[2] + '>')
-				if cfg['cron'].has_key('send_email') and cfg['cron']['send_email'] == 'yes':
+				if 'send_email' in cfg['cron'] and cfg['cron']['send_email'] == 'yes':
 					send_msg( "PGP key registration failed", "registrationError.md", row[2] )
 		else:
 			# delete key so we don't continue processing it
 			cursor.execute("DELETE FROM gpgmw_keys WHERE id = %s", (row[1],))
-			if cfg['cron'].has_key('send_email') and cfg['cron']['send_email'] == 'yes':
+			if 'send_email' in cfg['cron'] and cfg['cron']['send_email'] == 'yes':
 				send_msg( "PGP key deleted", "keyDeleted.md", row[2])
 
 		connection.commit()
@@ -108,4 +108,4 @@ def send_msg( mailsubject, messagefile, recipients = None ):
 		appendLog('Deleted key for <' + row[0] + '>')
 		connection.commit()
 else:
-	print "Warning: doing nothing since database settings are not configured!"
+	print("Warning: doing nothing since database settings are not configured!")

gpg-mailgate.conf.sample

@@ -80,6 +80,9 @@ port = 10028
 # mails through the GPG-Mailgate so they are encrypted
 enc_port = 25
 
+# Set this option to yes to use TLS for SMTP Servers which require TLS.
+starttls = no
+
 [database]
 # uncomment the settings below if you want
 #  to read keys from a gpg-mailgate-web database