descriptionA mail processing system intended to provide the functionality of the POSIX mailx(1) command
homepage URLhttps://www.sdaoden.eu/code.html
repository URLhttps://git.sdaoden.eu/scm/s-nail.git
ownersteffen@sdaoden.eu
last changeMon, 22 May 2017 14:26:01 +0000 (22 16:26 +0200)
last refreshSat, 27 May 2017 05:59:11 +0000 (27 07:59 +0200)
content tags
add:
README
W e l c o m e  t o  S - n a i l / S - m a i l x
===============================================

S-nail (later S-mailx) provides a simple and friendly environment for
sending and receiving mail.  It is intended to provide the functionality
of the POSIX mailx(1) command, but is MIME capable and optionally offers
extensions for line editing, S/MIME, SMTP and POP3, among others.
S-nail divides incoming mail into its constituent messages and allows
the user to deal with them in any order.  It offers many commands and
internal variables for manipulating messages and sending mail.  It
provides the user simple editing capabilities to ease the composition of
outgoing messages, and increasingly powerful and reliable
non-interactive scripting capabilities.

Please refer to the file INSTALL for build and installation remarks,
and to NEWS for release update information.  The file THANKS mentions
people who have helped improving and deserve acknowledgement.

This software originates in the codebase of Heirloom mailx, formerly
known as nail, which itself is based upon Berkeley Mail that has
a history back to 1978 and which superseded Unix mail, a program that
already shipped with First Edition Unix from 1971 -- M. Douglas McIlroy
writes in his article "A Research UNIX Reader: Annotated Excerpts from
the Programmer's Manual, 1971-1986":

  MAIL (v1 page 21, v7 page 22)
    Electronic mail was there from the start. Never satisfied with its
    exact behavior, everybody touched it at one time or another: to
    assure the safety of simultaneous access, to improve privacy, to
    survive crashes, to exploit uucp, to screen out foreign freeloaders,
    or whatever. Not until v7 did the interface change (Thompson). [.]

1. Where?
2. Repository layout
3. Security record
4. Authors

1. Where?
---------

Our latest release can be downloaded at [1], and the fully cross-
referenced manual can also be viewed as HTML online[2].
There are browsable git(1) repositories at sdaoden.eu[3] (use [4] for
cloning purposes), with mirrors at Sourceforge[5] and repo.or.cz[6].

  [1] https?://www.sdaoden.eu/downloads/s-nail-latest.tar.{gz,xz}{,.asc}
  [2] https?://www.sdaoden.eu/code.html#s-mailx
  [3] https?://git.sdaoden.eu/cgit/s-nail.git
  [4] https?://git.sdaoden.eu/scm/s-nail.git
  [5] http://sourceforge.net/projects/s-nail
  [6] http://repo.or.cz/s-mailx.git

