certbot-dns-poweradmin 0.1.1__py3-none-any.whl

certbot_dns_poweradmin/__init__.py

@@ -0,0 +1,103 @@
+"""
+The `~certbot_dns_poweradmin._internal.dns_poweradmin` plugin automates the process of
+completing a ``dns-01`` challenge (`~acme.challenges.DNS01`) by creating, and
+subsequently removing, TXT records using the PowerAdmin API.
+
+
+Named Arguments
+---------------
+
+==========================================  ===================================
+``--dns-poweradmin-credentials``            PowerAdmin credentials INI file.
+                                            (Required)
+``--dns-poweradmin-propagation-seconds``    The number of seconds to wait for
+                                            DNS to propagate before asking the
+                                            ACME server to verify the DNS
+                                            record.
+                                            (Default: 120)
+==========================================  ===================================
+
+
+Credentials
+-----------
+
+Use of this plugin requires a configuration file containing PowerAdmin API
+credentials, obtained from your PowerAdmin installation.
+
+.. code-block:: ini
+   :name: credentials.ini
+   :caption: Example credentials file:
+
+   # PowerAdmin API credentials
+   dns_poweradmin_api_url = https://poweradmin.example.com
+   dns_poweradmin_api_key = your-api-key-here
+   dns_poweradmin_api_version = v2
+
+The path to this file can be provided interactively or using the
+``--dns-poweradmin-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
+   PowerAdmin 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 this server isn't managing those domains.
+
+Certbot will emit a warning if it detects that the credential file can be
+accessed by other users on your system. The warning reads "Unsafe permissions
+on credential configuration file", followed by the path to the credential
+file. This warning will be emitted each time Certbot uses the credential 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).
+
+
+API Version
+-----------
+
+PowerAdmin supports two API versions:
+
+- ``v1``: Stable API version
+- ``v2``: Enhanced API with additional features (default)
+
+You can specify the API version in your credential file using the
+``dns_poweradmin_api_version`` option. If not specified, ``v2`` is used by default.
+
+
+Examples
+--------
+
+.. code-block:: bash
+   :caption: To acquire a certificate for ``example.com``
+
+   certbot certonly \\
+     --authenticator dns-poweradmin \\
+     --dns-poweradmin-credentials ~/.secrets/certbot/poweradmin.ini \\
+     -d example.com
+
+.. code-block:: bash
+   :caption: To acquire a single certificate for both ``example.com`` and
+             ``www.example.com``
+
+   certbot certonly \\
+     --authenticator dns-poweradmin \\
+     --dns-poweradmin-credentials ~/.secrets/certbot/poweradmin.ini \\
+     -d example.com \\
+     -d www.example.com
+
+.. code-block:: bash
+   :caption: To acquire a certificate for ``example.com``, waiting 300 seconds
+             for DNS propagation
+
+   certbot certonly \\
+     --authenticator dns-poweradmin \\
+     --dns-poweradmin-credentials ~/.secrets/certbot/poweradmin.ini \\
+     --dns-poweradmin-propagation-seconds 300 \\
+     -d example.com
+
+"""
+
+from certbot_dns_poweradmin._internal.dns_poweradmin import Authenticator
+
+__all__ = ["Authenticator"]

certbot_dns_poweradmin/_internal/__init__.py

@@ -0,0 +1 @@
+"""Internal implementation of certbot-dns-poweradmin plugin."""

certbot_dns_poweradmin/_internal/dns_poweradmin.py

