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