Move IP option decode out-of-line
[exim.git] / src / src / smtp_in.c
index adf6c59cb966169b673ca09f01b8578fd2f1e939..9f9ff7016860bcc70e34f7cdfd0b24340d5e0e95 100644 (file)
@@ -72,7 +72,7 @@ enum {
 
   HELO_CMD, EHLO_CMD, DATA_CMD, /* These are listed in the pipelining */
   VRFY_CMD, EXPN_CMD, NOOP_CMD, /* RFC as requiring synchronization */
-  ETRN_CMD,                     /* This by analogy with TURN from the RFC */
+  ATRN_CMD, ETRN_CMD,          /* This by analogy with TURN from the RFC */
   STARTTLS_CMD,                 /* Required by the STARTTLS RFC */
   TLS_AUTH_CMD,                        /* auto-command at start of SSL */
 #ifdef EXPERIMENTAL_XCLIENT
@@ -231,6 +231,7 @@ static smtp_cmd_list cmd_list[] = {
   { "bdat",       sizeof("bdat")-1,       BDAT_CMD, TRUE,  TRUE  },
   { "quit",       sizeof("quit")-1,       QUIT_CMD, FALSE, TRUE  },
   { "noop",       sizeof("noop")-1,       NOOP_CMD, TRUE,  FALSE },
+  { "atrn",       sizeof("atrn")-1,       ATRN_CMD, TRUE,  FALSE },
   { "etrn",       sizeof("etrn")-1,       ETRN_CMD, TRUE,  FALSE },
   { "vrfy",       sizeof("vrfy")-1,       VRFY_CMD, TRUE,  FALSE },
   { "expn",       sizeof("expn")-1,       EXPN_CMD, TRUE,  FALSE },
@@ -350,7 +351,6 @@ static int     smtp_had_error;
 
 /* forward declarations */
 static int smtp_read_command(BOOL check_sync, unsigned buffer_lim);
-static int synprot_error(int type, int code, uschar *data, uschar *errmess);
 static void smtp_quit_handler(uschar **, uschar **);
 static void smtp_rset_handler(void);
 
@@ -464,6 +464,23 @@ smtp_had_eof = smtp_had_error = 0;
 
 
 
+#ifndef DISABLE_DKIM
+/* Feed received message data to the dkim module */
+/*XXX maybe a global dkim_info? */
+void
+smtp_verify_feed(const uschar * s, unsigned n)
+{
+static misc_module_info * dkim_mi = NULL;
+typedef void (*fn_t)(const uschar *, int);
+
+if (!dkim_mi && !(dkim_mi = misc_mod_findonly(US"dkim")))
+  return;
+
+(((fn_t *) dkim_mi->functions)[DKIM_VERIFY_FEED]) (s, n);
+}
+#endif
+
+
 /* Refill the buffer, and notify DKIM verification code.
 Return false for error or EOF.
 */
@@ -507,7 +524,7 @@ if (rc <= 0)
   return FALSE;
   }
 #ifndef DISABLE_DKIM
-dkim_exim_verify_feed(smtp_inbuffer, rc);
+smtp_verify_feed(smtp_inbuffer, rc);
 #endif
 smtp_inend = smtp_inbuffer + rc;
 smtp_inptr = smtp_inbuffer;
@@ -570,7 +587,7 @@ int n = smtp_inend - smtp_inptr;
 if (n > lim)
   n = lim;
 if (n > 0)
-  dkim_exim_verify_feed(smtp_inptr, n);
+  smtp_verify_feed(smtp_inptr, n);
 #endif
 }
 
@@ -726,19 +743,24 @@ bdat_getc(unsigned lim)
 uschar * user_msg = NULL;
 uschar * log_msg;
 
