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