feat: support DKIM (#129)

vitepress-docs/docs/.vitepress/zh.ts

@@ -100,6 +100,7 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
             items: [
                 { text: '命令行部署准备', link: 'cli/pre-requisite' },
                 { text: 'D1 数据库', link: 'cli/d1' },
+                { text: '配置 DKIM', link: 'dkim' },
                 { text: 'Cloudflare workers 后端', link: 'cli/worker' },
                 { text: '配置邮件转发', link: 'email-routing.md' },
                 { text: 'Cloudflare Pages 前端', link: 'cli/pages' },
@@ -111,6 +112,7 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
             collapsed: false,
             items: [
                 { text: 'D1 数据库', link: 'ui/d1' },
+                { text: '配置 DKIM', link: 'dkim' },
                 { text: 'Cloudflare workers 后端', link: 'ui/worker' },
                 { text: '配置邮件转发', link: 'email-routing.md' },
                 { text: 'Cloudflare Pages 前端', link: 'ui/pages' },

vitepress-docs/docs/en/cli.md

@@ -1,5 +1,7 @@
 # cloudflare temp email
 
+This is a temporary email service that uses Cloudflare Workers to create a temporary email address and view the received email in web browser.
+
 ## Features
 
 - [x] Cloudflare D1 as a database
@@ -14,6 +16,7 @@
 - [x] Add attachment viewing function
 - [x] use rust wasm to parse email
 - [x] support send email
+- [x] support DKIM
 
 ## Deploy
 
@@ -101,3 +104,27 @@ Create a new `_mailchannels` record, the type is `TXT`, the content is `v=mc1 cf
 
 - The worker domain name here is the domain name of the back-end api. For example, if I deploy it at `https://temp-email-api.awsl.uk/`, fill in `v=mc1 cfid=awsl.uk`
 - If your domain name is `https://temp-email-api.xxx.workers.dev`, fill in `v=mc1 cfid=xxx.workers.dev`
+
+
+## Configure DKIM
+
+Ref: [Adding-a-DKIM-Signature](https://support.mailchannels.com/hc/en-us/articles/7122849237389-Adding-a-DKIM-Signature)
+
+Creating a DKIM private and public key:
+Private key as PEM file and base64 encoded txt file:
+
+```bash
+openssl genrsa 2048 | tee priv_key.pem | openssl rsa -outform der | openssl base64 -A > priv_key.txt
+```
+
+Public key as DNS record:
+
+```bash
+echo -n "v=DKIM1;p=" > pub_key_record.txt && \
+openssl rsa -in priv_key.pem -pubout -outform der | openssl base64 -A >> pub_key_record.txt
+```
+
+Add `TXT` record in `Cloudflare` all your mail domain `DNS`
+
+- `_dmarc`: `v=DMARC1; p=none; adkim=r; aspf=r;`
+- `mailchannels._domainkey`: `v=DKIM1; p=<content of the file pub_key_record.txt>`

vitepress-docs/docs/zh/guide/cli/worker.md

@@ -10,7 +10,7 @@ cp wrangler.toml.template wrangler.toml
 
 ## 修改 `wrangler.toml` 配置文件
 
-```bash
+```toml
 name = "cloudflare_temp_email"
 main = "src/worker.js"
 compatibility_date = "2023-12-01"
@@ -29,6 +29,9 @@ PREFIX = "tmp" # 要处理的邮箱名称前缀，不需要后缀可配置为空
 DOMAINS = ["xxx.xxx1" , "xxx.xxx2"] # 你的域名, 支持多个域名
 JWT_SECRET = "xxx" # 用于生成 jwt 的密钥
 BLACK_LIST = "" # 黑名单，用于过滤发件人，逗号分隔
+# dkim config
+# DKIM_SELECTOR = "mailchannels" # 参考 DKIM 部分 mailchannels._domainkey 的 mailchannels
+# DKIM_PRIVATE_KEY = "" # 参考 DKIM 部分 priv_key.txt 的内容
 
 # D1 数据库的名称和 ID 可以在 cloudflare 控制台查看
 [[d1_databases]]

vitepress-docs/docs/zh/guide/dkim.md

@@ -0,0 +1,31 @@
+# 配置 DKIM
+
+参考: [Adding-a-DKIM-Signature](https://support.mailchannels.com/hc/en-us/articles/7122849237389-Adding-a-DKIM-Signature)
+
+Creating a DKIM private and public key:
+Private key as PEM file and base64 encoded txt file:
+
+```bash
+openssl genrsa 2048 | tee priv_key.pem | openssl rsa -outform der | openssl base64 -A > priv_key.txt
+```
+
+Public key as DNS record:
+
+```bash
+echo -n "v=DKIM1;p=" > pub_key_record.txt && \
+openssl rsa -in priv_key.pem -pubout -outform der | openssl base64 -A >> pub_key_record.txt
+```
+
+在 `Cloudflare` 的 `DNS` 记录中添加 `TXT` 记录
+
+例如:
+
+- `_dmarc`: `v=DMARC1; p=none; adkim=r; aspf=r;`
+- `mailchannels._domainkey`: `v=DKIM1; p=<content of the file pub_key_record.txt>`
+
+那我在 `wrangler.toml` 中的配置应该是这样的:
+
+```toml
+DKIM_SELECTOR = "mailchannels"
+DKIM_PRIVATE_KEY = "<priv_key.txt 的内容>"
+```