| Name | certbot-dns-freedns JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | https://github.com/schleuss/certbot-dns-freedns |
| Summary | FreeDNS Authenticator plugin for Certbot |
| upload_time | 2024-04-24 23:45:06 |
| maintainer | None |
| docs_url | None |
| author | Rafael Schleuss |
| requires_python | >=3.0 |
| license | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
freedns
certbot
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
certbot-dns-freedns
===================
FreeDNS - 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 FreeDNS
Remote API.
Installation
------------
.. code:: bash
pip install certbot-dns-freedns
Named Arguments
---------------
To start using DNS authentication for freedns, pass the following
arguments on certbot’s command line:
+-----------------------------------+------------------------------------+
| --authenticator dns-freedns | select the authenticator plugin |
| | (Required) |
+-----------------------------------+------------------------------------+
| --dns-freedns-credentials | freedns Remote User credentials |
| | INI file. (Required) |
+-----------------------------------+------------------------------------+
| --dns-freedns-propagation-seconds | waiting time for DNS to propagate |
| | before asking the ACME server to |
| | verify the DNS record. (Default: |
| | 120, Recommended: >= 600) |
+-----------------------------------+------------------------------------+
..
(Note that the verbose and seemingly redundant
``certbot-dns-freedns:`` prefix is currently imposed by certbot for
external plugins.)
Credentials
-----------
An example ``credentials.ini`` file:
.. code:: ini
dns_freedns_username = myremoteuser
dns_freedns_password = verysecureremoteuserpassword
The path to this file can be provided interactively or using
the\ ``--dns-freedns-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 freedns 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:: bash
certbot certonly \
--authenticator dns-freedns \
--dns-freedns-credentials /etc/letsencrypt/.secrets/domain.tld.ini \
--dns-freedns-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-freedns
installation, create an empty directory with the following
``Dockerfile``:
.. code:: docker
FROM certbot/certbot
RUN pip install certbot-dns-freedns
Proceed to build the image:
.. code:: bash
docker build -t certbot/dns-freedns .
Once that’s finished, the application can be run as follows:
.. code:: bash
docker run --rm \
-v /var/lib/letsencrypt:/var/lib/letsencrypt \
-v /etc/letsencrypt:/etc/letsencrypt \
--cap-drop=all \
certbot/dns-freedns certonly \
--authenticator dns-freedns \
--dns-freedns-propagation-seconds 900 \
--dns-freedns-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:
.. code:: bash
chown root:root /etc/letsencrypt/.secrets
chmod 600 /etc/letsencrypt/.secrets
Raw data
{
"_id": null,
"home_page": "https://github.com/schleuss/certbot-dns-freedns",
"name": "certbot-dns-freedns",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.0",
"maintainer_email": null,
"keywords": "FreeDNS, Certbot",
"author": "Rafael Schleuss",
"author_email": "Rafael Schleuss <rschleuss@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/73/3f/33c60281778cd810ce35dfb1b0e3421a34b6dc01facbeea218cc8b58cb12/certbot_dns_freedns-0.2.0.tar.gz",
"platform": null,
"description": "certbot-dns-freedns\n===================\n\nFreeDNS - DNS Authenticator plugin for Certbot\n\nThis plugin automates the process of completing a ``dns-01`` challenge\nby creating, and subsequently removing, TXT records using the FreeDNS\nRemote API.\n\nInstallation\n------------\n\n.. code:: bash\n\n pip install certbot-dns-freedns\n\nNamed Arguments\n---------------\n\nTo start using DNS authentication for freedns, pass the following\narguments on certbot\u2019s command line:\n\n+-----------------------------------+------------------------------------+\n| --authenticator dns-freedns | select the authenticator plugin |\n| | (Required) |\n+-----------------------------------+------------------------------------+\n| --dns-freedns-credentials | freedns Remote User credentials |\n| | INI file. (Required) |\n+-----------------------------------+------------------------------------+\n| --dns-freedns-propagation-seconds | waiting time for DNS to propagate |\n| | before asking the ACME server to |\n| | verify the DNS record. (Default: |\n| | 120, Recommended: >= 600) |\n+-----------------------------------+------------------------------------+\n\n..\n\n (Note that the verbose and seemingly redundant\n ``certbot-dns-freedns:`` prefix is currently imposed by certbot for\n external plugins.)\n\nCredentials\n-----------\n\nAn example ``credentials.ini`` file:\n\n.. code:: ini\n\n dns_freedns_username = myremoteuser\n dns_freedns_password = verysecureremoteuserpassword\n\nThe path to this file can be provided interactively or using\nthe\\ ``--dns-freedns-credentials`` command-line argument. Certbot\nrecords the path to this file for use during renewal, but does not store\nthe file\u2019s contents.\n\n**CAUTION:** You should protect these API credentials as you would the\npassword to your freedns account. Users who can read this file can use\nthese credentials to issue arbitrary API calls on your behalf. Users who\ncan cause Certbot to run using these credentials can complete a\n``dns-01`` challenge to acquire new certificates or revoke existing\ncertificates for associated domains, even if those domains aren\u2019t being\nmanaged by this server.\n\nCertbot will emit a warning if it detects that the credentials file can\nbe accessed by other users on your system. The warning reads \u201cUnsafe\npermissions on credentials configuration file\u201d, followed by the path to\nthe credentials file. This warning will be emitted each time Certbot\nuses the credentials file, including for renewal, and cannot be silenced\nexcept by addressing the issue (e.g., by using a command like\n``chmod 600`` to restrict access to the file).\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:: bash\n\n certbot certonly \\\n --authenticator dns-freedns \\\n --dns-freedns-credentials /etc/letsencrypt/.secrets/domain.tld.ini \\\n --dns-freedns-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\nDocker\n~~~~~~\n\nIn order to create a docker container with a certbot-dns-freedns\ninstallation, create an empty directory with the following\n``Dockerfile``:\n\n.. code:: docker\n\n FROM certbot/certbot\n RUN pip install certbot-dns-freedns\n\nProceed to build the image:\n\n.. code:: bash\n\n docker build -t certbot/dns-freedns .\n\nOnce that\u2019s finished, the application can be run as follows:\n\n.. code:: bash\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-freedns certonly \\\n --authenticator dns-freedns \\\n --dns-freedns-propagation-seconds 900 \\\n --dns-freedns-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:\n\n.. code:: bash\n\n chown root:root /etc/letsencrypt/.secrets\n chmod 600 /etc/letsencrypt/.secrets\n",
"bugtrack_url": null,
"license": "Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "FreeDNS Authenticator plugin for Certbot",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/schleuss/certbot_dns_freedns"
},
"split_keywords": [
"freedns",
" certbot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "280a94bc2724f758d440535184393ad2285ab0830058a46e7327ffe2218eb521",
"md5": "a2aa3b567719bd13b971b4c54d95c4d1",
"sha256": "e167de1f8a82a68ad27150f4fb173e176506ef48300ba918a18933c6d9642c6a"
},
"downloads": -1,
"filename": "certbot_dns_freedns-0.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "a2aa3b567719bd13b971b4c54d95c4d1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.0",
"size": 8777,
"upload_time": "2024-04-24T23:45:04",
"upload_time_iso_8601": "2024-04-24T23:45:04.508254Z",
"url": "https://files.pythonhosted.org/packages/28/0a/94bc2724f758d440535184393ad2285ab0830058a46e7327ffe2218eb521/certbot_dns_freedns-0.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "733f33c60281778cd810ce35dfb1b0e3421a34b6dc01facbeea218cc8b58cb12",
"md5": "ac646e2ffba346b7cd27ddb4486d6096",
"sha256": "895d3b0181d69bc214ee4be95c7bf0e194a6d1185731527fcc4bc478ce42cbb7"
},
"downloads": -1,
"filename": "certbot_dns_freedns-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "ac646e2ffba346b7cd27ddb4486d6096",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0",
"size": 8643,
"upload_time": "2024-04-24T23:45:06",
"upload_time_iso_8601": "2024-04-24T23:45:06.656947Z",
"url": "https://files.pythonhosted.org/packages/73/3f/33c60281778cd810ce35dfb1b0e3421a34b6dc01facbeea218cc8b58cb12/certbot_dns_freedns-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 23:45:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "schleuss",
"github_project": "certbot-dns-freedns",
"github_not_found": true,
"lcname": "certbot-dns-freedns"
}
