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