summaryrefslogtreecommitdiff
path: root/src/leap/email/smtp/README
diff options
context:
space:
mode:
authorkali <kali@leap.se>2013-01-25 07:44:36 +0900
committerkali <kali@leap.se>2013-01-25 07:44:36 +0900
commit7102309d9636eeb458cc1cdac521a8555172c728 (patch)
tree7c3033c8e30fbfcf0090fee97922bb874e74fd43 /src/leap/email/smtp/README
parentaeabcbd2a771b36ecbd8f4a356e86dd65220ca7b (diff)
parent9efe6ee0fcf0d000d5da60cbf7dddf6479454aa6 (diff)
Merge branch 'develop' of ssh://leap.se/leap_client into develop
Diffstat (limited to 'src/leap/email/smtp/README')
-rw-r--r--src/leap/email/smtp/README41
1 files changed, 41 insertions, 0 deletions
diff --git a/src/leap/email/smtp/README b/src/leap/email/smtp/README
new file mode 100644
index 00000000..a351dcec
--- /dev/null
+++ b/src/leap/email/smtp/README
@@ -0,0 +1,41 @@
+Leap SMTP Relay
+===============
+
+Outgoing mail workflow:
+
+ * LEAP client runs a thin SMTP proxy on the user's device, bound to
+ localhost.
+ * User's MUA is configured outgoing SMTP to localhost
+ * When SMTP proxy receives an email from MUA
+ * SMTP proxy queries Key Manager for the user's private key and public
+ keys of all recipients
+ * Message is signed by sender and encrypted to recipients.
+ * If recipient's key is missing, email goes out in cleartext (unless
+ user has configured option to send only encrypted email)
+ * Finally, message is relayed to provider's SMTP relay
+
+
+Dependencies
+------------
+
+Leap SMTP Relay depends on the following python libraries:
+
+ * Twisted 12.3.0 [1]
+
+[1] http://pypi.python.org/pypi/Twisted/12.3.0
+
+
+How to run
+----------
+
+To launch the SMTP relay, run the following command:
+
+ twistd -y smtprelay.tac
+
+
+Running tests
+-------------
+
+Tests are run using Twisted's Trial API, like this:
+
+ trial leap.email.smtp.tests