6593ef2b6ede6e728d3d619f8097ea632b24a5f8
[exim.git] / src / src / routers / rf_get_errors_address.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) The Exim Maintainers 2020 - 2024 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
9
10 #include "../exim.h"
11 #include "rf_functions.h"
12
13
14 /*************************************************
15 *        Get errors address for a router         *
16 *************************************************/
17
18 /* This function is called by routers to sort out the errors address for a
19 particular address. If there is a setting in the router block, then expand and
20 verify it, and if it works, use it. Otherwise use any setting that is in the
21 address itself. This might be NULL, meaning unset (the message's sender is then
22 used). Verification isn't done when the original address is just being
23 verified, as otherwise there might be routing loops if someone sets up a silly
24 configuration.
25
26 Arguments:
27   addr         the input address
28   rblock       the router instance
29   verify       v_none / v_recipient / v_sender / v_expn
30   errors_to    point the errors address here
31
32 Returns:       OK if no problem
33                DEFER if verifying the address caused a deferment
34                  or a big disaster (e.g. expansion failure)
35 */
36
37 int
38 rf_get_errors_address(address_item * addr, router_instance * rblock,
39   int verify, const uschar ** errors_to)
40 {
41 uschar * s;
42
43 *errors_to = addr->prop.errors_address;
44 if (!rblock->errors_to) return OK;
45
46 GET_OPTION("errors_to");
47 if (!(s = expand_string(rblock->errors_to)))
48   {
49   if (f.expand_string_forcedfail)
50     {
51     DEBUG(D_route)
52       debug_printf("forced expansion failure - ignoring errors_to\n");
53     return OK;
54     }
55   addr->message = string_sprintf("%s router failed to expand \"%s\": %s",
56     rblock->drinst.name, rblock->errors_to, expand_string_message);
57   return DEFER;
58   }
59
60 /* If the errors_to address is empty, it means "ignore errors" */
61
62 if (!*s)
63   {
64   addr->prop.ignore_error = TRUE;   /* For locally detected errors */
65   *errors_to = US"";                   /* Return path for SMTP */
66   return OK;
67   }
68
69 /* If we are already verifying, do not check the errors address, in order to
70 save effort (but we do verify when testing an address). When we do verify, set
71 the sender address to null, because that's what it will be when sending an
72 error message, and there are now configuration options that control the running
73 of routers by checking the sender address. When testing an address, there may
74 not be a sender address. We also need to save and restore the expansion values
75 associated with an address. */
76
77 if (verify != v_none)
78   {
79   *errors_to = s;
80   DEBUG(D_route)
81     debug_printf("skipped verify errors_to address: already verifying\n");
82   }
83 else
84   {
85   BOOL save_address_test_mode = f.address_test_mode;
86   const uschar * save_sender = sender_address;
87   int i;
88   const uschar ***p;
89   const uschar *address_expansions_save[ADDRESS_EXPANSIONS_COUNT];
90   address_item *snew = deliver_make_addr(s, FALSE);
91
92   if (sender_address)
93     sender_address = US"";
94
95   for (i = 0, p = address_expansions; *p;)
96     address_expansions_save[i++] = **p++;
97   f.address_test_mode = FALSE;
98
99   /* NOTE: the address is verified as a recipient, not a sender. This is
100   perhaps confusing. It isn't immediately obvious what to do: we want to have
101   some confidence that we can deliver to the address, in which case it will be
102   a recipient, but on the other hand, it will be passed on in SMTP deliveries
103   as a sender. However, I think on balance recipient is right because sender
104   verification is really about the *incoming* sender of the message.
105
106   If this code is changed, note that you must set vopt_fake_sender instead of
107   vopt_is_recipient, as otherwise sender_address may be altered because
108   verify_address() thinks it is dealing with *the* sender of the message. */
109
110   DEBUG(D_route|D_verify)
111     debug_printf("------ Verifying errors address %s ------\n", s);
112   if (verify_address(snew, NULL,
113       vopt_is_recipient /* vopt_fake_sender is the alternative */
114       | vopt_qualify, -1, -1, -1, NULL, NULL, NULL) == OK)
115     *errors_to = snew->address;
116   DEBUG(D_route|D_verify)
117     debug_printf("------ End verifying errors address %s ------\n", s);
118
119   f.address_test_mode = save_address_test_mode;
120   for (i = 0, p = address_expansions; *p; )
121     **p++ = address_expansions_save[i++];
122
123   sender_address = save_sender;
124   }
125
126 return OK;
127 }
128
129 /* End of rf_get_errors_address.c */