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