Metadata-Version: 2.1
Name: certbot-dns-netcup
Version: 0.31.0.1
Summary: netcup DNS Authenticator plugin for Certbot
Home-page: https://github.com/coldfix/certbot-dns-netcup
Author: Thomas Gläßle
Author-email: thomas@coldfix.de
License: Apache License 2.0
Description: certbot-dns-netcup
        ==================
        
        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_.
        
        .. _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
        ------------
        
        ::
        
            pip install certbot-dns-netcup
        
        
        Named Arguments
        ---------------
        
        To start using DNS authentication for netcup, pass the following arguments on
        certbot's command line:
        
        - ``--authenticator=certbot-dns-netcup:dns-netcup``: select the authenticator
          plugin (Required)
        
        - ``--certbot-dns-netcup:dns-netcup-credentials=<FILE>``: netcup credentials_
          INI file. (Required)
        
        - ``--certbot-dns-netcup:dns-netcup-propagation-seconds=<SECONDS>``: waiting
          time for DNS to propagate before asking the ACME server to verify the DNS
          record. (Default: 10, Recommended: >= 900)
        
        You may need to set an even higher 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.
        
        (Note that the verbose and seemingly redundant ``certbot-dns-netcup:`` prefix
        is currently imposed by certbot for external plugins.)
        
        
        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
        
           certbot_dns_netcup:dns_netcup_customer_id  = 123456
           certbot_dns_netcup:dns_netcup_api_key      = 0123456789abcdef0123456789abcdef01234567
           certbot_dns_netcup:dns_netcup_api_password = abcdef0123456789abcdef01234567abcdef0123
        
        The path to this file can be provided interactively or using the
        ``--certbot-dns-netcup: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).
        
        
        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 certbot-dns-netcup:dns-netcup \\
             --certbot-dns-netcup:dns-netcup-credentials ~/.secrets/certbot/netcup.ini \\
             --certbot-dns-netcup:dns-netcup-propagation-seconds 900 \\
             --server https://acme-v02.api.letsencrypt.org/directory \
             -d 'example.com' \\
             -d '*.example.com'
        
        
        Docker
        ------
        
        In order to create a docker container with a certbot-dns-netcup installation,
        create an empty directory with the following ``Dockerfile``:
        
        .. code-block:: docker
        
            FROM certbot/certbot
            RUN pip install certbot-dns-netcup
        
        Proceed to build the image::
        
            docker build -t 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 \
               certbot/dns-netcup certonly \
               --authenticator certbot-dns-netcup:dns-netcup \
               --certbot-dns-netcup:dns-netcup-propagation-seconds 900 \
               --certbot-dns-netcup:dns-netcup-credentials \
                   /var/lib/letsencrypt/netcup_credentials.ini \
               --no-self-upgrade \
               --keep-until-expiring --non-interactive --expand \
               --server https://acme-v02.api.letsencrypt.org/directory \
               -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.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Plugins
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Security
Classifier: Topic :: System :: Installation/Setup
Classifier: Topic :: System :: Networking
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
Description-Content-Type: text/x-rst
