First trial

README.md

@@ -8,5 +8,37 @@ The intention of this project is to deploy the milter ALWAYS AND ONLY as an [OCI
 The following [docker-compose](https://docs.docker.com/compose/) file demonstrates how such a setup could be orchestrated on a single docker host or on a docker swarm cluster. In this context we use [postfix](http://www.postfix.org) as our milter-aware MTA.
 
 ```
-*TODO*
+version: '3'
+
+volumes:
+  sosm_socket:
+
+services:
+  sos-milter:
+    image: "sos-milter/debian:19.06_master"
+    restart: unless-stopped
+    environment:
+      LOG_LEVEL: debug
+      # default: test, possible: test,reject
+      MILTER_MODE: reject
+      MILTER_NAME: sos-milter
+      #MILTER_SOCKET: inet6:8020
+      #MILTER_REJECT_MESSAGE: Message rejected due to security policy violation!
+      #MILTER_TMPFAIL_MESSAGE: Message temporary rejected. Please try again later ;)
+      SPF_REGEX: '^.*include:secure-mailgate\.com.*$$'
+    hostname: sos-milter
+    volumes:
+    - "sosm_socket:/socket/:rw"
+
+  postfix:
+    depends_on:
+    - sos-milter
+    image: "postfix/alpine/amd64"
+    restart: unless-stopped
+    hostname: postfix
+    ports:
+    - "1587:587"
+    volumes:
+    - "./config/postfix:/etc/postfix:ro"
+    - "sosm_socket:/socket/sos-milter/:rw"
 ```

app/sos-milter.py

@@ -14,7 +14,9 @@ g_milter_name = 'sos-milter'
 g_milter_socket = '/socket/' + g_milter_name
 g_milter_reject_message = 'Security policy violation!'
 g_milter_tmpfail_message = 'Service temporarily not available! Please try again later.'
-g_re_domain = re.compile(r'^\S*@(\S+)$')
+g_re_domain = re.compile(r'^\S*@(\S+)$', re.IGNORECASE)
+g_re_spf_regex = re.compile(r'.*', re.IGNORECASE)
+g_re_expected_txt_data = ''
 g_loglevel = logging.INFO
 g_milter_mode = 'test'
 g_milter_default_policy = 'reject'
@@ -25,6 +27,8 @@ class SOSMilter(Milter.Base):
     self.time_start = timer()
     self.env_from = None
     self.env_from_domain = None
+    self.spf_record = None
+    self.add_header = False
     # https://stackoverflow.com/a/2257449
     self.mconn_id = g_milter_name + ': ' + ''.join(
       random.choice(string.ascii_lowercase + string.digits) for _ in range(8)
@@ -34,7 +38,7 @@ class SOSMilter(Milter.Base):
   def connect(self, IPname, family, hostaddr):
     return Milter.CONTINUE
   @Milter.nocallback
-  def hello(self, heloname)
+  def hello(self, heloname):
     return Milter.CONTINUE
   @Milter.nocallback
   def envrcpt(self, to, *str):
@@ -53,11 +57,12 @@ class SOSMilter(Milter.Base):
     return Milter.CONTINUE
 
   def envfrom(self, mailfrom, *str):
+    try:
       mailfrom = mailfrom.replace("<","")
       mailfrom = mailfrom.replace(">","")
       self.env_from = mailfrom
       m = g_re_domain.match(self.env_from)
-    if m == None:
+      if m is None:
         logging.error(self.mconn_id + "/FROM " +
           "Could not determine domain of 5321.from=" + self.env_from
         )
@@ -67,16 +72,66 @@ class SOSMilter(Milter.Base):
       logging.debug(self.mconn_id +
         "/FROM env_from_domain=" + self.env_from_domain
       )
-    # Get SPF record of sender domain
+      # Get TXT record of sender domain
+      dns_response = None
+      try:
         dns_response = dns.resolver.query(self.env_from_domain, 'TXT')
-    for rdata in dns_response:
+      except:
-      logging.debug(self.mconn_id +
+        logging.error("DNS-Resolver-EXCEPTION: " + traceback.format_exc())
-        "RDATA: " + str(rdata)
+        # accept message if DNS-resolver fails
-      )
         return Milter.CONTINUE
+      spf_count = 0
+      for rdata in dns_response:
+        if re.match(r'^"v=spf1.*"$', rdata.to_text(), re.IGNORECASE):
+          # we´ve got a SPF match!
+          spf_count += 1
+          self.spf_record = rdata.to_text()
+          logging.debug(self.mconn_id + "/FROM " +
+            "SPFv1: " + self.spf_record
+          )
+          if re.match(r'^".+-all"$', self.spf_record, re.IGNORECASE) is not None:
+            # SPF record is in agressive mode!
+            if g_re_spf_regex.match(self.spf_record) is not None:
+              logging.debug(self.mconn_id + "/FROM" +
+                " SPF-record of sender-domain " + self.env_from_domain +
+                " permits us to relay this message"
+              )
+            else:
+              ex = "Agressive SPF-record (-all) of sender-domain " + self.env_from_domain + " does not permit us to relay this message!"
+              # Expected 'include' not found in SPF-record
+              logging.debug(self.mconn_id + "/FROM " + ex)
+              if g_milter_mode == 'test':
+                logging.debug(self.mconn_id + "/FROM " +
+                  ' test-mode: X-SOS-Milter header will be added'
+                )
+                self.add_header = True
+              else:
+                logging.error(self.mconn_id + "/FROM " + ex)
+                self.setreply('550','5.7.1',
+                  self.mconn_id + ' ' + ex + ' Please contact your postmaster!'
+                )
+                return Milter.REJECT
+      if spf_count > 1:
+        ex = "Sender-domain " + self.env_from_domain + " has more than one SPF-TXT-records in DNS!"""
+        logging.error(self.mconn_id + "/FROM " + ex)
+        if g_milter_mode == 'reject':
+          self.setreply('550','5.7.1',
+            self.mconn_id + ' ' + ex + ' Please contact your postmaster!'
+          )
+          return Milter.REJECT
+      return Milter.CONTINUE
+    except:
+      logging.error("FROM-EXCEPTION: " + traceback.format_exc())
+      self.setreply('450','4.7.1', g_milter_tmpfail_message)
+      return Milter.TEMPFAIL
 
   def eom(self):
     # EOM is not optional and thus, always called by MTA
+    if self.add_header == True:
+      self.addheader(
+        'X-SOS-Milter',
+        self.mconn_id + ' ' + self.env_from_domain + ': failed SPF-expectation'
+      )
     return Milter.CONTINUE
 
   def abort(self):
@@ -121,6 +176,12 @@ if __name__ == "__main__":
     g_milter_reject_message = os.environ['MILTER_REJECT_MESSAGE']
   if 'MILTER_TMPFAIL_MESSAGE' in os.environ:
     g_milter_tmpfail_message = os.environ['MILTER_TMPFAIL_MESSAGE']
+  if 'SPF_REGEX' in os.environ:
+    try:
+      g_re_spf_regex = re.compile(os.environ['SPF_REGEX'], re.IGNORECASE)
+    except:
+      logging.error("ENV[SPF_REGEX] exception: " + traceback.format_exc())
+      sys.exit(1)
   try:
     timeout = 600
     # Register to have the Milter factory create instances of your class: