diff --git a/Makefile b/Makefile
index 07f084e..7253435 100644
--- a/Makefile
+++ b/Makefile
@@ -37,7 +37,7 @@ e2etest: test/tmp test/logs pre-clean restore-keyhome
# it slurps the right config.
#
crontest: clean-db $(TEST_DB)
- GPG_MAILGATE_CONFIG=test/gpg-mailgate-cron-test.conf PYTHONPATH=`pwd` $(PYTHON) gpg-mailgate-web/cron.py
+ GPG_MAILGATE_CONFIG=test/gpg-mailgate-cron-test.conf PYTHONPATH=`pwd` $(PYTHON) webgate-cron.py
$(TEST_DB):
$(PYTHON) test/utils/schema.py $(TEST_DB)
diff --git a/webgate-cron.py b/webgate-cron.py
index 625963e..30dabef 100755
--- a/webgate-cron.py
+++ b/webgate-cron.py
@@ -1,22 +1,22 @@
#!/usr/bin/python
#
-# gpg-mailgate
+# gpg-mailgate
#
-# This file is part of the gpg-mailgate source code.
+# This file is part of the gpg-mailgate source code.
#
-# gpg-mailgate 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 3 of the License, or
-# (at your option) any later version.
+# gpg-mailgate 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 3 of the License, or
+# (at your option) any later version.
#
-# gpg-mailgate source code 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.
+# gpg-mailgate source code 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.
#
-# You should have received a copy of the GNU General Public License
-# along with gpg-mailgate source code. If not, see .
+# You should have received a copy of the GNU General Public License
+# along with gpg-mailgate source code. If not, see .
#
from configparser import RawConfigParser
@@ -41,51 +41,51 @@ def load_file(name):
return data
def authenticate_maybe(smtp):
- if conf.config_item_equals('smtp', 'enabled', 'true'):
- LOG.debug(f"Connecting to {conf.get_item('smtp', 'host')}:{conf.get_item('smtp', 'port')}")
- smtp.connect(conf.get_item('smtp', 'host'), conf.get_item('smtp', 'port'))
- smtp.ehlo()
- if conf.config_item_equals('smtp', 'starttls', 'true'):
- LOG.debug("StartTLS enabled")
- smtp.starttls()
- smtp.ehlo()
- smtp.login(conf.get_item('smtp', 'username'), conf.get_item('smtp', 'password'))
+ if conf.config_item_equals('smtp', 'enabled', 'true'):
+ LOG.debug(f"Connecting to {conf.get_item('smtp', 'host')}:{conf.get_item('smtp', 'port')}")
+ smtp.connect(conf.get_item('smtp', 'host'), conf.get_item('smtp', 'port'))
+ smtp.ehlo()
+ if conf.config_item_equals('smtp', 'starttls', 'true'):
+ LOG.debug("StartTLS enabled")
+ smtp.starttls()
+ smtp.ehlo()
+ smtp.login(conf.get_item('smtp', 'username'), conf.get_item('smtp', 'password'))
def send_msg( mailsubject, messagefile, recipients = None ):
- mailbody = load_file( conf.get_item('cron', 'mail_templates') + "/" + messagefile)
- msg = MIMEMultipart("alternative")
+ mailbody = load_file( conf.get_item('cron', 'mail_templates') + "/" + messagefile)
+ msg = MIMEMultipart("alternative")
- msg["From"] = conf.get_item('cron', 'notification_email')
- msg["To"] = recipients
- msg["Subject"] = mailsubject
+ msg["From"] = conf.get_item('cron', 'notification_email')
+ msg["To"] = recipients
+ msg["Subject"] = mailsubject
- msg.attach(MIMEText(mailbody, 'plain'))
- msg.attach(MIMEText(markdown.markdown(mailbody), 'html'))
-
- if conf.config_item_set('relay', 'host') and conf.config_item_set('relay', 'enc_port'):
- relay = (conf.get_item('relay', 'host'), int(conf.get_item('relay', 'enc_port')))
- smtp = smtplib.SMTP(relay[0], relay[1])
- authenticate_maybe(smtp)
- smtp.sendmail( conf.get_item('cron', 'notification_email'), recipients, msg.as_string() )
- else:
- LOG.info("Could not send mail due to wrong configuration")
+ msg.attach(MIMEText(mailbody, 'plain'))
+ msg.attach(MIMEText(markdown.markdown(mailbody), 'html'))
+
+ if conf.config_item_set('relay', 'host') and conf.config_item_set('relay', 'enc_port'):
+ relay = (conf.get_item('relay', 'host'), int(conf.get_item('relay', 'enc_port')))
+ smtp = smtplib.SMTP(relay[0], relay[1])
+ authenticate_maybe(smtp)
+ smtp.sendmail( conf.get_item('cron', 'notification_email'), recipients, msg.as_string() )
+ else:
+ LOG.info("Could not send mail due to wrong configuration")
def setup_db_connection(url):
- engine = sqlalchemy.create_engine(url)
- return (engine, engine.connect())
+ engine = sqlalchemy.create_engine(url)
+ return (engine, engine.connect())
def define_db_schema():
- meta = sqlalchemy.MetaData()
+ meta = sqlalchemy.MetaData()
- gpgmw_keys = sqlalchemy.Table('gpgmw_keys', meta,
- sqlalchemy.Column('id', sqlalchemy.Integer, primary_key=True),
- sqlalchemy.Column('email', sqlalchemy.String(256)),
- sqlalchemy.Column('publickey', sqlalchemy.Text),
- sqlalchemy.Column('confirm', sqlalchemy.String(32)),
- sqlalchemy.Column('status', sqlalchemy.Integer),
- sqlalchemy.Column('time', sqlalchemy.DateTime))
+ gpgmw_keys = sqlalchemy.Table('gpgmw_keys', meta,
+ sqlalchemy.Column('id', sqlalchemy.Integer, primary_key=True),
+ sqlalchemy.Column('email', sqlalchemy.String(256)),
+ sqlalchemy.Column('publickey', sqlalchemy.Text),
+ sqlalchemy.Column('confirm', sqlalchemy.String(32)),
+ sqlalchemy.Column('status', sqlalchemy.Integer),
+ sqlalchemy.Column('time', sqlalchemy.DateTime))
- return (gpgmw_keys)
+ return (gpgmw_keys)
# Read configuration from /etc/gpg-mailgate.conf
@@ -96,57 +96,57 @@ LOG = logging.getLogger(__name__)
if conf.config_item_equals('database', 'enabled', 'yes') and conf.config_item_set('database', 'url'):
- (engine, conn) = setup_db_connection(conf.get_item("database", "url"))
- (gpgmw_keys) = define_db_schema()
+ (engine, conn) = setup_db_connection(conf.get_item("database", "url"))
+ (gpgmw_keys) = define_db_schema()
- selq = select(gpgmw_keys.c.publickey, gpgmw_keys.c.id, gpgmw_keys.c.email)\
- .where(and_(gpgmw_keys.c.status == 0, gpgmw_keys.c.confirm == ""))\
- .limit(100)
- LOG.debug(f"Retrieving keys to be processed: {selq}")
- result_set = conn.execute(selq)
+ selq = select(gpgmw_keys.c.publickey, gpgmw_keys.c.id, gpgmw_keys.c.email)\
+ .where(and_(gpgmw_keys.c.status == 0, gpgmw_keys.c.confirm == ""))\
+ .limit(100)
+ LOG.debug(f"Retrieving keys to be processed: {selq}")
+ result_set = conn.execute(selq)
- for row in result_set:
- # delete any other public keys associated with this confirmed email address
- delq = delete(gpgmw_keys).where(and_(gpgmw_keys.c.email == row[2], gpgmw_keys.c.id != row[1]))
- LOG.debug(f"Deleting public keys associated with confirmed email: {delq}")
- conn.execute(delq)
- GnuPG.delete_key(conf.get_item('gpg', 'keyhome'), row[2])
- LOG.info('Deleted key for <' + row[2] + '> via import request')
+ for row in result_set:
+ # delete any other public keys associated with this confirmed email address
+ delq = delete(gpgmw_keys).where(and_(gpgmw_keys.c.email == row[2], gpgmw_keys.c.id != row[1]))
+ LOG.debug(f"Deleting public keys associated with confirmed email: {delq}")
+ conn.execute(delq)
+ GnuPG.delete_key(conf.get_item('gpg', 'keyhome'), row[2])
+ LOG.info('Deleted key for <' + row[2] + '> via import request')
- if row[0].strip(): # we have this so that user can submit blank key to remove any encryption
- if GnuPG.confirm_key(row[0], row[2]):
- GnuPG.add_key(conf.get_item('gpg', 'keyhome'), row[0]) # import the key to gpg
- modq = gpgmw_keys.update().where(gpgmw_keys.c.id == row[1]).values(status = 1)
- LOG.debug(f"Key imported, updating key: {modq}")
- conn.execute(modq) # mark key as accepted
- LOG.warning('Imported key from <' + row[2] + '>')
- if conf.config_item_equals('cron', 'send_email', 'yes'):
- send_msg( "PGP key registration successful", "registrationSuccess.md", row[2] )
- else:
- delq = delete(gpgmw_keys).where(gpgmw_keys.c.id == row[1])
- LOG.debug(f"Cannot confirm key, deleting it: {delq}")
- conn.execute(delq) # delete key
- LOG.warning('Import confirmation failed for <' + row[2] + '>')
- if conf.config_item_equals('cron', 'send_email', 'yes'):
- send_msg( "PGP key registration failed", "registrationError.md", row[2] )
- else:
- # delete key so we don't continue processing it
- delq = delete(gpgmw_keys).where(gpgmw_keys.c.id == row[1])
- LOG.debug(f"Deleting key: {delq}")
- conn.execute(delq)
- if conf.config_item_equals('cron', 'send_email', 'yes'):
- send_msg( "PGP key deleted", "keyDeleted.md", row[2])
+ if row[0].strip(): # we have this so that user can submit blank key to remove any encryption
+ if GnuPG.confirm_key(row[0], row[2]):
+ GnuPG.add_key(conf.get_item('gpg', 'keyhome'), row[0]) # import the key to gpg
+ modq = gpgmw_keys.update().where(gpgmw_keys.c.id == row[1]).values(status = 1)
+ LOG.debug(f"Key imported, updating key: {modq}")
+ conn.execute(modq) # mark key as accepted
+ LOG.warning('Imported key from <' + row[2] + '>')
+ if conf.config_item_equals('cron', 'send_email', 'yes'):
+ send_msg( "PGP key registration successful", "registrationSuccess.md", row[2] )
+ else:
+ delq = delete(gpgmw_keys).where(gpgmw_keys.c.id == row[1])
+ LOG.debug(f"Cannot confirm key, deleting it: {delq}")
+ conn.execute(delq) # delete key
+ LOG.warning('Import confirmation failed for <' + row[2] + '>')
+ if conf.config_item_equals('cron', 'send_email', 'yes'):
+ send_msg( "PGP key registration failed", "registrationError.md", row[2] )
+ else:
+ # delete key so we don't continue processing it
+ delq = delete(gpgmw_keys).where(gpgmw_keys.c.id == row[1])
+ LOG.debug(f"Deleting key: {delq}")
+ conn.execute(delq)
+ if conf.config_item_equals('cron', 'send_email', 'yes'):
+ send_msg( "PGP key deleted", "keyDeleted.md", row[2])
- # delete keys
- stat2q = select(gpgmw_keys.c.email, gpgmw_keys.c.id).where(gpgmw_keys.c.status == 2).limit(100)
- stat2_result_set = conn.execute(stat2q)
+ # delete keys
+ stat2q = select(gpgmw_keys.c.email, gpgmw_keys.c.id).where(gpgmw_keys.c.status == 2).limit(100)
+ stat2_result_set = conn.execute(stat2q)
- for row in stat2_result_set:
- GnuPG.delete_key(conf.get_item('gpg', 'keyhome'), row[0])
- delq = delete(gpgmw_keys).where(gpgmw_keys.c.id == row[1])
- LOG.debug(f"Deleting keys that have already been processed: {delq}")
- conn.execute(delq)
- LOG.info('Deleted key for <' + row[0] + '>')
+ for row in stat2_result_set:
+ GnuPG.delete_key(conf.get_item('gpg', 'keyhome'), row[0])
+ delq = delete(gpgmw_keys).where(gpgmw_keys.c.id == row[1])
+ LOG.debug(f"Deleting keys that have already been processed: {delq}")
+ conn.execute(delq)
+ LOG.info('Deleted key for <' + row[0] + '>')
else:
- print("Warning: doing nothing since database settings are not configured!")
+ print("Warning: doing nothing since database settings are not configured!")
LOG.error("Warning: doing nothing since database settings are not configured!")