certbot-dns-gandi 1.6.2

Certbot plugin for authentication using Gandi LiveDNS

Certbot plugin for authentication using Gandi LiveDNS

This is a plugin for Certbot that uses the Gandi LiveDNS API to allow Gandi customers to prove control of a domain name.

[!IMPORTANT]
In order to match the naming convention for certbot plugin, the plugin has been repackaged under a new name certbot-dns-plugin and legacy users of the previous package will receive the new package as a dependency.

Usage

1. Obtain a Gandi API Personal Access Token (PAT) - see Gandi LiveDNS API > Authentication.

   Your Gandi personal access token requires minimum permissions in the Domains category to work with the plugin: See and renew domain names & Manage domain name technical configurations.

2. Install the plugin and ensure the old plugin name variant is not present:

   pip uninstall certbot-plugin-gandi
   pip install certbot-dns-gandi>=1.6.0
   

3. Create a /etc/letsencrypt/gandi.ini config file with the following contents:

   # Gandi personal access token
   dns_gandi_token=PERSONAL_ACCESS_TOKEN
   
   # optional organization id, remove it if not used
   dns_gandi_sharing_id=SHARINGID
   

   Replace PERSONAL_ACCESS_TOKEN with your Gandi personal access token.

4. Ensure permissions are set on /etc/letsencrypt/gandi.ini config file to disallow access from other users, e.g., using chmod 0600 /etc/letsencrypt/gandi.ini

5. Run certbot and direct it to use the plugin for authentication with the config file:

   certbot certonly --authenticator dns-gandi --dns-gandi-credentials /etc/letsencrypt/gandi.ini -d example.com
   # or
   certbot renew --authenticator dns-gandi --dns-gandi-credentials /etc/letsencrypt/gandi.ini
   

Please note that this solution is usually not relevant if you're using Gandi's web hosting services as Gandi offers free automated certificates for all simplehosting plans having SSL in the admin interface.

Be aware that the plugin configuration must be provided by CLI, configuration for third-party plugins in cli.ini is not supported by certbot for the moment. Please refer to #4351, #6504 and #7681 for details.

Distribution

PyPI is the upstream distribution channel, other channels are not maintained by me.

• PyPI: https://pypi.org/project/certbot-dns-gandi
• Archlinux: https://aur.archlinux.org/packages/certbot-dns-gandi-git/
• Debian: https://packages.debian.org/sid/main/python3-certbot-dns-gandi
• PyPI: https://pypi.org/project/certbot-dns-gandi/

pip uninstall certbot-plugin-gandi
pip install certbot-dns-gandi>=1.6.0

Installing this plugin from PyPI using pip will also install a recent version of certbot itself, which may conflict with any other certbot already installed on your system. See the provided Dockerfile on how to containerize certbot + the plugin to run together.

Wildcard certificates

This plugin is particularly useful when you need to obtain a wildcard certificate using dns challenges:

certbot certonly --authenticator dns-gandi --dns-gandi-credentials /etc/letsencrypt/gandi/gandi.ini -d domain.com -d \*.domain.com --server https://acme-v02.api.letsencrypt.org/directory

Automatic renewal

You can setup automatic renewal using crontab with the following job for weekly renewal attempts:

0 0 * * 0 certbot renew -q --authenticator dns-gandi --dns-gandi-credentials /etc/letsencrypt/gandi/gandi.ini --server https://acme-v02.api.letsencrypt.org/directory

Reading material

• A blog post by @realEmaRocca describing how to use this plugin on Debian

FAQ

What's certbot-plugin-gandi and certbot-dns-gandi ?

Decision was taken to adapt the name of the plugin to the common DNS plugin naming convention certbot-dns-* so the legacy package certbot-plugin-gandi will be deprecated in favor of certbot-dns-gandi.

I don't have a personal access token, only a Gandi LiveDNS API Key

Live DNS API keys are deprecated and now unusable.

I have a warning telling me Plugin legacy name certbot-plugin-gandi:dns may be removed in a future version. Please use dns instead.

Certbot had moved to remove 3rd party plugins prefixes since v1.7.0. Please switch to the new configuration format and remove any used prefix-based configuration.

Why do you keep this plugin a third-party plugin ? Just merge it with certbot ?

This Gandi plugin is a third-party plugin mainly because this plugin is not officially backed by Gandi and because Certbot does not accept new plugin submissions.

Credits

Huge thanks to Michael Porter for its original work !