Miltr

这是一个用于postfix和sendmail的milter协议的实现。

最小可行使用

use async_trait::async_trait;
use miltr_common::{actions::{Action, Continue}, commands::Recipient};
use miltr_server::Milter;

struct PrintRcptMilter;

#[async_trait]
impl Milter for PrintRcptMilter {
    type Error = &'static str;

    /// Just print the recipient
    async fn rcpt(&mut self, recipient: Recipient) -> Result<Action, Self::Error> {
        println!("Received recipient: {:?}", recipient);

        Ok(Continue.into())
    }

    /// Abort has to be implemented. It is called at least once per mail
    /// handling an can occur at any time during the milter conversation.
    /// As this milter does not have any state, nothing has to be cleared.
    async fn abort(&mut self) -> Result<Action, Self::Error> {
        Ok(Continue.into())
    }
}

有关如何使用它的示例，请参阅 ./examples 目录。

安全性

此crate在linting中使用 unsafe_code = "forbid"，但同时也使用 cast-possible-truncation = "allow"。因此，使用风险自负。

语义版本

此crate遵循语义版本规范，但有以下例外

1. 最低支持的Rust版本
   MSRV的升级被视为仅是次要的语义版本变更，而不是主要变更。
2. 以 _ 开头的功能。这些被认为是 '内部' 和 '私有' 的。这主要用于模糊测试。这使得直接模糊测试内部变得更加容易。外部用户不应需要启用这些功能。

开发

待办事项

解析传入宏:
在 protocol::commands::optneg::Optneg::parse(…) 中，实现解析传入宏。目前这是一个占位符。

设计决策

这试图给出关于实现细节的简短 '理由'。

BytesMut 和所有权

使用 BytesMut::(split_to|split_off) 相对容易地解析此协议。这允许所有解析的命令仅拥有其数据，而不需要任何借用复杂性，同时解析逻辑在解析步骤内（而不是在结构体的访问函数/获取器上）。

这会产生一些额外的分配，但目前在简单性方面值得权衡。这可能在将来得到优化。

长度 & 数学 & 溢出

目前，此库在处理参数长度方面不是严格的。
这意味着，实现者可以传递给milter codec的数据过长。

编解码器将在编码时拒绝此数据，在解码时也会拒绝网络中过长数据。

在这种情况下拒绝将导致milter编解码器错误退出。这种行为可能不是最佳方案，但目前这是我能想到的最好的办法。

此外，该软件包还受到溢出恐慌的困扰。如果您在32位系统上传递一个参数（例如，一个标题值）长度为usize::MAX（约4GiB），编解码器将尝试获取项目长度：name.len() + value.len()。这将溢出并在调试模式下恐慌，在发布模式下环绕，破坏连接。

这是一个目前接受的权衡，因为电子邮件可能远小于现代系统上的usize。

这可以通过更好的方式实现。

集成测试

要运行集成测试，此存储库需要一些软件

• postfix
• swaks

集成测试假设可以自由调用这些组件。为了避免在您的系统上安装它们，此存储库包含一个docker-compose.yml文件，用于安装包含所有必需工具的容器。

然后可以运行测试

docker compose run test_milter

Milter协议的外部文档

• Postfix Milter Readme：https://www.postfix.org/MILTER_README.html
• Sendmail Libmilter 文档概述：https://fossies.org/linux/sendmail/libmilter/docs/overview.html
• Purepythonmilter关于Milter的评论：https://github.com/gertvdijk/purepythonmilter/blob/develop/docs/milter-protocol.md

致谢

purepythonmilter

特别感谢purepythonmilter，这是一个包含完整milter实现的Python包。没有这个资源查看“他们是怎样做的”，这个实现就不会出现。

Anh Vu

还要感谢Anh Vu（[email protected]），他是Retarus的实习生，写了大部分集成测试，并为实施改进提供了宝贵的反馈。谢谢！