Loading Sieve script from external file fails

[nmxhc]

Hi,

I have a Sieve script redirects that is supposed to redirect some mail. Because the mapping from addresses to their destination is supposed to be private and will be long I want to move the script in its own file to separate it from the config. The script will then be deployed in a different way.

When the script is inlined in the config as follows it forwards mail as expected:

[session]
[session.data]
script = "'redirects'"

[sieve.trusted.scripts.redirects]
contents = "require [\"envelope\"];\n if envelope :is \"to\" \"me@example.com\" {\n  redirect \"me@example.org\";\n}\n"

When the same script is referenced externally as described in the docs it fails:

[session]
[session.data]
script = "'redirects'"

[sieve.trusted.scripts.redirects]
contents = "file:///run/secrets/mailForwardSieve"

with ERROR Configuration build error (config.build-error) details = "Build error for key "sieve.trusted.scripts.redirects.contents": Failed to compile Sieve script: Expected token "command" but found "file" at line 0, column 0." at service startup time and mail is not forwarded.

I verified that the file is readable via

[me@host:~]$ sudo -u stalwart-mail -g stalwart-mail cat /run/secrets/mailForwardSieve
require ["envelope"];

if envelope :is "to" "me@example.com" {
  redirect "me@example.org";
}

[me@host:~]$ 

The complete startup log with level `trace`

Starting Stalwart Mail Server Server...
Started Stalwart Mail Server Server.
INFO Starting Stalwart Mail Server v0.9.2 (server.startup) version = 0.9.2
TRACE Data store iteration operation (store.data-iterate) elapsed = 0ms
TRACE Data store iteration operation (store.data-iterate) elapsed = 0ms
TRACE Blob read operation (store.blob-read) key = base64:U1RBTFdBUlRfV0VCQURNSU4=, elapsed = 4ms, size = 1902837
INFO Webadmin resource unpacked (resource.webadmin-unpacked) path = "/tmp/STALWART_WEBADMIN"
ERROR Configuration build error (config.build-error) details = "Build error for key "sieve.trusted.scripts.redirects.contents": Failed to compile Sieve script: Expected token "command" but found "file" at line 0, column 0."
ERROR Configuration build error (config.build-error) details = "Build error for key "*": Failed to update configuration: Configuration write error (config.write-error): reason = Read-only file system (os error 30), details = Failed to write local configuration, path = /nix/store/nzjp11yj4y5kkpbdrm9z6annbc27w3s2-stalwart-mail.toml"
INFO Network listener started (network.listen-start) listenerId = "imaptls", localIp = ::, localPort = 993, tls = true
INFO Network listener started (network.listen-start) listenerId = "management", localIp = ::, localPort = 80, tls = false
INFO Network listener started (network.listen-start) listenerId = "smtp", localIp = ::, localPort = 25, tls = false
INFO Network listener started (network.listen-start) listenerId = "submissions", localIp = ::, localPort = 465, tls = true
INFO Housekeeper process started (housekeeper.start)
DEBUG Housekeeper task scheduled (housekeeper.schedule) due = 2024-09-03T18:14:59Z, id = "Session"
DEBUG Housekeeper task scheduled (housekeeper.schedule) due = 2024-09-03T23:59:59Z, id = "Account"
DEBUG Housekeeper task scheduled (housekeeper.schedule) due = 2024-09-04T02:59:59Z, id = "Store(0)"
DEBUG Housekeeper task scheduled (housekeeper.schedule) due = 2024-09-04T03:59:59Z, id = "Store(1)"
DEBUG Housekeeper task scheduled (housekeeper.schedule) due = 2024-09-04T04:59:59Z, id = "Store(2)"
TRACE Data store iteration operation (store.data-iterate) elapsed = 0ms

I am running on version v0.9.2.

I also considered using the include feature of Sieve (RFC 6609) to load the file but that seems to expect an already loaded script and not a file.

Thanks for your considerations.

[mdecimus]

Hi,

Sieve scripts are stored in the database by default and these types of settings do not support macros. You need to make the sieve.trusted.scripts prefix local for this to work.

[nmxhc]

Hi,

thanks for your hints. With them I was able to produce a working config. However, it diverges from the format mentioned in the docs on Sieve Trusted Interpreter from which I would expect

[sieve.trusted.scripts.redirects]
contents = "file:///run/secrets/mailForwardSieve"

to work without using macros. Might that be a documentation bug?

The working config is:

[config]
local-keys = ["store.*", "directory.*", "tracer.*", "server.*", "!server.blocked-ip.*", "authentication.fallback-admin.*", "cluster.node-id", "storage.data", "storage.blob", "storage.lookup", "
storage.fts", "storage.directory", "lookup.default.hostname", "certificate.*", "sieve.trusted.scripts.*"]

[session]
[session.data]
script = "'redirects'"

[sieve.trusted.scripts.redirects]
contents = "%{file:/run/secrets/mailForwardSieve}%"

[nmxhc]

Is this a documentation bug?

[mdecimus]

Yes, it is outdated, I'll fix that now.