xref: /original-bsd/usr.sbin/sendmail/cf/m4/proto.m4 (revision 4ba124f7)
1divert(-1)
2#
3# Copyright (c) 1983 Eric P. Allman
4# Copyright (c) 1988, 1993
5#	The Regents of the University of California.  All rights reserved.
6#
7# %sccs.include.redist.sh%
8#
9divert(0)
10
11VERSIONID(`@(#)proto.m4	8.52 (Berkeley) 07/23/94')
12
13MAILER(local)dnl
14
15# level 5 config file format
16V5
17ifdef(`confSMTP_MAILER',, `define(`confSMTP_MAILER', `smtp')')dnl
18ifdef(`confLOCAL_MAILER',, `define(`confLOCAL_MAILER', `local')')dnl
19ifdef(`confRELAY_MAILER',,
20	`define(`confRELAY_MAILER',
21		`ifdef(`_MAILER_smtp_', `relay',
22			`ifdef(`_MAILER_uucp', `suucp', `unknown')')')')dnl
23define(`_SMTP_', `confSMTP_MAILER')dnl		for readability only
24define(`_LOCAL_', `confLOCAL_MAILER')dnl	for readability only
25define(`_RELAY_', `confRELAY_MAILER')dnl	for readability only
26
27##################
28#   local info   #
29##################
30
31Cwlocalhost
32ifdef(`USE_CW_FILE',
33`# file containing names of hosts for which we receive email
34Fw`'confCW_FILE',
35	`dnl')
36ifdef(`confDOMAIN_NAME', `
37# my official domain name
38Dj`'confDOMAIN_NAME',
39	`dnl')
40
41ifdef(`_NULL_CLIENT_ONLY_',
42`include(../m4/nullrelay.m4)m4exit',
43	`dnl')
44
45CP.
46
47ifdef(`UUCP_RELAY',
48`# UUCP relay host
49DY`'UUCP_RELAY
50CPUUCP
51
52')dnl
53ifdef(`BITNET_RELAY',
54`#  BITNET relay host
55DB`'BITNET_RELAY
56CPBITNET
57
58')dnl
59ifdef(`FAX_RELAY',
60`# FAX relay host
61DF`'FAX_RELAY
62CPFAX
63
64')dnl
65# "Smart" relay host (may be null)
66DS`'ifdef(`SMART_HOST', SMART_HOST)
67
68ifdef(`MAILER_TABLE',
69`# Mailer table (overriding domains)
70Kmailertable MAILER_TABLE
71
72')dnl
73ifdef(`DOMAIN_TABLE',
74`# Domain table (adding domains)
75Kdomaintable DOMAIN_TABLE
76
77')dnl
78# who I send unqualified names to (null means deliver locally)
79DR`'ifdef(`LOCAL_RELAY', LOCAL_RELAY)
80
81# who gets all local email traffic ($R has precedence for unqualified names)
82DH`'ifdef(`MAIL_HUB', MAIL_HUB)
83
84# who I masquerade as (null for no masquerading)
85DM`'ifdef(`MASQUERADE_NAME', MASQUERADE_NAME)
86
87# class L: names that should be delivered locally, even if we have a relay
88# class E: names that should be exposed as from this host, even if we masquerade
89# class D: dotted names, e.g., root.machinename
90#CL root
91CE root
92undivert(5)dnl
93ifdef(`__DOTTED_USER_LIST__',
94	`__DOTTED_USER_LIST__',
95	`#CD postmaster')
96
97# operators that cannot be in local usernames (i.e., network indicators)
98CO @ % ifdef(`_NO_UUCP_', `', `!')
99
100# a class with just dot (for identifying canonical names)
101C..
102
103# dequoting map
104Kdequote dequote
105
106undivert(6)dnl
107
108######################
109#   Special macros   #
110######################
111
112# SMTP initial login message
113De`'confSMTP_LOGIN_MSG
114
115# UNIX initial From header format
116Dl`'confFROM_LINE
117
118# my name for error messages
119Dn`'confMAILER_NAME
120
121# delimiter (operator) characters
122Do`'confOPERATORS
123
124# format of a total name
125Dq`'ifdef(`confFROM_HEADER', confFROM_HEADER, `$?x$x <$g>$|$g$.')
126include(`../m4/version.m4')
127
128###############
129#   Options   #
130###############
131
132# strip message body to 7 bits on input?
133O7`'confSEVEN_BIT_INPUT
134
135# 8-bit data handling
136O8`'confEIGHT_BIT_HANDLING
137
138# wait (in minutes) for alias file rebuild
139Oa`'confALIAS_WAIT
140
141# location of alias file
142OA`'ifdef(`ALIAS_FILE', `ALIAS_FILE', /etc/aliases)
143
144# minimum number of free blocks on filesystem
145Ob`'confMIN_FREE_BLOCKS
146
147# substitution for space (blank) characters
148OB`'confBLANK_SUB
149
150# avoid connecting to "expensive" mailers on initial submission?
151Oc`'confCON_EXPENSIVE
152
153# checkpoint queue runs after every N successful deliveries
154OC`'confCHECKPOINT_INTERVAL
155
156# default delivery mode
157Od`'confDELIVERY_MODE
158
159# automatically rebuild the alias database?
160OD`'confAUTO_REBUILD
161
162# error message header/file
163ifdef(`confERROR_MESSAGE',
164	OE`'confERROR_MESSAGE,
165	#OE/etc/sendmail.oE)
166
167# error mode
168ifdef(`confERROR_MODE',
169	Oe`'confERROR_MODE,
170	#Oep)
171
172# save Unix-style "From_" lines at top of header?
173Of`'confSAVE_FROM_LINES
174
175# temporary file mode
176OF`'confTEMP_FILE_MODE
177
178# match recipients against GECOS field?
179OG`'confMATCH_GECOS
180
181# default GID
182Og`'confDEF_GROUP_ID
183
184# maximum hop count
185Oh`'confMAX_HOP
186
187# location of help file
188OH`'ifdef(`HELP_FILE', HELP_FILE, /usr/lib/sendmail.hf)
189
190# ignore dots as terminators in incoming messages?
191Oi`'confIGNORE_DOTS
192
193# Insist that the BIND name server be running to resolve names
194ifdef(`confBIND_OPTS',
195	OI`'confBIND_OPTS,
196	#OI)
197
198# deliver MIME-encapsulated error messages?
199Oj`'confMIME_FORMAT_ERRORS
200
201# Forward file search path
202ifdef(`confFORWARD_PATH',
203	OJ`'confFORWARD_PATH,
204	#OJ/var/forward/$u:$z/.forward.$w:$z/.forward)
205
206# open connection cache size
207Ok`'confMCI_CACHE_SIZE
208
209# open connection cache timeout
210OK`'confMCI_CACHE_TIMEOUT
211
212# use Errors-To: header?
213Ol`'confUSE_ERRORS_TO
214
215# log level
216OL`'confLOG_LEVEL
217
218# send to me too, even in an alias expansion?
219Om`'confME_TOO
220
221# verify RHS in newaliases?
222On`'confCHECK_ALIASES
223
224# default messages to old style headers if no special punctuation?
225Oo`'confOLD_STYLE_HEADERS
226
227# SMTP daemon options
228ifdef(`confDAEMON_OPTIONS',
229	OO`'confDAEMON_OPTIONS,
230	#OOPort=esmtp)
231
232# privacy flags
233Op`'confPRIVACY_FLAGS
234
235# who (if anyone) should get extra copies of error messages
236ifdef(`confCOPY_ERRORS_TO',
237	OP`'confCOPY_ERRORS_TO,
238	#OPPostmaster)
239
240# slope of queue-only function
241ifdef(`confQUEUE_FACTOR',
242	Oq`'confQUEUE_FACTOR,
243	#Oq600000)
244
245# queue directory
246OQ`'ifdef(`QUEUE_DIR', QUEUE_DIR, /var/spool/mqueue)
247
248# read timeout -- now OK per RFC 1123 section 5.3.2
249ifdef(`confREAD_TIMEOUT',
250	Or`'confREAD_TIMEOUT,
251	#Ordatablock=10m)
252
253# queue up everything before forking?
254Os`'confSAFE_QUEUE
255
256# status file
257OS`'ifdef(`STATUS_FILE', STATUS_FILE, /etc/sendmail.st)
258
259# default message timeout interval
260OT`'confMESSAGE_TIMEOUT
261
262# time zone handling:
263#  if undefined, use system default
264#  if defined but null, use TZ envariable passed in
265#  if defined and non-null, use that info
266ifelse(confTIME_ZONE, `USE_SYSTEM', `#Ot',
267	confTIME_ZONE, `USE_TZ', `Ot',
268	`Ot`'confTIME_ZONE')
269
270# default UID
271Ou`'confDEF_USER_ID
272
273# list of locations of user database file (null means no lookup)
274OU`'ifdef(`confUSERDB_SPEC', `confUSERDB_SPEC')
275
276# fallback MX host
277ifdef(`confFALLBACK_MX',
278	OV`'confFALLBACK_MX,
279	#OVfall.back.host.net)
280
281# if we are the best MX host for a site, try it directly instead of config err
282Ow`'confTRY_NULL_MX_LIST
283
284# load average at which we just queue messages
285Ox`'confQUEUE_LA
286
287# load average at which we refuse connections
288OX`'confREFUSE_LA
289
290# work recipient factor
291ifdef(`confWORK_RECIPIENT_FACTOR',
292	Oy`'confWORK_RECIPIENT_FACTOR,
293	#Oy30000)
294
295# deliver each queued job in a separate process?
296OY`'confSEPARATE_PROC
297
298# work class factor
299ifdef(`confWORK_CLASS_FACTOR',
300	Oz`'confWORK_CLASS_FACTOR,
301	#Oz1800)
302
303# work time factor
304ifdef(`confWORK_TIME_FACTOR',
305	OZ`'confWORK_TIME_FACTOR,
306	#OZ90000)
307
308###########################
309#   Message precedences   #
310###########################
311
312Pfirst-class=0
313Pspecial-delivery=100
314Plist=-30
315Pbulk=-60
316Pjunk=-100
317
318#####################
319#   Trusted users   #
320#####################
321
322Troot
323Tdaemon
324Tuucp
325
326#########################
327#   Format of headers   #
328#########################
329
330H?P?Return-Path: $g
331HReceived: $?sfrom $s $.$?_($?s$|from $.$_) $.by $j ($v/$Z)$?r with $r$. id $i$?u for $u$.; $b
332H?D?Resent-Date: $a
333H?D?Date: $a
334H?F?Resent-From: $q
335H?F?From: $q
336H?x?Full-Name: $x
337HSubject:
338# HPosted-Date: $a
339# H?l?Received-Date: $b
340H?M?Resent-Message-Id: <$t.$i@$j>
341H?M?Message-Id: <$t.$i@$j>
342#
343######################################################################
344######################################################################
345#####
346#####			REWRITING RULES
347#####
348######################################################################
349######################################################################
350
351undivert(9)dnl
352
353###########################################
354###  Rulset 3 -- Name Canonicalization  ###
355###########################################
356S3
357
358# handle null input (translate to <@> special case)
359R$@			$@ <@>
360
361# basic textual canonicalization -- note RFC733 heuristic here
362R$*<$*>$*<$*>$*		$2$3<$4>$5			strip multiple <> <>
363R$*<$*<$+>$*>$*		<$3>$5				2-level <> nesting
364R$*<>$*			$@ <@>				MAIL FROM:<> case
365R$*<$+>$*		$2				basic RFC821/822 parsing
366
367# handle list:; syntax as special case
368R$*:;$*			$@ $1 :; <@>
369
370# make sure <@a,@b,@c:user@d> syntax is easy to parse -- undone later
371R@ $+ , $+		@ $1 : $2			change all "," to ":"
372
373# localize and dispose of route-based addresses
374R@ $+ : $+		$@ $>96 < @$1 > : $2		handle <route-addr>
375
376# find focus for list syntax
377R $+ : $* ; @ $+	$@ $>96 $1 : $2 ; < @ $3 >	list syntax
378R $+ : $* ;		$@ $1 : $2;			list syntax
379
380# find focus for @ syntax addresses
381R$+ @ $+		$: $1 < @ $2 >			focus on domain
382R$+ < $+ @ $+ >		$1 $2 < @ $3 >			move gaze right
383R$+ < @ $+ >		$@ $>96 $1 < @ $2 >		already canonical
384
385# do some sanity checking
386R$* < @ $* : $* > $*	$1 < @ $2 $3 > $4		nix colons in addrs
387
388ifdef(`_NO_UUCP_', `dnl',
389`# convert old-style addresses to a domain-based address
390R$- ! $+		$@ $>96 $2 < @ $1 .UUCP >	resolve uucp names
391R$+ . $- ! $+		$@ $>96 $3 < @ $1 . $2 >		domain uucps
392R$+ ! $+		$@ $>96 $2 < @ $1 .UUCP >	uucp subdomains')
393
394# if we have % signs, take the rightmost one
395R$* % $*		$1 @ $2				First make them all @s.
396R$* @ $* @ $*		$1 % $2 @ $3			Undo all but the last.
397R$* @ $*		$@ $>96 $1 < @ $2 >		Insert < > and finish
398
399# else we must be a local name
400
401
402################################################
403###  Ruleset 96 -- bottom half of ruleset 3  ###
404################################################
405
406#  At this point, everything should be in a "local_part<@domain>extra" format.
407S96
408
409# handle special cases for local names
410R$* < @ localhost > $*		$: $1 < @ $j . > $2		no domain at all
411R$* < @ localhost . $m > $*	$: $1 < @ $j . > $2		local domain
412ifdef(`_NO_UUCP_', `dnl',
413`R$* < @ localhost . UUCP > $*	$: $1 < @ $j . > $2		.UUCP domain')
414R$* < @ [ $+ ] > $*		$: $1 < @@ [ $2 ] > $3		mark [a.b.c.d]
415R$* < @@ $=w > $*		$: $1 < @ $j . > $3		self-literal
416R$* < @@ $+ > $*		$@ $1 < @ $2 > $3		canon IP addr
417ifdef(`DOMAIN_TABLE', `
418# look up domains in the domain table
419R$* < @ $+ > $*			$: $1 < @ $(domaintable $2 $) > $3',
420`dnl')
421undivert(2)dnl
422
423ifdef(`_NO_UUCP_', `dnl',
424`ifdef(`UUCP_RELAY',
425`# pass UUCP addresses straight through
426R$* < @ $+ . UUCP > $*		$@ $1 < @ $2 . UUCP . > $3',
427`# if really UUCP, handle it immediately
428ifdef(`_CLASS_U_',
429`R$* < @ $=U . UUCP > $*	$@ $1 < @ $2 . UUCP . > $3', `dnl')
430ifdef(`_CLASS_V_',
431`R$* < @ $=V . UUCP > $*	$@ $1 < @ $2 . UUCP . > $3', `dnl')
432ifdef(`_CLASS_W_',
433`R$* < @ $=W . UUCP > $*	$@ $1 < @ $2 . UUCP . > $3', `dnl')
434ifdef(`_CLASS_X_',
435`R$* < @ $=X . UUCP > $*	$@ $1 < @ $2 . UUCP . > $3', `dnl')
436ifdef(`_CLASS_Y_',
437`R$* < @ $=Y . UUCP > $*	$@ $1 < @ $2 . UUCP . > $3', `dnl')
438
439# try UUCP traffic as a local address
440R$* < @ $+ . UUCP > $*		$: $1 < @ $[ $2 $] . UUCP . > $3
441R$* < @ $+ . . UUCP . > $*		$@ $1 < @ $2 . > $3')
442')
443ifdef(`_NO_CANONIFY_', `dnl',
444`# pass to name server to make hostname canonical
445R$* < @ $* $~P > $*		$: $1 < @ $[ $2 $3 $] > $4')
446
447# local host aliases and pseudo-domains are always canonical
448R$* < @ $=w > $*		$: $1 < @ $2 . > $3
449R$* < @ $* $=P > $*		$: $1 < @ $2 $3 . > $4
450R$* < @ $* . . > $*		$1 < @ $2 . > $3
451
452# if this is the local hostname, make sure we treat is as canonical
453R$* < @ $j > $*			$: $1 < @ $j . > $2
454
455
456##################################################
457###  Ruleset 4 -- Final Output Post-rewriting  ###
458##################################################
459S4
460
461R$*<@>			$@ $1				handle <> and list:;
462
463# strip trailing dot off possibly canonical name
464R$* < @ $+ . > $*	$1 < @ $2 > $3
465
466# externalize local domain info
467R$* < $+ > $*		$1 $2 $3			defocus
468R@ $+ : @ $+ : $+	@ $1 , @ $2 : $3		<route-addr> canonical
469R@ $*			$@ @ $1				... and exit
470
471ifdef(`_NO_UUCP_', `dnl',
472`# UUCP must always be presented in old form
473R$+ @ $- . UUCP		$2!$1				u@h.UUCP => h!u')
474
475# delete duplicate local names
476R$+ % $=w @ $=w		$1 @ $j				u%host@host => u@host
477
478
479
480##############################################################
481###   Ruleset 97 -- recanonicalize and call ruleset zero   ###
482###		   (used for recursive calls)		   ###
483##############################################################
484
485S`'97
486R$*			$: $>3 $1
487R$*			$@ $>0 $1
488
489
490######################################
491###   Ruleset 0 -- Parse Address   ###
492######################################
493
494S0
495
496R<@>			$#_LOCAL_ $: <@>		special case error msgs
497R$* : $* ;		$#error $@ USAGE $: "list:; syntax illegal for recipient addresses"
498R<@ $+>			$#error $@ USAGE $: "user address required"
499R$* <$* : $* > $*	$#error $@ USAGE $: "colon illegal in host name part"
500R$* < @ . > $*		$#error $@ USAGE $: "invalid host name"
501
502ifdef(`_MAILER_smtp_',
503`# handle numeric address spec
504R$* < @ [ $+ ] > $*	$: $>98 $1 < @ [ $2 ] > $3	numeric internet spec
505R$* < @ [ $+ ] > $*	$#_SMTP_ $@ [$2] $: $1 < @ [$2] > $3	still numeric: send',
506	`dnl')
507
508# now delete the local info -- note $=O to find characters that cause forwarding
509R$* < @ > $*		$@ $>97 $1		user@ => user
510R< @ $=w . > : $*	$@ $>97 $2		@here:... -> ...
511R$* $=O $* < @ $=w . >	$@ $>97 $1 $2 $3		...@here -> ...
512
513# handle local hacks
514R$*			$: $>98 $1
515
516# short circuit local delivery so forwarded email works
517ifdef(`_LOCAL_NOT_STICKY_',
518`R$=L < @ $=w . >		$#_LOCAL_ $: @ $1			special local names
519R$+ < @ $=w . >		$#_LOCAL_ $: $1			dispose directly',
520`R$+ < @ $=w . >		$: $1 < @ $2 . @ $H >		first try hub
521R$+ < $+ @ $+ >		$#_LOCAL_ $: $1			yep ....
522R$=D . $+ < $+ @ >	$#_LOCAL_ $: $1 . $2		dotted name?
523R$+ < $+ @ >		$#_LOCAL_ $: @ $1			nope, local address')
524ifdef(`MAILER_TABLE',
525`
526# not local -- try mailer table lookup
527R$* <@ $+ > $*		$: < $2 > $1 < @ $2 > $3	extract host name
528R< $+ . > $*		$: < $1 > $2			strip trailing dot
529R< $+ > $*		$: < $(mailertable $1 $) > $2	lookup
530R< $- : $+ > $*		$# $1 $@ $2 $: $3		check -- resolved?
531R< $+ > $*		$: $>90 <$1> $2			try domain',
532`dnl')
533undivert(4)dnl
534
535ifdef(`_NO_UUCP_', `dnl',
536`# resolve remotely connected UUCP links (if any)
537ifdef(`_CLASS_V_',
538`R$* < @ $=V . UUCP . > $*		$: $>95 < $V > $1 <@$2.UUCP.> $3',
539	`dnl')
540ifdef(`_CLASS_W_',
541`R$* < @ $=W . UUCP . > $*		$: $>95 < $W > $1 <@$2.UUCP.> $3',
542	`dnl')
543ifdef(`_CLASS_X_',
544`R$* < @ $=X . UUCP . > $*		$: $>95 < $X > $1 <@$2.UUCP.> $3',
545	`dnl')')
546
547# resolve fake top level domains by forwarding to other hosts
548ifdef(`BITNET_RELAY',
549`R$*<@$+.BITNET.>$*	$: $>95 < $B > $1 <@$2.BITNET.> $3	user@host.BITNET',
550	`dnl')
551ifdef(`_MAILER_pop_',
552`R$+ < @ POP. >		$#pop $: $1			user@POP',
553	`dnl')
554ifdef(`_MAILER_fax_',
555`R$+ < @ $+ .FAX. >	$#fax $@ $2 $: $1		user@host.FAX',
556`ifdef(`FAX_RELAY',
557`R$*<@$+.FAX.>$*		$: $>95 < $F > $1 <@$2.FAX.> $3	user@host.FAX',
558	`dnl')')
559
560ifdef(`UUCP_RELAY',
561`# forward non-local UUCP traffic to our UUCP relay
562R$*<@$*.UUCP.>$*		$: $>95 < $Y > $1 <@$2.UUCP.> $3	uucp mail',
563`ifdef(`_MAILER_uucp_',
564`# forward other UUCP traffic straight to UUCP
565R$* < @ $+ .UUCP. > $*		$#uucp $@ $2 $: $1 < @ $2 .UUCP. > $3	user@host.UUCP',
566	`dnl')')
567ifdef(`_MAILER_usenet_', `
568# addresses sent to net.group.USENET will get forwarded to a newsgroup
569R$+ . USENET		$#usenet $: $1',
570	`dnl')
571
572ifdef(`_LOCAL_RULES_',
573`# figure out what should stay in our local mail system
574undivert(1)', `dnl')
575
576# pass names that still have a host to a smarthost (if defined)
577R$* < @ $* > $*		$: $>95 < $S > $1 < @ $2 > $3	glue on smarthost name
578
579# deal with other remote names
580ifdef(`_MAILER_smtp_',
581`R$* < @$* > $*		$#_SMTP_ $@ $2 $: $1 < @ $2 > $3		user@host.domain',
582`R$* < @$* > $*		$#error $@NOHOST $: Unrecognized host name $2')
583
584# if this is quoted, strip the quotes and try again
585R$+			$: $(dequote $1 $)		strip quotes
586R$+ $=O $+		$@ $>97 $1 $2 $3			try again
587
588# handle locally delivered names
589R$=L			$#_LOCAL_ $: @ $1			special local names
590R$+			$#_LOCAL_ $: $1			regular local names
591
592###########################################################################
593###   Ruleset 5 -- special rewriting after aliases have been expanded   ###
594###		   (new sendmail only)					###
595###########################################################################
596
597S5
598
599# if we have a "special dotted user", convert it back to the base name
600R$=D . *		$#_LOCAL_ $: $1
601R$=D . $+		$#_LOCAL_ $: $1 . *
602
603# see if we have a relay or a hub
604R$+			$: < $R > $1			try relay
605R< > $+			$: < $H > $1			try hub
606R< > $+			$@ $1				nope, give up
607R< $- : $+ > $+		$: $>95 < $1 : $2 > $3 < @ $2 >
608R< $+ > $+		$@ $>95 < $1 > $2 < @ $1 >
609ifdef(`MAILER_TABLE',
610`
611
612###################################################################
613###  Ruleset 90 -- try domain part of mailertable entry 	###
614###		   (new sendmail only)				###
615###################################################################
616
617S90
618R$* <$- . $+ > $*	$: $1$2 < $(mailertable .$3 $@ $1$2 $@ $2 $) > $4
619R$* <$- : $+ > $*	$# $2 $@ $3 $: $4		check -- resolved?
620R$* < . $+ > $*		$@ $>90 $1 . <$2> $3		no -- strip & try again
621R$* < $* > $*		$: < $(mailertable . $@ $1$2 $) > $3	try "."
622R<$- : $+ > $*		$# $1 $@ $2 $: $3		"." found?
623R< $* > $*		$@ $2				no mailertable match',
624`dnl')
625
626###################################################################
627###  Ruleset 95 -- canonify mailer:host syntax to triple	###
628###################################################################
629
630S95
631R< > $*			$@ $1				strip off null relay
632R< $- : $+ > $*		$# $1 $@ $2 $: $3		try qualified mailer
633R< $=w > $*		$@ $2				delete local host
634R< $+ > $*		$#_RELAY_ $@ $1 $: $2		use unqualified mailer
635
636###################################################################
637###  Ruleset 98 -- local part of ruleset zero (can be null)	###
638###################################################################
639
640S98
641undivert(3)dnl
642#
643######################################################################
644######################################################################
645#####
646`#####			MAILER DEFINITIONS'
647#####
648######################################################################
649######################################################################
650undivert(7)dnl
651