certapi 0.4.3__tar.gz → 0.4.4__tar.gz

{certapi-0.4.3 → certapi-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: certapi
-Version: 0.4.3
+Version: 0.4.4
 Summary: Python Package for managing keys, request SSL certificates from ACME.
 Home-page: https://github.com/mesudip/certapi
 Author: Sudip Bhattarai

{certapi-0.4.3 → certapi-0.4.4}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="certapi",
-    version="0.4.3",
+    version="0.4.4",
     packages=find_packages(where="src"),
     package_dir={"": "src"},
     install_requires=[

{certapi-0.4.3 → certapi-0.4.4}/src/certapi/__init__.py

@@ -1,7 +1,7 @@
 from .acme.Acme import Acme, Order, AcmeNetworkError, AcmeHttpError, Challenge
 from .manager.acme_cert_manager import AcmeCertManager
 from .http.types import CertificateResponse, IssuedCert
-
+from .errors import CertApiException
 from .crypto import (
     Certificate,
     CertificateSigningRequest,
@@ -20,4 +20,4 @@ from .challenge_solver import (
     CloudflareChallengeSolver,
     DigitalOceanChallengeSolver,
 )
-from .issuers import SelfCertIssuer
+from .issuers import CertIssuer,SelfCertIssuer,AcmeCertIssuer

{certapi-0.4.3 → certapi-0.4.4}/src/certapi/acme/AcmeError.py

@@ -1,18 +1,13 @@
 import re
 import requests
+from certapi.errors import CertApiException
 
 
-class AcmeError(Exception):
+class AcmeError(CertApiException):
     def __init__(self, message, detail, step):
-        super().__init__(step, message)
-        self.message: str = message
-        self.step: str = step
-        self.detail: dict = detail
+        super().__init__(message, detail, step)
         self.can_retry = False
 
-    def json_obj(self) -> dict:
-        return {"message": self.message, "step": self.step, "detail": self.detail}
-
 
 class AcmeNetworkError(AcmeError, requests.RequestException):
     """
@@ -23,7 +18,6 @@ class AcmeNetworkError(AcmeError, requests.RequestException):
         # Initialize both parent classes
         requests.RequestException.__init__(self, request=request)
         AcmeError.__init__(self, message, detail, step)
-        requests.RequestException.__init__(self, request=request)  # Pass message to RequestException
         self.can_retry = True
 
 

{certapi-0.4.3 → certapi-0.4.4}/src/certapi/challenge_solver/ChallengeSolver.py

@@ -29,6 +29,10 @@ class ChallengeSolver(ABC):
     def supported_challenge_type(self) -> Literal["http-01", "dns-01", "tls-alpn-01"]:
         pass
 
+    @abstractmethod
+    def cleanup_old_challenges(self):
+        pass
+
     def __iter__(self):
         raise NotImplementedError("Must implement `__iter__` method.")
 

{certapi-0.4.3 → certapi-0.4.4}/src/certapi/challenge_solver/FileSystemChallengeSolver.py

@@ -5,7 +5,7 @@ import os
 
 class FilesystemChallengeSolver(ChallengeSolver):
     """
-    Filesystem implementation of the ChallengeStore.
+    Filesystem implementation of the ChallengeSolver.
     This should never be used, but extended for your webserver e.g. nginx, apache etc.
     """
 
@@ -36,6 +36,12 @@ class FilesystemChallengeSolver(ChallengeSolver):
     def supported_challenge_type(self) -> Literal["http-01"]:
         return "http-01"
 
+    def cleanup_old_challenges(self):
+        for filename in os.listdir(self.directory):
+            file_path = os.path.join(self.directory, filename)
+            if os.path.isfile(file_path):
+                os.remove(file_path)
+
     def __iter__(self):
         return (f for f in os.listdir(self.directory) if os.path.isfile(os.path.join(self.directory, f)))
 

{certapi-0.4.3 → certapi-0.4.4}/src/certapi/challenge_solver/InmemoryChallengeSolver.py

@@ -4,7 +4,7 @@ from .ChallengeSolver import ChallengeSolver
 
 class InMemoryChallengeSolver(ChallengeSolver):
     """
-    In-memory implementation of the ChallengeStore.
+    In-memory implementation of the ChallengeSolver.
     """
 
     def __init__(self):

{certapi-0.4.3 → certapi-0.4.4}/src/certapi/challenge_solver/dns/cloudflare/cloudflare_challenge_solver.py

@@ -2,8 +2,10 @@ import os
 import time
 from collections.abc import MutableMapping
 from typing import Literal
+from concurrent.futures import ThreadPoolExecutor
 from ...ChallengeSolver import ChallengeSolver
 from .cloudflare_client import Cloudflare
+from certapi.errors import CertApiException
 
 
 class CloudflareChallengeSolver(ChallengeSolver):
@@ -22,7 +24,10 @@ class CloudflareChallengeSolver(ChallengeSolver):
         try:
             self.cloudflare.determine_registered_domain(domain)
             return True
-        except Exception:
+        except CertApiException as e:
+            # Log the exception or handle it as needed, but return False as it doesn't support the domain
+            print(f"CloudflareChallengeSolver.supports_domain: {e.message} - {e.detail}")
+            return False
             return False
 
     def save_challenge(self, key: str, value: str, domain=None):
@@ -32,7 +37,7 @@ class CloudflareChallengeSolver(ChallengeSolver):
 
         record_id = self.cloudflare.create_record(name=key, data=value, domain=base_domain)
         self.challenges_map[key] = record_id
-        print(f"CloudflareChallengeStore[{domain}]: Added Record {key}")
+        print(f"CloudflareChallengeSolver[{domain}]: Added Record {key}")
 
     def get_challenge(self, key: str, domain: str) -> str:
         base_domain = self.cloudflare.determine_registered_domain(domain)
@@ -40,17 +45,42 @@ class CloudflareChallengeSolver(ChallengeSolver):
         for record in records:
             if record["name"] == key:
                 return record["content"]
-        return None  # Return None if not found, as per ChallengeStore's __getitem__ behavior
+        return None  # Return None if not found, as per ChallengeSolver's __getitem__ behavior
 
     def delete_challenge(self, key: str, domain: str):
         if key not in self.challenges_map:
-            raise KeyError(f"Challenge {key} not found in store (no record_id stored).")
+            print(f"CloudflareChallengeSolver.delete: Not found Skipping  key={key}  record_id={record_id}")
+            return
 
         record_id = self.challenges_map[key]
         base_domain = self.cloudflare.determine_registered_domain(domain)
         self.cloudflare.delete_record(record=record_id, domain=base_domain)
         del self.challenges_map[key]
-        print(f"CloudflareChallengeStore: Deleted challenge for {key} with record ID {record_id}")
+        print(f"CloudflareChallengeSolver: Deleted challenge for {key} with record ID {record_id}")
+
+    def _cleanup_zone_challenges(self, zone):
+        zone_name = zone["name"]
+        try:
+            # List all TXT records in the zone
+            records = self.cloudflare.list_txt_records(zone_name)
+            for record in records:
+                if record["type"] == "TXT" and record["name"].startswith("_acme-challenge"):
+                    print(f"CloudflareChallengeSolver: Deleting old challenge record {record['name']} in zone {zone_name}")
+                    try:
+                        self.cloudflare.delete_record(record["id"], zone_name)
+                    except CertApiException as e:
+                        print(f"CloudflareChallengeSolver: Warning - Failed to delete record {record['name']} in zone {zone_name}: {e.message} - {e.detail}")
+                    except Exception as e:
+                        print(f"CloudflareChallengeSolver: Warning - An unexpected error occurred while deleting record {record['name']} in zone {zone_name}: {e}")
+        except CertApiException as e:
+            print(f"CloudflareChallengeSolver: Error listing challenges in zone {zone_name}: {e.message} - {e.detail}")
+        except Exception as e:
+            print(f"CloudflareChallengeSolver: An unexpected error occurred while listing challenges in zone {zone_name}: {e}")
+
+    def cleanup_old_challenges(self):
+        zones = self.cloudflare._get_zones()
+        with ThreadPoolExecutor(max_workers=len(zones)) as executor:
+            executor.map(self._cleanup_zone_challenges, zones)
 
     def __iter__(self):
         # This is tricky as we can't easily iterate all challenges across all domains

{certapi-0.4.3 → certapi-0.4.4}/src/certapi/challenge_solver/dns/cloudflare/cloudflare_client.py

@@ -2,6 +2,7 @@ import json
 import time
 from os import getenv
 from urllib.request import urlopen, Request
+from certapi.errors import CertApiException
 
 
 class Cloudflare(object):
@@ -13,7 +14,7 @@ class Cloudflare(object):
         if not self.token:
             self.token = getenv("CLOUDFLARE_API_KEY")
             if not self.token:
-                raise Exception("CLOUDFLARE_API_KEY not found in environment")
+                raise CertApiException("CLOUDFLARE_API_KEY not found in environment", step="Cloudflare.__init__")
 
         self._zones_cache = None
         self._zones_cache_time = 0  # Unix timestamp of last cache update
@@ -31,7 +32,11 @@ class Cloudflare(object):
         api_url = "{0}/zones?per_page=50".format(self.api)
         response = urlopen(Request(api_url, headers=request_headers))
         if response.getcode() != 200:
-            raise Exception(json.loads(response.read().decode("utf8")))
+            raise CertApiException(
+                "Cloudflare API error",
+                detail=json.loads(response.read().decode("utf8")),
+                step="Cloudflare._get_zones"
+            )
 
         zones = json.loads(response.read().decode("utf8"))["result"]
         self._zones_cache = zones
@@ -44,7 +49,11 @@ class Cloudflare(object):
         for zone in zones:
             if zone["name"] == domain:
                 return zone["id"]
-        raise Exception("No Cloudflare zone found for domain: {0}".format(domain))
+        raise CertApiException(
+            "No Cloudflare zone found for domain",
+            detail={"domain": domain},
+            step="Cloudflare._get_zone_id"
+        )
 
     def determine_registered_domain(self, domain: str) -> str:
         """
@@ -62,9 +71,13 @@ class Cloudflare(object):
                 err = e
                 continue
         if err:
-            raise err
+            raise CertApiException(str(err), step="Cloudflare.determine_registered_domain")
         else:
-            raise Exception("Could not determine Cloudflare registered domain for: {0}".format(domain))
+            raise CertApiException(
+                "Could not determine Cloudflare registered domain",
+                detail={"domain": domain},
+                step="Cloudflare.determine_registered_domain"
+            )
 
     def list_txt_records(self, domain: str, name_filter: str = None) -> list:
         """
@@ -81,12 +94,20 @@ class Cloudflare(object):
         response = urlopen(Request(api_url, headers=request_headers))
 
         if response.getcode() != 200:
-            raise Exception(json.loads(response.read().decode("utf8")))
+            raise CertApiException(
+                "Cloudflare API error",
+                detail=json.loads(response.read().decode("utf8")),
+                step="Cloudflare.list_txt_records"
+            )
 
         result = json.loads(response.read().decode("utf8"))
         if not result.get("success"):
             print(f"List TXT record [{response.getcode()}]", result)
-            raise Exception(result.get("errors", "Unknown error listing TXT records"))
+            raise CertApiException(
+                "Unknown error listing TXT records",
+                detail=result.get("errors", "Unknown error listing TXT records"),
+                step="Cloudflare.list_txt_records"
+            )
 
         return result["result"]
 
@@ -115,7 +136,11 @@ class Cloudflare(object):
         result = response.read().decode("utf8")
         if response.getcode() != 200:
             print(f"Create TXT record [{response.getcode()}]", result)
-            raise Exception(json.loads(response.read().decode("utf8")))
+            raise CertApiException(
+                "Cloudflare API error",
+                detail=json.loads(result),
+                step="Cloudflare.create_record"
+            )
 
         return json.loads(result)["result"]["id"]
 
@@ -136,4 +161,8 @@ class Cloudflare(object):
         result = response.read().decode("utf8")
         if response.getcode() != 200:
             print(f"Delete dns record [{response.getcode()}]", result)
-            raise Exception(json.loads(response.read().decode("utf8")))
+            raise CertApiException(
+                "Cloudflare API error",
+                detail=json.loads(result),
+                step="Cloudflare.delete_record"
+            )

{certapi-0.4.3 → certapi-0.4.4}/src/certapi/challenge_solver/dns/digitalocean/digitalocean_challenge_solver.py

@@ -3,6 +3,7 @@ from collections.abc import MutableMapping
 from typing import Literal
 from ...ChallengeSolver import ChallengeSolver
 from .digitalocean_client import DigitalOcean
+from certapi.errors import CertApiException
 
 
 class DigitalOceanChallengeSolver(ChallengeSolver):
@@ -21,7 +22,13 @@ class DigitalOceanChallengeSolver(ChallengeSolver):
         try:
             self.digitalocean.determine_domain(domain)
             return True
-        except Exception:
+        except CertApiException as e:
+            # Log the exception or handle it as needed, but return False as it doesn't support the domain
+            print(f"DigitalOceanChallengeSolver.supports_domain: {e.message} - {e.detail}")
+            return False
+        except Exception as e:
+            # Catch any other unexpected exceptions
+            print(f"DigitalOceanChallengeSolver.supports_domain: An unexpected error occurred: {e}")
             return False
 
     def save_challenge(self, key: str, value: str, domain=None):
@@ -31,7 +38,7 @@ class DigitalOceanChallengeSolver(ChallengeSolver):
 
         record_id = self.digitalocean.create_record(name=key, data=value, domain=base_domain)
         self.challenges_map[key] = record_id
-        print(f"DigitalOceanChallengeStore: Saved challenge for {key} with record ID {record_id}")
+        print(f"DigitalOceanChallengeSolver: Saved challenge for {key} with record ID {record_id}")
 
     def get_challenge(self, key: str, domain: str) -> str:
         base_domain = self.digitalocean.determine_domain(domain)
@@ -39,7 +46,7 @@ class DigitalOceanChallengeSolver(ChallengeSolver):
         for record in records:
             if record["name"] == key:
                 return record["data"]  # DigitalOcean API returns 'data' for TXT record content
-        return None  # Return None if not found, as per ChallengeStore's __getitem__ behavior
+        return None  # Return None if not found, as per ChallengeSolver's __getitem__ behavior
 
     def delete_challenge(self, key: str, domain: str):
         if key not in self.challenges_map:
@@ -49,7 +56,27 @@ class DigitalOceanChallengeSolver(ChallengeSolver):
         base_domain = self.digitalocean.determine_domain(domain)
         self.digitalocean.delete_record(record=record_id, domain=base_domain)
         del self.challenges_map[key]
-        print(f"DigitalOceanChallengeStore: Deleted challenge for {key} with record ID {record_id}")
+        print(f"DigitalOceanChallengeSolver: Deleted challenge for {key} with record ID {record_id}")
+
+    def cleanup_old_challenges(self):
+        domains = self.digitalocean._get_domains()
+        for domain_obj in domains:
+            domain_name = domain_obj["name"]
+            try:
+                records = self.digitalocean.list_records(domain_name)
+                for record in records:
+                    if record["type"] == "TXT" and record["name"].startswith("_acme-challenge"):
+                        print(f"DigitalOceanChallengeSolver: Deleting old challenge record {record['name']} in domain {domain_name}")
+                        try:
+                            self.digitalocean.delete_record(record["id"], domain_name)
+                        except CertApiException as e:
+                            print(f"DigitalOceanChallengeSolver: Warning - Failed to delete record {record['name']} in domain {domain_name}: {e.message} - {e.detail}")
+                        except Exception as e:
+                            print(f"DigitalOceanChallengeSolver: Warning - An unexpected error occurred while deleting record {record['name']} in domain {domain_name}: {e}")
+            except CertApiException as e:
+                print(f"DigitalOceanChallengeSolver: Error listing challenges in domain {domain_name}: {e.message} - {e.detail}")
+            except Exception as e:
+                print(f"DigitalOceanChallengeSolver: An unexpected error occurred while listing challenges in domain {domain_name}: {e}")
 
     def __iter__(self):
         # This is tricky as we can't easily iterate all challenges across all domains

{certapi-0.4.3 → certapi-0.4.4}/src/certapi/challenge_solver/dns/digitalocean/digitalocean_client.py

@@ -1,7 +1,7 @@
 import json
 from os import getenv
-
-from urllib.request import urlopen, Request  # Python 3
+from urllib.request import urlopen, Request
+from certapi.errors import CertApiException
 
 
 class DigitalOcean(object):
@@ -11,18 +11,31 @@ class DigitalOcean(object):
         if not self.token:
             self.token = getenv("DIGITALOCEAN_API_KEY")
             if not self.token:
-                raise Exception("DIGITALOCEAN_API_KEY not found in environment")
+                raise CertApiException("DIGITALOCEAN_API_KEY not found in environment", step="DigitalOcean.__init__")
 
-    def determine_domain(self, domain):
-        """Determine registered domain in API"""
+    def _get_domains(self):
+        """Fetch DigitalOcean domains"""
         request_headers = {"Content-Type": "application/json", "Authorization": "Bearer {0}".format(self.token)}
         response = urlopen(Request(self.api, headers=request_headers))
         if response.getcode() != 200:
-            raise Exception(json.loads(response.read().decode("utf8")))
-        domains = json.loads(response.read().decode("utf8"))["domains"]
+            raise CertApiException(
+                "DigitalOcean API error",
+                detail=json.loads(response.read().decode("utf8")),
+                step="DigitalOcean._get_domains"
+            )
+        return json.loads(response.read().decode("utf8"))["domains"]
+
+    def determine_domain(self, domain):
+        """Determine registered domain in API"""
+        domains = self._get_domains()
         for d in domains:
             if d["name"] in domain:
                 return d["name"]
+        raise CertApiException(
+            "No DigitalOcean domain found for: {0}".format(domain),
+            detail={"domain": domain},
+            step="DigitalOcean.determine_domain"
+        )
 
     def create_record(self, name, data, domain):
         """
@@ -40,7 +53,11 @@ class DigitalOcean(object):
         request_data = {"type": "TXT", "ttl": 300, "name": name, "data": data}
         response = urlopen(Request(api, data=json.dumps(request_data).encode("utf8"), headers=request_headers))
         if response.getcode() != 201:
-            raise Exception(json.loads(response.read().decode("utf8")))
+            raise CertApiException(
+                "DigitalOcean API error",
+                detail=json.loads(response.read().decode("utf8")),
+                step="DigitalOcean.create_record"
+            )
         return json.loads(response.read().decode("utf8"))["domain_record"]["id"]
 
     def delete_record(self, record, domain):
@@ -57,7 +74,11 @@ class DigitalOcean(object):
         request.get_method = lambda: "DELETE"
         response = urlopen(request)
         if response.getcode() != 204:
-            raise Exception(json.loads(response.read().decode("utf8")))
+            raise CertApiException(
+                "DigitalOcean API error",
+                detail=json.loads(response.read().decode("utf8")),
+                step="DigitalOcean.delete_record"
+            )
 
     def list_records(self, domain, name_filter=None):
         """
@@ -73,7 +94,11 @@ class DigitalOcean(object):
         request_headers = {"Content-Type": "application/json", "Authorization": "Bearer {0}".format(self.token)}
         response = urlopen(Request(api, headers=request_headers))
         if response.getcode() != 200:
-            raise Exception(json.loads(response.read().decode("utf8")))
+            raise CertApiException(
+                "DigitalOcean API error",
+                detail=json.loads(response.read().decode("utf8")),
+                step="DigitalOcean.list_records"
+            )
 
         all_records = json.loads(response.read().decode("utf8"))["domain_records"]
 

certapi-0.4.4/src/certapi/errors.py

@@ -0,0 +1,17 @@
+class CertApiException(Exception):
+    """
+    Base exception for all CertAPI related errors.
+    """
+    def __init__(self, message: str, detail: dict = None, step: str = None):
+        super().__init__(message)
+        self.message = message
+        self.detail = detail if detail is not None else {}
+        self.step = step
+        self.can_retry = False
+
+    def json_obj(self) -> dict:
+        return {
+            "message": self.message,
+            "step": self.step,
+            "detail": self.detail
+        }

{certapi-0.4.3 → certapi-0.4.4}/src/certapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: certapi
-Version: 0.4.3
+Version: 0.4.4
 Summary: Python Package for managing keys, request SSL certificates from ACME.
 Home-page: https://github.com/mesudip/certapi
 Author: Sudip Bhattarai

{certapi-0.4.3 → certapi-0.4.4}/src/certapi.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 pyproject.toml
 setup.py
 src/certapi/__init__.py
+src/certapi/errors.py
 src/certapi/util.py
 src/certapi/utils.py
 src/certapi.egg-info/PKG-INFO