1 /*
2 **  SENDMAIL.H -- Global definitions for sendmail.
3 */
4 
5 
6 
7 # ifdef _DEFINE
8 # define EXTERN
9 static char SmailSccsId[] =	"@(#)sendmail.h	3.54	11/21/81";
10 # else  _DEFINE
11 # define EXTERN extern
12 # endif _DEFINE
13 
14 # ifndef major
15 # include <sys/types.h>
16 # endif major
17 # include <stdio.h>
18 # include <ctype.h>
19 # include "useful.h"
20 
21 /*
22 **  Configuration constants.
23 **	There shouldn't be much need to change these....
24 */
25 
26 # define MAXLINE	256		/* max line length */
27 # define MAXNAME	128		/* max length of a name */
28 # define MAXFIELD	2500		/* max total length of a hdr field */
29 # define MAXPV		40		/* max # of parms to mailers */
30 # define MAXHOP		30		/* max value of HopCount */
31 # define MAXATOM	30		/* max atoms per address */
32 # define MAXMAILERS	10		/* maximum mailers known to system */
33 # define SPACESUB	('.'|0200)	/* substitution for <lwsp> */
34 
35 extern char	Arpa_Info[];	/* the message number for Arpanet info */
36 
37 
38 
39 
40 
41 
42 /*
43 **  Address structure.
44 **	Addresses are stored internally in this structure.
45 */
46 
47 struct address
48 {
49 	char		*q_paddr;	/* the printname for the address */
50 	char		*q_user;	/* user name */
51 	char		*q_host;	/* host name */
52 	struct mailer	*q_mailer;	/* mailer to use */
53 	short		q_rmailer;	/* real mailer (before mapping) */
54 	u_short		q_flags;	/* status flags, see below */
55 	short		q_uid;		/* user-id of receiver (if known) */
56 	short		q_gid;		/* group-id of receiver (if known) */
57 	char		*q_home;	/* home dir (local mailer only) */
58 	char		*q_fullname;	/* full name if known */
59 	struct address	*q_next;	/* chain */
60 	struct address	*q_alias;	/* address this results from */
61 	time_t		q_timeout;	/* timeout for this address */
62 };
63 
64 typedef struct address ADDRESS;
65 
66 # define QDONTSEND	000001	/* don't send to this address */
67 # define QBADADDR	000002	/* this address is verified bad */
68 # define QGOODUID	000004	/* the q_uid q_gid fields are good */
69 # define QPRIMARY	000010	/* set from argv */
70 # define QQUEUEUP	000020	/* queue for later transmission */
71 
72 
73 
74 
75 
76 /*
77 **  Mailer definition structure.
78 **	Every mailer known to the system is declared in this
79 **	structure.  It defines the pathname of the mailer, some
80 **	flags associated with it, and the argument vector to
81 **	pass to it.  The flags are defined in conf.c
82 **
83 **	The argument vector is expanded before actual use.  All
84 **	words except the first are passed through the macro
85 **	processor.
86 */
87 
88 struct mailer
89 {
90 	char	*m_name;	/* symbolic name of this mailer */
91 	char	*m_mailer;	/* pathname of the mailer to use */
92 	u_long	m_flags;	/* status flags, see below */
93 	short	m_badstat;	/* the status code to use on unknown error */
94 	short	m_mno;		/* mailer number internally */
95 	char	*m_from;	/* pattern for From: header */
96 	char	**m_argv;	/* template argument vector */
97 };
98 
99 typedef struct mailer	MAILER;
100 
101 # define M_FOPT		000001	/* mailer takes picky -f flag */
102 # define M_ROPT		000002	/* mailer takes picky -r flag */
103 # define M_QUIET	000004	/* don't print error on bad status */
104 # define M_RESTR	000010	/* must be daemon to execute */
105 # define M_NHDR		000020	/* don't insert From line */
106 # define M_LOCAL	000040	/* delivery is to this host */
107 # define M_STRIPQ	000100	/* strip quote characters from user/host */
108 # define M_MUSER	000200	/* mailer can handle multiple users at once */
109 # define M_NEEDFROM	000400	/* need arpa-style From: line */
110 # define M_NEEDDATE	001000	/* need arpa-style Date: line */
111 # define M_MSGID	002000	/* need Message-Id: field */
112 # define M_USR_UPPER	010000	/* preserve user case distinction */
113 # define M_HST_UPPER	020000	/* preserve host case distinction */
114 # define M_FULLNAME	040000	/* want Full-Name field */
115 
116 # define M_ARPAFMT	(M_NEEDDATE|M_NEEDFROM|M_MSGID)
117 
118 EXTERN MAILER	*Mailer[MAXMAILERS+1];
119 
120 EXTERN MAILER	*LocalMailer;		/* ptr to local mailer */
121 EXTERN MAILER	*ProgMailer;		/* ptr to program mailer */
122 
123 
124 /*
125 **  Header structure.
126 **	This structure is used internally to store header items.
127 */
128 
129 struct header
130 {
131 	char		*h_field;	/* the name of the field */
132 	char		*h_value;	/* the value of that field */
133 	struct header	*h_link;	/* the next header */
134 	u_short		h_flags;	/* status bits, see below */
135 	u_long		h_mflags;	/* m_flags bits needed */
136 };
137 
138 typedef struct header	HDR;
139 
140 EXTERN HDR	*Header;	/* head of header list */
141 
142 /*
143 **  Header information structure.
144 **	Defined in conf.c, this struct declares the header fields
145 **	that have some magic meaning.
146 */
147 
148 struct hdrinfo
149 {
150 	char	*hi_field;	/* the name of the field */
151 	u_short	hi_flags;	/* status bits, see below */
152 	u_short	hi_mflags;	/* m_flags needed for this field */
153 };
154 
155 extern struct hdrinfo	HdrInfo[];
156 
157 /* bits for h_flags and hi_flags */
158 # define H_EOH		00001	/* this field terminates header */
159 # define H_DEFAULT	00004	/* if another value is found, drop this */
160 # define H_USED		00010	/* indicates that this has been output */
161 # define H_CHECK	00020	/* check h_mflags against m_flags */
162 # define H_ACHECK	00040	/* ditto, but always (not just default) */
163 # define H_FORCE	00100	/* force this field, even if default */
164 # define H_ADDR		00200	/* this field contains addresses */
165 
166 
167 
168 /*
169 **  Work queue.
170 */
171 
172 struct work
173 {
174 	char		*w_name;	/* name of control file */
175 	short		w_pri;		/* priority of message, see below */
176 	long		w_size;		/* length of data file */
177 	struct work	*w_next;	/* next in queue */
178 };
179 
180 typedef struct work	WORK;
181 
182 EXTERN WORK	*WorkQ;			/* queue of things to be done */
183 
184 
185 /*
186 **  Message priorities.
187 **	Priorities > 0 should be preemptive.
188 */
189 
190 # define PRI_ALERT	20
191 # define PRI_QUICK	10
192 # define PRI_FIRSTCL	0
193 # define PRI_NORMAL	-4
194 # define PRI_SECONDCL	-10
195 # define PRI_THIRDCL	-20
196 
197 EXTERN int	MsgPriority;		/* priority of this message */
198 
199 
200 
201 /*
202 **  Rewrite rules.
203 */
204 
205 struct rewrite
206 {
207 	char	**r_lhs;	/* pattern match */
208 	char	**r_rhs;	/* substitution value */
209 	struct rewrite	*r_next;/* next in chain */
210 };
211 
212 extern struct rewrite	*RewriteRules[];
213 
214 # define MATCHANY	'\020'	/* match one or more tokens */
215 # define MATCHONE	'\021'	/* match exactly one token */
216 # define MATCHCLASS	'\022'	/* match one token in a class */
217 # define MATCHREPL	'\023'	/* replacement on RHS for above */
218 
219 # define CANONNET	'\025'	/* canonical net, next token */
220 # define CANONHOST	'\026'	/* canonical host, next token */
221 # define CANONUSER	'\027'	/* canonical user, next N tokens */
222 
223 
224 
225 /*
226 **  Symbol table definitions
227 */
228 
229 struct symtab
230 {
231 	char		*s_name;	/* name to be entered */
232 	char		s_type;		/* general type (see below) */
233 	struct symtab	*s_next;	/* pointer to next in chain */
234 	union
235 	{
236 		long	sv_class;	/* bit-map of word classes */
237 		ADDRESS	*sv_addr;	/* pointer to address header */
238 		MAILER	*sv_mailer;	/* pointer to mailer */
239 		char	*sv_alias;	/* alias */
240 	}	s_value;
241 };
242 
243 typedef struct symtab	STAB;
244 
245 /* symbol types */
246 # define ST_UNDEF	0	/* undefined type */
247 # define ST_CLASS	1	/* class map */
248 # define ST_ADDRESS	2	/* an address in parsed format */
249 # define ST_MAILER	3	/* a mailer header */
250 # define ST_ALIAS	4	/* an alias */
251 
252 # define s_class	s_value.sv_class
253 # define s_addr		s_value.sv_addr
254 # define s_mailer	s_value.sv_mailer
255 # define s_alias	s_value.sv_alias
256 
257 extern STAB	*stab();
258 
259 /* opcodes to stab */
260 # define ST_FIND	0	/* find entry */
261 # define ST_ENTER	1	/* enter if not there */
262 
263 
264 
265 
266 /*
267 **  Statistics structure.
268 */
269 
270 struct statistics
271 {
272 	time_t	stat_itime;		/* file initialization time */
273 	short	stat_size;		/* size of this structure */
274 	long	stat_nf[MAXMAILERS];	/* # msgs from each mailer */
275 	long	stat_bf[MAXMAILERS];	/* kbytes from each mailer */
276 	long	stat_nt[MAXMAILERS];	/* # msgs to each mailer */
277 	long	stat_bt[MAXMAILERS];	/* kbytes to each mailer */
278 };
279 
280 EXTERN struct statistics	Stat;
281 extern long			kbytes();	/* for _bf, _bt */
282 
283 
284 
285 
286 /*
287 **  Global variables.
288 */
289 
290 EXTERN bool	FromFlag;	/* if set, "From" person is explicit */
291 EXTERN bool	MailBack;	/* mail back response on error */
292 EXTERN bool	BerkNet;	/* called from BerkNet */
293 EXTERN bool	WriteBack;	/* write back response on error */
294 EXTERN bool	NoAlias;	/* if set, don't do any aliasing */
295 EXTERN bool	ForceMail;	/* if set, mail even if already got a copy */
296 EXTERN bool	MeToo;		/* send to the sender also */
297 EXTERN bool	IgnrDot;	/* don't let dot end messages */
298 EXTERN bool	SaveFrom;	/* save leading "From" lines */
299 EXTERN bool	Verbose;	/* set if blow-by-blow desired */
300 EXTERN bool	GrabTo;		/* if set, get recipients from msg */
301 EXTERN bool	DontSend;	/* mark recipients as QDONTSEND */
302 EXTERN bool	NoReturn;	/* don't return letter to sender */
303 EXTERN bool	Daemon;		/* running as a daemon */
304 EXTERN bool	Smtp;		/* using SMTP over connection */
305 EXTERN bool	SuprErrs;	/* set if we are suppressing errors */
306 EXTERN bool	QueueUp;	/* queue this message for future xmission */
307 EXTERN bool	QueueRun;	/* currently running something from the queue */
308 EXTERN bool	HoldErrs;	/* only output errors to transcript */
309 EXTERN bool	ArpaMode;	/* set if running arpanet protocol */
310 extern time_t	TimeOut;	/* time until timeout */
311 EXTERN FILE	*InChannel;	/* input connection */
312 EXTERN FILE	*OutChannel;	/* output connection */
313 EXTERN FILE	*TempFile;	/* mail temp file */
314 EXTERN FILE	*Xscript;	/* mail transcript file */
315 EXTERN int	RealUid;	/* when Daemon, real uid of caller */
316 EXTERN int	RealGid;	/* when Daemon, real gid of caller */
317 EXTERN int	OldUmask;	/* umask when sendmail starts up */
318 EXTERN int	Debug;		/* debugging level */
319 EXTERN int	Errors;		/* set if errors */
320 EXTERN int	ExitStat;	/* exit status code */
321 EXTERN int	HopCount;	/* hop count */
322 EXTERN int	AliasLevel;	/* depth of aliasing */
323 EXTERN time_t	QueueIntvl;	/* intervals between running the queue */
324 EXTERN char	*OrigFrom;	/* the From: line read from the message */
325 EXTERN char	*To;		/* the target person */
326 EXTERN char	*HostName;	/* name of this host for SMTP messages */
327 EXTERN char	*InFileName;	/* input file name */
328 EXTERN char	*Transcript;	/* the transcript file name */
329 extern char	*XcriptFile;	/* template for Transcript */
330 extern char	*AliasFile;	/* location of alias file */
331 extern char	*ConfFile;	/* location of configuration file */
332 extern char	*StatFile;	/* location of statistics summary */
333 extern char	*QueueDir;	/* location of queue directory */
334 EXTERN ADDRESS	From;		/* the person it is from */
335 EXTERN ADDRESS	*SendQueue;	/* list of message recipients */
336 EXTERN long	MsgSize;	/* size of the message in bytes */
337 EXTERN time_t	CurTime;	/* time of this message */
338 
339 
340 # include	<sysexits.h>
341 
342 # define setstat(s)		{ if (ExitStat == EX_OK) ExitStat = s; }
343 
344 
345 /* useful functions */
346 
347 extern char	*newstr();
348 extern ADDRESS	*parse();
349 extern char	*xalloc();
350 extern char	*expand();
351 extern bool	sameaddr();
352