summaryrefslogtreecommitdiff
path: root/usr.sbin/smtpd/table_passwd.5
diff options
context:
space:
mode:
Diffstat (limited to 'usr.sbin/smtpd/table_passwd.5')
-rw-r--r--usr.sbin/smtpd/table_passwd.564
1 files changed, 64 insertions, 0 deletions
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 <gilles@poolp.org>
+.\"
+.\" 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