phiag/mta-sts-exporter

MTA-STS Exporter

镜像概述

MTA-STS Exporter是一个用于接收MTA-STS（SMTP MTA严格传输安全）报告并导出Prometheus指标的工具。它通过HTTPS端点接收TLS报告，提供MTA-STS策略服务，并将相关指标暴露给Prometheus进行监控和分析，适用于邮件服务器管理员监控邮件传输的TLS安全状态。

核心功能与特性

• 支持通过环境变量或配置文件进行灵活配置
• 提供MTA-STS策略服务，可配置策略模式、MX记录、最大存活时间等
• 接收并处理TLS报告，支持报告存储功能
• 导出Prometheus指标，包括策略请求、报告请求、会话成功/失败等关键指标
• 支持JSON日志输出，便于日志分析

配置说明

可通过环境变量或配置文件（参考https://github.com/phi-ag/mta-sts-exporter/blob/main/compose.yaml%EF%BC%89%E8%BF%9B%E8%A1%8C%E9%85%8D%E7%BD%AE%EF%BC%8C%E4%B8%BB%E8%A6%81%E5%8F%82%E6%95%B0%E5%A6%82%E4%B8%8B%EF%BC%9A

DNS配置

需配置以下DNS记录以支持MTA-STS和TLS报告功能：

mta-sts    A    <IPv4>          ; 指向MTA-STS服务的IPv4地址
mta-sts    AAAA <IPv6>          ; 指向MTA-STS服务的IPv6地址（可选）
_mta-sts   TXT  "v=STSv1; id=20240101T010101;"  ; MTA-STS策略版本和标识
_smtp._tls TXT  "v=TLSRPTv1;rua=https://mta-sts.example.com/report"  ; TLS报告接收地址

使用方法

基本运行

bash
docker run -it --rm -p 8080:8080 -p 8081:8081 phiag/mta-sts-exporter:latest

发送测试报告

bash
# 发送RFC格式报告
cat examples/rfc.json | gzip | curl --data-binary @- localhost:8080/report

# 发送Google格式报告
cat examples/google.json | gzip | curl --data-binary @- localhost:8080/report

# 发送Microsoft格式报告
cat examples/microsoft.json | gzip | curl --data-binary @- localhost:8080/report

访问策略和指标

bash
# 获取MTA-STS策略
curl localhost:8080/.well-known/mta-sts.txt

# 获取Prometheus指标
curl localhost:8081/metrics

启用报告保存功能

bash
# 创建报告存储目录并设置权限
mkdir reports
chown 65532:65532 reports

# 运行容器并挂载报告目录
docker run -it --rm -p 8080:8080 -p 8081:8081 \
  --env REPORTS_SAVE_ENABLED=true \
  -v ${PWD}/reports:/tmp/reports \
  phiag/mta-sts-exporter:latest

指标说明

开发指南

测试

bash
go test

代码检查

bash
golangci-lint run

代码格式化

bash
go fmt

本地运行

bash
PORT=1234 METRICS_PORT=3333 go run .
cat examples/rfc.json | gzip | curl --data-binary @- localhost:1234/report
curl localhost:3333/metrics

构建容器

bash
ko build --local --base-import-paths

参考资料

• RFC 8460: SMTP TLS Reporting
• RFC 8461: SMTP MTA Strict Transport Security (MTA-STS)