@@ -0,0 +1,315 @@
+"""DNS Authenticator for PowerAdmin."""
+
+from __future__ import annotations
+
+import logging
+from collections.abc import Callable
+from typing import Any
+
+import requests
+from certbot import errors
+from certbot.plugins import dns_common
+from certbot.plugins.dns_common import CredentialsConfiguration
+
+logger = logging.getLogger(__name__)
+
+DEFAULT_API_VERSION = "v2"
+SUPPORTED_API_VERSIONS = ("v1", "v2")
+
+
+class Authenticator(dns_common.DNSAuthenticator):
+    """DNS Authenticator for PowerAdmin.
+
+    This Authenticator uses the PowerAdmin API to fulfill a dns-01 challenge.
+    """
+
+    description = (
+        "Obtain certificates using a DNS TXT record (if you are using PowerAdmin for DNS)."
+    )
+    ttl = 120
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.credentials: CredentialsConfiguration | None = None
+
+    @classmethod
+    def add_parser_arguments(
+        cls, add: Callable[..., None], default_propagation_seconds: int = 120
+    ) -> None:
+        super().add_parser_arguments(add, default_propagation_seconds)
+        add("credentials", help="PowerAdmin credentials INI file.")
+
+    def more_info(self) -> str:
+        return (
+            "This plugin configures a DNS TXT record to respond to a dns-01 challenge "
+            "using the PowerAdmin API."
+        )
+
+    def _setup_credentials(self) -> None:
+        self.credentials = self._configure_credentials(
+            "credentials",
+            "PowerAdmin credentials INI file",
+            None,
+            self._validate_credentials,
+        )
+
+    def _validate_credentials(self, credentials: CredentialsConfiguration) -> None:
+        api_url = credentials.conf("api-url")
+        api_key = credentials.conf("api-key")
+        api_version = credentials.conf("api-version")
+
+        if not api_url:
+            raise errors.PluginError("PowerAdmin API URL is required (dns_poweradmin_api_url)")
+        if not api_key:
+            raise errors.PluginError("PowerAdmin API key is required (dns_poweradmin_api_key)")
+        if api_version and api_version not in SUPPORTED_API_VERSIONS:
+            raise errors.PluginError(
+                f"Invalid API version: {api_version}. "
+                f"Supported versions: {', '.join(SUPPORTED_API_VERSIONS)}"
+            )
+
+    def _perform(self, domain: str, validation_name: str, validation: str) -> None:
+        self._get_poweradmin_client().add_txt_record(domain, validation_name, validation, self.ttl)
+
+    def _cleanup(self, domain: str, validation_name: str, validation: str) -> None:
+        self._get_poweradmin_client().del_txt_record(domain, validation_name, validation)
+
+    def _get_poweradmin_client(self) -> _PowerAdminClient:
+        if self.credentials is None:
+            raise errors.PluginError("Credentials not configured")
+
+        api_url = self.credentials.conf("api-url")
+        api_key = self.credentials.conf("api-key")
+        api_version = self.credentials.conf("api-version") or DEFAULT_API_VERSION
+
+        # These are validated in _validate_credentials, so they should never be None
+        assert api_url is not None
+        assert api_key is not None
+
+        return _PowerAdminClient(
+            api_url=api_url,
+            api_key=api_key,
+            api_version=api_version,
+        )
+
+
+class _PowerAdminClient:
+    """Encapsulates all communication with the PowerAdmin API."""
+
+    def __init__(self, api_url: str, api_key: str, api_version: str = "v2") -> None:
+        self.api_url = api_url.rstrip("/")
+        self.api_key = api_key
+        self.api_version = api_version
+        self.session = requests.Session()
+        self.session.headers.update(
+            {
+                "X-API-Key": self.api_key,
+                "Content-Type": "application/json",
+                "Accept": "application/json",
+            }
+        )
+
+    def add_txt_record(
+        self, domain: str, record_name: str, record_content: str, record_ttl: int
+    ) -> None:
+        """Add a TXT record using the PowerAdmin API.
+
+        Args:
+            domain: The domain to use for finding the zone.
+            record_name: The record name (FQDN, e.g., _acme-challenge.example.com).
+            record_content: The record content (validation token).
+            record_ttl: The record TTL in seconds.
+        """
+        zone_id, _zone_name = self._find_zone_id(domain)
+        if zone_id is None:
+            raise errors.PluginError(f"Unable to find a PowerAdmin zone for {domain}")
+
+        # Check if a record already exists (idempotent)
+        existing_record = self._find_txt_record(zone_id, record_name, record_content)
+        if existing_record is not None:
+            logger.debug("TXT record already exists, skipping creation")
+            return
+
+        # Create the TXT record
+        record_data = {
+            "name": record_name,
+            "type": "TXT",
+            "content": record_content,
+            "ttl": record_ttl,
+        }
+
+        url = f"{self.api_url}/api/{self.api_version}/zones/{zone_id}/records"
+        try:
+            response = self.session.post(url, json=record_data)
+            response.raise_for_status()
+            logger.debug("Successfully added TXT record for %s", record_name)
+        except requests.exceptions.HTTPError as e:
+            hint = self._get_error_hint(e.response)
+            raise errors.PluginError(f"Error adding TXT record: {e}{hint}") from e
+        except requests.exceptions.RequestException as e:
+            raise errors.PluginError(f"Error communicating with PowerAdmin API: {e}") from e
+
+    def del_txt_record(self, domain: str, record_name: str, record_content: str) -> None:
+        """Delete a TXT record using the PowerAdmin API.
+
+        Args:
+            domain: The domain to use for finding the zone.
+            record_name: The record name (FQDN).
+            record_content: The record content (validation token).
+        """
+        try:
+            zone_id, _zone_name = self._find_zone_id(domain)
+            if zone_id is None:
+                logger.debug("Unable to find zone for %s during cleanup", domain)
+                return
+
+            record = self._find_txt_record(zone_id, record_name, record_content)
+            if record is None:
+                logger.debug("TXT record not found for %s during cleanup", record_name)
+                return
+
+            record_id = record.get("id")
+            if record_id is None:
+                logger.warning("Record found but has no ID, cannot delete")
+                return
+
+            url = f"{self.api_url}/api/{self.api_version}/zones/{zone_id}/records/{record_id}"
+            response = self.session.delete(url)
+            response.raise_for_status()
+            logger.debug("Successfully deleted TXT record for %s", record_name)
+
+        except requests.exceptions.RequestException as e:
+            logger.warning("Error deleting TXT record during cleanup: %s", e)
+
+    def _find_zone_id(self, domain: str) -> tuple[int | None, str | None]:
+        """Find the zone ID for a given domain.
+
+        Args:
+            domain: The domain being validated.
+
+        Returns:
+            Tuple of (zone_id, zone_name) or (None, None) if not found.
+        """
+        zone_name_guesses = dns_common.base_domain_name_guesses(domain)
+
+        for zone_name in zone_name_guesses:
+            logger.debug("Looking for zone: %s", zone_name)
+            zone_id = self._get_zone_id_by_name(zone_name)
+            if zone_id is not None:
+                logger.debug("Found zone %s with ID %s", zone_name, zone_id)
+                return zone_id, zone_name
+
+        return None, None
+
+    def _get_zone_id_by_name(self, zone_name: str) -> int | None:
+        """Get zone ID by zone name from PowerAdmin API.
+
+        Args:
+            zone_name: The zone name to look up.
+
+        Returns:
+            The zone ID if found, None otherwise.
+        """
+        url = f"{self.api_url}/api/{self.api_version}/zones"
+        try:
+            response = self.session.get(url)
+            response.raise_for_status()
+            zones = response.json()
+
+            # Handle various response formats from PowerAdmin API
+            if isinstance(zones, dict) and "data" in zones:
+                zones = zones["data"]
+                # API v2 returns {"data": {"zones": [...]}}
+                if isinstance(zones, dict) and "zones" in zones:
+                    zones = zones["zones"]
+
+            for zone in zones:
+                # Zone name might be stored with or without a trailing dot
+                zone_stored_name = zone.get("name", "").rstrip(".")
+                if zone_stored_name == zone_name or zone_stored_name == zone_name.rstrip("."):
+                    zone_id: int | None = zone.get("id")
+                    return zone_id
+
+            return None
+
+        except requests.exceptions.RequestException as e:
+            logger.debug("Error fetching zones: %s", e)
+            return None
+
+    def _find_txt_record(
+        self, zone_id: int, record_name: str, record_content: str
+    ) -> dict[str, Any] | None:
+        """Find a specific TXT record in a zone.
+
+        Args:
+            zone_id: The zone ID to search in.
+            record_name: The record name to find.
+            record_content: The record content to match.
+
+        Returns:
+            The record dict if found, None otherwise.
+        """
+        url = f"{self.api_url}/api/{self.api_version}/zones/{zone_id}/records"
+        try:
+            response = self.session.get(url)
+            response.raise_for_status()
+            records = response.json()
+
+            # Handle both list and dict response formats
+            if isinstance(records, dict) and "data" in records:
+                records = records["data"]
+
+            for record in records:
+                if record.get("type") != "TXT":
+                    continue
+
+                # Compare record name (with or without a trailing dot)
+                stored_name = record.get("name", "").rstrip(".")
+                target_name = record_name.rstrip(".")
+                if stored_name != target_name:
+                    continue
+
+                # Compare content (may be quoted in API response)
+                stored_content = record.get("content", "").strip('"')
+                if stored_content == record_content:
+                    result: dict[str, Any] = record
+                    return result
+
+            return None
+
+        except requests.exceptions.RequestException as e:
+            logger.debug("Error fetching records: %s", e)
+            return None
+
+    @staticmethod
+    def _get_error_hint(response: requests.Response | None) -> str:
+        """Extract error hint from API response.
+
+        Args:
+            response: The HTTP response object.
+
+        Returns:
+            A hint string for the error, or empty string.
+        """
+        if response is None:
+            return ""
+
+        hint = ""
+        try:
+            error_data = response.json()
+            if isinstance(error_data, dict):
+                message = error_data.get("message") or error_data.get("error")
+                if message:
+                    hint = f" ({message})"
+        except (ValueError, KeyError):
+            pass
+
+        # Add specific hints based on the status code
+        if response.status_code == 401:
+            hint = hint or " (Is your API key correct?)"
+        elif response.status_code == 403:
+            hint = hint or " (Does your API key have sufficient permissions?)"
+        elif response.status_code == 404:
+            hint = hint or " (Zone or record not found)"
+
+        return hint

