1 2 3 NEW SENDMAIL CONFIGURATION FILES 4 5 Eric Allman <eric@CS.Berkeley.EDU> 6 7 @(#)README 8.25 (Berkeley) 02/10/94 8 9 10This document describes the sendmail configuration files being used 11at Berkeley. These use features in the new (R8) sendmail, and although 12there is an ``OLDSENDMAIL'' mode, they haven't really been tested on 13old versions of sendmail and cannot be expected to work well. 14 15These configuration files are probably not as general as previous 16versions, and don't handle as many of the weird cases automagically. 17I was able to simplify by them for two reasons. First, the network 18has become more consistent -- for example, at this point, everyone 19on the internet is supposed to be running a name server, so hacks to 20handle NIC-registered hosts can go away. Second, I assumed that a 21subdomain would be running SMTP internally -- UUCP is presumed to be 22a long-haul protocol. I realize that this is not universal, but it 23does describe the vast majority of sites with which I am familiar, 24including those outside the US. 25 26Of course, the downside of this is that if you do live in a weird 27world, things are going to get weirder for you. I'm sorry about that, 28but at the time we at Berkeley had a problem, and it seemed like the 29right thing to do. 30 31This package requires a post-V7 version of m4; if you are running the 324.2bsd, SysV.2, or 7th Edition version, I suggest finding a friend with 33a newer version. You can m4-expand on their system, then run locally. 34SunOS's /usr/5bin/m4 or BSD-Net/2's m4 both work. GNU m4 version 1.1 35also works. Unfortunately, I'm told that the M4 on BSDI 1.0 doesn't 36work -- you'll have to use a Net/2 or GNU version. 37 38IF YOU DON'T HAVE A BERKELEY MAKE, don't despair! Just run 39"m4 foo.mc > foo.cf" -- that should be all you need. There is also 40a fairly crude (but functional) Makefile.dist that works on the 41old version of make. 42 43To get started, you may want to look at tcpproto.mc (for TCP-only 44sites), uucpproto.mc (for UUCP-only sites), and clientproto.mc (for 45clusters of clients using a single mail host). Others are versions 46that we use at Berkeley, although not all are in current use. For 47example, ucbarpa has gone away, but I've left ucbarpa.mc in because 48it demonstrates some interesting techniques. 49 50I'm not pretending that this README describes everything that these 51configuration files can do; clever people can probably tweak them 52to great effect. But it should get you started. 53 54******************************************************************* 55*** BE SURE YOU CUSTOMIZE THESE FILES! They have some *** 56*** Berkeley-specific assumptions built in, such as the name *** 57*** of our UUCP-relay. You'll want to create your own domain *** 58*** description, and use that in place of domain/Berkeley.m4. *** 59******************************************************************* 60 61 62+--------------------------+ 63| INTRODUCTION AND EXAMPLE | 64+--------------------------+ 65 66Configuration files are contained in the subdirectory "cf", with a 67suffix ".mc". They must be run through "m4" to produce a ".cf" file. 68 69Let's examine a typical .mc file (cf/cs-exposed.mc): 70 71 divert(-1) 72 # 73 # Copyright (c) 1983 Eric P. Allman 74 # Copyright (c) 1988 The Regents of the University of California. 75 # All rights reserved. 76 # 77 # Redistribution and use in source and binary forms are permitted 78 # provided that the above copyright notice and this paragraph are 79 # duplicated in all such forms and that any documentation, 80 # advertising materials, and other materials related to such 81 # distribution and use acknowledge that the software was developed 82 # by the University of California, Berkeley. The name of the 83 # University may not be used to endorse or promote products derived 84 # from this software without specific prior written permission. 85 # THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR 86 # IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED 87 # WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. 88 # 89 90The divert(-1) will delete the crud in the resulting output file. 91The copyright notice is what your lawyers require. Our lawyers require 92the one that I've included in my files. A copyleft is a copyright by 93another name. 94 95The next line MUST be 96 97 include(`../m4/cf.m4') 98 99This will pull in the M4 macros you will need to make sense of 100everything else. As the saying goes, don't think about it, just 101do it. If you don't do it, don't bother reading the rest of this 102file. 103 104 VERSIONID(`<SCCS or RCS version id>') 105 106VERSIONID is a macro that stuffs the version information into the 107resulting file. We use SCCS; you could use RCS, something else, or 108omit it completely. This is not the same as the version id included 109in SMTP greeting messages -- this is defined in m4/version.m4. 110 111 DOMAIN(cs.exposed) 112 113This example exposes the host inside of the CS subdomain -- that is, 114it doesn't try to hide the name of the workstation to the outside 115world. Changing this to DOMAIN(cs.hidden) would have made outgoing 116messages refer to "<username>@CS.Berkeley.EDU" instead of using the 117local hostname. Internally this is effected by using 118"MASQUERADE_AS(CS.Berkeley.EDU)". 119 120 MAILER(smtp) 121 122These describe the mailers used at the default CS site site. The 123local mailer is always included automatically. 124 125 126+--------+ 127| OSTYPE | 128+--------+ 129 130Note that cf/cs-exposed.mc omits an OSTYPE macro -- this assumes 131default Computer Science Division environment. There are several 132explicit environments available: bsd4.3, bsd4.4, hpux, irix, osf1, 133riscos4.5, sunos3.5, sunos4.1, and ultrix4.1. These change things 134like the location of the alias file and queue directory. Some of 135these files are identical to one another. 136 137Operating system definitions are easy to write. They may define 138the following variables (everything defaults, so an ostype file 139may be empty). 140 141ALIAS_FILE [/etc/aliases] The location of the text version 142 of the alias file(s). It can be a comma-separated 143 list of names. 144HELP_FILE [/usr/lib/sendmail.hf] The name of the file 145 containing information printed in response to 146 the SMTP HELP command. 147QUEUE_DIR [/var/spool/mqueue] The directory containing 148 queue files. 149STATUS_FILE [/etc/sendmail.st] The file containing status 150 information. 151LOCAL_MAILER_PATH [/bin/mail] The program used to deliver local mail. 152LOCAL_MAILER_FLAGS [rmn] The flags used by the local mailer. The 153 flags lsDFM are always included. 154LOCAL_MAILER_ARGS [mail -d $u] The arguments passed to deliver local 155 mail. 156LOCAL_SHELL_PATH [/bin/sh] The shell used to deliver piped email. 157LOCAL_SHELL_FLAGS [eu] The flags used by the shell mailer. The 158 flags lsDFM are always included. 159LOCAL_SHELL_ARGS [sh -c $u] The arguments passed to deliver "prog" 160 mail. 161USENET_MAILER_PATH [/usr/lib/news/inews] The name of the program 162 used to submit news. 163USENET_MAILER_FLAGS [rlsDFMmn] The mailer flags for the usenet mailer. 164USENET_MAILER_ARGS [-m -h -n] The command line arguments for the 165 usenet mailer. 166USENET_MAILER_MAX [100000] The maximum size of messages that will 167 be accepted by the usenet mailer. 168SMTP_MAILER_FLAGS [undefined] Flags added to SMTP mailer. Default 169 flags are `mDFMUX' (and `a' for esmtp mailer). 170SMTP_MAILER_MAX [undefined] The maximum size of messages that will 171 be transported using the smtp or esmtp mailers. 172UUCP_MAILER_FLAGS [undefined] Flags added to UUCP mailer. Default 173 flags are `DFMhuU' (and `m' for suucp mailer, minus 174 `U' for uucp-dom mailer). 175UUCP_MAILER_ARGS [uux - -r -z -a$f -gC $h!rmail ($u)] The arguments 176 passed to the UUCP mailer. 177UUCP_MAX_SIZE [100000] The maximum size message accepted for 178 transmission by the UUCP mailers. 179FAX_MAILER_PATH [/usr/local/lib/fax/mailfax] The program used to 180 submit FAX messages. 181FAX_MAILER_MAX [100000] The maximum size message accepted for 182 transmission by FAX. 183 184+---------+ 185| DOMAINS | 186+---------+ 187 188You will probably want to collect domain-dependent defines into one 189file, referenced by the DOMAIN macro. For example, our Berkeley 190domain file includes definitions for several internal distinguished 191hosts: 192 193UUCP_RELAY The host that will forward UUCP-addressed email. 194 If not defined, all UUCP sites must be directly 195 connected. 196BITNET_RELAY The host that will forward BITNET-addressed email. 197 If not defined, the .BITNET pseudo-domain won't work. 198LOCAL_RELAY The site that will handle unqualified names -- that 199 is, names with out an @domain extension. If not set, 200 they are assumed to belong on this machine. This 201 allows you to have a central site to store a 202 company- or department-wide alias database. This 203 only works at small sites, and there are better 204 methods. 205 206Each of these can be either ``mailer:hostname'' (in which case the 207mailer is the internal mailer name, such as ``suucp'' and the hostname 208is the name of the host as appropriate for that mailer) or just a 209``hostname'', in which case a default mailer type (usually ``relay'', 210a variant on SMTP) is used. WARNING: if you have a wildcard MX 211record matching your domain, you probably want to define these to 212have a trailing dot so that you won't get the mail diverted back 213to yourself. 214 215The domain file can also be used to define a domain name, if needed 216(using "DD<domain>") and set certain site-wide features. If all hosts 217at your site masquerade behind one email name, you could also use 218MASQUERADE_AS here. 219 220You do not have to define a domain -- in particular, if you are a 221single machine sitting off somewhere, it is probably more work than 222it's worth. This is just a mechanism for combining "domain dependent 223knowledge" into one place. 224 225+---------+ 226| MAILERS | 227+---------+ 228 229There are fewer mailers supported in this version than the previous 230version, owing mostly to a simpler world. 231 232local The local and prog mailers. You will almost always 233 need these; the only exception is if you relay ALL 234 your mail to another site. This mailer is included 235 automatically. 236 237smtp The Simple Mail Transport Protocol mailer. This does 238 not hide hosts behind a gateway or another other 239 such hack; it assumes a world where everyone is 240 running the name server. This file actually defines 241 three mailers: "smtp" for regular (old-style) SMTP to 242 other servers, "esmtp" for extended SMTP to other 243 servers, and "relay" for transmission to our 244 RELAY_HOST or MAILER_HUB. 245 246uucp The Unix-to-Unix Copy Program mailer. Actually, this 247 defines two mailers, "uucp" and "suucp". The latter 248 is for when you know that the UUCP mailer at the other 249 end can handle multiple recipients in one transfer. 250 When you invoke this, sendmail looks for all names in 251 the $=U class and sends them to the uucp-old mailer; all 252 names in the $=Y class are sent to uucp-new; and all 253 names in the $=Z class are sent to uucp-uudom. Note that 254 this is a function of what version of rmail runs on 255 the receiving end, and hence may be out of your control. 256 If smtp is defined, it also defines "uucp-dom" and 257 "uucp-uudom" mailers that use domain-style rewriting. 258 See the section below describing UUCP mailers in more 259 detail. 260 261usenet Usenet (network news) delivery. If this is specified, 262 an extra rule is added to ruleset 0 that forwards all 263 local email for users named ``group.usenet'' to the 264 ``inews'' program. Note that this works for all groups, 265 and may be considered a security problem. 266 267fax Facsimile transmission. This is experimental and based 268 on Sam Leffler's FlexFAX software. For more information, 269 see below. 270 271pop Post Office Protocol. 272 273 274+----------+ 275| FEATURES | 276+----------+ 277 278Special features can be requested using the "FEATURE" macro. For 279example, the .mc line: 280 281 FEATURE(use_cw_file) 282 283tells sendmail that you want to have it read an /etc/sendmail.cw 284file to get values for class $=w. The FEATURE may contain a single 285optional parameter -- for example: 286 287 FEATURE(mailertable, dbm /usr/lib/mailertable) 288 289Available features are: 290 291use_cw_file Read the file /etc/sendmail.cw file to get alternate 292 names for this host. This might be used if you were 293 on a host that MXed for a dynamic set of other 294 hosts. If the set is static, just including the line 295 "Cw<name1> <name2> ..." is probably superior. 296 The actual filename can be overridden by redefining 297 confCW_FILE. 298 299redirect Reject all mail addressed to "address.REDIRECT" with 300 a ``551 User not local; please try <address>'' message. 301 If this is set, you can alias people who have left 302 to their new address with ".REDIRECT" appended. 303 304nouucp Don't do anything special with UUCP addresses at all. 305 306nocanonify Don't pass addresses to $[ ... $] for canonification. 307 This would generally only be used by sites that only 308 act as mail gateways or which have user agents that do 309 full canonification themselves. You may also want to 310 use "define(`confBIND_OPTS',`-DNSRCH -DEFNAMES')" to 311 turn off the usual resolver options that do a similar 312 thing. 313 314notsticky By default, email sent to "user@local.host" are marked 315 as "sticky" -- that is, the local addresses aren't 316 matched against UDB and don't go through ruleset 5. 317 This features disables this treatment. It would 318 normally be used on network gateway machines. 319 320mailertable Include a "mailer table" which can be used to override 321 routing for particular domains. The argument of the 322 FEATURE may be the key definition. If none is specified, 323 the definition used is: 324 hash -o /etc/mailertable 325 Keys in this database are fully qualified domain names 326 or partial domains preceded by a dot -- for example, 327 "vangogh.CS.Berkeley.EDU" or ".CS.Berkeley.EDU". 328 Values must be of the form: 329 mailer:domain 330 where "mailer" is the internal mailer name, and "domain" 331 is where to send the message. These maps are not 332 reflected into the message header. 333 334domaintable Include a "domain table" which can be used to provide 335 full domains on unqualified (single word) hosts. The 336 argument of the FEATURE may be the key definition. If 337 none is specified, the definition used is: 338 hash -o /etc/domaintable 339 The key in this table is the unqualified host name; the 340 value is the fully qualified domain. Anything in the 341 domaintable is reflected into headers; that is, this 342 is done in ruleset 3. 343 344bitdomain Look up bitnet hosts in a table to try to turn them into 345 internet addresses. The table can be built using the 346 bitdomain program contributed by John Gardiner Myers. 347 The argument of the FEATURE may be the key definition; if 348 none is specified, the definition used is: 349 hash -o /etc/bitdomain.db 350 Keys are the bitnet hostname; values are the corresponding 351 internet hostname. 352 353uucpdomain Similar feature for UUCP hosts. The default map definition 354 is: 355 hash -o /etc/uudomain.db 356 At the moment there is no automagic tool to build this 357 database. 358 359always_add_domain 360 Include the local host domain even on locally delivered 361 mail. Normally it is not added unless it is already 362 present. 363 364allmasquerade If masquerading is enabled (using MASQUERADE_AS), this 365 feature will cause recipient addresses to also masquerade 366 as being from the masquerade host. Normally they get 367 the local hostname. Although this may be right for 368 ordinary users, it can break local aliases. For example, 369 if you send to "localalias", the originating sendmail will 370 find that alias and send to all members, but send the 371 message with "To: localalias@masqueradehost". Since that 372 alias likely does not exist, replies will fail. Use this 373 feature ONLY if you can guarantee that the ENTIRE 374 namespace on your masquerade host supersets all the 375 local entries. 376 377nodns We aren't running DNS at our site (for example, 378 we are UUCP-only connected). It's hard to consider 379 this a "feature", but hey, it had to go somewhere. 380 381nullclient This is a special case -- it creates a stripped down 382 configuration file containing nothing but support for 383 forwarding all mail to a central hub via a local 384 SMTP-based network. The argument is the name of that 385 hub. 386 387 The only other feature that should be used in conjunction 388 with this one is "nocanonify" (this causes addresses to 389 be sent unqualified via the SMTP connection; normally 390 they are qualifed with the masquerade name, which 391 defaults to the name of the hub machine). No mailers 392 should be defined. No aliasing or forwarding is done. 393 394 395+-------+ 396| HACKS | 397+-------+ 398 399Some things just can't be called features. To make this clear, 400they go in the hack subdirectory and are referenced using the HACK 401macro. These will tend to be site-dependent. The release 402includes the Berkeley-dependent "cssubdomain" hack (that makes 403sendmail accept local names in either Berkeley.EDU or CS.Berkeley.EDU; 404this is intended as a short-term aid while we move hosts into 405subdomains. 406 407 408+--------------------+ 409| SITE CONFIGURATION | 410+--------------------+ 411 412Complex sites will need more local configuration information, such as 413lists of UUCP hosts they speak with directly. This can get a bit more 414tricky. For an example of a "complex" site, see cf/ucbvax.mc. 415 416The SITECONFIG macro allows you to indirectly reference site-dependent 417configuration information stored in the siteconfig subdirectory. For 418example, the line 419 420 SITECONFIG(uucp.ucbvax, ucbvax, U) 421 422reads the file uucp.ucbvax for local connection information. The 423second parameter is the local name (in this case just "ucbvax" since 424it is locally connected, and hence a UUCP hostname) and the name of 425the class in which to store the host information. Another SITECONFIG 426line reads 427 428 SITECONFIG(uucp.ucbarpa, ucbarpa.Berkeley.EDU, W) 429 430This says that the file uucp.ucbarpa contains the list of UUCP sites 431connected to ucbarpa.Berkeley.EDU. The $=W class will be used to 432store this list. [The machine ucbarpa is gone now, but I've left 433this out-of-date configuration file around to demonstrate how you 434might do this.] 435 436The siteconfig file (e.g., siteconfig/uucp.ucbvax.m4) contains nothing 437more than a sequence of SITE macros describing connectivity. For 438example: 439 440 SITE(cnmat) 441 SITE(sgi olympus) 442 443The second example demonstrates that you can use two names on the 444same line; these are usually aliases for the same host (or are at 445least in the same company). 446 447 448+--------------------+ 449| USING UUCP MAILERS | 450+--------------------+ 451 452It's hard to get UUCP mailers right because of the extremely ad hoc 453nature of UUCP addressing. These config files are really designed 454for domain-based addressing, even for UUCP sites. 455 456There are four UUCP mailers available. The choice of which one to 457use is partly a matter of local preferences and what is running at 458the other end of your UUCP connection. Unlike good protocols that 459define what will go over the wire, UUCP uses the policy that you 460should do what is right for the other end; if they change, you have 461to change. This makes it hard to do the right thing, and discourages 462people from updating their software. In general, if you can avoid 463UUCP, please do. 464 465The major choice is whether to go for a domainized scheme or a 466non-domainized scheme. This depends entirely on what the other 467end will recognize. If at all possible, you should encourage the 468other end to go to a domain-based system -- non-domainized addresses 469don't work entirely properly. 470 471The four mailers are: 472 473 uucp-old (obsolete name: "uucp") 474 This is the oldest, the worst (but the closest to UUCP) way of 475 sending messages accros UUCP connections. It does bangify 476 everything and prepends $U (your UUCP name) to the sender's 477 address (which can already be a bang path itself). It can 478 only send to one address at a time, so it spends a lot of 479 time copying duplicates of messages. Avoid this if at all 480 possible. 481 482 uucp-new (obsolete name: "suucp") 483 The same as above, except that it assumes that in one rmail 484 command you can specify several recipients. It still has a 485 lot of other problems. 486 487 uucp-dom 488 This UUCP mailer keeps everything as domain addresses. 489 Basically, it uses the SMTP mailer rewriting rules. 490 491 Unfortunately, a lot of UUCP mailer transport agents require 492 bangified addresses in the envelope, although you can use 493 domain-based addresses in the message header. (The envelope 494 shows up as the From_ line on UNIX mail.) So.... 495 496 uucp-uudom 497 This is a cross between uucp-new (for the envelope addresses) 498 and uucp-dom (for the header addresses). It bangifies the 499 envelope sender (From_ line in messages) without adding the 500 local hostname, unless there is no host name on the address 501 at all (e.g., "wolf") or the host component is a UUCP host name 502 instead of a domain name ("somehost!wolf" instead of 503 "some.dom.ain!wolf"). 504 505Examples: 506 507We are on host grasp.insa-lyon.fr (UUCP host name "grasp"). The 508following summarizes the sender rewriting for various mailers. 509 510Mailer sender rewriting in the envelope 511------ ------ ------------------------- 512uucp-{old,new} wolf grasp!wolf 513uucp-dom wolf wolf@grasp.insa-lyon.fr 514uucp-uudom wolf grasp.insa-lyon.fr!wolf 515 516uucp-{old,new} wolf@fr.net grasp!fr.net!wolf 517uucp-dom wolf@fr.net wolf@fr.net 518uucp-uudom wolf@fr.net fr.net!wolf 519 520uucp-{old,new} somehost!wolf grasp!somehost!wolf 521uucp-dom somehost!wolf somehost!wolf@grasp.insa-lyon.fr 522uucp-uudom somehost!wolf grasp.insa-lyon.fr!somehost!wolf 523 524If you are using one of the domainized UUCP mailers, you really want 525to convert all UUCP addresses to domain format -- otherwise, it will 526do it for you (and probably not the way you expected). For example, 527if you have the address foo!bar!baz (and you are not sending to foo), 528the heuristics will add the @uucp.relay.name or @local.host.name to 529this address. However, if you map foo to foo.host.name first, it 530will not add the local hostname. You can do this using the uucpdomain 531feature. 532 533 534+-------------------+ 535| TWEAKING RULESETS | 536+-------------------+ 537 538For more complex configurations, you can define special rules. 539The macro LOCAL_RULE_3 introduces rules that are used in canonicalizing 540the names. Any modifications made here are reflected in the header. 541 542A common use is to convert old UUCP addreses to SMTP addresses using 543the UUCPSMTP macro. For example: 544 545 LOCAL_RULE_3 546 UUCPSMTP(decvax, decvax.dec.com) 547 UUCPSMTP(research, research.att.com) 548 549will cause addresses of the form "decvax!user" and "research!user" 550to be converted to "user@decvax.dec.com" and "user@research.att.com" 551respectively. 552 553This could also be used to look up hosts in a database map: 554 555 LOCAL_RULE_3 556 R$* < @ $+ > $* $: $1 < @ $(hostmap $2 $) > $3 557 558This map would be defined in the LOCAL_CONFIG portion, as shown below. 559 560Similarly, LOCAL_RULE_0 can be used to introduce new parsing rules. 561For example, new rules are needed to parse hostnames that you accept 562via MX records. For example, you might have: 563 564 LOCAL_RULE_0 565 R$+ <@ host.dom.ain.> $#uucp $@ cnmat $: $1 < @ host.dom.ain.> 566 567You would use this if you had installed an MX record for cnmat.Berkeley.EDU 568pointing at this host; this rule catches the message and forwards it on 569using UUCP. 570 571You can also tweak rulesets 1 and 2 using LOCAL_RULE_1 and LOCAL_RULE_2. 572These rulesets are normally empty. 573 574A similar macro is LOCAL_CONFIG. This introduces lines added after the 575boilerplate option setting but before rulesets, and can be used to 576declare local database maps or whatever. For example: 577 578 LOCAL_CONFIG 579 Khostmap hash /etc/hostmap.db 580 Kyplocal nis -m hosts.byname 581 582 583+---------------------------+ 584| MASQUERADING AND RELAYING | 585+---------------------------+ 586 587You can have your host masquerade as another using 588 589 MASQUERADE_AS(host.domain) 590 591This causes outgoing SMTP mail to be labeled as coming from the 592indicated domain, rather than $j. One normally masquerades as one 593of one's own subdomains (for example, it's unlikely that I would 594choose to masquerade as an MIT site). 595 596The masquerade name is not normally canonified, so it is important 597that it be your One True Name, that is, fully qualified and not a 598CNAME. 599 600there are always users that need to be "exposed" -- that is, their 601internal site name should be displayed instead of the masquerade name. 602Root is an example. You can add users to this list using 603 604 EXPOSED_USER(usernames) 605 606This adds users to class E; you could also use something like 607 608 FE/etc/sendmail.cE 609 610You can also arrange to relay all unqualified names (that is, names 611without @host) to a relay host. For example, if you have a central 612email server, you might relay to that host so that users don't have 613to have .forward files or aliases. You can do this using 614 615 define(`LOCAL_RELAY', mailer:hostname) 616 617The ``mailer:'' can be omitted, in which case the mailer defaults to 618"smtp". There are some user names that you don't want relayed, perhaps 619because of local aliases. A common example is root, which may be 620locally aliased. You can add entries to this list using 621 622 LOCAL_USER(usernames) 623 624This adds users to class L; you could also use something like 625 626 FL/etc/sendmail.cL 627 628If you want all incoming mail sent to a centralized hub, as for a 629shared /var/spool/mail scheme, use 630 631 define(`MAIL_HUB', mailer:hostname) 632 633Again, ``mailer:'' defaults to "smtp". If you define both LOCAL_RELAY 634and MAIL_HUB, unqualified names will be sent to the LOCAL_RELAY and 635other local names will be sent to MAIL_HUB. Names in $=L will be 636delivered locally, so you MUST have aliases or .forward files for them. 637 638For example, if are on machine mastodon.CS.Berkeley.EDU, the following 639combinations of settings will have the indicated effects: 640 641email sent to.... eric eric@mastodon.CS.Berkeley.EDU 642 643LOCAL_RELAY set to mail.CS.Berkeley.EDU (delivered locally) 644mail.CS.Berkeley.EDU 645 646MAIL_HUB set to mammoth.CS.Berkeley.EDU mammoth.CS.Berkeley.EDU 647mammoth.CS.Berkeley.EDU 648 649Both LOCAL_RELAY and mail.CS.Berkeley.EDU mammoth.CS.Berkeley.EDU 650MAIL_HUB set as above 651 652If you want all outgoing mail to go to a central relay site, define 653SMART_HOST as well. Briefly: 654 655 LOCAL_RELAY applies to unqualifed names (e.g., "eric"). 656 MAIL_HUB applies to names qualified with the name of the 657 local host (e.g., "eric@mastodon.CS.Berkeley.EDU"). 658 SMART_HOST applies to names qualified with other hosts. 659 660However, beware that other relays (e.g., UUCP_RELAY, BITNET_RELAY, and 661FAX_RELAY) take precedence over SMART_HOST, so if you really want 662absolutely everything to go to a single central site you will need to 663unset all the other relays -- or better yet, find or build a minimal 664config file that does this. 665 666 667+-------------------------------+ 668| NON-SMTP BASED CONFIGURATIONS | 669+-------------------------------+ 670 671These configuration files are designed primarily for use by SMTP-based 672sites. I don't pretend that they are well tuned for UUCP-only or 673UUCP-primarily nodes (the latter is defined as a small local net 674connected to the rest of the world via UUCP). However, there is one 675hook to handle some special cases. 676 677You can define a ``smart host'' that understands a richer address syntax 678using: 679 680 define(`SMART_HOST', mailer:hostname) 681 682In this case, the ``mailer:'' defaults to "relay". Any messages that 683can't be handled using the usual UUCP rules are passed to this host. 684 685If you are on a local SMTP-based net that connects to the outside 686world via UUCP, you can use LOCAL_NET_CONFIG to add appropriate rules. 687For example: 688 689 define(`SMART_HOST', suucp:uunet) 690 LOCAL_NET_CONFIG 691 R$* < @ $* .$m. > $* $#smtp $@ $2.$m. $: $1 < @ $2.$m. > $3 692 693This will cause all names that end in your domain name ($m) via 694SMTP; anything else will be sent via suucp (smart UUCP) to uunet. 695If you have FEATURE(nocanonify), you may need to omit the dots after 696the $m. If you are running a local DNS inside your domain which is 697not otherwise connected to the outside world, you probably want to 698use: 699 700 define(`SMART_HOST', smtp:fire.wall.com) 701 LOCAL_NET_CONFIG 702 R$* < @ $* . > $* $#smtp $@ $2. $: $1 < @ $2. > $3 703 704That is, send directly only to things you found in your DNS lookup; 705anything else goes through SMART_HOST. 706 707If you are not running DNS at all, it is important to use 708FEATURE(nodns) to avoid having sendmail queue everything waiting 709for the name server to come up. 710 711 712+-----------+ 713| WHO AM I? | 714+-----------+ 715 716Normally, the $j macro is automatically defined to be your fully 717qualified domain name (FQDN). Sendmail does this by getting your 718host name using gethostname and then calling gethostbyname on the 719result. For example, in some environments gethostname returns 720only the root of the host name (such as "foo"); gethostbyname is 721supposed to return the FQDN ("foo.bar.com"). In some (fairly rare) 722cases, gethostbyname may fail to return the FQDN. In this case 723you MUST define confDOMAIN_NAME to be your fully qualified domain 724name. This is usually done using: 725 726 Dmbar.com 727 define(`confDOMAIN_NAME', `$w.$m')dnl 728 729 730+--------------------+ 731| USING MAILERTABLES | 732+--------------------+ 733 734To use FEATURE(mailertable), you will have to create an external 735database containing the routing information for various domains. 736For example, a mailertable file in text format might be: 737 738 .my.domain xnet:%1.my.domain 739 uuhost1.my.domain suucp:uuhost1 740 .bitnet smtp:relay.bit.net 741 742This should normally be stored in /etc/mailertable. The actual 743database version of the mailertable is built using: 744 745 makemap hash /etc/mailertable.db < /etc/mailertable 746 747The semantics are simple. Any LHS entry that does not begin with 748a dot matches the full host name indicated. LHS entries beginning 749with a dot match anything ending with that domain name -- that is, 750they can be thought of as having a leading "*" wildcard. Matching 751is done in order of most-to-least qualified -- for example, even 752though ".my.domain" is listed first in the above example, an entry 753of "uuhost1.my.domain" will match the second entry since it is 754more explicit. 755 756The RHS should always be a "mailer:host" pair. The mailer is the 757configuration name of a mailer (that is, an `M' line in the 758sendmail.cf file). The "host" will be the hostname passed to 759that mailer. In domain-based matches (that is, those with leading 760dots) the "%1" may be used to interpolate the wildcarded part of 761the host name. For example, the first line above sends everything 762addressed to "anything.my.domain" to that same host name, but using 763the (presumably experimental) xnet mailer. 764 765 766+--------------------------------+ 767| USING USERDB TO MAP FULL NAMES | 768+--------------------------------+ 769 770The user database was not originally intended for mapping full names 771to login names (e.g., Eric.Allman => eric), but some people are using 772it that way. (I would recommend that you set up aliases for this 773purpose instead -- since you can specify multiple alias files, this 774is fairly easy.) The intent was to locate the default maildrop at 775a site, but allow you to override this by sending to a specific host. 776 777If you decide to set up the user database in this fashion, it is 778imperative that you also specify FEATURE(notsticky) -- otherwise, 779e-mail sent to Full.Name@local.host.name will be rejected. 780 781To build the internal form of the user databae, use: 782 783 makemap btree /usr/data/base.db < /usr/data/base.txt 784 785 786+------------------+ 787| FlexFAX SOFTWARE | 788+------------------+ 789 790Sam Leffler's FlexFAX software is still in beta test -- but he expects a 791public version out "later this week" [as of 3/1/93]. The following 792blurb is direct from Sam: 793 794 $Header: /usr/people/sam/fax/RCS/HOWTO,v 1.14 93/05/24 11:42:16 sam Exp $ 795 796 How To Obtain This Software (in case all you get is this file) 797 -------------------------------------------------------------- 798 The source code is available for public ftp on 799 sgi.com sgi/fax/v2.1.src.tar.Z 800 (192.48.153.1) 801 802 You can also obtain inst'able images for Silicon Graphics machines from 803 sgi.com sgi/fax/v2.1.inst.tar 804 (192.48.153.1) 805 806 For example, 807 % ftp -n sgi.com 808 .... 809 ftp> user anonymous 810 ... <type in password> 811 ftp> cd sgi/fax 812 ftp> binary 813 ftp> get v2.1.src.tar.Z 814 815 In general, the latest version of the 2.1 release of the software is 816 always available as "v2.1.src.tar.Z" or "v2.1.inst.tar" in the ftp 817 directory. This file is a link to the appropriate released version (so 818 don't waste your time retrieving the linked file as well!) Any files of 819 the form v2.1.*.patch are shell scripts that can be used to patch older 820 versions of the source code. For example, the file v2.1.0.patch would 821 contain patches to update v2.1.0.tar.Z. (Note to beta testers: this is 822 different than the naming conventions used during beta testing.) Patch 823 files only work to go between consecutive versions, so if you are 824 multiple versions behind the latest release, you will need to apply 825 each patch file between your current version and the latest. 826 827 828 Obtaining the Software by Electronic Mail 829 ----------------------------------------- 830 Do not send me requests for the software; they will be ignored (without 831 response). If you cannot use FTP at all, there is a service called 832 "ftpmail" available from gatekeeper.dec.com: you can send e-mail to 833 this machine and it will use FTP to retrieve files for you and send you 834 the files back again via e-mail. To find out more about the ftpmail 835 service, send a message to "ftpmail@gatekeeper.dec.com" whose body 836 consists of the single line "help". 837 838 839 Obtaining the Software Within Silicon Graphics 840 ---------------------------------------------- 841 Internal to Silicon Graphics there are inst'able images on the host 842 flake.asd in the directory /usr/dist. Thus you can do something like: 843 844 % inst -f flake.asd.sgi.com:/usr/dist/flexfax 845 846 to install the latest version of the software on your machine. 847 848 849 What to do Once You've Retrieved Stuff 850 -------------------------------------- 851 The external distributions come in a compressed or uncompressed tar 852 file. To extract the source distribution: 853 854 % zcat v2.1.src.tar.Z | tar xf - 855 856 (uncompress and extract individual files in current directory). To 857 unpack and install the client portion of the inst'able distribution: 858 859 % mkdir dist 860 % cd dist; tar xf ../v2.1.inst.tar; cd .. 861 % inst -f dist/flexfax 862 ... 863 inst> go 864 865 (Note, the dist subdirectory is because some versions of inst fail if 866 the files are in the current directory.) Server binaries are also 867 included in the inst'able images as flexfax.server.*. They are not 868 installed by default, so to get them also you need to do: 869 870 % inst -f flexfax 871 ... 872 inst> install flexfax.server.* 873 inst> go 874 875 The SGI binaries were built for Version 4.0.5H of the IRIX operating 876 system. They should work w/o problem on earlier versions of the 877 system, but I have not fully tested this. Also, note that to install a 878 server on an SGI machine, you need to have installed the Display 879 PostScript execution environment product (dps_eoe). Otherwise, the fax 880 server will not be able to convert PostScript to facsimile for 881 transmission. 882 883 If you are working from the source distribution, look at the file 884 README in the top of the source tree. If you are working from the inst 885 images, the subsystem flexfax.man.readme contains the README file and 886 other useful pieces of information--the installed files are placed in 887 the directory /usr/local/doc/flexfax). Basically you will need to run 888 the faxaddmodem script to setup and configure your fax modem. Consult 889 the README file and the manual page for faxaddmodem for information. 890 891 892 FlexFAX Mail List 893 ----------------- 894 A mailing list for users of this software is located on sgi.com. 895 If you want to join this mailing list or have a list-related request 896 such as getting your name removed from it, send a request to 897 898 majordomo@whizzer.wpd.sgi.com 899 900 For example, to subscribe, send the line "subscribe flexfax" in 901 the body of your message. The line "help" will return a list of 902 the commands understood by the mailing list management software. 903 904 Submissions (including bug reports) should be directed to: 905 906 flexfax@sgi.com 907 908 When corresponding about this software please always specify what 909 version you have, what system you're running on, and, if the problem is 910 specific to your modem, identify the modem and firmware revision. 911 912 913+--------------------------------+ 914| TWEAKING CONFIGURATION OPTIONS | 915+--------------------------------+ 916 917There are a large number of configuration options that don't normally 918need to be changed. However, if you feel you need to tweak them, you 919can define the following M4 variables. This list is shown in four 920columns: the name you define, the default value for that definition, 921the option or macro that is affected (either Ox for an option or Dx 922for a macro), and a brief description. Greater detail of the semantics 923can be found in the Installation and Operations Guide. 924 925Some options are likely to be deprecated in future versions -- that is, 926the option is only included to provide back-compatibility. These are 927marked with "*". 928 929Remember that these options are M4 variables, and hence may need to 930be quoted. In particular, arguments with commas will usually have to 931be ``double quoted, like this phrase'' to avoid having the comma 932confuse things. This is common for alias file definitions and for 933the read timeout. 934 935M4 Variable Name Default Mac/Opt Description 936================ ======= ======= =========== 937confMAILER_NAME MAILER-DAEMON Dn The sender name used for 938 internally generated 939 outgoing messages. 940confFROM_LINE From $g $d Dl The From_ line used when 941 sending to files or programs. 942confFROM_HEADER $?x$x <$g>$|$g$. The format of an internally 943 Dq generated From: address. 944confOPERATORS .:%@!^/[] Do Address operator characters. 945confSMTP_LOGIN_MSG $j Sendmail $v/$Z ready at $b 946 De The initial (spontaneous) 947 SMTP greeting message. 948confSEVEN_BIT_INPUT False O7 Force input to seven bits? 949confALIAS_WAIT 10 Oa Wait (in minutes) for alias 950 file rebuild. 951confMIN_FREE_BLOCKS 4 Ob Minimum number of free blocks 952 on queue filesystem to accept 953 SMTP mail. 954confBLANK_SUB . OB Blank (space) substitution 955 character. 956confCON_EXPENSIVE False Oc Avoid connecting immediately 957 to mailers marked expensive? 958confCHECKPOINT_INTERVAL 10 OC Checkpoint queue files 959 every N recipients. 960confDELIVERY_MODE background Od Default delivery mode. 961confAUTO_REBUILD False OD Automatically rebuild 962 alias file if needed. 963confERROR_MODE (undefined) Oe Error message mode. 964confERROR_MESSAGE (undefined) OE Error message header/file. 965confSAVE_FROM_LINES False Of Save extra leading 966 From_ lines. 967confTEMP_FILE_MODE 0600 OF Temporary file mode. 968confDEF_GROUP_ID 1 Og Default group id. 969confMATCH_GECOS False OG Match GECOS field. 970confMAX_HOP 17 Oh Maximum hop count. 971confIGNORE_DOTS False Oi * Ignore dot as terminator 972 for incoming messages? 973confBIND_OPTS (empty) OI Default options for BIND. 974confMIME_FORMAT_ERRORS True Oj * Send error messages as MIME- 975 encapsulated messages per 976 RFC 1344. 977confFORWARD_PATH (undefined) OJ The colon-separated list of 978 places to search for .forward 979 files. 980confMCI_CACHE_SIZE 2 Ok Size of open connection cache. 981confMCI_CACHE_TIMEOUT 5m OK Open connection cache timeout. 982confUSE_ERRORS_TO False Ol * Use the Errors-To: header to 983 deliver error messages. This 984 should not be necessary because 985 of general acceptance of the 986 envelope/header distinction. 987confLOG_LEVEL 9 OL Log level. 988confME_TOO False Om Include sender in group 989 expansions. 990confCHECK_ALIASES True On Check RHS of aliases when 991 running newaliases. 992confOLD_STYLE_HEADERS True Oo * Assume that headers without 993 special chars are old style. 994confDAEMON_OPTIONS (undefined) OO SMTP daemon options. 995confPRIVACY_FLAGS authwarnings Op Privacy flags. 996confCOPY_ERRORS_TO (undefined) OP Address for additional copies 997 of all error messages. 998confQUEUE_FACTOR (undefined) Oq Slope of queue-only function 999confREAD_TIMEOUT (undefined) Or SMTP read timeouts. 1000confSAFE_QUEUE True Os * Commit all messages to disk 1001 before forking. 1002confMESSAGE_TIMEOUT 5d/4h OT Timeout for messages before 1003 sending error/warning message. 1004confTIME_ZONE USE_SYSTEM Ot Time zone info -- can be 1005 USE_SYSTEM to use the system's 1006 idea, USE_TZ to use the user's 1007 TZ envariable, or something 1008 else to force that value. 1009confDEF_USER_ID 1 Ou Default user id. 1010confUSERDB_SPEC (undefined) OU User database specification. 1011confFALLBACK_MX (undefined) OV Fallback MX host. 1012confTRY_NULL_MX_LIST False Ow If we are the best MX for a 1013 host and haven't made other 1014 arrangements, try connecting 1015 to the host directly; normally 1016 this would be a config error. 1017confQUEUE_LA 8 Ox Load average at which queue-only 1018 function kicks in. 1019confREFUSE_LA 12 OX Load average at which incoming 1020 SMTP connections are refused. 1021confWORK_RECIPIENT_FACTOR 1022 (undefined) Oy Cost of each recipient. 1023confSEPARATE_PROC False OY Run all deliveries in a 1024 separate process. 1025confWORK_CLASS_FACTOR (undefined) Oz Priority multiplier for class. 1026confWORK_TIME_FACTOR (undefined) OZ Cost of each delivery attempt. 1027confCW_FILE /etc/sendmail.cw Name of file used to get the 1028 Fw local additions to the $=w 1029 class. 1030confSMTP_MAILER smtp - The mailer name used when 1031 SMTP connectivity is required. 1032 Either "smtp" or "esmtp". 1033confLOCAL_MAILER local - The mailer name used when 1034 local connectivity is required. 1035 Almost always "local". 1036confRELAY_MAILER relay - The default mailer name used 1037 for relaying any mail (e.g., 1038 to a BITNET_RELAY, a 1039 SMART_HOST, or whatever). 1040 This can reasonably be "suucp" 1041 if you are on a UUCP-connected 1042 site. 1043confDOMAIN_NAME (undefined) Dj If defined, sets $j. 1044 1045 1046+-----------+ 1047| HIERARCHY | 1048+-----------+ 1049 1050Within this directory are several subdirectories, to wit: 1051 1052m4 General support routines. These are typically 1053 very important and should not be changed without 1054 very careful consideration. 1055 1056cf The configuration files themselves. They have 1057 ".mc" suffixes, and must be run through m4 to 1058 become complete. The resulting output should 1059 have a ".cf" suffix. 1060 1061ostype Definitions describing a particular operating 1062 system type. These should always be referenced 1063 using the OSTYPE macro in the .mc file. Examples 1064 include "bsd4.3", "bsd4.4", "sunos3.5", and 1065 "sunos4.1". 1066 1067domain Definitions describing a particular domain, referenced 1068 using the DOMAIN macro in the .mc file. These are 1069 site dependent; for example, we contribute "cs.exposed.m4" 1070 and "cs.hidden.m4" which both describe hosts in the 1071 CS.Berkeley.EDU subdomain; the former displays the local 1072 hostname (e.g., mammoth.CS.Berkeley.EDU), whereas the 1073 latter does its best to hide the identity of the local 1074 workstation inside the CS subdomain. 1075 1076mailer Descriptions of mailers. These are referenced using 1077 the MAILER macro in the .mc file. 1078 1079sh Shell files used when building the .cf file from the 1080 .mc file in the cf subdirectory. 1081 1082feature These hold special orthogonal features that you might 1083 want to include. They should be referenced using 1084 the FEATURE macro. 1085 1086hack Local hacks. These can be referenced using the HACK 1087 macro. They shouldn't be of more than voyeuristic 1088 interest outside the .Berkeley.EDU domain, but who knows? 1089 We've all got our own peccadillos. 1090 1091siteconfig Site configuration -- e.g., tables of locally connected 1092 UUCP sites. 1093 1094 1095+------------------------+ 1096| ADMINISTRATIVE DETAILS | 1097+------------------------+ 1098 1099The following sections detail usage of certain internal parts of the 1100sendmail.cf file. Read them carefully if you are trying to modify 1101the current model. If you find the above descriptions adequate, these 1102should be {boring, confusing, tedious, ridiculous} (pick one or more). 1103 1104RULESETS (* means built in to sendmail) 1105 1106 0 * Parsing 1107 1 * Sender rewriting 1108 2 * Recipient rewriting 1109 3 * Canonicalization 1110 4 * Post cleanup 1111 5 * Local address rewrite (after aliasing) 1112 1x mailer rules (sender qualification) 1113 2x mailer rules (recipient qualification) 1114 3x mailer rules (sender header qualification) 1115 4x mailer rules (recipient header qualification) 1116 5x mailer subroutines (general) 1117 6x mailer subroutines (general) 1118 7x mailer subroutines (general) 1119 8x reserved 1120 90 Mailertable host stripping 1121 96 Bottom half of Ruleset 3 (ruleset 6 in old sendmail) 1122 97 Hook for recursive ruleset 0 call (ruleset 7 in old sendmail) 1123 98 Local part of ruleset 0 (ruleset 8 in old sendmail) 1124 1125 1126MAILERS 1127 1128 0 local, prog local and program mailers 1129 1 [e]smtp, relay SMTP channel 1130 2 uucp-* UNIX-to-UNIX Copy Program 1131 3 netnews Network News delivery 1132 4 fax Sam Leffler's FlexFAX software 1133 1134 1135MACROS 1136 1137 A 1138 B Bitnet Relay 1139 C 1140 D The local domain -- usually not needed 1141 E 1142 F FAX Relay 1143 G 1144 H mail Hub (for mail clusters) 1145 I 1146 J 1147 K 1148 L 1149 M Masquerade (who I claim to be) 1150 N 1151 O 1152 P 1153 Q 1154 R Relay (for unqualified names) 1155 S Smart Host 1156 T 1157 U my UUCP name (if I have a UUCP connection) 1158 V UUCP Relay (class V hosts) 1159 W UUCP Relay (class W hosts) 1160 X UUCP Relay (class X hosts) 1161 Y UUCP Relay (all other hosts) 1162 Z Version number 1163 1164 1165CLASSES 1166 1167 A 1168 B 1169 C 1170 D 1171 E addresses that should not seem to come from $M 1172 F hosts we forward for 1173 G 1174 H 1175 I 1176 J 1177 K 1178 L addresses that should not be forwarded to $R 1179 M 1180 N 1181 O operators that indicate network operations (cannot be in local names) 1182 P top level pseudo-domains: BITNET, FAX, UUCP, etc. 1183 Q 1184 R 1185 S 1186 T 1187 U locally connected UUCP hosts 1188 V UUCP hosts connected to relay $V 1189 W UUCP hosts connected to relay $W 1190 X UUCP hosts connected to relay $X 1191 Y locally connected smart UUCP hosts 1192 Z locally connected domain-ized UUCP hosts 1193 . the class containing only a dot 1194 1195 1196M4 DIVERSIONS 1197 1198 1 Local host detection and resolution 1199 2 Local Ruleset 3 additions 1200 3 Local Ruleset 0 additions 1201 4 UUCP Ruleset 0 additions 1202 5 locally interpreted names (overrides $R) 1203 6 local configuration (at top of file) 1204 7 mailer definitions 1205 8 special local name recognition (late in ruleset 3) 1206 9 special local rulesets (1 and 2) 1207