email_handler.py 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  1. """
  2. Handle the email *forward* and *reply*. phase. There are 3 actors:
  3. - website: who sends emails to alias@sl.co address
  4. - SL email handler (this script)
  5. - user personal email: to be protected. Should never leak to website.
  6. This script makes sure that in the forward phase, the email that is forwarded to user personal email has the following
  7. envelope and header fields:
  8. Envelope:
  9. mail from: srs@sl.co # managed by SRS
  10. rcpt to: @personal_email
  11. Header:
  12. From: @website
  13. To: alias@sl.co # so user knows this email is sent to alias
  14. Reply-to: special@sl.co # magic HERE
  15. And in the reply phase:
  16. Envelope:
  17. mail from: srs@sl.co # managed by SRS
  18. rcpt to: @website
  19. Header:
  20. From: alias@sl.co # so for website the email comes from alias. magic HERE
  21. To: @website
  22. The special@sl.co allows to hide user personal email when user clicks "Reply" to the forwarded email.
  23. It should contain the following info:
  24. - alias
  25. - @website
  26. """
  27. import time
  28. from email.message import EmailMessage
  29. from email.parser import Parser
  30. from email.policy import SMTPUTF8
  31. from smtplib import SMTP
  32. from aiosmtpd.controller import Controller
  33. from app.config import EMAIL_DOMAIN, POSTFIX_SERVER, URL
  34. from app.email_utils import notify_admin
  35. from app.extensions import db
  36. from app.log import LOG
  37. from app.models import GenEmail, ForwardEmail, ForwardEmailLog
  38. from app.utils import random_words
  39. from server import create_app
  40. def parse_srs_email(srs) -> str:
  41. """
  42. Parse srs0=8lgw=y6=outlook.com=abcd@mailsl.meo.ovh and return abcd@outlook.com
  43. """
  44. local_part = srs[: srs.find("@")] # srs0=8lgw=y6=outlook.com=abcd
  45. local_email_part = local_part[local_part.rfind("=") + 1 :] # abcd
  46. rest = local_part[: local_part.rfind("=")] # srs0=8lgw=y6=outlook.com
  47. domain_email_part = rest[rest.rfind("=") + 1 :] # outlook.com
  48. return f"{local_email_part}@{domain_email_part}"
  49. class MailHandler:
  50. async def handle_RCPT(self, server, session, envelope, address, rcpt_options):
  51. if not address.endswith(EMAIL_DOMAIN):
  52. LOG.error(f"Not handle email {address}")
  53. return "550 not relaying to that domain"
  54. envelope.rcpt_tos.append(address)
  55. return "250 OK"
  56. async def handle_DATA(self, server, session, envelope):
  57. LOG.debug(">>> New message <<<")
  58. LOG.debug("Mail from %s", envelope.mail_from)
  59. LOG.debug("Rcpt to %s", envelope.rcpt_tos)
  60. message_data = envelope.content.decode("utf8", errors="replace")
  61. # Only when debug
  62. # LOG.debug("Message data:\n")
  63. # LOG.debug(message_data)
  64. # host IP, setup via Docker network
  65. smtp = SMTP(POSTFIX_SERVER, 25)
  66. msg = Parser(policy=SMTPUTF8).parsestr(message_data)
  67. if not envelope.rcpt_tos[0].startswith("reply+"): # Forward case
  68. LOG.debug("Forward phase")
  69. app = create_app()
  70. with app.app_context():
  71. return self.handle_forward(envelope, smtp, msg)
  72. else:
  73. LOG.debug("Reply phase")
  74. app = create_app()
  75. with app.app_context():
  76. return self.handle_reply(envelope, smtp, msg)
  77. def handle_forward(self, envelope, smtp, msg: EmailMessage) -> str:
  78. """return *status_code message*"""
  79. alias = envelope.rcpt_tos[0] # alias@SL
  80. gen_email = GenEmail.get_by(email=alias)
  81. if not gen_email:
  82. LOG.d("alias %s not exist")
  83. return "510 Email not exist"
  84. website_email = parse_srs_email(envelope.mail_from)
  85. forward_email = ForwardEmail.get_by(
  86. gen_email_id=gen_email.id, website_email=website_email
  87. )
  88. if not forward_email:
  89. LOG.debug(
  90. "create forward email for alias %s and website email %s",
  91. alias,
  92. website_email,
  93. )
  94. # todo: make sure reply_email is unique
  95. reply_email = f"reply+{random_words()}@{EMAIL_DOMAIN}"
  96. forward_email = ForwardEmail.create(
  97. gen_email_id=gen_email.id,
  98. website_email=website_email,
  99. reply_email=reply_email,
  100. )
  101. db.session.commit()
  102. forward_log = ForwardEmailLog.create(forward_id=forward_email.id)
  103. if gen_email.enabled:
  104. # add custom header
  105. msg.add_header("X-SimpleLogin-Type", "Forward")
  106. # no need to modify reply-to as it is used in From: header directly
  107. # try:
  108. # msg.add_header("Reply-To", forward_email.reply_email)
  109. # except ValueError:
  110. # # the header exists already
  111. # msg.replace_header("Reply-To", forward_email.reply_email)
  112. # remove reply-to header if present
  113. if msg["Reply-To"]:
  114. LOG.d("Delete reply-to header %s", msg["Reply-To"])
  115. del msg["Reply-To"]
  116. # change the from header so the sender comes from @SL
  117. # so it can pass DMARC check
  118. # replace the email part in from: header
  119. from_header = (
  120. get_email_name(msg["From"])
  121. + " - "
  122. + website_email.replace("@", " at ")
  123. + f" <{forward_email.reply_email}>"
  124. )
  125. msg.replace_header("From", from_header)
  126. LOG.d("new from header:%s", from_header)
  127. # add List-Unsubscribe header
  128. unsubscribe_link = f"{URL}/dashboard/unsubscribe/{gen_email.id}"
  129. add_or_replace_header(msg, "List-Unsubscribe", f"<{unsubscribe_link}>")
  130. original_subject = msg["Subject"]
  131. LOG.d(
  132. "Forward mail from %s to %s, subject %s, mail_options %s, rcpt_options %s ",
  133. website_email,
  134. gen_email.user.email,
  135. original_subject,
  136. envelope.mail_options,
  137. envelope.rcpt_options,
  138. )
  139. smtp.send_message(
  140. msg,
  141. from_addr=envelope.mail_from,
  142. to_addrs=[gen_email.user.email], # user personal email
  143. mail_options=envelope.mail_options,
  144. rcpt_options=envelope.rcpt_options,
  145. )
  146. else:
  147. LOG.d("%s is disabled, do not forward", gen_email)
  148. forward_log.blocked = True
  149. db.session.commit()
  150. return "250 Message accepted for delivery"
  151. def handle_reply(self, envelope, smtp, msg: EmailMessage) -> str:
  152. reply_email = envelope.rcpt_tos[0]
  153. forward_email = ForwardEmail.get_by(reply_email=reply_email)
  154. alias = forward_email.gen_email.email
  155. notify_admin(f"Reply phase used by user: {forward_email.gen_email.user.email} ")
  156. # email seems to come from alias
  157. msg.replace_header("From", alias)
  158. msg.replace_header("To", forward_email.website_email)
  159. # add List-Unsubscribe header
  160. unsubscribe_link = f"{URL}/dashboard/unsubscribe/{forward_email.gen_email_id}"
  161. add_or_replace_header(msg, "List-Unsubscribe", f"<{unsubscribe_link}>")
  162. LOG.d(
  163. "send email from %s to %s, mail_options:%s,rcpt_options:%s",
  164. alias,
  165. forward_email.website_email,
  166. envelope.mail_options,
  167. envelope.rcpt_options,
  168. )
  169. smtp.send_message(
  170. msg,
  171. from_addr=alias,
  172. to_addrs=[forward_email.website_email],
  173. mail_options=envelope.mail_options,
  174. rcpt_options=envelope.rcpt_options,
  175. )
  176. ForwardEmailLog.create(forward_id=forward_email.id, is_reply=True)
  177. db.session.commit()
  178. return "250 Message accepted for delivery"
  179. def add_or_replace_header(msg: EmailMessage, header: str, value: str):
  180. try:
  181. msg.add_header(header, value)
  182. except ValueError:
  183. # the header exists already
  184. msg.replace_header(header, value)
  185. def get_email_name(email_from):
  186. """parse email from header and return the name part
  187. First Last <ab@cd.com> -> First Last
  188. ab@cd.com -> ""
  189. """
  190. if "<" in email_from:
  191. return email_from[: email_from.find("<")].strip()
  192. return ""
  193. if __name__ == "__main__":
  194. controller = Controller(MailHandler(), hostname="0.0.0.0", port=20381)
  195. controller.start()
  196. LOG.d("Start mail controller %s %s", controller.hostname, controller.port)
  197. while True:
  198. time.sleep(10)