certbot_dns_poweradmin/_internal/tests/__init__.py

@@ -0,0 +1 @@
+"""Tests for certbot-dns-poweradmin plugin."""

certbot_dns_poweradmin/_internal/tests/dns_poweradmin_test.py

@@ -0,0 +1,283 @@
+"""Tests for certbot_dns_poweradmin._internal.dns_poweradmin."""
+
+from __future__ import annotations
+
+import unittest
+from unittest import mock
+
+import requests_mock
+from certbot import errors
+from certbot.compat import os
+from certbot.plugins import dns_test_common
+from certbot.plugins.dns_test_common import DOMAIN
+from certbot.tests import util as test_util
+
+from certbot_dns_poweradmin import Authenticator
+from certbot_dns_poweradmin._internal.dns_poweradmin import _PowerAdminClient
+
+API_URL = "https://poweradmin.example.com"
+API_KEY = "test-api-key"
+API_VERSION = "v2"
+
+
+class AuthenticatorTest(test_util.TempDirTestCase, dns_test_common.BaseAuthenticatorTest):
+    """Tests for Authenticator class."""
+
+    def setUp(self) -> None:
+        super().setUp()
+
+        path = os.path.join(self.tempdir, "credentials.ini")
+        dns_test_common.write(
+            {
+                "poweradmin_api_url": API_URL,
+                "poweradmin_api_key": API_KEY,
+                "poweradmin_api_version": API_VERSION,
+            },
+            path,
+        )
+
+        self.config = mock.MagicMock(
+            poweradmin_credentials=path,
+            poweradmin_propagation_seconds=0,
+        )
+        self.auth = Authenticator(self.config, "poweradmin")
+
+        self.mock_client = mock.MagicMock()
+        self.auth._get_poweradmin_client = mock.MagicMock(return_value=self.mock_client)
+
+    @test_util.patch_display_util()
+    def test_perform(self, _: mock.MagicMock) -> None:
+        self.auth.perform([self.achall])
+        expected = [
+            mock.call.add_txt_record(DOMAIN, "_acme-challenge." + DOMAIN, mock.ANY, mock.ANY)
+        ]
+        self.assertEqual(expected, self.mock_client.mock_calls)
+
+    @test_util.patch_display_util()
+    def test_cleanup(self, _: mock.MagicMock) -> None:
+        self.auth._attempt_cleanup = True
+        self.auth.cleanup([self.achall])
+        expected = [mock.call.del_txt_record(DOMAIN, "_acme-challenge." + DOMAIN, mock.ANY)]
+        self.assertEqual(expected, self.mock_client.mock_calls)
+
+
+class PowerAdminClientTest(unittest.TestCase):
+    """Tests for _PowerAdminClient class."""
+
+    record_name = "_acme-challenge.example.com"
+    record_content = "validation-token"
+    record_ttl = 120
+
+    def setUp(self) -> None:
+        self.adapter = requests_mock.Adapter()
+        self.client = _PowerAdminClient(API_URL, API_KEY, API_VERSION)
+        self.client.session.mount("https://", self.adapter)
+
+    def _register_zones_response(
+        self, zones: list[dict] | None = None, api_v2_format: bool = False
+    ) -> None:
+        """Register a mock response for zones endpoint.
+
+        Args:
+            zones: List of zone dicts.
+            api_v2_format: If True, wrap in {"data": {"zones": [...]}},
+                           otherwise use {"data": [...]}.
+        """
+        if zones is None:
+            zones = [{"id": 1, "name": "example.com"}]
+
+        data: dict[str, list[dict[str, str | int]]] | list[dict[str, str | int]] = (
+            {"zones": zones} if api_v2_format else zones
+        )
+        response = {"data": data}
+
+        self.adapter.register_uri(
+            "GET",
+            f"{API_URL}/api/{API_VERSION}/zones",
+            json=response,
+        )
+
+    def _register_records_response(
+        self, zone_id: int = 1, records: list[dict] | None = None
+    ) -> None:
+        """Register a mock response for records endpoint."""
+        if records is None:
+            records = []
+        self.adapter.register_uri(
+            "GET",
+            f"{API_URL}/api/{API_VERSION}/zones/{zone_id}/records",
+            json={"data": records},
+        )
+
+    def _register_add_record_response(self, zone_id: int = 1, status_code: int = 201) -> None:
+        """Register a mock response for adding a record."""
+        self.adapter.register_uri(
+            "POST",
+            f"{API_URL}/api/{API_VERSION}/zones/{zone_id}/records",
+            status_code=status_code,
+            json={"id": 100, "name": self.record_name, "type": "TXT"},
+        )
+
+    def _register_delete_record_response(
+        self, zone_id: int = 1, record_id: int = 100, status_code: int = 204
+    ) -> None:
+        """Register a mock response for deleting a record."""
+        self.adapter.register_uri(
+            "DELETE",
+            f"{API_URL}/api/{API_VERSION}/zones/{zone_id}/records/{record_id}",
+            status_code=status_code,
+        )
+
+    def test_add_txt_record(self) -> None:
+        """Test adding a TXT record."""
+        self._register_zones_response()
+        self._register_records_response()
+        self._register_add_record_response()
+
+        self.client.add_txt_record(DOMAIN, self.record_name, self.record_content, self.record_ttl)
+
+        # Verify the POST request was made
+        history = self.adapter.request_history
+        post_request = [r for r in history if r.method == "POST"][0]
+        self.assertIn("TXT", post_request.text)
+
+    def test_add_txt_record_already_exists(self) -> None:
+        """Test adding a TXT record that already exists."""
+        self._register_zones_response()
+        self._register_records_response(
+            records=[
+                {
+                    "id": 50,
+                    "name": self.record_name,
+                    "type": "TXT",
+                    "content": self.record_content,
+                }
+            ]
+        )
+
+        # Should not raise, should just return (idempotent)
+        self.client.add_txt_record(DOMAIN, self.record_name, self.record_content, self.record_ttl)
+
+        # Verify no POST request was made
+        history = self.adapter.request_history
+        post_requests = [r for r in history if r.method == "POST"]
+        self.assertEqual(len(post_requests), 0)
+
+    def test_add_txt_record_zone_not_found(self) -> None:
+        """Test adding a TXT record when a zone is not found."""
+        self._register_zones_response(zones=[])
+
+        with self.assertRaises(errors.PluginError) as context:
+            self.client.add_txt_record(
+                DOMAIN, self.record_name, self.record_content, self.record_ttl
+            )
+
+        self.assertIn("Unable to find", str(context.exception))
+
+    def test_del_txt_record(self) -> None:
+        """Test deleting a TXT record."""
+        self._register_zones_response()
+        self._register_records_response(
+            records=[
+                {
+                    "id": 100,
+                    "name": self.record_name,
+                    "type": "TXT",
+                    "content": self.record_content,
+                }
+            ]
+        )
+        self._register_delete_record_response()
+
+        self.client.del_txt_record(DOMAIN, self.record_name, self.record_content)
+
+        # Verify the DELETE request was made
+        history = self.adapter.request_history
+        delete_requests = [r for r in history if r.method == "DELETE"]
+        self.assertEqual(len(delete_requests), 1)
+
+    def test_del_txt_record_not_found(self) -> None:
+        """Test deleting a TXT record that doesn't exist."""
+        self._register_zones_response()
+        self._register_records_response(records=[])
+
+        # Should not raise (graceful cleanup)
+        self.client.del_txt_record(DOMAIN, self.record_name, self.record_content)
+
+    def test_del_txt_record_zone_not_found(self) -> None:
+        """Test deleting when a zone is not found."""
+        self._register_zones_response(zones=[])
+
+        # Should not raise (graceful cleanup)
+        self.client.del_txt_record(DOMAIN, self.record_name, self.record_content)
+
+    def test_find_zone_with_trailing_dot(self) -> None:
+        """Test finding a zone when API returns name with trailing dot."""
+        self._register_zones_response(zones=[{"id": 1, "name": "example.com."}])
+        self._register_records_response()
+        self._register_add_record_response()
+
+        # Should find the zone despite trailing dot
+        self.client.add_txt_record(DOMAIN, self.record_name, self.record_content, self.record_ttl)
+
+    def test_api_error_handling(self) -> None:
+        """Test API error handling."""
+        self._register_zones_response()
+        self._register_records_response()
+        self.adapter.register_uri(
+            "POST",
+            f"{API_URL}/api/{API_VERSION}/zones/1/records",
+            status_code=401,
+            json={"message": "Invalid API key"},
+        )
+
+        with self.assertRaises(errors.PluginError) as context:
+            self.client.add_txt_record(
+                DOMAIN, self.record_name, self.record_content, self.record_ttl
+            )
+
+        self.assertIn("401", str(context.exception))
+
+    def test_headers_contain_api_key(self) -> None:
+        """Test that requests contain the API key header."""
+        self._register_zones_response()
+
+        # Trigger a request
+        self.client._get_zone_id_by_name("example.com")
+
+        # Verify headers
+        history = self.adapter.request_history
+        self.assertEqual(len(history), 1)
+        self.assertEqual(history[0].headers["X-API-Key"], API_KEY)
+
+    def test_zones_api_v2_nested_format(self) -> None:
+        """Test handling of API v2 nested zones response format."""
+        self._register_zones_response(api_v2_format=True)
+        self._register_records_response()
+        self._register_add_record_response()
+
+        # Should find the zone with nested format
+        self.client.add_txt_record(DOMAIN, self.record_name, self.record_content, self.record_ttl)
+
+        # Verify the POST request was made
+        history = self.adapter.request_history
+        post_requests = [r for r in history if r.method == "POST"]
+        self.assertEqual(len(post_requests), 1)
+
+    def test_zones_api_v1_flat_format(self) -> None:
+        """Test handling of API v1 flat zones response format."""
+        self._register_zones_response(api_v2_format=False)
+        self._register_records_response()
+        self._register_add_record_response()
+
+        # Should find the zone with flat format
+        self.client.add_txt_record(DOMAIN, self.record_name, self.record_content, self.record_ttl)
+
+        # Verify the POST request was made
+        history = self.adapter.request_history
+        post_requests = [r for r in history if r.method == "POST"]
+        self.assertEqual(len(post_requests), 1)
+
+
+if __name__ == "__main__":
+    unittest.main()