-for(;;)
-  {
 #ifndef DISABLE_DKIM
-  unsigned dkim_save;
+misc_module_info * dkim_info = misc_mod_findonly(US"dkim");
+typedef void (*dkim_pause_t)(BOOL);
+dkim_pause_t dkim_pause;
+
+dkim_pause = dkim_info
+  ? ((dkim_pause_t *) dkim_info->functions)[DKIM_VERIFY_PAUSE] : NULL;
 #endif
 
+for(;;)
+  {
+
   if (chunking_data_left > 0)
     return lwr_receive_getc(chunking_data_left--);
 
   bdat_pop_receive_functions();
 #ifndef DISABLE_DKIM
-  dkim_save = dkim_collect_input;
-  dkim_collect_input = 0;
+  if (dkim_pause) dkim_pause(TRUE);
 #endif
 
   /* Unless PIPELINING was offered, there should be no next command
@@ -767,9 +789,7 @@ for(;;)
   if (chunking_state == CHUNKING_LAST)
     {
 #ifndef DISABLE_DKIM
-    dkim_collect_input = dkim_save;
-    dkim_exim_verify_feed(NULL, 0);    /* notify EOD */
-    dkim_collect_input = 0;
+    smtp_verify_feed(NULL, 0); /* notify EOD */
 #endif
     return EOD;
     }
@@ -843,7 +863,7 @@ next_cmd:
 
       bdat_push_receive_functions();
 #ifndef DISABLE_DKIM
-      dkim_collect_input = dkim_save;
+      if (dkim_pause) dkim_pause(FALSE);
 #endif
       break;   /* to top of main loop */
       }
@@ -1364,6 +1384,9 @@ if (host_checking)
 else if (f.sender_host_unknown || f.sender_host_notsocket)
   g = string_cat(g, sender_ident ? sender_ident : US"NULL");
 
+else if (atrn_mode)
+  g = string_append(g, 2, hostname, US" (ODMR customer)");
+
 else if (f.is_inetd)
   g = string_append(g, 2, hostname, US" (via inetd)");
 
@@ -1681,21 +1704,7 @@ bmi_run = 0;
 bmi_verdicts = NULL;
 #endif
 dnslist_domain = dnslist_matched = NULL;
-#ifndef DISABLE_DKIM
-dkim_cur_signer = dkim_signers =
-dkim_signing_domain = dkim_signing_selector = dkim_signatures = NULL;
-f.dkim_disable_verify = FALSE;
-dkim_collect_input = 0;
-dkim_verify_overall = dkim_verify_status = dkim_verify_reason = NULL;
-dkim_key_length = 0;
-#endif
-#ifdef SUPPORT_DMARC
-f.dmarc_has_been_checked = f.dmarc_disable_verify = f.dmarc_enable_forensic = FALSE;
-#endif
-#ifdef EXPERIMENTAL_ARC
-arc_state = arc_state_reason = NULL;
-arc_received_instance = 0;
-#endif
+
 dsn_ret = 0;
 dsn_envid = NULL;
 deliver_host = deliver_host_address = NULL;    /* Can be set by ACL */
@@ -1943,13 +1952,10 @@ while (done <= 0)
       break;
 
 
-    /* The VRFY, EXPN, HELP, ETRN, and NOOP commands are ignored. */
+    /* The VRFY, EXPN, HELP, ETRN, ATRN and NOOP commands are ignored. */
 
-    case VRFY_CMD:
-    case EXPN_CMD:
-    case HELP_CMD:
-    case NOOP_CMD:
-    case ETRN_CMD:
+    case VRFY_CMD: case EXPN_CMD: case HELP_CMD: case NOOP_CMD:
+    case ETRN_CMD: case ATRN_CMD:
 #ifndef DISABLE_WELLKNOWN
     case WELLKNOWN_CMD:
 #endif
@@ -2078,6 +2084,132 @@ if (log_reject_target)
 }
 
 
