contrib/sendmail/README

   1
   2                         SENDMAIL RELEASE 8
   3
   4 This directory has the latest sendmail(TM) software from Sendmail, Inc.
   5
   6 Report any bugs to sendmail-bugs@sendmail.ORG
   7
   8 There is a web site at http://WWW.Sendmail.ORG/ -- see that site for
   9 the latest updates.
  10
  11 +--------------+
  12 | INTRODUCTION |
  13 +--------------+
  14
  15 0. The vast majority of queries to <sendmail-questions@sendmail.org>
  16    are answered in the README files noted below.
  17
  18 1. Read this README file, especially this introduction, and the DIRECTORY
  19    PERMISSIONS sections.
  20
  21 2. Read the INSTALL file in this directory.
  22
  23 3. Read sendmail/README, especially:
  24    a. the introduction
  25    b. the BUILDING SENDMAIL section
  26    c. the relevant part(s) of the OPERATING SYSTEM AND COMPILE QUIRKS section
  27
  28    You may also find these useful:
  29
  30    d. sendmail/SECURITY
  31    e. devtools/README
  32    f. devtools/Site/README
  33    g. libmilter/README
  34    h. mail.local/README
  35    i. smrsh/README
  36
  37 4. Read cf/README.
  38
  39 Sendmail is a trademark of Sendmail, Inc.
  40
  41 +-----------------------+
  42 | DIRECTORY PERMISSIONS |
  43 +-----------------------+
  44
  45 Sendmail often gets blamed for many problems that are actually the
  46 result of other problems, such as overly permissive modes on directories.
  47 For this reason, sendmail checks the modes on system directories and
  48 files to determine if they can be trusted.  For sendmail to run without
  49 complaining, you MUST execute the following command:
  50
  51         chmod go-w / /etc /etc/mail /usr /var /var/spool /var/spool/mqueue
  52         chown root / /etc /etc/mail /usr /var /var/spool /var/spool/mqueue
  53
  54 You will probably have to tweak this for your environment (for example,
  55 some systems put the spool directory into /usr/spool instead of
  56 /var/spool).  If you set the RunAsUser option in your sendmail.cf, the
  57 /var/spool/mqueue directory will have to be owned by the RunAsUser user.
  58 As a general rule, after you have compiled sendmail, run the command
  59
  60         sendmail -v -bi
  61
  62 to initialize the alias database.  If it gives messages such as
  63
  64         WARNING: writable directory /etc
  65         WARNING: writable directory /var/spool/mqueue
  66
  67 then the directories listed have inappropriate write permissions and
  68 should be secured to avoid various possible security attacks.
  69
  70 Beginning with sendmail 8.9, these checks have become more strict to
  71 prevent users from being able to access files they would normally not
  72 be able to read.  In particular, .forward and :include: files in unsafe
  73 directory paths (directory paths which are group or world writable) will
  74 no longer be allowed.  This would mean that if user joe's home directory
  75 was writable by group staff, sendmail would not use his .forward file.
  76 This behavior can be altered, at the expense of system security, by
  77 setting the DontBlameSendmail option.  For example, to allow .forward
  78 files in group writable directories:
  79
  80         O DontBlameSendmail=forwardfileingroupwritabledirpath
  81
  82 Or to allow them in both group and world writable directories:
  83
  84         O DontBlameSendmail=forwardfileinunsafedirpath
  85
  86 Items from these unsafe .forward and :include: files will be marked
  87 as unsafe addresses -- the items can not be deliveries to files or
  88 programs.  This behavior can also be altered via DontBlameSendmail:
  89
  90         O DontBlameSendmail=forwardfileinunsafedirpath,
  91                 forwardfileinunsafedirpathsafe
  92
  93 The first flag allows the .forward file to be read, the second allows
  94 the items in the file to be marked as safe for file and program
  95 delivery.
  96
  97 Other files affected by this strengthened security include class
  98 files (i.e., Fw /etc/mail/local-host-names), persistent host status files,
  99 and the files specified by the ErrorHeader and HelpFile options.  Similar
 100 DontBlameSendmail flags are available for the class, ErrorHeader, and
 101 HelpFile files.
 102
 103 If you have an unsafe configuration of .forward and :include:
 104 files, you can make it safe by finding all such files, and doing
 105 a "chmod go-w $FILE" on each.  Also, do a "chmod go-w $DIR" for
 106 each directory in the file's path.
 107
 108
 109 +--------------------------+
 110 | FILE AND MAP PERMISSIONS |
 111 +--------------------------+
 112
 113 Any application which uses either flock() or fcntl() style locking or
 114 other APIs that use one of these locking methods (such as open() with
 115 O_EXLOCK and O_SHLOCK) on files readable by other local untrusted users
 116 may be susceptible to local denial of service attacks.
 117
 118 File locking is used throughout sendmail for a variety of files
 119 including aliases, maps, statistics, and the pid file.  Any user who
 120 can open one of these files can prevent sendmail or it's associated
 121 utilities, e.g., makemap or newaliases, from operating properly.  This
 122 can also affect sendmail's ability to update status files such as
 123 statistics files.  For system which use flock() for file locking, a
 124 user's ability to obtain an exclusive lock prevents other sendmail
 125 processes from reading certain files such as alias or map databases.
 126
 127 A workaround for this problem is to protect all sendmail files such
 128 that they can't be opened by untrusted users.  As long as users can
 129 not open a file, they can not lock it.  Since queue files should
 130 already have restricted permissions, the only files that need
 131 adjustment are alias, map, statistics, and pid files.  These files
 132 should be owned by root or the trusted user specified in the
 133 TrustedUser option.  Changing the permissions to be only readable and
 134 writable by that user is sufficient to avoid the denial of service.
 135 For example, depending on the paths you use, these commands would be
 136 used:
 137
 138         chmod 0640 /etc/mail/aliases /etc/mail/aliases.{db,pag,dir}
 139         chmod 0640 /etc/mail/*.{db,pag,dir}
 140         chmod 0640 /etc/mail/statistics /var/log/sendmail.st
 141         chmod 0600 /var/run/sendmail.pid /etc/mail/sendmail.pid
 142
 143 If the permissions 0640 are used, be sure that only trusted users belong
 144 to the group assigned to those files.  Otherwise, files should not even
 145 be group readable.  As of sendmail 8.12.4, the permissions shown above
 146 are the default permissions for newly created files.
 147
 148 Note that the denial of service on the plain text aliases file
 149 (/etc/mail/aliases) only prevents newaliases from rebuilding the
 150 aliases file.  The same is true for the database files on systems which
 151 use fcntl() style locking.  Since it does not interfere with normal
 152 operations, sites may chose to leave these files readable.  Also, it is
 153 not necessary to protect the text files associated with map databases
 154 as makemap does not lock those files.
 155
 156
 157 +-----------------------+
 158 | RELATED DOCUMENTATION |
 159 +-----------------------+
 160
 161 There are other files you should read.  Rooted in this directory are:
 162
 163   FAQ
 164         The FAQ (frequently answered questions) is no longer maintained
 165         with the sendmail release.  It is available at
 166         http://www.sendmail.org/faq/ .  The file FAQ is a reminder of
 167         this and a pointer to the web page.
 168   INSTALL
 169         Installation instructions for building and installing sendmail.
 170   KNOWNBUGS
 171         Known bugs in the current release.
 172   RELEASE_NOTES
 173         A detailed description of the changes in each version.  This
 174         is quite long, but informative.
 175   sendmail/README
 176         Details on compiling and installing sendmail.
 177   cf/README
 178         Details on configuring sendmail.
 179   doc/op/op.me
 180         The sendmail Installation & Operations Guide.  Be warned: if
 181         you are running this off on SunOS or some other system with an
 182         old version of -me, you need to add the following macro to the
 183         macros:
 184
 185                 .de sm
 186                 \s-1\\$1\\s0\\$2
 187                 ..
 188
 189         This sets a word in a smaller pointsize.
 190
 191
 192 +--------------+
 193 | RELATED RFCS |
 194 +--------------+
 195
 196 There are several related RFCs that you may wish to read -- they are
 197 available via anonymous FTP to several sites.  For a list of the
 198 primary repositories see:
 199
 200         http://www.isi.edu/in-notes/rfc-retrieval.txt
 201
 202 They are also online at:
 203
 204         http://www.ietf.org/
 205
 206 They can also be retrieved via electronic mail by sending
 207 email to one of:
 208
 209         mail-server@nisc.sri.com
 210                 Put "send rfcNNN" in message body
 211         nis-info@nis.nsf.net
 212                 Put "send RFCnnn.TXT-1" in message body
 213         sendrfc@jvnc.net
 214                 Put "RFCnnn" as Subject: line
 215
 216 For further instructions see:
 217
 218         http://www.isi.edu/in-notes/rfc-editor/rfc-info
 219
 220 Important RFCs for electronic mail are:
 221
 222         RFC821  SMTP protocol
 223         RFC822  Mail header format
 224         RFC974  MX routing
 225         RFC976  UUCP mail format
 226         RFC1123 Host requirements (modifies 821, 822, and 974)
 227         RFC1344 Implications of MIME for Internet Mail Gateways
 228         RFC1413 Identification server
 229         RFC1428 Transition of Internet Mail from Just-Send-8 to
 230                 8-bit SMTP/MIME
 231         RFC1652 SMTP Service Extension for 8bit-MIMEtransport
 232         RFC1869 SMTP Service Extensions (ESMTP spec)
 233         RFC1870 SMTP Service Extension for Message Size Declaration
 234         RFC1891 SMTP Service Extension for Delivery Status Notifications
 235         RFC1892 Multipart/Report Content Type for the Reporting of
 236                 Mail System Administrative Messages
 237         RFC1893 Enhanced Mail System Status Codes
 238         RFC1894 An Extensible Message Format for Delivery Status
 239                 Notifications
 240         RFC1985 SMTP Service Extension for Remote Message Queue Starting
 241         RFC2033 Local Mail Transfer Protocol (LMTP)
 242         RFC2034 SMTP Service Extension for Returning Enhanced Error Codes
 243         RFC2045 Multipurpose Internet Mail Extensions (MIME) Part One:
 244                 Format of Internet Message Bodies
 245         RFC2476 Message Submission
 246         RFC2487 SMTP Service Extension for Secure SMTP over TLS
 247         RFC2554 SMTP Service Extension for Authentication
 248         RFC2821 Simple Mail Transfer Protocol
 249         RFC2822 Internet Message Format
 250         RFC2852 Deliver By SMTP Service Extension
 251         RFC2920 SMTP Service Extension for Command Pipelining
 252
 253 Other standards that may be of interest (but which are less directly
 254 relevant to sendmail) are:
 255
 256         RFC987  Mapping between RFC822 and X.400
 257         RFC1049 Content-Type header field (extension to RFC822)
 258
 259 Warning to AIX users: this version of sendmail does not implement
 260 MB, MR, or MG DNS resource records, as defined (as experiments) in
 261 RFC1035.
 262
 263
 264 +---------+
 265 | WARNING |
 266 +---------+
 267
 268 Since sendmail 8.11 and later includes hooks to cryptography, the
 269 following information from OpenSSL applies to sendmail as well.
 270
 271 PLEASE REMEMBER THAT EXPORT/IMPORT AND/OR USE OF STRONG CRYPTOGRAPHY
 272 SOFTWARE, PROVIDING CRYPTOGRAPHY HOOKS OR EVEN JUST COMMUNICATING
 273 TECHNICAL DETAILS ABOUT CRYPTOGRAPHY SOFTWARE IS ILLEGAL IN SOME
 274 PARTS OF THE WORLD.  SO, WHEN YOU IMPORT THIS PACKAGE TO YOUR
 275 COUNTRY, RE-DISTRIBUTE IT FROM THERE OR EVEN JUST EMAIL TECHNICAL
 276 SUGGESTIONS OR EVEN SOURCE PATCHES TO THE AUTHOR OR OTHER PEOPLE
 277 YOU ARE STRONGLY ADVISED TO PAY CLOSE ATTENTION TO ANY EXPORT/IMPORT
 278 AND/OR USE LAWS WHICH APPLY TO YOU.  THE AUTHORS ARE NOT LIABLE FOR
 279 ANY VIOLATIONS YOU MAKE HERE.  SO BE CAREFUL, IT IS YOUR RESPONSIBILITY.
 280
 281 If you use OpenSSL then make sure you read their README file which
 282 contains information about patents etc.
 283
 284
 285 +-------------------+
 286 | DATABASE ROUTINES |
 287 +-------------------+
 288
 289 IF YOU WANT TO RUN THE NEW BERKELEY DB SOFTWARE:  ****  DO NOT  ****
 290 use the version that was on the Net2 tape -- it has a number of
 291 nefarious bugs that were bad enough when I got them; you shouldn't have
 292 to go through the same thing.  Instead, get a new version via the web at
 293 http://www.sleepycat.com/.  This software is highly recommended; it gets
 294 rid of several stupid limits, it's much faster, and the interface is
 295 nicer to animals and plants.  If the Berkeley DB include files
 296 are installed in a location other than those which your compiler searches,
 297 you will need to provide that directory when building:
 298
 299         Build -I/path/to/include/directory
 300
 301 If you are using Berkeley DB versions 1.85 or 1.86, you are *strongly*
 302 urged to upgrade to DB version 2 or later, available from
 303 http://www.sleepycat.com/.  Berkeley DB versions 1.85 and 1.86 are known to
 304 be broken in various nasty ways (see http://www.sleepycat.com/db.185.html),
 305 and can cause sendmail to dump core.  In addition, the newest versions of
 306 gcc and the Solaris compilers perform optimizations in those versions that
 307 may cause fairly random core dumps.
 308
 309 If you have no choice but to use Berkeley DB 1.85 or 1.86, and you are
 310 using both Berkeley DB and files in the UNIX ndbm format, remove ndbm.h
 311 and ndbm.o from the DB library after building it.  You should also apply
 312 all of the patches for DB 1.85 and 1.86 found at the Sleepycat web site
 313 (see http://www.sleepycat.com/db.185.html), as they fix some of the known
 314 problems.
 315
 316 If you are using a version of Berkeley DB 2 previous to 2.3.15, and you
 317 are using both Berkeley DB and files in the UNIX ndbm format, remove dbm.o
 318 from the DB library after building it.  No other changes are necessary.
 319
 320 If you are using Berkeley DB version 2.3.15 or greater, no changes are
 321 necessary.
 322
 323 The underlying database file formats changed between Berkeley DB versions
 324 1.85 and 1.86, again between DB 1.86 and version 2.0, and finally between
 325 DB 2.X and 3.X.  If you are upgrading from one of those versions, you must
 326 recreate your database file(s).  Do this by rebuilding all maps with
 327 makemap and rebuilding the alias file with newaliases.
 328
 329
 330 +--------------------+
 331 | HOST NAME SERVICES |
 332 +--------------------+
 333
 334 If you are using NIS or /etc/hosts, it is critical that you
 335 list the long (fully qualified) name somewhere (preferably first) in
 336 the /etc/hosts file used to build the NIS database.  For example, the
 337 line should read
 338
 339         128.32.149.68   mastodon.CS.Berkeley.EDU mastodon
 340
 341 **** NOT ****
 342
 343         128.32.149.68   mastodon
 344
 345 If you do not include the long name, sendmail will complain loudly
 346 about ``unable to qualify my own domain name (mastodon) -- using
 347 short name'' and conclude that your canonical name is the short
 348 version and use that in messages.  The name "mastodon" doesn't mean
 349 much outside of Berkeley, and so this creates incorrect and unreplyable
 350 messages.
 351
 352
 353 +-------------+
 354 | USE WITH MH |
 355 +-------------+
 356
 357 This version of sendmail notices and reports certain kinds of SMTP
 358 protocol violations that were ignored by older versions.  If you
 359 are running MH you may wish to install the patch in contrib/mh.patch
 360 that will prevent these warning reports.  This patch also works
 361 with the old version of sendmail, so it's safe to go ahead and
 362 install it.
 363
 364
 365 +----------------+
 366 | USE WITH IDENT |
 367 +----------------+
 368
 369 Sendmail 8 supports the IDENT protocol, as defined by RFC 1413.
 370 Note that the RFC states a client should wait at least 30 seconds
 371 for a response.  As of 8.10.0, the default Timeout.ident is 5 seconds
 372 as many sites have adopted the practice of dropping IDENT queries.
 373 This has lead to delays processing mail.
 374
 375 No ident server is included with this distribution.  It is available
 376 from:
 377
 378   ftp://ftp.lysator.liu.se/pub/ident/servers/
 379   http://sf.www.lysator.liu.se/~pen/pidentd/
 380
 381 +-------------------------+
 382 | INTEROPERATION PROBLEMS |
 383 +-------------------------+
 384
 385 Microsoft Exchange Server 5.0
 386         We have had a report that ``about 7% of messages from Sendmail
 387         to Exchange were not being delivered with status messages of
 388         "connection reset" and "I/O error".''  Upgrading Exchange from
 389         Version 5.0 to Version 5.5 Service Pack 2 solved this problem.
 390
 391 CommuniGate Pro
 392         CommuniGate Pro 3.2.4 does not accept the AUTH= -parameter on
 393         the MAIL FROM command if the client is not authenticated.  Use
 394
 395                 define(`confAUTH_OPTIONS', `A')
 396
 397         in .mc file if you have compiled sendmail with Cyrus SASL
 398         and you communicate with CommuniGate Pro servers.
 399
 400 +---------------------+
 401 | DIRECTORY STRUCTURE |
 402 +---------------------+
 403
 404 The structure of this directory tree is:
 405
 406 cf              Source for sendmail configuration files.  These are
 407                 different than what you've seen before.  They are a
 408                 fairly dramatic rewrite, requiring the new sendmail
 409                 (since they use new features).
 410 contrib         Some contributed tools to help with sendmail.  THESE
 411                 ARE NOT SUPPORTED by sendmail -- contact the original
 412                 authors if you have problems.  (This directory is not
 413                 on the 4.4BSD tape.)
 414 devtools        Build environment.  See devtools/README.
 415 doc             Documentation.  If you are getting source, read
 416                 op.me -- it's long, but worth it.
 417 editmap         A program to edit and query maps that have been created
 418                 with makemap, e.g., adding and deleting entries.
 419 include         Include files used by multiple programs in the distribution.
 420 libsmdb         sendmail database library with support for Berkeley DB 1.X,
 421                 Berkeley DB 2.X, Berkeley DB 3.X, and NDBM.
 422 libsmutil       sendmail utility library with functions used by different
 423                 programs.
 424 mail.local      The source for the local delivery agent used for 4.4BSD.
 425                 THIS IS NOT PART OF SENDMAIL! and may not compile
 426                 everywhere, since it depends on some 4.4-isms.  Warning:
 427                 it does mailbox locking differently than other systems.
 428 mailstats       Statistics printing program.
 429 makemap         A program that creates the keyed maps used by the $( ... $)
 430                 construct in sendmail.  It is primitive but effective.
 431                 It takes a very simple input format, so you will probably
 432                 expect to preprocess must human-convenient formats
 433                 using sed scripts before this program will like them.
 434                 But it should be functionally complete.
 435 praliases       A program to print the DBM or NEWDB version of the
 436                 aliases file.
 437 rmail           Source for rmail(8).  This is used as a delivery
 438                 agent for for UUCP, and could presumably be used by
 439                 other non-socket oriented mailers.  Older versions of
 440                 rmail are probably deficient.  RMAIL IS NOT PART OF
 441                 SENDMAIL!!!  The 4.4BSD source is included for you to
 442                 look at or try to port to your system.  There is no
 443                 guarantee it will even compile on your operating system.
 444 smrsh           The "sendmail restricted shell", which can be used as
 445                 a replacement for /bin/sh in the prog mailer to provide
 446                 increased security control.  NOT PART OF SENDMAIL!
 447 sendmail        Source for the sendmail program itself.
 448 test            Some test scripts (currently only for compilation aids).
 449 vacation        Source for the vacation program.  NOT PART OF SENDMAIL!
 450
 451 $Revision: 8.90 $, Last updated $Date: 2002/05/25 02:55:59 $