# certbot-dns-corenetworks

Core Networks DNS Authenticator plugin for Certbot

This plugin automates the process of completing a `dns-01` challenge by creating, and subsequently removing, TXT records using the Core Networks beta API.

## Requirements

- Python >= 3.10
- certbot >= 2.0.0

## Configuration of Core Networks

In the `Allgemein -> Profil -> API-Benutzer` you have to have a user with a login name and password.

See [Core Networks API Documentation](https://beta.api.core-networks.de/doc/) for more information.

## Installation

### Using pip

```bash
pip install certbot-dns-corenetworks
```

### From source

```bash
git clone https://git.hogertz.eu/hendrik-hog/certbot-dns-corenetworks.git
cd certbot-dns-corenetworks
uv sync
```

## Named Arguments

To start using DNS authentication for Core Networks, pass the following arguments on certbot's command line:

| Argument                                 | Description                                                                                                                |
| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `--authenticator dns-corenetworks`       | Select the authenticator plugin (Required)                                                                                 |
| `--dns-corenetworks-credentials`         | Core Networks credentials INI file (Required)                                                                              |
| `--dns-corenetworks-propagation-seconds` | Waiting time for DNS to propagate before asking the ACME server to verify the DNS record (Default: 30, Recommended: >= 60) |

## Credentials

An example `credentials.ini` file:

```ini
dns_corenetworks_username = myremoteuser
dns_corenetworks_password = verysecureremoteuserpassword
```

The path to this file can be provided interactively or using the `--dns-corenetworks-credentials` command-line argument. Certbot records the path to this file for use during renewal, but does not store the file's contents.

**CAUTION:** You should protect these API credentials as you would the password to your Core Networks account. Users who can read this file can use these credentials to issue arbitrary API calls on your behalf. Users who can cause Certbot to run using these credentials can complete a `dns-01` challenge to acquire new certificates or revoke existing certificates for associated domains, even if those domains aren't being managed by this server.

Certbot will emit a warning if it detects that the credentials file can be accessed by other users on your system. The warning reads "Unsafe permissions on credentials configuration file", followed by the path to the credentials file. This warning will be emitted each time Certbot uses the credentials file, including for renewal, and cannot be silenced except by addressing the issue (e.g., by using a command like `chmod 600` to restrict access to the file).

## Examples

### Acquire a certificate for a domain

To acquire a single certificate for `example.com`:

```bash
certbot certonly \
  --authenticator dns-corenetworks \
  --dns-corenetworks-credentials /etc/letsencrypt/.secrets/corenetworks.ini \
  --dns-corenetworks-propagation-seconds 60 \
  --server https://acme-v02.api.letsencrypt.org/directory \
  --agree-tos \
  --rsa-key-size 4096 \
  -d example.com
```

### Acquire a wildcard certificate

To acquire a certificate for both `example.com` and `*.example.com`, waiting 60 seconds for DNS propagation:

```bash
certbot certonly \
  --authenticator dns-corenetworks \
  --dns-corenetworks-credentials /etc/letsencrypt/.secrets/corenetworks.ini \
  --dns-corenetworks-propagation-seconds 60 \
  --server https://acme-v02.api.letsencrypt.org/directory \
  --agree-tos \
  --rsa-key-size 4096 \
  -d 'example.com' \
  -d '*.example.com'
```

## Development

### Setup development environment

```bash
# Clone the repository
git clone https://git.hogertz.eu/hendrik-hog/certbot-dns-corenetworks.git
cd certbot-dns-corenetworks
uv sync
```

### Running tests

```bash
# Run tests with pytest
pytest

# Run tests with coverage
pytest --cov=certbot_dns_corenetworks --cov-report=html
```

## License

Apache License 2.0 - See LICENSE.txt for details

## Credits

Original author: Masin Al-Dujaili  
Maintainer: Hendrik Hogertz