+
+
+/* IP options: log and reject the connection.
+
+Deal with any IP options that are set. On the systems I have looked at,
+the value of MAX_IPOPTLEN has been 40, meaning that there should never be
+more logging data than will fit in big_buffer. Nevertheless, after somebody
+questioned this code, I've added in some paranoid checking.
+
+Given the disuse of options on the internet as of 2024 I'm tempted to
+drop the detailed parsing and logging. */
+
+#ifdef GLIBC_IP_OPTIONS
+# if (!defined __GLIBC__) || (__GLIBC__ < 2)
+#  define OPTSTYLE 1
+# else
+#  define OPTSTYLE 2
+# endif
+#elif defined DARWIN_IP_OPTIONS
+# define OPTSTYLE 2
+#else
+# define OPTSTYLE 3
+# endif
+
+#if OPTSTYLE == 1
+# define EXIM_IP_OPT_T struct ip_options
+# define OPTSTART      (ipopt->__data)
+#elif OPTSTYLE == 2
+# define EXIM_IP_OPT_T struct ip_opts
+# define OPTSTART      (ipopt->ip_opts);
+#else
+# define EXIM_IP_OPT_T struct ipoption
+# define OPTSTART      (ipopt->ipopt_list);
+#endif
+
+static BOOL
+smtp_in_reject_options(EXIM_IP_OPT_T * ipopt, EXIM_SOCKLEN_T optlen)
+{
+uschar * p, * pend = big_buffer + big_buffer_size;
+uschar * adptr;
+int optcount, sprint_len;
+struct in_addr addr;
+uschar * optstart = US OPTSTART;
+
+DEBUG(D_receive) debug_printf("IP options exist\n");
+
+p = Ustpcpy(big_buffer, "IP options on incoming call:");
+
+for (uschar * opt = optstart; opt && opt < US (ipopt) + optlen; )
+  switch (*opt)
+    {
+    case IPOPT_EOL:
+      opt = NULL;
+      break;
+
+    case IPOPT_NOP:
+      opt++;
+      break;
+
+    case IPOPT_SSRR:
+    case IPOPT_LSRR:
+      if (!
+# if OPTSTYLE == 1
+          string_format(p, pend-p, " %s [@%s%n",
+            *opt == IPOPT_SSRR ? "SSRR" : "LSRR",
+            inet_ntoa(*(struct in_addr *)&ipopt->faddr),
+            &sprint_len)
+# elif OPTSTYLE == 2
+          string_format(p, pend-p, " %s [@%s%n",
+            *opt == IPOPT_SSRR ? "SSRR" : "LSRR",
+            inet_ntoa(ipopt->ip_dst),
+            &sprint_len)
+# else
+          string_format(p, pend-p, " %s [@%s%n",
+            *opt == IPOPT_SSRR ? "SSRR" : "LSRR",
+            inet_ntoa(ipopt->ipopt_dst),
+            &sprint_len)
+# endif
+         )
+       opt = NULL;
+      else
+       {
+       p += sprint_len;
+       optcount = (opt[1] - 3) / sizeof(struct in_addr);
+       adptr = opt + 3;
+       while (optcount-- > 0)
+         {
+         memcpy(&addr, adptr, sizeof(addr));
+         if (!string_format(p, pend - p - 1, "%s%s%n",
+               optcount == 0 ? ":" : "@", inet_ntoa(addr), &sprint_len))
+           { opt = NULL; goto bad_srr; }
+         p += sprint_len;
+         adptr += sizeof(struct in_addr);
+         }
+       *p++ = ']';
+       opt += opt[1];
+       }
+bad_srr:    break;
+
+    default:
+      if (pend - p < 4 + 3*opt[1])
+       opt = NULL;
+      else
+       {
+       p = Ustpcpy(p, "[ ");
+       for (int i = 0; i < opt[1]; i++)
+         p += sprintf(CS p, "%2.2x ", opt[i]);
+       *p++ = ']';
+       opt += opt[1];
+       }
+      break;
+    }
+
+*p = '\0';
+log_write(0, LOG_MAIN, "%s", big_buffer);
+
+/* Refuse any call with IP options. This is what tcpwrappers 7.5 does. */
+
+log_write(0, LOG_MAIN|LOG_REJECT,
+  "connection from %s refused (IP options)", host_and_ident(FALSE));
+
+smtp_printf("554 SMTP service not available\r\n", SP_NO_MORE);
+return FALSE;
+}
+
+
 /*************************************************
 *          Start an SMTP session                 *
 *************************************************/
@@ -2126,10 +2258,13 @@ if (!host_checking && !f.sender_host_notsocket)
 authenticated_by = NULL;
 
 #ifndef DISABLE_TLS
