diff --git a/CHANGELOG b/CHANGELOG index f13c2143..cce5d437 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,10 @@ +stalwart-mail v0.3.1 +================================ +- Added: Milter filter support. Documentation is available [here](https://stalw.art/docs/smtp/filter/milter). +- Added: Match IP address type using /0 mask (#16). +- Fix: Support for OpenLDAP password hashing schemes between curly brackets (#8). +- Fix: Add CA certificates to Docker runtime (#5). + stalwart-mail v0.3.0 ================================ - Merged the `stalwart-jmap`, `stalwart-imap` and `stalwart-smtp` repositories into diff --git a/Dockerfile b/Dockerfile index 6cb6c359..af3a3ba3 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,53 +1,16 @@ -FROM debian:buster-slim AS chef -RUN apt-get update && \ - export DEBIAN_FRONTEND=noninteractive && \ - apt-get install -yq \ - build-essential \ - cmake \ - clang \ - curl \ - protobuf-compiler -ENV RUSTUP_HOME=/opt/rust/rustup \ - PATH=/home/root/.cargo/bin:/opt/rust/cargo/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin -RUN curl https://sh.rustup.rs -sSf | \ - env CARGO_HOME=/opt/rust/cargo \ - sh -s -- -y --default-toolchain stable --profile minimal --no-modify-path && \ - env CARGO_HOME=/opt/rust/cargo \ - rustup component add rustfmt -RUN env CARGO_HOME=/opt/rust/cargo cargo install cargo-chef && \ - rm -rf /opt/rust/cargo/registry/ -WORKDIR /app +FROM debian:bullseye-slim -FROM chef AS planner -COPY Cargo.toml . -COPY Cargo.lock . -COPY crates/ crates/ -COPY resources/ resources/ -COPY tests/ tests/ -RUN cargo chef prepare --recipe-path recipe.json +RUN apt-get update -y && apt-get install -yq ca-certificates curl tar -FROM chef AS builder -COPY --from=planner /app/recipe.json recipe.json -RUN cargo chef cook --release --recipe-path recipe.json -COPY Cargo.toml . -COPY Cargo.lock . -COPY crates/ crates/ -COPY resources/ resources/ -COPY tests/ tests/ -RUN cargo build --manifest-path=crates/main/Cargo.toml --release -RUN cargo build --manifest-path=crates/install/Cargo.toml --release +COPY resources/docker/configure.sh /usr/local/bin/configure.sh +COPY resources/docker/entrypoint.sh /usr/local/bin/entrypoint.sh -FROM debian:buster-slim AS runtime +RUN chmod a+rx /usr/local/bin/*.sh -COPY --from=builder /app/target/release/stalwart-mail /usr/local/bin/stalwart-mail -COPY --from=builder /app/target/release/stalwart-install /usr/local/bin/stalwart-install -RUN apt-get update -y && apt-get install -yq ca-certificates -RUN echo "#\!/bin/sh\n\n/usr/local/bin/stalwart-install -c all-in-one -p /opt/stalwart-mail -d" > /usr/local/bin/configure.sh && \ - chmod +x /usr/local/bin/configure.sh RUN useradd stalwart-mail -s /sbin/nologin -M RUN mkdir -p /opt/stalwart-mail RUN chown stalwart-mail:stalwart-mail /opt/stalwart-mail -VOLUME [ "/opt/stalwart-mail" ] +EXPOSE 8080 25 587 465 8686 143 993 4190 -ENTRYPOINT ["/usr/local/bin/stalwart-mail", "--config", "/opt/stalwart-mail/etc/config.toml"] +ENTRYPOINT ["/bin/sh", "/usr/local/bin/entrypoint.sh"] diff --git a/crates/install/src/main.rs b/crates/install/src/main.rs index 4c788de1..e2d91638 100644 --- a/crates/install/src/main.rs +++ b/crates/install/src/main.rs @@ -334,19 +334,23 @@ fn main() -> std::io::Result<()> { } }) { Ok(Ok(bytes)) => { + let unpack_path = if !args.docker { + base_path.join("bin") + } else { + PathBuf::from("/usr/local/bin") + }; + #[cfg(not(target_env = "msvc"))] if let Err(err) = tar::Archive::new(flate2::bufread::GzDecoder::new(Cursor::new(bytes))) - .unpack(base_path.join("bin")) + .unpack(unpack_path) { eprintln!("❌ Failed to unpack {}: {}", url, err); return Ok(()); } #[cfg(target_env = "msvc")] - if let Err(err) = - zip_extract::extract(Cursor::new(bytes), &base_path.join("bin"), true) - { + if let Err(err) = zip_extract::extract(Cursor::new(bytes), &unpack_path, true) { eprintln!("❌ Failed to unpack {}: {}", url, err); return Ok(()); } diff --git a/crates/smtp/src/config/session.rs b/crates/smtp/src/config/session.rs index a50c0467..96041ada 100644 --- a/crates/smtp/src/config/session.rs +++ b/crates/smtp/src/config/session.rs @@ -457,7 +457,7 @@ impl ConfigSession for Config { )?, protocol_version: match self.property_or_static::( ("session.data.milter", id, "options.version"), - "2", + "6", )? { 6 => milter::Version::V6, 2 => milter::Version::V2, diff --git a/crates/smtp/src/inbound/data.rs b/crates/smtp/src/inbound/data.rs index f02ef917..1ec1d8ec 100644 --- a/crates/smtp/src/inbound/data.rs +++ b/crates/smtp/src/inbound/data.rs @@ -286,10 +286,25 @@ impl Session { // Run Milter filters let mut edited_message = match self.run_milters(&auth_message).await { - Ok(modifications) => self - .data - .apply_modifications(modifications, &auth_message) - .map(Arc::new), + Ok(modifications) => { + tracing::debug!( + parent: &self.span, + context = "milter", + event = "accept", + modifications = modifications.iter().fold(String::new(), |mut s, m| { + use std::fmt::Write; + if !s.is_empty() { + s.push_str(", "); + } + let _ = write!(s, "{m}"); + s + }), + "Milter filter(s) accepted message."); + + self.data + .apply_modifications(modifications, &auth_message) + .map(Arc::new) + } Err(response) => return response, }; diff --git a/crates/smtp/src/inbound/milter/message.rs b/crates/smtp/src/inbound/milter/message.rs index 863f57c4..eccb16b5 100644 --- a/crates/smtp/src/inbound/milter/message.rs +++ b/crates/smtp/src/inbound/milter/message.rs @@ -335,10 +335,11 @@ impl SessionData { needs_rewrite = true; } Modification::ChangeHeader { index, name, value } => { - if message - .raw_parsed_headers() - .iter() - .any(|(n, _)| n.eq_ignore_ascii_case(name.as_bytes())) + if value.is_empty() + || message + .raw_parsed_headers() + .iter() + .any(|(n, _)| n.eq_ignore_ascii_case(name.as_bytes())) { header_changes.push((index, name, value, true)); needs_rewrite = true; diff --git a/crates/smtp/src/inbound/milter/protocol.rs b/crates/smtp/src/inbound/milter/protocol.rs index 1af6a4e4..09fad424 100644 --- a/crates/smtp/src/inbound/milter/protocol.rs +++ b/crates/smtp/src/inbound/milter/protocol.rs @@ -413,7 +413,7 @@ impl Response { buf } Modification::ReplaceBody { value } => { - let mut buf = Command::build(SMFIR_REPLBODY, value.len() as u32 + 1); + let mut buf = Command::build(SMFIR_REPLBODY, value.len() as u32); buf.extend(value); buf } diff --git a/resources/config/smtp.toml b/resources/config/smtp.toml index 80652963..0a57ed6f 100644 --- a/resources/config/smtp.toml +++ b/resources/config/smtp.toml @@ -81,6 +81,24 @@ wait = "5s" [session.data] #script = "data" +#[session.data.milter."rspamd"] +#enable = [ { if = "listener", eq = "smtp", then = true }, +# { else = false } ] +#hostname = "127.0.0.1" +#port = 11332 +#tls = false +#allow-invalid-certs = false + +#[session.data.milter."rspamd".timeout] +#connect = "30s" +#command = "30s" +#data = "60s" + +#[session.data.milter."rspamd".options] +#tempfail-on-error = true +#max-response-size = 52428800 # 50mb +#version = 6 + #[session.data.pipe."spam-assassin"] #command = "spamc" #arguments = [] diff --git a/resources/docker/Dockerfile.fdb b/resources/docker/Dockerfile.fdb new file mode 100644 index 00000000..2d5ab0d8 --- /dev/null +++ b/resources/docker/Dockerfile.fdb @@ -0,0 +1,49 @@ +FROM debian:buster-slim AS chef +RUN apt-get update && \ + export DEBIAN_FRONTEND=noninteractive && \ + apt-get install -yq \ + build-essential \ + cmake \ + clang \ + curl \ + protobuf-compiler +ENV RUSTUP_HOME=/opt/rust/rustup \ + PATH=/home/root/.cargo/bin:/opt/rust/cargo/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin +RUN curl https://sh.rustup.rs -sSf | \ + env CARGO_HOME=/opt/rust/cargo \ + sh -s -- -y --default-toolchain stable --profile minimal --no-modify-path && \ + env CARGO_HOME=/opt/rust/cargo \ + rustup component add rustfmt +RUN wget https://github.com/apple/foundationdb/releases/download/7.1.0/foundationdb-clients_7.1.0-1_amd64.deb && \ + dpkg -i foundationdb-clients_7.1.0-1_amd64.deb +RUN env CARGO_HOME=/opt/rust/cargo cargo install cargo-chef && \ + rm -rf /opt/rust/cargo/registry/ +WORKDIR /app + +FROM chef AS planner +COPY Cargo.toml . +COPY Cargo.lock . +COPY crates/ crates/ +COPY resources/ resources/ +COPY tests/ tests/ +RUN cargo chef prepare --recipe-path recipe.json + +FROM chef AS builder +COPY --from=planner /app/recipe.json recipe.json +RUN cargo chef cook --release --recipe-path recipe.json +COPY Cargo.toml . +COPY Cargo.lock . +COPY crates/ crates/ +COPY resources/ resources/ +COPY tests/ tests/ +RUN cargo build --manifest-path=crates/main/Cargo.toml --no-default-features --features foundationdb --release + +FROM debian:buster-slim AS runtime + +COPY --from=builder /app/target/release/stalwart-mail /usr/local/bin/stalwart-mail +RUN apt-get update -y && apt-get install -yq ca-certificates +RUN useradd stalwart-mail -s /sbin/nologin -M +RUN mkdir -p /opt/stalwart-mail +RUN chown stalwart-mail:stalwart-mail /opt/stalwart-mail + +ENTRYPOINT ["/usr/local/bin/stalwart-mail", "--config", "/opt/stalwart-mail/etc/config.toml"] diff --git a/resources/docker/configure.sh b/resources/docker/configure.sh new file mode 100644 index 00000000..95d5e564 --- /dev/null +++ b/resources/docker/configure.sh @@ -0,0 +1,610 @@ +#!/usr/bin/env sh +# shellcheck shell=dash + +# Stalwart Mail install script -- based on the rustup installation script. + +set -e +set -u + +readonly BASE_URL="https://github.com/stalwartlabs/mail-server/releases/latest/download" + +main() { + downloader --check + need_cmd uname + need_cmd mktemp + need_cmd chmod + need_cmd mkdir + need_cmd rm + need_cmd rmdir + need_cmd tar + + # Make sure we are running as root + if [ "$(id -u)" -ne 0 ] ; then + err "❌ Install failed: This program needs to run as root." + fi + + # Detect OS + local _os="unknown" + local _uname="$(uname)" + _account="stalwart-mail" + if [ "${_uname}" = "Linux" ]; then + _os="linux" + elif [ "${_uname}" = "Darwin" ]; then + _os="macos" + _account="_stalwart-mail" + fi + + # Start configuration mode + if [ "$#" -eq 1 ] && [ "$1" = "--init" ] ; then + init + configure + return 0 + fi + + # Detect platform architecture + get_architecture || return 1 + local _arch="$RETVAL" + assert_nz "$_arch" "arch" + + # Download latest binary + say "⏳ Downloading configure tool for ${_arch}..." + local _dir + _dir="$(ensure mktemp -d)" + local _file="${_dir}/stalwart-install.tar.gz" + local _url="${BASE_URL}/stalwart-install-${_arch}.tar.gz" + ensure mkdir -p "$_dir" + ensure downloader "$_url" "$_file" "$_arch" + + # Copy binary + say "⬇️ Running configuration wizard..." + ensure tar zxvf "$_file" -C "$_dir" + ignore $_dir/stalwart-install -p /opt/stalwart-mail -d + ignore rm "$_file" + ignore rm "$_dir/stalwart-install" + + return 0 +} + +get_architecture() { + local _ostype _cputype _bitness _arch _clibtype + _ostype="$(uname -s)" + _cputype="$(uname -m)" + _clibtype="gnu" + + if [ "$_ostype" = Linux ]; then + if [ "$(uname -o)" = Android ]; then + _ostype=Android + fi + if ldd --version 2>&1 | grep -q 'musl'; then + _clibtype="musl" + fi + fi + + if [ "$_ostype" = Darwin ] && [ "$_cputype" = i386 ]; then + # Darwin `uname -m` lies + if sysctl hw.optional.x86_64 | grep -q ': 1'; then + _cputype=x86_64 + fi + fi + + if [ "$_ostype" = SunOS ]; then + # Both Solaris and illumos presently announce as "SunOS" in "uname -s" + # so use "uname -o" to disambiguate. We use the full path to the + # system uname in case the user has coreutils uname first in PATH, + # which has historically sometimes printed the wrong value here. + if [ "$(/usr/bin/uname -o)" = illumos ]; then + _ostype=illumos + fi + + # illumos systems have multi-arch userlands, and "uname -m" reports the + # machine hardware name; e.g., "i86pc" on both 32- and 64-bit x86 + # systems. Check for the native (widest) instruction set on the + # running kernel: + if [ "$_cputype" = i86pc ]; then + _cputype="$(isainfo -n)" + fi + fi + + case "$_ostype" in + + Android) + _ostype=linux-android + ;; + + Linux) + check_proc + _ostype=unknown-linux-$_clibtype + _bitness=$(get_bitness) + ;; + + FreeBSD) + _ostype=unknown-freebsd + ;; + + NetBSD) + _ostype=unknown-netbsd + ;; + + DragonFly) + _ostype=unknown-dragonfly + ;; + + Darwin) + _ostype=apple-darwin + ;; + + illumos) + _ostype=unknown-illumos + ;; + + MINGW* | MSYS* | CYGWIN* | Windows_NT) + _ostype=pc-windows-gnu + ;; + + *) + err "unrecognized OS type: $_ostype" + ;; + + esac + + case "$_cputype" in + + i386 | i486 | i686 | i786 | x86) + _cputype=i686 + ;; + + xscale | arm) + _cputype=arm + if [ "$_ostype" = "linux-android" ]; then + _ostype=linux-androideabi + fi + ;; + + armv6l) + _cputype=arm + if [ "$_ostype" = "linux-android" ]; then + _ostype=linux-androideabi + else + _ostype="${_ostype}eabihf" + fi + ;; + + armv7l | armv8l) + _cputype=armv7 + if [ "$_ostype" = "linux-android" ]; then + _ostype=linux-androideabi + else + _ostype="${_ostype}eabihf" + fi + ;; + + aarch64 | arm64) + _cputype=aarch64 + ;; + + x86_64 | x86-64 | x64 | amd64) + _cputype=x86_64 + ;; + + mips) + _cputype=$(get_endianness mips '' el) + ;; + + mips64) + if [ "$_bitness" -eq 64 ]; then + # only n64 ABI is supported for now + _ostype="${_ostype}abi64" + _cputype=$(get_endianness mips64 '' el) + fi + ;; + + ppc) + _cputype=powerpc + ;; + + ppc64) + _cputype=powerpc64 + ;; + + ppc64le) + _cputype=powerpc64le + ;; + + s390x) + _cputype=s390x + ;; + riscv64) + _cputype=riscv64gc + ;; + *) + err "unknown CPU type: $_cputype" + + esac + + # Detect 64-bit linux with 32-bit userland + if [ "${_ostype}" = unknown-linux-gnu ] && [ "${_bitness}" -eq 32 ]; then + case $_cputype in + x86_64) + if [ -n "${RUSTUP_CPUTYPE:-}" ]; then + _cputype="$RUSTUP_CPUTYPE" + else { + # 32-bit executable for amd64 = x32 + if is_host_amd64_elf; then { + echo "This host is running an x32 userland; as it stands, x32 support is poor," 1>&2 + echo "and there isn't a native toolchain -- you will have to install" 1>&2 + echo "multiarch compatibility with i686 and/or amd64, then select one" 1>&2 + echo "by re-running this script with the RUSTUP_CPUTYPE environment variable" 1>&2 + echo "set to i686 or x86_64, respectively." 1>&2 + echo 1>&2 + echo "You will be able to add an x32 target after installation by running" 1>&2 + echo " rustup target add x86_64-unknown-linux-gnux32" 1>&2 + exit 1 + }; else + _cputype=i686 + fi + }; fi + ;; + mips64) + _cputype=$(get_endianness mips '' el) + ;; + powerpc64) + _cputype=powerpc + ;; + aarch64) + _cputype=armv7 + if [ "$_ostype" = "linux-android" ]; then + _ostype=linux-androideabi + else + _ostype="${_ostype}eabihf" + fi + ;; + riscv64gc) + err "riscv64 with 32-bit userland unsupported" + ;; + esac + fi + + # Detect armv7 but without the CPU features Rust needs in that build, + # and fall back to arm. + # See https://github.com/rust-lang/rustup.rs/issues/587. + if [ "$_ostype" = "unknown-linux-gnueabihf" ] && [ "$_cputype" = armv7 ]; then + if ensure grep '^Features' /proc/cpuinfo | grep -q -v neon; then + # At least one processor does not have NEON. + _cputype=arm + fi + fi + + _arch="${_cputype}-${_ostype}" + + RETVAL="$_arch" +} + +check_proc() { + # Check for /proc by looking for the /proc/self/exe link + # This is only run on Linux + if ! test -L /proc/self/exe ; then + err "fatal: Unable to find /proc/self/exe. Is /proc mounted? Installation cannot proceed without /proc." + fi +} + +get_bitness() { + need_cmd head + # Architecture detection without dependencies beyond coreutils. + # ELF files start out "\x7fELF", and the following byte is + # 0x01 for 32-bit and + # 0x02 for 64-bit. + # The printf builtin on some shells like dash only supports octal + # escape sequences, so we use those. + local _current_exe_head + _current_exe_head=$(head -c 5 /proc/self/exe ) + if [ "$_current_exe_head" = "$(printf '\177ELF\001')" ]; then + echo 32 + elif [ "$_current_exe_head" = "$(printf '\177ELF\002')" ]; then + echo 64 + else + err "unknown platform bitness" + fi +} + +is_host_amd64_elf() { + need_cmd head + need_cmd tail + # ELF e_machine detection without dependencies beyond coreutils. + # Two-byte field at offset 0x12 indicates the CPU, + # but we're interested in it being 0x3E to indicate amd64, or not that. + local _current_exe_machine + _current_exe_machine=$(head -c 19 /proc/self/exe | tail -c 1) + [ "$_current_exe_machine" = "$(printf '\076')" ] +} + +get_endianness() { + local cputype=$1 + local suffix_eb=$2 + local suffix_el=$3 + + # detect endianness without od/hexdump, like get_bitness() does. + need_cmd head + need_cmd tail + + local _current_exe_endianness + _current_exe_endianness="$(head -c 6 /proc/self/exe | tail -c 1)" + if [ "$_current_exe_endianness" = "$(printf '\001')" ]; then + echo "${cputype}${suffix_el}" + elif [ "$_current_exe_endianness" = "$(printf '\002')" ]; then + echo "${cputype}${suffix_eb}" + else + err "unknown platform endianness" + fi +} + +say() { + printf 'stalwart-mail: %s\n' "$1" +} + +err() { + say "$1" >&2 + exit 1 +} + +need_cmd() { + if ! check_cmd "$1"; then + err "need '$1' (command not found)" + fi +} + +check_cmd() { + command -v "$1" > /dev/null 2>&1 +} + +assert_nz() { + if [ -z "$1" ]; then err "assert_nz $2"; fi +} + +# Run a command that should never fail. If the command fails execution +# will immediately terminate with an error showing the failing +# command. +ensure() { + if ! "$@"; then err "command failed: $*"; fi +} + +# This wraps curl or wget. Try curl first, if not installed, +# use wget instead. +downloader() { + local _dld + local _ciphersuites + local _err + local _status + local _retry + if check_cmd curl; then + _dld=curl + elif check_cmd wget; then + _dld=wget + else + _dld='curl or wget' # to be used in error message of need_cmd + fi + + if [ "$1" = --check ]; then + need_cmd "$_dld" + elif [ "$_dld" = curl ]; then + check_curl_for_retry_support + _retry="$RETVAL" + get_ciphersuites_for_curl + _ciphersuites="$RETVAL" + if [ -n "$_ciphersuites" ]; then + _err=$(curl $_retry --proto '=https' --tlsv1.2 --ciphers "$_ciphersuites" --silent --show-error --fail --location "$1" --output "$2" 2>&1) + _status=$? + else + echo "Warning: Not enforcing strong cipher suites for TLS, this is potentially less secure" + if ! check_help_for "$3" curl --proto --tlsv1.2; then + echo "Warning: Not enforcing TLS v1.2, this is potentially less secure" + _err=$(curl $_retry --silent --show-error --fail --location "$1" --output "$2" 2>&1) + _status=$? + else + _err=$(curl $_retry --proto '=https' --tlsv1.2 --silent --show-error --fail --location "$1" --output "$2" 2>&1) + _status=$? + fi + fi + if [ -n "$_err" ]; then + if echo "$_err" | grep -q 404; then + err "❌ Binary for platform '$3' not found, this platform may be unsupported." + else + echo "$_err" >&2 + fi + fi + return $_status + elif [ "$_dld" = wget ]; then + if [ "$(wget -V 2>&1|head -2|tail -1|cut -f1 -d" ")" = "BusyBox" ]; then + echo "Warning: using the BusyBox version of wget. Not enforcing strong cipher suites for TLS or TLS v1.2, this is potentially less secure" + _err=$(wget "$1" -O "$2" 2>&1) + _status=$? + else + get_ciphersuites_for_wget + _ciphersuites="$RETVAL" + if [ -n "$_ciphersuites" ]; then + _err=$(wget --https-only --secure-protocol=TLSv1_2 --ciphers "$_ciphersuites" "$1" -O "$2" 2>&1) + _status=$? + else + echo "Warning: Not enforcing strong cipher suites for TLS, this is potentially less secure" + if ! check_help_for "$3" wget --https-only --secure-protocol; then + echo "Warning: Not enforcing TLS v1.2, this is potentially less secure" + _err=$(wget "$1" -O "$2" 2>&1) + _status=$? + else + _err=$(wget --https-only --secure-protocol=TLSv1_2 "$1" -O "$2" 2>&1) + _status=$? + fi + fi + fi + if [ -n "$_err" ]; then + if echo "$_err" | grep -q ' 404 Not Found'; then + err "❌ Binary for platform '$3' not found, this platform may be unsupported." + else + echo "$_err" >&2 + fi + fi + return $_status + else + err "Unknown downloader" # should not reach here + fi +} + +# Check if curl supports the --retry flag, then pass it to the curl invocation. +check_curl_for_retry_support() { + local _retry_supported="" + # "unspecified" is for arch, allows for possibility old OS using macports, homebrew, etc. + if check_help_for "notspecified" "curl" "--retry"; then + _retry_supported="--retry 3" + fi + + RETVAL="$_retry_supported" + +} + +check_help_for() { + local _arch + local _cmd + local _arg + _arch="$1" + shift + _cmd="$1" + shift + + local _category + if "$_cmd" --help | grep -q 'For all options use the manual or "--help all".'; then + _category="all" + else + _category="" + fi + + case "$_arch" in + + *darwin*) + if check_cmd sw_vers; then + case $(sw_vers -productVersion) in + 10.*) + # If we're running on macOS, older than 10.13, then we always + # fail to find these options to force fallback + if [ "$(sw_vers -productVersion | cut -d. -f2)" -lt 13 ]; then + # Older than 10.13 + echo "Warning: Detected macOS platform older than 10.13" + return 1 + fi + ;; + 11.*) + # We assume Big Sur will be OK for now + ;; + *) + # Unknown product version, warn and continue + echo "Warning: Detected unknown macOS major version: $(sw_vers -productVersion)" + echo "Warning TLS capabilities detection may fail" + ;; + esac + fi + ;; + + esac + + for _arg in "$@"; do + if ! "$_cmd" --help $_category | grep -q -- "$_arg"; then + return 1 + fi + done + + true # not strictly needed +} + +# Return cipher suite string specified by user, otherwise return strong TLS 1.2-1.3 cipher suites +# if support by local tools is detected. Detection currently supports these curl backends: +# GnuTLS and OpenSSL (possibly also LibreSSL and BoringSSL). Return value can be empty. +get_ciphersuites_for_curl() { + if [ -n "${RUSTUP_TLS_CIPHERSUITES-}" ]; then + # user specified custom cipher suites, assume they know what they're doing + RETVAL="$RUSTUP_TLS_CIPHERSUITES" + return + fi + + local _openssl_syntax="no" + local _gnutls_syntax="no" + local _backend_supported="yes" + if curl -V | grep -q ' OpenSSL/'; then + _openssl_syntax="yes" + elif curl -V | grep -iq ' LibreSSL/'; then + _openssl_syntax="yes" + elif curl -V | grep -iq ' BoringSSL/'; then + _openssl_syntax="yes" + elif curl -V | grep -iq ' GnuTLS/'; then + _gnutls_syntax="yes" + else + _backend_supported="no" + fi + + local _args_supported="no" + if [ "$_backend_supported" = "yes" ]; then + # "unspecified" is for arch, allows for possibility old OS using macports, homebrew, etc. + if check_help_for "notspecified" "curl" "--tlsv1.2" "--ciphers" "--proto"; then + _args_supported="yes" + fi + fi + + local _cs="" + if [ "$_args_supported" = "yes" ]; then + if [ "$_openssl_syntax" = "yes" ]; then + _cs=$(get_strong_ciphersuites_for "openssl") + elif [ "$_gnutls_syntax" = "yes" ]; then + _cs=$(get_strong_ciphersuites_for "gnutls") + fi + fi + + RETVAL="$_cs" +} + +# Return cipher suite string specified by user, otherwise return strong TLS 1.2-1.3 cipher suites +# if support by local tools is detected. Detection currently supports these wget backends: +# GnuTLS and OpenSSL (possibly also LibreSSL and BoringSSL). Return value can be empty. +get_ciphersuites_for_wget() { + if [ -n "${RUSTUP_TLS_CIPHERSUITES-}" ]; then + # user specified custom cipher suites, assume they know what they're doing + RETVAL="$RUSTUP_TLS_CIPHERSUITES" + return + fi + + local _cs="" + if wget -V | grep -q '\-DHAVE_LIBSSL'; then + # "unspecified" is for arch, allows for possibility old OS using macports, homebrew, etc. + if check_help_for "notspecified" "wget" "TLSv1_2" "--ciphers" "--https-only" "--secure-protocol"; then + _cs=$(get_strong_ciphersuites_for "openssl") + fi + elif wget -V | grep -q '\-DHAVE_LIBGNUTLS'; then + # "unspecified" is for arch, allows for possibility old OS using macports, homebrew, etc. + if check_help_for "notspecified" "wget" "TLSv1_2" "--ciphers" "--https-only" "--secure-protocol"; then + _cs=$(get_strong_ciphersuites_for "gnutls") + fi + fi + + RETVAL="$_cs" +} + +# Return strong TLS 1.2-1.3 cipher suites in OpenSSL or GnuTLS syntax. TLS 1.2 +# excludes non-ECDHE and non-AEAD cipher suites. DHE is excluded due to bad +# DH params often found on servers (see RFC 7919). Sequence matches or is +# similar to Firefox 68 ESR with weak cipher suites disabled via about:config. +# $1 must be openssl or gnutls. +get_strong_ciphersuites_for() { + if [ "$1" = "openssl" ]; then + # OpenSSL is forgiving of unknown values, no problems with TLS 1.3 values on versions that don't support it yet. + echo "TLS_AES_128_GCM_SHA256:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_256_GCM_SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384" + elif [ "$1" = "gnutls" ]; then + # GnuTLS isn't forgiving of unknown values, so this may require a GnuTLS version that supports TLS 1.3 even if wget doesn't. + # Begin with SECURE128 (and higher) then remove/add to build cipher suites. Produces same 9 cipher suites as OpenSSL but in slightly different order. + echo "SECURE128:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1:-VERS-DTLS-ALL:-CIPHER-ALL:-MAC-ALL:-KX-ALL:+AEAD:+ECDHE-ECDSA:+ECDHE-RSA:+AES-128-GCM:+CHACHA20-POLY1305:+AES-256-GCM" + fi +} + +# This is just for indicating that commands' results are being +# intentionally ignored. Usually, because it's being executed +# as part of error handling. +ignore() { + "$@" +} + +main "$@" || exit 1 diff --git a/resources/docker/entrypoint.sh b/resources/docker/entrypoint.sh new file mode 100644 index 00000000..17fa8a65 --- /dev/null +++ b/resources/docker/entrypoint.sh @@ -0,0 +1,10 @@ +#!/usr/bin/env sh +# shellcheck shell=dash + +# If the configuration file does not exist wait until it does. +while [ ! -f /opt/stalwart-mail/etc/config.toml ]; do + sleep 1 +done + +# If the configuration file exists, start the server. +exec /usr/local/bin/stalwart-mail --config /opt/stalwart-mail/etc/config.toml diff --git a/tests/src/smtp/inbound/milter.rs b/tests/src/smtp/inbound/milter.rs index 3b80543a..d9622678 100644 --- a/tests/src/smtp/inbound/milter.rs +++ b/tests/src/smtp/inbound/milter.rs @@ -41,7 +41,8 @@ use tokio::{ }; use crate::smtp::{ - session::{load_test_message, TestSession}, + inbound::{TestMessage, TestQueueEvent}, + session::{load_test_message, TestSession, VerifyResponse}, ParseTestConfig, TestConfig, TestSMTP, }; @@ -54,13 +55,13 @@ struct HeaderTest { #[tokio::test] async fn milter_session() { // Enable logging - let disable = "true"; + /*let disable = "true"; tracing::subscriber::set_global_default( tracing_subscriber::FmtSubscriber::builder() .with_max_level(tracing::Level::TRACE) .finish(), ) - .unwrap(); + .unwrap();*/ // Configure tests let _rx = spawn_mock_milter_server(); @@ -72,8 +73,9 @@ async fn milter_session() { config.data.milters = r#"[[session.data.milter]] hostname = "127.0.0.1" port = 9332 + #port = 11332 enable = true - version = 6 + options.version = 6 tls = false "# .parse_milters(&ConfigContext::new(&[])); @@ -138,6 +140,56 @@ async fn milter_session() { ) .await; qr.assert_empty_queue(); + + // Test accept with header addition + session + .send_message( + "0@doe.org", + &["bill@foobar.org"], + "test:no_dkim", + "250 2.0.0", + ) + .await; + qr.read_event() + .await + .unwrap_message() + .read_lines() + .assert_contains("X-Hello: World") + .assert_contains("Subject: Is dinner ready?") + .assert_contains("Are you hungry yet?"); + + // Test accept with header replacement + session + .send_message( + "3@doe.org", + &["bill@foobar.org"], + "test:no_dkim", + "250 2.0.0", + ) + .await; + qr.read_event() + .await + .unwrap_message() + .read_lines() + .assert_contains("Subject: [SPAM] Saying Hello") + .assert_count("References: ", 1) + .assert_contains("Are you hungry yet?"); + + // Test accept with body replacement + session + .send_message( + "2@doe.org", + &["bill@foobar.org"], + "test:no_dkim", + "250 2.0.0", + ) + .await; + qr.read_event() + .await + .unwrap_message() + .read_lines() + .assert_contains("X-Spam: Yes") + .assert_contains("123456"); } #[test] @@ -435,6 +487,7 @@ async fn accept_milter( let mut buf = vec![0u8; 1024]; let mut receiver = Receiver::with_max_frame_len(5000000); let mut action = None; + let mut modidications = None; 'outer: loop { let br = tokio::select! { @@ -498,18 +551,10 @@ async fn accept_milter( text: "test".to_string(), }, test_num => { - for modification in - &tests[test_num.parse::().unwrap()].modifications - { - // Write modifications - stream - .write_all( - &Response::Modification(modification.clone()) - .serialize(), - ) - .await - .unwrap(); - } + modidications = tests[test_num.parse::().unwrap()] + .modifications + .clone() + .into(); Action::Accept } } @@ -517,7 +562,21 @@ async fn accept_milter( Response::Action(Action::Accept) } Command::Quit => break 'outer, - Command::EndOfBody => Response::Action(action.take().unwrap()), + Command::EndOfBody => { + if let Some(modifications) = modidications.take() { + for modification in modifications { + // Write modifications + stream + .write_all( + &Response::Modification(modification).serialize(), + ) + .await + .unwrap(); + } + } + + Response::Action(action.take().unwrap()) + } }; // Write response diff --git a/tests/src/smtp/session.rs b/tests/src/smtp/session.rs index 1e0a08bd..c32cf55f 100644 --- a/tests/src/smtp/session.rs +++ b/tests/src/smtp/session.rs @@ -311,6 +311,7 @@ pub trait VerifyResponse { fn assert_code(self, expected_code: &str) -> Self; fn assert_contains(self, expected_text: &str) -> Self; fn assert_not_contains(self, expected_text: &str) -> Self; + fn assert_count(self, text: &str, occurences: usize) -> Self; } impl VerifyResponse for Vec { @@ -341,6 +342,18 @@ impl VerifyResponse for Vec { ); } } + + fn assert_count(self, text: &str, occurences: usize) -> Self { + assert_eq!( + self.iter().filter(|l| l.contains(text)).count(), + occurences, + "Expected {} occurrences of {:?}, found {}.", + occurences, + text, + self.iter().filter(|l| l.contains(text)).count() + ); + self + } } pub trait TestServerInstance {