certbot-dns-esa 1.0.0__tar.gz

certbot_dns_esa-1.0.0/.gitignore

@@ -0,0 +1,253 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs/Zensical documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
+#   can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, you
+#   could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Local AI development instructions, configuration, sessions and caches
+AGENTS.md
+AGENTS.override.md
+CLAUDE*.md
+GEMINI*.md
+CODEX*.md
+.ai/
+.codex/
+.claude/
+.cursor/
+.cursorrules
+.cursorignore
+.cursorindexingignore
+.gemini/
+.aider*
+.continue/
+.windsurf/
+.windsurfrules
+.cline/
+.clinerules
+.roo/
+.roorules
+.opencode/
+.copilot/
+.agents/
+.agent/
+.skills/
+/.github/copilot-instructions.md
+/.github/instructions/
+/.github/prompts/
+/.github/agents/
+/.github/skills/

certbot_dns_esa-1.0.0/CHANGELOG.md

@@ -0,0 +1,8 @@
+# 更新日志
+
+## 1.0.0
+
+- 基于官方 ESA 2024-09-10 SDK 实现 Certbot DNS-01 验证。
+- 自动发现 NS 托管站点，支持国际化域名和最长站点匹配。
+- 支持多挑战、TXT 记录所有权追踪、已有记录保护和清理重试。
+- 提供 Certbot 3/4/5 的 wheel 安装验证、兼容测试与 CI/CD。

certbot_dns_esa-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# 开发与验证
+
+使用 uv 管理依赖，`pyproject.toml` 为版本、依赖、入口和构建配置的唯一来源。
+
+```bash
+uv sync --locked --python 3.13
+uv run --no-sync ruff check .
+uv run --no-sync ruff format --check .
+uv run --no-sync pytest --cov=certbot_dns_esa --cov-report=term-missing
+```
+
+测试模拟外部 API，不修改真实 DNS，也不向 ACME 服务申请证书。SDK 请求和响应使用真实 DTO；另通过模拟 HTTP 传输验证 SDK 不会重试写入。
+
+兼容矩阵使用 tox-uv 构建并安装 wheel，从源码目录之外运行测试，校验实际宿主版本、插件入口、导入路径及 `certbot plugins --text`：
+
+```bash
+uv python install 3.9 3.10 3.11 3.12 3.13 3.14 3.15
+uv run --no-sync tox run-parallel -p 4
+uv build
+uv run --no-sync twine check --strict dist/*
+```
+
+矩阵共 18 组：Python 3.9–3.13 × Certbot 3、Python 3.9–3.15 × Certbot 4、Python 3.10–3.15 × Certbot 5。Certbot 3 测试固定最低版本 3.0.0，并限制 `pyopenssl<25`；该限制不能加入插件运行依赖，否则会与 Certbot 4/5 冲突。Python 3.14 及以后不支持旧 josepy 1.x，限定使用 Certbot 4/5。
+
+修改依赖后执行 `uv lock`；修改认证行为或兼容边界后运行单元测试及完整矩阵；修改发行配置后构建并校验 wheel/sdist。
+
+认证器复用 Certbot 公共生命周期。站点必须通过完整分页发现并按 DNS 标签边界匹配，查询失败不得猜测站点。仅删除本次创建且保存了 ID 的记录；已有记录不得更新或删除。SDK 超时和重试策略应同时通过实际传输层测试验证。
+
+GitHub Actions 对 push/PR 执行检查。发布工作流在 release 发布时复用完整 CI，检查标签为 `v{项目版本}`；预发布版本只验证，正式版本验证成功后使用 PyPI Trusted Publishing 发布。需在仓库配置 `pypi` environment 及 PyPI 的可信发布者。

certbot_dns_esa-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 TiyeeJiang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