-tls_in.ver = tls_in.cipher = tls_in.peerdn = NULL;
-tls_in.ourcert = tls_in.peercert = NULL;
-tls_in.sni = NULL;
-tls_in.ocsp = OCSP_NOT_REQ;
+if (!atrn_mode)
+  {
+  tls_in.ver = tls_in.cipher = tls_in.peerdn = NULL;
+  tls_in.ourcert = tls_in.peercert = NULL;
+  tls_in.sni = NULL;
+  tls_in.ocsp = OCSP_NOT_REQ;
+  }
 fl.tls_advertised = FALSE;
 #endif
 fl.dsn_advertised = FALSE;
@@ -2168,13 +2303,28 @@ call the local functions instead of the standard C ones. */
 
 smtp_buf_init();
 
-receive_getc = smtp_getc;
-receive_getbuf = smtp_getbuf;
-receive_get_cache = smtp_get_cache;
-receive_hasc = smtp_hasc;
-receive_ungetc = smtp_ungetc;
-receive_feof = smtp_feof;
-receive_ferror = smtp_ferror;
+#ifndef DISABLE_TLS
+if (atrn_mode && tls_in.active.sock >= 0)
+  {
+  receive_getc = tls_getc;
+  receive_getbuf = tls_getbuf;
+  receive_get_cache = tls_get_cache;
+  receive_hasc = tls_hasc;
+  receive_ungetc = tls_ungetc;
+  receive_feof = tls_feof;
+  receive_ferror = tls_ferror;
+  }
+else
+#endif
+  {
+  receive_getc = smtp_getc;
+  receive_getbuf = smtp_getbuf;
+  receive_get_cache = smtp_get_cache;
+  receive_hasc = smtp_hasc;
+  receive_ungetc = smtp_ungetc;
+  receive_feof = smtp_feof;
+  receive_ferror = smtp_ferror;
+  }
 lwr_receive_getc = NULL;
 lwr_receive_getbuf = NULL;
 lwr_receive_hasc = NULL;
@@ -2238,31 +2388,15 @@ if (!f.sender_host_unknown)
 
 #if !HAVE_IPV6 && !defined(NO_IP_OPTIONS)
 
