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