Metadata-Version: 2.4
Name: certbot-dns-arsys
Version: 0.1.2
Summary: Arsys DNS Authenticator plugin for Certbot
Author-email: Javier Vázquez <javier.vazquez.romera@gmail.com>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship made available under
              the License, as indicated by a copyright notice that is included in
              or attached to the work (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other transformations
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean, as submitted to the Licensor for inclusion
              in the Work by the copyright owner or by an individual or Legal Entity
              authorized to submit on behalf of the copyright owner. For the purposes
              of this definition, "submitted" means any form of electronic, verbal,
              or written communication sent to the Licensor or its representatives,
              including but not limited to communication on electronic mailing lists,
              source code control systems, and issue tracking systems that are managed
              by, or on behalf of, the Licensor for the purpose of discussing and
              improving the Work, but excluding communication that is conspicuously
              marked or designated in writing by the copyright owner as "Not a
              Contribution."
        
              "Contributor" shall mean Licensor and any Legal Entity on behalf of
              whom a Contribution has been received by the Licensor and included
              within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by the combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a cross-claim
              or counterclaim in a lawsuit) alleging that the Work or any
              Contribution embodied within the Work constitutes direct or contributory
              patent infringement, then any patent licenses granted to You under
              this License for that Work shall terminate as of the date such
              litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or Derivative
                  Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, You must include a readable copy of the
                  attribution notices contained within such NOTICE file, in
                  at least one of the following places: within a NOTICE text
                  file distributed as part of the Derivative Works; within
                  the Source form or documentation, if provided along with the
                  Derivative Works; or, within a display generated by the
                  Derivative Works, if and wherever such third-party notices
                  normally appear. The contents of the NOTICE file are for
                  informational purposes only and do not modify the License.
                  You may add Your own attribution notices within Derivative
                  Works that You distribute, alongside or in addition to the
                  NOTICE text from the Work, provided that such additional
                  attribution notices cannot be construed as modifying the License.
        
              You may add Your own license statement for Your modifications and
              may provide additional grant of rights to use, copy, modify, merge,
              publish, distribute, sublicense, and/or sell copies of the
              Contribution, either on an exclusive or nonexclusive basis.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or reproducing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or exemplary damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or all other
              commercial damages or losses), even if such Contributor has been
              advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may offer only
              conditions consistent with this License, for which You may charge
              a reasonable fee for those services. In accepting such obligations,
              You may offer only conditions consistent with this License.
        
           END OF TERMS AND CONDITIONS
        
           Copyright 2024 Javier Vázquez
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://github.com/javiervazquez/certbot-dns-arsys
Project-URL: Repository, https://github.com/javiervazquez/certbot-dns-arsys
Project-URL: Bug Tracker, https://github.com/javiervazquez/certbot-dns-arsys/issues
Keywords: certbot,letsencrypt,dns,arsys,acme
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 :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: Name Service (DNS)
Classifier: Topic :: Security
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: certbot>=2.0.0
Requires-Dist: acme>=2.0.0
Requires-Dist: dnspython>=2.0.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: mypy>=1.0; extra == "dev"
Requires-Dist: pyyaml>=6.0; extra == "dev"
Dynamic: license-file

certbot-dns-arsys
=================

.. image:: https://img.shields.io/pypi/v/certbot-dns-arsys
   :target: https://pypi.org/project/certbot-dns-arsys/
   :alt: PyPI version

.. image:: https://img.shields.io/pypi/l/certbot-dns-arsys
   :target: https://github.com/spanishkangaroo/certbot-dns-arsys/blob/main/LICENSE
   :alt: License: Apache 2.0

.. image:: https://img.shields.io/pypi/pyversions/certbot-dns-arsys
   :target: https://pypi.org/project/certbot-dns-arsys/
   :alt: Supported Python versions

.. image:: https://github.com/spanishkangaroo/certbot-dns-arsys/actions/workflows/test.yml/badge.svg
   :target: https://github.com/spanishkangaroo/certbot-dns-arsys/actions/workflows/test.yml
   :alt: CI test status

`Certbot <https://certbot.eff.org/>`_ DNS authenticator plugin for `Arsys <https://www.arsys.es/>`_ domains.

Automates DNS-01 challenge validation by creating and removing ``_acme-challenge`` TXT records via
the Arsys Hosting SOAP API, enabling wildcard certificate issuance and fully automated renewal.

.. contents:: Table of Contents
   :local:
   :depth: 1


Prerequisites
-------------

- Python 3.10+
- Certbot 2.0+
- An Arsys account with API access enabled (obtain your API key from the Arsys control panel)
- Network access to ``api.servidoresdns.net`` on port **54321**


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

.. code-block:: bash

   pip install certbot-dns-arsys

Verify the plugin is available::

   certbot plugins

You should see ``dns-arsys`` in the list.


Snap
----

If you installed Certbot as a snap, a pip-installed plugin is **not** visible to it.
Install this plugin from the Snap Store instead:

.. code-block:: bash

   snap install certbot-dns-arsys
   snap connect certbot:plugin certbot-dns-arsys
   snap connect certbot-dns-arsys:certbot-metadata certbot:certbot-metadata

Then confirm the plugin is registered::

   certbot plugins

You should see ``dns-arsys`` in the list. The ``certbot-dns-arsys:certbot-metadata``
interface auto-connects; the ``certbot:plugin`` connection requires the explicit
``snap connect`` above.


