Skip to main content

Issue Let's Encrypt certificates (including wildcard) using cdmon DNS via pycdmon

Project description

cdmon-acme

Issue Let's Encrypt certificates (including wildcard) using cdmon DNS (dns-01) via pycdmon.

Features

  • Wildcard support (*.example.com)
  • Fully Python implementation
  • DNS TXT automation on cdmon
  • DNS propagation wait loop
  • Retries/backoff for DNS record create/delete
  • Lock file to prevent parallel issuance
  • Commands: issue, renew, inspect
  • Outputs: cert.pem, chain.pem, fullchain.pem, private key

Install

pip install -e .

Usage

export CDMON_API_KEY="..."

# Staging first (recommended)
cdmon-acme issue \
  --domain example.com \
  --wildcard \
  --email admin@example.com \
  --staging \
  --out ./certs

# Production
cdmon-acme issue \
  --domain example.com \
  --wildcard \
  --email admin@example.com \
  --out ./certs

# Renew (same flow, reusable keys + lock)
cdmon-acme renew \
  --domain example.com \
  --wildcard \
  --email admin@example.com \
  --out ./certs \
  --lock-file ./.state/issue.lock \
  --post-hook "systemctl reload nginx"

# Inspect existing cert
cdmon-acme inspect --cert ./certs/fullchain.pem

Security notes

  • Never commit private keys (secrets/, certs/)
  • Rotate/revoke credentials if exposed
  • Use staging first to avoid Let's Encrypt rate limits

Repo structure

  • src/cdmon_acme/issuer.py ACME + issuance flow
  • src/cdmon_acme/dns_solver.py cdmon DNS TXT create/delete + propagation
  • src/cdmon_acme/cert_info.py certificate inspection helpers
  • src/cdmon_acme/cli.py CLI

GitHub Actions renew example

Add repository secrets:

  • CDMON_API_KEY
  • ACME_EMAIL

Then use a scheduled workflow (example in .github/workflows/renew-example.yml).

Releases

This repository supports automatic releases from main using Python Semantic Release and Conventional Commits.

Why this approach

This is a Python package, so the release automation is Python-native:

  • no package.json
  • versioning is configured in pyproject.toml
  • the workflow uses python-semantic-release, build, and optional PyPI publication

Conventional Commits are only the input convention used to determine the version bump.

How it works

  • merge changes into main
  • GitHub Actions runs validation (ruff check . and pytest)
  • python-semantic-release inspects commit messages since the last tag
  • if a release is warranted, it will:
    • determine the next version
    • update pyproject.toml
    • create the release commit and tag
    • publish the GitHub Release
  • the workflow always creates the Git tag and GitHub Release when a release is warranted
  • if PYPI_TOKEN is defined in repository secrets, the workflow also publishes to PyPI
  • if PYPI_TOKEN is not defined but PYPI_MASTER_TOKEN exists, the workflow falls back to that token for PyPI publication
  • if neither token exists, the workflow skips the PyPI upload but still publishes the GitHub Release

Commit conventions

Use Conventional Commits so release automation can infer version bumps:

  • fix: -> patch release
  • feat: -> minor release
  • feat!: or any commit with BREAKING CHANGE: -> major release
  • docs:, test:, chore: -> no release by default

Example:

git commit -m "fix: correct TXT record handling for cdmon DNS challenge"

Notes

  • The release workflow only runs on pushes to main.
  • The repository must allow GitHub Actions to push release commits and tags using GITHUB_TOKEN.
  • If branch protection is strict, make sure it still permits the release workflow to push the generated release commit.

Status

MVP+ ready. Next recommended steps:

  • Add integration tests against LE staging + disposable domain
  • Add deploy target adapters (nginx/caddy/traefik)
  • Add optional webhook/slack notification on renew

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdmon_acme-1.0.0.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cdmon_acme-1.0.0-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file cdmon_acme-1.0.0.tar.gz.

File metadata

  • Download URL: cdmon_acme-1.0.0.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.13

File hashes

Hashes for cdmon_acme-1.0.0.tar.gz
Algorithm Hash digest
SHA256 459d6da0e6a675200db7206559044ba3b1ac878cd962c29f60ca6585efbd4eec
MD5 26fdfd39156f23fa6fd3681612d42d26
BLAKE2b-256 2539c675716cbfb4f8ac1d4077316ae91fd014dc6cd199e2259f752b7ce94353

See more details on using hashes here.

File details

Details for the file cdmon_acme-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: cdmon_acme-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.13

File hashes

Hashes for cdmon_acme-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 999f5cc28f0bf851957c6c2929d4dc57e36f2e4566f7f3554600e887d9245fe4
MD5 6e0d48b96b1c997132ed0343466719e2
BLAKE2b-256 c49f66b55c2005c543e4112701bee570aa2be22204c6708dfd4aef6aec0d4e1f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page