certbot-dns-easydns
=====================
EasyDNS_ 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 EasyDNS REST API.
Configuration of EasyDNS
------------------------
As an EasyDNS_ user with at least one domain being served by EasyDNS,
log into the control panel and navigate under "User" to "Security" and
then to the bottom, to the REST API section. You may need to complete
the registration form in order to receive credentials, but they should
be issued automatically once the form is submitted.
The user token is like a username or public key, but should probably
still be kept confidential. The API key is issued by clicking
"Regenerate" and is only shown for a short time in the browser and
then never again; be ready to copy it and stuff it into some sort
of protected datastore. Both must be used together to authenticate
with the API. See below about how to create a file for the credentials.
It is possible to direct the endpoint, but currently there is only ever
one correct value: ``https://rest.easydns.net``
.. _EasyDNS: https://www.easydns.com/
.. _certbot: https://certbot.eff.org/
Installation
------------
::
pip install certbot
pip install certbot-dns-easydns
Named Arguments
---------------
To start using DNS authentication for EasyDNS, pass the following arguments on
certbot's command line:
===================================== ==============================================
``--authenticator dns-easydns`` select the authenticator plugin (Required)
``--dns-easydns-credentials`` EasyDNS Remote User credentials
INI file (Required)
``--dns-easydns-propagation-seconds`` | waiting time for DNS to propagate before asking
| the ACME server to verify the DNS record
| (Default: 120, Recommended: >= 600)
===================================== ==============================================
Credentials
-----------
Credentials for access to the EasyDNS REST API are required in order
for this plugin to work. The credentials are stored in a separate INI
file which should have mode 0600 for security (see below). The file
is often stored in a location such as ``/root/.secrets`` or
``/etc/letsencrypt/.secrets`` and perhaps named for the authenticator,
e.g. ``/root/.secrets/easydns.ini``. Henceforth we shall refer to
this file as ``credentials.ini``.
An example ``credentials.ini`` file:
.. code-block:: ini
dns_easydns_usertoken = myremoteuser
dns_easydns_userkey = verysecureremoteuserpassword
dns_easydns_endpoint = https://rest.easydns.net
The full path to this file can be provided interactively or by using
the ``--dns-easydns-credentials`` command-line argument; that value
appears in the ``domain.conf`` which Certbot creates to describe the
domain which is the subject of the cert. Certbot records the absolute
path to this file for use during renewal, but does not store the
file's contents.
The ``domain.conf`` file is created by ``certbot`` if it is not
present, when the SSL cert is first provisioned by running the
``certbot certonly`` command (example below). If the
``--dns-easydns-credentials`` option is used, the resulting
``domain.conf`` file should reflect the location provided without any
need for editing by the user. However, if the credentials file
changes locations, then the ``domain.conf`` file will need to be
updated to reflect the new location. It is worthy of note that in the
``domain.conf`` file, the parameter uses underscores in place of
hyphens.
.. note::
Please note that providing the endpoint is required, though it is
currently always the same; this is for forward compatibility.
.. caution::
You should protect these API credentials as you would the
password to your EasyDNS 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).
Examples
--------
To acquire a single certificate for both ``example.com`` and
``*.example.com``, waiting 900 seconds for DNS propagation:
.. code-block:: bash
certbot certonly \
--authenticator dns-easydns \
--dns-easydns-credentials /etc/letsencrypt/.secrets/domain.tld.ini \
--dns-easydns-propagation-seconds 900 \
--server https://acme-v02.api.letsencrypt.org/directory \
--agree-tos \
--rsa-key-size 4096 \
-d 'example.com' \
-d '*.example.com'
Docker
------
In order to create a docker container with a certbot-dns-easydns installation,
create an empty directory with the following ``Dockerfile``:
.. code-block:: docker
FROM certbot/certbot
RUN pip install certbot-dns-easydns
Proceed to build the image::
docker build -t certbot/dns-easydns .
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 \
certbot/dns-easydns certonly \
--authenticator dns-easydns \
--dns-easydns-propagation-seconds 900 \
--dns-easydns-credentials \
/etc/letsencrypt/.secrets/domain.tld.ini \
--no-self-upgrade \
--keep-until-expiring --non-interactive --expand \
--server https://acme-v02.api.letsencrypt.org/directory \
-d example.com -d '*.example.com'
It is suggested to secure the folder as follows::
chown root:root /etc/letsencrypt/.secrets
chmod 600 /etc/letsencrypt/.secrets
Raw data
{
"_id": null,
"home_page": "https://github.com/easydns/certbot-dns-easydns",
"name": "certbot-dns-easydns",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
"maintainer_email": "",
"keywords": "",
"author": "Caleb S. Cullen",
"author_email": "certbot-dev@easydns.com",
"download_url": "https://files.pythonhosted.org/packages/84/51/e9f8b673062d8729265f1bf3006eebac85d4e663b6af66c4c4f99d19843b/certbot-dns-easydns-0.1.3.tar.gz",
"platform": null,
"description": "certbot-dns-easydns\n=====================\n\nEasyDNS_ 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 EasyDNS REST API.\n\nConfiguration of EasyDNS\n------------------------\n\nAs an EasyDNS_ user with at least one domain being served by EasyDNS,\nlog into the control panel and navigate under \"User\" to \"Security\" and\nthen to the bottom, to the REST API section. You may need to complete\nthe registration form in order to receive credentials, but they should\nbe issued automatically once the form is submitted.\n\nThe user token is like a username or public key, but should probably\nstill be kept confidential. The API key is issued by clicking\n\"Regenerate\" and is only shown for a short time in the browser and\nthen never again; be ready to copy it and stuff it into some sort\nof protected datastore. Both must be used together to authenticate\nwith the API. See below about how to create a file for the credentials.\n\nIt is possible to direct the endpoint, but currently there is only ever\none correct value: ``https://rest.easydns.net``\n\n.. _EasyDNS: https://www.easydns.com/\n.. _certbot: https://certbot.eff.org/\n\nInstallation\n------------\n\n::\n\n pip install certbot\n pip install certbot-dns-easydns\n\n\nNamed Arguments\n---------------\n\nTo start using DNS authentication for EasyDNS, pass the following arguments on\ncertbot's command line:\n\n===================================== ==============================================\n``--authenticator dns-easydns`` select the authenticator plugin (Required)\n\n``--dns-easydns-credentials`` EasyDNS Remote User credentials\n INI file (Required)\n\n``--dns-easydns-propagation-seconds`` | waiting time for DNS to propagate before asking\n | the ACME server to verify the DNS record\n | (Default: 120, Recommended: >= 600)\n===================================== ==============================================\n\n\nCredentials\n-----------\n\nCredentials for access to the EasyDNS REST API are required in order\nfor this plugin to work. The credentials are stored in a separate INI\nfile which should have mode 0600 for security (see below). The file\nis often stored in a location such as ``/root/.secrets`` or\n``/etc/letsencrypt/.secrets`` and perhaps named for the authenticator,\ne.g. ``/root/.secrets/easydns.ini``. Henceforth we shall refer to\nthis file as ``credentials.ini``.\n\nAn example ``credentials.ini`` file:\n\n.. code-block:: ini\n\n dns_easydns_usertoken = myremoteuser\n dns_easydns_userkey = verysecureremoteuserpassword\n dns_easydns_endpoint = https://rest.easydns.net\n\n\nThe full path to this file can be provided interactively or by using\nthe ``--dns-easydns-credentials`` command-line argument; that value\nappears in the ``domain.conf`` which Certbot creates to describe the\ndomain which is the subject of the cert. Certbot records the absolute\npath to this file for use during renewal, but does not store the\nfile's contents.\n\nThe ``domain.conf`` file is created by ``certbot`` if it is not\npresent, when the SSL cert is first provisioned by running the\n``certbot certonly`` command (example below). If the\n``--dns-easydns-credentials`` option is used, the resulting\n``domain.conf`` file should reflect the location provided without any\nneed for editing by the user. However, if the credentials file\nchanges locations, then the ``domain.conf`` file will need to be\nupdated to reflect the new location. It is worthy of note that in the\n``domain.conf`` file, the parameter uses underscores in place of\nhyphens.\n\n.. note::\n\n Please note that providing the endpoint is required, though it is\n currently always the same; this is for forward compatibility.\n\n.. caution::\n\n You should protect these API credentials as you would the\n password to your EasyDNS account. Users who can read this file can use these\n credentials to issue arbitrary API calls on your behalf. Users who can cause\n Certbot to run using these credentials can complete a ``dns-01`` challenge to\n acquire new certificates or revoke existing certificates for associated\n domains, even if those domains aren't being managed by this server.\n\n Certbot will emit a warning if it detects that the credentials file can be\n accessed by other users on your system. The warning reads \"Unsafe permissions\n on credentials configuration file\", followed by the path to the credentials\n file. This warning will be emitted each time Certbot uses the credentials file,\n including 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\nExamples\n--------\n\nTo acquire a single certificate for both ``example.com`` and\n``*.example.com``, waiting 900 seconds for DNS propagation:\n\n.. code-block:: bash\n\n certbot certonly \\\n --authenticator dns-easydns \\\n --dns-easydns-credentials /etc/letsencrypt/.secrets/domain.tld.ini \\\n --dns-easydns-propagation-seconds 900 \\\n --server https://acme-v02.api.letsencrypt.org/directory \\\n --agree-tos \\\n --rsa-key-size 4096 \\\n -d 'example.com' \\\n -d '*.example.com'\n\n\nDocker\n------\n\nIn order to create a docker container with a certbot-dns-easydns installation,\ncreate an empty directory with the following ``Dockerfile``:\n\n.. code-block:: docker\n\n FROM certbot/certbot\n RUN pip install certbot-dns-easydns\n\nProceed to build the image::\n\n docker build -t certbot/dns-easydns .\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 certbot/dns-easydns certonly \\\n --authenticator dns-easydns \\\n --dns-easydns-propagation-seconds 900 \\\n --dns-easydns-credentials \\\n /etc/letsencrypt/.secrets/domain.tld.ini \\\n --no-self-upgrade \\\n --keep-until-expiring --non-interactive --expand \\\n --server https://acme-v02.api.letsencrypt.org/directory \\\n -d example.com -d '*.example.com'\n\nIt is suggested to secure the folder as follows::\nchown root:root /etc/letsencrypt/.secrets\nchmod 600 /etc/letsencrypt/.secrets\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "EasyDNS Authenticator plugin for Certbot",
"version": "0.1.3",
"project_urls": {
"Bug Tracker": "https://github.com/easydns/certbot-dns-easydns/issues",
"Documentation": "https://github.com/easydns/certbot-dns-easydns/",
"Homepage": "https://github.com/easydns/certbot-dns-easydns",
"Release Notes": "https://github.com/easydns/certbot-dns-easydns/blob/main/CHANGELOG.md",
"Source Code": "https://github.com/easydns/certbot-dns-easydns/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8451e9f8b673062d8729265f1bf3006eebac85d4e663b6af66c4c4f99d19843b",
"md5": "3781ebca17dd83171e66e6df7956a18f",
"sha256": "1be99bcb8a049a57eb071b5db5410f952aaf70e18fbfa2b60c1fc866aa84795f"
},
"downloads": -1,
"filename": "certbot-dns-easydns-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "3781ebca17dd83171e66e6df7956a18f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
"size": 11096,
"upload_time": "2024-01-30T21:26:50",
"upload_time_iso_8601": "2024-01-30T21:26:50.842614Z",
"url": "https://files.pythonhosted.org/packages/84/51/e9f8b673062d8729265f1bf3006eebac85d4e663b6af66c4c4f99d19843b/certbot-dns-easydns-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-30 21:26:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "easydns",
"github_project": "certbot-dns-easydns",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "certbot-dns-easydns"
}
JSON
