7faaea0cd06cddd71fabf9f79a8d7b3552763011
[exim.git] / src / src / routers / iplookup.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) The Exim Maintainers 2020 - 2022 */
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
11 #include "../exim.h"
12 #include "rf_functions.h"
13 #include "iplookup.h"
14
15
16 /* IP connection types */
17
18 #define ip_udp 0
19 #define ip_tcp 1
20
21
22 /* Options specific to the iplookup router. */
23
24 optionlist iplookup_router_options[] = {
25   { "hosts",    opt_stringptr,
26       OPT_OFF(iplookup_router_options_block, hosts) },
27   { "optional", opt_bool,
28       OPT_OFF(iplookup_router_options_block, optional) },
29   { "port",     opt_int,
30       OPT_OFF(iplookup_router_options_block, port) },
31   { "protocol", opt_stringptr,
32       OPT_OFF(iplookup_router_options_block, protocol_name) },
33   { "query",    opt_stringptr,
34       OPT_OFF(iplookup_router_options_block, query) },
35   { "reroute",  opt_stringptr,
36       OPT_OFF(iplookup_router_options_block, reroute) },
37   { "response_pattern", opt_stringptr,
38       OPT_OFF(iplookup_router_options_block, response_pattern) },
39   { "timeout",  opt_time,
40       OPT_OFF(iplookup_router_options_block, timeout) }
41 };
42
43 /* Size of the options list. An extern variable has to be used so that its
44 address can appear in the tables drtables.c. */
45
46 int iplookup_router_options_count =
47   sizeof(iplookup_router_options)/sizeof(optionlist);
48
49
50 #ifdef MACRO_PREDEF
51
52 /* Dummy entries */
53 iplookup_router_options_block iplookup_router_option_defaults = {0};
54 void iplookup_router_init(router_instance *rblock) {}
55 int iplookup_router_entry(router_instance *rblock, address_item *addr,
56   struct passwd *pw, int verify, address_item **addr_local,
57   address_item **addr_remote, address_item **addr_new,
58   address_item **addr_succeed) {return 0;}
59
60 #else   /*!MACRO_PREDEF*/
61
62
63 /* Default private options block for the iplookup router. */
64
65 iplookup_router_options_block iplookup_router_option_defaults = {
66   -1,       /* port */
67   ip_udp,   /* protocol */
68   5,        /* timeout */
69   NULL,     /* protocol_name */
70   NULL,     /* hosts */
71   NULL,     /* query; NULL => local_part@domain */
72   NULL,     /* response_pattern; NULL => don't apply regex */
73   NULL,     /* reroute; NULL => just used returned data */
74   NULL,     /* re_response_pattern; compiled pattern */
75   FALSE     /* optional */
76 };
77
78
79
80 /*************************************************
81 *          Initialization entry point            *
82 *************************************************/
83
84 /* Called for each instance, after its options have been read, to enable
85 consistency checks to be done, or anything else that needs to be set up. */
86
87 void
88 iplookup_router_init(router_instance * rblock)
89 {
90 iplookup_router_options_block * ob =
91   (iplookup_router_options_block *) rblock->options_block;
92
93 /* A port and a host list must be given */
94
95 if (ob->port < 0)
96   log_write(0, LOG_PANIC_DIE|LOG_CONFIG_FOR, "%s router:\n  "
97     "a port must be specified", rblock->name);
98
99 if (!ob->hosts)
100   log_write(0, LOG_PANIC_DIE|LOG_CONFIG_FOR, "%s router:\n  "
101     "a host list must be specified", rblock->name);
102
103 /* Translate protocol name into value */
104
105 if (ob->protocol_name)
106   {
107   if (Ustrcmp(ob->protocol_name, "udp") == 0) ob->protocol = ip_udp;
108   else if (Ustrcmp(ob->protocol_name, "tcp") == 0) ob->protocol = ip_tcp;
109   else log_write(0, LOG_PANIC_DIE|LOG_CONFIG_FOR, "%s router:\n  "
110     "protocol not specified as udp or tcp", rblock->name);
111   }
112
113 /* If a response pattern is given, compile it now to get the error early. */
114
115 if (ob->response_pattern)
116   ob->re_response_pattern =
117     regex_must_compile(ob->response_pattern, MCS_NOFLAGS, TRUE);
118 }
119
120
121
122 /*************************************************
123 *              Main entry point                  *
124 *************************************************/
125
126 /* See local README for interface details. This router returns:
127
128 DECLINE
129   . pattern or identification match on returned data failed
130
131 DEFER
132   . failed to expand the query or rerouting string
133   . failed to create socket ("optional" not set)
134   . failed to find a host, failed to connect, timed out ("optional" not set)
135   . rerouting string is not in the form localpart@domain
136   . verifying the errors address caused a deferment or a big disaster such
137       as an expansion failure (rf_get_errors_address)
138   . expanding a headers_{add,remove} string caused a deferment or another
139       expansion error (rf_get_munge_headers)
140
141 PASS
142   . failed to create socket ("optional" set)
143   . failed to find a host, failed to connect, timed out ("optional" set)
144
145 OK
146   . new address added to addr_new
147 */
148
149 int
150 iplookup_router_entry(
151   router_instance *rblock,        /* data for this instantiation */
152   address_item *addr,             /* address we are working on */
153   struct passwd *pw,              /* passwd entry after check_local_user */
154   int verify,                     /* v_none/v_recipient/v_sender/v_expn */
155   address_item **addr_local,      /* add it to this if it's local */
156   address_item **addr_remote,     /* add it to this if it's remote */
157   address_item **addr_new,        /* put new addresses on here */
158   address_item **addr_succeed)    /* put old address here on success */
159 {
160 uschar *query = NULL;
161 uschar *reply;
162 uschar *hostname, *reroute, *domain;
163 const uschar *listptr;
164 uschar host_buffer[256];
165 host_item *host = store_get(sizeof(host_item), GET_UNTAINTED);
166 address_item *new_addr;
167 iplookup_router_options_block *ob =
168   (iplookup_router_options_block *)(rblock->options_block);
169 const pcre2_code *re = ob->re_response_pattern;
170 int count, query_len, rc;
171 int sep = 0;
172
173 DEBUG(D_route) debug_printf("%s router called for %s: domain = %s\n",
174   rblock->name, addr->address, addr->domain);
175
176 reply = store_get(256, GET_TAINTED);
177
178 /* Build the query string to send. If not explicitly given, a default of
179 "user@domain user@domain" is used. */
180
181 if (ob->query == NULL)
182   query = string_sprintf("%s@%s %s@%s", addr->local_part, addr->domain,
183     addr->local_part, addr->domain);
184 else
185   {
186   query = expand_string(ob->query);
187   if (query == NULL)
188     {
189     addr->message = string_sprintf("%s router: failed to expand %s: %s",
190       rblock->name, ob->query, expand_string_message);
191     return DEFER;
192     }
193   }
194
195 query_len = Ustrlen(query);
196 DEBUG(D_route) debug_printf("%s router query is \"%s\"\n", rblock->name,
197   string_printing(query));
198
199 /* Now connect to the required port for each of the hosts in turn, until a
200 response it received. Initialization insists on the port being set and there
201 being a host list. */
202
203 listptr = ob->hosts;
204 /* not expanded so should never be tainted */
205 while ((hostname = string_nextinlist(&listptr, &sep, host_buffer,
206        sizeof(host_buffer))))
207   {
208   host_item *h;
209
210   DEBUG(D_route) debug_printf("calling host %s\n", hostname);
211
212   host->name = hostname;
213   host->address = NULL;
214   host->port = PORT_NONE;
215   host->mx = MX_NONE;
216   host->next = NULL;
217
218   if (string_is_ip_address(host->name, NULL) != 0)
219     host->address = host->name;
220   else
221     {
222 /*XXX might want dnssec request/require on an iplookup router? */
223     int rc = host_find_byname(host, NULL, HOST_FIND_QUALIFY_SINGLE, NULL, TRUE);
224     if (rc == HOST_FIND_FAILED || rc == HOST_FIND_AGAIN) continue;
225     }
226
227   /* Loop for possible multiple IP addresses for the given name. */
228
229   for (h = host; h; h = h->next)
230     {
231     int host_af;
232     client_conn_ctx query_cctx = {0};
233
234     /* Skip any hosts for which we have no address */
235
236     if (!h->address) continue;
237
238     /* Create a socket, for UDP or TCP, as configured. IPv6 addresses are
239     detected by checking for a colon in the address. */
240
241     host_af = (Ustrchr(h->address, ':') != NULL)? AF_INET6 : AF_INET;
242
243     query_cctx.sock = ip_socket(ob->protocol == ip_udp ? SOCK_DGRAM:SOCK_STREAM,
244       host_af);
245     if (query_cctx.sock < 0)
246       {
247       if (ob->optional) return PASS;
248       addr->message = string_sprintf("failed to create socket in %s router",
249         rblock->name);
250       return DEFER;
251       }
252
253     /* Connect to the remote host, under a timeout. In fact, timeouts can occur
254     here only for TCP calls; for a UDP socket, "connect" always works (the
255     router will timeout later on the read call). */
256 /*XXX could take advantage of TFO */
257
258     if (ip_connect(query_cctx.sock, host_af, h->address,ob->port, ob->timeout,
259                 ob->protocol == ip_udp ? NULL : &tcp_fastopen_nodata) < 0)
260       {
261       close(query_cctx.sock);
262       DEBUG(D_route)
263         debug_printf("connection to %s failed: %s\n", h->address,
264           strerror(errno));
265       continue;
266       }
267
268     /* Send the query. If it fails, just continue with the next address. */
269
270     if (send(query_cctx.sock, query, query_len, 0) < 0)
271       {
272       DEBUG(D_route) debug_printf("send to %s failed\n", h->address);
273       (void)close(query_cctx.sock);
274       continue;
275       }
276
277     /* Read the response and close the socket. If the read fails, try the
278     next IP address. */
279
280     count = ip_recv(&query_cctx, reply, sizeof(reply) - 1, time(NULL) + ob->timeout);
281     (void)close(query_cctx.sock);
282     if (count <= 0)
283       {
284       DEBUG(D_route) debug_printf("%s from %s\n", (errno == ETIMEDOUT)?
285         "timed out" : "recv failed", h->address);
286       *reply = 0;
287       continue;
288       }
289
290     /* Success; break the loop */
291
292     reply[count] = 0;
293     DEBUG(D_route) debug_printf("%s router received \"%s\" from %s\n",
294       rblock->name, string_printing(reply), h->address);
295     break;
296     }
297
298   /* If h == NULL we have tried all the IP addresses and failed on all of them,
299   so we must continue to try more host names. Otherwise we have succeeded. */
300
301   if (h) break;
302   }
303
304
305 /* If hostname is NULL, we have failed to find any host, or failed to
306 connect to any of the IP addresses, or timed out while reading or writing to
307 those we have connected to. In all cases, we must pass if optional and
308 defer otherwise. */
309
310 if (hostname == NULL)
311   {
312   DEBUG(D_route) debug_printf("%s router failed to get anything\n", rblock->name);
313   if (ob->optional) return PASS;
314   addr->message = string_sprintf("%s router: failed to communicate with any "
315     "host", rblock->name);
316   return DEFER;
317   }
318
319
320 /* If a response pattern was supplied, match the returned string against it. A
321 failure to match causes the router to decline. After a successful match, the
322 numerical variables for expanding the rerouted address are set up. */
323
324 if (re != NULL)
325   {
326   if (!regex_match_and_setup(re, reply, 0, -1))
327     {
328     DEBUG(D_route) debug_printf("%s router: %s failed to match response %s\n",
329       rblock->name, ob->response_pattern, reply);
330     return DECLINE;
331     }
332   }
333
334
335 /* If no response pattern was supplied, set up $0 as the response up to the
336 first white space (if any). Also, if no query was specified, check that what
337 follows the white space matches user@domain. */
338
339 else
340   {
341   int n = 0;
342   while (reply[n] != 0 && !isspace(reply[n])) n++;
343   expand_nmax = 0;
344   expand_nstring[0] = reply;
345   expand_nlength[0] = n;
346
347   if (ob->query == NULL)
348     {
349     int nn = n;
350     while (isspace(reply[nn])) nn++;
351     if (Ustrcmp(query + query_len/2 + 1, reply+nn) != 0)
352       {
353       DEBUG(D_route) debug_printf("%s router: failed to match identification "
354         "in response %s\n", rblock->name, reply);
355       return DECLINE;
356       }
357     }
358
359   reply[n] = 0;  /* Terminate for the default case */
360   }
361
362 /* If an explicit rerouting string is specified, expand it. Otherwise, use
363 what was sent back verbatim. */
364
365 if (ob->reroute != NULL)
366   {
367   reroute = expand_string(ob->reroute);
368   expand_nmax = -1;
369   if (reroute == NULL)
370     {
371     addr->message = string_sprintf("%s router: failed to expand %s: %s",
372       rblock->name, ob->reroute, expand_string_message);
373     return DEFER;
374     }
375   }
376 else reroute = reply;
377
378 /* We should now have a new address in the form user@domain. */
379
380 domain = Ustrchr(reroute, '@');
381 if (domain == NULL)
382   {
383   log_write(0, LOG_MAIN, "%s router: reroute string %s is not of the form "
384     "user@domain", rblock->name, reroute);
385   addr->message = string_sprintf("%s router: reroute string %s is not of the "
386     "form user@domain", rblock->name, reroute);
387   return DEFER;
388   }
389
390 /* Create a child address with the old one as parent. Put the new address on
391 the chain of new addressess. */
392
393 new_addr = deliver_make_addr(reroute, TRUE);
394 new_addr->parent = addr;
395
396 new_addr->prop = addr->prop;
397
398 if (addr->child_count == USHRT_MAX)
399   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s router generated more than %d "
400     "child addresses for <%s>", rblock->name, USHRT_MAX, addr->address);
401 addr->child_count++;
402 new_addr->next = *addr_new;
403 *addr_new = new_addr;
404
405 /* Set up the errors address, if any, and the additional and removable headers
406 for this new address. */
407
408 rc = rf_get_errors_address(addr, rblock, verify, &new_addr->prop.errors_address);
409 if (rc != OK) return rc;
410
411 rc = rf_get_munge_headers(addr, rblock, &new_addr->prop.extra_headers,
412   &new_addr->prop.remove_headers);
413 if (rc != OK) return rc;
414
415 return OK;
416 }
417
418 #endif   /*!MACRO_PREDEF*/
419 /* End of routers/iplookup.c */