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