Skip to main content

PyPI version Documentation Status Tests Build GitHub last commit Code style: black

The certbot_dns_gcore plugin automates the process of completing a dns-01 challenge (acme.challenges.DNS01) by creating, and subsequently removing, TXT records using the G-Core DNS API.

Documentation

For full documentation, including installation, examples, changelog please see readthedocs page.

Install

The plugin is not installed by default. It can be installed by command below.

pip install certbot-dns-gcore

Named Arguments

plugin flags Description
--dns-gcore-credentials G-Core credentials INI file. (Required)
--dns-gcore-propagation-seconds The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (Default: 10)

Credentials

Use of this plugin requires a configuration file containing G-Core DNS API credentials. You can use:

  • G-Core API Token, obtained from your profile panel or
  • use G-Core Authentication credentials (email and password) for login page.

G-Core API Token is recommended authentication option.

The token needed by Certbot for add temporary TXT record to zone what you need certificates for.

Example gcore.ini credentials file using restricted API Token (recommended)

# G-Core API token used by Certbot
dns_gcore_apitoken = 0123456789abcdef0123456789abcdef01234567

Example gcore.ini credentials file using authentication credentials (not recommended)

# G-Core API credentials used by Certbot
dns_gcore_email = gcore_user@example.com
dns_gcore_password = 0123456789abcdef0123456789abcdef01234

The path to this file can be provided interactively or using the --dns-gcore-credentials command-line argument. Certbot records the path to this file for use during renewal, but does not store the file's contents.

WARNING: You should protect these API credentials as you would the password to your G-Core account. Users who can read this file can use these credentials to issue arbitrary API calls on your behalf. Users who can cause Certbot to run using these credentials can complete a dns-01 challenge to acquire new certificates or revoke existing certificates for associated domains, even if those domains aren't being managed by this server.

Certbot will emit a warning if it detects that the credentials file can be accessed by other users on your system. The warning reads "Unsafe permissions on credentials configuration file", followed by the path to the credentials file. This warning will be emitted each time Certbot uses the credentials file, including for renewal, and cannot be silenced except by addressing the issue (e.g., by using a command like chmod 600 to restrict access to the file).

Also you can override the default api_url or achieve even more flexibility by specifying auth and dns_api urls separately. Example gcore.ini file:

# G-Core API urls used by Certbot
dns_gcore_api_url = https://api.reseller.com
# implies that authapi available as /iam and dnsapi as /dns

# or
dns_gcore_auth_url = https://api.example.org/iam
dns_gcore_dns_api_url = https://dnsapi.example.com

Examples

To acquire a certificate for example.com

certbot certonly --authenticator dns-gcore --dns-gcore-credentials=./gcore.ini -d 'example.com'

To acquire a certificate for example.com, waiting 80 seconds (recommended) for DNS propagation

certbot certonly --authenticator dns-gcore --dns-gcore-credentials=./gcore.ini --dns-gcore-propagation-seconds=80 -d 'example.com'

To acquire a ecdsa backed wildcard certificate for *.example.com, waiting 80 seconds (recommended) for DNS propagation in isolated directory (e.g. as non-root user)

mkdir certbot && cd certbot
certbot certonly --authenticator dns-gcore --dns-gcore-credentials=./gcore.ini --dns-gcore-propagation-seconds=80 -d '*.example.com' --key-type ecdsa --logs-dir=. --config-dir=. --work-dir=.

For developers

How to run\develop plugin in docker

docker-compose run --rm --service-ports dev bash
# commands below run inside docker container
pip install -e .
touch ./gcore.ini # add g-core dns api credentials
pip install certbot
certbot certonly --authenticator dns-gcore --dns-gcore-credentials=./gcore.ini -d 'example.com'

Main docs file here: certbot_dns_gcore/__init__.py Build html docs files: cd ./docs && sphinx-build -b html . _build/html Main plugin version here: certbot_dns_gcore/__version__.py

How to run tests: please see document .github/workflows/ci.yml

Metadata

Release files for certbot-dns-gcore 0.1.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for certbot-dns-gcore 0.1.8
File Size Uploaded Provenance Actions
certbot-dns-gcore-0.1.8.tar.gz 10.2 kB Without provenance Details for certbot-dns-gcore-0.1.8.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for certbot-dns-gcore 0.1.8
File Interpreter ABI Platform Actions
certbot_dns_gcore-0.1.8-py3-none-any.whl Python 3 none any Details for certbot_dns_gcore-0.1.8-py3-none-any.whl

Total release size: 21.8 kB

Release files / certbot-dns-gcore-0.1.8.tar.gz

Download URL certbot-dns-gcore-0.1.8.tar.gz
Size 10.2 kB
Tags Source
SHA-256 checksum
How to use checksums
7b830cc73f3b1925660fe0ded6a444fd6cb4d8e5a48bf46363d56ffef26c3e17
BLAKE2b-256 checksum
How to use checksums
a2f6463f5e814abb34e0e88f20b7b264f4995cd76a92cb7aebb43356b63561ee
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.17

Release files / certbot_dns_gcore-0.1.8-py3-none-any.whl

Download URL certbot_dns_gcore-0.1.8-py3-none-any.whl
Size 11.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2302e05aee307732f94319081e74a4f17ee2765383a2ecae3ff15fdea8e579f0
BLAKE2b-256 checksum
How to use checksums
5e89a0b459ee378254fcba11831623e26e6c73f5eb88c65e6204a924bc55b8e6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.17

Security for certbot-dns-gcore 0.1.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page