certapi 0.6.0__tar.gz → 1.0.1__tar.gz

{certapi-0.6.0/src/certapi.egg-info → certapi-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: certapi
-Version: 0.6.0
+Version: 1.0.1
 Summary: Python Package for managing keys, request SSL certificates from ACME.
 Home-page: https://github.com/mesudip/certapi
 Author: Sudip Bhattarai
@@ -27,7 +27,10 @@ Dynamic: summary
 CertApi is a Python package for requesting SSL certificates from ACME.
 This is to be used as a base library for building other tools, or to integrate Certificate creation feature in you app.
 
-> ⚠️ Warning: This project is in beta. Please stay tuned for the LTS `v1.0.0` release.
+[![Build Status](https://github.com/mesudip/certapi/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/mesudip/certapi/actions/workflows/tests.yml)
+[![codecov](https://codecov.io/github/mesudip/certapi/graph/badge.svg?token=NYTNCH29IT)](https://codecov.io/github/mesudip/certapi)
+[![PyPI version](https://img.shields.io/pypi/v/certapi.svg)](https://pypi.org/project/certapi/)
+
 
 For a detailed list of changes, please refer to the [CHANGELOG.md](CHANGELOG.md).
 
@@ -39,7 +42,7 @@ You can install CertApi using pip
 pip install certapi
 ```
 
-## Example: Obtain Certificate with Cloudflare
+## Example: Low Leve API : Certificate with Cloudflare
 
 ```python
 import json
@@ -51,7 +54,7 @@ from certapi import CertApiException, CloudflareChallengeSolver, Key, AcmeCertIs
 challenge_solver = CloudflareChallengeSolver(api_key=None)
 
 ## initialize cert issuer with a new account key
-cert_issuer = AcmeCertIssuer(Key.generate('rsa'), challenge_solver)
+cert_issuer = AcmeCertIssuer(Key.generate('ecdsa'), challenge_solver)
 
 # Preform setup i.e. fetching directory and registering ACME account
 cert_issuer.setup()
@@ -70,7 +73,45 @@ except CertApiException as e:
 ```
 
 
-## Example: Use High Leve API
+## Example: High Level API (with AcmeCertManager)
 
-```
+The `AcmeCertManager` provides a high-level interface that handles certificate storage, automatic renewal checks, and multi-solver management.
+
+```python
+from certapi import (
+    AcmeCertManager, 
+    FileSystemKeyStore, 
+    AcmeCertIssuer, 
+    CloudflareChallengeSolver
+)
+
+# 1. Setup KeyStore to persist keys and certificates
+key_store = FileSystemKeyStore("db")
+
+
+# DNS-01 via Cloudflare (e.g. for wildcard certs or internal domains)
+dns_solver = CloudflareChallengeSolver(api_token="your-cloudflare-token")
+
+# 3. Initialize and Setup AcmeCertManager
+# Create cert issuer with the default challenge solver
+cert_issuer = AcmeCertIssuer.with_keystore(key_store, dns_solver)
+
+cert_manager = AcmeCertManager(
+    key_store=key_store,
+    cert_issuer=cert_issuer,
+    challenge_solvers=[dns_solver], # other solvers can be used
+    renew_threshold_days=7
+)
+cert_manager.setup()
+
+# 4. Issue or Reuse Certificate
+# Automatically checks keystore and renews only if necessary
+response = cert_manager.issue_certificate(["example.com", "www.example.com"])
+
+for cert_data in response.issued:
+    print(f"Newly issued for: {cert_data.domains}")
+    print(cert_data.cert)
+
+for cert_data in response.existing:
+    print(f"Reusing existing for: {cert_data.domains}")
 ```

certapi-1.0.1/README.md

@@ -0,0 +1,93 @@
+# CertApi
+
+CertApi is a Python package for requesting SSL certificates from ACME.
+This is to be used as a base library for building other tools, or to integrate Certificate creation feature in you app.
+
+[![Build Status](https://github.com/mesudip/certapi/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/mesudip/certapi/actions/workflows/tests.yml)
+[![codecov](https://codecov.io/github/mesudip/certapi/graph/badge.svg?token=NYTNCH29IT)](https://codecov.io/github/mesudip/certapi)
+[![PyPI version](https://img.shields.io/pypi/v/certapi.svg)](https://pypi.org/project/certapi/)
+
+
+For a detailed list of changes, please refer to the [CHANGELOG.md](CHANGELOG.md).
+
+## Installation
+
+You can install CertApi using pip
+
+```bash
+pip install certapi
+```
+
+## Example: Low Leve API : Certificate with Cloudflare
+
+```python
+import json
+from certapi import CertApiException, CloudflareChallengeSolver, Key, AcmeCertIssuer
+
+
+# Initialize the Cloudflare challenge solver
+# The API key is read from the CLOUDFLARE_API_KEY environment variable, or you can set it below.
+challenge_solver = CloudflareChallengeSolver(api_key=None)
+
+## initialize cert issuer with a new account key
+cert_issuer = AcmeCertIssuer(Key.generate('ecdsa'), challenge_solver)
+
+# Preform setup i.e. fetching directory and registering ACME account
+cert_issuer.setup()
+
+try:
+    # Obtain a certificate for your domain
+    (key, cert) = cert_issuer.generate_key_and_cert_for_domain("your-domain.com")
+
+    print("------ Private Key -----")
+    print(key.to_pem())
+    print("------- Certificate ------")
+    print(cert)
+except CertApiException as e:
+    print(f"An error occurred:", json.dumps(e.json_obj(), indent=2))
+
+```
+
+
+## Example: High Level API (with AcmeCertManager)
+
+The `AcmeCertManager` provides a high-level interface that handles certificate storage, automatic renewal checks, and multi-solver management.
+
+```python
+from certapi import (
+    AcmeCertManager, 
+    FileSystemKeyStore, 
+    AcmeCertIssuer, 
+    CloudflareChallengeSolver
+)
+
+# 1. Setup KeyStore to persist keys and certificates
+key_store = FileSystemKeyStore("db")
+
+
+# DNS-01 via Cloudflare (e.g. for wildcard certs or internal domains)
+dns_solver = CloudflareChallengeSolver(api_token="your-cloudflare-token")
+
+# 3. Initialize and Setup AcmeCertManager
+# Create cert issuer with the default challenge solver
+cert_issuer = AcmeCertIssuer.with_keystore(key_store, dns_solver)
+
+cert_manager = AcmeCertManager(
+    key_store=key_store,
+    cert_issuer=cert_issuer,
+    challenge_solvers=[dns_solver], # other solvers can be used
+    renew_threshold_days=7
+)
+cert_manager.setup()
+
+# 4. Issue or Reuse Certificate
+# Automatically checks keystore and renews only if necessary
+response = cert_manager.issue_certificate(["example.com", "www.example.com"])
+
+for cert_data in response.issued:
+    print(f"Newly issued for: {cert_data.domains}")
+    print(cert_data.cert)
+
+for cert_data in response.existing:
+    print(f"Reusing existing for: {cert_data.domains}")
+```

{certapi-0.6.0 → certapi-1.0.1}/setup.py

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

{certapi-0.6.0 → certapi-1.0.1}/src/certapi/__init__.py

@@ -21,3 +21,4 @@ from .challenge_solver import (
     DigitalOceanChallengeSolver,
 )
 from .issuers import CertIssuer, SelfCertIssuer, AcmeCertIssuer
+from .client import CertManagerClient

{certapi-0.6.0 → certapi-1.0.1}/src/certapi/acme/AcmeError.py

@@ -28,16 +28,17 @@ class AcmeHttpError(AcmeError, requests.HTTPError):
 
     def __init__(self, response: requests.Response, step: str):
         requests.HTTPError.__init__(self, response=response)
-        self.response = response
         (message, detail) = self.extract_acme_response_error()
         AcmeError.__init__(self, message, detail, step)
+        self.response = response
+
 
     def extract_acme_response_error(self):
         message = None
         error = None
         try:
             res_json = self.response.json()
-            if res_json["status"] == "invalid":
+            if res_json.get("status") == "invalid":
                 if res_json["challenges"]:
                     failed_challenge: dict = [x for x in res_json["challenges"] if x["status"] == "invalid"][0]
                     error = failed_challenge["error"]
@@ -108,10 +109,7 @@ class AcmeHttpError(AcmeError, requests.HTTPError):
                                 hostname = error.get("hostname", "unknown")
                                 status = error.get("status", "unknown")
                                 message = (
-                                    str(hostname)
-                                    + " Status="
-                                    + str(status)
-                                    + ": Invalid response in challenge url"
+                                    str(hostname) + " Status=" + str(status) + ": Invalid response in challenge url"
                                 )
                             else:
                                 message = err_detail
@@ -143,4 +141,4 @@ class AcmeInvalidNonceError(AcmeHttpError):
     def __init__(self, response: requests.Response, step: str):
         super().__init__(response, step)
         self.can_retry = True
-        self.response=0
+        self.response = 0

certapi-1.0.1/src/certapi/client/__init__.py

@@ -0,0 +1 @@
+from .cert_manager_client import CertManagerClient

{certapi-0.6.0 → certapi-1.0.1}/src/certapi/http/HttpClientBase.py

@@ -80,7 +80,7 @@ class HttpClientBase(object):
                 return self._req(method, url, step, json_data, data, params, timeout)
             except CertApiException as e:
                 if e.can_retry and i < retries:
-                    retry_delay = e.retry_delay if hasattr(e, 'retry_delay') else delay
+                    retry_delay = e.retry_delay if hasattr(e, "retry_delay") else delay
                     print(f"Retrying {method} {url} in {retry_delay} seconds due to retryable error: {e.message}")
                     time.sleep(retry_delay)
                 else:

{certapi-0.6.0 → certapi-1.0.1}/src/certapi/issuers/AcmeCertIssuer.py

@@ -21,6 +21,16 @@ class AcmeCertIssuer(CertIssuer):
         self.challenge_solver = challenge_solver
         self.self_verify_challenge = self_verify_challenge
 
+    @staticmethod
+    def with_keystore(
+        key_store: "KeyStore",
+        challenge_solver: ChallengeSolver,
+        account_key_name: str = "acme_account.key",
+        acme_url: str = None,
+    ) -> "AcmeCertIssuer":
+        account_key, _ = key_store._get_or_generate_key(account_key_name)
+        return AcmeCertIssuer(account_key, challenge_solver, acme_url=acme_url)
+
     def setup(self):
         self.acme.setup()
         res: Response = self.acme.register()

{certapi-0.6.0 → certapi-1.0.1}/src/certapi/manager/acme_cert_manager.py

@@ -12,6 +12,8 @@ from ..keystore.KeyStore import KeyStore
 from cryptography.x509 import Certificate, CertificateSigningRequest
 from ..crypto import Key, certs_to_pem, cert_to_pem, get_csr_hostnames
 
+DEFAULT_RENEW_THRESHOLD_DAYS = 62
+
 
 class AcmeCertManager:
     def __init__(
@@ -19,10 +21,14 @@ class AcmeCertManager:
         key_store: KeyStore,
         cert_issuer: AcmeCertIssuer,
         challenge_solvers: List[ChallengeSolver] = [],
+        renew_threshold_days: int = DEFAULT_RENEW_THRESHOLD_DAYS,  # Renewal will be accepted if cert is valid for less than 75 days
     ):
         self.key_store: KeyStore = key_store
         self.cert_issuer: AcmeCertIssuer = cert_issuer
         self.challenge_solvers: List[ChallengeSolver] = challenge_solvers
+        self.renew_threshold_days: int = (
+            DEFAULT_RENEW_THRESHOLD_DAYS if renew_threshold_days is None else renew_threshold_days
+        )
 
     def setup(self):
         names = [solver.__class__.__name__.replace("ChallengeSolver", "") for solver in self.challenge_solvers]
@@ -67,6 +73,7 @@ class AcmeCertManager:
         locality: Optional[str] = None,
         organization: Optional[str] = None,
         user_id: Optional[str] = None,
+        renew_threshold_days: Optional[int] = None,
     ) -> CertificateResponse:
 
         if type(hosts) == str:
@@ -77,10 +84,11 @@ class AcmeCertManager:
             result = self.key_store.find_key_and_cert_by_domain(h)
             if result is not None:
                 # result is (domain_id, key, cert_list)
-                cert=result[2][0]
+                cert = result[2][0]
                 invalid_date = cert.not_valid_after_utc
-                # Check if the certificate is still valid for at least 30 days
-                if invalid_date > datetime.now(timezone.utc) + timedelta(days=6):
+                # Check if the certificate is still valid for at least renew_threshold_days
+                threshold = renew_threshold_days if renew_threshold_days is not None else self.renew_threshold_days
+                if invalid_date > datetime.now(timezone.utc) + timedelta(days=threshold):
                     existing[h] = result
         missing = [h for h in hosts if h not in existing]
         if len(missing) > 0:

{certapi-0.6.0 → certapi-1.0.1}/src/certapi/server/api.py

@@ -1,4 +1,6 @@
 import json
+import threading
+import os
 from flask import request, jsonify
 from cryptography.x509 import CertificateSigningRequest
 from flask_restx import Resource, reqparse, fields
@@ -6,7 +8,48 @@ from flask_restx import Resource, reqparse, fields
 from certapi import AcmeCertManager
 
 
-def create_api_resources(api_ns, cert_manager: AcmeCertManager):
+class RenewalQueueFullError(Exception):
+    """Exception raised when the renewal queue is full."""
+
+    pass
+
+
+class RenewalLockManager:
+    def __init__(self, queue_size: int = 5):
+        self.queue_size = queue_size
+        self._lock = threading.Lock()
+        self._condition = threading.Condition(self._lock)
+        self._renewing_domains = set()
+        self._waiting_threads = 0
+
+    def acquire(self, domains):
+        while True:
+            with self._lock:
+                # Check if any domain is already being renewed by another thread
+                if any(h in self._renewing_domains for h in domains):
+                    if self._waiting_threads >= self.queue_size:
+                        raise RenewalQueueFullError("Proper queue is full")
+
+                    self._waiting_threads += 1
+                    self._condition.wait()
+                    self._waiting_threads -= 1
+                    continue  # Re-check everything after waking up
+
+                # Mark as renewing
+                for h in domains:
+                    self._renewing_domains.add(h)
+                break
+
+    def release(self, domains):
+        with self._lock:
+            for h in domains:
+                self._renewing_domains.discard(h)
+            self._condition.notify_all()
+
+
+def create_api_resources(api_ns, cert_manager: AcmeCertManager, renew_queue_size: int = 5):
+
+    lock_manager = RenewalLockManager(queue_size=renew_queue_size)
 
     # Models for documentation
     issued_cert_model = api_ns.model(
@@ -45,6 +88,7 @@ def create_api_resources(api_ns, cert_manager: AcmeCertManager):
     obtain_parser.add_argument("locality", type=str, help="Locality name")
     obtain_parser.add_argument("organization", type=str, help="Organization name")
     obtain_parser.add_argument("user_id", type=str, help="User ID")
+    obtain_parser.add_argument("renew_threshold_days", type=int, help="Threshold in days for certificate reuse")
 
     @api_ns.route("/obtain")
     class ObtainCert(Resource):
@@ -59,16 +103,23 @@ def create_api_resources(api_ns, cert_manager: AcmeCertManager):
             args = obtain_parser.parse_args()
             hostnames = args["hostname"]
 
-            data = cert_manager.issue_certificate(
-                hostnames,
-                key_type=args["key_type"],
-                expiry_days=args["expiry_days"],
-                country=args["country"],
-                state=args["state"],
-                locality=args["locality"],
-                organization=args["organization"],
-                user_id=args["user_id"],
-            )
+            # Acquire lock for the domains
+            lock_manager.acquire(hostnames)
+            try:
+                data = cert_manager.issue_certificate(
+                    hostnames,
+                    key_type=args["key_type"],
+                    expiry_days=args["expiry_days"],
+                    country=args["country"],
+                    state=args["state"],
+                    locality=args["locality"],
+                    organization=args["organization"],
+                    user_id=args["user_id"],
+                    renew_threshold_days=args.get("renew_threshold_days"),
+                )
+            finally:
+                lock_manager.release(hostnames)
+
             print(data)
             print(data.to_json())
             if data:

{certapi-0.6.0 → certapi-1.0.1/src/certapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: certapi
-Version: 0.6.0
+Version: 1.0.1
 Summary: Python Package for managing keys, request SSL certificates from ACME.
 Home-page: https://github.com/mesudip/certapi
 Author: Sudip Bhattarai
@@ -27,7 +27,10 @@ Dynamic: summary
 CertApi is a Python package for requesting SSL certificates from ACME.
 This is to be used as a base library for building other tools, or to integrate Certificate creation feature in you app.
 
-> ⚠️ Warning: This project is in beta. Please stay tuned for the LTS `v1.0.0` release.
+[![Build Status](https://github.com/mesudip/certapi/actions/workflows/tests.yml/badge.svg?branch=master)](https://github.com/mesudip/certapi/actions/workflows/tests.yml)
+[![codecov](https://codecov.io/github/mesudip/certapi/graph/badge.svg?token=NYTNCH29IT)](https://codecov.io/github/mesudip/certapi)
+[![PyPI version](https://img.shields.io/pypi/v/certapi.svg)](https://pypi.org/project/certapi/)
+
 
 For a detailed list of changes, please refer to the [CHANGELOG.md](CHANGELOG.md).
 
@@ -39,7 +42,7 @@ You can install CertApi using pip
 pip install certapi
 ```
 
-## Example: Obtain Certificate with Cloudflare
+## Example: Low Leve API : Certificate with Cloudflare
 
 ```python
 import json
@@ -51,7 +54,7 @@ from certapi import CertApiException, CloudflareChallengeSolver, Key, AcmeCertIs
 challenge_solver = CloudflareChallengeSolver(api_key=None)
 
 ## initialize cert issuer with a new account key
-cert_issuer = AcmeCertIssuer(Key.generate('rsa'), challenge_solver)
+cert_issuer = AcmeCertIssuer(Key.generate('ecdsa'), challenge_solver)
 
 # Preform setup i.e. fetching directory and registering ACME account
 cert_issuer.setup()
@@ -70,7 +73,45 @@ except CertApiException as e:
 ```
 
 
-## Example: Use High Leve API
+## Example: High Level API (with AcmeCertManager)
 
-```
+The `AcmeCertManager` provides a high-level interface that handles certificate storage, automatic renewal checks, and multi-solver management.
+
+```python
+from certapi import (
+    AcmeCertManager, 
+    FileSystemKeyStore, 
+    AcmeCertIssuer, 
+    CloudflareChallengeSolver
+)
+
+# 1. Setup KeyStore to persist keys and certificates
+key_store = FileSystemKeyStore("db")
+
+
+# DNS-01 via Cloudflare (e.g. for wildcard certs or internal domains)
+dns_solver = CloudflareChallengeSolver(api_token="your-cloudflare-token")
+
+# 3. Initialize and Setup AcmeCertManager
+# Create cert issuer with the default challenge solver
+cert_issuer = AcmeCertIssuer.with_keystore(key_store, dns_solver)
+
+cert_manager = AcmeCertManager(
+    key_store=key_store,
+    cert_issuer=cert_issuer,
+    challenge_solvers=[dns_solver], # other solvers can be used
+    renew_threshold_days=7
+)
+cert_manager.setup()
+
+# 4. Issue or Reuse Certificate
+# Automatically checks keystore and renews only if necessary
+response = cert_manager.issue_certificate(["example.com", "www.example.com"])
+
+for cert_data in response.issued:
+    print(f"Newly issued for: {cert_data.domains}")
+    print(cert_data.cert)
+
+for cert_data in response.existing:
+    print(f"Reusing existing for: {cert_data.domains}")
 ```

{certapi-0.6.0 → certapi-1.0.1}/src/certapi.egg-info/SOURCES.txt

@@ -52,6 +52,7 @@ src/certapi/server/__init__.py
 src/certapi/server/api.py
 src/certapi/server/cert_api.py
 src/certapi/server/key_api.py
+tests/test_acme_error_handling.py
 tests/test_cert_issuer_generic.py
 tests/test_certs_with_key_types.py
 tests/test_http_error_handling.py