certbot-dns-gyro 0.1.0__tar.gz

certbot_dns_gyro-0.1.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: certbot-dns-gyro
+Version: 0.1.0
+Summary: Gyro DNS authenticator plugin for Certbot (DNS-01, wildcard certificates)
+Author: Gyro Hosting
+License: MIT
+Project-URL: Homepage, https://github.com/Gyro-Hosting/gyro-acme
+Project-URL: Documentation, https://www.gyrohosting.com/en/knowledgebase/article/gyro-dns-lets-encrypt-wildcard-certificate
+Project-URL: API documentation, https://www.gyrohosting.com/developers
+Project-URL: Issues, https://github.com/Gyro-Hosting/gyro-acme/issues
+Keywords: certbot,letsencrypt,acme,dns-01,wildcard,gyro
+Classifier: Environment :: Plugins
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Security
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: certbot>=2.0
+Requires-Dist: requests>=2.20
+
+# certbot-dns-gyro
+
+Gyro DNS authenticator plugin for [Certbot](https://certbot.eff.org): DNS-01 challenges, wildcard certificates.
+
+## Install
+```sh
+pip install "certbot-dns-gyro @ git+https://github.com/Gyro-Hosting/gyro-acme@v0.1.0#subdirectory=certbot-dns-gyro"
+```
+(Install into the same Python environment as Certbot. Snap Certbot users: use `pip` Certbot or acme.sh.)
+
+## Credentials
+```ini
+# /etc/letsencrypt/gyro.ini  (chmod 600)
+dns_gyro_token = wck_...
+# dns_gyro_api = https://www.gyrohosting.com/api/v1/client/   (optional)
+```
+## Use
+```sh
+certbot certonly --authenticator dns-gyro --dns-gyro-credentials /etc/letsencrypt/gyro.ini \
+  -d example.com -d '*.example.com'
+```
+The plugin waits until both Gyro DNS name servers publish the record; the default
+`--dns-gyro-propagation-seconds` is 10.
+
+Türkçe: Gyro DNS ACME anahtarını `dns_gyro_token` olarak bir ini dosyasına yazın (izin 600) ve
+`--authenticator dns-gyro` ile kullanın. Joker sertifika için hem `ornek.com` hem `*.ornek.com` isteyin.

certbot_dns_gyro-0.1.0/README.md

@@ -0,0 +1,26 @@
+# certbot-dns-gyro
+
+Gyro DNS authenticator plugin for [Certbot](https://certbot.eff.org): DNS-01 challenges, wildcard certificates.
+
+## Install
+```sh
+pip install "certbot-dns-gyro @ git+https://github.com/Gyro-Hosting/gyro-acme@v0.1.0#subdirectory=certbot-dns-gyro"
+```
+(Install into the same Python environment as Certbot. Snap Certbot users: use `pip` Certbot or acme.sh.)
+
+## Credentials
+```ini
+# /etc/letsencrypt/gyro.ini  (chmod 600)
+dns_gyro_token = wck_...
+# dns_gyro_api = https://www.gyrohosting.com/api/v1/client/   (optional)
+```
+## Use
+```sh
+certbot certonly --authenticator dns-gyro --dns-gyro-credentials /etc/letsencrypt/gyro.ini \
+  -d example.com -d '*.example.com'
+```
+The plugin waits until both Gyro DNS name servers publish the record; the default
+`--dns-gyro-propagation-seconds` is 10.
+
+Türkçe: Gyro DNS ACME anahtarını `dns_gyro_token` olarak bir ini dosyasına yazın (izin 600) ve
+`--authenticator dns-gyro` ile kullanın. Joker sertifika için hem `ornek.com` hem `*.ornek.com` isteyin.

certbot_dns_gyro-0.1.0/certbot_dns_gyro/__init__.py

@@ -0,0 +1 @@
+"""Gyro DNS Authenticator plugin for Certbot."""

certbot_dns_gyro-0.1.0/certbot_dns_gyro/_internal/__init__.py

@@ -0,0 +1 @@
+

certbot_dns_gyro-0.1.0/certbot_dns_gyro/_internal/dns_gyro.py

@@ -0,0 +1,89 @@
+"""DNS Authenticator for Gyro DNS (ACME key: may only write _acme-challenge TXT records)."""
+import logging
+import time
+from typing import Any, Callable, Optional
+
+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 = "https://www.gyrohosting.com/api/v1/client/"
+USER_AGENT = "certbot-dns-gyro/0.1.0"
+
+
+class Authenticator(dns_common.DNSAuthenticator):
+    """Gyro DNS Authenticator: fulfils dns-01 challenges with the Gyro DNS API."""
+
+    description = "Obtain certificates using a DNS TXT record (if you are using Gyro DNS)."
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.credentials: Optional[CredentialsConfiguration] = None
+
+    @classmethod
+    def add_parser_arguments(cls, add: Callable[..., None], default_propagation_seconds: int = 10) -> None:
+        super().add_parser_arguments(add, default_propagation_seconds)
+        add("credentials", help="Gyro DNS credentials INI file (dns_gyro_token = <ACME key>).")
+
+    def more_info(self) -> str:
+        return "This plugin configures a DNS TXT record to respond to a dns-01 challenge using the Gyro DNS API."
+
+    def _setup_credentials(self) -> None:
+        self.credentials = self._configure_credentials(
+            "credentials", "Gyro DNS credentials INI file",
+            {"token": "ACME key created in the Gyro DNS service page (ACME / Let's Encrypt)."})
+
+    def _client(self) -> "_GyroClient":
+        assert self.credentials is not None
+        return _GyroClient(self.credentials.conf("token"), self.credentials.conf("api") or DEFAULT_API)
+
+    def _perform(self, domain: str, validation_name: str, validation: str) -> None:
+        self._client().add(validation_name, validation)
+
+    def _cleanup(self, domain: str, validation_name: str, validation: str) -> None:
+        try:
+            self._client().remove(validation_name, validation)
+        except errors.PluginError as e:
+            logger.warning("Could not remove the TXT record %s: %s", validation_name, e)
+
+
+class _GyroClient:
+    def __init__(self, token: str, api: str) -> None:
+        self.api = api if api.endswith("/") else api + "/"
+        self.s = requests.Session()
+        self.s.headers.update({"Authorization": "Bearer " + token, "Accept": "application/json", "User-Agent": USER_AGENT})
+
+    def _call(self, method: str, name: str, value: str) -> dict:
+        url = self.api + "cloud/dns/acme-challenge"
+        try:
+            if method == "POST":
+                r = self.s.post(url, json={"name": name, "value": value}, timeout=60)
+            else:
+                r = self.s.request(method, url, params={"name": name, "value": value}, timeout=60)
+        except requests.RequestException as e:
+            raise errors.PluginError("Gyro DNS API unreachable: %s" % e)
+        try:
+            j = r.json()
+        except ValueError:
+            j = {}
+        if r.status_code >= 300:
+            err = (j.get("error") or {}) if isinstance(j, dict) else {}
+            raise errors.PluginError("Gyro DNS API error %s: %s (%s)" % (r.status_code, err.get("message", r.text[:200]), err.get("code", "")))
+        return j.get("data") or {}
+
+    def add(self, name: str, value: str) -> None:
+        self._call("POST", name, value)
+        # wait until both authoritative name servers publish the value
+        deadline = time.time() + 180
+        while time.time() < deadline:
+            if self._call("GET", name, value).get("ready"):
+                logger.info("Gyro DNS: %s is live on both name servers", name)
+                return
+            time.sleep(5)
+        logger.warning("Gyro DNS: name servers have not confirmed %s yet; continuing", name)
+
+    def remove(self, name: str, value: str) -> None:
+        self._call("DELETE", name, value)

certbot_dns_gyro-0.1.0/certbot_dns_gyro.egg-info/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: certbot-dns-gyro
+Version: 0.1.0
+Summary: Gyro DNS authenticator plugin for Certbot (DNS-01, wildcard certificates)
+Author: Gyro Hosting
+License: MIT
+Project-URL: Homepage, https://github.com/Gyro-Hosting/gyro-acme
+Project-URL: Documentation, https://www.gyrohosting.com/en/knowledgebase/article/gyro-dns-lets-encrypt-wildcard-certificate
+Project-URL: API documentation, https://www.gyrohosting.com/developers
+Project-URL: Issues, https://github.com/Gyro-Hosting/gyro-acme/issues
+Keywords: certbot,letsencrypt,acme,dns-01,wildcard,gyro
+Classifier: Environment :: Plugins
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Security
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: certbot>=2.0
+Requires-Dist: requests>=2.20
+
+# certbot-dns-gyro
+
+Gyro DNS authenticator plugin for [Certbot](https://certbot.eff.org): DNS-01 challenges, wildcard certificates.
+
+## Install
+```sh
+pip install "certbot-dns-gyro @ git+https://github.com/Gyro-Hosting/gyro-acme@v0.1.0#subdirectory=certbot-dns-gyro"
+```
+(Install into the same Python environment as Certbot. Snap Certbot users: use `pip` Certbot or acme.sh.)
+
+## Credentials
+```ini
+# /etc/letsencrypt/gyro.ini  (chmod 600)
+dns_gyro_token = wck_...
+# dns_gyro_api = https://www.gyrohosting.com/api/v1/client/   (optional)
+```
+## Use
+```sh
+certbot certonly --authenticator dns-gyro --dns-gyro-credentials /etc/letsencrypt/gyro.ini \
+  -d example.com -d '*.example.com'
+```
+The plugin waits until both Gyro DNS name servers publish the record; the default
+`--dns-gyro-propagation-seconds` is 10.
+
+Türkçe: Gyro DNS ACME anahtarını `dns_gyro_token` olarak bir ini dosyasına yazın (izin 600) ve
+`--authenticator dns-gyro` ile kullanın. Joker sertifika için hem `ornek.com` hem `*.ornek.com` isteyin.

certbot_dns_gyro-0.1.0/certbot_dns_gyro.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+certbot_dns_gyro/__init__.py
+certbot_dns_gyro.egg-info/PKG-INFO
+certbot_dns_gyro.egg-info/SOURCES.txt
+certbot_dns_gyro.egg-info/dependency_links.txt
+certbot_dns_gyro.egg-info/entry_points.txt
+certbot_dns_gyro.egg-info/requires.txt
+certbot_dns_gyro.egg-info/top_level.txt
+certbot_dns_gyro/_internal/__init__.py
+certbot_dns_gyro/_internal/dns_gyro.py

certbot_dns_gyro-0.1.0/certbot_dns_gyro.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

certbot_dns_gyro-0.1.0/certbot_dns_gyro.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[certbot.plugins]
+dns-gyro = certbot_dns_gyro._internal.dns_gyro:Authenticator

certbot_dns_gyro-0.1.0/certbot_dns_gyro.egg-info/requires.txt

@@ -0,0 +1,2 @@
+certbot>=2.0
+requests>=2.20

certbot_dns_gyro-0.1.0/certbot_dns_gyro.egg-info/top_level.txt

@@ -0,0 +1 @@
+certbot_dns_gyro

certbot_dns_gyro-0.1.0/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "certbot-dns-gyro"
+version = "0.1.0"
+description = "Gyro DNS authenticator plugin for Certbot (DNS-01, wildcard certificates)"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [{name = "Gyro Hosting"}]
+requires-python = ">=3.8"
+dependencies = ["certbot>=2.0", "requests>=2.20"]
+classifiers = ["Environment :: Plugins", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Topic :: Security"]
+
+keywords = ["certbot", "letsencrypt", "acme", "dns-01", "wildcard", "gyro"]
+
+[project.urls]
+Homepage = "https://github.com/Gyro-Hosting/gyro-acme"
+Documentation = "https://www.gyrohosting.com/en/knowledgebase/article/gyro-dns-lets-encrypt-wildcard-certificate"
+"API documentation" = "https://www.gyrohosting.com/developers"
+Issues = "https://github.com/Gyro-Hosting/gyro-acme/issues"
+
+[project.entry-points."certbot.plugins"]
+dns-gyro = "certbot_dns_gyro._internal.dns_gyro:Authenticator"
+
+[tool.setuptools.packages.find]
+include = ["certbot_dns_gyro*"]

certbot_dns_gyro-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+