src/src/routers/queryprogram.c

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