1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
.\"
.\" Copyright (c) 2014 Jason Barbier <kusuriya@serversave.us>
.\"
.\" 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: June 17 2014 $
.Dt TABLE_SQLITE 5
.Os
.Sh NAME
.Nm table_sqlite
.Nd format description for smtpd sqlite tables
.Sh DESCRIPTION
This manual page documents the file format of sqlite 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 SQLITE TABLE
A sqlite table allows the storing of usernames, passwords, aliases, and domains
in a format that is shareable across various machines that support
.Xr sqlite3 1
(SQLite version 3).
.Pp
The table is used by
.Xr smtpd 8
when authenticating a user, when user information such as user-id and/or
home directory is required for a delivery, when a domain lookup may be required,
and/or when looking for an alias.
.Pp
A sqlite table consists of one or more
.Xr sqlite3 1
databases with one or more tables.
.Pp
If the table is used for authentication, the password should be
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 SQLITE TABLE CONFIG FILE
The following configuration options are available:
.Pp
.Bl -tag -width Ds
.It Xo
.Ic dbpath
.Ar file
.Xc
This is the path to where the DB is located with the dbname.
For example:
.Bd -literal -offset indent
dbpath /etc/mail/smtp.sqlite
.Ed
.Pp
.It Xo
.Ic query_alias
.Ar SQL statement
.Xc
This is used to provide a query to look up aliases. The question mark
is replaced with the appropriate data. For alias it is the left hand side of
the SMTP address. This expects one VARCHAR to be returned with the user name
the alias resolves to.
.Pp
.It Xo
.Ic query_credentials
.Ar SQL statement
.Xc
This is used to provide a query for looking up user credentials. The question
mark is replaced with the appropriate data. For credentials it is the left
hand side of the SMTP address. The query expects that there are two VARCHARS
returned, one with a user name and one with a password in
.Xr crypt 3
format.
.Pp
.It Xo
.Ic query_domain
.Ar SQL statement
.Xc
This is used to provide a query for looking up a domain. The question mark
is replaced with the appropriate data. For the domain it would be the
right hand side of the SMTP address. This expects one VARCHAR to be returned
with a matching domain name.
.El
A generic SQL statement would be something like:
.Bd -literal -offset indent
query_ SELECT value FROM table WHERE key=?;
.Ed
.Sh EXAMPLES
Those provided here a known to work.
.Ic Pa sqlite3 schema
.Bd -literal -compact
CREATE TABLE aliases (
id INTEGER PRIMARY KEY AUTOINCREMENT,
email VARCHAR(255) NOT NULL,
destination VARCHAR(255) NOT NULL
);
CREATE TABLE credentials (
id INTEGER PRIMARY KEY AUTOINCREMENT,
email VARCHAR(255) NOT NULL,
password VARCHAR(255) NOT NULL
);
CREATE TABLE domains (
id INTEGER PRIMARY KEY AUTOINCREMENT,
domain VARCHAR(255) NOT NULL
);
.Ed
.Ic Pa /etc/mail/sqlite.conf
.Bd -literal -compact
dbpath /etc/mail/smtp.sqlite
query_alias SELECT destination FROM aliases WHERE email=?;
query_credentials SELECT email, password FROM credentials WHERE email=?;
query_domain SELECT domain FROM domains WHERE domain=?;
.Ed
.Ic Pa /etc/mail/smtpd.conf
.Bd -literal -compact
table domains sqlite:/etc/mail/sqlite.conf
table virtuals sqlite:/etc/mail/sqlite.conf
table credentials sqlite:/etc/mail/sqlite.conf
listen on egress port 587 tls-require pki mx.domain.tld auth <credentials>
accept from any for domain <domains> virtual <virtuals> deliver to mbox
.Ed
.Sh FILES
.Bl -tag -width "/etc/mail/sqlite.conf" -compact
.It Pa /etc/mail/sqlite.conf
Suggested
.Xr table-sqlite 8
configuration file.
.It Pa /etc/mail/smtp.sqlite
Suggested
.Xr sqlite3 1
database file.
.El
.Sh SEE ALSO
.Xr smtpd.conf 5 ,
.Xr smtpctl 8 ,
.Xr smtpd 8 ,
.Xr encrypt 1 ,
.Xr crypt 3
|