certbot_dns_poweradmin-0.1.1.dist-info/METADATA

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: certbot-dns-poweradmin
+Version: 0.1.1
+Summary: PowerAdmin DNS Authenticator plugin for Certbot
+Project-URL: Homepage, https://github.com/poweradmin/certbot-dns-poweradmin
+Project-URL: Bug Reports, https://github.com/poweradmin/certbot-dns-poweradmin/issues
+Project-URL: Source, https://github.com/poweradmin/certbot-dns-poweradmin
+Author-email: Edmondas Girkantas <edmondas@girkantas.lt>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Security
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.10
+Requires-Dist: acme>=5.1.0
+Requires-Dist: certbot>=5.1.0
+Requires-Dist: requests>=2.32.5
+Provides-Extra: dev
+Requires-Dist: mypy>=1.13.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: requests-mock>=1.11.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Requires-Dist: tox>=4.0.0; extra == 'dev'
+Requires-Dist: types-requests>=2.32.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# certbot-dns-poweradmin
+
+[![Test](https://github.com/poweradmin/certbot-dns-poweradmin/actions/workflows/test.yml/badge.svg)](https://github.com/poweradmin/certbot-dns-poweradmin/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/poweradmin/certbot-dns-poweradmin/graph/badge.svg?token=3686WTALGK)](https://codecov.io/gh/poweradmin/certbot-dns-poweradmin)
+[![PyPI](https://img.shields.io/pypi/v/certbot-dns-poweradmin)](https://pypi.org/project/certbot-dns-poweradmin/)
+[![Python](https://img.shields.io/pypi/pyversions/certbot-dns-poweradmin)](https://pypi.org/project/certbot-dns-poweradmin/)
+
+PowerAdmin 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 PowerAdmin API.
+
+## Installation
+
+```
+pip install certbot-dns-poweradmin
+```
+
+## PowerAdmin Configuration
+
+Your PowerAdmin installation needs to have the API enabled. The plugin supports both API v1 and v2.
+
+You'll need an API key with permissions to:
+- List zones
+- Create DNS records
+- Delete DNS records
+
+## Usage
+
+1. Create a credential file (e.g., `/etc/letsencrypt/poweradmin.ini`):
+
+```ini
+dns_poweradmin_api_url = https://poweradmin.example.com
+dns_poweradmin_api_key = your-api-key-here
+dns_poweradmin_api_version = v2
+```
+
+The `api_version` is optional and defaults to `v2`. Set it to `v1` if your PowerAdmin installation uses the older API.
+
+2. Secure the credential file:
+
+```
+chmod 600 /etc/letsencrypt/poweradmin.ini
+```
+
+3. Run certbot:
+
+```
+certbot certonly \
+  --authenticator dns-poweradmin \
+  --dns-poweradmin-credentials /etc/letsencrypt/poweradmin.ini \
+  -d example.com
+```
+
+## Arguments
+
+| Argument                               | Description                                        |
+|----------------------------------------|----------------------------------------------------|
+| `--dns-poweradmin-credentials`         | Path to credentials INI file (required)            |
+| `--dns-poweradmin-propagation-seconds` | Seconds to wait for DNS propagation (default: 120) |
+
+## Examples
+
+Get a certificate for a single domain:
+
+```
+certbot certonly \
+  --authenticator dns-poweradmin \
+  --dns-poweradmin-credentials /etc/letsencrypt/poweradmin.ini \
+  -d example.com
+```
+
+Get a wildcard certificate:
+
+```
+certbot certonly \
+  --authenticator dns-poweradmin \
+  --dns-poweradmin-credentials /etc/letsencrypt/poweradmin.ini \
+  -d example.com \
+  -d "*.example.com"
+```
+
+With custom propagation time:
+
+```
+certbot certonly \
+  --authenticator dns-poweradmin \
+  --dns-poweradmin-credentials /etc/letsencrypt/poweradmin.ini \
+  --dns-poweradmin-propagation-seconds 300 \
+  -d example.com
+```
+
+## Docker
+
+```dockerfile
+FROM certbot/certbot
+RUN pip install certbot-dns-poweradmin
+```
+
+Build and run:
+
+```
+docker build -t certbot/dns-poweradmin .
+
+docker run --rm \
+  -v /etc/letsencrypt:/etc/letsencrypt \
+  -v /var/lib/letsencrypt:/var/lib/letsencrypt \
+  certbot/dns-poweradmin certonly \
+  --authenticator dns-poweradmin \
+  --dns-poweradmin-credentials /etc/letsencrypt/poweradmin.ini \
+  -d example.com
+```
+
+## Troubleshooting
+
+### Plugin not found by certbot
+
+If `certbot plugins` doesn't show `dns-poweradmin`, ensure both certbot and the plugin are installed in the same Python environment:
+
+```bash
+# Check where certbot is installed
+which certbot
+
+# If using system certbot but plugin in venv, either:
+# Option 1: Install certbot in the same venv
+pip install certbot certbot-dns-poweradmin
+
+# Option 2: Use certbot from the venv
+python -m certbot plugins
+```
+
+### Virtual environment usage
+
+When using a virtual environment, install both certbot and the plugin together:
+
+```bash
+python3 -m venv certbot-env
+source certbot-env/bin/activate
+pip install certbot certbot-dns-poweradmin
+
+# Run certbot from the venv
+certbot plugins  # should show dns-poweradmin
+```
+
+### API connection issues
+
+- Verify your API URL is correct and accessible
+- Check that your API key has the required permissions
+
+## License
+
+Apache License 2.0

certbot_dns_poweradmin-0.1.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+certbot_dns_poweradmin/__init__.py,sha256=9fIRPdIiZ7-dPVor851Y0ZdcvDuyk1GUA_FvFeYZHVU,3771
+certbot_dns_poweradmin/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+certbot_dns_poweradmin/_internal/__init__.py,sha256=UDMjoJeWxCW0PO15TzBKzrpqYkn5CR9qwsBeGO0JjD0,64
+certbot_dns_poweradmin/_internal/dns_poweradmin.py,sha256=OwTj_KGUOvJSVXJPzvLy6jk5U01DhdgaRuL0DxI7pww,11667
+certbot_dns_poweradmin/_internal/tests/__init__.py,sha256=xoKF-9-hut6f08ERpJUb4xbkWg-i3JKVVyQyBlcINVo,47
+certbot_dns_poweradmin/_internal/tests/dns_poweradmin_test.py,sha256=EKYm96KTTX7ZbzM4L9l2UiVF6h7dO0wpQWNdCcCI_hY,10364
+certbot_dns_poweradmin-0.1.1.dist-info/METADATA,sha256=ujzuXrsmxFPiNmeNqEiD16lkMbF9G4CeteFjkvwiE_Y,5694
+certbot_dns_poweradmin-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+certbot_dns_poweradmin-0.1.1.dist-info/entry_points.txt,sha256=erkikti0fCRn2YbHCGAUYlfEgxx6NJCWAt3i6ZfyJ6w,97
+certbot_dns_poweradmin-0.1.1.dist-info/licenses/LICENSE,sha256=jxIpEpEufD33Bn_5ZgjKHGGpK8H1xZNCPKqBeEta4jg,11348
+certbot_dns_poweradmin-0.1.1.dist-info/RECORD,,

certbot_dns_poweradmin-0.1.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

certbot_dns_poweradmin-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[certbot.plugins]
+dns-poweradmin = certbot_dns_poweradmin._internal.dns_poweradmin:Authenticator

certbot_dns_poweradmin-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 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, whether in Source or
+      Object form, 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 modifications
+      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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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 otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated 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 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 a Contribution incorporated 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, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, 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 as an addendum 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 copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   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 redistributing 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 consequential 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 any and 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 act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Edmondas Girkantas
+
+   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.