certbot-dns-netangels 0.0.4
netangels DNS Authenticator plugin for Certbot
License: Apache License 2.0

certbot-dns-netangels
=====================

Netangels_ 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 Netangels Remote API.

Configuration of Netangels
--------------------------

In the `System -> Remote Users` you have to have a user, with the following rights:

- Client Functions
- DNS zone functions
- DNS txt functions

.. _Netangels: https://www.netangels.ru/
.. _certbot: https://certbot.eff.org/

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

.. code-block:: bash

    pip install certbot-dns-netangels

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

To start using DNS authentication for netangels, pass the following arguments on
certbot's command line:

.. list-table::
   :header-rows: 1

   * - Argument
     - Description
   * - ``--authenticator dns-netangels``
     - select the authenticator plugin (Required)
   * - ``--dns-netangels-credentials``
     - netangels Remote User credentials INI file. (Required)
   * - ``--dns-netangels-propagation-seconds``
     - waiting time for DNS to propagate before asking the ACME server to verify the DNS record. (Default: 120, Recommended: >= 600)

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

An example ``credentials.ini`` file:

.. code-block:: ini

    dns_netangels_panelurl = https://panel.netangels.ru/api/gateway/token/
    dns_netangels_apiurl = https://api-ms.netangels.ru/api/v1
    dns_netangels_apikey = verysecureremoteuserpassword


The path to this file can be provided interactively or using the
``--dns-netangels-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 netangels 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-netangels \
    --dns-netangels-credentials /etc/letsencrypt/.secrets/domain.tld.ini \
    --dns-netangels-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-netangels installation,
create an empty directory with the following ``Dockerfile``:

.. code-block:: docker

    FROM certbot/certbot
    RUN pip install certbot-dns-netangels

Proceed to build the image::

    docker build -t certbot/dns-netangels .

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-netangels certonly \
       --authenticator dns-netangels \
       --dns-netangels-propagation-seconds 900 \
       --dns-netangels-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

chown root:root /etc/letsencrypt/.secrets
chmod 600 /etc/letsencrypt/.secrets