certbot-dns-netcup
==================
|Version| |License| |ImageSize|
netcup_ DNS Authenticator plugin for certbot_.
This plugin automates the process of completing a ``dns-01`` challenge by
creating, and subsequently removing, ``TXT`` records using the netcup `CCP
API`_ via lexicon_.
**Note:** This manual assumes certbot ≥ v1.7, which has improved the naming
scheme for external plugins. If you cannot upgrade, please also refer to the
`Old option naming scheme`_ section below.
.. _netcup: https://www.netcup.de/
.. _certbot: https://certbot.eff.org/
.. _CCP API: https://www.netcup-wiki.de/wiki/CCP_API
.. _lexicon: https://github.com/AnalogJ/lexicon
.. _certbot-dns-cloudflare: https://certbot-dns-cloudflare.readthedocs.io/en/latest/
Installation
------------
Since this package acts as a plugin for certbot_, the installation method can
vary depending on how certbot is installed.
pip
~~~
If certbot is installed normally as a python package, the plugin can be
installed using::
pip install certbot-dns-netcup
snap
~~~~
If certbot is installed as a snap, you'll have to install this plugin as
follows::
sudo snap install certbot-dns-netcup
Furthermore, the following seems to be required in order to connect the plugin
to certbot::
sudo snap set certbot trust-plugin-with-root=ok
sudo snap connect certbot:plugin certbot-dns-netcup
docker
~~~~~~
Using docker, you can pull an image that contains both certbot and a matching
version of the plugin::
docker pull coldfix/certbot-dns-netcup
Usage
-----
To acquire a single certificate for both ``example.com`` and
``*.example.com``, waiting 1200 seconds (20min) for DNS propagation::
certbot certonly \\
--authenticator dns-netcup \\
--dns-netcup-credentials ~/.secrets/certbot/netcup.ini \\
--dns-netcup-propagation-seconds 1200 \\
--keep-until-expiring --non-interactive --expand \
--server https://acme-v02.api.letsencrypt.org/directory \
-d 'example.com' \\
-d '*.example.com'
The parameters and the format of the credentials file are described below.
Named Arguments
---------------
To start using DNS authentication for netcup, pass the following arguments on
certbot's command line:
======================================== =======================
``--authenticator dns-netcup`` select the authenticator
plugin (Required)
``--dns-netcup-credentials FILE`` netcup credentials_
INI file. (Required)
``--dns-netcup-propagation-seconds NUM`` | waiting time for DNS to propagate before asking
| the ACME server to verify the DNS record.
| (Default: 900, Recommended: >= 600)
======================================== =======================
**NOTE:**
You may need to set an unexpectedly high propagation time (≥ 900 seconds) to
give the netcup DNS time to propagate the entries! This may be annoying when
calling certbot manually but should not be a problem in automated setups.
In exceptional cases, 20 minutes may be required. See `#28`_.
.. _#28: https://github.com/coldfix/certbot-dns-netcup/issues/28
Credentials
-----------
Use of this plugin requires a configuration file containing netcup API
credentials, obtained from your netcup `account page`_. See also the `CCP
API`_ documentation.
.. _account page: https://ccp.netcup.net/run/daten_aendern.php?sprung=api
An example ``credentials.ini`` file:
.. code-block:: ini
dns_netcup_customer_id = 123456
dns_netcup_api_key = 0123456789abcdef0123456789abcdef01234567
dns_netcup_api_password = abcdef0123456789abcdef01234567abcdef0123
The path to this file can be provided interactively or using the
``--dns-netcup-credentials`` command-line argument. Certbot
records the path to this file for use during renewal, but does not store the
file's contents.
**CAUTION:** You should protect these API credentials as you would the
password to your netcup 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).
Docker
------
You can pull the latest version of the docker image directly from Docker Hub
as follows::
docker pull coldfix/certbot-dns-netcup
Alternatively, the docker image can be built from a local checkout and the
included ``Dockerfile`` as follows::
docker build -t coldfix/certbot-dns-netcup .
Once that's finished, the application can be run as follows::
docker run --rm \
-v /var/lib/letsencrypt:/var/lib/letsencrypt \
-v /etc/letsencrypt:/etc/letsencrypt \
--cap-drop=all \
coldfix/certbot-dns-netcup certbot certonly \
--authenticator dns-netcup \
--dns-netcup-propagation-seconds 900 \
--dns-netcup-credentials /var/lib/letsencrypt/netcup_credentials.ini \
--keep-until-expiring --non-interactive --expand \
--server https://acme-v02.api.letsencrypt.org/directory \
--agree-tos --email "webmaster@example.com" \
-d example.com -d '*.example.com'
You may want to change the volumes ``/var/lib/letsencrypt`` and
``/etc/letsencrypt`` to local directories where the certificates and
configuration should be stored.
Old option naming scheme
------------------------
It is recommended to use the newest certbot version, at least ``v1.7``.
If you're using a certbot version below ``v1.7`` all options related to
external plugins (such as this one) must be prefixed by the name of the
plugin. This means that every occurence of ``dns-netcup`` in the command line
options must be replaced by ``certbot-dns-netcup:dns-netcup``, i.e.::
--authenticator certbot-dns-netcup:dns-netcup
--certbot-dns-netcup:dns-netcup-credentials
--certbot-dns-netcup:dns-netcup-propagation-seconds
Further, every occurence of ``dns_netcup`` in the config file must be prefixed
by ``certbot_dns_netcup:``, resulting in a file like this:
.. code-block:: ini
certbot_dns_netcup:dns_netcup_customer_id = ...
certbot_dns_netcup:dns_netcup_api_key = ...
certbot_dns_netcup:dns_netcup_api_password = ...
.. Badges:
.. |Version| image:: https://img.shields.io/pypi/v/certbot-dns-netcup.svg
:target: https://pypi.python.org/pypi/certbot-dns-netcup
:alt: Version
.. |License| image:: https://img.shields.io/pypi/l/certbot-dns-netcup.svg
:target: https://github.com/coldfix/certbot-dns-netcup/blob/master/LICENSE.txt
:alt: License: Apache
.. |ImageSize| image:: https://img.shields.io/docker/image-size/coldfix/certbot-dns-netcup
:target: https://hub.docker.com/repository/docker/coldfix/certbot-dns-netcup
:alt: Docker image size
Raw data
{
"_id": null,
"home_page": "https://github.com/coldfix/certbot-dns-netcup",
"name": "certbot-dns-netcup",
"maintainer": "",
"docs_url": null,
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"maintainer_email": "",
"keywords": "",
"author": "Thomas Gl\u00e4\u00dfle",
"author_email": "thomas@coldfix.de",
"download_url": "https://files.pythonhosted.org/packages/f8/f1/e7f43edd8b3dfa8247967adc21243153119ffe3fe60a6bc1b32efd1b749f/certbot-dns-netcup-1.4.3.tar.gz",
"platform": null,
"description": "certbot-dns-netcup\n==================\n\n|Version| |License| |ImageSize|\n\nnetcup_ DNS Authenticator plugin for certbot_.\n\nThis plugin automates the process of completing a ``dns-01`` challenge by\ncreating, and subsequently removing, ``TXT`` records using the netcup `CCP\nAPI`_ via lexicon_.\n\n**Note:** This manual assumes certbot \u2265 v1.7, which has improved the naming\nscheme for external plugins. If you cannot upgrade, please also refer to the\n`Old option naming scheme`_ section below.\n\n.. _netcup: https://www.netcup.de/\n.. _certbot: https://certbot.eff.org/\n.. _CCP API: https://www.netcup-wiki.de/wiki/CCP_API\n.. _lexicon: https://github.com/AnalogJ/lexicon\n.. _certbot-dns-cloudflare: https://certbot-dns-cloudflare.readthedocs.io/en/latest/\n\n\nInstallation\n------------\n\nSince this package acts as a plugin for certbot_, the installation method can\nvary depending on how certbot is installed.\n\npip\n~~~\n\nIf certbot is installed normally as a python package, the plugin can be\ninstalled using::\n\n pip install certbot-dns-netcup\n\nsnap\n~~~~\n\nIf certbot is installed as a snap, you'll have to install this plugin as\nfollows::\n\n sudo snap install certbot-dns-netcup\n\nFurthermore, the following seems to be required in order to connect the plugin\nto certbot::\n\n sudo snap set certbot trust-plugin-with-root=ok\n sudo snap connect certbot:plugin certbot-dns-netcup\n\ndocker\n~~~~~~\n\nUsing docker, you can pull an image that contains both certbot and a matching\nversion of the plugin::\n\n docker pull coldfix/certbot-dns-netcup\n\n\nUsage\n-----\n\nTo acquire a single certificate for both ``example.com`` and\n``*.example.com``, waiting 1200 seconds (20min) for DNS propagation::\n\n certbot certonly \\\\\n --authenticator dns-netcup \\\\\n --dns-netcup-credentials ~/.secrets/certbot/netcup.ini \\\\\n --dns-netcup-propagation-seconds 1200 \\\\\n --keep-until-expiring --non-interactive --expand \\\n --server https://acme-v02.api.letsencrypt.org/directory \\\n -d 'example.com' \\\\\n -d '*.example.com'\n\nThe parameters and the format of the credentials file are described below.\n\n\nNamed Arguments\n---------------\n\nTo start using DNS authentication for netcup, pass the following arguments on\ncertbot's command line:\n\n======================================== =======================\n``--authenticator dns-netcup`` select the authenticator\n plugin (Required)\n\n``--dns-netcup-credentials FILE`` netcup credentials_\n INI file. (Required)\n\n``--dns-netcup-propagation-seconds NUM`` | waiting time for DNS to propagate before asking\n | the ACME server to verify the DNS record.\n | (Default: 900, Recommended: >= 600)\n======================================== =======================\n\n**NOTE:**\nYou may need to set an unexpectedly high propagation time (\u2265 900 seconds) to\ngive the netcup DNS time to propagate the entries! This may be annoying when\ncalling certbot manually but should not be a problem in automated setups.\nIn exceptional cases, 20 minutes may be required. See `#28`_.\n\n.. _#28: https://github.com/coldfix/certbot-dns-netcup/issues/28\n\n\nCredentials\n-----------\n\nUse of this plugin requires a configuration file containing netcup API\ncredentials, obtained from your netcup `account page`_. See also the `CCP\nAPI`_ documentation.\n\n.. _account page: https://ccp.netcup.net/run/daten_aendern.php?sprung=api\n\nAn example ``credentials.ini`` file:\n\n.. code-block:: ini\n\n dns_netcup_customer_id = 123456\n dns_netcup_api_key = 0123456789abcdef0123456789abcdef01234567\n dns_netcup_api_password = abcdef0123456789abcdef01234567abcdef0123\n\nThe path to this file can be provided interactively or using the\n``--dns-netcup-credentials`` command-line argument. Certbot\nrecords the path to this file for use during renewal, but does not store the\nfile's contents.\n\n**CAUTION:** You should protect these API credentials as you would the\npassword to your netcup account. Users who can read this file can use these\ncredentials to issue arbitrary API calls on your behalf. Users who can cause\nCertbot to run using these credentials can complete a ``dns-01`` challenge to\nacquire new certificates or revoke existing certificates for associated\ndomains, even if those domains aren't being managed by this server.\n\nCertbot will emit a warning if it detects that the credentials file can be\naccessed by other users on your system. The warning reads \"Unsafe permissions\non credentials configuration file\", followed by the path to the credentials\nfile. This warning will be emitted each time Certbot uses the credentials file,\nincluding for renewal, and cannot be silenced except by addressing the issue\n(e.g., by using a command like ``chmod 600`` to restrict access to the file).\n\n\nDocker\n------\n\nYou can pull the latest version of the docker image directly from Docker Hub\nas follows::\n\n docker pull coldfix/certbot-dns-netcup\n\nAlternatively, the docker image can be built from a local checkout and the\nincluded ``Dockerfile`` as follows::\n\n docker build -t coldfix/certbot-dns-netcup .\n\nOnce that's finished, the application can be run as follows::\n\n docker run --rm \\\n -v /var/lib/letsencrypt:/var/lib/letsencrypt \\\n -v /etc/letsencrypt:/etc/letsencrypt \\\n --cap-drop=all \\\n coldfix/certbot-dns-netcup certbot certonly \\\n --authenticator dns-netcup \\\n --dns-netcup-propagation-seconds 900 \\\n --dns-netcup-credentials /var/lib/letsencrypt/netcup_credentials.ini \\\n --keep-until-expiring --non-interactive --expand \\\n --server https://acme-v02.api.letsencrypt.org/directory \\\n --agree-tos --email \"webmaster@example.com\" \\\n -d example.com -d '*.example.com'\n\nYou may want to change the volumes ``/var/lib/letsencrypt`` and\n``/etc/letsencrypt`` to local directories where the certificates and\nconfiguration should be stored.\n\n\nOld option naming scheme\n------------------------\n\nIt is recommended to use the newest certbot version, at least ``v1.7``.\n\nIf you're using a certbot version below ``v1.7`` all options related to\nexternal plugins (such as this one) must be prefixed by the name of the\nplugin. This means that every occurence of ``dns-netcup`` in the command line\noptions must be replaced by ``certbot-dns-netcup:dns-netcup``, i.e.::\n\n --authenticator certbot-dns-netcup:dns-netcup\n --certbot-dns-netcup:dns-netcup-credentials\n --certbot-dns-netcup:dns-netcup-propagation-seconds\n\nFurther, every occurence of ``dns_netcup`` in the config file must be prefixed\nby ``certbot_dns_netcup:``, resulting in a file like this:\n\n.. code-block:: ini\n\n certbot_dns_netcup:dns_netcup_customer_id = ...\n certbot_dns_netcup:dns_netcup_api_key = ...\n certbot_dns_netcup:dns_netcup_api_password = ...\n\n\n.. Badges:\n\n.. |Version| image:: https://img.shields.io/pypi/v/certbot-dns-netcup.svg\n :target: https://pypi.python.org/pypi/certbot-dns-netcup\n :alt: Version\n\n.. |License| image:: https://img.shields.io/pypi/l/certbot-dns-netcup.svg\n :target: https://github.com/coldfix/certbot-dns-netcup/blob/master/LICENSE.txt\n :alt: License: Apache\n\n.. |ImageSize| image:: https://img.shields.io/docker/image-size/coldfix/certbot-dns-netcup\n :target: https://hub.docker.com/repository/docker/coldfix/certbot-dns-netcup\n :alt: Docker image size\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "netcup DNS Authenticator plugin for Certbot",
"version": "1.4.3",
"project_urls": {
"Homepage": "https://github.com/coldfix/certbot-dns-netcup"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ad95f2e7f77c906b2d9058f665312df7fb8b62037a1b3222a6b359e9c9f2322f",
"md5": "5375703e214fcecb7027dd3f71e3a97e",
"sha256": "d2315f753b6f202c8d53d04853e4c44d93046c89ad3d1850135dbd6a90b4e3b4"
},
"downloads": -1,
"filename": "certbot_dns_netcup-1.4.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5375703e214fcecb7027dd3f71e3a97e",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"size": 9884,
"upload_time": "2023-11-19T13:09:37",
"upload_time_iso_8601": "2023-11-19T13:09:37.247549Z",
"url": "https://files.pythonhosted.org/packages/ad/95/f2e7f77c906b2d9058f665312df7fb8b62037a1b3222a6b359e9c9f2322f/certbot_dns_netcup-1.4.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f8f1e7f43edd8b3dfa8247967adc21243153119ffe3fe60a6bc1b32efd1b749f",
"md5": "78ee292e2a85d78202c94e68f1abde8b",
"sha256": "8fe45b9276b103891c0c5e05117ef0d06a7c08f7eb1fdb4f7adbcccb01d66510"
},
"downloads": -1,
"filename": "certbot-dns-netcup-1.4.3.tar.gz",
"has_sig": false,
"md5_digest": "78ee292e2a85d78202c94e68f1abde8b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,>=2.7",
"size": 9629,
"upload_time": "2023-11-19T13:09:38",
"upload_time_iso_8601": "2023-11-19T13:09:38.461102Z",
"url": "https://files.pythonhosted.org/packages/f8/f1/e7f43edd8b3dfa8247967adc21243153119ffe3fe60a6bc1b32efd1b749f/certbot-dns-netcup-1.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-19 13:09:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "coldfix",
"github_project": "certbot-dns-netcup",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "certbot-dns-netcup"
}
JSON
