1个不稳定版本

0.1.0	2024年2月26日

#197 in 邮件

MIT许可证

10KB

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"。所以请自行承担风险。

Semver 该crate遵循semver规范，但有以下例外：最低支持的Rust版本 MSRV的升级不被视为semver的主要版本更改，而仅视为次级更改。以_开头的特性。这些被认为是'内部'和'私有'的。这主要用于模糊测试。这使得直接模糊内部变得更加容易。外部用户不应需要启用这些特性。开发待办事项解析传入宏: 在protocol::commands::optneg::Optneg::parse(…)中，实现解析传入宏。目前这是空实现。设计决策这尝试给出一些关于实现细节的小型'理由'。 BytesMut和所有权使用BytesMut::(split_to|split_off)相对容易地'解析'这个协议。这允许所有解析命令都拥有自己的数据，而不需要任何借用复杂性，同时在解析步骤（而不是在结构体的访问函数/获取器）中拥有解析逻辑。这会产生一些额外的分配，但就目前而言，这种权衡在简单性方面是值得的。这可能在将来得到优化。长度 & 数学 & 溢出目前，该库在处理参数长度时并不严格。这意味着，实现者可以向milter编解码器传递过长数据。编解码器将拒绝在编码中传递此数据，以及在解码中从网络接收过长数据。在这种情况下拒绝将使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 Docs Overview：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的一名工作学生，他编写了大部分集成测试，并为实现改进提供了宝贵的反馈。谢谢！

依赖关系 ~320–790KB ~19K SLoC async-trait