certbot-dns-nicmanager 1.0.0__tar.gz

certbot_dns_nicmanager-1.0.0/CHANGELOG.md

@@ -0,0 +1,60 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2026-06-16
+
+First stable release. The plugin has been validated in production against the
+live nicmanager AnycastDNS API (wildcard issuance for 8 domains, with automatic
+renewal via certbot's systemd timer).
+
+### Added
+- `docs/ARCHITECTURE.md` and Architecture Decision Records
+  (`docs/decisions/ADR-001..003`) documenting the design.
+- `docs/TROUBLESHOOTING.md` with the real-world nicmanager API status decoder
+  (401 vs 403 vs rate-limit vs firewall block) and authentication notes.
+- Automated PyPI publishing via GitHub Actions Trusted Publishing (OIDC).
+
+### Notes
+- The basic-auth **username must match the account's active authentication
+  method**: the account **email** for "E-Mail + Passwort" accounts, or
+  `login.username` otherwise. The wrong form returns `401` even with the correct
+  password. 2FA must be disabled on the automation account.
+
+## [0.2.0] - 2026-06-14
+
+### Changed
+- **Zone detection no longer reads zones.** A restricted API-ACME account cannot
+  read zone metadata (`GET /anycast/{zone}` returns 401/403), so the owning zone
+  is now found by attempting the record *create* against each candidate zone
+  (most-specific first) and using the first that succeeds. A `403`/`404` skips to
+  the next candidate; a `401` (genuine auth failure) is never swallowed.
+- Cleanup now deletes strictly by the record id captured at creation and makes no
+  `GET` request when no id is stored (the restricted account cannot list records).
+
+### Notes
+- If the credentials password contains `#`, quote it in the INI
+  (`dns_nicmanager_password = "..."`) — the INI parser treats an unquoted `#` as
+  a comment.
+
+## [0.1.0] - 2026-06-14
+
+### Added
+- Initial release.
+- Certbot `dns-01` authenticator (`dns-nicmanager`) for the nicmanager AnycastDNS
+  API.
+- Automatic zone detection with an optional `dns_nicmanager_zone` override.
+- Tolerates locked-down API-ACME accounts that cannot read zone metadata.
+- Cleanup deletes the challenge record by the numeric id returned at creation,
+  with a name/content lookup fallback.
+- Test suite covering create, delete, zone walking, and API error handling.
+
+[Unreleased]: https://github.com/jp1337/certbot-dns-nicmanager/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/jp1337/certbot-dns-nicmanager/compare/v0.2.0...v1.0.0
+[0.2.0]: https://github.com/jp1337/certbot-dns-nicmanager/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/jp1337/certbot-dns-nicmanager/releases/tag/v0.1.0

certbot_dns_nicmanager-1.0.0/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

certbot_dns_nicmanager-1.0.0/MANIFEST.in

@@ -0,0 +1,7 @@
+include README.md
+include CHANGELOG.md
+include LICENSE.txt
+include certbot_dns_nicmanager/py.typed
+recursive-include examples *.ini
+recursive-include tests *.py
+recursive-include docs *.md

certbot_dns_nicmanager-1.0.0/NOTICE

@@ -0,0 +1,8 @@
+certbot-dns-nicmanager
+Copyright 2026 Jochen Pylypiw
+
+This product includes software developed as an independent, community-maintained
+Certbot DNS plugin for the nicmanager AnycastDNS API.
+
+It is not affiliated with or endorsed by InterNexum GmbH / nicmanager, nor by the
+Electronic Frontier Foundation / the Certbot project.

certbot_dns_nicmanager-1.0.0/PKG-INFO

@@ -0,0 +1,226 @@
+Metadata-Version: 2.4
+Name: certbot-dns-nicmanager
+Version: 1.0.0
+Summary: nicmanager AnycastDNS Authenticator plugin for Certbot
+Author: Jochen Pylypiw
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/jp1337/certbot-dns-nicmanager
+Project-URL: Repository, https://github.com/jp1337/certbot-dns-nicmanager
+Project-URL: Issues, https://github.com/jp1337/certbot-dns-nicmanager/issues
+Project-URL: Changelog, https://github.com/jp1337/certbot-dns-nicmanager/blob/main/CHANGELOG.md
+Keywords: certbot,letsencrypt,acme,dns-01,nicmanager,dns
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Plugins
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+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: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Security
+Classifier: Topic :: System :: Installation/Setup
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+License-File: NOTICE
+Requires-Dist: certbot>=2.0.0
+Requires-Dist: requests>=2.20.0
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: requests-mock; extra == "test"
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: types-requests; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+# certbot-dns-nicmanager
+
+[![CI](https://github.com/jp1337/certbot-dns-nicmanager/actions/workflows/ci.yml/badge.svg)](https://github.com/jp1337/certbot-dns-nicmanager/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/certbot-dns-nicmanager.svg)](https://pypi.org/project/certbot-dns-nicmanager/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE.txt)
+
+> **Status:** stable (1.0). Running in production — wildcard issuance + automatic
+> renewal against the live nicmanager AnycastDNS API.
+
+A [Certbot](https://certbot.eff.org/) DNS authenticator plugin for
+[nicmanager](https://www.nicmanager.com/) **AnycastDNS**. It automates the
+`dns-01` ACME challenge by creating, and then removing, the
+`_acme-challenge` TXT record through the
+[nicmanager API](https://api.nicmanager.com/docs/v1/) — which makes it possible
+to issue **wildcard certificates** for domains hosted on nicmanager.
+
+There was no Certbot plugin for the nicmanager API, and the `lego`-based
+multi-provider plugins do not yet support nicmanager's current API. This plugin
+fills that gap with a small, dependency-light, well-tested implementation.
+
+## Why DNS-01 (and not HTTP-01)?
+
+`dns-01` is the only ACME challenge type that can issue **wildcard**
+certificates, and it does not require any inbound HTTP reachability. It also
+keeps your individual service hostnames out of the public
+[Certificate Transparency](https://certificate.transparency.dev/) logs that a
+per-host `http-01` certificate would expose.
+
+## Installation
+
+```bash
+pip install certbot-dns-nicmanager
+```
+
+> Install the plugin into the **same** Python environment as Certbot. If you
+> installed Certbot via `snap`, install the plugin with
+> `snap install certbot-dns-nicmanager` once it is published there, or run
+> Certbot from a `pip` environment that contains both packages.
+
+Verify it is registered:
+
+```bash
+certbot plugins
+# ... should list:  * dns-nicmanager
+```
+
+## Credentials
+
+This plugin authenticates against the nicmanager API with HTTP Basic auth.
+The strongly recommended setup is a dedicated **API-ACME account**, which
+nicmanager restricts to managing only the `_acme-challenge.<zone>` TXT record:
+
+| Module           | Rights                                  |
+| ---------------- | --------------------------------------- |
+| Webfrontend      | –                                       |
+| Account settings | –                                       |
+| Domains          | –                                       |
+| Nameserver       | View, Manage (create, edit, delete)     |
+| Domainsecurity   | –                                       |
+| Other modules    | –                                       |
+
+Because such an account can touch nothing but the challenge record, a leaked
+credential cannot be used to hijack other records, transfer domains, or read
+account data. **Disable two-factor authentication** on the account used for
+automation — the API would otherwise require a rotating TOTP code that cannot be
+provided unattended.
+
+Create an INI file, e.g. `~/.secrets/certbot/nicmanager.ini`:
+
+```ini
+# nicmanager API credentials used by Certbot
+dns_nicmanager_username = mylogin.acmeuser
+# Quote the password if it contains '#' — an unquoted '#' starts an INI comment.
+dns_nicmanager_password = "0123456789abcdef0123456789abcdef"
+
+# Optional. Defaults to https://api.nicmanager.com/v1
+# dns_nicmanager_endpoint = https://api.nicmanager.com/v1
+
+# Optional. Skip zone detection and always use this zone.
+# dns_nicmanager_zone = example.com
+```
+
+The `username` is `login.username` (or the account email). Zone detection works
+without any read access, so `dns_nicmanager_zone` is only needed in unusual
+multi-zone-suffix setups.
+
+The `username` is either `login.username` or the account email address, as
+configured in nicmanager.
+
+Protect this file:
+
+```bash
+chmod 600 ~/.secrets/certbot/nicmanager.ini
+```
+
+## Usage
+
+```bash
+# A single hostname
+certbot certonly \
+  --authenticator dns-nicmanager \
+  --dns-nicmanager-credentials ~/.secrets/certbot/nicmanager.ini \
+  -d example.com
+
+# A wildcard (and the apex)
+certbot certonly \
+  --authenticator dns-nicmanager \
+  --dns-nicmanager-credentials ~/.secrets/certbot/nicmanager.ini \
+  -d 'example.com' -d '*.example.com'
+```
+
+### Command-line arguments
+
+| Argument                                | Description                                                                 | Default |
+| --------------------------------------- | --------------------------------------------------------------------------- | ------- |
+| `--dns-nicmanager-credentials`          | Path to the nicmanager credentials INI file. **(required)**                 | –       |
+| `--dns-nicmanager-propagation-seconds`  | Seconds to wait for DNS propagation before the ACME server checks the record. | `60`    |
+
+## How it works
+
+1. Certbot asks the plugin to create `_acme-challenge.<domain>` with the
+   validation token.
+2. The plugin determines the owning AnycastDNS zone **without reading it** — a
+   restricted API-ACME account cannot read zones. It tries
+   `POST /v1/anycast/<candidate>/records` against each candidate zone
+   (most-specific first); a `403`/`404` skips to the next candidate, the first
+   `2xx` wins. An explicit `dns_nicmanager_zone` short-circuits this. A `401`
+   (genuine auth failure) is surfaced immediately.
+3. nicmanager returns the new record's numeric `id`, which the plugin
+   remembers.
+4. After validation, the plugin removes the record via
+   `DELETE /v1/anycast/<zone>/records/<id>`.
+
+TTL is fixed at the API minimum of **900 seconds**.
+
+> **Heads-up:** the API blocks the IP after too many failed logins. Make sure
+> the password is correct (and any `#` in it is quoted in the INI, see below)
+> before running at scale.
+
+## Troubleshooting
+
+Common failures, decoded (full details in
+[`docs/TROUBLESHOOTING.md`](docs/TROUBLESHOOTING.md)):
+
+| Response | Meaning | Fix |
+| --- | --- | --- |
+| `401 Authentication error` | Wrong username form or password | Match the username to the account's auth method: **email** for "E-Mail + Passwort" accounts, `login.username` otherwise. Disable 2FA. |
+| `403 API usage not allowed` | Auth OK — API access not enabled | Ask nicmanager support to enable API access for the account. |
+| `401 Too many invalid attempts` / no response (`000`) | IP rate-limited / firewall-blocked after failed logins | Stop and wait. **Never** loop over credential variants — it locks the IP. |
+
+Key gotchas: the username form depends on the account's **active authentication
+method** (email vs `login.username`); **2FA must be off**; a `#` in the password
+must be **quoted** in the INI; and the restricted API-ACME account **cannot read
+zones** (this plugin resolves the zone by create-attempt instead).
+
+## Development
+
+```bash
+git clone https://github.com/jp1337/certbot-dns-nicmanager
+cd certbot-dns-nicmanager
+python -m venv .venv && . .venv/bin/activate
+pip install -e '.[test,dev]'
+
+pytest          # run the test suite
+ruff check .    # lint
+mypy certbot_dns_nicmanager
+```
+
+For the design and the reasoning behind it, see
+[`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) and the Architecture Decision
+Records in [`docs/decisions/`](docs/decisions/) (DNS-01-only, zone resolution
+without zone reads, and the basic-auth username / cleanup-by-id decisions).
+
+## License
+
+[Apache License 2.0](LICENSE.txt)
+
+This is an independent, community-maintained plugin and is not affiliated with
+or endorsed by InterNexum GmbH / nicmanager or the EFF / Certbot project.