Files
inbuxa-server/vendor/sieve-rs/VENDORED.md
jcoffey-dev 926abf147d Sieve: replace and enclose inside foreverypart no longer crash delivery
replace deleted the replaced part's children by shifting the message's
part list, but left every other reference to part numbers as it was:
the child lists of the other multiparts and the parts a foreverypart
loop had still to visit. So replace inside foreverypart, which is how
RFC 5703 strips attachments, could make a later step index past the
end of the list, and enclose inside foreverypart left the loop walking
parts that no longer existed. Either panicked the delivery task, which
never released its slot in the local delivery queue and left the
message locked. Any user could do it with their own script and a
message to themselves, and any outside sender could do it to an account
that already strips attachments that way. Twenty-five such messages
stopped local delivery for every account on the node until restart,
and again after it.

Now replace renumbers the parts that are left (child lists, the body
and attachment lists, and every foreverypart loop and the part it
returns to), so the loop goes on over the parts still there, and enclose
ends any foreverypart loop it runs in, since those parts are now inside
the enclosed message. Headers are only added to or removed from a part
that exists, and the message size can no longer wrap below zero.

Found in a security review.

Test: in crates/common, an RFC 5703-style script replacing *.exe
attachments inside foreverypart panicked on a message with two nested
multipart attachments ("removal index (is 6) should be < len (is 6)").
Now both attachments are replaced and the rest kept, and foreverypart
with replace on every part, and with enclose then addheader, run to the
end.
2026-11-17 21:36:15 -07:00

5.4 KiB

sieve-rs, vendored

The published sieve-rs 0.7.3, taken from crates.io under AGPL-3.0-only, with the upstream project's name taken out of the identifiers it spells into the Sieve language (docs/spec/SPEC.md §2.4). The root Cargo.toml patches it in with [patch.crates-io].

Changes

Every changed file carries the AGPL 5(a) notice in its header.

  • src/compiler/grammar/mod.rs: the extensions scripts require and ManageSieve advertises are vnd.inbuxa.while and vnd.inbuxa.expressions. The pre-rename vnd.stalwart.* spellings are still accepted, never advertised, so a script written for upstream compiles when it's edited. Without them, the name is treated as an unknown extension and let or eval fails with "Undeclared capability". The legacy_extension_names tests cover both.
  • src/runtime/mod.rs: the default environment "name" is inbuxa Sieve (the server sets its own name on both of its runtimes anyway), and the test-only capability is vnd.inbuxa.testsuite.
  • src/lib.rs: the test-suite environment variables are vnd.inbuxa.*.
  • src/runtime/tests/comparator.rs, src/compiler/grammar/mod.rs: every :regex pattern is built through build_regex, which holds the compiled matcher and its lazy DFA to 1 MiB each (fancy-regex's default is 10 MiB), and a pattern built from variables is compiled once per run (RegexCache, 32 patterns, a field of Context in src/lib.rs and src/runtime/context.rs) instead of once for every value it is tested against. Every caller of Comparator::regex passes the cache. The sieve_regexes_are_size_limited and sieve_variable_patterns_compile_once tests in crates/common cover both.
  • src/runtime/context.rs, src/lib.rs, src/runtime/tests/test_header.rs, test_address.rs, test_body.rs, test_string.rs, test_exists.rs, src/runtime/actions/action_editheader.rs: the bytes that tests scan count against the cpu limit, one instruction for every 64 KiB (SCAN_BYTES_PER_INSTRUCTION). Header, address, body and string tests and deleteheader charge each value they compare times the number of keys, and every search for a header charges the part's header block; the total is Context::scanned_bytes. A test stops scanning once the run is over the limit, and the run fails with CPULimitReached as it does for too many instructions (deleteheader then deletes nothing). The scan_limit_tests in context.rs cover it; they run from this directory with cargo test --offline --target-dir ../../target/sieve-rs-tests scan_limit (the crate's test_suite and parse_rfc need upstream's tests/, which isn't kept).
  • src/runtime/actions/action_vacation.rs, action_notify.rs: vacation and notify stay silent for mail with Auto-Submitted other than no (RFC 3834). Upstream looked for the header as HeaderName::Other, but mail-parser 0.11 parses it as HeaderName::AutoSubmitted, so the check never ran and both answered other programs' mail, autoresponders included. Upstream 0.7.3 fails its own svtests "No reply to auto-submitted mail" and "Notifying on automated messages" for this reason. The sieve_auto_submitted_mail_gets_no_reply test in crates/common covers it.
  • src/runtime/tests/test_string.rs: string is true when any key matches any source. Upstream's break on a match only left the loop over sources, so the next key overwrote the result: string :is "a" ["a", "b"] was false while ["b", "a"] was true.
  • src/runtime/tests/test_date.rs: date :regex and currentdate :regex compare with the regex comparator (through the same size limit and cache); upstream compared them as :matches wildcard patterns, so "^20[0-9]{2}$" never matched a year. The sieve_tests_match_any_key_and_regex_dates test in crates/common covers both.
  • src/runtime/actions/action_mime.rs, src/runtime/tests/mime.rs, action_editheader.rs: replace removes the replaced part's children with Context::remove_parts, which renumbers the parts left (every multipart's child list, the body and attachment lists, and every foreverypart iterator with the part it returns to), and enclose ends any foreverypart loop it runs in. Upstream shifted the parts with Vec::remove and left the loop's ids stale, so replace or enclose inside foreverypart (RFC 5703's attachment stripping) panicked the delivery on a message with nested parts. Headers are added and removed only on a part that exists, and the message size can't wrap below zero. The sieve_replace_inside_foreverypart test in crates/common covers it.
  • Cargo.toml: the example target is dropped, with the top-level examples/ and tests/, which the server never builds. (src/ keeps its own tests modules: the crate declares them.)

Updating

When the server's Cargo.lock moves sieve-rs to a new version, Cargo stops using this copy and only warns that the patch went unused. The unit test sieve_extensions_carry_the_fork_name in crates/common fails when that happens. Re-vendor the new version from ~/.cargo/registry/src/*/sieve-rs-*, dropping the top-level tests/ and examples/ (only those: rsync --exclude /tests --exclude /examples), Cargo.lock and Cargo.toml.orig, repeat the changes above, and update the version here and in the root Cargo.toml comment. tools/fork/name-check.py covers vendor/ too, so a rename missed in a new version fails CI.