1 /*
2  * Copyright (c) 1983 Eric P. Allman
3  * Copyright (c) 1988, 1993
4  *	The Regents of the University of California.  All rights reserved.
5  *
6  * %sccs.include.redist.c%
7  *
8  *	@(#)sendmail.h	8.34 (Berkeley) 12/11/93
9  */
10 
11 /*
12 **  SENDMAIL.H -- Global definitions for sendmail.
13 */
14 
15 # ifdef _DEFINE
16 # define EXTERN
17 # ifndef lint
18 static char SmailSccsId[] =	"@(#)sendmail.h	8.34		12/11/93";
19 # endif
20 # else /*  _DEFINE */
21 # define EXTERN extern
22 # endif /* _DEFINE */
23 
24 # include <unistd.h>
25 # include <stddef.h>
26 # include <stdlib.h>
27 # include <stdio.h>
28 # include <ctype.h>
29 # include <setjmp.h>
30 # include <sysexits.h>
31 # include <string.h>
32 # include <time.h>
33 # include <errno.h>
34 
35 # include "conf.h"
36 # include "useful.h"
37 
38 # ifdef LOG
39 # include <syslog.h>
40 # endif /* LOG */
41 
42 # ifdef DAEMON
43 # include <sys/socket.h>
44 # endif
45 # ifdef NETUNIX
46 # include <sys/un.h>
47 # endif
48 # ifdef NETINET
49 # include <netinet/in.h>
50 # endif
51 # ifdef NETISO
52 # include <netiso/iso.h>
53 # endif
54 # ifdef NETNS
55 # include <netns/ns.h>
56 # endif
57 # ifdef NETX25
58 # include <netccitt/x25.h>
59 # endif
60 
61 
62 
63 
64 /*
65 **  Data structure for bit maps.
66 **
67 **	Each bit in this map can be referenced by an ascii character.
68 **	This is 128 possible bits, or 12 8-bit bytes.
69 */
70 
71 #define BITMAPBYTES	16	/* number of bytes in a bit map */
72 #define BYTEBITS	8	/* number of bits in a byte */
73 
74 /* internal macros */
75 #define _BITWORD(bit)	(bit / (BYTEBITS * sizeof (int)))
76 #define _BITBIT(bit)	(1 << (bit % (BYTEBITS * sizeof (int))))
77 
78 typedef int	BITMAP[BITMAPBYTES / sizeof (int)];
79 
80 /* test bit number N */
81 #define bitnset(bit, map)	((map)[_BITWORD(bit)] & _BITBIT(bit))
82 
83 /* set bit number N */
84 #define setbitn(bit, map)	(map)[_BITWORD(bit)] |= _BITBIT(bit)
85 
86 /* clear bit number N */
87 #define clrbitn(bit, map)	(map)[_BITWORD(bit)] &= ~_BITBIT(bit)
88 
89 /* clear an entire bit map */
90 #define clrbitmap(map)		bzero((char *) map, BITMAPBYTES)
91 /*
92 **  Address structure.
93 **	Addresses are stored internally in this structure.
94 */
95 
96 struct address
97 {
98 	char		*q_paddr;	/* the printname for the address */
99 	char		*q_user;	/* user name */
100 	char		*q_ruser;	/* real user name, or NULL if q_user */
101 	char		*q_host;	/* host name */
102 	struct mailer	*q_mailer;	/* mailer to use */
103 	u_short		q_flags;	/* status flags, see below */
104 	uid_t		q_uid;		/* user-id of receiver (if known) */
105 	gid_t		q_gid;		/* group-id of receiver (if known) */
106 	char		*q_home;	/* home dir (local mailer only) */
107 	char		*q_fullname;	/* full name if known */
108 	struct address	*q_next;	/* chain */
109 	struct address	*q_alias;	/* address this results from */
110 	char		*q_owner;	/* owner of q_alias */
111 	struct address	*q_tchain;	/* temporary use chain */
112 	time_t		q_timeout;	/* timeout for this address */
113 };
114 
115 typedef struct address ADDRESS;
116 
117 # define QDONTSEND	000001	/* don't send to this address */
118 # define QBADADDR	000002	/* this address is verified bad */
119 # define QGOODUID	000004	/* the q_uid q_gid fields are good */
120 # define QPRIMARY	000010	/* set from argv */
121 # define QQUEUEUP	000020	/* queue for later transmission */
122 # define QSENT		000040	/* has been successfully delivered */
123 # define QNOTREMOTE	000100	/* not an address for remote forwarding */
124 # define QSELFREF	000200	/* this address references itself */
125 # define QVERIFIED	000400	/* verified, but not expanded */
126 # define QREPORT	001000	/* report this address in return message */
127 
128 # define NULLADDR	((ADDRESS *) NULL)
129 /*
130 **  Mailer definition structure.
131 **	Every mailer known to the system is declared in this
132 **	structure.  It defines the pathname of the mailer, some
133 **	flags associated with it, and the argument vector to
134 **	pass to it.  The flags are defined in conf.c
135 **
136 **	The argument vector is expanded before actual use.  All
137 **	words except the first are passed through the macro
138 **	processor.
139 */
140 
141 struct mailer
142 {
143 	char	*m_name;	/* symbolic name of this mailer */
144 	char	*m_mailer;	/* pathname of the mailer to use */
145 	BITMAP	m_flags;	/* status flags, see below */
146 	short	m_mno;		/* mailer number internally */
147 	char	**m_argv;	/* template argument vector */
148 	short	m_sh_rwset;	/* rewrite set: sender header addresses */
149 	short	m_se_rwset;	/* rewrite set: sender envelope addresses */
150 	short	m_rh_rwset;	/* rewrite set: recipient header addresses */
151 	short	m_re_rwset;	/* rewrite set: recipient envelope addresses */
152 	char	*m_eol;		/* end of line string */
153 	long	m_maxsize;	/* size limit on message to this mailer */
154 	int	m_linelimit;	/* max # characters per line */
155 	char	*m_execdir;	/* directory to chdir to before execv */
156 };
157 
158 typedef struct mailer	MAILER;
159 
160 /* bits for m_flags */
161 # define M_ESMTP	'a'	/* run Extended SMTP protocol */
162 # define M_BLANKEND	'b'	/* ensure blank line at end of message */
163 # define M_NOCOMMENT	'c'	/* don't include comment part of address */
164 # define M_CANONICAL	'C'	/* make addresses canonical "u@dom" */
165 		/*	'D'	/* CF: include Date: */
166 # define M_EXPENSIVE	'e'	/* it costs to use this mailer.... */
167 # define M_ESCFROM	'E'	/* escape From lines to >From */
168 # define M_FOPT		'f'	/* mailer takes picky -f flag */
169 		/*	'F'	/* CF: include From: or Resent-From: */
170 # define M_NO_NULL_FROM	'g'	/* sender of errors should be $g */
171 # define M_HST_UPPER	'h'	/* preserve host case distinction */
172 # define M_PREHEAD	'H'	/* MAIL11V3: preview headers */
173 # define M_INTERNAL	'I'	/* SMTP to another sendmail site */
174 # define M_LOCALMAILER	'l'	/* delivery is to this host */
175 # define M_LIMITS	'L'	/* must enforce SMTP line limits */
176 # define M_MUSER	'm'	/* can handle multiple users at once */
177 		/*	'M'	/* CF: include Message-Id: */
178 # define M_NHDR		'n'	/* don't insert From line */
179 # define M_MANYSTATUS	'N'	/* MAIL11V3: DATA returns multi-status */
180 # define M_FROMPATH	'p'	/* use reverse-path in MAIL FROM: */
181 		/*	'P'	/* CF: include Return-Path: */
182 # define M_ROPT		'r'	/* mailer takes picky -r flag */
183 # define M_SECURE_PORT	'R'	/* try to send on a reserved TCP port */
184 # define M_STRIPQ	's'	/* strip quote chars from user/host */
185 # define M_RESTR	'S'	/* must be daemon to execute */
186 # define M_USR_UPPER	'u'	/* preserve user case distinction */
187 # define M_UGLYUUCP	'U'	/* this wants an ugly UUCP from line */
188 		/*	'V'	/* UIUC: !-relativize all addresses */
189 		/*	'x'	/* CF: include Full-Name: */
190 # define M_XDOT		'X'	/* use hidden-dot algorithm */
191 # define M_7BITS	'7'	/* use 7-bit path */
192 
193 EXTERN MAILER	*Mailer[MAXMAILERS+1];
194 
195 EXTERN MAILER	*LocalMailer;		/* ptr to local mailer */
196 EXTERN MAILER	*ProgMailer;		/* ptr to program mailer */
197 EXTERN MAILER	*FileMailer;		/* ptr to *file* mailer */
198 EXTERN MAILER	*InclMailer;		/* ptr to *include* mailer */
199 /*
200 **  Header structure.
201 **	This structure is used internally to store header items.
202 */
203 
204 struct header
205 {
206 	char		*h_field;	/* the name of the field */
207 	char		*h_value;	/* the value of that field */
208 	struct header	*h_link;	/* the next header */
209 	u_short		h_flags;	/* status bits, see below */
210 	BITMAP		h_mflags;	/* m_flags bits needed */
211 };
212 
213 typedef struct header	HDR;
214 
215 /*
216 **  Header information structure.
217 **	Defined in conf.c, this struct declares the header fields
218 **	that have some magic meaning.
219 */
220 
221 struct hdrinfo
222 {
223 	char	*hi_field;	/* the name of the field */
224 	u_short	hi_flags;	/* status bits, see below */
225 };
226 
227 extern struct hdrinfo	HdrInfo[];
228 
229 /* bits for h_flags and hi_flags */
230 # define H_EOH		00001	/* this field terminates header */
231 # define H_RCPT		00002	/* contains recipient addresses */
232 # define H_DEFAULT	00004	/* if another value is found, drop this */
233 # define H_RESENT	00010	/* this address is a "Resent-..." address */
234 # define H_CHECK	00020	/* check h_mflags against m_flags */
235 # define H_ACHECK	00040	/* ditto, but always (not just default) */
236 # define H_FORCE	00100	/* force this field, even if default */
237 # define H_TRACE	00200	/* this field contains trace information */
238 # define H_FROM		00400	/* this is a from-type field */
239 # define H_VALID	01000	/* this field has a validated value */
240 # define H_RECEIPTTO	02000	/* this field has return receipt info */
241 # define H_ERRORSTO	04000	/* this field has error address info */
242 /*
243 **  Envelope structure.
244 **	This structure defines the message itself.  There is usually
245 **	only one of these -- for the message that we originally read
246 **	and which is our primary interest -- but other envelopes can
247 **	be generated during processing.  For example, error messages
248 **	will have their own envelope.
249 */
250 
251 # define ENVELOPE	struct envelope
252 
253 ENVELOPE
254 {
255 	HDR		*e_header;	/* head of header list */
256 	long		e_msgpriority;	/* adjusted priority of this message */
257 	time_t		e_ctime;	/* time message appeared in the queue */
258 	char		*e_to;		/* the target person */
259 	char		*e_receiptto;	/* return receipt address */
260 	ADDRESS		e_from;		/* the person it is from */
261 	char		*e_sender;	/* e_from.q_paddr w comments stripped */
262 	char		**e_fromdomain;	/* the domain part of the sender */
263 	ADDRESS		*e_sendqueue;	/* list of message recipients */
264 	ADDRESS		*e_errorqueue;	/* the queue for error responses */
265 	long		e_msgsize;	/* size of the message in bytes */
266 	long		e_flags;	/* flags, see below */
267 	int		e_nrcpts;	/* number of recipients */
268 	short		e_class;	/* msg class (priority, junk, etc.) */
269 	short		e_hopcount;	/* number of times processed */
270 	short		e_nsent;	/* number of sends since checkpoint */
271 	short		e_sendmode;	/* message send mode */
272 	short		e_errormode;	/* error return mode */
273 	int		(*e_puthdr)__P((FILE *, MAILER *, ENVELOPE *));
274 					/* function to put header of message */
275 	int		(*e_putbody)__P((FILE *, MAILER *, ENVELOPE *, char *));
276 					/* function to put body of message */
277 	struct envelope	*e_parent;	/* the message this one encloses */
278 	struct envelope *e_sibling;	/* the next envelope of interest */
279 	char		*e_bodytype;	/* type of message body */
280 	char		*e_df;		/* location of temp file */
281 	FILE		*e_dfp;		/* temporary file */
282 	char		*e_id;		/* code for this entry in queue */
283 	FILE		*e_xfp;		/* transcript file */
284 	FILE		*e_lockfp;	/* the lock file for this message */
285 	char		*e_message;	/* error message */
286 	char		*e_statmsg;	/* stat msg (changes per delivery) */
287 	char		*e_msgboundary;	/* MIME-style message part boundary */
288 	char		*e_origrcpt;	/* original recipient (one only) */
289 	char		*e_macro[128];	/* macro definitions */
290 };
291 
292 /* values for e_flags */
293 #define EF_OLDSTYLE	0x0000001	/* use spaces (not commas) in hdrs */
294 #define EF_INQUEUE	0x0000002	/* this message is fully queued */
295 #define EF_CLRQUEUE	0x0000008	/* disk copy is no longer needed */
296 #define EF_SENDRECEIPT	0x0000010	/* send a return receipt */
297 #define EF_FATALERRS	0x0000020	/* fatal errors occured */
298 #define EF_KEEPQUEUE	0x0000040	/* keep queue files always */
299 #define EF_RESPONSE	0x0000080	/* this is an error or return receipt */
300 #define EF_RESENT	0x0000100	/* this message is being forwarded */
301 #define EF_VRFYONLY	0x0000200	/* verify only (don't expand aliases) */
302 #define EF_WARNING	0x0000400	/* warning message has been sent */
303 #define EF_QUEUERUN	0x0000800	/* this envelope is from queue */
304 #define EF_GLOBALERRS	0x0001000	/* treat errors as global */
305 #define EF_PM_NOTIFY	0x0002000	/* send return mail to postmaster */
306 #define EF_METOO	0x0004000	/* send to me too */
307 #define EF_LOGSENDER	0x0008000	/* need to log the sender */
308 
309 EXTERN ENVELOPE	*CurEnv;	/* envelope currently being processed */
310 /*
311 **  Message priority classes.
312 **
313 **	The message class is read directly from the Priority: header
314 **	field in the message.
315 **
316 **	CurEnv->e_msgpriority is the number of bytes in the message plus
317 **	the creation time (so that jobs ``tend'' to be ordered correctly),
318 **	adjusted by the message class, the number of recipients, and the
319 **	amount of time the message has been sitting around.  This number
320 **	is used to order the queue.  Higher values mean LOWER priority.
321 **
322 **	Each priority class point is worth WkClassFact priority points;
323 **	each recipient is worth WkRecipFact priority points.  Each time
324 **	we reprocess a message the priority is adjusted by WkTimeFact.
325 **	WkTimeFact should normally decrease the priority so that jobs
326 **	that have historically failed will be run later; thanks go to
327 **	Jay Lepreau at Utah for pointing out the error in my thinking.
328 **
329 **	The "class" is this number, unadjusted by the age or size of
330 **	this message.  Classes with negative representations will have
331 **	error messages thrown away if they are not local.
332 */
333 
334 struct priority
335 {
336 	char	*pri_name;	/* external name of priority */
337 	int	pri_val;	/* internal value for same */
338 };
339 
340 EXTERN struct priority	Priorities[MAXPRIORITIES];
341 EXTERN int		NumPriorities;	/* pointer into Priorities */
342 /*
343 **  Rewrite rules.
344 */
345 
346 struct rewrite
347 {
348 	char	**r_lhs;	/* pattern match */
349 	char	**r_rhs;	/* substitution value */
350 	struct rewrite	*r_next;/* next in chain */
351 };
352 
353 EXTERN struct rewrite	*RewriteRules[MAXRWSETS];
354 
355 /*
356 **  Special characters in rewriting rules.
357 **	These are used internally only.
358 **	The COND* rules are actually used in macros rather than in
359 **		rewriting rules, but are given here because they
360 **		cannot conflict.
361 */
362 
363 /* left hand side items */
364 # define MATCHZANY	0220	/* match zero or more tokens */
365 # define MATCHANY	0221	/* match one or more tokens */
366 # define MATCHONE	0222	/* match exactly one token */
367 # define MATCHCLASS	0223	/* match one token in a class */
368 # define MATCHNCLASS	0224	/* match anything not in class */
369 # define MATCHREPL	0225	/* replacement on RHS for above */
370 
371 /* right hand side items */
372 # define CANONNET	0226	/* canonical net, next token */
373 # define CANONHOST	0227	/* canonical host, next token */
374 # define CANONUSER	0230	/* canonical user, next N tokens */
375 # define CALLSUBR	0231	/* call another rewriting set */
376 
377 /* conditionals in macros */
378 # define CONDIF		0232	/* conditional if-then */
379 # define CONDELSE	0233	/* conditional else */
380 # define CONDFI		0234	/* conditional fi */
381 
382 /* bracket characters for host name lookup */
383 # define HOSTBEGIN	0235	/* hostname lookup begin */
384 # define HOSTEND	0236	/* hostname lookup end */
385 
386 /* bracket characters for generalized lookup */
387 # define LOOKUPBEGIN	0205	/* generalized lookup begin */
388 # define LOOKUPEND	0206	/* generalized lookup end */
389 
390 /* macro substitution character */
391 # define MACROEXPAND	0201	/* macro expansion */
392 # define MACRODEXPAND	0202	/* deferred macro expansion */
393 
394 /* to make the code clearer */
395 # define MATCHZERO	CANONHOST
396 
397 /* external <==> internal mapping table */
398 struct metamac
399 {
400 	char	metaname;	/* external code (after $) */
401 	u_char	metaval;	/* internal code (as above) */
402 };
403 /*
404 **  Information about currently open connections to mailers, or to
405 **  hosts that we have looked up recently.
406 */
407 
408 # define MCI	struct mailer_con_info
409 
410 MCI
411 {
412 	short		mci_flags;	/* flag bits, see below */
413 	short		mci_errno;	/* error number on last connection */
414 	short		mci_herrno;	/* h_errno from last DNS lookup */
415 	short		mci_exitstat;	/* exit status from last connection */
416 	short		mci_state;	/* SMTP state */
417 	long		mci_maxsize;	/* max size this server will accept */
418 	FILE		*mci_in;	/* input side of connection */
419 	FILE		*mci_out;	/* output side of connection */
420 	int		mci_pid;	/* process id of subordinate proc */
421 	char		*mci_phase;	/* SMTP phase string */
422 	struct mailer	*mci_mailer;	/* ptr to the mailer for this conn */
423 	char		*mci_host;	/* host name */
424 	time_t		mci_lastuse;	/* last usage time */
425 };
426 
427 
428 /* flag bits */
429 #define MCIF_VALID	000001		/* this entry is valid */
430 #define MCIF_TEMP	000002		/* don't cache this connection */
431 #define MCIF_CACHED	000004		/* currently in open cache */
432 #define MCIF_ESMTP	000010		/* this host speaks ESMTP */
433 #define MCIF_EXPN	000020		/* EXPN command supported */
434 #define MCIF_SIZE	000040		/* SIZE option supported */
435 #define MCIF_8BITMIME	000100		/* BODY=8BITMIME supported */
436 #define MCIF_MULTSTAT	000200		/* MAIL11V3: handles MULT status */
437 
438 /* states */
439 #define MCIS_CLOSED	0		/* no traffic on this connection */
440 #define MCIS_OPENING	1		/* sending initial protocol */
441 #define MCIS_OPEN	2		/* open, initial protocol sent */
442 #define MCIS_ACTIVE	3		/* message being sent */
443 #define MCIS_QUITING	4		/* running quit protocol */
444 #define MCIS_SSD	5		/* service shutting down */
445 #define MCIS_ERROR	6		/* I/O error on connection */
446 /*
447 **  Name canonification short circuit.
448 **
449 **	If the name server for a host is down, the process of trying to
450 **	canonify the name can hang.  This is similar to (but alas, not
451 **	identical to) looking up the name for delivery.  This stab type
452 **	caches the result of the name server lookup so we don't hang
453 **	multiple times.
454 */
455 
456 #define NAMECANON	struct _namecanon
457 
458 NAMECANON
459 {
460 	short		nc_errno;	/* cached errno */
461 	short		nc_herrno;	/* cached h_errno */
462 	short		nc_stat;	/* cached exit status code */
463 	short		nc_flags;	/* flag bits */
464 	char		*nc_cname;	/* the canonical name */
465 };
466 
467 /* values for nc_flags */
468 #define NCF_VALID	0x0001	/* entry valid */
469 /*
470 **  Mapping functions
471 **
472 **	These allow arbitrary mappings in the config file.  The idea
473 **	(albeit not the implementation) comes from IDA sendmail.
474 */
475 
476 # define MAPCLASS	struct _mapclass
477 # define MAP		struct _map
478 
479 
480 /*
481 **  An actual map.
482 */
483 
484 MAP
485 {
486 	MAPCLASS	*map_class;	/* the class of this map */
487 	char		*map_mname;	/* name of this map */
488 	int		map_mflags;	/* flags, see below */
489 	char		*map_file;	/* the (nominal) filename */
490 	ARBPTR_T	map_db1;	/* the open database ptr */
491 	ARBPTR_T	map_db2;	/* an "extra" database pointer */
492 	char		*map_app;	/* to append to successful matches */
493 	char		*map_domain;	/* the (nominal) NIS domain */
494 	char		*map_rebuild;	/* program to run to do auto-rebuild */
495 	time_t		map_mtime;	/* last database modification time */
496 };
497 
498 /* bit values for map_flags */
499 # define MF_VALID	0x0001		/* this entry is valid */
500 # define MF_INCLNULL	0x0002		/* include null byte in key */
501 # define MF_OPTIONAL	0x0004		/* don't complain if map not found */
502 # define MF_NOFOLDCASE	0x0008		/* don't fold case in keys */
503 # define MF_MATCHONLY	0x0010		/* don't use the map value */
504 # define MF_OPEN	0x0020		/* this entry is open */
505 # define MF_WRITABLE	0x0040		/* open for writing */
506 # define MF_ALIAS	0x0080		/* this is an alias file */
507 # define MF_TRY0NULL	0x0100		/* try with no null byte */
508 # define MF_TRY1NULL	0x0200		/* try with the null byte */
509 # define MF_LOCKED	0x0400		/* this map is currently locked */
510 # define MF_ALIASWAIT	0x0800		/* alias map in aliaswait state */
511 # define MF_IMPL_HASH	0x1000		/* implicit: underlying hash database */
512 # define MF_IMPL_NDBM	0x2000		/* implicit: underlying NDBM database */
513 
514 
515 /*
516 **  The class of a map -- essentially the functions to call
517 */
518 
519 MAPCLASS
520 {
521 	char	*map_cname;		/* name of this map class */
522 	char	*map_ext;		/* extension for database file */
523 	short	map_cflags;		/* flag bits, see below */
524 	bool	(*map_parse)__P((MAP *, char *));
525 					/* argument parsing function */
526 	char	*(*map_lookup)__P((MAP *, char *, char **, int *));
527 					/* lookup function */
528 	void	(*map_store)__P((MAP *, char *, char *));
529 					/* store function */
530 	bool	(*map_open)__P((MAP *, int));
531 					/* open function */
532 	void	(*map_close)__P((MAP *));
533 					/* close function */
534 };
535 
536 /* bit values for map_cflags */
537 #define MCF_ALIASOK	0x0001		/* can be used for aliases */
538 #define MCF_ALIASONLY	0x0002		/* usable only for aliases */
539 #define MCF_REBUILDABLE	0x0004		/* can rebuild alias files */
540 /*
541 **  Symbol table definitions
542 */
543 
544 struct symtab
545 {
546 	char		*s_name;	/* name to be entered */
547 	char		s_type;		/* general type (see below) */
548 	struct symtab	*s_next;	/* pointer to next in chain */
549 	union
550 	{
551 		BITMAP		sv_class;	/* bit-map of word classes */
552 		ADDRESS		*sv_addr;	/* pointer to address header */
553 		MAILER		*sv_mailer;	/* pointer to mailer */
554 		char		*sv_alias;	/* alias */
555 		MAPCLASS	sv_mapclass;	/* mapping function class */
556 		MAP		sv_map;		/* mapping function */
557 		char		*sv_hostsig;	/* host signature */
558 		MCI		sv_mci;		/* mailer connection info */
559 		NAMECANON	sv_namecanon;	/* canonical name cache */
560 	}	s_value;
561 };
562 
563 typedef struct symtab	STAB;
564 
565 /* symbol types */
566 # define ST_UNDEF	0	/* undefined type */
567 # define ST_CLASS	1	/* class map */
568 # define ST_ADDRESS	2	/* an address in parsed format */
569 # define ST_MAILER	3	/* a mailer header */
570 # define ST_ALIAS	4	/* an alias */
571 # define ST_MAPCLASS	5	/* mapping function class */
572 # define ST_MAP		6	/* mapping function */
573 # define ST_HOSTSIG	7	/* host signature */
574 # define ST_NAMECANON	8	/* cached canonical name */
575 # define ST_MCI		16	/* mailer connection info (offset) */
576 
577 # define s_class	s_value.sv_class
578 # define s_address	s_value.sv_addr
579 # define s_mailer	s_value.sv_mailer
580 # define s_alias	s_value.sv_alias
581 # define s_mci		s_value.sv_mci
582 # define s_mapclass	s_value.sv_mapclass
583 # define s_hostsig	s_value.sv_hostsig
584 # define s_map		s_value.sv_map
585 # define s_namecanon	s_value.sv_namecanon
586 
587 extern STAB		*stab __P((char *, int, int));
588 extern void		stabapply __P((void (*)(STAB *, int), int));
589 
590 /* opcodes to stab */
591 # define ST_FIND	0	/* find entry */
592 # define ST_ENTER	1	/* enter if not there */
593 /*
594 **  STRUCT EVENT -- event queue.
595 **
596 **	Maintained in sorted order.
597 **
598 **	We store the pid of the process that set this event to insure
599 **	that when we fork we will not take events intended for the parent.
600 */
601 
602 struct event
603 {
604 	time_t		ev_time;	/* time of the function call */
605 	int		(*ev_func)__P((int));
606 					/* function to call */
607 	int		ev_arg;		/* argument to ev_func */
608 	int		ev_pid;		/* pid that set this event */
609 	struct event	*ev_link;	/* link to next item */
610 };
611 
612 typedef struct event	EVENT;
613 
614 EXTERN EVENT	*EventQueue;		/* head of event queue */
615 /*
616 **  Operation, send, and error modes
617 **
618 **	The operation mode describes the basic operation of sendmail.
619 **	This can be set from the command line, and is "send mail" by
620 **	default.
621 **
622 **	The send mode tells how to send mail.  It can be set in the
623 **	configuration file.  It's setting determines how quickly the
624 **	mail will be delivered versus the load on your system.  If the
625 **	-v (verbose) flag is given, it will be forced to SM_DELIVER
626 **	mode.
627 **
628 **	The error mode tells how to return errors.
629 */
630 
631 EXTERN char	OpMode;		/* operation mode, see below */
632 
633 #define MD_DELIVER	'm'		/* be a mail sender */
634 #define MD_SMTP		's'		/* run SMTP on standard input */
635 #define MD_DAEMON	'd'		/* run as a daemon */
636 #define MD_VERIFY	'v'		/* verify: don't collect or deliver */
637 #define MD_TEST		't'		/* test mode: resolve addrs only */
638 #define MD_INITALIAS	'i'		/* initialize alias database */
639 #define MD_PRINT	'p'		/* print the queue */
640 #define MD_FREEZE	'z'		/* freeze the configuration file */
641 
642 
643 /* values for e_sendmode -- send modes */
644 #define SM_DELIVER	'i'		/* interactive delivery */
645 #define SM_QUICKD	'j'		/* deliver w/o queueing */
646 #define SM_FORK		'b'		/* deliver in background */
647 #define SM_QUEUE	'q'		/* queue, don't deliver */
648 #define SM_VERIFY	'v'		/* verify only (used internally) */
649 
650 /* used only as a parameter to sendall */
651 #define SM_DEFAULT	'\0'		/* unspecified, use SendMode */
652 
653 
654 /* values for e_errormode -- error handling modes */
655 #define EM_PRINT	'p'		/* print errors */
656 #define EM_MAIL		'm'		/* mail back errors */
657 #define EM_WRITE	'w'		/* write back errors */
658 #define EM_BERKNET	'e'		/* special berknet processing */
659 #define EM_QUIET	'q'		/* don't print messages (stat only) */
660 /*
661 **  Additional definitions
662 */
663 
664 
665 /*
666 **  Privacy flags
667 **	These are bit values for the PrivacyFlags word.
668 */
669 
670 #define PRIV_PUBLIC		0	/* what have I got to hide? */
671 #define PRIV_NEEDMAILHELO	00001	/* insist on HELO for MAIL, at least */
672 #define PRIV_NEEDEXPNHELO	00002	/* insist on HELO for EXPN */
673 #define PRIV_NEEDVRFYHELO	00004	/* insist on HELO for VRFY */
674 #define PRIV_NOEXPN		00010	/* disallow EXPN command entirely */
675 #define PRIV_NOVRFY		00020	/* disallow VRFY command entirely */
676 #define PRIV_AUTHWARNINGS	00040	/* flag possible authorization probs */
677 #define PRIV_RESTRICTMAILQ	01000	/* restrict mailq command */
678 #define PRIV_RESTRICTQRUN	02000	/* restrict queue run */
679 #define PRIV_GOAWAY		00777	/* don't give no info, anyway, anyhow */
680 
681 /* struct defining such things */
682 struct prival
683 {
684 	char	*pv_name;	/* name of privacy flag */
685 	int	pv_flag;	/* numeric level */
686 };
687 
688 
689 /*
690 **  Flags passed to remotename, parseaddr, allocaddr, and buildaddr.
691 */
692 
693 #define RF_SENDERADDR		0001	/* this is a sender address */
694 #define RF_HEADERADDR		0002	/* this is a header address */
695 #define RF_CANONICAL		0004	/* strip comment information */
696 #define RF_ADDDOMAIN		0010	/* OK to do domain extension */
697 #define RF_COPYPARSE		0020	/* copy parsed user & host */
698 #define RF_COPYPADDR		0040	/* copy print address */
699 #define RF_COPYALL		(RF_COPYPARSE|RF_COPYPADDR)
700 #define RF_COPYNONE		0
701 
702 
703 /*
704 **  Flags passed to safefile.
705 */
706 
707 #define SFF_ANYFILE		0	/* no special restrictions */
708 #define SFF_MUSTOWN		0x0001	/* user must own this file */
709 #define SFF_NOSLINK		0x0002	/* file cannot be a symbolic link */
710 
711 
712 /*
713 **  Regular UNIX sockaddrs are too small to handle ISO addresses, so
714 **  we are forced to declare a supertype here.
715 */
716 
717 union bigsockaddr
718 {
719 	struct sockaddr		sa;	/* general version */
720 #ifdef NETUNIX
721 	struct sockaddr_un	sunix;	/* UNIX family */
722 #endif
723 #ifdef NETINET
724 	struct sockaddr_in	sin;	/* INET family */
725 #endif
726 #ifdef NETISO
727 	struct sockaddr_iso	siso;	/* ISO family */
728 #endif
729 #ifdef NETNS
730 	struct sockaddr_ns	sns;	/* XNS family */
731 #endif
732 #ifdef NETX25
733 	struct sockaddr_x25	sx25;	/* X.25 family */
734 #endif
735 };
736 
737 #define SOCKADDR	union bigsockaddr
738 /*
739 **  Global variables.
740 */
741 
742 EXTERN bool	FromFlag;	/* if set, "From" person is explicit */
743 EXTERN bool	MeToo;		/* send to the sender also */
744 EXTERN bool	IgnrDot;	/* don't let dot end messages */
745 EXTERN bool	SaveFrom;	/* save leading "From" lines */
746 EXTERN bool	Verbose;	/* set if blow-by-blow desired */
747 EXTERN bool	GrabTo;		/* if set, get recipients from msg */
748 EXTERN bool	NoReturn;	/* don't return letter to sender */
749 EXTERN bool	SuprErrs;	/* set if we are suppressing errors */
750 EXTERN bool	HoldErrs;	/* only output errors to transcript */
751 EXTERN bool	NoConnect;	/* don't connect to non-local mailers */
752 EXTERN bool	SuperSafe;	/* be extra careful, even if expensive */
753 EXTERN bool	ForkQueueRuns;	/* fork for each job when running the queue */
754 EXTERN bool	AutoRebuild;	/* auto-rebuild the alias database as needed */
755 EXTERN bool	CheckAliases;	/* parse addresses during newaliases */
756 EXTERN bool	NoAlias;	/* suppress aliasing */
757 EXTERN bool	UseNameServer;	/* use internet domain name server */
758 EXTERN bool	SevenBit;	/* force 7-bit data */
759 EXTERN time_t	SafeAlias;	/* interval to wait until @:@ in alias file */
760 EXTERN FILE	*InChannel;	/* input connection */
761 EXTERN FILE	*OutChannel;	/* output connection */
762 EXTERN uid_t	RealUid;	/* when Daemon, real uid of caller */
763 EXTERN gid_t	RealGid;	/* when Daemon, real gid of caller */
764 EXTERN uid_t	DefUid;		/* default uid to run as */
765 EXTERN gid_t	DefGid;		/* default gid to run as */
766 EXTERN char	*DefUser;	/* default user to run as (from DefUid) */
767 EXTERN int	OldUmask;	/* umask when sendmail starts up */
768 EXTERN int	Errors;		/* set if errors (local to single pass) */
769 EXTERN int	ExitStat;	/* exit status code */
770 EXTERN int	AliasLevel;	/* depth of aliasing */
771 EXTERN int	LineNumber;	/* line number in current input */
772 EXTERN int	LogLevel;	/* level of logging to perform */
773 EXTERN int	FileMode;	/* mode on files */
774 EXTERN int	QueueLA;	/* load average starting forced queueing */
775 EXTERN int	RefuseLA;	/* load average refusing connections are */
776 EXTERN int	CurrentLA;	/* current load average */
777 EXTERN long	QueueFactor;	/* slope of queue function */
778 EXTERN time_t	QueueIntvl;	/* intervals between running the queue */
779 EXTERN char	*HelpFile;	/* location of SMTP help file */
780 EXTERN char	*ErrMsgFile;	/* file to prepend to all error messages */
781 EXTERN char	*StatFile;	/* location of statistics summary */
782 EXTERN char	*QueueDir;	/* location of queue directory */
783 EXTERN char	*FileName;	/* name to print on error messages */
784 EXTERN char	*SmtpPhase;	/* current phase in SMTP processing */
785 EXTERN char	*MyHostName;	/* name of this host for SMTP messages */
786 EXTERN char	*RealHostName;	/* name of host we are talking to */
787 EXTERN SOCKADDR RealHostAddr;	/* address of host we are talking to */
788 EXTERN char	*CurHostName;	/* current host we are dealing with */
789 EXTERN jmp_buf	TopFrame;	/* branch-to-top-of-loop-on-error frame */
790 EXTERN bool	QuickAbort;	/*  .... but only if we want a quick abort */
791 EXTERN bool	LogUsrErrs;	/* syslog user errors (e.g., SMTP RCPT cmd) */
792 EXTERN bool	SendMIMEErrors;	/* send error messages in MIME format */
793 EXTERN bool	MatchGecos;	/* look for user names in gecos field */
794 EXTERN bool	UseErrorsTo;	/* use Errors-To: header (back compat) */
795 EXTERN bool	TryNullMXList;	/* if we are the best MX, try host directly */
796 extern bool	CheckLoopBack;	/* check for loopback on HELO packet */
797 EXTERN bool	InChild;	/* true if running in an SMTP subprocess */
798 EXTERN char	SpaceSub;	/* substitution for <lwsp> */
799 EXTERN int	PrivacyFlags;	/* privacy flags */
800 EXTERN char	*ConfFile;	/* location of configuration file [conf.c] */
801 extern char	*PidFile;	/* location of proc id file [conf.c] */
802 extern ADDRESS	NullAddress;	/* a null (template) address [main.c] */
803 EXTERN long	WkClassFact;	/* multiplier for message class -> priority */
804 EXTERN long	WkRecipFact;	/* multiplier for # of recipients -> priority */
805 EXTERN long	WkTimeFact;	/* priority offset each time this job is run */
806 EXTERN char	*UdbSpec;	/* user database source spec */
807 EXTERN int	MaxHopCount;	/* max # of hops until bounce */
808 EXTERN int	ConfigLevel;	/* config file level */
809 EXTERN char	*TimeZoneSpec;	/* override time zone specification */
810 EXTERN char	*ForwardPath;	/* path to search for .forward files */
811 EXTERN long	MinBlocksFree;	/* min # of blocks free on queue fs */
812 EXTERN char	*FallBackMX;	/* fall back MX host */
813 EXTERN long	MaxMessageSize;	/* advertised max size we will accept */
814 EXTERN char	*PostMasterCopy;	/* address to get errs cc's */
815 EXTERN int	CheckpointInterval;	/* queue file checkpoint interval */
816 EXTERN bool	DontPruneRoutes;	/* don't prune source routes */
817 extern bool	BrokenSmtpPeers;	/* peers can't handle 2-line greeting */
818 EXTERN int	MaxMciCache;		/* maximum entries in MCI cache */
819 EXTERN time_t	MciCacheTimeout;	/* maximum idle time on connections */
820 EXTERN char	*QueueLimitRecipient;	/* limit queue runs to this recipient */
821 EXTERN char	*QueueLimitSender;	/* limit queue runs to this sender */
822 EXTERN char	*QueueLimitId;		/* limit queue runs to this id */
823 EXTERN FILE	*TrafficLogFile;	/* file in which to log all traffic */
824 extern int	errno;
825 
826 
827 /*
828 **  Timeouts
829 **
830 **	Indicated values are the MINIMUM per RFC 1123 section 5.3.2.
831 */
832 
833 EXTERN struct
834 {
835 			/* RFC 1123-specified timeouts [minimum value] */
836 	time_t	to_initial;	/* initial greeting timeout [5m] */
837 	time_t	to_mail;	/* MAIL command [5m] */
838 	time_t	to_rcpt;	/* RCPT command [5m] */
839 	time_t	to_datainit;	/* DATA initiation [2m] */
840 	time_t	to_datablock;	/* DATA block [3m] */
841 	time_t	to_datafinal;	/* DATA completion [10m] */
842 	time_t	to_nextcommand;	/* next command [5m] */
843 			/* following timeouts are not mentioned in RFC 1123 */
844 	time_t	to_rset;	/* RSET command */
845 	time_t	to_helo;	/* HELO command */
846 	time_t	to_quit;	/* QUIT command */
847 	time_t	to_miscshort;	/* misc short commands (NOOP, VERB, etc) */
848 	time_t	to_ident;	/* IDENT protocol requests */
849 			/* following are per message */
850 	time_t	to_q_return;	/* queue return timeout */
851 	time_t	to_q_warning;	/* queue warning timeout */
852 } TimeOuts;
853 
854 
855 /*
856 **  Trace information
857 */
858 
859 /* trace vector and macros for debugging flags */
860 EXTERN u_char	tTdvect[100];
861 # define tTd(flag, level)	(tTdvect[flag] >= level)
862 # define tTdlevel(flag)		(tTdvect[flag])
863 /*
864 **  Miscellaneous information.
865 */
866 
867 
868 
869 /*
870 **  Some in-line functions
871 */
872 
873 /* set exit status */
874 #define setstat(s)	{ \
875 				if (ExitStat == EX_OK || ExitStat == EX_TEMPFAIL) \
876 					ExitStat = s; \
877 			}
878 
879 /* make a copy of a string */
880 #define newstr(s)	strcpy(xalloc(strlen(s) + 1), s)
881 
882 #define STRUCTCOPY(s, d)	d = s
883 
884 
885 /*
886 **  Declarations of useful functions
887 */
888 
889 extern ADDRESS		*parseaddr __P((char *, ADDRESS *, int, int, char **, ENVELOPE *));
890 extern char		*xalloc __P((int));
891 extern bool		sameaddr __P((ADDRESS *, ADDRESS *));
892 extern FILE		*dfopen __P((char *, int, int));
893 extern EVENT		*setevent __P((time_t, int(*)(), int));
894 extern char		*sfgets __P((char *, int, FILE *, time_t, char *));
895 extern char		*queuename __P((ENVELOPE *, int));
896 extern time_t		curtime __P(());
897 extern bool		transienterror __P((int));
898 extern const char	*errstring __P((int));
899 extern void		expand __P((char *, char *, char *, ENVELOPE *));
900 extern void		define __P((int, char *, ENVELOPE *));
901 extern char		*macvalue __P((int, ENVELOPE *));
902 extern char		**prescan __P((char *, int, char[], int, char **));
903 extern int		rewrite __P((char **, int, int, ENVELOPE *));
904 extern char		*fgetfolded __P((char *, int, FILE *));
905 extern ADDRESS		*recipient __P((ADDRESS *, ADDRESS **, ENVELOPE *));
906 extern ENVELOPE		*newenvelope __P((ENVELOPE *, ENVELOPE *));
907 extern void		dropenvelope __P((ENVELOPE *));
908 extern void		clearenvelope __P((ENVELOPE *, int));
909 extern char		*username __P(());
910 extern MCI		*mci_get __P((char *, MAILER *));
911 extern char		*pintvl __P((time_t, int));
912 extern char		*map_rewrite __P((MAP *, char *, int, char **));
913 extern ADDRESS		*getctladdr __P((ADDRESS *));
914 extern char		*anynet_ntoa __P((SOCKADDR *));
915 extern char		*remotename __P((char *, MAILER *, int, int *, ENVELOPE *));
916 extern bool		shouldqueue __P((long, time_t));
917 extern bool		lockfile __P((int, char *, char *, int));
918 extern char		*hostsignature __P((MAILER *, char *, ENVELOPE *));
919 extern void		openxscript __P((ENVELOPE *));
920 extern void		closexscript __P((ENVELOPE *));
921 extern sigfunc_t	setsignal __P((int, sigfunc_t));
922 extern char		*shortenstring __P((char *, int));
923 
924 /* ellipsis is a different case though */
925 #ifdef __STDC__
926 extern void		auth_warning(ENVELOPE *, const char *, ...);
927 extern void		syserr(const char *, ...);
928 extern void		usrerr(const char *, ...);
929 extern void		message(const char *, ...);
930 extern void		nmessage(const char *, ...);
931 #else
932 extern void		auth_warning();
933 extern void		syserr();
934 extern void		usrerr();
935 extern void		message();
936 extern void		nmessage();
937 #endif
938