certbot-dns-clouddns 1.0.0.post2
CloudDNS Authenticator plugin for Certbot
License: Apache-2.0
Requires Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*

certbot-dns-clouddns
====================

The `~certbot_dns_clouddns.dns_clouddns` plugin automates the process of
completing a ``dns-01`` challenge (`~acme.challenges.DNS01`) by creating, and
subsequently removing, TXT records using the CloudDNS_ REST API.

.. _CloudDNS: https://github.com/vshosting/clouddns


Named Arguments
---------------

===========================================================  =====================================
``--authenticator certbot-dns-clouddns:dns-clouddns``        Select the plugin. (Required)
``--certbot-dns-clouddns:dns-clouddns-credentials``          CloudDNS Remote API credentials_
                                                             INI file. (Required)
``--certbot-dns-clouddns:dns-clouddns-propagation-seconds``  The number of seconds to wait for DNS
                                                             to propagate before asking the ACME
                                                             server to verify the DNS record.
                                                             (Default: 60)
===========================================================  =====================================


Installation
------------

``certbot-dns-clouddns`` requires Python 2.7 or 3.5+ to run.

.. code:: bash

   pip3 install certbot-dns-clouddns


Credentials
-----------

Use of this plugin requires a configuration file containing CloudDNS Remote API
. You can find out the clientId by running the following command:

.. code:: bash

   curl --silent --request POST https://admin.vshosting.cloud/api/public/auth/login \
   --data '{"email":"<email>","password":"<password>"}' \
   --header "Content-Type: application/json" \
     | grep --perl-rexexp --only-matching '"clientId": \K"[^"]"' \
     | head -n 1 \
     | tr -d '"'

Example credentials file:

.. code:: ini

   # CloudDNS API credentials used by Certbot
   certbot_dns_clouddns:dns_clouddns_clientId = myclientid
   certbot_dns_clouddns:dns_clouddns_email = myemailaddress
   certbot_dns_clouddns:dns_clouddns_password = mysecretpassword

The path to this file can be provided interactively or using the
``--certbot-dns-clouddns:dns-clouddns-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 a password. Users who
   can read this file can use these to issue arbitrary CloudDNS 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 certificate for ``example.com``

.. code:: bash

   certbot certonly \
     --authenticator certbot-dns-clouddns:dns-clouddns \
     --certbot-dns-clouddns:dns-clouddns-credentials ~/.secrets/certbot/clouddns.ini \
     -d example.com

To acquire a single certificate for both ``example.com`` and ``*.example.com``

.. code:: bash

   certbot certonly \
     --authenticator certbot-dns-clouddns:dns-clouddns \
     --certbot-dns-clouddns:dns-clouddns-credentials ~/.secrets/certbot/clouddns.ini \
     -d example.com \
     -d '*.example.com'

To acquire a certificate for ``example.com``, waiting 240 seconds for DNS propagation

.. code:: bash

   certbot certonly \
     --authenticator certbot-dns-clouddns:dns-clouddns \
     --certbot-dns-clouddns:dns-clouddns-credentials ~/.secrets/certbot/clouddns.ini \
     --certbot-dns-clouddns:dns-clouddns-propagation-seconds 240 \
     -d example.com