diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index c5110e51..9f4017c6 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -13,12 +13,12 @@ body: required: true - label: 我搜索了issues,没有发现已提出的类似问题。 required: true - - label: 我已经阅读了项目[Readme](https://github.com/Jinnrry/PMail/blob/master/README_CN.md)和[常见问题](https://github.com/Jinnrry/PMail/discussions/170) + - label: 我已经阅读了项目[Readme](https://git.pcux.cn/xuans/Smail/src/branch/main/README_CN.md)和[常见问题](https://git.pcux.cn/xuans/Smail/issues) required: true - type: input attributes: label: 版本 - description: 使用的PMail版本 + description: 使用的Smail版本 validations: required: true - type: markdown @@ -31,9 +31,9 @@ body: ### 对于日志 请先将日志等级设置为 debug. - 重启 PMail ,再按复现方式操作,尽量减少日志中的无关部分。 + 重启 Smail ,再按复现方式操作,尽量减少日志中的无关部分。 记得删除有关个人信息的部分。 - 提供 PMail 的日志,而不是面板或者别的东西输出的日志。 + 提供 Smail 的日志,而不是面板或者别的东西输出的日志。 ### 最后 在去掉不影响复现的部分后,提供实际运行的**完整**文件,不要出于自己的判断只提供入站出站或者几行日志。 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 0cb3367c..712e06d9 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ contact_links: - name: 部署错误及使用讨论 / Community Support and Questions - url: https://github.com/Jinnrry/PMail/discussions + url: https://git.pcux.cn/xuans/Smail/issues about: 非程序异常请前往Discussions讨论 / Please ask and answer questions there. The issue tracker is for issues with core. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 168ceb39..f787edea 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,4 +7,4 @@ assignees: '' --- -## 请完整读完[README](https://github.com/Jinnrry/PMail/blob/master/README_CN.md)再提问! / Before asking questions, please read the [README](https://github.com/Jinnrry/PMail/blob/master/README.md) ! +## 请完整读完[README](https://git.pcux.cn/xuans/Smail/src/branch/main/README_CN.md)再提问! / Before asking questions, please read the [README](https://git.pcux.cn/xuans/Smail/src/branch/main/README.md) ! diff --git a/.github/workflows/docker_build.yml b/.github/workflows/docker_build.yml deleted file mode 100644 index 5dce102c..00000000 --- a/.github/workflows/docker_build.yml +++ /dev/null @@ -1,70 +0,0 @@ -name: Docker Image CI - -on: - workflow_dispatch: - release: - types: [released] - -env: - REGISTRY: ghcr.io - -jobs: - build-and-push-image: - runs-on: ubuntu-latest - permissions: - contents: read - packages: write - steps: - - name: Get version - id: get_version - run: | - echo "VERSION=${GITHUB_REF/refs\/tags\//}" >> ${GITHUB_ENV} - echo "${GITHUB_REF/refs\/tags\//}" - echo "${GITHUB_REF#refs/*/}" - echo "${GITHUB_REF}" - - uses: actions/checkout@v3 - - - name: set lower case repository name - run: | - echo "REPOSITORY_LC=${REPOSITORY,,}" >> ${GITHUB_ENV} - env: - REPOSITORY: '${{ github.repository }}' - - - name: Set up QEMU - uses: docker/setup-qemu-action@v3 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 - - - uses: actions/setup-node@v4 - - - name: Build FE - run: | - echo "$(git show -s --format=%H)" - echo "GITHASH=$(git show -s --format=%H)" >> ${GITHUB_ENV} - make build_fe - - - name: Log in to the Container registry - uses: docker/login-action@v2.1.0 - with: - registry: ${{ env.REGISTRY }} - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Build and push Docker images - uses: docker/build-push-action@v4 - with: - build-args: | - VERSION=${{ env.VERSION }} - GITHASH=${{ env.GITHASH }} - context: . - file: ./DockerfileGithubAction - platforms: | - linux/386 - linux/amd64 - linux/arm/v7 - linux/arm64 - push: true - tags: | - ${{ env.REGISTRY }}/${{ env.REPOSITORY_LC }}:${{ env.VERSION }} - ${{ env.REGISTRY }}/${{ env.REPOSITORY_LC }}:latest diff --git a/.github/workflows/docker_build_pre.yml b/.github/workflows/docker_build_pre.yml deleted file mode 100644 index a4ac05c5..00000000 --- a/.github/workflows/docker_build_pre.yml +++ /dev/null @@ -1,68 +0,0 @@ -name: Docker Image CI Pre - -on: - workflow_dispatch: - release: - types: [ prereleased ] - -env: - REGISTRY: ghcr.io - -jobs: - build-and-push-image: - runs-on: ubuntu-latest - permissions: - contents: read - packages: write - steps: - - name: Get version - id: get_version - run: | - echo "VERSION=pre${GITHUB_REF/refs\/tags\//}" >> ${GITHUB_ENV} - echo "${GITHUB_REF/refs\/tags\//}" - echo "${GITHUB_REF#refs/*/}" - echo "${GITHUB_REF}" - - uses: actions/checkout@v3 - - - name: set lower case repository name - run: | - echo "REPOSITORY_LC=${REPOSITORY,,}" >> ${GITHUB_ENV} - env: - REPOSITORY: '${{ github.repository }}' - - - name: Set up QEMU - uses: docker/setup-qemu-action@v3 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 - - - uses: actions/setup-node@v4 - - - name: Build FE - run: | - echo "GITHASH=$(git show -s --format=%H)" >> ${GITHUB_ENV} - make build_fe - - - name: Log in to the Container registry - uses: docker/login-action@v2.1.0 - with: - registry: ${{ env.REGISTRY }} - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Build and push Docker images - uses: docker/build-push-action@v4 - with: - build-args: | - VERSION=${{ env.VERSION }} - GITHASH=${{ env.GITHASH }} - context: . - file: ./DockerfileGithubAction - platforms: | - linux/386 - linux/amd64 - linux/arm/v7 - linux/arm64 - push: true - tags: | - ${{ env.REGISTRY }}/${{ env.REPOSITORY_LC }}:${{ env.VERSION }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 0d3ecaca..ce0666e3 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -37,14 +37,14 @@ jobs: check-latest: true - name: Gen output name run: | - echo "FILENAME=pmail_${{ matrix.goos }}_${{ matrix.goarch }}" >> ${GITHUB_ENV} + echo "FILENAME=smail_${{ matrix.goos }}_${{ matrix.goarch }}" >> ${GITHUB_ENV} echo "WCFILENAME=wechat_push_${{ matrix.goos }}_${{ matrix.goarch }}" >> ${GITHUB_ENV} echo "SPAMBLOCKFILENAME=spam_block_${{ matrix.goos }}_${{ matrix.goarch }}" >> ${GITHUB_ENV} echo "ZIPNAME=${{ matrix.goos }}_${{ matrix.goarch }}" >> ${GITHUB_ENV} - name: Rename Windows File if: matrix.goos == 'windows' run: | - echo "FILENAME=pmail_${{ matrix.goos }}_${{ matrix.goarch }}.exe" >> ${GITHUB_ENV} + echo "FILENAME=smail_${{ matrix.goos }}_${{ matrix.goarch }}.exe" >> ${GITHUB_ENV} echo "WCFILENAME=wechat_push_${{ matrix.goos }}_${{ matrix.goarch }}.exe" >> ${GITHUB_ENV} echo "SPAMBLOCKFILENAME=spam_block_${{ matrix.goos }}_${{ matrix.goarch }}.exe" >> ${GITHUB_ENV} - name: FE Build diff --git a/.github/workflows/unitTest.yml b/.github/workflows/unitTest.yml deleted file mode 100644 index b546dd48..00000000 --- a/.github/workflows/unitTest.yml +++ /dev/null @@ -1,69 +0,0 @@ -name: PR - Docker unit test - -on: - pull_request: - branches: - - master - types: [opened, reopened, synchronize, edited] - # Please, always create a pull request instead of push to master. - -permissions: - contents: read - pull-requests: write - -concurrency: - group: docker-test-${{ github.ref_name }} - cancel-in-progress: true - -jobs: - test: - name: Docker tests - runs-on: ubuntu-latest - services: - mysql: - image: mysql - env: - MYSQL_DATABASE: pmail - MYSQL_ROOT_PASSWORD: githubTest - options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3 - postgres: - image: postgres - env: - POSTGRESQL_PASSWORD: githubTest - container: - image: golang - env: - REPOSITORY: ${{ github.repository }} - TRIGGERING_ACTOR: ${{ github.triggering_actor }} - SOURCE_BRANCH: ${{ github.ref_name }} - COMMIT: ${{ github.workflow_sha }} - EVENT: ${{ github.event_name}} - steps: - - name: Setup Node.js environment - run: apt update && apt install -y nodejs npm - - - name: Checkout - uses: actions/checkout@v4 - - - name: Pull Request Labeler - if: ${{ failure() }} - env: - GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: | - gh pr edit ${{ github.event.pull_request.number }} --add-label "Auto: Test Failed" - - - name: Install Dependencies - run: npm install --global yarn - - - name: FE build - run: make build_fe - - - name: Run Test Mysql - run: make test_mysql - - - name: Run Test - run: make test - -# - name: Run postgres -# run: make test_postgres - diff --git a/.gitignore b/.gitignore index c8b9f275..feb28ad3 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,7 @@ .DS_Store dist output -pmail.db +smail.db server/plugins config *_KEY diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index dd3f1e09..00000000 --- a/Dockerfile +++ /dev/null @@ -1,37 +0,0 @@ -FROM node:lts-alpine as febuild -WORKDIR /work - -COPY fe . - -RUN yarn && yarn build - - -FROM golang:alpine as serverbuild -ARG VERSION -WORKDIR /work -COPY . . -COPY --from=febuild /work/dist /work/server/listen/http_server/dist -RUN apk update && apk add git -RUN cd /work/server && go build -ldflags "-s -w -X 'main.version=${VERSION}' -X 'main.goVersion=$(go version)' -X 'main.gitHash=$(git show -s --format=%H)' -X 'main.buildTime=$(TZ=UTC-8 date +%Y-%m-%d" "%H:%M:%S)'" -o pmail main.go -RUN cd /work/server/hooks/wechat_push && go build -ldflags "-s -w" -o output/wechat_push wechat_push.go -RUN cd /work/server/hooks/spam_block && go build -ldflags "-s -w" -o output/spam_block spam_block.go - - -FROM alpine - -WORKDIR /work - -# 设置时区 -RUN apk add --no-cache tzdata \ - && ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime \ - && echo "Asia/Shanghai" > /etc/timezone \ - &&rm -rf /var/cache/apk/* /tmp/* /var/tmp/* $HOME/.cache - - -COPY --from=serverbuild /work/server/pmail . -COPY --from=serverbuild /work/server/hooks/wechat_push/output/* ./plugins/ -COPY --from=serverbuild /work/server/hooks/spam_block/output/* ./plugins/ - -EXPOSE 25 80 110 443 465 587 995 993 - -CMD /work/pmail diff --git a/DockerfileGithubAction b/DockerfileGithubAction deleted file mode 100644 index 2a4997f5..00000000 --- a/DockerfileGithubAction +++ /dev/null @@ -1,31 +0,0 @@ -FROM golang:alpine as serverbuild -ARG VERSION -ARG GITHASH -WORKDIR /work - -COPY server . - -RUN apk update && apk add git -RUN go build -ldflags "-s -w -X 'main.version=${VERSION}' -X 'main.goVersion=$(go version)' -X 'main.gitHash=${GITHASH}' -X 'main.buildTime=$(TZ=UTC-8 date +%Y-%m-%d" "%H:%M:%S)'" -o pmail main.go -RUN cd /work/hooks/wechat_push && go build -ldflags "-s -w" -o output/wechat_push wechat_push.go -RUN cd /work/hooks/spam_block && go build -ldflags "-s -w" -o output/spam_block spam_block.go - - -FROM alpine - -WORKDIR /work - -# 设置时区 -RUN apk add --no-cache tzdata \ - && ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime \ - && echo "Asia/Shanghai" > /etc/timezone \ - &&rm -rf /var/cache/apk/* /tmp/* /var/tmp/* $HOME/.cache - - -COPY --from=serverbuild /work/pmail . -COPY --from=serverbuild /work/hooks/wechat_push/output/* ./plugins/ -COPY --from=serverbuild /work/hooks/spam_block/output/* ./plugins/ - -EXPOSE 25 80 110 443 465 587 995 993 - -CMD /work/pmail diff --git a/Makefile b/Makefile index a4b5fb66..79446e14 100644 --- a/Makefile +++ b/Makefile @@ -10,10 +10,10 @@ build_fe: cd server && cp -rf ../fe/dist listen/http_server build_server: - cd server && CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags "-s -w -X 'main.goVersion=$(go version)' -X 'main.gitHash=$(git show -s --format=%H)' -X 'main.buildTime=$(TZ=UTC-8 date +%Y-%m-%d" "%H:%M:%S)'" -o pmail_linux_amd64 main.go - cd server && CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags "-s -w -X 'main.goVersion=$(go version)' -X 'main.gitHash=$(git show -s --format=%H)' -X 'main.buildTime=$(TZ=UTC-8 date +%Y-%m-%d" "%H:%M:%S)'" -o pmail_windows_amd64.exe main.go - cd server && CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -ldflags "-s -w -X 'main.goVersion=$(go version)' -X 'main.gitHash=$(git show -s --format=%H)' -X 'main.buildTime=$(TZ=UTC-8 date +%Y-%m-%d" "%H:%M:%S)'" -o pmail_mac_amd64 main.go - cd server && CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 go build -ldflags "-s -w -X 'main.goVersion=$(go version)' -X 'main.gitHash=$(git show -s --format=%H)' -X 'main.buildTime=$(TZ=UTC-8 date +%Y-%m-%d" "%H:%M:%S)'" -o pmail_mac_arm64 main.go + cd server && CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags "-s -w -X 'main.goVersion=$(go version)' -X 'main.gitHash=$(git show -s --format=%H)' -X 'main.buildTime=$(TZ=UTC-8 date +%Y-%m-%d" "%H:%M:%S)'" -o smail_linux_amd64 main.go + cd server && CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags "-s -w -X 'main.goVersion=$(go version)' -X 'main.gitHash=$(git show -s --format=%H)' -X 'main.buildTime=$(TZ=UTC-8 date +%Y-%m-%d" "%H:%M:%S)'" -o smail_windows_amd64.exe main.go + cd server && CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -ldflags "-s -w -X 'main.goVersion=$(go version)' -X 'main.gitHash=$(git show -s --format=%H)' -X 'main.buildTime=$(TZ=UTC-8 date +%Y-%m-%d" "%H:%M:%S)'" -o smail_mac_amd64 main.go + cd server && CGO_ENABLED=0 GOOS=darwin GOARCH=arm64 go build -ldflags "-s -w -X 'main.goVersion=$(go version)' -X 'main.gitHash=$(git show -s --format=%H)' -X 'main.buildTime=$(TZ=UTC-8 date +%Y-%m-%d" "%H:%M:%S)'" -o smail_mac_arm64 main.go wechat_push: cd server/hooks/wechat_push && CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags "-s -w" -o output/wechat_push_linux_amd64 wechat_push.go @@ -34,7 +34,7 @@ plugin: spam_block wechat_push package: clean mkdir output - mv server/pmail* output/ + mv server/smail* output/ mkdir output/config mkdir output/plugins cp -r server/config/dkim output/config/ @@ -45,10 +45,10 @@ package: clean cp README.md output/ test: - export setup_port=17888 && cd server && export PMail_ROOT=$(CURDIR)/server/ && go test -v -p 1 ./... + export setup_port=17888 && cd server && export SMAIL_ROOT=$(CURDIR)/server/ && go test -v -p 1 ./... test_mysql: - export setup_port=17888 && cd server && export PMail_ROOT=$(CURDIR)/server/ && go test -args "mysql" -v -p 1 ./... + export setup_port=17888 && cd server && export SMAIL_ROOT=$(CURDIR)/server/ && go test -args "mysql" -v -p 1 ./... test_postgres: - export setup_port=17888 && cd server && export PMail_ROOT=$(CURDIR)/server/ && go test -args "postgres" -v -p 1 ./... \ No newline at end of file + export setup_port=17888 && cd server && export SMAIL_ROOT=$(CURDIR)/server/ && go test -args "postgres" -v -p 1 ./... \ No newline at end of file diff --git a/README.md b/README.md index 582544e4..ed70b3a0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# PMail +# Smail > A server, a domain, a line of code, a minute, and you'll be able to build a domain mailbox of your own. @@ -8,7 +8,7 @@ I'm Chinese, and I'm not good at English, so I apologise for my translation. ## Introduction -PMail is a personal email server that pursues a minimal deployment process and extreme resource consumption. It runs on +Smail is a personal email server that pursues a minimal deployment process and extreme resource consumption. It runs on a single file and contains complete send/receive mail service and web-side mail management functions. Just a server , a domain name , a line of code , a minute of deployment time , you will be able to build a domain name mailbox of your own . @@ -43,12 +43,12 @@ First go to [spamhaus](https://check.spamhaus.org/) and check your domain name a ## 1、Download -* [Click Here](https://github.com/Jinnrry/PMail/releases) Download a program file that matches you. +* [Click Here](https://git.pcux.cn/xuans/Smail/releases) Download a program file that matches you. * Or use Docker `docker pull ghcr.io/jinnrry/pmail:latest` ## 2、Run -`./pmail -p 80` +`./smail -p 80` > -p Set the http port of the bootstrap setup interface, the default is port 80, note that this parameter only affects the bootstrap setup phase, if you need to change the port after setup is complete, please modify the configuration file. @@ -84,7 +84,7 @@ use [https://www.mail-tester.com/](https://www.mail-tester.com/) for checking. "sslType": "0", // ssl certificate update mode, 0 automatic, 1 manual "SSLPrivateKeyPath": "config/ssl/private.key", // ssl certificate path "SSLPublicKeyPath": "config/ssl/public.crt", // ssl certificate path - "dbDSN": "./config/pmail.db", // database connect DSN + "dbDSN": "./config/smail.db", // database connect DSN "dbType": "sqlite", //database type ,`sqlite` or `mysql` "httpsEnabled": 0, // enabled https , 0:enabled 1:enablde 2:disenabled "httpPort": 80, // http port . default 80 @@ -119,7 +119,7 @@ IMAP Port: 993(SSL) ## Plugin Install > [!IMPORTANT] -> Plugins run on your server as independent processes, please review the security of third-party plugins on your own.PMail currently only maintains the three plugins mentioned above. +> Plugins run on your server as independent processes, please review the security of third-party plugins on your own.Smail currently only maintains the three plugins mentioned above. Copy plugin binary file to `/plugins` @@ -145,10 +145,10 @@ The code is in `server` folder. ## Api Documentation -[go to wiki](https://github.com/Jinnrry/PMail/wiki/%E5%90%8E%E7%AB%AF%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3) +[go to wiki](https://git.pcux.cn/xuans/Smail/wiki/%E5%90%8E%E7%AB%AF%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3) ## Plugin Development -[go to wiki](https://github.com/Jinnrry/PMail/wiki/%E6%8F%92%E4%BB%B6%E5%BC%80%E5%8F%91%E8%AF%B4%E6%98%8E) +[go to wiki](https://git.pcux.cn/xuans/Smail/wiki/%E6%8F%92%E4%BB%B6%E5%BC%80%E5%8F%91%E8%AF%B4%E6%98%8E) diff --git a/README_CN.md b/README_CN.md index e2639a08..a71227d6 100644 --- a/README_CN.md +++ b/README_CN.md @@ -1,8 +1,8 @@ -# PMail +# Smail > 一台服务器、一个域名、一行代码、一分钟时间,你就能够搭建出一个自己的域名邮箱。 -PMail是一个追求极简部署流程、极致资源占用的个人域名邮箱服务器。单文件运行,包含完整的收发邮件服务和Web端邮件管理功能。只需一台服务器、一个域名、一行代码、一分钟部署时间,你就能够搭建出一个自己的域名邮箱。 +Smail是一个追求极简部署流程、极致资源占用的个人域名邮箱服务器。单文件运行,包含完整的收发邮件服务和Web端邮件管理功能。只需一台服务器、一个域名、一行代码、一分钟部署时间,你就能够搭建出一个自己的域名邮箱。 欢迎各类PR,无论你是修复bug、新增功能、修改翻译。另外,也为这个项目征集一个漂亮可爱的Logo! @@ -51,12 +51,12 @@ PMail是一个追求极简部署流程、极致资源占用的个人域名邮箱 ## 1、下载文件 -* [点击这里](https://github.com/Jinnrry/PMail/releases)下载一个与你匹配的程序文件。 +* [点击这里](https://git.pcux.cn/xuans/Smail/releases)下载一个与你匹配的程序文件。 * 或者使用Docker运行 `docker pull ghcr.io/jinnrry/pmail:latest` ## 2、运行 -`./pmail -p 80` +`./smail -p 80` > `-p 指定引导设置界面的http端口,默认为80端口,注意该参数仅影响引导设置阶段,设置完成后如果需要修改端口请修改配置文件` @@ -89,7 +89,7 @@ PMail是一个追求极简部署流程、极致资源占用的个人域名邮箱 "sslType": "0", // ssl证书更新模式,0自动,HTTP模式,1手动、2自动,DNS模式 "SSLPrivateKeyPath": "config/ssl/private.key", // ssl 证书地址 "SSLPublicKeyPath": "config/ssl/public.crt", // ssl 证书地址 - "dbDSN": "./config/pmail.db", // 数据库连接DSN + "dbDSN": "./config/smail.db", // 数据库连接DSN "dbType": "sqlite", //数据库类型,支持sqlite 和 mysql "httpsEnabled": 0, // web后台是否启用https 0默认(启用),1启用,2不启用 "spamFilterLevel": 0,// 垃圾邮件过滤级别,0不过滤、1 spf dkim 校验均失败时且无有效收件人过滤,2 spf校验不通过时且无有效收件人过滤 3,dkim 校验不过的时候且无有效收件人过滤 @@ -125,7 +125,7 @@ IMAP端口: 993(SSL) ## 插件安装 > [!IMPORTANT] -> 插件已独立进程的方式运行在你的服务器上,请自行审查第三方插件的安全性。PMail目前仅维护上述三款插件 +> 插件已独立进程的方式运行在你的服务器上,请自行审查第三方插件的安全性。Smail目前仅维护上述三款插件 将插件二进制文件放到`plugins`文件夹中即可 @@ -151,10 +151,10 @@ IMAP端口: 993(SSL) ## 后端接口文档 -[go to wiki](https://github.com/Jinnrry/PMail/wiki/%E5%90%8E%E7%AB%AF%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3) +[go to wiki](https://git.pcux.cn/xuans/Smail/wiki/%E5%90%8E%E7%AB%AF%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3) ## 插件开发 -[go to wiki](https://github.com/Jinnrry/PMail/wiki/%E6%8F%92%E4%BB%B6%E5%BC%80%E5%8F%91%E8%AF%B4%E6%98%8E) +[go to wiki](https://git.pcux.cn/xuans/Smail/wiki/%E6%8F%92%E4%BB%B6%E5%BC%80%E5%8F%91%E8%AF%B4%E6%98%8E) diff --git a/docs/安全审查风险整改任务清单.md b/docs/安全审查风险整改任务清单.md new file mode 100644 index 00000000..a3f82a3a --- /dev/null +++ b/docs/安全审查风险整改任务清单.md @@ -0,0 +1,775 @@ +# Smail 安全审查风险整改任务清单 + +> 审查日期:2026-08-24 +> 审查范围:当前工作区 `D:\Desktop\Smail` +> 文档用途:按照任务项逐项整改,并在整改完成后进行复审。 + +## 一、使用说明 + +### 1. 状态标记 + +- `[ ] 未开始` +- `[~] 进行中` +- `[x] 已完成,等待复审` +- `[✓] 复审通过` +- `[!] 暂缓或存在阻塞` + +每项整改完成后,请补充以下内容: + +- 实际修改的文件和提交号; +- 修改前后的行为差异; +- 测试命令或手工验证步骤; +- 测试结果和遗留风险; +- 复审日期。 + +### 2. 优先级说明 + +- **P0:上线阻断项**。可能导致凭据泄漏、管理员被抢先创建、会话被窃取或跨用户影响,生产上线前必须完成。 +- **P1:高优先级安全整改**。需要在近期版本完成,否则会扩大攻击面或降低租户隔离能力。 +- **P2:加固和质量整改**。建议纳入后续版本和持续安全建设。 + +### 3. 整改原则 + +- 不要把密码、私钥、数据库凭据或初始化令牌写入 Git、脚本、测试输出和普通日志。 +- 所有资源 ID 都必须同时校验当前用户或租户归属。 +- 安全修复应增加回归测试,避免只修改实现而没有验证边界。 +- 测试不得删除工作区真实配置或数据库;应使用临时目录和测试专用配置。 +- 本次不保留旧密码算法兼容逻辑,不执行旧算法与新算法双轨校验;已有账号通过统一的密码重置或重新初始化流程设置新密码。 +- 登录、管理员操作、初始化和第三方配置验证必须复用统一的凭据校验服务;需要向第三方服务发起连接的密钥不得使用不可逆密码哈希保存,而应使用受控加密存储。 + +--- + +## 二、整改总览 + +| 任务编号 | 优先级 | 风险主题 | 主要位置 | 状态 | +| --- | --- | --- | --- | --- | +| SEC-001 | P0 | SMTP 587 在 STARTTLS 前允许认证 | `server/listen/smtp_server/smtp.go` | [ ] | +| SEC-002 | P0 | SMTP 日志记录明文密码 | `server/listen/smtp_server/action.go` | [ ] | +| SEC-003 | P0 | 初始化接口缺少访问保护 | `server/listen/http_server/`、`server/controllers/setup.go` | [ ] | +| SEC-004 | P0 | 明文 HTTP 承载完整登录会话 | `server/listen/http_server/http_server.go` | [ ] | +| SEC-005 | P1 | 邮件移动未验证目标分组归属 | `server/controllers/email/move.go`、`server/services/group/group.go` | [ ] | +| SEC-006 | P1 | 删除分组后的邮件更新缺少用户条件 | `server/services/group/group.go` | [ ] | +| SEC-007 | P1 | 密码使用 MD5 和固定盐 | `server/utils/password/encode.go` | [ ] | +| SEC-008 | P1 | 请求体读取没有统一大小限制 | `server/controllers/` | [ ] | +| SEC-009 | P1 | 缺少统一 CSRF 防护 | Cookie 会话状态修改接口 | [ ] | +| SEC-010 | P1 | 邮件 HTML 清理策略较宽松 | `server/dto/parsemail/email.go`、`fe/src/views/EmailDetailView.vue` | [ ] | +| SEC-011 | P1 | 缺少统一安全响应头,插件 iframe 未隔离 | `server/listen/http_server/`、`fe/src/components/PluginSettings.vue` | [ ] | +| SEC-012 | P1 | 初始化 SSL 路径校验不足 | `server/controllers/setup.go` | [ ] | +| SEC-013 | P1 | 出站 SMTPS 跳过证书校验 | `server/utils/smtp/smtp.go` | [ ] | +| SEC-014 | P1 | 测试可能删除真实配置和数据库 | `server/main_test.go` | [ ] | +| SEC-015 | P2 | 敏感文件权限过宽 | `server/services/auth/`、`server/services/setup/ssl/`、`server/config/` | [ ] | +| SEC-016 | P2 | DKIM RSA 密钥长度只有 1024 位 | `server/services/auth/auth.go` | [ ] | +| SEC-017 | P2 | 附件下载响应头和文件名处理不规范 | `server/controllers/attachments.go` | [ ] | +| SEC-018 | P2 | Windows 路径处理不完整 | `server/config/config.go` | [ ] | +| SEC-019 | P2 | 插件进程信任边界较宽 | `server/hooks/base.go` | [ ] | +| SEC-020 | P2 | IMAP 未使用辅助函数缺少 UID 用户隔离 | `server/services/detail/detail.go` | [ ] | +| SEC-021 | P2 | 依赖漏洞审计和锁文件审计尚未建立 | Go、前端依赖管理 | [ ] | +| SEC-022 | P2 | `go vet` 现有问题降低静态检查效果 | `server/dto/parsemail/email.go`、`server/controllers/group.go` | [ ] | + +--- + +# 三、P0:上线阻断项 + +## SEC-001:禁止 SMTP 587 在 STARTTLS 前认证 + +- **状态**:[ ] 未开始 +- **风险等级**:P0 / 高风险 +- **关联问题**:SMTP 明文认证导致凭据泄漏。 +- **关联文件**: + - `server/listen/smtp_server/smtp.go` + - SMTP 认证和 STARTTLS 相关测试文件 + +### 整改要求 + +1. 587 端口在 TLS 建立前不得声明 `AUTH` 能力。 +2. 只有 STARTTLS 成功后才允许 `AUTH PLAIN`、`AUTH LOGIN` 或其他认证方式。 +3. 移除或关闭允许不安全认证的配置。 +4. 465 端口继续使用隐式 TLS,不与 587 的明文升级逻辑混用。 +5. 对 TLS 协商失败、重复认证和 STARTTLS 降级行为增加测试。 + +### 验收标准 + +- 明文连接执行 `EHLO` 时只返回 `STARTTLS`,不返回 `AUTH`。 +- 未执行 STARTTLS 直接发送认证命令时,服务器拒绝认证。 +- STARTTLS 成功后重新执行 `EHLO`,才返回认证能力。 +- 认证失败时日志中不包含密码或密码编码值。 +- 增加自动化测试,覆盖成功、失败和降级场景。 + +### 复审建议 + +使用隔离测试端口执行 SMTP 对话验证,并保存不含凭据的协议输出。 + +--- + +## SEC-002:删除 SMTP 明文密码日志 + +- **状态**:[ ] 未开始 +- **风险等级**:P0 / 高风险 +- **关联问题**:Debug 日志输出认证密码。 +- **关联文件**: + - `server/listen/smtp_server/action.go` + - 其他 SMTP 认证日志调用点 + +### 整改要求 + +1. 删除所有用户名和密码同时输出的日志。 +2. 不记录明文密码、Base64 密码或完整 AUTH 报文。 +3. 只记录认证方式、脱敏账号、结果、远端地址和追踪信息。 +4. 搜索整个仓库,确认没有其他认证密码日志。 +5. 检查现有日志配置,避免调试模式绕过脱敏逻辑。 + +### 验收标准 + +- 使用成功和失败认证各执行一次,日志中均不存在密码原文。 +- 搜索源代码和测试输出,不存在密码格式化日志。 +- 日志中账号已按需要脱敏。 +- 认证失败日志不会回显用户输入的敏感字段。 + +### 复审建议 + +使用固定测试账号进行验证,但不要把实际密码写入命令历史、报告或 Git。 + +--- + +## SEC-003:保护初始化接口并限制初始化网络边界 + +- **状态**:[ ] 未开始 +- **风险等级**:P0 / 高风险 +- **关联问题**:攻击者可能在管理员之前抢先完成初始化。 +- **关联文件**: + - `server/listen/http_server/setup_server.go` + - `server/listen/http_server/https_server.go` + - `server/controllers/setup.go` + +### 整改要求 + +1. 初始化接口必须要求一次性随机初始化令牌。 +2. 默认初始化服务只监听 `127.0.0.1` 或受控管理地址。 +3. 初始化成功后立即使令牌失效。 +4. 初始化完成后,`/api/setup` 必须永久拒绝重复初始化。 +5. 增加来源限制、失败次数限制和速率限制。 +6. 初始化操作必须记录审计事件,但不得记录密码、私钥内容或数据库凭据。 +7. 对数据库、管理员、域名、SSL 路径等字段进行服务端校验,不能仅依赖前端。 + +### 验收标准 + +- 无初始化令牌不能调用初始化接口。 +- 令牌只能使用一次,重复使用失败。 +- 非本机来源无法完成首次初始化,除非管理员明确配置了受控入口。 +- 初始化完成后再次调用接口返回拒绝结果。 +- 端口扫描或未授权请求不会泄漏初始化配置细节。 + +### 复审建议 + +在隔离环境启动一个全新实例,分别验证无令牌、错误令牌、重复令牌、跨来源请求和初始化成功后的重复调用。 + +--- + +## SEC-004:禁止明文 HTTP 承载登录会话 + +- **状态**:[ ] 未开始 +- **风险等级**:P0 / 高风险 +- **关联问题**:HTTP 模式下可能窃听登录请求和会话 Cookie。 +- **关联文件**: + - `server/listen/http_server/http_server.go` + - `server/listen/http_server/https_server.go` + - 会话 Cookie 配置 + - `server/config/config*.json` + +### 整改要求 + +1. 生产模式强制 HTTPS。 +2. HTTP 只允许安全跳转或 ACME 挑战,不加载完整业务路由。 +3. HTTPS 下的会话 Cookie 必须设置 `Secure=true`。 +4. 保持 `HttpOnly=true`,合理设置 `SameSite`。 +5. 添加 HSTS,并确认代理转发场景下协议判断正确。 +6. 避免由于错误的反向代理头导致服务误判为 HTTP 或 HTTPS。 + +### 验收标准 + +- 通过 HTTP 访问登录页面时只能获得安全跳转或明确拒绝。 +- HTTP 不接受登录请求、不返回完整业务页面、不设置可用会话 Cookie。 +- HTTPS 响应中的会话 Cookie 包含 `Secure` 和 `HttpOnly`。 +- HTTPS 页面不存在混合内容。 +- HSTS 只在确认 HTTPS 部署正确后启用。 + +--- + +# 四、P1:高优先级安全整改 + +## SEC-005:验证邮件移动目标分组属于当前用户 + +- **状态**:[ ] 未开始 +- **风险等级**:P1 / 中高风险 +- **关联问题**:用户可以引用其他用户的分组 ID。 +- **关联文件**: + - `server/controllers/email/move.go` + - `server/services/group/group.go` + +### 整改要求 + +1. 移动邮件前验证目标 `group_id` 存在且属于当前用户。 +2. 对默认分组和系统分组使用明确的归属规则。 +3. 无效或跨用户分组 ID 统一返回安全错误,不泄漏其他用户资源是否存在。 +4. 同时覆盖 HTTP、IMAP 或其他可能修改分组的入口。 + +### 验收标准 + +- 用户 B 不能将邮件移动到用户 A 的分组。 +- 不存在的分组 ID 与跨用户分组 ID 返回一致的错误语义。 +- 正常移动仍然成功。 +- 增加跨用户回归测试。 + +--- + +## SEC-006:删除分组后的更新必须带用户条件 + +- **状态**:[ ] 未开始 +- **风险等级**:P1 / 中高风险 +- **关联问题**:删除用户 A 的分组可能影响用户 B 的邮件元数据。 +- **关联文件**: + - `server/services/group/group.go` + - 分组删除相关测试 + +### 整改要求 + +将分组删除后的邮件更新限制在当前用户范围内,例如逻辑上必须包含: + +```sql +update user_email +set group_id=0 +where group_id in (...) + and user_id=? +``` + +同时检查事务范围,确保删除分组和清理邮件引用处于同一事务中。 + +### 验收标准 + +- 用户 A 删除分组不会改变用户 B 的任何邮件数据。 +- 用户 A 自己关联该分组的邮件会被正确清理。 +- 删除失败时不会留下半完成状态。 +- 增加双用户事务和回滚测试。 + +--- + +## SEC-007:统一密码哈希与凭据验证机制 + +- **状态**:[ ] 未开始 +- **风险等级**:P1 / 中风险 +- **关联问题**:MD5、固定盐、无独立随机盐。 +- **关联文件**: + - `server/utils/password/encode.go` + - 用户创建、登录、修改密码流程 + - 数据库用户表结构 + +### 整改要求 + +1. 统一使用 Argon2id 作为用户密码的唯一哈希算法,不再保留 MD5、固定盐、bcrypt、scrypt 或其他旧算法的运行时兼容分支。 +2. 每个密码使用独立的密码学安全随机盐,并保存经过评审的算法参数和版本。 +3. 将密码处理集中到统一的密码服务,例如 `PasswordService`,统一提供密码策略校验、哈希和验证能力。 +4. 登录、用户改密、管理员重置、初始化管理员密码和其他用户密码验证入口必须调用同一个密码服务,不允许各业务模块自行拼接或比较哈希。 +5. 第三方配置验证必须复用统一的凭据校验流程、输入规范化、超时、错误分类和脱敏日志规则。 +6. 需要向第三方服务发起连接的 SMTP、API 或其他密钥不能使用不可逆密码哈希保存,应使用受控加密存储,并通过统一的 `CredentialValidator` 完成配置有效性验证。 +7. 密码比较和第三方凭据校验应避免时序侧信道;所有失败响应不得泄露账号、配置或凭据是否存在的额外信息。 +8. 不在日志、错误响应或审计记录中记录密码、第三方密钥、令牌或完整认证报文。 +9. 对已有旧算法密码不提供兼容登录;发布前完成账号密码重置或强制重新设置密码,并提供管理员可审计的处理结果。 + +### 验收标准 + +- 新创建和重置后的用户密码均使用 Argon2id,数据库中不存在新写入的 MD5 或其他旧算法哈希。 +- 每个用户的盐值不同,算法参数和版本可以被服务端正确解析。 +- 登录、初始化、用户改密和管理员重置使用同一个密码服务,并对相同输入给出一致的成功或失败结果。 +- 旧算法密码不会被兼容登录;没有完成密码重置的旧账号按明确策略被拒绝并引导设置新密码。 +- 第三方 SMTP、API 等配置使用统一的凭据验证流程;验证成功的配置与实际运行时连接使用相同的规范化和校验规则。 +- 第三方密钥不会以明文或不可逆哈希形式保存,日志、错误响应和审计记录均已脱敏。 +- 密码哈希参数经过性能和部署环境验证。 +- 错误密码、无效第三方配置和不存在的凭据不会产生可用于枚举的差异化错误信息。 + +--- + +## SEC-008:为请求体和附件增加大小限制 + +- **状态**:[ ] 未开始 +- **风险等级**:P1 / 中风险 +- **关联问题**:多个接口直接使用无上限 `io.ReadAll`。 +- **关联范围**: + - `server/controllers/login.go` + - `server/controllers/setup.go` + - `server/controllers/user.go` + - `server/controllers/settings.go` + - `server/controllers/rule.go` + - `server/controllers/plugin.go` + - `server/controllers/group.go` + - `server/controllers/email/` + +### 整改要求 + +1. 为每个接口定义请求体上限。 +2. 普通 JSON、邮件正文和附件使用不同限制。 +3. 附件限制总大小、单文件大小、文件数量和 Base64 解码后的大小。 +4. 超限请求在解析前拒绝。 +5. 设置请求读取超时和上传超时。 +6. 对压缩内容和异常编码考虑解压缩炸弹或放大攻击。 + +### 验收标准 + +- 超过接口限制的请求返回明确错误。 +- 服务内存不会随请求体无限增长。 +- 附件原始大小和解码后大小都受到限制。 +- 正常大小的登录、设置、邮件发送仍然可用。 +- 增加边界值和并发上传测试。 + +--- + +## SEC-009:增加统一 CSRF 防护和状态修改方法限制 + +- **状态**:[ ] 未开始 +- **风险等级**:P1 / 中风险 +- **关联问题**:Cookie 会话状态修改接口缺少统一 CSRF 防护。 +- **关联范围**:登录后的所有状态修改接口。 + +### 整改要求 + +1. 对 Cookie 会话增加 CSRF Token。 +2. 对状态修改请求校验 `Origin`,必要时校验 `Referer`。 +3. 所有状态修改接口只接受合适的非 GET 方法。 +4. 删除、发送邮件、修改规则和账号设置等操作统一接入防护中间件。 +5. 对 API 客户端和浏览器会话区分认证方式,避免 CSRF 逻辑互相绕过。 + +### 验收标准 + +- 无 CSRF Token 的跨站状态修改请求被拒绝。 +- 错误 Origin 被拒绝。 +- GET 请求不能执行有副作用的操作。 +- 正常前端请求自动携带并校验 Token。 +- 登录、退出和 Token 失效流程经过验证。 + +--- + +## SEC-010:收紧邮件 HTML 清理和展示隔离 + +- **状态**:[ ] 未开始 +- **风险等级**:P1 / 中风险 +- **关联问题**:邮件正文使用 `v-html`,允许较宽的 HTML 和外链能力。 +- **关联文件**: + - `server/dto/parsemail/email.go` + - `fe/src/views/EmailDetailView.vue` + +### 整改要求 + +1. 使用成熟的 HTML Sanitizer 或严格白名单。 +2. 默认禁止 `