Docs: clean for next release
[exim.git] / src / src / routers / queryprogram.c
CommitLineData
0756eb3c
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
f9ba5e22 5/* Copyright (c) University of Cambridge 1995 - 2018 */
0756eb3c
PH
6/* See the file NOTICE for conditions of use and distribution. */
7
8#include "../exim.h"
9#include "rf_functions.h"
10#include "queryprogram.h"
11
12
13
14/* Options specific to the queryprogram router. */
15
16optionlist queryprogram_router_options[] = {
17 { "*expand_command_group", opt_bool | opt_hidden,
18 (void *)(offsetof(queryprogram_router_options_block, expand_cmd_gid)) },
19 { "*expand_command_user", opt_bool | opt_hidden,
20 (void *)(offsetof(queryprogram_router_options_block, expand_cmd_uid)) },
21 { "*set_command_group", opt_bool | opt_hidden,
22 (void *)(offsetof(queryprogram_router_options_block, cmd_gid_set)) },
23 { "*set_command_user", opt_bool | opt_hidden,
24 (void *)(offsetof(queryprogram_router_options_block, cmd_uid_set)) },
25 { "command", opt_stringptr,
26 (void *)(offsetof(queryprogram_router_options_block, command)) },
27 { "command_group",opt_expand_gid,
28 (void *)(offsetof(queryprogram_router_options_block, cmd_gid)) },
29 { "command_user", opt_expand_uid,
30 (void *)(offsetof(queryprogram_router_options_block, cmd_uid)) },
31 { "current_directory", opt_stringptr,
32 (void *)(offsetof(queryprogram_router_options_block, current_directory)) },
33 { "timeout", opt_time,
34 (void *)(offsetof(queryprogram_router_options_block, timeout)) }
35};
36
37/* Size of the options list. An extern variable has to be used so that its
38address can appear in the tables drtables.c. */
39
40int queryprogram_router_options_count =
41 sizeof(queryprogram_router_options)/sizeof(optionlist);
42
d185889f
JH
43
44#ifdef MACRO_PREDEF
45
46/* Dummy entries */
47queryprogram_router_options_block queryprogram_router_option_defaults = {0};
48void queryprogram_router_init(router_instance *rblock) {}
49int queryprogram_router_entry(router_instance *rblock, address_item *addr,
50 struct passwd *pw, int verify, address_item **addr_local,
51 address_item **addr_remote, address_item **addr_new,
cab0c277 52 address_item **addr_succeed) {return 0;}
d185889f
JH
53
54#else /*!MACRO_PREDEF*/
55
56
0756eb3c
PH
57/* Default private options block for the queryprogram router. */
58
59queryprogram_router_options_block queryprogram_router_option_defaults = {
60 NULL, /* command */
61 60*60, /* timeout */
62 (uid_t)(-1), /* cmd_uid */
63 (gid_t)(-1), /* cmd_gid */
64 FALSE, /* cmd_uid_set */
65 FALSE, /* cmd_gid_set */
66 US"/", /* current_directory */
67 NULL, /* expand_cmd_gid */
68 NULL /* expand_cmd_uid */
69};
70
71
72
73/*************************************************
74* Initialization entry point *
75*************************************************/
76
77/* Called for each instance, after its options have been read, to enable
78consistency checks to be done, or anything else that needs to be set up. */
79
80void
81queryprogram_router_init(router_instance *rblock)
82{
83queryprogram_router_options_block *ob =
84 (queryprogram_router_options_block *)(rblock->options_block);
85
86/* A command must be given */
87
88if (ob->command == NULL)
89 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_FOR, "%s router:\n "
90 "a command specification is required", rblock->name);
91
92/* A uid/gid must be supplied */
93
94if (!ob->cmd_uid_set && ob->expand_cmd_uid == NULL)
95 log_write(0, LOG_PANIC_DIE|LOG_CONFIG_FOR, "%s router:\n "
96 "command_user must be specified", rblock->name);
97}
98
99
100
101/*************************************************
102* Process a set of generated new addresses *
103*************************************************/
104
105/* This function sets up a set of newly generated child addresses and puts them
106on the new address chain.
107
108Arguments:
109 rblock router block
110 addr_new new address chain
111 addr original address
112 generated list of generated addresses
113 addr_prop the propagated data block, containing errors_to,
114 header change stuff, and address_data
115
116Returns: nothing
117*/
118
119static void
120add_generated(router_instance *rblock, address_item **addr_new,
121 address_item *addr, address_item *generated,
122 address_item_propagated *addr_prop)
123{
124while (generated != NULL)
125 {
7eb0e5d2 126 BOOL ignore_error = addr->prop.ignore_error;
0756eb3c 127 address_item *next = generated;
7eb0e5d2 128
0756eb3c
PH
129 generated = next->next;
130
131 next->parent = addr;
d43cbe25 132 next->prop = *addr_prop;
a5853d7c 133 next->prop.ignore_error = next->prop.ignore_error || ignore_error;
0756eb3c
PH
134 next->start_router = rblock->redirect_router;
135
136 next->next = *addr_new;
137 *addr_new = next;
138
82f90600 139 if (addr->child_count == USHRT_MAX)
4362ff0d 140 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "%s router generated more than %d "
82f90600 141 "child addresses for <%s>", rblock->name, USHRT_MAX, addr->address);
0756eb3c
PH
142 addr->child_count++;
143
144 DEBUG(D_route)
145 debug_printf("%s router generated %s\n", rblock->name, next->address);
146 }
147}
148
149
150
151
152/*************************************************
153* Main entry point *
154*************************************************/
155
156/* See local README for interface details. This router returns:
157
158DECLINE
159 . DECLINE returned
160 . self = DECLINE
161
162PASS
163 . PASS returned
164 . timeout of host lookup and pass_on_timeout set
165 . self = PASS
166
167DEFER
168 . verifying the errors address caused a deferment or a big disaster such
169 as an expansion failure (rf_get_errors_address)
170 . expanding a headers_{add,remove} string caused a deferment or another
171 expansion error (rf_get_munge_headers)
172 . a problem in rf_get_transport: no transport when one is needed;
173 failed to expand dynamic transport; failed to find dynamic transport
174 . bad lookup type
175 . problem looking up host (rf_lookup_hostlist)
176 . self = DEFER or FREEZE
177 . failure to set up uid/gid for running the command
178 . failure of transport_set_up_command: too many arguments, expansion fail
179 . failure to create child process
180 . child process crashed or timed out or didn't return data
181 . :defer: in data
182 . DEFER or FREEZE returned
183 . problem in redirection data
184 . unknown transport name or trouble expanding router transport
185
186FAIL
187 . :fail: in data
188 . FAIL returned
189 . self = FAIL
190
191OK
192 . address added to addr_local or addr_remote for delivery
193 . new addresses added to addr_new
194*/
195
196int
197queryprogram_router_entry(
198 router_instance *rblock, /* data for this instantiation */
199 address_item *addr, /* address we are working on */
200 struct passwd *pw, /* passwd entry after check_local_user */
fd6de02e 201 int verify, /* v_none/v_recipient/v_sender/v_expn */
0756eb3c
PH
202 address_item **addr_local, /* add it to this if it's local */
203 address_item **addr_remote, /* add it to this if it's remote */
204 address_item **addr_new, /* put new addresses on here */
205 address_item **addr_succeed) /* put old address here on success */
206{
207int fd_in, fd_out, len, rc;
208pid_t pid;
209struct passwd *upw = NULL;
210uschar buffer[1024];
55414b25 211const uschar **argvptr;
0756eb3c
PH
212uschar *rword, *rdata, *s;
213address_item_propagated addr_prop;
214queryprogram_router_options_block *ob =
215 (queryprogram_router_options_block *)(rblock->options_block);
216uschar *current_directory = ob->current_directory;
217ugid_block ugid;
59e82a2a
PH
218uid_t curr_uid = getuid();
219gid_t curr_gid = getgid();
0756eb3c
PH
220uid_t uid = ob->cmd_uid;
221gid_t gid = ob->cmd_gid;
59e82a2a
PH
222uid_t *puid = &uid;
223gid_t *pgid = &gid;
0756eb3c
PH
224
225DEBUG(D_route) debug_printf("%s router called for %s: domain = %s\n",
226 rblock->name, addr->address, addr->domain);
227
228ugid.uid_set = ugid.gid_set = FALSE;
229
230/* Set up the propagated data block with the current address_data and the
231errors address and extra header stuff. */
232
806c3df9 233bzero(&addr_prop, sizeof(addr_prop));
0756eb3c
PH
234addr_prop.address_data = deliver_address_data;
235
d43cbe25 236rc = rf_get_errors_address(addr, rblock, verify, &addr_prop.errors_address);
0756eb3c
PH
237if (rc != OK) return rc;
238
d43cbe25
JH
239rc = rf_get_munge_headers(addr, rblock, &addr_prop.extra_headers,
240 &addr_prop.remove_headers);
0756eb3c
PH
241if (rc != OK) return rc;
242
67e87fcf
JH
243#ifdef EXPERIMENTAL_SRS
244addr_prop.srs_sender = NULL;
245#endif
246
0756eb3c
PH
247/* Get the fixed or expanded uid under which the command is to run
248(initialization ensures that one or the other is set). */
249
250if (!ob->cmd_uid_set)
251 {
252 if (!route_find_expanded_user(ob->expand_cmd_uid, rblock->name, US"router",
253 &upw, &uid, &(addr->message)))
254 return DEFER;
255 }
256
257/* Get the fixed or expanded gid, or take the gid from the passwd entry. */
258
259if (!ob->cmd_gid_set)
260 {
261 if (ob->expand_cmd_gid != NULL)
262 {
263 if (route_find_expanded_group(ob->expand_cmd_gid, rblock->name,
264 US"router", &gid, &(addr->message)))
265 return DEFER;
266 }
267 else if (upw != NULL)
268 {
269 gid = upw->pw_gid;
270 }
271 else
272 {
273 addr->message = string_sprintf("command_user set without command_group "
274 "for %s router", rblock->name);
275 return DEFER;
276 }
277 }
278
59e82a2a 279DEBUG(D_route) debug_printf("requires uid=%ld gid=%ld current_directory=%s\n",
0756eb3c
PH
280 (long int)uid, (long int)gid, current_directory);
281
59e82a2a
PH
282/* If we are not running as root, we will not be able to change uid/gid. */
283
284if (curr_uid != root_uid && (uid != curr_uid || gid != curr_gid))
285 {
286 DEBUG(D_route)
287 {
288 debug_printf("not running as root: cannot change uid/gid\n");
289 debug_printf("subprocess will run with uid=%ld gid=%ld\n",
290 (long int)curr_uid, (long int)curr_gid);
291 }
292 puid = pgid = NULL;
293 }
294
295/* Set up the command to run */
296
0756eb3c
PH
297if (!transport_set_up_command(&argvptr, /* anchor for arg list */
298 ob->command, /* raw command */
299 TRUE, /* expand the arguments */
300 0, /* not relevant when... */
301 NULL, /* no transporting address */
302 US"queryprogram router", /* for error messages */
303 &(addr->message))) /* where to put error message */
304 {
305 return DEFER;
306 }
307
308/* Create the child process, making it a group leader. */
309
59e82a2a 310pid = child_open_uid(argvptr, NULL, 0077, puid, pgid, &fd_in, &fd_out,
0756eb3c
PH
311 current_directory, TRUE);
312
313if (pid < 0)
314 {
315 addr->message = string_sprintf("%s router couldn't create child process: %s",
316 rblock->name, strerror(errno));
317 return DEFER;
318 }
319
320/* Nothing is written to the standard input. */
321
f1e894f3 322(void)close(fd_in);
0756eb3c
PH
323
324/* Wait for the process to finish, applying the timeout, and inspect its return
325code. */
326
327if ((rc = child_close(pid, ob->timeout)) != 0)
328 {
329 if (rc > 0)
330 addr->message = string_sprintf("%s router: command returned non-zero "
331 "code %d", rblock->name, rc);
332
333 else if (rc == -256)
334 {
335 addr->message = string_sprintf("%s router: command timed out",
336 rblock->name);
337 killpg(pid, SIGKILL); /* Kill the whole process group */
338 }
339
340 else if (rc == -257)
341 addr->message = string_sprintf("%s router: wait() failed: %s",
342 rblock->name, strerror(errno));
343
344 else
345 addr->message = string_sprintf("%s router: command killed by signal %d",
346 rblock->name, -rc);
347
348 return DEFER;
349 }
350
351/* Read the pipe to get the command's output, and then close it. */
352
353len = read(fd_out, buffer, sizeof(buffer) - 1);
f1e894f3 354(void)close(fd_out);
0756eb3c
PH
355
356/* Failure to return any data is an error. */
357
358if (len <= 0)
359 {
360 addr->message = string_sprintf("%s router: command failed to return data",
361 rblock->name);
362 return DEFER;
363 }
364
365/* Get rid of leading and trailing white space, and pick off the first word of
366the result. */
367
368while (len > 0 && isspace(buffer[len-1])) len--;
369buffer[len] = 0;
370
371DEBUG(D_route) debug_printf("command wrote: %s\n", buffer);
372
373rword = buffer;
374while (isspace(*rword)) rword++;
375rdata = rword;
376while (*rdata != 0 && !isspace(*rdata)) rdata++;
377if (*rdata != 0) *rdata++ = 0;
378
379/* The word must be a known yield name. If it is "REDIRECT", the rest of the
380line is redirection data, as for a .forward file. It may not contain filter
381data, and it may not contain anything other than addresses (no files, no pipes,
382no specials). */
383
384if (strcmpic(rword, US"REDIRECT") == 0)
385 {
386 int filtertype;
387 redirect_block redirect;
388 address_item *generated = NULL;
389
390 redirect.string = rdata;
391 redirect.isfile = FALSE;
392
393 rc = rda_interpret(&redirect, /* redirection data */
394 RDO_BLACKHOLE | /* forbid :blackhole: */
395 RDO_FAIL | /* forbid :fail: */
396 RDO_INCLUDE | /* forbid :include: */
397 RDO_REWRITE, /* rewrite generated addresses */
398 NULL, /* :include: directory not relevant */
399 NULL, /* sieve vacation directory not relevant */
efd9a422 400 NULL, /* sieve enotify mailto owner not relevant */
e4a89c47
PH
401 NULL, /* sieve useraddress not relevant */
402 NULL, /* sieve subaddress not relevant */
0756eb3c
PH
403 &ugid, /* uid/gid (but not set) */
404 &generated, /* where to hang the results */
405 &(addr->message), /* where to put messages */
406 NULL, /* don't skip syntax errors */
407 &filtertype, /* not used; will always be FILTER_FORWARD */
408 string_sprintf("%s router", rblock->name));
409
410 switch (rc)
411 {
412 /* FF_DEFER and FF_FAIL can arise only as a result of explicit commands.
413 If a configured message was supplied, allow it to be included in an SMTP
414 response after verifying. */
415
416 case FF_DEFER:
417 if (addr->message == NULL) addr->message = US"forced defer";
418 else addr->user_message = addr->message;
419 return DEFER;
420
421 case FF_FAIL:
422 add_generated(rblock, addr_new, addr, generated, &addr_prop);
423 if (addr->message == NULL) addr->message = US"forced rejection";
424 else addr->user_message = addr->message;
425 return FAIL;
426
427 case FF_DELIVERED:
428 break;
429
430 case FF_NOTDELIVERED: /* an empty redirection list is bad */
431 addr->message = US"no addresses supplied";
432 /* Fall through */
433
434 case FF_ERROR:
435 default:
436 addr->basic_errno = ERRNO_BADREDIRECT;
437 addr->message = string_sprintf("error in redirect data: %s", addr->message);
438 return DEFER;
439 }
440
441 /* Handle the generated addresses, if any. */
442
443 add_generated(rblock, addr_new, addr, generated, &addr_prop);
444
445 /* Put the original address onto the succeed queue so that any retry items
446 that get attached to it get processed. */
447
448 addr->next = *addr_succeed;
449 *addr_succeed = addr;
450
451 return OK;
452 }
453
454/* Handle other returns that are not ACCEPT */
455
456if (strcmpic(rword, US"accept") != 0)
457 {
458 if (strcmpic(rword, US"decline") == 0) return DECLINE;
459 if (strcmpic(rword, US"pass") == 0) return PASS;
460 addr->message = string_copy(rdata); /* data is a message */
447d236c
PH
461 if (strcmpic(rword, US"fail") == 0)
462 {
463 setflag(addr, af_pass_message);
464 return FAIL;
465 }
0756eb3c
PH
466 if (strcmpic(rword, US"freeze") == 0) addr->special_action = SPECIAL_FREEZE;
467 else if (strcmpic(rword, US"defer") != 0)
468 {
469 addr->message = string_sprintf("bad command yield: %s %s", rword, rdata);
470 log_write(0, LOG_PANIC, "%s router: %s", rblock->name, addr->message);
471 }
472 return DEFER;
473 }
474
475/* The command yielded "ACCEPT". The rest of the string is a number of keyed
476fields from which we can fish out values using the "extract" expansion
477function. To use this feature, we must put the string into the $value variable,
478i.e. set lookup_value. */
479
480lookup_value = rdata;
481s = expand_string(US"${extract{data}{$value}}");
482if (*s != 0) addr_prop.address_data = string_copy(s);
483
484s = expand_string(US"${extract{transport}{$value}}");
485lookup_value = NULL;
486
487/* If we found a transport name, find the actual transport */
488
489if (*s != 0)
490 {
491 transport_instance *transport;
492 for (transport = transports; transport != NULL; transport = transport->next)
493 if (Ustrcmp(transport->name, s) == 0) break;
494 if (transport == NULL)
495 {
496 addr->message = string_sprintf("unknown transport name %s yielded by "
497 "command", s);
498 log_write(0, LOG_PANIC, "%s router: %s", rblock->name, addr->message);
499 return DEFER;
500 }
501 addr->transport = transport;
502 }
503
504/* No transport given; get the transport from the router configuration. It may
505be fixed or expanded, but there will be an error if it is unset, requested by
506the last argument not being NULL. */
507
508else
509 {
510 if (!rf_get_transport(rblock->transport_name, &(rblock->transport), addr,
511 rblock->name, US"transport"))
512 return DEFER;
513 addr->transport = rblock->transport;
514 }
515
516/* See if a host list is given, and if so, look up the addresses. */
517
518lookup_value = rdata;
519s = expand_string(US"${extract{hosts}{$value}}");
520
521if (*s != 0)
522 {
66387a73 523 int lookup_type = LK_DEFAULT;
0756eb3c
PH
524 uschar *ss = expand_string(US"${extract{lookup}{$value}}");
525 lookup_value = NULL;
526
527 if (*ss != 0)
528 {
66387a73
JH
529 if (Ustrcmp(ss, "byname") == 0) lookup_type = LK_BYNAME;
530 else if (Ustrcmp(ss, "bydns") == 0) lookup_type = LK_BYDNS;
0756eb3c
PH
531 else
532 {
533 addr->message = string_sprintf("bad lookup type \"%s\" yielded by "
534 "command", ss);
535 log_write(0, LOG_PANIC, "%s router: %s", rblock->name, addr->message);
536 return DEFER;
537 }
538 }
539
540 host_build_hostlist(&(addr->host_list), s, FALSE); /* pro tem no randomize */
541
542 rc = rf_lookup_hostlist(rblock, addr, rblock->ignore_target_hosts,
543 lookup_type, hff_defer, addr_new);
544 if (rc != OK) return rc;
545 }
546lookup_value = NULL;
547
548/* Put the errors address, extra headers, and address_data into this address */
549
d43cbe25 550addr->prop = addr_prop;
0756eb3c
PH
551
552/* Queue the address for local or remote delivery. */
553
554return rf_queue_add(addr, addr_local, addr_remote, rblock, pw)?
555 OK : DEFER;
556}
557
d185889f 558#endif /*!MACRO_PREDEF*/
0756eb3c 559/* End of routers/queryprogram.c */