rspamd-client 0.7.0

//!
//! ## Configuration for rspamd-client
//!
//! The `Config` struct allows you to customize various aspects of the client, including the base URL, proxy settings, and TLS settings.
//!

use std::collections::HashMap;
use std::iter::IntoIterator;
use std::time::Duration;
use typed_builder::TypedBuilder;

/// Custom TLS settings for the Rspamd client
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct TlsSettings {
    /// Path to the TLS certificate file
    pub cert_path: String,

    /// Path to the TLS key file
    pub key_path: String,

    /// Optional path to the TLS CA file
    pub ca_path: Option<String>,
}

/// Proxy configuration for the Rspamd client
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ProxyConfig {
    /// Proxy server URL
    pub proxy_url: String,

    /// Optional username for proxy authentication
    pub username: Option<String>,

    /// Optional password for proxy authentication
    pub password: Option<String>,
}

#[derive(TypedBuilder, Debug, PartialEq, Default)]
pub struct EnvelopeData {
    /// Sender email address
    #[builder(default, setter(strip_option))]
    pub from: Option<String>,

    /// Recipients email addresses
    #[builder(default)]
    pub rcpt: Vec<String>,

    /// Optional IP address of the sender
    #[builder(default, setter(strip_option))]
    pub ip: Option<String>,

    /// Optional IP of the sender
    #[builder(default, setter(strip_option))]
    pub user: Option<String>,

    /// Optional HELO string
    #[builder(default, setter(strip_option))]
    pub helo: Option<String>,

    /// Optional hostname
    #[builder(default, setter(strip_option))]
    pub hostname: Option<String>,

    /// Optional file path for local file scanning (File header)
    /// When set, the message body is not transmitted and Rspamd reads the file directly from disk
    /// This is a significant optimization when client and server are on the same host
    #[builder(default, setter(strip_option))]
    pub file_path: Option<String>,

    /// Request rewritten body in response (body_block flag)
    /// When enabled, if Rspamd rewrites the message body, it will be returned
    /// as a separate part of the reply after the JSON, with Message-Offset header
    /// indicating where the body starts
    #[builder(default)]
    pub body_block: bool,

    /// Optional additional headers
    #[builder(default)]
    pub additional_headers: HashMap<String, String>,
}

impl IntoIterator for EnvelopeData {
    type Item = (String, String);
    type IntoIter = std::vec::IntoIter<(String, String)>;

    /// Convert the EnvelopeData struct into an iterator of header pairs.
    /// Keys may repeat: each recipient is emitted as a separate `Rcpt` header.
    fn into_iter(self) -> Self::IntoIter {
        let mut headers = Vec::with_capacity(self.rcpt.len() + self.additional_headers.len() + 7);
        if let Some(from) = self.from {
            headers.push(("From".to_string(), from));
        }
        if let Some(ip) = self.ip {
            headers.push(("IP".to_string(), ip));
        }
        if let Some(user) = self.user {
            headers.push(("User".to_string(), user));
        }
        if let Some(helo) = self.helo {
            headers.push(("Helo".to_string(), helo));
        }
        if let Some(hostname) = self.hostname {
            headers.push(("Hostname".to_string(), hostname));
        }
        if let Some(file_path) = self.file_path {
            headers.push(("File".to_string(), file_path));
        }
        if self.body_block {
            headers.push(("Flags".to_string(), "body_block".to_string()));
        }
        for rcpt in self.rcpt {
            headers.push(("Rcpt".to_string(), rcpt));
        }
        headers.extend(self.additional_headers);
        headers.into_iter()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn envelope_emits_one_rcpt_header_per_recipient() {
        let envelope = EnvelopeData::builder()
            .from("sender@example.com".to_string())
            .rcpt(vec![
                "one@example.com".to_string(),
                "two@example.com".to_string(),
                "three@example.com".to_string(),
            ])
            .build();

        let headers: Vec<(String, String)> = envelope.into_iter().collect();
        let rcpts: Vec<&str> = headers
            .iter()
            .filter(|(k, _)| k == "Rcpt")
            .map(|(_, v)| v.as_str())
            .collect();
        assert_eq!(
            rcpts,
            ["one@example.com", "two@example.com", "three@example.com"]
        );
    }
}

/// Configuration for Rspamd client
///
/// Implements `Clone`, `Eq` and `Hash`, so it can be used directly as a key
/// in caches of persistent clients (e.g. an LRU of `RspamdAsyncClient`).
#[derive(TypedBuilder, Debug, Clone, PartialEq, Eq, Hash)]
pub struct Config {
    /// Base URL of Rspamd server
    pub base_url: String,

    /// Optional API key for authentication
    #[builder(default, setter(strip_option))]
    pub password: Option<String>,

    /// Timeout duration for requests
    #[builder(default = Duration::from_secs(30))]
    pub timeout: Duration,

    /// Number of retries for requests
    #[builder(default = 1)]
    pub retries: u32,

    /// Custom TLS settings for the asynchronous client
    #[builder(default, setter(strip_option))]
    pub tls_settings: Option<TlsSettings>,

    /// Proxy configuration for the asynchronous client
    #[builder(default, setter(strip_option))]
    pub proxy_config: Option<ProxyConfig>,

    /// Use zstd compression
    #[builder(default = true)]
    pub zstd: bool,

    /// Encryption key if using native HTTPCrypt encryption (must be in Rspamd base32 format)
    #[builder(default, setter(strip_option))]
    pub encryption_key: Option<String>,
}