1 /* 2 * Copyright (c) 1998-2013 Proofpoint, Inc. and its suppliers. 3 * All rights reserved. 4 * Copyright (c) 1983, 1995-1997 Eric P. Allman. All rights reserved. 5 * Copyright (c) 1988, 1993 6 * The Regents of the University of California. All rights reserved. 7 * 8 * By using this file, you agree to the terms and conditions set 9 * forth in the LICENSE file which can be found at the top level of 10 * the sendmail distribution. 11 */ 12 13 /* 14 ** SENDMAIL.H -- MTA-specific definitions for sendmail. 15 */ 16 17 #ifndef _SENDMAIL_H 18 # define _SENDMAIL_H 1 19 20 #ifndef MILTER 21 # define MILTER 1 /* turn on MILTER by default */ 22 #endif /* MILTER */ 23 24 #ifdef _DEFINE 25 # define EXTERN 26 #else /* _DEFINE */ 27 # define EXTERN extern 28 #endif /* _DEFINE */ 29 30 31 #include <unistd.h> 32 33 #include <stddef.h> 34 #include <stdlib.h> 35 #include <stdio.h> 36 #include <ctype.h> 37 #include <setjmp.h> 38 #include <string.h> 39 #include <time.h> 40 # ifdef EX_OK 41 # undef EX_OK /* for SVr4.2 SMP */ 42 # endif /* EX_OK */ 43 44 #include "sendmail/sendmail.h" 45 46 /* profiling? */ 47 #if MONCONTROL 48 # define SM_PROF(x) moncontrol(x) 49 #else /* MONCONTROL */ 50 # define SM_PROF(x) 51 #endif /* MONCONTROL */ 52 53 #ifdef _DEFINE 54 # ifndef lint 55 SM_UNUSED(static char SmailId[]) = "@(#)$Id: sendmail.h,v 8.1104 2013-11-22 20:51:56 ca Exp $"; 56 # endif /* ! lint */ 57 #endif /* _DEFINE */ 58 59 #include "bf.h" 60 #include "timers.h" 61 #include <sm/exc.h> 62 #include <sm/heap.h> 63 #include <sm/debug.h> 64 #include <sm/rpool.h> 65 #include <sm/io.h> 66 #include <sm/path.h> 67 #include <sm/signal.h> 68 #include <sm/clock.h> 69 #include <sm/mbdb.h> 70 #include <sm/errstring.h> 71 #include <sm/sysexits.h> 72 #include <sm/shm.h> 73 #include <sm/misc.h> 74 75 #ifdef LOG 76 # include <syslog.h> 77 #endif /* LOG */ 78 79 80 81 # if NETINET || NETINET6 || NETUNIX || NETISO || NETNS || NETX25 82 # include <sys/socket.h> 83 # endif /* NETINET || NETINET6 || NETUNIX || NETISO || NETNS || NETX25 */ 84 # if NETUNIX 85 # include <sys/un.h> 86 # endif /* NETUNIX */ 87 # if NETINET || NETINET6 88 # include <netinet/in.h> 89 # endif /* NETINET || NETINET6 */ 90 # if NETINET6 91 /* 92 ** There is no standard yet for IPv6 includes. 93 ** Specify OS specific implementation in conf.h 94 */ 95 # endif /* NETINET6 */ 96 # if NETISO 97 # include <netiso/iso.h> 98 # endif /* NETISO */ 99 # if NETNS 100 # include <netns/ns.h> 101 # endif /* NETNS */ 102 # if NETX25 103 # include <netccitt/x25.h> 104 # endif /* NETX25 */ 105 106 # if NAMED_BIND 107 # include <arpa/nameser.h> 108 # ifdef NOERROR 109 # undef NOERROR /* avoid <sys/streams.h> conflict */ 110 # endif /* NOERROR */ 111 # include <resolv.h> 112 # else /* NAMED_BIND */ 113 # undef SM_SET_H_ERRNO 114 # define SM_SET_H_ERRNO(err) 115 # endif /* NAMED_BIND */ 116 117 # if HESIOD 118 # include <hesiod.h> 119 # if !defined(HES_ER_OK) || defined(HESIOD_INTERFACES) 120 # define HESIOD_INIT /* support for the new interface */ 121 # endif /* !defined(HES_ER_OK) || defined(HESIOD_INTERFACES) */ 122 # endif /* HESIOD */ 123 124 #if STARTTLS 125 # include <openssl/ssl.h> 126 # if !TLS_NO_RSA 127 # if _FFR_FIPSMODE 128 # define RSA_KEYLENGTH 1024 129 # else /* _FFR_FIPSMODE */ 130 # define RSA_KEYLENGTH 512 131 # endif /* _FFR_FIPSMODE */ 132 # endif /* !TLS_NO_RSA */ 133 #endif /* STARTTLS */ 134 135 #if SASL /* include the sasl include files if we have them */ 136 137 138 # if SASL == 2 || SASL >= 20000 139 # include <sasl/sasl.h> 140 # include <sasl/saslplug.h> 141 # include <sasl/saslutil.h> 142 # if SASL_VERSION_FULL < 0x020119 143 typedef int (*sasl_callback_ft)(void); 144 # endif /* SASL_VERSION_FULL < 0x020119 */ 145 # else /* SASL == 2 || SASL >= 20000 */ 146 # include <sasl.h> 147 # include <saslutil.h> 148 typedef int (*sasl_callback_ft)(void); 149 # endif /* SASL == 2 || SASL >= 20000 */ 150 # if defined(SASL_VERSION_MAJOR) && defined(SASL_VERSION_MINOR) && defined(SASL_VERSION_STEP) 151 # define SASL_VERSION (SASL_VERSION_MAJOR * 10000) + (SASL_VERSION_MINOR * 100) + SASL_VERSION_STEP 152 # if SASL == 1 || SASL == 2 153 # undef SASL 154 # define SASL SASL_VERSION 155 # else /* SASL == 1 || SASL == 2 */ 156 # if SASL != SASL_VERSION 157 ERROR README: -DSASL (SASL) does not agree with the version of the CYRUS_SASL library (SASL_VERSION) 158 ERROR README: see README! 159 # endif /* SASL != SASL_VERSION */ 160 # endif /* SASL == 1 || SASL == 2 */ 161 # else /* defined(SASL_VERSION_MAJOR) && defined(SASL_VERSION_MINOR) && defined(SASL_VERSION_STEP) */ 162 # if SASL == 1 163 ERROR README: please set -DSASL to the version of the CYRUS_SASL library 164 ERROR README: see README! 165 # endif /* SASL == 1 */ 166 # endif /* defined(SASL_VERSION_MAJOR) && defined(SASL_VERSION_MINOR) && defined(SASL_VERSION_STEP) */ 167 #endif /* SASL */ 168 169 /* 170 ** Following are "sort of" configuration constants, but they should 171 ** be pretty solid on most architectures today. They have to be 172 ** defined after <arpa/nameser.h> because some versions of that 173 ** file also define them. In all cases, we can't use sizeof because 174 ** some systems (e.g., Crays) always treat everything as being at 175 ** least 64 bits. 176 */ 177 178 #ifndef INADDRSZ 179 # define INADDRSZ 4 /* size of an IPv4 address in bytes */ 180 #endif /* ! INADDRSZ */ 181 #ifndef IN6ADDRSZ 182 # define IN6ADDRSZ 16 /* size of an IPv6 address in bytes */ 183 #endif /* ! IN6ADDRSZ */ 184 #ifndef INT16SZ 185 # define INT16SZ 2 /* size of a 16 bit integer in bytes */ 186 #endif /* ! INT16SZ */ 187 #ifndef INT32SZ 188 # define INT32SZ 4 /* size of a 32 bit integer in bytes */ 189 #endif /* ! INT32SZ */ 190 #ifndef INADDR_LOOPBACK 191 # define INADDR_LOOPBACK 0x7f000001 /* loopback address */ 192 #endif /* ! INADDR_LOOPBACK */ 193 194 /* 195 ** Error return from inet_addr(3), in case not defined in /usr/include. 196 */ 197 198 #ifndef INADDR_NONE 199 # define INADDR_NONE 0xffffffff 200 #endif /* ! INADDR_NONE */ 201 202 203 /* (f)open() modes for queue files */ 204 # define QF_O_EXTRA 0 205 206 207 /* 208 ** An 'argument class' describes the storage allocation status 209 ** of an object pointed to by an argument to a function. 210 */ 211 212 typedef enum 213 { 214 A_HEAP, /* the storage was allocated by malloc, and the 215 * ownership of the storage is ceded by the caller 216 * to the called function. */ 217 A_TEMP, /* The storage is temporary, and is only guaranteed 218 * to be valid for the duration of the function call. */ 219 A_PERM /* The storage is 'permanent': this might mean static 220 * storage, or rpool storage. */ 221 } ARGCLASS_T; 222 223 /* forward references for prototypes */ 224 typedef struct envelope ENVELOPE; 225 typedef struct mailer MAILER; 226 typedef struct queuegrp QUEUEGRP; 227 228 /* 229 ** Address structure. 230 ** Addresses are stored internally in this structure. 231 */ 232 233 struct address 234 { 235 char *q_paddr; /* the printname for the address */ 236 char *q_user; /* user name */ 237 char *q_ruser; /* real user name, or NULL if q_user */ 238 char *q_host; /* host name */ 239 struct mailer *q_mailer; /* mailer to use */ 240 unsigned long q_flags; /* status flags, see below */ 241 uid_t q_uid; /* user-id of receiver (if known) */ 242 gid_t q_gid; /* group-id of receiver (if known) */ 243 char *q_home; /* home dir (local mailer only) */ 244 char *q_fullname; /* full name if known */ 245 struct address *q_next; /* chain */ 246 struct address *q_alias; /* address this results from */ 247 char *q_owner; /* owner of q_alias */ 248 struct address *q_tchain; /* temporary use chain */ 249 #if PIPELINING 250 struct address *q_pchain; /* chain for pipelining */ 251 #endif /* PIPELINING */ 252 char *q_finalrcpt; /* Final-Recipient: DSN header */ 253 char *q_orcpt; /* ORCPT parameter from RCPT TO: line */ 254 char *q_status; /* status code for DSNs */ 255 char *q_rstatus; /* remote status message for DSNs */ 256 time_t q_statdate; /* date of status messages */ 257 char *q_statmta; /* MTA generating q_rstatus */ 258 short q_state; /* address state, see below */ 259 char *q_signature; /* MX-based sorting value */ 260 int q_qgrp; /* index into queue groups */ 261 int q_qdir; /* queue directory inside group */ 262 char *q_message; /* error message */ 263 }; 264 265 typedef struct address ADDRESS; 266 267 /* bit values for q_flags */ 268 #define QGOODUID 0x00000001 /* the q_uid q_gid fields are good */ 269 #define QPRIMARY 0x00000002 /* set from RCPT or argv */ 270 #define QNOTREMOTE 0x00000004 /* address not for remote forwarding */ 271 #define QSELFREF 0x00000008 /* this address references itself */ 272 #define QBOGUSSHELL 0x00000010 /* user has no valid shell listed */ 273 #define QUNSAFEADDR 0x00000020 /* address acquired via unsafe path */ 274 #define QPINGONSUCCESS 0x00000040 /* give return on successful delivery */ 275 #define QPINGONFAILURE 0x00000080 /* give return on failure */ 276 #define QPINGONDELAY 0x00000100 /* give return on message delay */ 277 #define QHASNOTIFY 0x00000200 /* propagate notify parameter */ 278 #define QRELAYED 0x00000400 /* DSN: relayed to non-DSN aware sys */ 279 #define QEXPANDED 0x00000800 /* DSN: undergone list expansion */ 280 #define QDELIVERED 0x00001000 /* DSN: successful final delivery */ 281 #define QDELAYED 0x00002000 /* DSN: message delayed */ 282 #define QALIAS 0x00004000 /* expanded alias */ 283 #define QBYTRACE 0x00008000 /* DeliverBy: trace */ 284 #define QBYNDELAY 0x00010000 /* DeliverBy: notify, delay */ 285 #define QBYNRELAY 0x00020000 /* DeliverBy: notify, relayed */ 286 #define QTHISPASS 0x40000000 /* temp: address set this pass */ 287 #define QRCPTOK 0x80000000 /* recipient() processed address */ 288 289 #define Q_PINGFLAGS (QPINGONSUCCESS|QPINGONFAILURE|QPINGONDELAY) 290 291 /* values for q_state */ 292 #define QS_OK 0 /* address ok (for now)/not yet tried */ 293 #define QS_SENT 1 /* good address, delivery complete */ 294 #define QS_BADADDR 2 /* illegal address */ 295 #define QS_QUEUEUP 3 /* save address in queue */ 296 #define QS_RETRY 4 /* retry delivery for next MX */ 297 #define QS_VERIFIED 5 /* verified, but not expanded */ 298 299 /* 300 ** Notice: all of the following values are variations of QS_DONTSEND. 301 ** If new states are added, they must be inserted in the proper place! 302 ** See the macro definition of QS_IS_DEAD() down below. 303 */ 304 305 #define QS_DONTSEND 6 /* don't send to this address */ 306 #define QS_EXPANDED 7 /* expanded */ 307 #define QS_SENDER 8 /* message sender (MeToo) */ 308 #define QS_CLONED 9 /* addr cloned to split envelope */ 309 #define QS_DISCARDED 10 /* rcpt discarded (EF_DISCARD) */ 310 #define QS_REPLACED 11 /* maplocaluser()/UserDB replaced */ 311 #define QS_REMOVED 12 /* removed (removefromlist()) */ 312 #define QS_DUPLICATE 13 /* duplicate suppressed */ 313 #define QS_INCLUDED 14 /* :include: delivery */ 314 #define QS_FATALERR 15 /* fatal error, don't deliver */ 315 316 /* address state testing primitives */ 317 #define QS_IS_OK(s) ((s) == QS_OK) 318 #define QS_IS_SENT(s) ((s) == QS_SENT) 319 #define QS_IS_BADADDR(s) ((s) == QS_BADADDR) 320 #define QS_IS_QUEUEUP(s) ((s) == QS_QUEUEUP) 321 #define QS_IS_RETRY(s) ((s) == QS_RETRY) 322 #define QS_IS_VERIFIED(s) ((s) == QS_VERIFIED) 323 #define QS_IS_EXPANDED(s) ((s) == QS_EXPANDED) 324 #define QS_IS_REMOVED(s) ((s) == QS_REMOVED) 325 #define QS_IS_UNDELIVERED(s) ((s) == QS_OK || \ 326 (s) == QS_QUEUEUP || \ 327 (s) == QS_RETRY || \ 328 (s) == QS_VERIFIED) 329 #define QS_IS_UNMARKED(s) ((s) == QS_OK || \ 330 (s) == QS_RETRY) 331 #define QS_IS_SENDABLE(s) ((s) == QS_OK || \ 332 (s) == QS_QUEUEUP || \ 333 (s) == QS_RETRY) 334 #define QS_IS_ATTEMPTED(s) ((s) == QS_QUEUEUP || \ 335 (s) == QS_RETRY || \ 336 (s) == QS_SENT || \ 337 (s) == QS_DISCARDED) 338 #define QS_IS_DEAD(s) ((s) >= QS_DONTSEND) 339 #define QS_IS_TEMPFAIL(s) ((s) == QS_QUEUEUP || (s) == QS_RETRY) 340 341 #define NULLADDR ((ADDRESS *) NULL) 342 343 extern ADDRESS NullAddress; /* a null (template) address [main.c] */ 344 345 /* functions */ 346 extern void cataddr __P((char **, char **, char *, int, int, bool)); 347 extern char *crackaddr __P((char *, ENVELOPE *)); 348 extern bool emptyaddr __P((ADDRESS *)); 349 extern ADDRESS *getctladdr __P((ADDRESS *)); 350 extern int include __P((char *, bool, ADDRESS *, ADDRESS **, int, ENVELOPE *)); 351 extern bool invalidaddr __P((char *, char *, bool)); 352 extern ADDRESS *parseaddr __P((char *, ADDRESS *, int, int, char **, 353 ENVELOPE *, bool)); 354 extern char **prescan __P((char *, int, char[], int, char **, unsigned char *, bool)); 355 extern void printaddr __P((SM_FILE_T *, ADDRESS *, bool)); 356 extern ADDRESS *recipient __P((ADDRESS *, ADDRESS **, int, ENVELOPE *)); 357 extern char *remotename __P((char *, MAILER *, int, int *, ENVELOPE *)); 358 extern int rewrite __P((char **, int, int, ENVELOPE *, int)); 359 extern bool sameaddr __P((ADDRESS *, ADDRESS *)); 360 extern int sendtolist __P((char *, ADDRESS *, ADDRESS **, int, ENVELOPE *)); 361 #if MILTER 362 extern int removefromlist __P((char *, ADDRESS **, ENVELOPE *)); 363 #endif /* MILTER */ 364 extern void setsender __P((char *, ENVELOPE *, char **, int, bool)); 365 typedef void esmtp_args_F __P((ADDRESS *, char *, char *, ENVELOPE *)); 366 extern void parse_esmtp_args __P((ENVELOPE *, ADDRESS *, char *, char *, 367 char *, char *args[], esmtp_args_F)); 368 extern esmtp_args_F mail_esmtp_args; 369 extern esmtp_args_F rcpt_esmtp_args; 370 extern void reset_mail_esmtp_args __P((ENVELOPE *)); 371 372 /* macro to simplify the common call to rewrite() */ 373 #define REWRITE(pvp, rs, env) rewrite(pvp, rs, 0, env, MAXATOM) 374 375 /* 376 ** Token Tables for prescan 377 */ 378 379 extern unsigned char ExtTokenTab[256]; /* external strings */ 380 extern unsigned char IntTokenTab[256]; /* internal strings */ 381 382 383 /* 384 ** Mailer definition structure. 385 ** Every mailer known to the system is declared in this 386 ** structure. It defines the pathname of the mailer, some 387 ** flags associated with it, and the argument vector to 388 ** pass to it. The flags are defined in conf.c 389 ** 390 ** The argument vector is expanded before actual use. All 391 ** words except the first are passed through the macro 392 ** processor. 393 */ 394 395 struct mailer 396 { 397 char *m_name; /* symbolic name of this mailer */ 398 char *m_mailer; /* pathname of the mailer to use */ 399 char *m_mtatype; /* type of this MTA */ 400 char *m_addrtype; /* type for addresses */ 401 char *m_diagtype; /* type for diagnostics */ 402 BITMAP256 m_flags; /* status flags, see below */ 403 short m_mno; /* mailer number internally */ 404 short m_nice; /* niceness to run at (mostly for prog) */ 405 char **m_argv; /* template argument vector */ 406 short m_sh_rwset; /* rewrite set: sender header addresses */ 407 short m_se_rwset; /* rewrite set: sender envelope addresses */ 408 short m_rh_rwset; /* rewrite set: recipient header addresses */ 409 short m_re_rwset; /* rewrite set: recipient envelope addresses */ 410 char *m_eol; /* end of line string */ 411 long m_maxsize; /* size limit on message to this mailer */ 412 int m_linelimit; /* max # characters per line */ 413 int m_maxdeliveries; /* max deliveries per mailer connection */ 414 char *m_execdir; /* directory to chdir to before execv */ 415 char *m_rootdir; /* directory to chroot to before execv */ 416 uid_t m_uid; /* UID to run as */ 417 gid_t m_gid; /* GID to run as */ 418 char *m_defcharset; /* default character set */ 419 time_t m_wait; /* timeout to wait for end */ 420 int m_maxrcpt; /* max recipients per envelope client-side */ 421 short m_qgrp; /* queue group for this mailer */ 422 }; 423 424 /* bits for m_flags */ 425 #define M_ESMTP 'a' /* run Extended SMTP */ 426 #define M_ALIASABLE 'A' /* user can be LHS of an alias */ 427 #define M_BLANKEND 'b' /* ensure blank line at end of message */ 428 #define M_STRIPBACKSL 'B' /* strip all leading backslashes from user */ 429 #define M_NOCOMMENT 'c' /* don't include comment part of address */ 430 #define M_CANONICAL 'C' /* make addresses canonical "u@dom" */ 431 #define M_NOBRACKET 'd' /* never angle bracket envelope route-addrs */ 432 /* 'D' CF: include Date: */ 433 #define M_EXPENSIVE 'e' /* it costs to use this mailer.... */ 434 #define M_ESCFROM 'E' /* escape From lines to >From */ 435 #define M_FOPT 'f' /* mailer takes picky -f flag */ 436 /* 'F' CF: include From: or Resent-From: */ 437 #define M_NO_NULL_FROM 'g' /* sender of errors should be $g */ 438 #define M_HST_UPPER 'h' /* preserve host case distinction */ 439 #define M_PREHEAD 'H' /* MAIL11V3: preview headers */ 440 #define M_UDBENVELOPE 'i' /* do udbsender rewriting on envelope */ 441 #define M_INTERNAL 'I' /* SMTP to another sendmail site */ 442 #define M_UDBRECIPIENT 'j' /* do udbsender rewriting on recipient lines */ 443 #define M_NOLOOPCHECK 'k' /* don't check for loops in HELO command */ 444 #define M_CHUNKING 'K' /* CHUNKING: reserved for future use */ 445 #define M_LOCALMAILER 'l' /* delivery is to this host */ 446 #define M_LIMITS 'L' /* must enforce SMTP line limits */ 447 #define M_MUSER 'm' /* can handle multiple users at once */ 448 /* 'M' CF: include Message-Id: */ 449 #define M_NHDR 'n' /* don't insert From line */ 450 #define M_MANYSTATUS 'N' /* MAIL11V3: DATA returns multi-status */ 451 #define M_RUNASRCPT 'o' /* always run mailer as recipient */ 452 #define M_FROMPATH 'p' /* use reverse-path in MAIL FROM: */ 453 /* 'P' CF: include Return-Path: */ 454 #define M_VRFY250 'q' /* VRFY command returns 250 instead of 252 */ 455 #define M_ROPT 'r' /* mailer takes picky -r flag */ 456 #define M_SECURE_PORT 'R' /* try to send on a reserved TCP port */ 457 #define M_STRIPQ 's' /* strip quote chars from user/host */ 458 #define M_SPECIFIC_UID 'S' /* run as specific uid/gid */ 459 #define M_USR_UPPER 'u' /* preserve user case distinction */ 460 #define M_UGLYUUCP 'U' /* this wants an ugly UUCP from line */ 461 #define M_CONTENT_LEN 'v' /* add Content-Length: header (SVr4) */ 462 /* 'V' UIUC: !-relativize all addresses */ 463 #define M_HASPWENT 'w' /* check for /etc/passwd entry */ 464 #define M_NOHOSTSTAT 'W' /* ignore long term host status information */ 465 /* 'x' CF: include Full-Name: */ 466 #define M_XDOT 'X' /* use hidden-dot algorithm */ 467 #define M_LMTP 'z' /* run Local Mail Transport Protocol */ 468 #define M_DIALDELAY 'Z' /* apply dial delay sleeptime */ 469 #define M_NOMX '0' /* turn off MX lookups */ 470 #define M_NONULLS '1' /* don't send null bytes */ 471 #define M_FSMTP '2' /* force SMTP (no ESMTP even if offered) */ 472 #define M_EBCDIC '3' /* extend Q-P encoding for EBCDIC */ 473 #define M_TRYRULESET5 '5' /* use ruleset 5 after local aliasing */ 474 #define M_7BITHDRS '6' /* strip headers to 7 bits even in 8 bit path */ 475 #define M_7BITS '7' /* use 7-bit path */ 476 #define M_8BITS '8' /* force "just send 8" behaviour */ 477 #define M_MAKE8BIT '9' /* convert 7 -> 8 bit if appropriate */ 478 #define M_CHECKINCLUDE ':' /* check for :include: files */ 479 #define M_CHECKPROG '|' /* check for |program addresses */ 480 #define M_CHECKFILE '/' /* check for /file addresses */ 481 #define M_CHECKUDB '@' /* user can be user database key */ 482 #define M_CHECKHDIR '~' /* SGI: check for valid home directory */ 483 #define M_HOLD '%' /* Hold delivery until ETRN/-qI/-qR/-qS */ 484 #define M_PLUS '+' /* Reserved: Used in mc for adding new flags */ 485 #define M_MINUS '-' /* Reserved: Used in mc for removing flags */ 486 #define M_NOMHHACK '!' /* Don't perform HM hack dropping explicit from */ 487 488 /* functions */ 489 extern void initerrmailers __P((void)); 490 extern void makemailer __P((char *)); 491 extern void makequeue __P((char *, bool)); 492 extern void runqueueevent __P((int)); 493 #if _FFR_QUEUE_RUN_PARANOIA 494 extern bool checkqueuerunner __P((void)); 495 #endif /* _FFR_QUEUE_RUN_PARANOIA */ 496 497 EXTERN MAILER *FileMailer; /* ptr to *file* mailer */ 498 EXTERN MAILER *InclMailer; /* ptr to *include* mailer */ 499 EXTERN MAILER *LocalMailer; /* ptr to local mailer */ 500 EXTERN MAILER *ProgMailer; /* ptr to program mailer */ 501 EXTERN MAILER *Mailer[MAXMAILERS + 1]; 502 503 /* 504 ** Queue group definition structure. 505 ** Every queue group known to the system is declared in this structure. 506 ** It defines the basic pathname of the queue group, some flags 507 ** associated with it, and the argument vector to pass to it. 508 */ 509 510 struct qpaths_s 511 { 512 char *qp_name; /* name of queue dir, relative path */ 513 short qp_subdirs; /* use subdirs? */ 514 short qp_fsysidx; /* file system index of this directory */ 515 # if SM_CONF_SHM 516 int qp_idx; /* index into array for queue information */ 517 # endif /* SM_CONF_SHM */ 518 }; 519 520 typedef struct qpaths_s QPATHS; 521 522 struct queuegrp 523 { 524 char *qg_name; /* symbolic name of this queue group */ 525 526 /* 527 ** For now this is the same across all queue groups. 528 ** Otherwise we have to play around with chdir(). 529 */ 530 531 char *qg_qdir; /* common component of queue directory */ 532 short qg_index; /* queue number internally, index in Queue[] */ 533 int qg_maxqrun; /* max # of jobs in 1 queuerun */ 534 int qg_numqueues; /* number of queues in this queue */ 535 536 /* 537 ** qg_queueintvl == 0 denotes that no individual value is used. 538 ** Whatever accesses this must deal with "<= 0" as 539 ** "not set, use appropriate default". 540 */ 541 542 time_t qg_queueintvl; /* interval for queue runs */ 543 QPATHS *qg_qpaths; /* list of queue directories */ 544 BITMAP256 qg_flags; /* status flags, see below */ 545 short qg_nice; /* niceness for queue run */ 546 int qg_wgrp; /* Assigned to this work group */ 547 int qg_maxlist; /* max items in work queue for this group */ 548 int qg_curnum; /* current number of queue for queue runs */ 549 int qg_maxrcpt; /* max recipients per envelope, 0==no limit */ 550 551 time_t qg_nextrun; /* time for next queue runs */ 552 #if _FFR_QUEUE_GROUP_SORTORDER 553 short qg_sortorder; /* how do we sort this queuerun */ 554 #endif /* _FFR_QUEUE_GROUP_SORTORDER */ 555 #if 0 556 long qg_wkrcptfact; /* multiplier for # recipients -> priority */ 557 long qg_qfactor; /* slope of queue function */ 558 bool qg_doqueuerun; /* XXX flag is it time to do a queuerun */ 559 #endif /* 0 */ 560 }; 561 562 /* bits for qg_flags (XXX: unused as of now) */ 563 #define QD_DEFINED ((char) 1) /* queue group has been defined */ 564 #define QD_FORK 'f' /* fork queue runs */ 565 566 extern void filesys_update __P((void)); 567 #if _FFR_ANY_FREE_FS 568 extern bool filesys_free __P((long)); 569 #endif /* _FFR_ANY_FREE_FS */ 570 571 #if SASL 572 /* 573 ** SASL 574 */ 575 576 /* lines in authinfo file or index into SASL_AI_T */ 577 # define SASL_WRONG (-1) 578 # define SASL_USER 0 /* authorization id (user) */ 579 # define SASL_AUTHID 1 /* authentication id */ 580 # define SASL_PASSWORD 2 /* password fuer authid */ 581 # define SASL_DEFREALM 3 /* realm to use */ 582 # define SASL_MECHLIST 4 /* list of mechanisms to try */ 583 # define SASL_ID_REALM 5 /* authid@defrealm */ 584 585 /* 586 ** Current mechanism; this is just used to convey information between 587 ** invocation of SASL callback functions. 588 ** It must be last in the list, because it's not allocated by us 589 ** and hence we don't free() it. 590 */ 591 # define SASL_MECH 6 592 # define SASL_ENTRIES 7 /* number of entries in array */ 593 594 # define SASL_USER_BIT (1 << SASL_USER) 595 # define SASL_AUTHID_BIT (1 << SASL_AUTHID) 596 # define SASL_PASSWORD_BIT (1 << SASL_PASSWORD) 597 # define SASL_DEFREALM_BIT (1 << SASL_DEFREALM) 598 # define SASL_MECHLIST_BIT (1 << SASL_MECHLIST) 599 600 /* authenticated? */ 601 # define SASL_NOT_AUTH 0 /* not authenticated */ 602 # define SASL_PROC_AUTH 1 /* in process of authenticating */ 603 # define SASL_IS_AUTH 2 /* authenticated */ 604 605 /* SASL options */ 606 # define SASL_AUTH_AUTH 0x1000 /* use auth= only if authenticated */ 607 # if SASL >= 20101 608 # define SASL_SEC_MASK SASL_SEC_MAXIMUM /* mask for SASL_SEC_* values: sasl.h */ 609 # else /* SASL >= 20101 */ 610 # define SASL_SEC_MASK 0x0fff /* mask for SASL_SEC_* values: sasl.h */ 611 # if (SASL_SEC_NOPLAINTEXT & SASL_SEC_MASK) == 0 || \ 612 (SASL_SEC_NOACTIVE & SASL_SEC_MASK) == 0 || \ 613 (SASL_SEC_NODICTIONARY & SASL_SEC_MASK) == 0 || \ 614 (SASL_SEC_FORWARD_SECRECY & SASL_SEC_MASK) == 0 || \ 615 (SASL_SEC_NOANONYMOUS & SASL_SEC_MASK) == 0 || \ 616 (SASL_SEC_PASS_CREDENTIALS & SASL_SEC_MASK) == 0 617 ERROR: change SASL_SEC_MASK_ notify sendmail.org! 618 # endif /* SASL_SEC_NOPLAINTEXT & SASL_SEC_MASK) == 0 ... */ 619 # endif /* SASL >= 20101 */ 620 # define MAXOUTLEN 8192 /* length of output buffer, should be 2^n */ 621 622 /* functions */ 623 extern char *intersect __P((char *, char *, SM_RPOOL_T *)); 624 extern char *iteminlist __P((char *, char *, char *)); 625 # if SASL >= 20000 626 extern int proxy_policy __P((sasl_conn_t *, void *, const char *, unsigned, const char *, unsigned, const char *, unsigned, struct propctx *)); 627 extern int safesaslfile __P((void *, const char *, sasl_verify_type_t)); 628 # else /* SASL >= 20000 */ 629 extern int proxy_policy __P((void *, const char *, const char *, const char **, const char **)); 630 # if SASL > 10515 631 extern int safesaslfile __P((void *, char *, int)); 632 # else /* SASL > 10515 */ 633 extern int safesaslfile __P((void *, char *)); 634 # endif /* SASL > 10515 */ 635 # endif /* SASL >= 20000 */ 636 extern void stop_sasl_client __P((void)); 637 638 /* structure to store authinfo */ 639 typedef char *SASL_AI_T[SASL_ENTRIES]; 640 641 EXTERN char *AuthMechanisms; /* AUTH mechanisms */ 642 EXTERN char *AuthRealm; /* AUTH realm */ 643 EXTERN char *SASLInfo; /* file with AUTH info */ 644 EXTERN int SASLOpts; /* options for SASL */ 645 EXTERN int MaxSLBits; /* max. encryption bits for SASL */ 646 #endif /* SASL */ 647 648 /* 649 ** Structure to store macros. 650 */ 651 typedef struct 652 { 653 SM_RPOOL_T *mac_rpool; /* resource pool */ 654 BITMAP256 mac_allocated; /* storage has been alloc()? */ 655 char *mac_table[MAXMACROID + 1]; /* macros */ 656 } MACROS_T; 657 658 EXTERN MACROS_T GlobalMacros; 659 660 /* 661 ** Information about currently open connections to mailers, or to 662 ** hosts that we have looked up recently. 663 */ 664 665 #define MCI struct mailer_con_info 666 667 MCI 668 { 669 unsigned long mci_flags; /* flag bits, see below */ 670 short mci_errno; /* error number on last connection */ 671 short mci_herrno; /* h_errno from last DNS lookup */ 672 short mci_exitstat; /* exit status from last connection */ 673 short mci_state; /* SMTP state */ 674 int mci_deliveries; /* delivery attempts for connection */ 675 long mci_maxsize; /* max size this server will accept */ 676 SM_FILE_T *mci_in; /* input side of connection */ 677 SM_FILE_T *mci_out; /* output side of connection */ 678 pid_t mci_pid; /* process id of subordinate proc */ 679 char *mci_phase; /* SMTP phase string */ 680 struct mailer *mci_mailer; /* ptr to the mailer for this conn */ 681 char *mci_host; /* host name */ 682 char *mci_status; /* DSN status to be copied to addrs */ 683 char *mci_rstatus; /* SMTP status to be copied to addrs */ 684 time_t mci_lastuse; /* last usage time */ 685 SM_FILE_T *mci_statfile; /* long term status file */ 686 char *mci_heloname; /* name to use as HELO arg */ 687 long mci_min_by; /* minimum DELIVERBY */ 688 bool mci_retryrcpt; /* tempfail for at least one rcpt */ 689 char *mci_tolist; /* list of valid recipients */ 690 SM_RPOOL_T *mci_rpool; /* resource pool */ 691 #if PIPELINING 692 int mci_okrcpts; /* number of valid recipients */ 693 ADDRESS *mci_nextaddr; /* next address for pipelined status */ 694 #endif /* PIPELINING */ 695 #if SASL 696 SASL_AI_T mci_sai; /* authentication info */ 697 bool mci_sasl_auth; /* authenticated? */ 698 int mci_sasl_string_len; 699 char *mci_sasl_string; /* sasl reply string */ 700 char *mci_saslcap; /* SASL list of mechanisms */ 701 sasl_conn_t *mci_conn; /* SASL connection */ 702 #endif /* SASL */ 703 #if STARTTLS 704 SSL *mci_ssl; /* SSL connection */ 705 #endif /* STARTTLS */ 706 MACROS_T mci_macro; /* macro definitions */ 707 }; 708 709 710 /* flag bits */ 711 #define MCIF_VALID 0x00000001 /* this entry is valid */ 712 /* 0x00000002 unused, was MCIF_TEMP */ 713 #define MCIF_CACHED 0x00000004 /* currently in open cache */ 714 #define MCIF_ESMTP 0x00000008 /* this host speaks ESMTP */ 715 #define MCIF_EXPN 0x00000010 /* EXPN command supported */ 716 #define MCIF_SIZE 0x00000020 /* SIZE option supported */ 717 #define MCIF_8BITMIME 0x00000040 /* BODY=8BITMIME supported */ 718 #define MCIF_7BIT 0x00000080 /* strip this message to 7 bits */ 719 /* 0x00000100 unused, was MCIF_MULTSTAT: MAIL11V3: handles MULT status */ 720 #define MCIF_INHEADER 0x00000200 /* currently outputing header */ 721 #define MCIF_CVT8TO7 0x00000400 /* convert from 8 to 7 bits */ 722 #define MCIF_DSN 0x00000800 /* DSN extension supported */ 723 #define MCIF_8BITOK 0x00001000 /* OK to send 8 bit characters */ 724 #define MCIF_CVT7TO8 0x00002000 /* convert from 7 to 8 bits */ 725 #define MCIF_INMIME 0x00004000 /* currently reading MIME header */ 726 #define MCIF_AUTH 0x00008000 /* AUTH= supported */ 727 #define MCIF_AUTHACT 0x00010000 /* SASL (AUTH) active */ 728 #define MCIF_ENHSTAT 0x00020000 /* ENHANCEDSTATUSCODES supported */ 729 #define MCIF_PIPELINED 0x00040000 /* PIPELINING supported */ 730 #define MCIF_VERB 0x00080000 /* VERB supported */ 731 #if STARTTLS 732 #define MCIF_TLS 0x00100000 /* STARTTLS supported */ 733 #define MCIF_TLSACT 0x00200000 /* STARTTLS active */ 734 #else /* STARTTLS */ 735 #define MCIF_TLS 0 736 #define MCIF_TLSACT 0 737 #endif /* STARTTLS */ 738 #define MCIF_DLVR_BY 0x00400000 /* DELIVERBY */ 739 #if _FFR_IGNORE_EXT_ON_HELO 740 # define MCIF_HELO 0x00800000 /* we used HELO: ignore extensions */ 741 #endif /* _FFR_IGNORE_EXT_ON_HELO */ 742 #define MCIF_INLONGLINE 0x01000000 /* in the middle of a long line */ 743 #define MCIF_AUTH2 0x02000000 /* got 2 AUTH lines */ 744 #define MCIF_ONLY_EHLO 0x10000000 /* use only EHLO in smtpinit */ 745 746 #define MCIF_EXTENS (MCIF_EXPN | MCIF_SIZE | MCIF_8BITMIME | MCIF_DSN | MCIF_8BITOK | MCIF_AUTH | MCIF_ENHSTAT | MCIF_TLS | MCIF_AUTH2) 747 748 /* states */ 749 #define MCIS_CLOSED 0 /* no traffic on this connection */ 750 #define MCIS_OPENING 1 /* sending initial protocol */ 751 #define MCIS_OPEN 2 /* open, initial protocol sent */ 752 #define MCIS_MAIL 3 /* MAIL command sent */ 753 #define MCIS_RCPT 4 /* RCPT commands being sent */ 754 #define MCIS_DATA 5 /* DATA command sent */ 755 #define MCIS_QUITING 6 /* running quit protocol */ 756 #define MCIS_SSD 7 /* service shutting down */ 757 #define MCIS_ERROR 8 /* I/O error on connection */ 758 759 /* functions */ 760 extern void mci_cache __P((MCI *)); 761 extern void mci_close __P((MCI *, char *where)); 762 extern void mci_dump __P((SM_FILE_T *, MCI *, bool)); 763 extern void mci_dump_all __P((SM_FILE_T *, bool)); 764 extern void mci_flush __P((bool, MCI *)); 765 extern void mci_clr_extensions __P((MCI *)); 766 extern MCI *mci_get __P((char *, MAILER *)); 767 extern int mci_lock_host __P((MCI *)); 768 extern bool mci_match __P((char *, MAILER *)); 769 extern int mci_print_persistent __P((char *, char *)); 770 extern int mci_purge_persistent __P((char *, char *)); 771 extern MCI **mci_scan __P((MCI *)); 772 extern void mci_setstat __P((MCI *, int, char *, char *)); 773 extern void mci_store_persistent __P((MCI *)); 774 extern int mci_traverse_persistent __P((int (*)(char *, char *), char *)); 775 extern void mci_unlock_host __P((MCI *)); 776 777 EXTERN int MaxMciCache; /* maximum entries in MCI cache */ 778 EXTERN time_t MciCacheTimeout; /* maximum idle time on connections */ 779 EXTERN time_t MciInfoTimeout; /* how long 'til we retry down hosts */ 780 781 /* 782 ** Header structure. 783 ** This structure is used internally to store header items. 784 */ 785 786 struct header 787 { 788 char *h_field; /* the name of the field */ 789 char *h_value; /* the value of that field */ 790 struct header *h_link; /* the next header */ 791 unsigned char h_macro; /* include header if macro defined */ 792 unsigned long h_flags; /* status bits, see below */ 793 BITMAP256 h_mflags; /* m_flags bits needed */ 794 }; 795 796 typedef struct header HDR; 797 798 /* 799 ** Header information structure. 800 ** Defined in conf.c, this struct declares the header fields 801 ** that have some magic meaning. 802 */ 803 804 struct hdrinfo 805 { 806 char *hi_field; /* the name of the field */ 807 unsigned long hi_flags; /* status bits, see below */ 808 char *hi_ruleset; /* validity check ruleset */ 809 }; 810 811 extern struct hdrinfo HdrInfo[]; 812 813 /* bits for h_flags and hi_flags */ 814 #define H_EOH 0x00000001 /* field terminates header */ 815 #define H_RCPT 0x00000002 /* contains recipient addresses */ 816 #define H_DEFAULT 0x00000004 /* if another value is found, drop this */ 817 #define H_RESENT 0x00000008 /* this address is a "Resent-..." address */ 818 #define H_CHECK 0x00000010 /* check h_mflags against m_flags */ 819 #define H_ACHECK 0x00000020 /* ditto, but always (not just default) */ 820 #define H_FORCE 0x00000040 /* force this field, even if default */ 821 #define H_TRACE 0x00000080 /* this field contains trace information */ 822 #define H_FROM 0x00000100 /* this is a from-type field */ 823 #define H_VALID 0x00000200 /* this field has a validated value */ 824 #define H_RECEIPTTO 0x00000400 /* field has return receipt info */ 825 #define H_ERRORSTO 0x00000800 /* field has error address info */ 826 #define H_CTE 0x00001000 /* field is a content-transfer-encoding */ 827 #define H_CTYPE 0x00002000 /* this is a content-type field */ 828 #define H_BCC 0x00004000 /* Bcc: header: strip value or delete */ 829 #define H_ENCODABLE 0x00008000 /* field can be RFC 1522 encoded */ 830 #define H_STRIPCOMM 0x00010000 /* header check: strip comments */ 831 #define H_BINDLATE 0x00020000 /* only expand macros at deliver */ 832 #define H_USER 0x00040000 /* header came from the user/SMTP */ 833 834 /* bits for chompheader() */ 835 #define CHHDR_DEF 0x0001 /* default header */ 836 #define CHHDR_CHECK 0x0002 /* call ruleset for header */ 837 #define CHHDR_USER 0x0004 /* header from user */ 838 #define CHHDR_QUEUE 0x0008 /* header from queue file */ 839 840 /* functions */ 841 extern void addheader __P((char *, char *, int, ENVELOPE *, bool)); 842 extern unsigned long chompheader __P((char *, int, HDR **, ENVELOPE *)); 843 extern bool commaize __P((HDR *, char *, bool, MCI *, ENVELOPE *, int)); 844 extern HDR *copyheader __P((HDR *, SM_RPOOL_T *)); 845 extern void eatheader __P((ENVELOPE *, bool, bool)); 846 extern char *hvalue __P((char *, HDR *)); 847 extern void insheader __P((int, char *, char *, int, ENVELOPE *, bool)); 848 extern bool isheader __P((char *)); 849 extern bool putfromline __P((MCI *, ENVELOPE *)); 850 extern void setupheaders __P((void)); 851 852 /* 853 ** Performance monitoring 854 */ 855 856 #define TIMERS struct sm_timers 857 858 TIMERS 859 { 860 TIMER ti_overall; /* the whole process */ 861 }; 862 863 864 #define PUSHTIMER(l, t) { if (tTd(98, l)) pushtimer(&t); } 865 #define POPTIMER(l, t) { if (tTd(98, l)) poptimer(&t); } 866 867 /* 868 ** Envelope structure. 869 ** This structure defines the message itself. There is usually 870 ** only one of these -- for the message that we originally read 871 ** and which is our primary interest -- but other envelopes can 872 ** be generated during processing. For example, error messages 873 ** will have their own envelope. 874 */ 875 876 struct envelope 877 { 878 HDR *e_header; /* head of header list */ 879 long e_msgpriority; /* adjusted priority of this message */ 880 time_t e_ctime; /* time message appeared in the queue */ 881 char *e_to; /* (list of) target person(s) */ 882 ADDRESS e_from; /* the person it is from */ 883 char *e_sender; /* e_from.q_paddr w comments stripped */ 884 char **e_fromdomain; /* the domain part of the sender */ 885 ADDRESS *e_sendqueue; /* list of message recipients */ 886 ADDRESS *e_errorqueue; /* the queue for error responses */ 887 888 /* 889 ** Overflow detection is based on < 0, so don't change this 890 ** to unsigned. We don't use unsigned and == ULONG_MAX because 891 ** some libc's don't have strtoul(), see mail_esmtp_args(). 892 */ 893 894 long e_msgsize; /* size of the message in bytes */ 895 char *e_msgid; /* message id (for logging) */ 896 unsigned long e_flags; /* flags, see below */ 897 int e_nrcpts; /* number of recipients */ 898 short e_class; /* msg class (priority, junk, etc.) */ 899 short e_hopcount; /* number of times processed */ 900 short e_nsent; /* number of sends since checkpoint */ 901 short e_sendmode; /* message send mode */ 902 short e_errormode; /* error return mode */ 903 short e_timeoutclass; /* message timeout class */ 904 bool (*e_puthdr)__P((MCI *, HDR *, ENVELOPE *, int)); 905 /* function to put header of message */ 906 bool (*e_putbody)__P((MCI *, ENVELOPE *, char *)); 907 /* function to put body of message */ 908 ENVELOPE *e_parent; /* the message this one encloses */ 909 ENVELOPE *e_sibling; /* the next envelope of interest */ 910 char *e_bodytype; /* type of message body */ 911 SM_FILE_T *e_dfp; /* data file */ 912 char *e_id; /* code for this entry in queue */ 913 #if _FFR_SESSID 914 char *e_sessid; /* session ID for this envelope */ 915 #endif /* _FFR_SESSID */ 916 int e_qgrp; /* queue group (index into queues) */ 917 int e_qdir; /* index into queue directories */ 918 int e_dfqgrp; /* data file queue group index */ 919 int e_dfqdir; /* data file queue directory index */ 920 int e_xfqgrp; /* queue group (index into queues) */ 921 int e_xfqdir; /* index into queue directories (xf) */ 922 SM_FILE_T *e_xfp; /* transcript file */ 923 SM_FILE_T *e_lockfp; /* the lock file for this message */ 924 char *e_message; /* error message; readonly; NULL, 925 * or allocated from e_rpool */ 926 char *e_statmsg; /* stat msg (changes per delivery). 927 * readonly. NULL or allocated from 928 * e_rpool. */ 929 char *e_quarmsg; /* why envelope is quarantined */ 930 char e_qfletter; /* queue file letter on disk */ 931 char *e_msgboundary; /* MIME-style message part boundary */ 932 char *e_origrcpt; /* original recipient (one only) */ 933 char *e_envid; /* envelope id from MAIL FROM: line */ 934 char *e_status; /* DSN status for this message */ 935 time_t e_dtime; /* time of last delivery attempt */ 936 int e_ntries; /* number of delivery attempts */ 937 dev_t e_dfdev; /* data file device (crash recovery) */ 938 ino_t e_dfino; /* data file inode (crash recovery) */ 939 MACROS_T e_macro; /* macro definitions */ 940 MCI *e_mci; /* connection info */ 941 char *e_auth_param; /* readonly; NULL or static storage or 942 * allocated from e_rpool */ 943 TIMERS e_timers; /* per job timers */ 944 long e_deliver_by; /* deliver by */ 945 int e_dlvr_flag; /* deliver by flag */ 946 SM_RPOOL_T *e_rpool; /* resource pool for this envelope */ 947 unsigned int e_features; /* server features */ 948 #if _FFR_MILTER_ENHSC 949 #define ENHSC_LEN 11 950 char e_enhsc[ENHSC_LEN]; /* enhanced status code */ 951 #endif /* _FFR_MILTER_ENHSC */ 952 }; 953 954 #define PRT_NONNEGL(v) ((v) < 0 ? LONG_MAX : (v)) 955 956 /* values for e_flags */ 957 #define EF_OLDSTYLE 0x00000001L /* use spaces (not commas) in hdrs */ 958 #define EF_INQUEUE 0x00000002L /* this message is fully queued */ 959 #define EF_NO_BODY_RETN 0x00000004L /* omit message body on error */ 960 #define EF_CLRQUEUE 0x00000008L /* disk copy is no longer needed */ 961 #define EF_SENDRECEIPT 0x00000010L /* send a return receipt */ 962 #define EF_FATALERRS 0x00000020L /* fatal errors occurred */ 963 #define EF_DELETE_BCC 0x00000040L /* delete Bcc: headers entirely */ 964 #define EF_RESPONSE 0x00000080L /* this is an error or return receipt */ 965 #define EF_RESENT 0x00000100L /* this message is being forwarded */ 966 #define EF_VRFYONLY 0x00000200L /* verify only (don't expand aliases) */ 967 #define EF_WARNING 0x00000400L /* warning message has been sent */ 968 #define EF_QUEUERUN 0x00000800L /* this envelope is from queue */ 969 #define EF_GLOBALERRS 0x00001000L /* treat errors as global */ 970 #define EF_PM_NOTIFY 0x00002000L /* send return mail to postmaster */ 971 #define EF_METOO 0x00004000L /* send to me too */ 972 #define EF_LOGSENDER 0x00008000L /* need to log the sender */ 973 #define EF_NORECEIPT 0x00010000L /* suppress all return-receipts */ 974 #define EF_HAS8BIT 0x00020000L /* at least one 8-bit char in body */ 975 #define EF_NL_NOT_EOL 0x00040000L /* don't accept raw NL as EOLine */ 976 #define EF_CRLF_NOT_EOL 0x00080000L /* don't accept CR-LF as EOLine */ 977 #define EF_RET_PARAM 0x00100000L /* RCPT command had RET argument */ 978 #define EF_HAS_DF 0x00200000L /* set when data file is instantiated */ 979 #define EF_IS_MIME 0x00400000L /* really is a MIME message */ 980 #define EF_DONT_MIME 0x00800000L /* never MIME this message */ 981 #define EF_DISCARD 0x01000000L /* discard the message */ 982 #define EF_TOOBIG 0x02000000L /* message is too big */ 983 #define EF_SPLIT 0x04000000L /* envelope has been split */ 984 #define EF_UNSAFE 0x08000000L /* unsafe: read from untrusted source */ 985 #define EF_TOODEEP 0x10000000L /* message is nested too deep */ 986 987 #define DLVR_NOTIFY 0x01 988 #define DLVR_RETURN 0x02 989 #define DLVR_TRACE 0x10 990 #define IS_DLVR_NOTIFY(e) (((e)->e_dlvr_flag & DLVR_NOTIFY) != 0) 991 #define IS_DLVR_RETURN(e) (((e)->e_dlvr_flag & DLVR_RETURN) != 0) 992 #define IS_DLVR_TRACE(e) (((e)->e_dlvr_flag & DLVR_TRACE) != 0) 993 #define IS_DLVR_BY(e) ((e)->e_dlvr_flag != 0) 994 995 #define BODYTYPE_NONE (0) 996 #define BODYTYPE_7BIT (1) 997 #define BODYTYPE_8BITMIME (2) 998 #define BODYTYPE_ILLEGAL (-1) 999 #define BODYTYPE_VALID(b) ((b) == BODYTYPE_7BIT || (b) == BODYTYPE_8BITMIME) 1000 1001 extern ENVELOPE BlankEnvelope; 1002 1003 /* functions */ 1004 extern void clearenvelope __P((ENVELOPE *, bool, SM_RPOOL_T *)); 1005 extern int dropenvelope __P((ENVELOPE *, bool, bool)); 1006 extern ENVELOPE *newenvelope __P((ENVELOPE *, ENVELOPE *, SM_RPOOL_T *)); 1007 extern void clrsessenvelope __P((ENVELOPE *)); 1008 extern void printenvflags __P((ENVELOPE *)); 1009 extern bool putbody __P((MCI *, ENVELOPE *, char *)); 1010 extern bool putheader __P((MCI *, HDR *, ENVELOPE *, int)); 1011 1012 /* 1013 ** Message priority classes. 1014 ** 1015 ** The message class is read directly from the Priority: header 1016 ** field in the message. 1017 ** 1018 ** CurEnv->e_msgpriority is the number of bytes in the message plus 1019 ** the creation time (so that jobs ``tend'' to be ordered correctly), 1020 ** adjusted by the message class, the number of recipients, and the 1021 ** amount of time the message has been sitting around. This number 1022 ** is used to order the queue. Higher values mean LOWER priority. 1023 ** 1024 ** Each priority class point is worth WkClassFact priority points; 1025 ** each recipient is worth WkRecipFact priority points. Each time 1026 ** we reprocess a message the priority is adjusted by WkTimeFact. 1027 ** WkTimeFact should normally decrease the priority so that jobs 1028 ** that have historically failed will be run later; thanks go to 1029 ** Jay Lepreau at Utah for pointing out the error in my thinking. 1030 ** 1031 ** The "class" is this number, unadjusted by the age or size of 1032 ** this message. Classes with negative representations will have 1033 ** error messages thrown away if they are not local. 1034 */ 1035 1036 struct priority 1037 { 1038 char *pri_name; /* external name of priority */ 1039 int pri_val; /* internal value for same */ 1040 }; 1041 1042 EXTERN int NumPriorities; /* pointer into Priorities */ 1043 EXTERN struct priority Priorities[MAXPRIORITIES]; 1044 1045 /* 1046 ** Rewrite rules. 1047 */ 1048 1049 struct rewrite 1050 { 1051 char **r_lhs; /* pattern match */ 1052 char **r_rhs; /* substitution value */ 1053 struct rewrite *r_next;/* next in chain */ 1054 int r_line; /* rule line in sendmail.cf */ 1055 }; 1056 1057 /* 1058 ** Special characters in rewriting rules. 1059 ** These are used internally only. 1060 ** The COND* rules are actually used in macros rather than in 1061 ** rewriting rules, but are given here because they 1062 ** cannot conflict. 1063 */ 1064 1065 /* "out of band" indicator */ 1066 /* sm/sendmail.h #define METAQUOTE ((unsigned char)0377) quotes the next octet */ 1067 1068 /* left hand side items */ 1069 #define MATCHZANY ((unsigned char)0220) /* match zero or more tokens */ 1070 #define MATCHANY ((unsigned char)0221) /* match one or more tokens */ 1071 #define MATCHONE ((unsigned char)0222) /* match exactly one token */ 1072 #define MATCHCLASS ((unsigned char)0223) /* match one token in a class */ 1073 #define MATCHNCLASS ((unsigned char)0224) /* match tokens not in class */ 1074 1075 /* right hand side items */ 1076 #define MATCHREPL ((unsigned char)0225) /* RHS replacement for above */ 1077 #define CANONNET ((unsigned char)0226) /* canonical net, next token */ 1078 #define CANONHOST ((unsigned char)0227) /* canonical host, next token */ 1079 #define CANONUSER ((unsigned char)0230) /* canonical user, next N tokens */ 1080 #define CALLSUBR ((unsigned char)0231) /* call another rewriting set */ 1081 1082 /* conditionals in macros (anywhere) */ 1083 #define CONDIF ((unsigned char)0232) /* conditional if-then */ 1084 #define CONDELSE ((unsigned char)0233) /* conditional else */ 1085 #define CONDFI ((unsigned char)0234) /* conditional fi */ 1086 1087 /* bracket characters for RHS host name lookup */ 1088 #define HOSTBEGIN ((unsigned char)0235) /* hostname lookup begin */ 1089 #define HOSTEND ((unsigned char)0236) /* hostname lookup end */ 1090 1091 /* bracket characters for RHS generalized lookup */ 1092 #define LOOKUPBEGIN ((unsigned char)0205) /* generalized lookup begin */ 1093 #define LOOKUPEND ((unsigned char)0206) /* generalized lookup end */ 1094 1095 /* macro substitution characters (anywhere) */ 1096 #define MACROEXPAND ((unsigned char)0201) /* macro expansion */ 1097 #define MACRODEXPAND ((unsigned char)0202) /* deferred macro expansion */ 1098 1099 /* to make the code clearer */ 1100 #define MATCHZERO CANONHOST 1101 1102 #define MAXMATCH 9 /* max params per rewrite */ 1103 #define MAX_MAP_ARGS 10 /* max arguments for map */ 1104 1105 /* external <==> internal mapping table */ 1106 struct metamac 1107 { 1108 char metaname; /* external code (after $) */ 1109 unsigned char metaval; /* internal code (as above) */ 1110 }; 1111 1112 /* values for macros with external names only */ 1113 #define MID_OPMODE 0202 /* operation mode */ 1114 1115 /* functions */ 1116 #if SM_HEAP_CHECK 1117 extern void 1118 macdefine_tagged __P(( 1119 MACROS_T *_mac, 1120 ARGCLASS_T _vclass, 1121 int _id, 1122 char *_value, 1123 char *_file, 1124 int _line, 1125 int _group)); 1126 # define macdefine(mac,c,id,v) \ 1127 macdefine_tagged(mac,c,id,v,__FILE__,__LINE__,sm_heap_group()) 1128 #else /* SM_HEAP_CHECK */ 1129 extern void 1130 macdefine __P(( 1131 MACROS_T *_mac, 1132 ARGCLASS_T _vclass, 1133 int _id, 1134 char *_value)); 1135 # define macdefine_tagged(mac,c,id,v,file,line,grp) macdefine(mac,c,id,v) 1136 #endif /* SM_HEAP_CHECK */ 1137 extern void macset __P((MACROS_T *, int, char *)); 1138 #define macget(mac, i) (mac)->mac_table[i] 1139 extern void expand __P((char *, char *, size_t, ENVELOPE *)); 1140 extern int macid_parse __P((char *, char **)); 1141 #define macid(name) macid_parse(name, NULL) 1142 extern char *macname __P((int)); 1143 extern char *macvalue __P((int, ENVELOPE *)); 1144 extern int rscheck __P((char *, char *, char *, ENVELOPE *, int, int, char *, char *, ADDRESS *)); 1145 extern int rscap __P((char *, char *, char *, ENVELOPE *, char ***, char *, int)); 1146 extern void setclass __P((int, char *)); 1147 extern int strtorwset __P((char *, char **, int)); 1148 extern char *translate_dollars __P((char *, char *, int *)); 1149 extern bool wordinclass __P((char *, int)); 1150 1151 /* 1152 ** Name canonification short circuit. 1153 ** 1154 ** If the name server for a host is down, the process of trying to 1155 ** canonify the name can hang. This is similar to (but alas, not 1156 ** identical to) looking up the name for delivery. This stab type 1157 ** caches the result of the name server lookup so we don't hang 1158 ** multiple times. 1159 */ 1160 1161 #define NAMECANON struct _namecanon 1162 1163 NAMECANON 1164 { 1165 short nc_errno; /* cached errno */ 1166 short nc_herrno; /* cached h_errno */ 1167 short nc_stat; /* cached exit status code */ 1168 short nc_flags; /* flag bits */ 1169 char *nc_cname; /* the canonical name */ 1170 time_t nc_exp; /* entry expires at */ 1171 }; 1172 1173 /* values for nc_flags */ 1174 #define NCF_VALID 0x0001 /* entry valid */ 1175 1176 /* hostsignature structure */ 1177 1178 struct hostsig_t 1179 { 1180 char *hs_sig; /* hostsignature */ 1181 time_t hs_exp; /* entry expires at */ 1182 }; 1183 1184 typedef struct hostsig_t HOSTSIG_T; 1185 1186 /* 1187 ** The standard udp packet size PACKETSZ (512) is not sufficient for some 1188 ** nameserver answers containing very many resource records. The resolver 1189 ** may switch to tcp and retry if it detects udp packet overflow. 1190 ** Also note that the resolver routines res_query and res_search return 1191 ** the size of the *un*truncated answer in case the supplied answer buffer 1192 ** it not big enough to accommodate the entire answer. 1193 */ 1194 1195 # ifndef MAXPACKET 1196 # define MAXPACKET 8192 /* max packet size used internally by BIND */ 1197 # endif /* ! MAXPACKET */ 1198 1199 /* 1200 ** The resolver functions res_{send,query,querydomain} expect the 1201 ** answer buffer to be aligned, but some versions of gcc4 reverse 1202 ** 25 years of history and no longer align char buffers on the 1203 ** stack, resulting in crashes on strict-alignment platforms. Use 1204 ** this union when putting the buffer on the stack to force the 1205 ** alignment, then cast to (HEADER *) or (unsigned char *) as needed. 1206 */ 1207 typedef union 1208 { 1209 HEADER qb1; 1210 unsigned char qb2[MAXPACKET]; 1211 } querybuf; 1212 1213 /* functions */ 1214 extern bool getcanonname __P((char *, int, bool, int *)); 1215 extern int getmxrr __P((char *, char **, unsigned short *, bool, int *, bool, int *)); 1216 extern char *hostsignature __P((MAILER *, char *)); 1217 extern int getfallbackmxrr __P((char *)); 1218 1219 /* 1220 ** Mapping functions 1221 ** 1222 ** These allow arbitrary mappings in the config file. The idea 1223 ** (albeit not the implementation) comes from IDA sendmail. 1224 */ 1225 1226 #define MAPCLASS struct _mapclass 1227 #define MAP struct _map 1228 #define MAXMAPACTIONS 5 /* size of map_actions array */ 1229 1230 1231 /* 1232 ** An actual map. 1233 */ 1234 1235 MAP 1236 { 1237 MAPCLASS *map_class; /* the class of this map */ 1238 MAPCLASS *map_orgclass; /* the original class of this map */ 1239 char *map_mname; /* name of this map */ 1240 long map_mflags; /* flags, see below */ 1241 char *map_file; /* the (nominal) filename */ 1242 ARBPTR_T map_db1; /* the open database ptr */ 1243 ARBPTR_T map_db2; /* an "extra" database pointer */ 1244 char *map_keycolnm; /* key column name */ 1245 char *map_valcolnm; /* value column name */ 1246 unsigned char map_keycolno; /* key column number */ 1247 unsigned char map_valcolno; /* value column number */ 1248 char map_coldelim; /* column delimiter */ 1249 char map_spacesub; /* spacesub */ 1250 char *map_app; /* to append to successful matches */ 1251 char *map_tapp; /* to append to "tempfail" matches */ 1252 char *map_domain; /* the (nominal) NIS domain */ 1253 char *map_rebuild; /* program to run to do auto-rebuild */ 1254 time_t map_mtime; /* last database modification time */ 1255 time_t map_timeout; /* timeout for map accesses */ 1256 int map_retry; /* # of retries for map accesses */ 1257 pid_t map_pid; /* PID of process which opened map */ 1258 int map_lockfd; /* auxiliary lock file descriptor */ 1259 short map_specificity; /* specificity of aliases */ 1260 MAP *map_stack[MAXMAPSTACK]; /* list for stacked maps */ 1261 short map_return[MAXMAPACTIONS]; /* return bitmaps for stacked maps */ 1262 }; 1263 1264 1265 /* bit values for map_mflags */ 1266 #define MF_VALID 0x00000001 /* this entry is valid */ 1267 #define MF_INCLNULL 0x00000002 /* include null byte in key */ 1268 #define MF_OPTIONAL 0x00000004 /* don't complain if map not found */ 1269 #define MF_NOFOLDCASE 0x00000008 /* don't fold case in keys */ 1270 #define MF_MATCHONLY 0x00000010 /* don't use the map value */ 1271 #define MF_OPEN 0x00000020 /* this entry is open */ 1272 #define MF_WRITABLE 0x00000040 /* open for writing */ 1273 #define MF_ALIAS 0x00000080 /* this is an alias file */ 1274 #define MF_TRY0NULL 0x00000100 /* try with no null byte */ 1275 #define MF_TRY1NULL 0x00000200 /* try with the null byte */ 1276 #define MF_LOCKED 0x00000400 /* this map is currently locked */ 1277 #define MF_ALIASWAIT 0x00000800 /* alias map in aliaswait state */ 1278 #define MF_IMPL_HASH 0x00001000 /* implicit: underlying hash database */ 1279 #define MF_IMPL_NDBM 0x00002000 /* implicit: underlying NDBM database */ 1280 /* 0x00004000 */ 1281 #define MF_APPEND 0x00008000 /* append new entry on rebuild */ 1282 #define MF_KEEPQUOTES 0x00010000 /* don't dequote key before lookup */ 1283 #define MF_NODEFER 0x00020000 /* don't defer if map lookup fails */ 1284 #define MF_REGEX_NOT 0x00040000 /* regular expression negation */ 1285 #define MF_DEFER 0x00080000 /* don't lookup map in defer mode */ 1286 #define MF_SINGLEMATCH 0x00100000 /* successful only if match one key */ 1287 #define MF_SINGLEDN 0x00200000 /* only one match, but multi values */ 1288 #define MF_FILECLASS 0x00400000 /* this is a file class map */ 1289 #define MF_OPENBOGUS 0x00800000 /* open failed, don't call map_close */ 1290 #define MF_CLOSING 0x01000000 /* map is being closed */ 1291 1292 #define DYNOPENMAP(map) \ 1293 do \ 1294 { \ 1295 if (!bitset(MF_OPEN, (map)->map_mflags)) \ 1296 { \ 1297 if (!openmap(map)) \ 1298 return NULL; \ 1299 } \ 1300 } while (0) 1301 1302 1303 /* indices for map_actions */ 1304 #define MA_NOTFOUND 0 /* member map returned "not found" */ 1305 #define MA_UNAVAIL 1 /* member map is not available */ 1306 #define MA_TRYAGAIN 2 /* member map returns temp failure */ 1307 1308 /* macros to handle MapTempFail */ 1309 #define BIT_IS_MTP 0x01 /* temp.failure occurred */ 1310 #define BIT_ASK_MTP 0x02 /* do we care about MapTempFail? */ 1311 #define RESET_MAPTEMPFAIL MapTempFail = 0 1312 #define INIT_MAPTEMPFAIL MapTempFail = BIT_ASK_MTP 1313 #define SET_MAPTEMPFAIL MapTempFail |= BIT_IS_MTP 1314 #define IS_MAPTEMPFAIL bitset(BIT_IS_MTP, MapTempFail) 1315 #define ASK_MAPTEMPFAIL bitset(BIT_ASK_MTP, MapTempFail) 1316 1317 /* 1318 ** The class of a map -- essentially the functions to call 1319 */ 1320 1321 MAPCLASS 1322 { 1323 char *map_cname; /* name of this map class */ 1324 char *map_ext; /* extension for database file */ 1325 short map_cflags; /* flag bits, see below */ 1326 bool (*map_parse)__P((MAP *, char *)); 1327 /* argument parsing function */ 1328 char *(*map_lookup)__P((MAP *, char *, char **, int *)); 1329 /* lookup function */ 1330 void (*map_store)__P((MAP *, char *, char *)); 1331 /* store function */ 1332 bool (*map_open)__P((MAP *, int)); 1333 /* open function */ 1334 void (*map_close)__P((MAP *)); 1335 /* close function */ 1336 }; 1337 1338 /* bit values for map_cflags */ 1339 #define MCF_ALIASOK 0x0001 /* can be used for aliases */ 1340 #define MCF_ALIASONLY 0x0002 /* usable only for aliases */ 1341 #define MCF_REBUILDABLE 0x0004 /* can rebuild alias files */ 1342 #define MCF_OPTFILE 0x0008 /* file name is optional */ 1343 #define MCF_NOTPERSIST 0x0010 /* don't keep map open all the time */ 1344 1345 /* functions */ 1346 extern void closemaps __P((bool)); 1347 extern bool impl_map_open __P((MAP *, int)); 1348 extern void initmaps __P((void)); 1349 extern MAP *makemapentry __P((char *)); 1350 extern void maplocaluser __P((ADDRESS *, ADDRESS **, int, ENVELOPE *)); 1351 extern char *map_rewrite __P((MAP *, const char *, size_t, char **)); 1352 #if NETINFO 1353 extern char *ni_propval __P((char *, char *, char *, char *, int)); 1354 #endif /* NETINFO */ 1355 extern bool openmap __P((MAP *)); 1356 extern int udbexpand __P((ADDRESS *, ADDRESS **, int, ENVELOPE *)); 1357 #if USERDB 1358 extern void _udbx_close __P((void)); 1359 extern char *udbsender __P((char *, SM_RPOOL_T *)); 1360 #endif /* USERDB */ 1361 1362 /* 1363 ** LDAP related items 1364 */ 1365 #if LDAPMAP 1366 /* struct defining LDAP Auth Methods */ 1367 struct lamvalues 1368 { 1369 char *lam_name; /* name of LDAP auth method */ 1370 int lam_code; /* numeric code */ 1371 }; 1372 1373 /* struct defining LDAP Alias Dereferencing */ 1374 struct ladvalues 1375 { 1376 char *lad_name; /* name of LDAP alias dereferencing method */ 1377 int lad_code; /* numeric code */ 1378 }; 1379 1380 /* struct defining LDAP Search Scope */ 1381 struct lssvalues 1382 { 1383 char *lss_name; /* name of LDAP search scope */ 1384 int lss_code; /* numeric code */ 1385 }; 1386 1387 /* functions */ 1388 extern bool ldapmap_parseargs __P((MAP *, char *)); 1389 extern void ldapmap_set_defaults __P((char *)); 1390 #endif /* LDAPMAP */ 1391 1392 /* 1393 ** PH related items 1394 */ 1395 1396 #if PH_MAP 1397 1398 # include <phclient.h> 1399 1400 struct ph_map_struct 1401 { 1402 char *ph_servers; /* list of ph servers */ 1403 char *ph_field_list; /* list of fields to search for match */ 1404 PH *ph; /* PH server handle */ 1405 int ph_fastclose; /* send "quit" command on close */ 1406 time_t ph_timeout; /* timeout interval */ 1407 }; 1408 typedef struct ph_map_struct PH_MAP_STRUCT; 1409 1410 #endif /* PH_MAP */ 1411 1412 /* 1413 ** Regular UNIX sockaddrs are too small to handle ISO addresses, so 1414 ** we are forced to declare a supertype here. 1415 */ 1416 1417 #if NETINET || NETINET6 || NETUNIX || NETISO || NETNS || NETX25 1418 union bigsockaddr 1419 { 1420 struct sockaddr sa; /* general version */ 1421 # if NETUNIX 1422 struct sockaddr_un sunix; /* UNIX family */ 1423 # endif /* NETUNIX */ 1424 # if NETINET 1425 struct sockaddr_in sin; /* INET family */ 1426 # endif /* NETINET */ 1427 # if NETINET6 1428 struct sockaddr_in6 sin6; /* INET/IPv6 */ 1429 # endif /* NETINET6 */ 1430 # if NETISO 1431 struct sockaddr_iso siso; /* ISO family */ 1432 # endif /* NETISO */ 1433 # if NETNS 1434 struct sockaddr_ns sns; /* XNS family */ 1435 # endif /* NETNS */ 1436 # if NETX25 1437 struct sockaddr_x25 sx25; /* X.25 family */ 1438 # endif /* NETX25 */ 1439 }; 1440 1441 # define SOCKADDR union bigsockaddr 1442 1443 /* functions */ 1444 extern char *anynet_ntoa __P((SOCKADDR *)); 1445 # if NETINET6 1446 extern char *anynet_ntop __P((struct in6_addr *, char *, size_t)); 1447 extern int anynet_pton __P((int, const char *, void *)); 1448 # endif /* NETINET6 */ 1449 extern char *hostnamebyanyaddr __P((SOCKADDR *)); 1450 extern char *validate_connection __P((SOCKADDR *, char *, ENVELOPE *)); 1451 # if SASL >= 20000 1452 extern bool iptostring __P((SOCKADDR *, SOCKADDR_LEN_T, char *, unsigned)); 1453 # endif /* SASL >= 20000 */ 1454 1455 #endif /* NETINET || NETINET6 || NETUNIX || NETISO || NETNS || NETX25 */ 1456 1457 /* 1458 ** Process List (proclist) 1459 */ 1460 1461 #define NO_PID ((pid_t) 0) 1462 #ifndef PROC_LIST_SEG 1463 # define PROC_LIST_SEG 32 /* number of pids to alloc at a time */ 1464 #endif /* ! PROC_LIST_SEG */ 1465 1466 /* process types */ 1467 #define PROC_NONE 0 1468 #define PROC_DAEMON 1 1469 #define PROC_DAEMON_CHILD 2 1470 #define PROC_QUEUE 3 1471 #define PROC_QUEUE_CHILD 3 1472 #define PROC_CONTROL 4 1473 #define PROC_CONTROL_CHILD 5 1474 1475 /* functions */ 1476 extern void proc_list_add __P((pid_t, char *, int, int, int, SOCKADDR *)); 1477 extern void proc_list_clear __P((void)); 1478 extern void proc_list_display __P((SM_FILE_T *, char *)); 1479 extern void proc_list_drop __P((pid_t, int, int *)); 1480 extern void proc_list_probe __P((void)); 1481 extern void proc_list_set __P((pid_t, char *)); 1482 extern void proc_list_signal __P((int, int)); 1483 1484 /* 1485 ** Symbol table definitions 1486 */ 1487 1488 struct symtab 1489 { 1490 char *s_name; /* name to be entered */ 1491 short s_symtype; /* general type (see below) */ 1492 struct symtab *s_next; /* pointer to next in chain */ 1493 union 1494 { 1495 BITMAP256 sv_class; /* bit-map of word classes */ 1496 MAILER *sv_mailer; /* pointer to mailer */ 1497 char *sv_alias; /* alias */ 1498 MAPCLASS sv_mapclass; /* mapping function class */ 1499 MAP sv_map; /* mapping function */ 1500 HOSTSIG_T sv_hostsig; /* host signature */ 1501 MCI sv_mci; /* mailer connection info */ 1502 NAMECANON sv_namecanon; /* canonical name cache */ 1503 int sv_macro; /* macro name => id mapping */ 1504 int sv_ruleset; /* ruleset index */ 1505 struct hdrinfo sv_header; /* header metainfo */ 1506 char *sv_service[MAXMAPSTACK]; /* service switch */ 1507 #if LDAPMAP 1508 MAP *sv_lmap; /* Maps for LDAP connection */ 1509 #endif /* LDAPMAP */ 1510 #if SOCKETMAP 1511 MAP *sv_socketmap; /* Maps for SOCKET connection */ 1512 #endif /* SOCKETMAP */ 1513 #if MILTER 1514 struct milter *sv_milter; /* milter filter name */ 1515 #endif /* MILTER */ 1516 QUEUEGRP *sv_queue; /* pointer to queue */ 1517 } s_value; 1518 }; 1519 1520 typedef struct symtab STAB; 1521 1522 /* symbol types */ 1523 #define ST_UNDEF 0 /* undefined type */ 1524 #define ST_CLASS 1 /* class map */ 1525 /* #define ST_unused 2 UNUSED */ 1526 #define ST_MAILER 3 /* a mailer header */ 1527 #define ST_ALIAS 4 /* an alias */ 1528 #define ST_MAPCLASS 5 /* mapping function class */ 1529 #define ST_MAP 6 /* mapping function */ 1530 #define ST_HOSTSIG 7 /* host signature */ 1531 #define ST_NAMECANON 8 /* cached canonical name */ 1532 #define ST_MACRO 9 /* macro name to id mapping */ 1533 #define ST_RULESET 10 /* ruleset index */ 1534 #define ST_SERVICE 11 /* service switch entry */ 1535 #define ST_HEADER 12 /* special header flags */ 1536 #if LDAPMAP 1537 # define ST_LMAP 13 /* List head of maps for LDAP connection */ 1538 #endif /* LDAPMAP */ 1539 #if MILTER 1540 # define ST_MILTER 14 /* milter filter */ 1541 #endif /* MILTER */ 1542 #define ST_QUEUE 15 /* a queue entry */ 1543 1544 #if SOCKETMAP 1545 # define ST_SOCKETMAP 16 /* List head of maps for SOCKET connection */ 1546 #endif /* SOCKETMAP */ 1547 1548 /* This entry must be last */ 1549 #define ST_MCI 17 /* mailer connection info (offset) */ 1550 1551 #define s_class s_value.sv_class 1552 #define s_mailer s_value.sv_mailer 1553 #define s_alias s_value.sv_alias 1554 #define s_mci s_value.sv_mci 1555 #define s_mapclass s_value.sv_mapclass 1556 #define s_hostsig s_value.sv_hostsig 1557 #define s_map s_value.sv_map 1558 #define s_namecanon s_value.sv_namecanon 1559 #define s_macro s_value.sv_macro 1560 #define s_ruleset s_value.sv_ruleset 1561 #define s_service s_value.sv_service 1562 #define s_header s_value.sv_header 1563 #if LDAPMAP 1564 # define s_lmap s_value.sv_lmap 1565 #endif /* LDAPMAP */ 1566 #if SOCKETMAP 1567 # define s_socketmap s_value.sv_socketmap 1568 #endif /* SOCKETMAP */ 1569 #if MILTER 1570 # define s_milter s_value.sv_milter 1571 #endif /* MILTER */ 1572 #define s_quegrp s_value.sv_queue 1573 1574 /* opcodes to stab */ 1575 #define ST_FIND 0 /* find entry */ 1576 #define ST_ENTER 1 /* enter if not there */ 1577 1578 /* functions */ 1579 extern STAB *stab __P((char *, int, int)); 1580 extern void stabapply __P((void (*)(STAB *, int), int)); 1581 1582 /* 1583 ** Operation, send, error, and MIME modes 1584 ** 1585 ** The operation mode describes the basic operation of sendmail. 1586 ** This can be set from the command line, and is "send mail" by 1587 ** default. 1588 ** 1589 ** The send mode tells how to send mail. It can be set in the 1590 ** configuration file. Its setting determines how quickly the 1591 ** mail will be delivered versus the load on your system. If the 1592 ** -v (verbose) flag is given, it will be forced to SM_DELIVER 1593 ** mode. 1594 ** 1595 ** The error mode tells how to return errors. 1596 */ 1597 1598 #define MD_DELIVER 'm' /* be a mail sender */ 1599 #define MD_SMTP 's' /* run SMTP on standard input */ 1600 #define MD_ARPAFTP 'a' /* obsolete ARPANET mode (Grey Book) */ 1601 #define MD_DAEMON 'd' /* run as a daemon */ 1602 #define MD_FGDAEMON 'D' /* run daemon in foreground */ 1603 #define MD_LOCAL 'l' /* like daemon, but localhost only */ 1604 #define MD_VERIFY 'v' /* verify: don't collect or deliver */ 1605 #define MD_TEST 't' /* test mode: resolve addrs only */ 1606 #define MD_INITALIAS 'i' /* initialize alias database */ 1607 #define MD_PRINT 'p' /* print the queue */ 1608 #define MD_PRINTNQE 'P' /* print number of entries in queue */ 1609 #define MD_FREEZE 'z' /* freeze the configuration file */ 1610 #define MD_HOSTSTAT 'h' /* print persistent host stat info */ 1611 #define MD_PURGESTAT 'H' /* purge persistent host stat info */ 1612 #define MD_QUEUERUN 'q' /* queue run */ 1613 #define MD_CHECKCONFIG 'C' /* check configuration file */ 1614 1615 #if _FFR_LOCAL_DAEMON 1616 EXTERN bool LocalDaemon; 1617 # if NETINET6 1618 EXTERN bool V6LoopbackAddrFound; /* found an IPv6 loopback address */ 1619 # define SETV6LOOPBACKADDRFOUND(sa) \ 1620 do \ 1621 { \ 1622 if (isloopback(sa)) \ 1623 V6LoopbackAddrFound = true; \ 1624 } while (0) 1625 # endif /* NETINET6 */ 1626 #else /* _FFR_LOCAL_DAEMON */ 1627 # define LocalDaemon false 1628 # define V6LoopbackAddrFound false 1629 # define SETV6LOOPBACKADDRFOUND(sa) 1630 #endif /* _FFR_LOCAL_DAEMON */ 1631 1632 /* Note: see also include/sendmail/pathnames.h: GET_CLIENT_CF */ 1633 1634 /* values for e_sendmode -- send modes */ 1635 #define SM_DELIVER 'i' /* interactive delivery */ 1636 #define SM_FORK 'b' /* deliver in background */ 1637 #if _FFR_DM_ONE 1638 #define SM_DM_ONE 'o' /* deliver first TA in background, then queue */ 1639 #endif /* _FFR_DM_ONE */ 1640 #define SM_QUEUE 'q' /* queue, don't deliver */ 1641 #define SM_DEFER 'd' /* defer map lookups as well as queue */ 1642 #define SM_VERIFY 'v' /* verify only (used internally) */ 1643 #define DM_NOTSET (-1) /* DeliveryMode (per daemon) option not set */ 1644 # define SM_IS_INTERACTIVE(m) ((m) == SM_DELIVER) 1645 1646 #define WILL_BE_QUEUED(m) ((m) == SM_QUEUE || (m) == SM_DEFER) 1647 1648 /* used only as a parameter to sendall */ 1649 #define SM_DEFAULT '\0' /* unspecified, use SendMode */ 1650 1651 /* functions */ 1652 extern void set_delivery_mode __P((int, ENVELOPE *)); 1653 1654 /* values for e_errormode -- error handling modes */ 1655 #define EM_PRINT 'p' /* print errors */ 1656 #define EM_MAIL 'm' /* mail back errors */ 1657 #define EM_WRITE 'w' /* write back errors */ 1658 #define EM_BERKNET 'e' /* special berknet processing */ 1659 #define EM_QUIET 'q' /* don't print messages (stat only) */ 1660 1661 1662 /* bit values for MimeMode */ 1663 #define MM_CVTMIME 0x0001 /* convert 8 to 7 bit MIME */ 1664 #define MM_PASS8BIT 0x0002 /* just send 8 bit data blind */ 1665 #define MM_MIME8BIT 0x0004 /* convert 8-bit data to MIME */ 1666 1667 1668 /* how to handle messages without any recipient addresses */ 1669 #define NRA_NO_ACTION 0 /* just leave it as is */ 1670 #define NRA_ADD_TO 1 /* add To: header */ 1671 #define NRA_ADD_APPARENTLY_TO 2 /* add Apparently-To: header */ 1672 #define NRA_ADD_BCC 3 /* add empty Bcc: header */ 1673 #define NRA_ADD_TO_UNDISCLOSED 4 /* add To: undisclosed:; header */ 1674 1675 1676 /* flags to putxline */ 1677 #define PXLF_NOTHINGSPECIAL 0 /* no special mapping */ 1678 #define PXLF_MAPFROM 0x0001 /* map From_ to >From_ */ 1679 #define PXLF_STRIP8BIT 0x0002 /* strip 8th bit */ 1680 #define PXLF_HEADER 0x0004 /* map newlines in headers */ 1681 #define PXLF_NOADDEOL 0x0008 /* if EOL not present, don't add one */ 1682 #define PXLF_STRIPMQUOTE 0x0010 /* strip METAQUOTEs */ 1683 1684 /* 1685 ** Privacy flags 1686 ** These are bit values for the PrivacyFlags word. 1687 */ 1688 1689 #define PRIV_PUBLIC 0 /* what have I got to hide? */ 1690 #define PRIV_NEEDMAILHELO 0x00000001 /* insist on HELO for MAIL */ 1691 #define PRIV_NEEDEXPNHELO 0x00000002 /* insist on HELO for EXPN */ 1692 #define PRIV_NEEDVRFYHELO 0x00000004 /* insist on HELO for VRFY */ 1693 #define PRIV_NOEXPN 0x00000008 /* disallow EXPN command */ 1694 #define PRIV_NOVRFY 0x00000010 /* disallow VRFY command */ 1695 #define PRIV_AUTHWARNINGS 0x00000020 /* flag possible auth probs */ 1696 #define PRIV_NOVERB 0x00000040 /* disallow VERB command */ 1697 #define PRIV_RESTRICTMAILQ 0x00010000 /* restrict mailq command */ 1698 #define PRIV_RESTRICTQRUN 0x00020000 /* restrict queue run */ 1699 #define PRIV_RESTRICTEXPAND 0x00040000 /* restrict alias/forward expansion */ 1700 #define PRIV_NOETRN 0x00080000 /* disallow ETRN command */ 1701 #define PRIV_NOBODYRETN 0x00100000 /* do not return bodies on bounces */ 1702 #define PRIV_NORECEIPTS 0x00200000 /* disallow return receipts */ 1703 #define PRIV_NOACTUALRECIPIENT 0x00400000 /* no X-Actual-Recipient in DSNs */ 1704 1705 /* don't give no info, anyway, anyhow (in the main SMTP transaction) */ 1706 #define PRIV_GOAWAY 0x0000ffff 1707 1708 /* struct defining such things */ 1709 struct prival 1710 { 1711 char *pv_name; /* name of privacy flag */ 1712 unsigned long pv_flag; /* numeric level */ 1713 }; 1714 1715 EXTERN unsigned long PrivacyFlags; /* privacy flags */ 1716 1717 1718 /* 1719 ** Flags passed to remotename, parseaddr, allocaddr, and buildaddr. 1720 */ 1721 1722 #define RF_SENDERADDR 0x001 /* this is a sender address */ 1723 #define RF_HEADERADDR 0x002 /* this is a header address */ 1724 #define RF_CANONICAL 0x004 /* strip comment information */ 1725 #define RF_ADDDOMAIN 0x008 /* OK to do domain extension */ 1726 #define RF_COPYPARSE 0x010 /* copy parsed user & host */ 1727 #define RF_COPYPADDR 0x020 /* copy print address */ 1728 #define RF_COPYALL (RF_COPYPARSE|RF_COPYPADDR) 1729 #define RF_COPYNONE 0 1730 #define RF_RM_ADDR 0x040 /* address to be removed */ 1731 1732 /* 1733 ** Flags passed to rscheck 1734 */ 1735 1736 #define RSF_RMCOMM 0x0001 /* strip comments */ 1737 #define RSF_UNSTRUCTURED 0x0002 /* unstructured, ignore syntax errors */ 1738 #define RSF_COUNT 0x0004 /* count rejections (statistics)? */ 1739 1740 /* 1741 ** Flags passed to mime8to7 and putheader. 1742 */ 1743 1744 #define M87F_OUTER 0 /* outer context */ 1745 #define M87F_NO8BIT 0x0001 /* can't have 8-bit in this section */ 1746 #define M87F_DIGEST 0x0002 /* processing multipart/digest */ 1747 #define M87F_NO8TO7 0x0004 /* don't do 8->7 bit conversions */ 1748 1749 /* functions */ 1750 extern bool mime7to8 __P((MCI *, HDR *, ENVELOPE *)); 1751 extern int mime8to7 __P((MCI *, HDR *, ENVELOPE *, char **, int, int)); 1752 1753 /* 1754 ** Flags passed to returntosender. 1755 */ 1756 1757 #define RTSF_NO_BODY 0 /* send headers only */ 1758 #define RTSF_SEND_BODY 0x0001 /* include body of message in return */ 1759 #define RTSF_PM_BOUNCE 0x0002 /* this is a postmaster bounce */ 1760 1761 /* functions */ 1762 extern int returntosender __P((char *, ADDRESS *, int, ENVELOPE *)); 1763 1764 /* 1765 ** Mail Filters (milter) 1766 */ 1767 1768 /* 1769 ** 32-bit type used by milter 1770 ** (needed by libmilter even if MILTER isn't defined) 1771 */ 1772 1773 typedef SM_INT32 mi_int32; 1774 1775 #if MILTER 1776 # define SMFTO_WRITE 0 /* Timeout for sending information */ 1777 # define SMFTO_READ 1 /* Timeout waiting for a response */ 1778 # define SMFTO_EOM 2 /* Timeout for ACK/NAK to EOM */ 1779 # define SMFTO_CONNECT 3 /* Timeout for connect() */ 1780 1781 # define SMFTO_NUM_TO 4 /* Total number of timeouts */ 1782 1783 struct milter 1784 { 1785 char *mf_name; /* filter name */ 1786 BITMAP256 mf_flags; /* MTA flags */ 1787 mi_int32 mf_fvers; /* filter version */ 1788 mi_int32 mf_fflags; /* filter flags */ 1789 mi_int32 mf_pflags; /* protocol flags */ 1790 char *mf_conn; /* connection info */ 1791 int mf_sock; /* connected socket */ 1792 char mf_state; /* state of filter */ 1793 char mf_lflags; /* "local" flags */ 1794 int mf_idx; /* milter number (index) */ 1795 time_t mf_timeout[SMFTO_NUM_TO]; /* timeouts */ 1796 #if _FFR_MILTER_CHECK 1797 /* for testing only */ 1798 mi_int32 mf_mta_prot_version; 1799 mi_int32 mf_mta_prot_flags; 1800 mi_int32 mf_mta_actions; 1801 #endif /* _FFR_MILTER_CHECK */ 1802 }; 1803 1804 #define MI_LFL_NONE 0x00000000 1805 #define MI_LFLAGS_SYM(st) (1 << (st)) /* has its own symlist for stage st */ 1806 1807 struct milters 1808 { 1809 mi_int32 mis_flags; /* filter flags */ 1810 }; 1811 typedef struct milters milters_T; 1812 1813 #define MIS_FL_NONE 0x00000000 /* no requirements... */ 1814 #define MIS_FL_DEL_RCPT 0x00000001 /* can delete rcpt */ 1815 #define MIS_FL_REJ_RCPT 0x00000002 /* can reject rcpt */ 1816 1817 1818 /* MTA flags */ 1819 # define SMF_REJECT 'R' /* Reject connection on filter fail */ 1820 # define SMF_TEMPFAIL 'T' /* tempfail connection on failure */ 1821 # define SMF_TEMPDROP '4' /* 421 connection on failure */ 1822 1823 EXTERN struct milter *InputFilters[MAXFILTERS]; 1824 EXTERN char *InputFilterList; 1825 EXTERN int MilterLogLevel; 1826 1827 /* functions */ 1828 extern void setup_daemon_milters __P((void)); 1829 #endif /* MILTER */ 1830 1831 /* 1832 ** Vendor codes 1833 ** 1834 ** Vendors can customize sendmail to add special behaviour, 1835 ** generally for back compatibility. Ideally, this should 1836 ** be set up in the .cf file using the "V" command. However, 1837 ** it's quite reasonable for some vendors to want the default 1838 ** be their old version; this can be set using 1839 ** -DVENDOR_DEFAULT=VENDOR_xxx 1840 ** in the Makefile. 1841 ** 1842 ** Vendors should apply to sendmail@sendmail.org for 1843 ** unique vendor codes. 1844 */ 1845 1846 #define VENDOR_BERKELEY 1 /* Berkeley-native configuration file */ 1847 #define VENDOR_SUN 2 /* Sun-native configuration file */ 1848 #define VENDOR_HP 3 /* Hewlett-Packard specific config syntax */ 1849 #define VENDOR_IBM 4 /* IBM specific config syntax */ 1850 #define VENDOR_SENDMAIL 5 /* Proofpoint, Inc. specific config syntax */ 1851 #define VENDOR_DEC 6 /* Compaq, DEC, Digital */ 1852 1853 /* prototypes for vendor-specific hook routines */ 1854 extern void vendor_daemon_setup __P((ENVELOPE *)); 1855 extern void vendor_set_uid __P((UID_T)); 1856 1857 1858 /* 1859 ** Terminal escape codes. 1860 ** 1861 ** To make debugging output clearer. 1862 */ 1863 1864 struct termescape 1865 { 1866 char *te_rv_on; /* turn reverse-video on */ 1867 char *te_under_on; /* turn underlining on */ 1868 char *te_normal; /* revert to normal output */ 1869 }; 1870 1871 /* 1872 ** Additional definitions 1873 */ 1874 1875 /* 1876 ** d_flags, see daemon.c 1877 ** general rule: lower case: required, upper case: No 1878 */ 1879 1880 #define D_AUTHREQ 'a' /* authentication required */ 1881 #define D_BINDIF 'b' /* use if_addr for outgoing connection */ 1882 #define D_CANONREQ 'c' /* canonification required (cf) */ 1883 #define D_IFNHELO 'h' /* use if name for HELO */ 1884 #define D_FQMAIL 'f' /* fq sender address required (cf) */ 1885 #define D_FQRCPT 'r' /* fq recipient address required (cf) */ 1886 #define D_SMTPS 's' /* SMTP over SSL (smtps) */ 1887 #define D_UNQUALOK 'u' /* unqualified address is ok (cf) */ 1888 #define D_NOAUTH 'A' /* no AUTH */ 1889 #define D_NOCANON 'C' /* no canonification (cf) */ 1890 #define D_NOETRN 'E' /* no ETRN (MSA) */ 1891 #define D_NOTLS 'S' /* don't use STARTTLS */ 1892 #define D_ETRNONLY ((char)0x01) /* allow only ETRN (disk low) */ 1893 #define D_OPTIONAL 'O' /* optional socket */ 1894 #define D_DISABLE ((char)0x02) /* optional socket disabled */ 1895 #define D_ISSET ((char)0x03) /* this client struct is set */ 1896 1897 #if STARTTLS 1898 /* 1899 ** TLS 1900 */ 1901 1902 /* what to do in the TLS initialization */ 1903 #define TLS_I_NONE 0x00000000 /* no requirements... */ 1904 #define TLS_I_CERT_EX 0x00000001 /* cert must exist */ 1905 #define TLS_I_CERT_UNR 0x00000002 /* cert must be g/o unreadable */ 1906 #define TLS_I_KEY_EX 0x00000004 /* key must exist */ 1907 #define TLS_I_KEY_UNR 0x00000008 /* key must be g/o unreadable */ 1908 #define TLS_I_CERTP_EX 0x00000010 /* CA cert path must exist */ 1909 #define TLS_I_CERTP_UNR 0x00000020 /* CA cert path must be g/o unreadable */ 1910 #define TLS_I_CERTF_EX 0x00000040 /* CA cert file must exist */ 1911 #define TLS_I_CERTF_UNR 0x00000080 /* CA cert file must be g/o unreadable */ 1912 #define TLS_I_RSA_TMP 0x00000100 /* RSA TMP must be generated */ 1913 #define TLS_I_USE_KEY 0x00000200 /* private key must usable */ 1914 #define TLS_I_USE_CERT 0x00000400 /* certificate must be usable */ 1915 #define TLS_I_VRFY_PATH 0x00000800 /* load verify path must succeed */ 1916 #define TLS_I_VRFY_LOC 0x00001000 /* load verify default must succeed */ 1917 #define TLS_I_CACHE 0x00002000 /* require cache */ 1918 #define TLS_I_TRY_DH 0x00004000 /* try DH certificate */ 1919 #define TLS_I_REQ_DH 0x00008000 /* require DH certificate */ 1920 #define TLS_I_DHPAR_EX 0x00010000 /* require DH parameters */ 1921 #define TLS_I_DHPAR_UNR 0x00020000 /* DH param. must be g/o unreadable */ 1922 #define TLS_I_DH512 0x00040000 /* generate 512bit DH param */ 1923 #define TLS_I_DH1024 0x00080000 /* generate 1024bit DH param */ 1924 #define TLS_I_DH2048 0x00100000 /* generate 2048bit DH param */ 1925 #define TLS_I_NO_VRFY 0x00200000 /* do not require authentication */ 1926 #define TLS_I_KEY_OUNR 0x00400000 /* Key must be other unreadable */ 1927 #define TLS_I_CRLF_EX 0x00800000 /* CRL file must exist */ 1928 #define TLS_I_CRLF_UNR 0x01000000 /* CRL file must be g/o unreadable */ 1929 1930 /* require server cert */ 1931 #define TLS_I_SRV_CERT (TLS_I_CERT_EX | TLS_I_KEY_EX | \ 1932 TLS_I_KEY_UNR | TLS_I_KEY_OUNR | \ 1933 TLS_I_CERTP_EX | TLS_I_CERTF_EX | \ 1934 TLS_I_USE_KEY | TLS_I_USE_CERT | TLS_I_CACHE) 1935 1936 /* server requirements */ 1937 #define TLS_I_SRV (TLS_I_SRV_CERT | TLS_I_RSA_TMP | TLS_I_VRFY_PATH | \ 1938 TLS_I_VRFY_LOC | TLS_I_TRY_DH | TLS_I_DH512 | \ 1939 TLS_I_CACHE) 1940 1941 /* client requirements */ 1942 #define TLS_I_CLT (TLS_I_KEY_UNR | TLS_I_KEY_OUNR) 1943 1944 #define TLS_AUTH_OK 0 1945 #define TLS_AUTH_NO 1 1946 #define TLS_AUTH_FAIL (-1) 1947 1948 /* functions */ 1949 extern bool init_tls_library __P((bool _fipsmode)); 1950 extern bool inittls __P((SSL_CTX **, unsigned long, long, bool, char *, char *, char *, char *, char *)); 1951 extern bool initclttls __P((bool)); 1952 extern void setclttls __P((bool)); 1953 extern bool initsrvtls __P((bool)); 1954 extern int tls_get_info __P((SSL *, bool, char *, MACROS_T *, bool)); 1955 extern int endtls __P((SSL *, char *)); 1956 extern void tlslogerr __P((int, const char *)); 1957 1958 1959 EXTERN char *CACertPath; /* path to CA certificates (dir. with hashes) */ 1960 EXTERN char *CACertFile; /* file with CA certificate */ 1961 EXTERN char *CltCertFile; /* file with client certificate */ 1962 EXTERN char *CltKeyFile; /* file with client private key */ 1963 # if _FFR_TLS_1 1964 EXTERN char *CipherList; /* list of ciphers */ 1965 EXTERN char *DHParams5; /* file with DH parameters (512) */ 1966 # endif /* _FFR_TLS_1 */ 1967 EXTERN char *DHParams; /* file with DH parameters */ 1968 EXTERN char *RandFile; /* source of random data */ 1969 EXTERN char *SrvCertFile; /* file with server certificate */ 1970 EXTERN char *SrvKeyFile; /* file with server private key */ 1971 EXTERN char *CRLFile; /* file CRLs */ 1972 #if _FFR_CRLPATH 1973 EXTERN char *CRLPath; /* path to CRLs (dir. with hashes) */ 1974 #endif /* _FFR_CRLPATH */ 1975 EXTERN unsigned long TLS_Srv_Opts; /* TLS server options */ 1976 EXTERN long Srv_SSL_Options, Clt_SSL_Options; /* SSL options */ 1977 #endif /* STARTTLS */ 1978 1979 /* 1980 ** Queue related items 1981 */ 1982 1983 /* queue file names */ 1984 #define ANYQFL_LETTER '?' 1985 #define QUARQF_LETTER 'h' 1986 #define DATAFL_LETTER 'd' 1987 #define XSCRPT_LETTER 'x' 1988 #define NORMQF_LETTER 'q' 1989 #define NEWQFL_LETTER 't' 1990 1991 # define TEMPQF_LETTER 'T' 1992 # define LOSEQF_LETTER 'Q' 1993 1994 /* queue sort order */ 1995 #define QSO_BYPRIORITY 0 /* sort by message priority */ 1996 #define QSO_BYHOST 1 /* sort by first host name */ 1997 #define QSO_BYTIME 2 /* sort by submission time */ 1998 #define QSO_BYFILENAME 3 /* sort by file name only */ 1999 #define QSO_RANDOM 4 /* sort in random order */ 2000 #define QSO_BYMODTIME 5 /* sort by modification time */ 2001 #define QSO_NONE 6 /* do not sort */ 2002 #if _FFR_RHS 2003 # define QSO_BYSHUFFLE 7 /* sort by shuffled host name */ 2004 #endif /* _FFR_RHS */ 2005 2006 #define NOQGRP (-1) /* no queue group (yet) */ 2007 #define ENVQGRP (-2) /* use queue group of envelope */ 2008 #define NOAQGRP (-3) /* no queue group in addr (yet) */ 2009 #define ISVALIDQGRP(x) ((x) >= 0) /* valid queue group? */ 2010 #define NOQDIR (-1) /* no queue directory (yet) */ 2011 #define ENVQDIR (-2) /* use queue directory of envelope */ 2012 #define NOAQDIR (-3) /* no queue directory in addr (yet) */ 2013 #define ISVALIDQDIR(x) ((x) >= 0) /* valid queue directory? */ 2014 #define RS_QUEUEGROUP "queuegroup" /* ruleset for queue group selection */ 2015 2016 #define NOW ((time_t) (-1)) /* queue return: now */ 2017 2018 /* SuperSafe values */ 2019 #define SAFE_NO 0 /* no fsync(): don't use... */ 2020 #define SAFE_INTERACTIVE 1 /* limit fsync() in -odi */ 2021 #define SAFE_REALLY 2 /* always fsync() */ 2022 #define SAFE_REALLY_POSTMILTER 3 /* fsync() if milter says OK */ 2023 2024 /* QueueMode bits */ 2025 #define QM_NORMAL ' ' 2026 #define QM_QUARANTINE 'Q' 2027 #define QM_LOST 'L' 2028 2029 /* Queue Run Limitations */ 2030 struct queue_char 2031 { 2032 char *queue_match; /* string to match */ 2033 bool queue_negate; /* or not match, if set */ 2034 struct queue_char *queue_next; 2035 }; 2036 2037 /* run_work_group() flags */ 2038 #define RWG_NONE 0x0000 2039 #define RWG_FORK 0x0001 2040 #define RWG_VERBOSE 0x0002 2041 #define RWG_PERSISTENT 0x0004 2042 #define RWG_FORCE 0x0008 2043 #define RWG_RUNALL 0x0010 2044 2045 typedef struct queue_char QUEUE_CHAR; 2046 2047 EXTERN int volatile CurRunners; /* current number of runner children */ 2048 EXTERN int MaxQueueRun; /* maximum number of jobs in one queue run */ 2049 EXTERN int MaxQueueChildren; /* max # of forked queue children */ 2050 EXTERN int MaxRunnersPerQueue; /* max # proc's active in queue group */ 2051 EXTERN int NiceQueueRun; /* nice queue runs to this value */ 2052 EXTERN int NumQueue; /* number of queue groups */ 2053 EXTERN int QueueFileMode; /* mode on files in mail queue */ 2054 EXTERN int QueueMode; /* which queue items to act upon */ 2055 EXTERN int QueueSortOrder; /* queue sorting order algorithm */ 2056 EXTERN time_t MinQueueAge; /* min delivery interval */ 2057 #if _FFR_EXPDELAY 2058 EXTERN time_t MaxQueueAge; /* max delivery interval */ 2059 #endif /* _FFR_EXPDELAY */ 2060 EXTERN time_t QueueIntvl; /* intervals between running the queue */ 2061 EXTERN char *QueueDir; /* location of queue directory */ 2062 EXTERN QUEUE_CHAR *QueueLimitId; /* limit queue run to id */ 2063 EXTERN QUEUE_CHAR *QueueLimitQuarantine; /* limit queue run to quarantine reason */ 2064 EXTERN QUEUE_CHAR *QueueLimitRecipient; /* limit queue run to rcpt */ 2065 EXTERN QUEUE_CHAR *QueueLimitSender; /* limit queue run to sender */ 2066 EXTERN QUEUEGRP *Queue[MAXQUEUEGROUPS + 1]; /* queue groups */ 2067 2068 /* functions */ 2069 extern void assign_queueid __P((ENVELOPE *)); 2070 extern ADDRESS *copyqueue __P((ADDRESS *, SM_RPOOL_T *)); 2071 extern void cleanup_queues __P((void)); 2072 extern bool doqueuerun __P((void)); 2073 extern void initsys __P((ENVELOPE *)); 2074 extern void loseqfile __P((ENVELOPE *, char *)); 2075 extern int name2qid __P((char *)); 2076 extern char *qid_printname __P((ENVELOPE *)); 2077 extern char *qid_printqueue __P((int, int)); 2078 extern void quarantine_queue __P((char *, int)); 2079 extern char *queuename __P((ENVELOPE *, int)); 2080 extern void queueup __P((ENVELOPE *, bool, bool)); 2081 extern bool runqueue __P((bool, bool, bool, bool)); 2082 extern bool run_work_group __P((int, int)); 2083 extern void set_def_queueval __P((QUEUEGRP *, bool)); 2084 extern void setup_queues __P((bool)); 2085 extern bool setnewqueue __P((ENVELOPE *)); 2086 extern bool shouldqueue __P((long, time_t)); 2087 extern void sync_queue_time __P((void)); 2088 extern void init_qid_alg __P((void)); 2089 extern int print_single_queue __P((int, int)); 2090 #if REQUIRES_DIR_FSYNC 2091 # define SYNC_DIR(path, panic) sync_dir(path, panic) 2092 extern void sync_dir __P((char *, bool)); 2093 #else /* REQUIRES_DIR_FSYNC */ 2094 # define SYNC_DIR(path, panic) ((void) 0) 2095 #endif /* REQUIRES_DIR_FSYNC */ 2096 2097 /* 2098 ** Timeouts 2099 ** 2100 ** Indicated values are the MINIMUM per RFC 1123 section 5.3.2. 2101 */ 2102 2103 EXTERN struct 2104 { 2105 /* RFC 1123-specified timeouts [minimum value] */ 2106 time_t to_initial; /* initial greeting timeout [5m] */ 2107 time_t to_mail; /* MAIL command [5m] */ 2108 time_t to_rcpt; /* RCPT command [5m] */ 2109 time_t to_datainit; /* DATA initiation [2m] */ 2110 time_t to_datablock; /* DATA block [3m] */ 2111 time_t to_datafinal; /* DATA completion [10m] */ 2112 time_t to_nextcommand; /* next command [5m] */ 2113 /* following timeouts are not mentioned in RFC 1123 */ 2114 time_t to_iconnect; /* initial connection timeout (first try) */ 2115 time_t to_connect; /* initial connection timeout (later tries) */ 2116 time_t to_aconnect; /* all connections timeout (MX and A records) */ 2117 time_t to_rset; /* RSET command */ 2118 time_t to_helo; /* HELO command */ 2119 time_t to_quit; /* QUIT command */ 2120 time_t to_miscshort; /* misc short commands (NOOP, VERB, etc) */ 2121 time_t to_ident; /* IDENT protocol requests */ 2122 time_t to_fileopen; /* opening :include: and .forward files */ 2123 time_t to_control; /* process a control socket command */ 2124 time_t to_lhlo; /* LMTP: LHLO command */ 2125 #if SASL 2126 time_t to_auth; /* AUTH dialogue [10m] */ 2127 #endif /* SASL */ 2128 #if STARTTLS 2129 time_t to_starttls; /* STARTTLS dialogue [10m] */ 2130 #endif /* STARTTLS */ 2131 /* following are per message */ 2132 time_t to_q_return[MAXTOCLASS]; /* queue return timeouts */ 2133 time_t to_q_warning[MAXTOCLASS]; /* queue warning timeouts */ 2134 time_t res_retrans[MAXRESTOTYPES]; /* resolver retransmit */ 2135 int res_retry[MAXRESTOTYPES]; /* resolver retry */ 2136 } TimeOuts; 2137 2138 /* timeout classes for return and warning timeouts */ 2139 #define TOC_NORMAL 0 /* normal delivery */ 2140 #define TOC_URGENT 1 /* urgent delivery */ 2141 #define TOC_NONURGENT 2 /* non-urgent delivery */ 2142 #define TOC_DSN 3 /* DSN delivery */ 2143 2144 /* resolver timeout specifiers */ 2145 #define RES_TO_FIRST 0 /* first attempt */ 2146 #define RES_TO_NORMAL 1 /* subsequent attempts */ 2147 #define RES_TO_DEFAULT 2 /* default value */ 2148 2149 /* functions */ 2150 extern void inittimeouts __P((char *, bool)); 2151 2152 /* 2153 ** Interface probing 2154 */ 2155 2156 #define DPI_PROBENONE 0 /* Don't probe any interfaces */ 2157 #define DPI_PROBEALL 1 /* Probe all interfaces */ 2158 #define DPI_SKIPLOOPBACK 2 /* Don't probe loopback interfaces */ 2159 2160 /* 2161 ** Trace information 2162 */ 2163 2164 /* macros for debugging flags */ 2165 #if NOT_SENDMAIL 2166 # define tTd(flag, level) (tTdvect[flag] >= (unsigned char)level) 2167 #else 2168 # define tTd(flag, level) (tTdvect[flag] >= (unsigned char)level && !IntSig) 2169 #endif 2170 #define tTdlevel(flag) (tTdvect[flag]) 2171 2172 /* variables */ 2173 extern unsigned char tTdvect[100]; /* trace vector */ 2174 2175 /* 2176 ** Miscellaneous information. 2177 */ 2178 2179 /* 2180 ** The "no queue id" queue id for sm_syslog 2181 */ 2182 2183 #define NOQID "" 2184 2185 #define CURHOSTNAME (CurHostName == NULL ? "local" : CurHostName) 2186 2187 /* 2188 ** Some in-line functions 2189 */ 2190 2191 /* set exit status */ 2192 #define setstat(s) \ 2193 do \ 2194 { \ 2195 if (ExitStat == EX_OK || ExitStat == EX_TEMPFAIL) \ 2196 ExitStat = s; \ 2197 } while (0) 2198 2199 2200 #define STRUCTCOPY(s, d) d = s 2201 2202 /* free a pointer if it isn't NULL and set it to NULL */ 2203 #define SM_FREE_CLR(p) \ 2204 do \ 2205 { \ 2206 if ((p) != NULL) \ 2207 { \ 2208 sm_free(p); \ 2209 (p) = NULL; \ 2210 } \ 2211 } while (0) 2212 2213 /* 2214 ** Update a permanent string variable with a new value. 2215 ** The old value is freed, the new value is strdup'ed. 2216 ** 2217 ** We use sm_pstrdup_x to duplicate the string because it raises 2218 ** an exception on error, and because it allocates "permanent storage" 2219 ** which is not expected to be freed before process exit. 2220 ** The latter is important for memory leak analysis. 2221 ** 2222 ** If an exception occurs while strdup'ing the new value, 2223 ** then the variable remains set to the old value. 2224 ** That's why the strdup must occur before we free the old value. 2225 ** 2226 ** The macro uses a do loop so that this idiom will work: 2227 ** if (...) 2228 ** PSTRSET(var, val1); 2229 ** else 2230 ** PSTRSET(var, val2); 2231 */ 2232 #define PSTRSET(var, val) \ 2233 do \ 2234 { \ 2235 char *_newval = sm_pstrdup_x(val); \ 2236 if (var != NULL) \ 2237 sm_free(var); \ 2238 var = _newval; \ 2239 } while (0) 2240 2241 #define _CHECK_RESTART \ 2242 do \ 2243 { \ 2244 if (ShutdownRequest != NULL) \ 2245 shutdown_daemon(); \ 2246 else if (RestartRequest != NULL) \ 2247 restart_daemon(); \ 2248 else if (RestartWorkGroup) \ 2249 restart_marked_work_groups(); \ 2250 } while (0) 2251 2252 # define CHECK_RESTART _CHECK_RESTART 2253 2254 #define CHK_CUR_RUNNERS(fct, idx, count) \ 2255 do \ 2256 { \ 2257 if (CurRunners < 0) \ 2258 { \ 2259 if (LogLevel > 3) \ 2260 sm_syslog(LOG_ERR, NOQID, \ 2261 "%s: CurRunners=%d, i=%d, count=%d, status=should not happen", \ 2262 fct, CurRunners, idx, count); \ 2263 CurRunners = 0; \ 2264 } \ 2265 } while (0) 2266 2267 /* reply types (text in SmtpMsgBuffer) */ 2268 #define XS_DEFAULT 0 2269 #define XS_STARTTLS 1 2270 #define XS_AUTH 2 2271 #define XS_GREET 3 2272 #define XS_EHLO 4 2273 #define XS_MAIL 5 2274 #define XS_RCPT 6 2275 #define XS_DATA 7 2276 #define XS_EOM 8 2277 #define XS_DATA2 9 2278 #define XS_RCPT2 10 2279 #define XS_QUIT 15 2280 2281 /* 2282 ** Global variables. 2283 */ 2284 2285 #if _FFR_ADDR_TYPE_MODES 2286 EXTERN bool AddrTypeModes; /* addr_type: extra "mode" information */ 2287 #endif /* _FFR_ADDR_TYPE_MODES */ 2288 EXTERN bool AllowBogusHELO; /* allow syntax errors on HELO command */ 2289 EXTERN bool CheckAliases; /* parse addresses during newaliases */ 2290 #if _FFR_QUEUE_RUN_PARANOIA 2291 EXTERN int CheckQueueRunners; /* check whether queue runners are OK */ 2292 #endif /* _FFR_QUEUE_RUN_PARANOIA */ 2293 EXTERN bool ColonOkInAddr; /* single colon legal in address */ 2294 #if !defined(_USE_SUN_NSSWITCH_) && !defined(_USE_DEC_SVC_CONF_) 2295 EXTERN bool ConfigFileRead; /* configuration file has been read */ 2296 #endif /* !defined(_USE_SUN_NSSWITCH_) && !defined(_USE_DEC_SVC_CONF_) */ 2297 EXTERN bool DisConnected; /* running with OutChannel redirect to transcript file */ 2298 EXTERN bool DontExpandCnames; /* do not $[...$] expand CNAMEs */ 2299 EXTERN bool DontInitGroups; /* avoid initgroups() because of NIS cost */ 2300 EXTERN bool DontLockReadFiles; /* don't read lock support files */ 2301 EXTERN bool DontPruneRoutes; /* don't prune source routes */ 2302 EXTERN bool ForkQueueRuns; /* fork for each job when running the queue */ 2303 EXTERN bool FromFlag; /* if set, "From" person is explicit */ 2304 EXTERN bool FipsMode; 2305 EXTERN bool GrabTo; /* if set, get recipients from msg */ 2306 EXTERN bool EightBitAddrOK; /* we'll let 8-bit addresses through */ 2307 EXTERN bool HasEightBits; /* has at least one eight bit input byte */ 2308 EXTERN bool HasWildcardMX; /* don't use MX records when canonifying */ 2309 EXTERN bool HoldErrs; /* only output errors to transcript */ 2310 EXTERN bool IgnoreHostStatus; /* ignore long term host status files */ 2311 EXTERN bool IgnrDot; /* don't let dot end messages */ 2312 EXTERN bool LogUsrErrs; /* syslog user errors (e.g., SMTP RCPT cmd) */ 2313 EXTERN bool MatchGecos; /* look for user names in gecos field */ 2314 EXTERN bool MeToo; /* send to the sender also */ 2315 EXTERN bool NoAlias; /* suppress aliasing */ 2316 EXTERN bool NoConnect; /* don't connect to non-local mailers */ 2317 EXTERN bool OnlyOneError; /* .... or only want to give one SMTP reply */ 2318 EXTERN bool QuickAbort; /* .... but only if we want a quick abort */ 2319 #if _FFR_REJECT_NUL_BYTE 2320 EXTERN bool RejectNUL; /* reject NUL input byte? */ 2321 #endif /* _FFR_REJECT_NUL_BYTE */ 2322 #if REQUIRES_DIR_FSYNC 2323 EXTERN bool RequiresDirfsync; /* requires fsync() for directory */ 2324 #endif /* REQUIRES_DIR_FSYNC */ 2325 EXTERN bool volatile RestartWorkGroup; /* daemon needs to restart some work groups */ 2326 EXTERN bool RrtImpliesDsn; /* turn Return-Receipt-To: into DSN */ 2327 EXTERN bool SaveFrom; /* save leading "From" lines */ 2328 EXTERN bool SendMIMEErrors; /* send error messages in MIME format */ 2329 EXTERN bool SevenBitInput; /* force 7-bit data on input */ 2330 EXTERN bool SingleLineFromHeader; /* force From: header to be one line */ 2331 EXTERN bool SingleThreadDelivery; /* single thread hosts on delivery */ 2332 EXTERN bool SoftBounce; /* replace 5xy by 4xy (for testing) */ 2333 EXTERN bool volatile StopRequest; /* stop sending output */ 2334 EXTERN bool SuprErrs; /* set if we are suppressing errors */ 2335 EXTERN bool TryNullMXList; /* if we are the best MX, try host directly */ 2336 EXTERN bool UseMSP; /* mail submission: group writable queue ok? */ 2337 EXTERN bool WorkAroundBrokenAAAA; /* some nameservers return SERVFAIL on AAAA queries */ 2338 EXTERN bool UseErrorsTo; /* use Errors-To: header (back compat) */ 2339 EXTERN bool UseNameServer; /* using DNS -- interpret h_errno & MX RRs */ 2340 EXTERN char InetMode; /* default network for daemon mode */ 2341 EXTERN char OpMode; /* operation mode, see below */ 2342 EXTERN char SpaceSub; /* substitution for <lwsp> */ 2343 #if _FFR_BADRCPT_SHUTDOWN 2344 EXTERN int BadRcptShutdown; /* Shutdown connection for rejected RCPTs */ 2345 EXTERN int BadRcptShutdownGood; /* above even when there are good RCPTs */ 2346 #endif /* _FFR_BADRCPT_SHUTDOWN */ 2347 EXTERN int BadRcptThrottle; /* Throttle rejected RCPTs per SMTP message */ 2348 #if _FFR_RCPTTHROTDELAY 2349 EXTERN unsigned int BadRcptThrottleDelay; /* delay for BadRcptThrottle */ 2350 #else 2351 # define BadRcptThrottleDelay 1 2352 #endif /* _FFR_RCPTTHROTDELAY */ 2353 EXTERN int CheckpointInterval; /* queue file checkpoint interval */ 2354 EXTERN int ConfigLevel; /* config file level */ 2355 EXTERN int ConnRateThrottle; /* throttle for SMTP connection rate */ 2356 EXTERN int volatile CurChildren; /* current number of daemonic children */ 2357 EXTERN int CurrentLA; /* current load average */ 2358 EXTERN int DefaultNotify; /* default DSN notification flags */ 2359 EXTERN int DelayLA; /* load average to delay connections */ 2360 EXTERN int DontProbeInterfaces; /* don't probe interfaces for names */ 2361 EXTERN int Errors; /* set if errors (local to single pass) */ 2362 EXTERN int ExitStat; /* exit status code */ 2363 EXTERN int FastSplit; /* fast initial splitting of envelopes */ 2364 EXTERN int FileMode; /* mode on files */ 2365 EXTERN int LineNumber; /* line number in current input */ 2366 EXTERN int LogLevel; /* level of logging to perform */ 2367 EXTERN int MaxAliasRecursion; /* maximum depth of alias recursion */ 2368 EXTERN int MaxChildren; /* maximum number of daemonic children */ 2369 EXTERN int MaxForwardEntries; /* maximum number of forward entries */ 2370 EXTERN int MaxHeadersLength; /* max length of headers */ 2371 EXTERN int MaxHopCount; /* max # of hops until bounce */ 2372 EXTERN int MaxMacroRecursion; /* maximum depth of macro recursion */ 2373 EXTERN int MaxMimeFieldLength; /* maximum MIME field length */ 2374 EXTERN int MaxMimeHeaderLength; /* maximum MIME header length */ 2375 EXTERN int MaxNOOPCommands; /* max "noise" commands before slowdown */ 2376 2377 EXTERN int MaxRcptPerMsg; /* max recipients per SMTP message */ 2378 EXTERN int MaxRuleRecursion; /* maximum depth of ruleset recursion */ 2379 #if _FFR_MSG_ACCEPT 2380 EXTERN char *MessageAccept; /* "Message accepted for delivery" reply text */ 2381 #endif /* _FFR_MSG_ACCEPT */ 2382 2383 EXTERN int MimeMode; /* MIME processing mode */ 2384 EXTERN int NoRecipientAction; 2385 2386 #if SM_CONF_SHM 2387 EXTERN int Numfilesys; /* number of queue file systems */ 2388 EXTERN int *PNumFileSys; 2389 # define NumFileSys (*PNumFileSys) 2390 # else /* SM_CONF_SHM */ 2391 EXTERN int NumFileSys; /* number of queue file systems */ 2392 # endif /* SM_CONF_SHM */ 2393 2394 EXTERN int QueueLA; /* load average starting forced queueing */ 2395 EXTERN int RefuseLA; /* load average refusing connections */ 2396 EXTERN time_t RejectLogInterval; /* time btwn log msgs while refusing */ 2397 #if _FFR_MEMSTAT 2398 EXTERN long QueueLowMem; /* low memory starting forced queueing */ 2399 EXTERN long RefuseLowMem; /* low memory refusing connections */ 2400 EXTERN char *MemoryResource;/* memory resource to look up */ 2401 #endif /* _FFR_MEMSTAT */ 2402 EXTERN int SuperSafe; /* be extra careful, even if expensive */ 2403 EXTERN int VendorCode; /* vendor-specific operation enhancements */ 2404 EXTERN int Verbose; /* set if blow-by-blow desired */ 2405 EXTERN gid_t DefGid; /* default gid to run as */ 2406 EXTERN gid_t RealGid; /* real gid of caller */ 2407 EXTERN gid_t RunAsGid; /* GID to become for bulk of run */ 2408 EXTERN gid_t EffGid; /* effective gid */ 2409 #if SM_CONF_SHM 2410 EXTERN key_t ShmKey; /* shared memory key */ 2411 EXTERN char *ShmKeyFile; /* shared memory key file */ 2412 #endif /* SM_CONF_SHM */ 2413 EXTERN pid_t CurrentPid; /* current process id */ 2414 EXTERN pid_t DaemonPid; /* process id of daemon */ 2415 EXTERN pid_t PidFilePid; /* daemon/queue runner who wrote pid file */ 2416 EXTERN uid_t DefUid; /* default uid to run as */ 2417 EXTERN uid_t RealUid; /* real uid of caller */ 2418 EXTERN uid_t RunAsUid; /* UID to become for bulk of run */ 2419 EXTERN uid_t TrustedUid; /* uid of trusted user for files and startup */ 2420 EXTERN size_t DataFileBufferSize; /* size of buf for in-core data file */ 2421 EXTERN time_t DeliverByMin; /* deliver by minimum time */ 2422 EXTERN time_t DialDelay; /* delay between dial-on-demand tries */ 2423 EXTERN time_t SafeAlias; /* interval to wait until @:@ in alias file */ 2424 EXTERN time_t ServiceCacheMaxAge; /* refresh interval for cache */ 2425 EXTERN size_t XscriptFileBufferSize; /* size of buf for in-core transcript file */ 2426 EXTERN MODE_T OldUmask; /* umask when sendmail starts up */ 2427 EXTERN long MaxMessageSize; /* advertised max size we will accept */ 2428 EXTERN long MinBlocksFree; /* min # of blocks free on queue fs */ 2429 EXTERN long QueueFactor; /* slope of queue function */ 2430 EXTERN long WkClassFact; /* multiplier for message class -> priority */ 2431 EXTERN long WkRecipFact; /* multiplier for # of recipients -> priority */ 2432 EXTERN long WkTimeFact; /* priority offset each time this job is run */ 2433 EXTERN char *ControlSocketName; /* control socket filename [control.c] */ 2434 EXTERN char *CurHostName; /* current host we are dealing with */ 2435 EXTERN char *DeadLetterDrop; /* path to dead letter office */ 2436 EXTERN char *DefUser; /* default user to run as (from DefUid) */ 2437 EXTERN char *DefaultCharSet; /* default character set for MIME */ 2438 EXTERN char *DoubleBounceAddr; /* where to send double bounces */ 2439 EXTERN char *ErrMsgFile; /* file to prepend to all error messages */ 2440 EXTERN char *FallbackMX; /* fall back MX host */ 2441 EXTERN char *FallbackSmartHost; /* fall back smart host */ 2442 EXTERN char *FileName; /* name to print on error messages */ 2443 EXTERN char *ForwardPath; /* path to search for .forward files */ 2444 EXTERN char *HeloName; /* hostname to announce in HELO */ 2445 EXTERN char *HelpFile; /* location of SMTP help file */ 2446 EXTERN char *HostStatDir; /* location of host status information */ 2447 EXTERN char *HostsFile; /* path to /etc/hosts file */ 2448 extern char *Mbdb; /* mailbox database type */ 2449 EXTERN char *MustQuoteChars; /* quote these characters in phrases */ 2450 EXTERN char *MyHostName; /* name of this host for SMTP messages */ 2451 EXTERN char *OperatorChars; /* operators (old $o macro) */ 2452 EXTERN char *PidFile; /* location of proc id file [conf.c] */ 2453 EXTERN char *PostMasterCopy; /* address to get errs cc's */ 2454 EXTERN char *ProcTitlePrefix; /* process title prefix */ 2455 EXTERN char *RealHostName; /* name of host we are talking to */ 2456 EXTERN char *RealUserName; /* real user name of caller */ 2457 EXTERN char *volatile RestartRequest;/* a sendmail restart has been requested */ 2458 EXTERN char *RunAsUserName; /* user to become for bulk of run */ 2459 EXTERN char *SafeFileEnv; /* chroot location for file delivery */ 2460 EXTERN char *ServiceSwitchFile; /* backup service switch */ 2461 EXTERN char *volatile ShutdownRequest;/* a sendmail shutdown has been requested */ 2462 EXTERN bool volatile IntSig; 2463 EXTERN char *SmtpGreeting; /* SMTP greeting message (old $e macro) */ 2464 EXTERN char *SmtpPhase; /* current phase in SMTP processing */ 2465 EXTERN char SmtpError[MAXLINE]; /* save failure error messages */ 2466 EXTERN char *StatFile; /* location of statistics summary */ 2467 EXTERN char *TimeZoneSpec; /* override time zone specification */ 2468 EXTERN char *UdbSpec; /* user database source spec */ 2469 EXTERN char *UnixFromLine; /* UNIX From_ line (old $l macro) */ 2470 EXTERN char **ExternalEnviron; /* saved user (input) environment */ 2471 EXTERN char **SaveArgv; /* argument vector for re-execing */ 2472 EXTERN BITMAP256 DontBlameSendmail; /* DontBlameSendmail bits */ 2473 EXTERN SM_FILE_T *InChannel; /* input connection */ 2474 EXTERN SM_FILE_T *OutChannel; /* output connection */ 2475 EXTERN SM_FILE_T *TrafficLogFile; /* file in which to log all traffic */ 2476 #if HESIOD 2477 EXTERN void *HesiodContext; 2478 #endif /* HESIOD */ 2479 EXTERN ENVELOPE *CurEnv; /* envelope currently being processed */ 2480 EXTERN char *RuleSetNames[MAXRWSETS]; /* ruleset number to name */ 2481 EXTERN char *UserEnviron[MAXUSERENVIRON + 1]; 2482 EXTERN struct rewrite *RewriteRules[MAXRWSETS]; 2483 EXTERN struct termescape TermEscape; /* terminal escape codes */ 2484 EXTERN SOCKADDR ConnectOnlyTo; /* override connection address (for testing) */ 2485 EXTERN SOCKADDR RealHostAddr; /* address of host we are talking to */ 2486 extern const SM_EXC_TYPE_T EtypeQuickAbort; /* type of a QuickAbort exception */ 2487 2488 2489 EXTERN int ConnectionRateWindowSize; 2490 #if STARTTLS && USE_OPENSSL_ENGINE 2491 EXTERN bool SSLEngineInitialized; 2492 #endif /* STARTTLS && USE_OPENSSL_ENGINE */ 2493 2494 /* 2495 ** Declarations of useful functions 2496 */ 2497 2498 /* Transcript file */ 2499 extern void closexscript __P((ENVELOPE *)); 2500 extern void openxscript __P((ENVELOPE *)); 2501 2502 /* error related */ 2503 extern void buffer_errors __P((void)); 2504 extern void flush_errors __P((bool)); 2505 extern void PRINTFLIKE(1, 2) message __P((const char *, ...)); 2506 extern void PRINTFLIKE(1, 2) nmessage __P((const char *, ...)); 2507 extern void PRINTFLIKE(1, 2) syserr __P((const char *, ...)); 2508 extern void PRINTFLIKE(2, 3) usrerrenh __P((char *, const char *, ...)); 2509 extern void PRINTFLIKE(1, 2) usrerr __P((const char *, ...)); 2510 extern int isenhsc __P((const char *, int)); 2511 extern int extenhsc __P((const char *, int, char *)); 2512 2513 /* alias file */ 2514 extern void alias __P((ADDRESS *, ADDRESS **, int, ENVELOPE *)); 2515 extern bool aliaswait __P((MAP *, char *, bool)); 2516 extern void forward __P((ADDRESS *, ADDRESS **, int, ENVELOPE *)); 2517 extern void readaliases __P((MAP *, SM_FILE_T *, bool, bool)); 2518 extern bool rebuildaliases __P((MAP *, bool)); 2519 extern void setalias __P((char *)); 2520 2521 /* logging */ 2522 extern void logdelivery __P((MAILER *, MCI *, char *, const char *, ADDRESS *, time_t, ENVELOPE *)); 2523 extern void logsender __P((ENVELOPE *, char *)); 2524 extern void PRINTFLIKE(3, 4) sm_syslog __P((int, const char *, const char *, ...)); 2525 2526 /* SMTP */ 2527 extern void giveresponse __P((int, char *, MAILER *, MCI *, ADDRESS *, time_t, ENVELOPE *, ADDRESS *)); 2528 extern int reply __P((MAILER *, MCI *, ENVELOPE *, time_t, void (*)__P((char *, bool, MAILER *, MCI *, ENVELOPE *)), char **, int)); 2529 extern void smtp __P((char *volatile, BITMAP256, ENVELOPE *volatile)); 2530 #if SASL 2531 extern int smtpauth __P((MAILER *, MCI *, ENVELOPE *)); 2532 #endif /* SASL */ 2533 extern int smtpdata __P((MAILER *, MCI *, ENVELOPE *, ADDRESS *, time_t)); 2534 extern int smtpgetstat __P((MAILER *, MCI *, ENVELOPE *)); 2535 extern int smtpmailfrom __P((MAILER *, MCI *, ENVELOPE *)); 2536 extern void smtpmessage __P((char *, MAILER *, MCI *, ...)); 2537 extern void smtpinit __P((MAILER *, MCI *, ENVELOPE *, bool)); 2538 extern char *smtptodsn __P((int)); 2539 extern int smtpprobe __P((MCI *)); 2540 extern void smtpquit __P((MAILER *, MCI *, ENVELOPE *)); 2541 extern int smtprcpt __P((ADDRESS *, MAILER *, MCI *, ENVELOPE *, ADDRESS *, time_t)); 2542 extern void smtprset __P((MAILER *, MCI *, ENVELOPE *)); 2543 2544 #define REPLYTYPE(r) ((r) / 100) /* first digit of reply code */ 2545 #define REPLYCLASS(r) (((r) / 10) % 10) /* second digit of reply code */ 2546 #define REPLYMINOR(r) ((r) % 10) /* last digit of reply code */ 2547 #define ISSMTPCODE(c) (isascii(c[0]) && isdigit(c[0]) && \ 2548 isascii(c[1]) && isdigit(c[1]) && \ 2549 isascii(c[2]) && isdigit(c[2])) 2550 #define ISSMTPREPLY(c) (ISSMTPCODE(c) && \ 2551 (c[3] == ' ' || c[3] == '-' || c[3] == '\0')) 2552 2553 /* delivery */ 2554 extern pid_t dowork __P((int, int, char *, bool, bool, ENVELOPE *)); 2555 extern pid_t doworklist __P((ENVELOPE *, bool, bool)); 2556 extern int endmailer __P((MCI *, ENVELOPE *, char **)); 2557 extern int mailfile __P((char *volatile, MAILER *volatile, ADDRESS *, volatile long, ENVELOPE *)); 2558 extern void sendall __P((ENVELOPE *, int)); 2559 2560 /* stats */ 2561 #define STATS_NORMAL 'n' 2562 #define STATS_QUARANTINE 'q' 2563 #define STATS_REJECT 'r' 2564 #define STATS_CONNECT 'c' 2565 2566 extern void markstats __P((ENVELOPE *, ADDRESS *, int)); 2567 extern void clearstats __P((void)); 2568 extern void poststats __P((char *)); 2569 2570 /* control socket */ 2571 extern void closecontrolsocket __P((bool)); 2572 extern void clrcontrol __P((void)); 2573 extern void control_command __P((int, ENVELOPE *)); 2574 extern int opencontrolsocket __P((void)); 2575 2576 #if MILTER 2577 /* milter functions */ 2578 extern void milter_config __P((char *, struct milter **, int)); 2579 extern void milter_setup __P((char *)); 2580 extern void milter_set_option __P((char *, char *, bool)); 2581 extern bool milter_init __P((ENVELOPE *, char *, milters_T *)); 2582 extern void milter_quit __P((ENVELOPE *)); 2583 extern void milter_abort __P((ENVELOPE *)); 2584 extern char *milter_connect __P((char *, SOCKADDR, ENVELOPE *, char *)); 2585 extern char *milter_helo __P((char *, ENVELOPE *, char *)); 2586 extern char *milter_envfrom __P((char **, ENVELOPE *, char *)); 2587 extern char *milter_data_cmd __P((ENVELOPE *, char *)); 2588 extern char *milter_envrcpt __P((char **, ENVELOPE *, char *, bool)); 2589 extern char *milter_data __P((ENVELOPE *, char *)); 2590 extern char *milter_unknown __P((char *, ENVELOPE *, char *)); 2591 #endif /* MILTER */ 2592 2593 extern char *addquotes __P((char *, SM_RPOOL_T *)); 2594 extern char *arpadate __P((char *)); 2595 extern bool atobool __P((char *)); 2596 extern int atooct __P((char *)); 2597 extern void auth_warning __P((ENVELOPE *, const char *, ...)); 2598 extern int blocksignal __P((int)); 2599 extern bool bitintersect __P((BITMAP256, BITMAP256)); 2600 extern bool bitzerop __P((BITMAP256)); 2601 extern int check_bodytype __P((char *)); 2602 extern void buildfname __P((char *, char *, char *, int)); 2603 extern bool chkclientmodifiers __P((int)); 2604 extern bool chkdaemonmodifiers __P((int)); 2605 extern int checkcompat __P((ADDRESS *, ENVELOPE *)); 2606 #ifdef XDEBUG 2607 extern void checkfd012 __P((char *)); 2608 extern void checkfdopen __P((int, char *)); 2609 #endif /* XDEBUG */ 2610 extern void checkfds __P((char *)); 2611 extern bool chownsafe __P((int, bool)); 2612 extern void cleanstrcpy __P((char *, char *, int)); 2613 #if SM_CONF_SHM 2614 extern void cleanup_shm __P((bool)); 2615 #endif /* SM_CONF_SHM */ 2616 extern void close_sendmail_pid __P((void)); 2617 extern void clrdaemon __P((void)); 2618 extern void collect __P((SM_FILE_T *, bool, HDR **, ENVELOPE *, bool)); 2619 extern bool connection_rate_check __P((SOCKADDR *, ENVELOPE *)); 2620 extern time_t convtime __P((char *, int)); 2621 extern char **copyplist __P((char **, bool, SM_RPOOL_T *)); 2622 extern void copy_class __P((int, int)); 2623 extern int count_open_connections __P((SOCKADDR *)); 2624 extern time_t curtime __P((void)); 2625 extern char *defcharset __P((ENVELOPE *)); 2626 extern char *denlstring __P((char *, bool, bool)); 2627 extern void dferror __P((SM_FILE_T *volatile, char *, ENVELOPE *)); 2628 extern void disconnect __P((int, ENVELOPE *)); 2629 extern void disk_status __P((SM_FILE_T *, char *)); 2630 extern bool dns_getcanonname __P((char *, int, bool, int *, int *)); 2631 extern pid_t dofork __P((void)); 2632 extern int drop_privileges __P((bool)); 2633 extern int dsntoexitstat __P((char *)); 2634 extern void dumpfd __P((int, bool, bool)); 2635 #if SM_HEAP_CHECK 2636 extern void dumpstab __P((void)); 2637 #endif /* SM_HEAP_CHECK */ 2638 extern void dumpstate __P((char *)); 2639 extern bool enoughdiskspace __P((long, ENVELOPE *)); 2640 extern char *exitstat __P((char *)); 2641 extern void fatal_error __P((SM_EXC_T *)); 2642 extern char *fgetfolded __P((char *, int *, SM_FILE_T *)); 2643 extern void fill_fd __P((int, char *)); 2644 extern char *find_character __P((char *, int)); 2645 extern int finduser __P((char *, bool *, SM_MBDB_T *)); 2646 extern void finis __P((bool, bool, volatile int)); 2647 extern void fixcrlf __P((char *, bool)); 2648 extern long freediskspace __P((const char *, long *)); 2649 #if NETINET6 && NEEDSGETIPNODE 2650 extern void freehostent __P((struct hostent *)); 2651 #endif /* NETINET6 && NEEDSGETIPNODE */ 2652 extern char *get_column __P((char *, int, int, char *, int)); 2653 extern char *getauthinfo __P((int, bool *)); 2654 extern int getdtsize __P((void)); 2655 extern int getla __P((void)); 2656 extern char *getmodifiers __P((char *, BITMAP256)); 2657 extern BITMAP256 *getrequests __P((ENVELOPE *)); 2658 extern char *getvendor __P((int)); 2659 extern void help __P((char *, ENVELOPE *)); 2660 extern void init_md __P((int, char **)); 2661 extern void initdaemon __P((void)); 2662 extern void inithostmaps __P((void)); 2663 extern void initmacros __P((ENVELOPE *)); 2664 extern void initsetproctitle __P((int, char **, char **)); 2665 extern void init_vendor_macros __P((ENVELOPE *)); 2666 extern SIGFUNC_DECL intsig __P((int)); 2667 extern bool isatom __P((const char *)); 2668 extern bool isloopback __P((SOCKADDR sa)); 2669 extern void load_if_names __P((void)); 2670 extern bool lockfile __P((int, char *, char *, int)); 2671 extern void log_sendmail_pid __P((ENVELOPE *)); 2672 extern void logundelrcpts __P((ENVELOPE *, char *, int, bool)); 2673 extern char lower __P((int)); 2674 extern void makelower __P((char *)); 2675 extern int makeconnection_ds __P((char *, MCI *)); 2676 extern int makeconnection __P((char *, volatile unsigned int, MCI *, ENVELOPE *, time_t)); 2677 extern void makeworkgroups __P((void)); 2678 extern void markfailure __P((ENVELOPE *, ADDRESS *, MCI *, int, bool)); 2679 extern void mark_work_group_restart __P((int, int)); 2680 extern MCI *mci_new __P((SM_RPOOL_T *)); 2681 extern char *munchstring __P((char *, char **, int)); 2682 extern struct hostent *myhostname __P((char *, int)); 2683 extern char *newstr __P((const char *)); 2684 #if NISPLUS 2685 extern char *nisplus_default_domain __P((void)); /* extern for Sun */ 2686 #endif /* NISPLUS */ 2687 extern bool path_is_dir __P((char *, bool)); 2688 extern int pickqdir __P((QUEUEGRP *qg, long fsize, ENVELOPE *e)); 2689 extern char *pintvl __P((time_t, bool)); 2690 extern void printav __P((SM_FILE_T *, char **)); 2691 extern void printmailer __P((SM_FILE_T *, MAILER *)); 2692 extern void printnqe __P((SM_FILE_T *, char *)); 2693 extern void printopenfds __P((bool)); 2694 extern void printqueue __P((void)); 2695 extern void printrules __P((void)); 2696 extern pid_t prog_open __P((char **, int *, ENVELOPE *)); 2697 extern bool putline __P((char *, MCI *)); 2698 extern bool putxline __P((char *, size_t, MCI *, int)); 2699 extern void queueup_macros __P((int, SM_FILE_T *, ENVELOPE *)); 2700 extern void readcf __P((char *, bool, ENVELOPE *)); 2701 extern SIGFUNC_DECL reapchild __P((int)); 2702 extern int releasesignal __P((int)); 2703 extern void resetlimits __P((void)); 2704 extern void restart_daemon __P((void)); 2705 extern void restart_marked_work_groups __P((void)); 2706 extern bool rfc822_string __P((char *)); 2707 extern void rmexpstab __P((void)); 2708 extern bool savemail __P((ENVELOPE *, bool)); 2709 extern void seed_random __P((void)); 2710 extern void sendtoargv __P((char **, ENVELOPE *)); 2711 extern void setclientoptions __P((char *)); 2712 extern bool setdaemonoptions __P((char *)); 2713 extern void setdefaults __P((ENVELOPE *)); 2714 extern void setdefuser __P((void)); 2715 extern bool setvendor __P((char *)); 2716 extern void set_op_mode __P((int)); 2717 extern void setoption __P((int, char *, bool, bool, ENVELOPE *)); 2718 extern sigfunc_t setsignal __P((int, sigfunc_t)); 2719 extern void sm_setuserenv __P((const char *, const char *)); 2720 extern void settime __P((ENVELOPE *)); 2721 #if STARTTLS 2722 extern void set_tls_rd_tmo __P((int)); 2723 #else /* STARTTLS */ 2724 #define set_tls_rd_tmo(rd_tmo) 2725 #endif /* STARTTLS */ 2726 extern char *sfgets __P((char *, int, SM_FILE_T *, time_t, char *)); 2727 extern char *shortenstring __P((const char *, size_t)); 2728 extern char *shorten_hostname __P((char [])); 2729 extern bool shorten_rfc822_string __P((char *, size_t)); 2730 extern void shutdown_daemon __P((void)); 2731 extern void sm_closefrom __P((int lowest, int highest)); 2732 extern void sm_close_on_exec __P((int lowest, int highest)); 2733 extern struct hostent *sm_gethostbyname __P((char *, int)); 2734 extern struct hostent *sm_gethostbyaddr __P((char *, int, int)); 2735 extern void sm_getla __P((void)); 2736 extern struct passwd *sm_getpwnam __P((char *)); 2737 extern struct passwd *sm_getpwuid __P((UID_T)); 2738 extern void sm_setproctitle __P((bool, ENVELOPE *, const char *, ...)); 2739 extern pid_t sm_wait __P((int *)); 2740 extern bool split_by_recipient __P((ENVELOPE *e)); 2741 extern void stop_sendmail __P((void)); 2742 extern void stripbackslash __P((char *)); 2743 extern bool strreplnonprt __P((char *, int)); 2744 extern bool strcontainedin __P((bool, char *, char *)); 2745 extern int switch_map_find __P((char *, char *[], short [])); 2746 #if STARTTLS 2747 extern void tls_set_verify __P((SSL_CTX *, SSL *, bool)); 2748 #endif /* STARTTLS */ 2749 extern bool transienterror __P((int)); 2750 extern void truncate_at_delim __P((char *, size_t, int)); 2751 extern void tTflag __P((char *)); 2752 extern void tTsetup __P((unsigned char *, unsigned int, char *)); 2753 extern SIGFUNC_DECL tick __P((int)); 2754 extern char *ttypath __P((void)); 2755 extern void unlockqueue __P((ENVELOPE *)); 2756 #if !HASUNSETENV 2757 extern void unsetenv __P((char *)); 2758 #endif /* !HASUNSETENV */ 2759 2760 /* update file system information: +/- some blocks */ 2761 #if SM_CONF_SHM 2762 extern void upd_qs __P((ENVELOPE *, int, int, char *)); 2763 # define updfs(e, count, space, where) upd_qs(e, count, space, where) 2764 #else /* SM_CONF_SHM */ 2765 # define updfs(e, count, space, where) 2766 # define upd_qs(e, count, space, where) 2767 #endif /* SM_CONF_SHM */ 2768 2769 extern char *username __P((void)); 2770 extern bool usershellok __P((char *, char *)); 2771 extern void vendor_post_defaults __P((ENVELOPE *)); 2772 extern void vendor_pre_defaults __P((ENVELOPE *)); 2773 extern int waitfor __P((pid_t)); 2774 extern bool writable __P((char *, ADDRESS *, long)); 2775 #if SM_HEAP_CHECK 2776 # define xalloc(size) xalloc_tagged(size, __FILE__, __LINE__) 2777 extern char *xalloc_tagged __P((int, char*, int)); 2778 #else /* SM_HEAP_CHECK */ 2779 extern char *xalloc __P((int)); 2780 #endif /* SM_HEAP_CHECK */ 2781 extern void xputs __P((SM_FILE_T *, const char *)); 2782 extern char *xtextify __P((char *, char *)); 2783 extern bool xtextok __P((char *)); 2784 extern int xunlink __P((char *)); 2785 extern char *xuntextify __P((char *)); 2786 2787 2788 #undef EXTERN 2789 #endif /* ! _SENDMAIL_H */ 2790