certbot-dns-lightsail 0.2.0__py3-none-any.whl

certbot_dns_lightsail/authentication.py

@@ -0,0 +1,96 @@
+import logging
+from typing import Callable
+
+import boto3
+
+from certbot import configuration
+from certbot import errors
+from certbot.plugins import dns_common
+
+logger = logging.getLogger(__name__)
+
+
+class Authenticator(dns_common.DNSAuthenticator):
+    description = 'This plugin proves you have control over a domain ' \
+        'by DNS-01 challenge to the Amazon Lightsail DNS.'
+
+    def __init__(
+        self,
+        config: configuration.NamespaceConfig,
+        name: str,
+    ) -> None:
+        super().__init__(config, name)
+        self._client = _LightsailClient()
+
+    @classmethod
+    def add_parser_arguments(
+        cls,
+        add: Callable[..., None],
+        default_propagation_seconds: int = 60,
+    ) -> None:
+        super().add_parser_arguments(add, default_propagation_seconds)
+
+    def more_info(self) -> str:
+        return self.description
+
+    def _perform(
+        self,
+        domain: str,
+        validation_domain_name: str,
+        validation: str,
+    ) -> None:
+        try:
+            self._client.create_txt_record(
+                domain,
+                validation_domain_name,
+                validation,
+            )
+        except Exception as e:
+            raise errors.PluginError(
+                f'Failed to create TXT record ({validation_domain_name}): {e}'
+            )
+
+    def _cleanup(
+        self,
+        domain: str,
+        validation_domain_name: str,
+        validation: str,
+    ) -> None:
+        try:
+            self._client.delete_txt_record(
+                domain,
+                validation_domain_name,
+                validation,
+            )
+        except Exception as e:
+            logger.error(
+                f'Failed to delete TXT record ({validation_domain_name}): {e}'
+            )
+
+    def _setup_credentials(self) -> None:
+        pass
+
+
+class _LightsailClient:
+    def __init__(self) -> None:
+        self._client = boto3.client('lightsail')
+
+    def create_txt_record(self, domain: str, name: str, value: str) -> None:
+        self._client.create_domain_entry(
+            domainName=domain,
+            domainEntry={
+                'type': 'TXT',
+                'name': name,
+                'target': f'"{value}"',
+            },
+        )
+
+    def delete_txt_record(self, domain: str, name: str, value: str) -> None:
+        self._client.delete_domain_entry(
+            domainName=domain,
+            domainEntry={
+                'type': 'TXT',
+                'name': name,
+                'target': f'"{value}"',
+            },
+        )

certbot_dns_lightsail-0.2.0.dist-info/METADATA

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: certbot-dns-lightsail
+Version: 0.2.0
+Summary: Amazon Lightsail DNS Authenticator Plugin for Certbot
+Home-page: https://github.com/noi/certbot-dns-lightsail
+Author: Nobuki Fujii
+License: MIT
+Project-URL: Certbot, https://certbot.eff.org/
+Project-URL: Amazon Lightsail, https://aws.amazon.com/lightsail/
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Operating System :: POSIX :: Linux
+Classifier: Environment :: Plugins
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: certbot<6,>=5.0.0
+Requires-Dist: acme<6,>=5.0.0
+Requires-Dist: boto3>=1.40.0
+Provides-Extra: dev
+Requires-Dist: tox; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: flake8-import-order; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Amazon Lightsail DNS Authenticator Plugin for Certbot
+[![CI](https://github.com/noi/certbot-dns-lightsail/actions/workflows/ci.yml/badge.svg)](https://github.com/noi/certbot-dns-lightsail/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/certbot-dns-lightsail)](https://pypi.org/project/certbot-dns-lightsail/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/certbot-dns-lightsail)](https://pypi.org/project/certbot-dns-lightsail/)
+[![GitHub - License](https://img.shields.io/github/license/noi/certbot-dns-lightsail)](https://github.com/noi/certbot-dns-lightsail/blob/main/LICENSE)
+
+This plugin proves you have control over a domain by DNS-01 challenge to the Amazon Lightsail DNS.
+
+## Additional Arguments for Certbot
+- `--authenticator dns-lightsail`
+  - Use this plugin as an authenticator. (required)
+- `--dns-lightsail-propagation-seconds ${value}`
+  - The number of seconds to wait for DNS to propagate before asking the ACME server to verify the DNS record. (default: 60, The default TTL for Amazon Lightsail DNS records is 60 seconds so I recommend to set a value greater than it)
+
+## Getting Started
+### Requirements
+- Python 3.10 or later
+- Certbot 5.0.0 or later
+
+### Installation
+Install this plugin using `pip`:
+```
+pip install certbot-dns-lightsail
+```
+
+### Usage
+This plugin requires AWS region and credential settings before it can be used. And the region must be `us-east-1`.
+
+#### 1. Create Access Key
+Create an access key using IAM policy below:
+```json
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Effect": "Allow",
+            "Action": [
+                "lightsail:CreateDomainEntry",
+                "lightsail:DeleteDomainEntry"
+            ],
+            "Resource": "arn:aws:lightsail:us-east-1:${YOUR-ACCOUNT-ID}:Domain/${YOUR-DOMAIN-ID}"
+        }
+    ]
+}
+```
+
+#### 2. Create Setting Files
+Create setting files below:
+```
+# ~/.aws/config
+[default]
+region=us-east-1
+
+# ~/.aws/credentials
+[default]
+aws_access_key_id=${YOUR-ACCESS-KEY-ID}
+aws_secret_access_key=${YOUR-SECRET-ACCESS-KEY}
+```
+
+#### 3. Run Certbot
+You are ready to run this plugin with Certbot!
+
+For example, run command below to obtain a certificate using this plugin:
+```sh
+certbot certonly \
+  --authenticator dns-lightsail \
+  --dns-lightsail-propagation-seconds 70 \
+  --non-interactive \
+  --agree-tos \
+  -m 'mail@example.com' \
+  -d 'example.com' \
+  -d '*.example.com'
+```

certbot_dns_lightsail-0.2.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+certbot_dns_lightsail/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+certbot_dns_lightsail/authentication.py,sha256=zV38WUqXyzTobknYsuSFVCKwjpPGlUP80-r82p37g68,2537
+certbot_dns_lightsail-0.2.0.dist-info/licenses/LICENSE,sha256=Kr8WPYnPjFYBI7vsBVqYkJf1_NY8q4Zo8GBLqmxkyDY,1069
+certbot_dns_lightsail-0.2.0.dist-info/METADATA,sha256=DFYtHz0-yejTOqi2kfu-QKbC_O016R6KH98N1L9R0lc,3905
+certbot_dns_lightsail-0.2.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+certbot_dns_lightsail-0.2.0.dist-info/entry_points.txt,sha256=xPBwr-67yaC9_7GBZNpcvTtOTmMPy1zRxncs-EycmDE,85
+certbot_dns_lightsail-0.2.0.dist-info/top_level.txt,sha256=LMlj41RY6oHXGSir_wN-RHHz5IMdPATOgbq_JfnUCcA,22
+certbot_dns_lightsail-0.2.0.dist-info/RECORD,,

certbot_dns_lightsail-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

certbot_dns_lightsail-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[certbot.plugins]
+dns-lightsail = certbot_dns_lightsail.authentication:Authenticator

certbot_dns_lightsail-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Nobuki Fujii
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

certbot_dns_lightsail-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+certbot_dns_lightsail