certbot_dns_esa-1.0.0/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: certbot-dns-esa
+Version: 1.0.0
+Summary: 阿里云边缘安全加速 ESA DNS 插件，用于 Certbot 的 DNS-01 验证
+Project-URL: Homepage, https://github.com/tiyee/certbot-dns-esa
+Project-URL: Repository, https://github.com/tiyee/certbot-dns-esa
+Project-URL: Issues, https://github.com/tiyee/certbot-dns-esa/issues
+Author-email: tiyee <tiyee@live.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: acme,aliyun,certbot,dns-01,esa
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Plugins
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Security
+Requires-Python: >=3.9
+Requires-Dist: acme<6,>=3
+Requires-Dist: alibabacloud-esa20240910<4,>=3.16
+Requires-Dist: alibabacloud-tea-openapi<1,>=0.4.5
+Requires-Dist: certbot<5,>=3; python_version < '3.10'
+Requires-Dist: certbot<6,>=3; python_version >= '3.10' and python_version < '3.14'
+Requires-Dist: certbot<6,>=4; python_version >= '3.14'
+Requires-Dist: darabonba-core<2,>=1.0.8
+Requires-Dist: importlib-metadata<9,>=4.6; python_version < '3.10'
+Description-Content-Type: text/markdown
+
+# Certbot DNS 阿里云 ESA 插件
+
+通过阿里云边缘安全加速（ESA）API 自动创建 TXT 记录，完成 Certbot DNS-01 验证，申请及续期普通域名和泛域名证书。
+
+本插件适用于 **NS 接入 ESA** 的域名，且 NS 委派须已生效；CNAME 接入仍需使用原 DNS 服务商的 Certbot 插件。参见 [ESA DNS 接入方式](https://help.aliyun.com/zh/edge-security-acceleration/esa/user-guide/dns-overview/)。
+
+## 功能特性
+
+- 自动分页查询站点，按 DNS 标签边界选择最长匹配项，无需手动填写站点 ID
+- 支持普通域名、子域名、泛域名及国际化域名
+- 支持多个挑战共用记录名，仅清理本次创建的记录，保留已有 TXT 记录
+- 支持 AccessKey 和 STS 临时凭证
+- 支持 Certbot 3、4、5 和 Python 3.9–3.15
+
+Python 3.9 支持 Certbot 3/4，Python 3.10–3.13 支持 Certbot 3/4/5，Python 3.14–3.15 支持 Certbot 4/5。使用 Certbot 3 时需额外安装 `pyopenssl<25`。
+
+## 安装
+
+在实际运行 Certbot 的 Python 环境中，从源码安装：
+
+```bash
+pip install .
+certbot plugins --text
+```
+
+输出应包含 `dns-esa`。使用 Certbot 3 时执行 `pip install 'pyopenssl<25'`。
+
+## 配置文件
+
+保存为 `~/esa.ini`：
+
+```ini
+dns_esa_access_key_id = YOUR_ACCESS_KEY_ID
+dns_esa_access_key_secret = YOUR_ACCESS_KEY_SECRET
+# 可选，默认 cn-hangzhou；国际站可使用 ap-southeast-1
+dns_esa_region_id = cn-hangzhou
+# 可选，仅使用 STS 临时凭证时填写
+# dns_esa_security_token = YOUR_SECURITY_TOKEN
+```
+
+`region_id` 应与站点所在的 API 地域一致。插件只查询所选地域，不会跨地域猜测。支持的公网接入点为杭州和新加坡，参见 [ESA 服务接入点](https://help.aliyun.com/zh/edge-security-acceleration/esa/api-esa-2024-09-10-endpoint)。使用 STS 时，续期前需确保凭证仍有效。
+
+限制凭证文件权限：
+
+```bash
+chmod 600 ~/esa.ini
+```
+
+Windows 用户请通过系统文件权限限制访问。
+
+## 运行
+
+```bash
+certbot certonly \
+  --authenticator dns-esa \
+  --dns-esa-credentials ~/esa.ini \
+  --dns-esa-propagation-seconds 30 \
+  -d '*.example.com' \
+  -d example.com
+```
+
+DNS 传播等待默认 30 秒，可根据实际情况增加。TXT TTL 默认 600 秒，可通过 `--dns-esa-ttl` 调整；`1` 表示 ESA 自动 TTL，其余允许值取决于服务限制。创建记录超时后插件不会自动重试写入，以避免重复创建。
+
+后续使用 `certbot renew` 自动续期。可先使用 `certbot renew --dry-run` 检查续期配置。
+
+## 阿里云权限配置
+
+AccessKey 需具备 `AliyunESAFullAccess`，或包含以下操作的自定义 RAM 权限：
+
+```json
+{
+  "Version": "1",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": [
+        "esa:ListSites",
+        "esa:ListRecords",
+        "esa:CreateRecord",
+        "esa:DeleteRecord"
+      ],
+      "Resource": "*"
+    }
+  ]
+}
+```
+
+`ListSites` 和 `DeleteRecord` 需要 `Resource: "*"`；`ListRecords` 和 `CreateRecord` 可进一步限制到指定站点。参见 [ListSites](https://help.aliyun.com/zh/edge-security-acceleration/esa/api-esa-2024-09-10-listsites)、[ListRecords](https://help.aliyun.com/zh/edge-security-acceleration/esa/api-esa-2024-09-10-listrecords)、[CreateRecord](https://help.aliyun.com/zh/edge-security-acceleration/esa/api-esa-2024-09-10-createrecord)、[DeleteRecord](https://help.aliyun.com/zh/edge-security-acceleration/esa/api-esa-2024-09-10-deleterecord)。
+
+## 自动部署
+
+本项目只负责 Certbot DNS 验证；申请后的自动部署可配合 [AutoCert](https://github.com/tiyee/AutoCert)。
+
+实现参考 [certbot-dns-aliyun-next](https://github.com/tiyee/certbot-dns-aliyun-next)。

certbot_dns_esa-1.0.0/README.md

@@ -0,0 +1,94 @@
+# Certbot DNS 阿里云 ESA 插件
+
+通过阿里云边缘安全加速（ESA）API 自动创建 TXT 记录，完成 Certbot DNS-01 验证，申请及续期普通域名和泛域名证书。
+
+本插件适用于 **NS 接入 ESA** 的域名，且 NS 委派须已生效；CNAME 接入仍需使用原 DNS 服务商的 Certbot 插件。参见 [ESA DNS 接入方式](https://help.aliyun.com/zh/edge-security-acceleration/esa/user-guide/dns-overview/)。
+
+## 功能特性
+
+- 自动分页查询站点，按 DNS 标签边界选择最长匹配项，无需手动填写站点 ID
+- 支持普通域名、子域名、泛域名及国际化域名
+- 支持多个挑战共用记录名，仅清理本次创建的记录，保留已有 TXT 记录
+- 支持 AccessKey 和 STS 临时凭证
+- 支持 Certbot 3、4、5 和 Python 3.9–3.15
+
+Python 3.9 支持 Certbot 3/4，Python 3.10–3.13 支持 Certbot 3/4/5，Python 3.14–3.15 支持 Certbot 4/5。使用 Certbot 3 时需额外安装 `pyopenssl<25`。
+
+## 安装
+
+在实际运行 Certbot 的 Python 环境中，从源码安装：
+
+```bash
+pip install .
+certbot plugins --text
+```
+
+输出应包含 `dns-esa`。使用 Certbot 3 时执行 `pip install 'pyopenssl<25'`。
+
+## 配置文件
+
+保存为 `~/esa.ini`：
+
+```ini
+dns_esa_access_key_id = YOUR_ACCESS_KEY_ID
+dns_esa_access_key_secret = YOUR_ACCESS_KEY_SECRET
+# 可选，默认 cn-hangzhou；国际站可使用 ap-southeast-1
+dns_esa_region_id = cn-hangzhou
+# 可选，仅使用 STS 临时凭证时填写
+# dns_esa_security_token = YOUR_SECURITY_TOKEN
+```
+
+`region_id` 应与站点所在的 API 地域一致。插件只查询所选地域，不会跨地域猜测。支持的公网接入点为杭州和新加坡，参见 [ESA 服务接入点](https://help.aliyun.com/zh/edge-security-acceleration/esa/api-esa-2024-09-10-endpoint)。使用 STS 时，续期前需确保凭证仍有效。
+
+限制凭证文件权限：
+
+```bash
+chmod 600 ~/esa.ini
+```
+
+Windows 用户请通过系统文件权限限制访问。
+
+## 运行
+
+```bash
+certbot certonly \
+  --authenticator dns-esa \
+  --dns-esa-credentials ~/esa.ini \
+  --dns-esa-propagation-seconds 30 \
+  -d '*.example.com' \
+  -d example.com
+```
+
+DNS 传播等待默认 30 秒，可根据实际情况增加。TXT TTL 默认 600 秒，可通过 `--dns-esa-ttl` 调整；`1` 表示 ESA 自动 TTL，其余允许值取决于服务限制。创建记录超时后插件不会自动重试写入，以避免重复创建。
+
+后续使用 `certbot renew` 自动续期。可先使用 `certbot renew --dry-run` 检查续期配置。
+
+## 阿里云权限配置
+
+AccessKey 需具备 `AliyunESAFullAccess`，或包含以下操作的自定义 RAM 权限：
+
+```json
+{
+  "Version": "1",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": [
+        "esa:ListSites",
+        "esa:ListRecords",
+        "esa:CreateRecord",
+        "esa:DeleteRecord"
+      ],
+      "Resource": "*"
+    }
+  ]
+}
+```
+
+`ListSites` 和 `DeleteRecord` 需要 `Resource: "*"`；`ListRecords` 和 `CreateRecord` 可进一步限制到指定站点。参见 [ListSites](https://help.aliyun.com/zh/edge-security-acceleration/esa/api-esa-2024-09-10-listsites)、[ListRecords](https://help.aliyun.com/zh/edge-security-acceleration/esa/api-esa-2024-09-10-listrecords)、[CreateRecord](https://help.aliyun.com/zh/edge-security-acceleration/esa/api-esa-2024-09-10-createrecord)、[DeleteRecord](https://help.aliyun.com/zh/edge-security-acceleration/esa/api-esa-2024-09-10-deleterecord)。
+
+## 自动部署
+
+本项目只负责 Certbot DNS 验证；申请后的自动部署可配合 [AutoCert](https://github.com/tiyee/AutoCert)。
+
+实现参考 [certbot-dns-aliyun-next](https://github.com/tiyee/certbot-dns-aliyun-next)。

certbot_dns_esa-1.0.0/certbot_dns_esa/__init__.py

@@ -0,0 +1,5 @@
+"""Alibaba Cloud ESA DNS-01 authenticator for Certbot."""
+
+from certbot_dns_esa.compat import metadata
+
+__version__ = metadata.version("certbot-dns-esa")

certbot_dns_esa-1.0.0/certbot_dns_esa/compat.py

@@ -0,0 +1,24 @@
+"""Keep host compatibility in one place, using Certbot's public APIs.
+
+DNSAuthenticator already handles the annotated-challenge API changes between
+Certbot 3, 4 and 5. Inherit its public lifecycle instead of copying it or applying
+the obsolete zope.interface decorators (removed from Certbot's dependencies).
+"""
+
+import sys
+
+from certbot.plugins.dns_common import DNSAuthenticator
+
+if sys.version_info < (3, 10):
+    # Python 3.9's stdlib entry_points() does not support the group keyword.
+    import importlib_metadata as metadata
+else:
+    from importlib import metadata
+
+
+def certbot_major_version() -> int:
+    """Return the actual installed host version, not a resolver assumption."""
+    return int(metadata.version("certbot").split(".", 1)[0])
+
+
+__all__ = ["DNSAuthenticator", "certbot_major_version", "metadata"]