Credentials File
----------------

Create a credentials file (e.g. ``~/.secrets/certbot/arsys.ini``) with the following content:

.. code-block:: ini

   # Arsys API endpoint (optional — this is the default)
   dns_arsys_api_url = https://api.servidoresdns.net:54321/hosting/api/soap/index.php

   # Your domain (as registered in your Arsys account)
   dns_arsys_api_login = example.com

   # API key from the Arsys control panel
   dns_arsys_api_key = YOUR_API_KEY_HERE

   # The base domain managed in this Arsys account
   dns_arsys_domain = example.com

Secure the file so only root can read it::

   chmod 600 ~/.secrets/certbot/arsys.ini


Usage
-----

**Wildcard certificate:**

.. code-block:: bash

   certbot certonly \
     --authenticator dns-arsys \
     --dns-arsys-credentials ~/.secrets/certbot/arsys.ini \
     -d "*.example.com" \
     -d "example.com"

**Standard certificate:**

.. code-block:: bash

   certbot certonly \
     --authenticator dns-arsys \
     --dns-arsys-credentials ~/.secrets/certbot/arsys.ini \
     -d "example.com" \
     -d "www.example.com"

**Renewal** (automatic, no extra flags needed after initial issuance)::

   certbot renew

**Non-root usage:**

Certbot requires write access to ``/var/log/letsencrypt``, ``/etc/letsencrypt``, and
``/var/lib/letsencrypt`` by default, which are root-owned. If you run certbot as a
regular user (e.g. for testing), redirect those paths with three extra flags:

.. code-block:: bash

   certbot certonly \
     --authenticator dns-arsys \
     --dns-arsys-credentials ~/.secrets/certbot/arsys.ini \
     -d "*.example.com" \
     -d "example.com" \
     --config-dir ~/.letsencrypt \
     --work-dir ~/.letsencrypt/work \
     --logs-dir ~/.letsencrypt/logs

Certificates will be written to ``~/.letsencrypt/live/example.com/``.


Options
-------

``--dns-arsys-credentials``
   Path to the INI credentials file. **Required.**

``--dns-arsys-propagation-seconds``
   Maximum seconds to wait for DNS propagation before proceeding. Default: ``30``.
   The plugin polls authoritative nameservers every 15 seconds and proceeds as soon as
   the record is confirmed. Increase this value if you see validation failures.


Docker
------

A Docker image based on ``certbot/certbot`` with the plugin pre-installed is available:

.. code-block:: bash

   docker run --rm \
     -v ~/.secrets/certbot:/secrets:ro \
     -v /etc/letsencrypt:/etc/letsencrypt \
     ghcr.io/javiervazquez/certbot-dns-arsys:latest \
     certonly \
       --authenticator dns-arsys \
       --dns-arsys-credentials /secrets/arsys.ini \
       -d "*.example.com"

Or build locally::

   docker build -t certbot-dns-arsys .
   docker run --rm certbot-dns-arsys plugins


Troubleshooting
---------------

**``dns-arsys`` is not listed by ``certbot plugins``**
   The plugin is not installed in the same environment as certbot. Confirm both are
   in the same interpreter::

      pip show certbot-dns-arsys
      certbot plugins

   If you installed certbot via snap, install the plugin into the snap instead of pip;
   a pip-installed plugin is not visible to a snap-installed certbot.

**Authentication errors (HTTP 401/403 or "invalid credentials")**
   Re-check the credentials file. ``dns_arsys_api_login`` must be your Arsys account
   domain and ``dns_arsys_api_key`` the key from the Arsys control panel. Make sure the
   API key has not been revoked and that ``dns_arsys_domain`` matches the zone you are
   issuing for.

**Connection timeouts / "connection refused" to the API**
   The Arsys Hosting API runs on the **non-standard port 54321**. Verify outbound
   connectivity from the host running certbot::

      nc -vz api.servidoresdns.net 54321

   If this fails, open outbound TCP to ``api.servidoresdns.net:54321`` in your firewall.

**Validation fails with "incorrect TXT record" or a propagation timeout**
   The challenge record had not propagated before certbot asked Let's Encrypt to validate.
   Increase the wait with ``--dns-arsys-propagation-seconds`` (default ``30``)::

      certbot certonly --authenticator dns-arsys \
        --dns-arsys-credentials ~/.secrets/certbot/arsys.ini \
        --dns-arsys-propagation-seconds 120 \
        -d "*.example.com"

   You can confirm propagation manually with::

      dig +short TXT _acme-challenge.example.com

**Permission errors reading the credentials file**
   Certbot warns if the credentials file is group/world-readable, and refuses to run if it
   cannot read it. Ensure the file is owned by the user running certbot and is mode ``600``::

      chmod 600 ~/.secrets/certbot/arsys.ini


Notes
-----

- The Arsys Hosting API endpoint runs on a non-standard port (54321). Ensure your firewall
  allows outbound TCP connections to ``api.servidoresdns.net:54321``.
- DNS propagation timing depends on Arsys infrastructure. The Arsys SOAP API applies
  changes almost immediately, so the default 30-second timeout is generally sufficient.
  Increase with ``--dns-arsys-propagation-seconds`` if you see validation failures.
- The plugin is a **third-party plugin** not affiliated with Certbot or the EFF.


License
-------

Licensed under the `Apache License 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.

Copyright 2026 Javier Vázquez.
