1 /*
2 **  SENDMAIL.H -- Global definitions for sendmail.
3 */
4 
5 
6 
7 # ifdef _DEFINE
8 # define EXTERN
9 # ifndef lint
10 static char SmailSccsId[] =	"@(#)sendmail.h	3.81		08/23/82";
11 # endif lint
12 # else  _DEFINE
13 # define EXTERN extern
14 # endif _DEFINE
15 
16 # include <stdio.h>
17 # include <ctype.h>
18 # include <setjmp.h>
19 # include "useful.h"
20 
21 # ifdef LOG
22 # include <syslog.h>
23 # endif LOG
24 /*
25 **  Configuration constants.
26 **	There shouldn't be much need to change these....
27 */
28 
29 # define MAXLINE	256		/* max line length */
30 # define MAXNAME	128		/* max length of a name */
31 # define MAXFIELD	2500		/* max total length of a hdr field */
32 # define MAXPV		40		/* max # of parms to mailers */
33 # define MAXHOP		30		/* max value of HopCount */
34 # define MAXATOM	100		/* max atoms per address */
35 # define MAXMAILERS	10		/* maximum mailers known to system */
36 # define SPACESUB	('.'|0200)	/* substitution for <lwsp> */
37 /*
38 **  Address structure.
39 **	Addresses are stored internally in this structure.
40 */
41 
42 struct address
43 {
44 	char		*q_paddr;	/* the printname for the address */
45 	char		*q_user;	/* user name */
46 	char		*q_host;	/* host name */
47 	struct mailer	*q_mailer;	/* mailer to use */
48 	short		q_rmailer;	/* real mailer (before mapping) */
49 	u_short		q_flags;	/* status flags, see below */
50 	short		q_uid;		/* user-id of receiver (if known) */
51 	short		q_gid;		/* group-id of receiver (if known) */
52 	char		*q_home;	/* home dir (local mailer only) */
53 	char		*q_fullname;	/* full name if known */
54 	struct address	*q_next;	/* chain */
55 	struct address	*q_alias;	/* address this results from */
56 	struct address	*q_tchain;	/* temporary use chain */
57 	time_t		q_timeout;	/* timeout for this address */
58 };
59 
60 typedef struct address ADDRESS;
61 
62 # define QDONTSEND	000001	/* don't send to this address */
63 # define QBADADDR	000002	/* this address is verified bad */
64 # define QGOODUID	000004	/* the q_uid q_gid fields are good */
65 # define QPRIMARY	000010	/* set from argv */
66 # define QQUEUEUP	000020	/* queue for later transmission */
67 /*
68 **  Mailer definition structure.
69 **	Every mailer known to the system is declared in this
70 **	structure.  It defines the pathname of the mailer, some
71 **	flags associated with it, and the argument vector to
72 **	pass to it.  The flags are defined in conf.c
73 **
74 **	The argument vector is expanded before actual use.  All
75 **	words except the first are passed through the macro
76 **	processor.
77 */
78 
79 struct mailer
80 {
81 	char	*m_name;	/* symbolic name of this mailer */
82 	char	*m_mailer;	/* pathname of the mailer to use */
83 	u_long	m_flags;	/* status flags, see below */
84 	short	m_badstat;	/* the status code to use on unknown error */
85 	short	m_mno;		/* mailer number internally */
86 	char	*m_from;	/* pattern for From: header */
87 	char	**m_argv;	/* template argument vector */
88 };
89 
90 typedef struct mailer	MAILER;
91 
92 /* bits for m_flags */
93 # define M_FOPT		000000001L	/* mailer takes picky -f flag */
94 # define M_ROPT		000000002L	/* mailer takes picky -r flag */
95 # define M_QUIET	000000004L	/* don't print error on bad status */
96 # define M_RESTR	000000010L	/* must be daemon to execute */
97 # define M_NHDR		000000020L	/* don't insert From line */
98 # define M_LOCAL	000000040L	/* delivery is to this host */
99 # define M_STRIPQ	000000100L	/* strip quote chars from user/host */
100 # define M_MUSER	000000200L	/* can handle multiple users at once */
101 # define M_NEEDFROM	000000400L	/* need arpa-style From: line */
102 # define M_NEEDDATE	000001000L	/* need arpa-style Date: line */
103 # define M_MSGID	000002000L	/* need Message-Id: field */
104 # define M_RELRCPT	000004000L	/* make recipient addresses relative */
105 # define M_USR_UPPER	000010000L	/* preserve user case distinction */
106 # define M_HST_UPPER	000020000L	/* preserve host case distinction */
107 # define M_FULLNAME	000040000L	/* want Full-Name field */
108 # define M_UGLYUUCP	000100000L	/* this wants an ugly UUCP from line */
109 # define M_EXPENSIVE	000200000L	/* it costs to use this mailer.... */
110 # define M_FULLSMTP	000400000L	/* must run full SMTP, inc. limits */
111 
112 # define M_ARPAFMT	(M_NEEDDATE|M_NEEDFROM|M_MSGID)
113 
114 EXTERN MAILER	*Mailer[MAXMAILERS+1];
115 
116 EXTERN MAILER	*LocalMailer;		/* ptr to local mailer */
117 EXTERN MAILER	*ProgMailer;		/* ptr to program mailer */
118 /*
119 **  Header structure.
120 **	This structure is used internally to store header items.
121 */
122 
123 struct header
124 {
125 	char		*h_field;	/* the name of the field */
126 	char		*h_value;	/* the value of that field */
127 	struct header	*h_link;	/* the next header */
128 	u_short		h_flags;	/* status bits, see below */
129 	u_long		h_mflags;	/* m_flags bits needed */
130 };
131 
132 typedef struct header	HDR;
133 
134 /*
135 **  Header information structure.
136 **	Defined in conf.c, this struct declares the header fields
137 **	that have some magic meaning.
138 */
139 
140 struct hdrinfo
141 {
142 	char	*hi_field;	/* the name of the field */
143 	u_short	hi_flags;	/* status bits, see below */
144 	u_short	hi_mflags;	/* m_flags needed for this field */
145 };
146 
147 extern struct hdrinfo	HdrInfo[];
148 
149 /* bits for h_flags and hi_flags */
150 # define H_EOH		00001	/* this field terminates header */
151 # define H_RCPT		00002	/* contains recipient addresses */
152 # define H_DEFAULT	00004	/* if another value is found, drop this */
153 # define H_USED		00010	/* indicates that this has been output */
154 # define H_CHECK	00020	/* check h_mflags against m_flags */
155 # define H_ACHECK	00040	/* ditto, but always (not just default) */
156 # define H_FORCE	00100	/* force this field, even if default */
157 # define H_ADDR		00200	/* this field contains addresses */
158 # define H_FROM		00400	/* this is a from-type field */
159 /*
160 **  Envelope structure.
161 **	This structure defines the message itself.  There is usually
162 **	only one of these -- for the message that we originally read
163 **	and which is our primary interest -- but other envelopes can
164 **	be generated during processing.  For example, error messages
165 **	will have their own envelope.
166 */
167 
168 struct envelope
169 {
170 	HDR		*e_header;	/* head of header list */
171 	long		e_msgpriority;	/* adjusted priority of this message */
172 	time_t		e_ctime;	/* time message appeared in the queue */
173 	bool		e_queueup;	/* queue this message */
174 	bool		e_dontqueue;	/* override queueing */
175 	bool		e_oldstyle;	/* use spaces (not commas) in hdrs */
176 	bool		e_retreceipt;	/* give a return receipt */
177 	bool		e_sendreceipt;	/* actually send a receipt back */
178 	char		*e_origfrom;	/* the From: line first read */
179 	char		*e_to;		/* the target person */
180 	ADDRESS		e_from;		/* the person it is from */
181 	ADDRESS		*e_sendqueue;	/* list of message recipients */
182 	ADDRESS		*e_errorqueue;	/* the queue for error responses */
183 	long		e_msgsize;	/* size of the message in bytes */
184 	short		e_class;	/* msg class (priority, junk, etc.) */
185 	int		(*e_puthdr)();	/* function to put header of message */
186 	int		(*e_putbody)();	/* function to put body of message */
187 	struct envelope	*e_parent;	/* the message this one encloses */
188 	char		*e_df;		/* location of temp file */
189 	char		*e_qf;		/* queue control file */
190 	char		*e_id;		/* code for this entry in queue */
191 	char		*e_macro[128];	/* macro definitions */
192 };
193 
194 typedef struct envelope	ENVELOPE;
195 
196 EXTERN ENVELOPE	*CurEnv;	/* envelope currently being processed */
197 /*
198 **  Work queue.
199 */
200 
201 struct work
202 {
203 	char		*w_name;	/* name of control file */
204 	long		w_pri;		/* priority of message, see below */
205 	struct work	*w_next;	/* next in queue */
206 };
207 
208 typedef struct work	WORK;
209 
210 EXTERN WORK	*WorkQ;			/* queue of things to be done */
211 
212 
213 /*
214 **  Message priorities.
215 **	Priorities > 0 should be preemptive.
216 **
217 **	CurEnv->e_msgpriority is the number of bytes in the message adjusted
218 **	by the message priority and the amount of time the message
219 **	has been sitting around.  Each priority point is worth
220 **	WKPRIFACT bytes of message, and each time we reprocess a
221 **	message the size gets reduced by WKTIMEFACT.
222 **
223 **	The "class" is this number, unadjusted by the age or size of
224 **	this message.  Classes with negative representations will have
225 **	error messages thrown away if they are not local.
226 */
227 
228 # define PRI_ALERT	50
229 # define PRI_QUICK	30
230 # define PRI_FIRSTCL	10
231 # define PRI_NORMAL	0
232 # define PRI_SECONDCL	-10
233 # define PRI_THIRDCL	-40
234 # define PRI_JUNK	-100
235 
236 # define WKPRIFACT	1800		/* bytes each pri point is worth */
237 # define WKTIMEFACT	400		/* bytes each time unit is worth */
238 /*
239 **  Rewrite rules.
240 */
241 
242 struct rewrite
243 {
244 	char	**r_lhs;	/* pattern match */
245 	char	**r_rhs;	/* substitution value */
246 	struct rewrite	*r_next;/* next in chain */
247 };
248 
249 extern struct rewrite	*RewriteRules[];
250 
251 # define MATCHANY	'\020'	/* match one or more tokens */
252 # define MATCHONE	'\021'	/* match exactly one token */
253 # define MATCHCLASS	'\022'	/* match one token in a class */
254 # define MATCHREPL	'\023'	/* replacement on RHS for above */
255 
256 # define CANONNET	'\025'	/* canonical net, next token */
257 # define CANONHOST	'\026'	/* canonical host, next token */
258 # define CANONUSER	'\027'	/* canonical user, next N tokens */
259 
260 # define CONDIF		'\030'	/* conditional if-then */
261 # define CONDELSE	'\031'	/* conditional else */
262 # define CONDFI		'\032'	/* conditional fi */
263 /*
264 **  Symbol table definitions
265 */
266 
267 struct symtab
268 {
269 	char		*s_name;	/* name to be entered */
270 	char		s_type;		/* general type (see below) */
271 	struct symtab	*s_next;	/* pointer to next in chain */
272 	union
273 	{
274 		long	sv_class;	/* bit-map of word classes */
275 		ADDRESS	*sv_addr;	/* pointer to address header */
276 		MAILER	*sv_mailer;	/* pointer to mailer */
277 		char	*sv_alias;	/* alias */
278 	}	s_value;
279 };
280 
281 typedef struct symtab	STAB;
282 
283 /* symbol types */
284 # define ST_UNDEF	0	/* undefined type */
285 # define ST_CLASS	1	/* class map */
286 # define ST_ADDRESS	2	/* an address in parsed format */
287 # define ST_MAILER	3	/* a mailer header */
288 # define ST_ALIAS	4	/* an alias */
289 
290 # define s_class	s_value.sv_class
291 # define s_address	s_value.sv_addr
292 # define s_mailer	s_value.sv_mailer
293 # define s_alias	s_value.sv_alias
294 
295 extern STAB	*stab();
296 
297 /* opcodes to stab */
298 # define ST_FIND	0	/* find entry */
299 # define ST_ENTER	1	/* enter if not there */
300 /*
301 **  STRUCT EVENT -- event queue.
302 **
303 **	Maintained in sorted order.
304 */
305 
306 struct event
307 {
308 	time_t		ev_time;	/* time of the function call */
309 	int		(*ev_func)();	/* function to call */
310 	int		ev_arg;		/* argument to ev_func */
311 	struct event	*ev_link;	/* link to next item */
312 };
313 
314 typedef struct event	EVENT;
315 
316 EXTERN EVENT	*EventQueue;		/* head of event queue */
317 /*
318 **  Statistics structure.
319 */
320 
321 struct statistics
322 {
323 	time_t	stat_itime;		/* file initialization time */
324 	short	stat_size;		/* size of this structure */
325 	long	stat_nf[MAXMAILERS];	/* # msgs from each mailer */
326 	long	stat_bf[MAXMAILERS];	/* kbytes from each mailer */
327 	long	stat_nt[MAXMAILERS];	/* # msgs to each mailer */
328 	long	stat_bt[MAXMAILERS];	/* kbytes to each mailer */
329 };
330 
331 EXTERN struct statistics	Stat;
332 extern long			kbytes();	/* for _bf, _bt */
333 /*
334 **  Operation modes
335 **	The default operation mode can be safely changed (except
336 **	that the default cannot be MD_DAEMON).
337 */
338 
339 EXTERN char	Mode;		/* operation mode, see below */
340 
341 #define MD_DELIVER	'a'		/* collect and deliver */
342 #define MD_FORK		'f'		/* verify & fork before delivery */
343 #define MD_QUEUE	'q'		/* collect & queue, don't deliver */
344 #define MD_DAEMON	'd'		/* run as a daemon */
345 #define MD_VERIFY	'v'		/* verify: don't collect or deliver */
346 
347 #define MD_DEFAULT	MD_DELIVER	/* default operation mode */
348 /*
349 **  Global variables.
350 */
351 
352 EXTERN bool	FromFlag;	/* if set, "From" person is explicit */
353 EXTERN bool	MailBack;	/* mail back response on error */
354 EXTERN bool	BerkNet;	/* called from BerkNet */
355 EXTERN bool	WriteBack;	/* write back response on error */
356 EXTERN bool	NoAlias;	/* if set, don't do any aliasing */
357 EXTERN bool	ForceMail;	/* if set, mail even if already got a copy */
358 EXTERN bool	MeToo;		/* send to the sender also */
359 EXTERN bool	IgnrDot;	/* don't let dot end messages */
360 EXTERN bool	SaveFrom;	/* save leading "From" lines */
361 EXTERN bool	Verbose;	/* set if blow-by-blow desired */
362 EXTERN bool	GrabTo;		/* if set, get recipients from msg */
363 EXTERN bool	DontSend;	/* mark recipients as QDONTSEND */
364 EXTERN bool	NoReturn;	/* don't return letter to sender */
365 EXTERN bool	Smtp;		/* using SMTP over connection */
366 EXTERN bool	SuprErrs;	/* set if we are suppressing errors */
367 EXTERN bool	QueueRun;	/* currently running message from the queue */
368 EXTERN bool	HoldErrs;	/* only output errors to transcript */
369 EXTERN bool	ArpaMode;	/* set if running arpanet protocol */
370 EXTERN bool	NoConnect;	/* don't connect to non-local mailers */
371 EXTERN bool	FatalErrors;	/* set if fatal errors during processing */
372 extern time_t	TimeOut;	/* time until timeout [conf.c] */
373 EXTERN FILE	*InChannel;	/* input connection */
374 EXTERN FILE	*OutChannel;	/* output connection */
375 EXTERN FILE	*TempFile;	/* mail temp file */
376 EXTERN FILE	*Xscript;	/* mail transcript file */
377 EXTERN int	RealUid;	/* when Daemon, real uid of caller */
378 EXTERN int	RealGid;	/* when Daemon, real gid of caller */
379 extern int	DefUid;		/* default uid to run as [conf.c] */
380 extern int	DefGid;		/* default gid to run as [conf.c] */
381 EXTERN int	OldUmask;	/* umask when sendmail starts up */
382 EXTERN int	Errors;		/* set if errors (local to single pass) */
383 EXTERN int	ExitStat;	/* exit status code */
384 EXTERN int	HopCount;	/* hop count */
385 EXTERN int	AliasLevel;	/* depth of aliasing */
386 EXTERN int	MotherPid;	/* proc id of parent process */
387 EXTERN time_t	QueueIntvl;	/* intervals between running the queue */
388 EXTERN char	*HostName;	/* name of this host for SMTP messages */
389 EXTERN char	*Transcript;	/* the transcript file name */
390 extern char	*XcriptFile;	/* template for Transcript [conf.c] */
391 extern char	*AliasFile;	/* location of alias file [conf.c] */
392 extern char	*ConfFile;	/* location of configuration file [conf.c] */
393 extern char	*StatFile;	/* location of statistics summary [conf.c] */
394 extern char	*QueueDir;	/* location of queue directory [conf.c] */
395 extern char	Arpa_Info[];	/* the reply code for Arpanet info [conf.c] */
396 EXTERN time_t	CurTime;	/* time of this message */
397 EXTERN jmp_buf	TopFrame;	/* branch-to-top-of-loop-on-error frame */
398 EXTERN bool	QuickAbort;	/*  .... but only if we want a quick abort */
399 extern int	ReadTimeout;	/* timeout on reads [conf.c] */
400 extern int	LogLevel;	/* level of logging to perform [conf.c] */
401 /*
402 **  Trace information
403 */
404 
405 /* trace vector and macros for debugging flags */
406 EXTERN u_char	tTdvect[100];
407 # define tTd(flag, level)	(tTdvect[flag] >= level)
408 # define tTdlevel(flag)		(tTdvect[flag])
409 /*
410 **  Miscellaneous information.
411 */
412 
413 # include	<sysexits.h>
414 
415 # define setstat(s)		{ if (ExitStat == EX_OK) ExitStat = s; }
416 
417 
418 /* useful functions */
419 
420 extern char	*newstr();
421 extern ADDRESS	*parse();
422 extern char	*xalloc();
423 extern bool	sameaddr();
424 extern FILE	*dfopen();
425 extern EVENT	*setevent();
426 extern char	*sfgets();
427 extern char	*queuename();
428