2024-02-28 16:13:13 +01:00
# Password Check Utility for Maddy
Features:
* Authenticates email accounts against the SQLite database used by Hostux panel
* Updates "last accessed" on a successful authentication
2024-02-28 16:15:57 +01:00
Configuration through environment variables:
* `HOSTUX_EMAIL_DATABASE_SQLITE` : required, path to the database containing the email addresses
* `HOSTUX_EMAIL_CHECKPW_LOGFILE` : if set, logs are written to the path indicated
2024-03-16 17:56:47 +01:00
* `HOSTUX_LOCAL_DOMAINS` : to complete `$(local_domains)` list (necessary for outbound DKIM signing, and w/ current `maddy.conf.docker` , for destination and source matching)
2024-02-28 16:15:57 +01:00
2024-02-28 16:13:13 +01:00
## Testing
### Maddy
Build the image:
```bash
2024-03-16 17:56:47 +01:00
podman build -t hostux/maddy:latest .
2024-02-28 16:13:13 +01:00
```
For `maddy.conf` :
```conf
$(hostname) = {env:MADDY_HOSTNAME}
$(primary_domain) = {env:MADDY_DOMAIN}
$(local_domains) = $(primary_domain)
tls off
auth.external hostux_auth {
helper /bin/checkpw
perdomain yes
domains $(local_domains)
}
storage.imapsql local_mailboxes {
driver sqlite3
dsn imapsql.db
}
hostname $(hostname)
table.chain local_rewrites {
optional_step regexp "(.+)\+(.+)@(.+)" "$1@$3"
optional_step static {
entry postmaster postmaster@$(primary_domain)
}
optional_step file /etc/maddy/aliases
}
msgpipeline local_routing {
destination postmaster $(local_domains) {
modify {
replace_rcpt & local_rewrites
}
deliver_to & local_mailboxes
}
default_destination {
reject 550 5.1.1 "User doesn't exist"
}
}
smtp tcp://0.0.0.0:25 {
limits {
all rate 20 1s
all concurrency 10
}
dmarc yes
check {
require_mx_record
dkim
spf
}
source $(local_domains) {
reject 501 5.1.8 "Use Submission for outgoing SMTP"
}
default_source {
destination postmaster $(local_domains) {
deliver_to & local_routing
}
default_destination {
reject 550 5.1.1 "User doesn't exist"
}
}
}
imap tcp://0.0.0.0:143 {
auth & hostux_auth
storage & local_mailboxes
}
```
```bash
2024-03-16 17:56:47 +01:00
podman volume create maddydata
2024-02-28 16:13:13 +01:00
2024-03-16 17:56:47 +01:00
podman run --rm \
2024-02-28 16:13:13 +01:00
--name maddy \
-e MADDY_HOSTNAME=mx.maddy.test \
-e MADDY_DOMAIN=maddy.test \
2024-03-16 17:56:47 +01:00
-e HOSTUX_EMAIL_DATABASE_SQLITE=/data/email-db/email.sqlite \
2024-02-28 16:13:13 +01:00
-v maddydata:/data \
2024-03-16 17:56:47 +01:00
-v email-db:/data/email-db/ \
2024-02-28 16:13:13 +01:00
-p 143:143 \
hostux/maddy:latest
2024-03-16 17:56:47 +01:00
podman run --rm -it -v maddydata:/data --entrypoint ash foxcpp/maddy:0.6
2024-02-28 16:13:13 +01:00
```
### CLI Imap Client
```bash
pip install imap-cli
export PATH="$PATH:/home/louis_guidez76/.local/bin"
```
In `~/.config/imap-cli` :
```ini
[imap]
hostname = localhost
username = louis@hostux.fr
password = ...
ssl = False
[display]
format_list =
ID: {mail_id}
Flags: {flags}
From: {from}
To: {to}
Date: {date}
Subject: {subject}
format_thread = {uid} {subject} < < < FROM { from }
format_status = {directory:>20} : {count:>5} Mails - {unseen:>5} Unseen - {recent:>5} Recent
limit = 10
2024-03-16 17:56:47 +01:00
```