-# ifdef GLIBC_IP_OPTIONS
-#  if (!defined __GLIBC__) || (__GLIBC__ < 2)
-#   define OPTSTYLE 1
-#  else
-#   define OPTSTYLE 2
-#  endif
-# elif defined DARWIN_IP_OPTIONS
-# define OPTSTYLE 2
-# else
-# define OPTSTYLE 3
-# endif
-
   if (!host_checking && !f.sender_host_notsocket)
     {
 # if OPTSTYLE == 1
-    EXIM_SOCKLEN_T optlen = sizeof(struct ip_options) + MAX_IPOPTLEN;
-    struct ip_options *ipopt = store_get(optlen, GET_UNTAINTED);
-# elif OPTSTYLE == 2
-    struct ip_opts ipoptblock;
-    struct ip_opts *ipopt = &ipoptblock;
-    EXIM_SOCKLEN_T optlen = sizeof(ipoptblock);
+    EXIM_SOCKLEN_T optlen = sizeof(EXIM_IP_OPT_T) + MAX_IPOPTLEN;
+    EXIM_IP_OPT_T * ipopt = store_get(optlen, GET_UNTAINTED);
 # else
-    struct ipoption ipoptblock;
-    struct ipoption *ipopt = &ipoptblock;
-    EXIM_SOCKLEN_T optlen = sizeof(ipoptblock);
+    EXIM_IP_OPT_T ipoptblock;
+    EXIM_IP_OPT_T * ipopt = &ipoptblock;
+    EXIM_SOCKLEN_T optlen = sizeof(EXIM_IP_OPT_T);
 # endif
 
     /* Occasional genuine failures of getsockopt() have been seen - for
@@ -2274,7 +2408,7 @@ if (!f.sender_host_unknown)
 
     DEBUG(D_receive) debug_printf("checking for IP options\n");
 
-    if (getsockopt(fileno(smtp_out), IPPROTO_IP, IP_OPTIONS, US (ipopt),
+    if (getsockopt(fileno(smtp_out), IPPROTO_IP, IP_OPTIONS, US ipopt,
           &optlen) < 0)
       {
       if (errno != ENOPROTOOPT)
@@ -2292,102 +2426,7 @@ if (!f.sender_host_unknown)
     questioned this code, I've added in some paranoid checking. */
 
     else if (optlen > 0)
-      {
-      uschar * p = big_buffer;
-      uschar * pend = big_buffer + big_buffer_size;
-      uschar * adptr;
-      int optcount;
-      struct in_addr addr;
-
-# if OPTSTYLE == 1
-      uschar * optstart = US (ipopt->__data);
-# elif OPTSTYLE == 2
-      uschar * optstart = US (ipopt->ip_opts);
-# else
-      uschar * optstart = US (ipopt->ipopt_list);
-# endif
-
-      DEBUG(D_receive) debug_printf("IP options exist\n");
-
-      Ustrcpy(p, "IP options on incoming call:");
-      p += Ustrlen(p);
-
-      for (uschar * opt = optstart; opt && opt < US (ipopt) + optlen; )
-        switch (*opt)
-          {
-          case IPOPT_EOL:
-           opt = NULL;
-           break;
-
-          case IPOPT_NOP:
-           opt++;
-           break;
-
-          case IPOPT_SSRR:
-          case IPOPT_LSRR:
-           if (!
-# if OPTSTYLE == 1
-                string_format(p, pend-p, " %s [@%s",
-                (*opt == IPOPT_SSRR)? "SSRR" : "LSRR",
-                inet_ntoa(*((struct in_addr *)(&(ipopt->faddr)))))
-# elif OPTSTYLE == 2
-                string_format(p, pend-p, " %s [@%s",
-                (*opt == IPOPT_SSRR)? "SSRR" : "LSRR",
-                inet_ntoa(ipopt->ip_dst))
-# else
-                string_format(p, pend-p, " %s [@%s",
-                (*opt == IPOPT_SSRR)? "SSRR" : "LSRR",
-                inet_ntoa(ipopt->ipopt_dst))
-# endif
-             )
-             {
-             opt = NULL;
-             break;
-             }
-
-           p += Ustrlen(p);
-           optcount = (opt[1] - 3) / sizeof(struct in_addr);
-           adptr = opt + 3;
-           while (optcount-- > 0)
-             {
-             memcpy(&addr, adptr, sizeof(addr));
-             if (!string_format(p, pend - p - 1, "%s%s",
-                   (optcount == 0)? ":" : "@", inet_ntoa(addr)))
-               {
-               opt = NULL;
-               break;
-               }
-             p += Ustrlen(p);
-             adptr += sizeof(struct in_addr);
-             }
-           *p++ = ']';
-           opt += opt[1];
-           break;
-
-          default:
-             {
-             if (pend - p < 4 + 3*opt[1]) { opt = NULL; break; }
-             Ustrcat(p, "[ ");
-             p += 2;
-             for (int i = 0; i < opt[1]; i++)
-               p += sprintf(CS p, "%2.2x ", opt[i]);
-             *p++ = ']';
-             }
-           opt += opt[1];
-           break;
-          }
-
-      *p = 0;
-      log_write(0, LOG_MAIN, "%s", big_buffer);
-
-      /* Refuse any call with IP options. This is what tcpwrappers 7.5 does. */
-
-      log_write(0, LOG_MAIN|LOG_REJECT,
-        "connection from %s refused (IP options)", host_and_ident(FALSE));
-
-      smtp_printf("554 SMTP service not available\r\n", SP_NO_MORE);
-      return FALSE;
-      }
+      return smtp_in_reject_options(ipopt);
 
     /* Length of options = 0 => there are no options */
 
@@ -2725,7 +2764,8 @@ smtp_printf("%Y",
 handshake arrived.  If so we must have managed a TFO. */
 
 #ifdef TCP_FASTOPEN
-if (sender_host_address && !f.sender_host_notsocket) tfo_in_check();
+if (sender_host_address && !f.sender_host_notsocket && !atrn_mode)
+  tfo_in_check();
 #endif
 
 return TRUE;
@@ -2755,7 +2795,7 @@ Returns:    -1   limit of syntax/protocol errors NOT exceeded
 These values fit in with the values of the "done" variable in the main
 processing loop in smtp_setup_msg(). */
 
-static int
+int
 synprot_error(int type, int code, uschar *data, uschar *errmess)
 {
 int yield = -1;
@@ -3688,7 +3728,7 @@ cmd_list[CL_EHLO].is_mail_cmd = TRUE;
 cmd_list[CL_STLS].is_mail_cmd = TRUE;
 #endif
 
-if (lwr_receive_getc != NULL)
+if (lwr_receive_getc && !atrn_mode)
   {
   /* This should have already happened, but if we've gotten confused,
   force a reset here. */
@@ -3716,23 +3756,17 @@ value. The values are 2 larger than the required yield of the function. */
 
 while (done <= 0)
   {
-  const uschar **argv;
-  uschar *etrn_command;
-  uschar *etrn_serialize_key;
-  uschar *errmess;
-  uschar *log_msg, *smtp_code;
-  uschar *user_msg = NULL;
-  uschar *recipient = NULL;
-  uschar *hello = NULL;
-  uschar *s, *ss;
-  BOOL was_rej_mail = FALSE;
-  BOOL was_rcpt = FALSE;
+  const uschar ** argv;
+  uschar * etrn_command, * etrn_serialize_key, * errmess;
+  uschar * log_msg, * smtp_code;
+  uschar * user_msg = NULL, * recipient = NULL, * hello = NULL;
+  uschar * s, * ss;
+  BOOL was_rej_mail = FALSE, was_rcpt = FALSE;
   void (*oldsignal)(int);
   pid_t pid;
   int start, end, sender_domain, recipient_domain;
-  int rc, c;
+  int rc, c, dsn_flags;
   uschar * orcpt = NULL;
-  int dsn_flags;
   gstring * g;
 
 #ifdef AUTH_TLS
@@ -4155,9 +4189,20 @@ while (done <= 0)
          fl.dsn_advertised = TRUE;
          }
 
-       /* Advertise ETRN/VRFY/EXPN if there's are ACL checking whether a host is
-       permitted to issue them; a check is made when any host actually tries. */
+       /* Advertise ATRN/ETRN/VRFY/EXPN if there's are ACL checking whether a
+       host is permitted to issue them; a check is made when any host actually
+       tries. */
 
+       GET_OPTION("acl_smtp_atrn");
+       if (acl_smtp_atrn && !atrn_mode)
+         {
+         const uschar * s = expand_cstring(acl_smtp_atrn);
+         if (s && *s)
+           {
+           g = string_catn(g, smtp_code, 3);
+           g = string_catn(g, US"-ATRN\r\n", 7);
+           }
+         }
        GET_OPTION("acl_smtp_etrn");
        if (acl_smtp_etrn)
          {
@@ -5514,6 +5559,7 @@ while (done <= 0)
 #endif
       smtp_printf(" HELO EHLO MAIL RCPT DATA BDAT", SP_MORE);
       smtp_printf(" NOOP QUIT RSET HELP", SP_MORE);
+      if (acl_smtp_atrn) smtp_printf(" ATRN", SP_MORE);
       if (acl_smtp_etrn) smtp_printf(" ETRN", SP_MORE);
       if (acl_smtp_expn) smtp_printf(" EXPN", SP_MORE);
       if (acl_smtp_vrfy) smtp_printf(" VRFY", SP_MORE);
@@ -5563,6 +5609,11 @@ while (done <= 0)
       break;
 
 
+    case ATRN_CMD:
+      HAD(SCH_ATRN);
+      done = atrn_handle_provider(&user_msg, &log_msg);        /* Normal: exit() */
+      break;                                           /* Error cases */
+
     case ETRN_CMD:
       HAD(SCH_ETRN);
       if (sender_address)