more more content

This commit is contained in:
Christoph Haas 2024-12-07 16:35:10 +01:00
parent 1c028a051d
commit 30341a60a4
2 changed files with 257 additions and 0 deletions

View file

@ -0,0 +1,177 @@
---
title: Setting up Dovecot
lastUpdated: 2023-10-04
slug: ispmail-bookworm/setting-up-dovecot/
sidebar:
order: 120
---
import { Aside } from "@astrojs/starlight/components";
This chapter of our journey leads us to Dovecot the software that…
- gets emails destined to your users from Postfix and saves them to disk
- executes user-based _sieve_ filter rules (can be used to e.g. move emails to different folders based on certain criteria or to send automated vacation responses)
- allows the user to fetch emails using POP3 or IMAP
Before we get to the actual configuration for security reasons I recommend that you create a new system user that will own all virtual mailboxes. The following shell commands will create a system group “vmail” with GID (group ID) 5000 and a system user “vmail” with UID (user ID) 5000. (Make sure that UID and GID are not yet used or choose another the number can be anything between 1000 and 65000 that is not yet used):
```
groupadd -g 5000 vmail
useradd -g vmail -u 5000 vmail -d /var/vmail -m
```
If the /var/vmail directory was already there because you assigned it a dedicated mount point then you should make sure that the permissions are set correctly:
```
chown -R vmail:vmail /var/vmail
```
The configuration files for Dovecot are found in `/etc/dovecot/conf.d`/. All these files are loaded by Dovecot. This is done by this magical line at the end of the `/etc/dovecot/dovecot.conf` file:
```
!include conf.d/*.conf
```
It loads all files in `/etc/dovecot/conf.d/` that end in “.conf” in alphanumerical order. So “10-auth.conf” is loaded first and “90-sieve-extprograms.conf” is loaded last. The big advantage is that you can edit or replace parts of the configuration without having to overwrite the entire configuration. The main `/etc/dovecot/dovecot.conf` file does not require any changes. Those other files in conf.d/ however do.
## conf.d/
### 10-auth.conf
The most common [authentication mechanism](https://doc.dovecot.org/configuration_manual/authentication/authentication_mechanisms/#authentication-authentication-mechanisms) is called _PLAIN_. However if you have Outl\*\*k users then you may need to add the _LOGIN_ mechanism, too.:
```
auth_mechanisms = plain login
```
These two mechanisms would ask for a password without enforcing encryption to secure the password. But dont worry. By default Dovecot sets `disable_plaintext_auth = yes` which ensures that authentication is only accepted over TLS-encrypted connections.
At the end of this file you will find various authentication backends that Dovecot ships with. By default it will use system users (those from the /etc/passwd). But we want to use the MariaDB database backend so go ahead and change this block to:
```
#!include auth-system.conf.ext
!include auth-sql.conf.ext
#!include auth-ldap.conf.ext
#!include auth-passwdfile.conf.ext
#!include auth-checkpassword.conf.ext
#!include auth-static.conf.ext
```
### 10-mail.conf
Change the mail_location setting to:
```
mail_location = maildir:~/Maildir
```
This is the directory where Dovecot will look for the emails of a specific user. The tilde character (~) means the users _home directory_. That does not make sense yet. But further down on this page we will tell Dovecot what the _home directory_ is supposed to mean. For example `john@example.org` will have his home directory in /var/vmail/example.org/john.
Further down in the 10-mail.conf file you will find sections defining the [namespaces](https://doc.dovecot.org/configuration_manual/namespace/). Those are folder structures that your email program sees when connecting to the mail server. If you use POP3 you can only access the “inbox” which is where all incoming email is stored. Using the IMAP protocol you get access to a hierarchy of folders and subfolders. And you can even share folders between users. Or use a public folder that can be accessed by anyone even anonymously. So IMAP is generally to be preferred.
Also edit the “mail_plugins” line to enable the _quota_ plugin we will configure later and turn it into:
```
mail_plugins = quota
```
<Aside type="danger" title="Check your separator setting!">
Migrating from a previous server? Previous versions of this guide told you to set the “separator” to either “.” or “/”. The default leads to a folder structure like:
"/var/vmail/example.org/john/Maildir/.INBOX.staff.marketing.simon".
If you see folders like this…
"/var/vmail/example.org/john/Maildir/INBOX/staff/marketing/simon"
…then please read Dovecots notes on the directory structure and the hierarchy separator. Hint: LAYOUT=fs.
</Aside>
### 10-master.conf
This configuration file deals with typical service ports like IMAP or POP3.
<Aside type="tip" title="Plaintext services? Really?">
Dont worry about the standard unencrypted TCP ports 110 (for POP3) and 143 (for IMAP). They can be kept accessible. If a user connects to these ports they will have to issue a _STARTTLS_ command to switch into encrypted mode before they are allowed to send their password. There is basically no difference between using an plaintext port like 110 for POP3 and then using _STARTTLS_ or connecting to the encrypted 995 port for POP3S (=secure). See the [Dovecot documentation](https://doc.dovecot.org/admin_manual/ssl/) for another explanation.
</Aside>
So most settings are sane here and do not have to be changed. However one change is required in the “service auth” section because we want Postfix to allow Dovecot as an authentication service. Make it look like this:
```
# Postfix smtp-auth
unix_listener /var/spool/postfix/private/auth {
mode = 0660
user = postfix
group = postfix
}
```
Well, Postfix runs in a chroot environment located at /var/spool/postfix. It can't access anything outside of that directory. So to allow communication with Postfix we tell Dovecot to place a communication socket into that chroot.
### 10-ssl.conf
Earlier in this guide you created both a key and a certificate file to encrypt the communication with POP3, IMAPs and HTTPS between the users and your mail server. You need to tell Dovecot where to find these files:
<pre>
ssl\_cert = \</etc/letsencrypt/live/**webmail.example.org**/fullchain.pem
ssl\_key = \</etc/letsencrypt/live/**webmail.example.org**/privkey.pem
</pre>
And enforce TLS encryption by setting:
```
ssl = required
```
See the [Dovecot documentation on SSL encryption](https://doc.dovecot.org/admin_manual/ssl/) for more information.
Next lets take a look at how Dovecot knows about users and their passwords:
### auth-sql.conf.ext
Dovecot reads the `auth-sql.conf.ext` which defines how to find user information in your database. Open the file. There are two sections:
- userdb: where to find a users mailbox in the file system
- passdb: where to find the users hashed password
By default Dovecot will run two queries at your database. One for the _userdb_ that gets information like the user ID, group ID, home directory and quota. And another for the _passdb_ that gets the hashed password.
The “userdb” section already reads:
```
userdb {
driver = sql
args = /etc/dovecot/dovecot-sql.conf.ext
}
```
As you can see Dovecot uses an SQL database lookup to get that information. And it refers to the dovecot-sql.conf.ext file for more information. Lets see…
## /etc/dovecot/dovecot-sql.conf.ext
(This configuration file is one level up and not in “conf.d”.)
You will find this file well documented although all configuration directives are commented out. Add these lines at the bottom of the file:
<pre>
driver = mysql
connect = \\
host=127.0.0.1 \\
dbname=mailserver \\
user=mailserver \\
password=**x893dNj4stkHy1MKQq0USWBaX4ZZdq**
user_query = SELECT email as user, \\
concat('*:bytes=', quota) AS quota_rule, \\
'/var/vmail/%d/%n' AS home, \\
5000 AS uid, 5000 AS gid \\
FROM virtual_users WHERE email='%u'
password_query = SELECT password FROM virtual_users WHERE email='%u'
iterate_query = SELECT email AS user FROM virtual_users
</pre>
```
driver = mysql
connect = \\
host=127.0.0.1 \\
dbname=mailserver \\
user=mailserver \\
password=**x893dNj4stkHy1MKQq0USWBaX4ZZdq**
user_query = SELECT email as user, \\
concat('*:bytes=', quota) AS quota_rule, \\
'/var/vmail/%d/%n' AS home, \\
5000 AS uid, 5000 AS gid \\
FROM virtual_users WHERE email='%u'
password_query = SELECT password FROM virtual_users WHERE email='%u'
iterate_query = SELECT email AS user FROM virtual_users
```