We have a mailing list[7] (later: [8]!) with moderated unsubscribed
posting possibilities; subscriptions can be managed via web interface[9];
Gmane added the ML their NNTP archive[10], and The Mail Archive archives
a browser-accessible and searchable web version[11] -- thank you!
Commits to the [master], [release/*] and [stable/*] branches will be
posted to [12], and announcements will also be posted to [13], both are
receive-only mailing-lists.

  [7] s-nail-users@lists.sourceforge.net
  [8] s-mailx@sdaoden.eu
  [9] https://lists.sourceforge.net/lists/listinfo/s-nail-users/
  [10] news.gmane.org/gmane.mail.s-nail.user
  [11] www.mail-archive.com/s-nail-users@lists.sourceforge.net/maillist.html
  [12] s-mailx-commit@sdaoden.eu
  [13] s-announce@sdaoden.eu

These and all other mailings-lists at sdaoden.eu are hosted by MLMMJ, so
users can manage their subscriptions by appending keywords to the plain
mailing list address, a +subscribe for subscription, and +unsubscribe
for unsubscription, e.g., s-mailx+subscribe@sdaoden.eu.
Our heraldic animal snailmail.jpg has been found at [+1].
Thank you!

  [+1] http://cdn.whatculture.com/wp-content/uploads/2009/06/snailmail.jpg

2. Repository layout
--------------------

- [release/*]
    A new branch within release/ is created for every release, e.g.,
    [release/v14.8.10].  History won't be rewritten.

    These branches consist of one commit, and that commit is signed with
    an OpenPGP key and used for the signed release tag,
    vMAJOR.MINOR.UPDATE.ar (.ar for "archive").  The commit as such
    covers the data modifications that make up a release, i.e., release
    date fixation, manual preprocessing, removal of data which doesn't
    make sense in release tarballs, etc.

    (Whereas all this is not true for older releases, the new repository
    layout was introduced after v14.8.10, and used [timeline] as
    a source for most references, therefore the signed tag v14.8.7.ar
    protects all elder references within [release/]:

      $ git describe --contains heads/release/v1.3.0
      v14.8.7.ar~113

- [release/latest] and [release/stable]
    "Symbolic links" to the latest and stable, respectively, release
    branches.

- [stable/*]
    A new branch within stable/ will be created for each new minor
    version, e.g., [stable/v14.8].  History won't be rewritten.

    These are the de-facto [master] branches for their respective minor
    release, which extend for the full lifetime of the said, e.g., the
    branch [stable/v14.7] has been created once the v14.7.0 release was
    made, and it extends until the release of v14.7.11, the last v14.7
    update release made.

    Once the time for a new release has come, the head of such a stable
    branch will gain a signed commit and a signed stable tag,
    vMAJOR.MINOR.UPDATE, and then be used as the source for a new branch
    in release/.

- [stable/latest] and [stable/stable]
    "Symbolic links" to the latest and stable, respectively, stable
    branches.

    These are possibly what users should track which want to have the
    newest non-release bugfixes and stable, backward-compatible commits.
    See below for examples how to accomplish that.

- [master]
    Rooted on top of [heirloom].  It gains only stable, but possibly
    backward-incompatible changes (usually mentioned on the ML), and
    will be used to create new entries in stable/.  It may gain signed
    commits for sealing purposes from time to time.
    History won't be rewritten.

- [next]
    Rooted on top of [master], this consists of a furious mixture of
    commits that eventually end up in [master].  Daring users may give
    this branch a try, but bugs and temporary nonstarters have to be
    dealt with, then.

- [crawl]
    Developer chaos (distributed horror backup - don't use!).

- [unix-mail,bsd-Mail,timeline]
    Sketchy efforts to collect the complete history of Unix mail and
    its successor, BSD Mail.  Anything from the pre-nail era has been
    taken from CSRG and TUHS, for nail and Heirloom mailx i have used
    release balls.

    The [timeline] branch was the original effort, and it will be
    continuously be extended whenever new releases will be made, but its
    history won't be rewritten, which is why it is a sketchy effort.
    The [unix-mail] and [bsd-Mail] branches have been added later, and
    will hopefully offer the most complete picture possible as time goes
    by (not taking into account the "nupas" effort of Research Unix,
    though) -- this means their history may change, but all commits are
    signed with an OpenPGP key.

- [heirloom]
    A full git(1) cvsimport of the Heirloom mailx(1) cvs(1) repository.

To create a full clone of the repository, with all the data and history:
  $ git clone https://git.sdaoden.eu/scm/s-nail.git

With a newer git(1), and only tracking the latest stable branch:
  $ git clone --single-branch --branch=stable/latest \
      https://git.sdaoden.eu/scm/s-nail.git

Or, being selective, also with older git(1)s:
  $ mkdir s-nail.git
  $ cd s-nail.git
  $ git init
  $ git remote add origin -t 'release/*' -t stable/stable -t master \
      https://git.sdaoden.eu/scm/s-nail.git
  $ git fetch -v

And then, assuming the last had been done:

  $ # Show all releases
  $ git log --no-walk --decorate --oneline --branches='release/*' --
  $ # Check out the latest release, and verify the signature
  $ git checkout release/latest
  $ git log --oneline --show-signature --max-count=1 HEAD
  $ make all && sudo make install

3. Security record
------------------

- CVE-2004-2771, and CVE-2014-7844.
  http://seclists.org/oss-sec/2014/q4/1066.
  Fixed in: v14.7.9 (on day after announcement on oss-sec)

  Affected all BSD Mail-based codebases.

- CVE-2017-5899.
  Credits: wapiflapi.
  Fixed in: v14.8.16 (on day of disclosure)

    > vulnerability in the setuid root helper binary

    > The problem is that an O_EXCL file is created with a user controlled
    > path because the di.di_hostname and di.di_randstr are never checked.
    > This means that using s-nail-privsep a normal user can create a file
    > anywhere on the filesystem, which is a security problem.

4. Authors
----------

Unix mail seems to have been written mostly by Ken Thompson.

Berkeley Mail was (according to def.h) developed by Kurt Shoens, dated
March 25, 1978.  According to the CSRG commit log authors of BSD mail in
the time span 1980-10-08 to 1995-05-01 were, in order of appearance
(commit count): Kurt Shoens (379), Kirk McKusick (50), Carl Smith (16),
Bill Bush (2), Eric Allman (6), Craig Leres (43), Sam Leffler (51),
Ralph Campbell (21), Serge Granik (28), Edward Wang (253),
Donn Seeley (1), Jay Lepreau (3), Jim Bloom (1), Anne Hughes (2),
Kevin Dunlap (34), Keith Bostic (253), Mike Karels (1), Cael Staelin (6)
and Dave Borman (17).  One commit by Charlie Root, 36 by "dist".

Official BSD Mail development ceased in 1995 according to the CSRG
(Berkeley's Computer Systems Research Group) repository.  Mail has then
seen further development in open source BSD variants, noticeably by
Christos Zoulas in NetBSD.

Gunnar Ritter reused that codebase when he started developing nail in
February 2000, and incorporated numerous patches from OpenBSD, NetBSD,
RedHat and Debian.  He added MIME code, network protocol support, and
POSIX conformance improvements. In March 2006, he integrated that
program into the Heirloom project, renaming it to Heirloom mailx, the
development of which ceased in 2008.

In 2012 Steffen (Daode) Nurpmeso adopted the codebase as S-nail.
We try to end up as S-mailx.

# s-ts-mode
shortlog
4 days ago Steffen (Daode... Fix _CLOEXEC_SET() fallback implementationmaster
2017-05-05 Steffen (Daode... Tweak previous, it added a bad memory access
2017-05-03 Steffen (Daode... FIX off-buffer with only empty input (since 2016-09+!)
2017-05-03 Steffen (Daode... memory.c: fix compilation with DEVEL+OPT_NOMEMDBG
2017-04-29 Steffen (Daode... nail.1: tweak previous
2017-04-28 Steffen (Daode... initbox(): for *mbox-rfc4155* to work, _always_ reset...
2017-04-22 Steffen (Daode... sendout.c:_sendbundle_setup_creds(): fix !HAVE_SMTP...
2017-04-22 Steffen (Daode... a_head_addrspec_check(): in quoted-string, only quoted...
2017-04-22 Steffen (Daode... Improve shell parser sequencing; changes \c@..
2017-04-22 Steffen (Daode... "Fix" shell parser (/ command parser relationship)..
2017-04-22 Steffen (Daode... FIX crash when `bind'ing over existing binding!..
2017-04-21 Steffen (Daode... nail.rc: use `retain' not non-portable `headerpick...
2017-04-19 Steffen (Daode... (BWDIC!) Drop bzip2(1)-, add zstd(1) support; FIX ...
2017-04-19 Steffen (Daode... nailfuns.h: fix CONFIG=MINIMAL (since 2016-03-03!)
2017-04-15 Steffen (Daode... nam-a-group.c: fix false indentation that sneaked in
2017-04-13 Steffen (Daode... Bump S-nail v14.9.0-pre4, 2017-04-13v14.9.0-pre4
...
tags
6 weeks ago v14.9.0-pre4 Bump S-nail v14.9.0-pre4, 2017...
3 months ago v14.8.16.ar Bump S-nail v14.8.16.ar ("Copris...
3 months ago v14.8.16 Bump S-nail v14.8.16 ("Copris lunar...
4 months ago v14.8.15.ar Bump S-nail v14.8.15.ar ("Scarabaeu...
4 months ago v14.8.15 Bump S-nail v14.8.15 ("Scarabaeus...
4 months ago v14.9.0-pre3 Bump S-nail v14.9.0-pre3, 2016...
5 months ago steffen-pgp-pub My OpenPGP key: steffen@sdaoden...
6 months ago v14.9.0-pre2 Bump S-nail v14.9.0-pre2, 2016...
7 months ago v14.8.14.ar Bump S-nail v14.8.14.ar, 2016-10-20
7 months ago v14.8.14 Bump S-nail v14.8.14, 2016-10-20
7 months ago v14.8.13.ar Bump S-nail v14.8.13.ar, 2016-10-19
7 months ago v14.8.13 Bump S-nail v14.8.13, 2016-10-19
7 months ago v14.8.12.ar Bump S-nail v14.8.12.ar, 2016-10-05
7 months ago v14.8.12 Bump S-nail v14.8.12, 2016-10-05
7 months ago v14.8.11.ar Bump S-nail v14.8.11.ar, 2016-10-03
7 months ago v14.8.11 Bump S-nail v14.8.11, 2016-10-03
...
heads
18 hours ago crawl
18 hours ago next
39 hours ago test-out
3 days ago stable/v14.8
4 days ago master
5 weeks ago stable/stable
5 weeks ago stable/latest
8 weeks ago bsd-Mail
8 weeks ago unix-mail
3 months ago timeline
3 months ago release/v14.8.16
3 months ago release/stable
3 months ago release/latest
4 months ago release/v14.8.15
7 months ago release/v14.8.14
7 months ago release/v14.8.13
...