src/src/routers/rf_self_action.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) The Exim Maintainers 2023 */
   6 /* Copyright (c) University of Cambridge 1995 - 2009 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8 /* SPDX-License-Identifier: GPL-2.0-or-later */
   9
  10
  11 #include "../exim.h"
  12 #include "rf_functions.h"
  13
  14
  15
  16 /*************************************************
  17 *        Decode actions for self reference       *
  18 *************************************************/
  19
  20 /* This function is called from a number of routers on receiving
  21 HOST_FOUND_LOCAL when looking up a supposedly remote host. The action is
  22 controlled by a generic configuration option called "self" on each router,
  23 which can be one of:
  24
  25    . freeze:                       Log the incident, freeze, and return DEFER
  26
  27    . defer:                        Log the incident and return DEFER
  28
  29    . fail:                         Fail the address
  30
  31    . send:                         Carry on with the delivery regardless -
  32                                    this makes sense only if the SMTP
  33                                    listener on this machine is a differently
  34                                    configured MTA
  35
  36    . pass:                         The router passes; the address
  37                                    gets passed to the next router, overriding
  38                                    the setting of no_more
  39
  40    . reroute:<new-domain>          Change the domain to the given domain
  41                                    and return REROUTE so it gets passed back
  42                                    to the routers.
  43
  44    . reroute:rewrite:<new-domain>  The same, but headers containing the
  45                                    old domain get rewritten.
  46
  47 These string values are interpreted earlier on, and passed into this function
  48 as the values of "code" and "rewrite".
  49
  50 Arguments:
  51   addr       the address being routed
  52   host       the host that is local, with MX set (or -1 if MX not used)
  53   code       the action to be taken (one of the self_xxx enums)
  54   rewrite    TRUE if rewriting headers required for REROUTED
  55   new        new domain to be used for REROUTED
  56   addr_new   child chain for REROUTEED
  57
  58 Returns:   DEFER, REROUTED, PASS, FAIL, or OK, according to the value of code.
  59 */
  60
  61 int
  62 rf_self_action(address_item *addr, host_item *host, int code, BOOL rewrite,
  63   uschar *new, address_item **addr_new)
  64 {
  65 uschar * msg = host->mx >= 0
  66   ? US"lowest numbered MX record points to local host"
  67   : US"remote host address is the local host";
  68
  69 switch (code)
  70   {
  71   case self_freeze:
  72
  73     /* If there is no message id, this is happening during an address
  74     verification, so give information about the address that is being verified,
  75     and where it has come from. Otherwise, during message delivery, the normal
  76     logging for the address will be sufficient. */
  77
  78     if (!message_id[0])
  79       if (sender_fullhost)
  80         log_write(0, LOG_MAIN, "%s: %s (while verifying <%s> from host %s)",
  81           msg, addr->domain, addr->address, sender_fullhost);
  82       else
  83         log_write(0, LOG_MAIN, "%s: %s (while routing <%s>)", msg,
  84           addr->domain, addr->address);
  85     else
  86       log_write(0, LOG_MAIN, "%s: %s", msg, addr->domain);
  87
  88     addr->message = msg;
  89     addr->special_action = SPECIAL_FREEZE;
  90     return DEFER;
  91
  92   case self_defer:
  93     addr->message = msg;
  94     return DEFER;
  95
  96   case self_reroute:
  97     DEBUG(D_route)
  98       debug_printf("%s: %s: domain changed to %s\n", msg, addr->domain, new);
  99     rf_change_domain(addr, new, rewrite, addr_new);
 100     return REROUTED;
 101
 102   case self_send:
 103     DEBUG(D_route)
 104       debug_printf("%s: %s: configured to try delivery anyway\n", msg, addr->domain);
 105     return OK;
 106
 107   case self_pass:    /* This is soft failure; pass to next router */
 108     DEBUG(D_route)
 109       debug_printf("%s: %s: passed to next router (self = pass)\n", msg, addr->domain);
 110     addr->message = msg;
 111     addr->self_hostname = string_copy(host->name);
 112     return PASS;
 113
 114   case self_fail:
 115     DEBUG(D_route)
 116       debug_printf("%s: %s: address failed (self = fail)\n", msg, addr->domain);
 117     addr->message = msg;
 118     setflag(addr, af_pass_message);
 119     return FAIL;
 120   }
 121
 122 return DEFER;   /* paranoia */
 123 }
 124
 125 /* End of rf_self_action.c */