From 12d2e742cdfbecfeddd3cf2eba9a51ca9d461e1f Mon Sep 17 00:00:00 2001 From: Eric Faurot Date: Tue, 4 Feb 2014 16:32:37 +0000 Subject: update documentation --- usr.sbin/smtpd/aliases.5 | 6 +-- usr.sbin/smtpd/sendmail.8 | 86 ++++++++++++++++++++++++++++++++++++ usr.sbin/smtpd/smtpd.conf.5 | 26 +++++------ usr.sbin/smtpd/table-passwd/Makefile | 4 +- usr.sbin/smtpd/table.5 | 5 ++- usr.sbin/smtpd/table_passwd.5 | 64 +++++++++++++++++++++++++++ 6 files changed, 171 insertions(+), 20 deletions(-) create mode 100644 usr.sbin/smtpd/sendmail.8 create mode 100644 usr.sbin/smtpd/table_passwd.5 diff --git a/usr.sbin/smtpd/aliases.5 b/usr.sbin/smtpd/aliases.5 index 42de2e62094..bda2ba5eb91 100644 --- a/usr.sbin/smtpd/aliases.5 +++ b/usr.sbin/smtpd/aliases.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: aliases.5,v 1.7 2013/07/21 17:23:45 jmc Exp $ +.\" $OpenBSD: aliases.5,v 1.8 2014/02/04 16:32:36 eric Exp $ .\" .\" Copyright (c) 2012 Gilles Chehade .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: July 21 2013 $ +.Dd $Mdocdate: February 4 2014 $ .Dt ALIASES 5 .Os .Sh NAME @@ -60,7 +60,7 @@ database file. Append messages to .Ar file , specified by its absolute pathname. -.It \*(Ba Ns Ar command +.It | Ns Ar command Pipe the message to .Ar command on its standard input. diff --git a/usr.sbin/smtpd/sendmail.8 b/usr.sbin/smtpd/sendmail.8 new file mode 100644 index 00000000000..7fa9ba1afae --- /dev/null +++ b/usr.sbin/smtpd/sendmail.8 @@ -0,0 +1,86 @@ +.\" $OpenBSD: sendmail.8,v 1.1 2014/02/04 16:32:36 eric Exp $ +.\" +.\" Copyright (C) 2013 Ryan Kavanagh +.\" All rights reserved. +.\" +.\" Permission to use, copy, modify, and/or distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.Dd $Mdocdate: February 4 2014 $ +.Dt SENDMAIL 8 +.Os +.Sh NAME +.Nm sendmail +.Nd a mail enqueuer for +.Xr smtpd 8 +.Sh SYNOPSIS +.Nm +.Op Fl tv +.Op Fl F Ar name +.Op Fl f Ar from +.Ar to ... +.Sh DESCRIPTION +The +.Nm +utility is a local enqueuer for the +.Xr smtpd 8 +daemon, +compatible with +.Xr mailwrapper 5 . +The message is read on standard input (stdin) until +.Nm +encounters an end-of-file. +The +.Nm +enqueuer is not intended to be used directly to send mail, +but rather via a frontend known as a mail user agent. +.Pp +Unless the optional +.Fl t +flag is specified, +one or more recipients must be specified on the command line. +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Fl F +Set the sender's full name. +.It Fl f +Set the sender's address. +.It Fl t +Read the message's To:, Cc:, and Bcc: fields for recipients. +The Bcc: field will be deleted before sending. +.It Fl v +Enable verbose output. +.El +.Pp +To maintain compatibility with Sendmail, Inc.'s implementation of +.Nm , +various other flags are accepted, +but have no effect. +.Sh EXIT STATUS +.Ex -std +.Sh SEE ALSO +.Xr smtpctl 8 , +.Xr smtpd 8 +.Sh AUTHORS +.Sy OpenSMTPD +is primarily developed by Gilles Chehade, +Eric Faurot, +and Charles Longeau, +with contributions from various +.Ox +hackers. +It is distributed under the ISC license. +.Pp +This manpage was written by +.An Ryan Kavanagh +.Aq Mt rak@debian.org +for the Debian project and is distributed under the ISC license. diff --git a/usr.sbin/smtpd/smtpd.conf.5 b/usr.sbin/smtpd/smtpd.conf.5 index d5715cbdfcc..b769871ccc9 100644 --- a/usr.sbin/smtpd/smtpd.conf.5 +++ b/usr.sbin/smtpd/smtpd.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: smtpd.conf.5,v 1.115 2013/12/13 21:48:28 jca Exp $ +.\" $OpenBSD: smtpd.conf.5,v 1.116 2014/02/04 16:32:36 eric Exp $ .\" .\" Copyright (c) 2008 Janne Johansson .\" Copyright (c) 2009 Jacek Masiulaniec @@ -17,7 +17,7 @@ .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" .\" -.Dd $Mdocdate: December 13 2013 $ +.Dd $Mdocdate: February 4 2014 $ .Dt SMTPD.CONF 5 .Os .Sh NAME @@ -39,7 +39,7 @@ the comment is effective until the end of the entire block. Argument names not beginning with a letter, digit, or underscore must be quoted. Arguments containing whitespace should be surrounded by double quotes -.Pq \(dq . +.Pq \&" . .Pp Macros can be defined that will later be expanded in context. Macro names must start with a letter, digit, or underscore, @@ -516,10 +516,10 @@ The relay URL must specify TLS for this option to be valid. .Pp Additional per-rule adjustments available: .Bl -tag -width Ds -.It Ic expire Ar n Brq Ar s\*(Bam\*(Bah\*(Bad +.It Ic expire Ar n Brq Ar s|m|h|d Specify how long a message that matched this rule can stay in the queue. .El -.It Ic bounce-warn Ar n Bro Ar s\*(Bam\*(Bah\*(Bad Brc Bq , Ar ... +.It Ic bounce-warn Ar n Bro Ar s|m|h|d Brc Bq , Ar ... Specify the delays for which temporary failure reports must be generated when messages are stuck in the queue. For example: @@ -530,7 +530,7 @@ bounce-warn 1h, 6h, 2d will generate a failure report when an envelope is in the queue for more than one hour, six hours and two days. The default is 4h. -.It Ic expire Ar n Brq Ar s\*(Bam\*(Bah\*(Bad +.It Ic expire Ar n Brq Ar s|m|h|d Specify how long a message can stay in the queue. The default value is 4 days. For example: @@ -728,7 +728,7 @@ It can be obtained using the .Xr openssl 1 utility as follow: .Bd -literal -offset indent -$ openssl rand -hex 16 +$ openssl rand \-hex 16 .Ed .Pp If the @@ -891,7 +891,7 @@ A secrets file is needed to specify a username and password: # touch /etc/mail/secrets # chmod 640 /etc/mail/secrets # chown root:_smtpd /etc/mail/secrets -# echo "label username:password" \*(Gt /etc/mail/secrets +# echo "label username:password" > /etc/mail/secrets # makemap /etc/mail/secrets .Ed .Pp @@ -914,9 +914,9 @@ The mail server listens on all interfaces the default route(s) point to. Mail with a local destination should be sent to an external mda. First, the RSA certificate is created: .Bd -literal -offset indent -# openssl genrsa -out /etc/ssl/private/mail.example.com.key 4096 -# openssl req -new -x509 -key /etc/ssl/private/mail.example.com.key \e - -out /etc/ssl/mail.example.com.crt -days 365 +# openssl genrsa \-out /etc/ssl/private/mail.example.com.key 4096 +# openssl req \-new \-x509 \-key /etc/ssl/private/mail.example.com.key \e + \-out /etc/ssl/mail.example.com.crt \-days 365 # chmod 600 /etc/ssl/mail.example.com.crt # chmod 600 /etc/ssl/private/mail.example.com.key .Ed @@ -933,9 +933,9 @@ listen on egress tls pki mail.example.com auth table aliases db:/etc/mail/aliases.db -accept for local alias deliver to mda "/path/to/mda -f -" +accept for local alias deliver to mda "/path/to/mda \-f \-" accept from any for domain example.org \e - deliver to mda "/path/to/mda -f -" + deliver to mda "/path/to/mda \-f \-" accept for any relay .Ed .Sh SEE ALSO diff --git a/usr.sbin/smtpd/table-passwd/Makefile b/usr.sbin/smtpd/table-passwd/Makefile index 882ad9a710c..e10dca7ba7d 100644 --- a/usr.sbin/smtpd/table-passwd/Makefile +++ b/usr.sbin/smtpd/table-passwd/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.2 2014/01/18 05:54:51 martynas Exp $ +# $OpenBSD: Makefile,v 1.3 2014/02/04 16:32:36 eric Exp $ .PATH: ${.CURDIR}/.. @@ -9,7 +9,7 @@ SRCS+= table_api.c SRCS+= dict.c SRCS+= log.c -NOMAN= noman +MAN= table_passwd.5 BINDIR= /usr/libexec/smtpd diff --git a/usr.sbin/smtpd/table.5 b/usr.sbin/smtpd/table.5 index 528c0395dc7..334690e5456 100644 --- a/usr.sbin/smtpd/table.5 +++ b/usr.sbin/smtpd/table.5 @@ -1,6 +1,7 @@ -.\" $OpenBSD: table.5,v 1.3 2013/11/30 09:42:52 eric Exp $ +.\" $OpenBSD: table.5,v 1.4 2014/02/04 16:32:36 eric Exp $ .\" .\" Copyright (c) 2013 Eric Faurot +.\" Copyright (c) 2013 Gilles Chehade .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -15,7 +16,7 @@ .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" .\" -.Dd $Mdocdate: November 30 2013 $ +.Dd $Mdocdate: February 4 2014 $ .Dt TABLE 5 .Os .Sh NAME diff --git a/usr.sbin/smtpd/table_passwd.5 b/usr.sbin/smtpd/table_passwd.5 new file mode 100644 index 00000000000..e6c94fc7625 --- /dev/null +++ b/usr.sbin/smtpd/table_passwd.5 @@ -0,0 +1,64 @@ +.\" $OpenBSD: table_passwd.5,v 1.1 2014/02/04 16:32:36 eric Exp $ +.\" +.\" Copyright (c) 2014 Gilles Chehade +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.\" +.Dd $Mdocdate: February 4 2014 $ +.Dt TABLE_PASSWD 5 +.Os +.Sh NAME +.Nm table_passwd +.Nd format description for smtpd passwd tables +.Sh DESCRIPTION +This manual page documents the file format of "passwd" tables used by the +.Xr smtpd 8 +mail daemon. +.Pp +The format described here applies to tables as defined in +.Xr smtpd.conf 5 . +.Sh PASSWD TABLE +A "passwd" table stores information regarding local users. +The information is encoded using the traditional +.Xr passwd 5 +format and allows to share a user database across different software +supporting this format. +.Pp +The table is used by +.Xr smtpd 8 +when authenticating a user or when user information such as user-id or +home directory is required for a delivery. +.Pp +A "passwd" table consists of a flat file containing the user entries, each +one on a line by itself, with fields separated by a colon: +.Bd -literal -offset indent +gilles:*:1000:1000:Gilles:/home/gilles:/sbin/nologin +eric:*:1001:1001:Eric:/home/eric:/sbin/nologin +chl:*:1002:1002:Charles:/home/chl:/sbin/nologin +.Ed +.Pp +If the table is used for authentication, the second field may contain a +password encrypted using the +.Xr crypt 3 +function. +Such passwords can be generated using the +.Xr encrypt 1 +utility or +.Xr smtpctl 8 +encrypt command. +.Sh SEE ALSO +.Xr smtpd.conf 5 , +.Xr passwd 5 , +.Xr smtpctl 8 , +.Xr smtpd 8 -- cgit v1.2.3