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