|
| 1 | +# shimkit 0.17.0 |
| 2 | + |
| 3 | +`shimkit tls --method dns-route53` — AWS Route53 DNS-01 alongside |
| 4 | +the v0.13.0 Cloudflare path. Second DNS-01 provider. For the full |
| 5 | +machine-readable changelog, see |
| 6 | +[`CHANGELOG.md`](../../CHANGELOG.md). |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +## TL;DR |
| 11 | + |
| 12 | +``` |
| 13 | +shimkit tls request --method dns-route53 --credentials FILE -d ... |
| 14 | +``` |
| 15 | + |
| 16 | +Uses `certbot/dns-route53:v3.0.1` (auto-selected). Cloudflare path |
| 17 | +still uses `certbot/dns-cloudflare:v3.0.1`; webroot still uses |
| 18 | +`certbot/certbot:v3.0.1`. The three image families are |
| 19 | +independent — pin each via its own `tools.tls.certbot_*_image` |
| 20 | +config field. |
| 21 | + |
| 22 | +--- |
| 23 | + |
| 24 | +## Why Route53 |
| 25 | + |
| 26 | +After Cloudflare, AWS Route53 is the most-common ACME DNS-01 |
| 27 | +provider in the wild. Adding it covers the two providers most |
| 28 | +teams actually use; other providers (DigitalOcean, Hurricane |
| 29 | +Electric, Google Cloud DNS, etc.) follow the same pattern and |
| 30 | +can be added in future minor releases. |
| 31 | + |
| 32 | +DNS-01 is the only ACME path that supports wildcards |
| 33 | +(`*.example.com`). |
| 34 | + |
| 35 | +--- |
| 36 | + |
| 37 | +## Setup |
| 38 | + |
| 39 | +1. **Create an IAM key** with the minimum scope: |
| 40 | + |
| 41 | + ```json |
| 42 | + { |
| 43 | + "Statement": [ |
| 44 | + { |
| 45 | + "Effect": "Allow", |
| 46 | + "Action": [ |
| 47 | + "route53:ListHostedZones", |
| 48 | + "route53:GetChange", |
| 49 | + "route53:ChangeResourceRecordSets" |
| 50 | + ], |
| 51 | + "Resource": "*" |
| 52 | + } |
| 53 | + ] |
| 54 | + } |
| 55 | + ``` |
| 56 | + |
| 57 | +2. **Write the credentials file** — standard AWS format: |
| 58 | + |
| 59 | + ```ini |
| 60 | + [default] |
| 61 | + aws_access_key_id = AKIAIOSFODNN7EXAMPLE |
| 62 | + aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY |
| 63 | + ``` |
| 64 | + |
| 65 | + ```bash |
| 66 | + chmod 600 ~/.shimkit/data/tls/aws-credentials |
| 67 | + ``` |
| 68 | + |
| 69 | +3. **Issue the cert** (staging first): |
| 70 | + |
| 71 | + ```bash |
| 72 | + shimkit tls request --yes --staging \ |
| 73 | + --email ops@example.com \ |
| 74 | + --method dns-route53 \ |
| 75 | + --credentials ~/.shimkit/data/tls/aws-credentials \ |
| 76 | + -d example.com -d '*.example.com' |
| 77 | + ``` |
| 78 | + |
| 79 | +--- |
| 80 | + |
| 81 | +## How it differs from Cloudflare |
| 82 | + |
| 83 | +The Route53 plugin reads `~/.aws/credentials` via boto3 — there's |
| 84 | +no `--dns-route53-credentials` flag like Cloudflare has. shimkit |
| 85 | +handles this transparently: |
| 86 | + |
| 87 | +| | Cloudflare | Route53 | |
| 88 | +|---|---|---| |
| 89 | +| Container image | `certbot/dns-cloudflare:v3.0.1` | `certbot/dns-route53:v3.0.1` | |
| 90 | +| Credentials file format | `dns_cloudflare_api_token = <token>` | AWS `[default]` ini | |
| 91 | +| Mount target inside container | parent dir at `/credentials` | file at `/root/.aws/credentials` | |
| 92 | +| Certbot flag | `--dns-cloudflare-credentials /credentials/cloudflare.ini` | (none — boto3 finds it) | |
| 93 | +| Mode 0600 enforced | yes | yes | |
| 94 | + |
| 95 | +The same `--credentials` CLI flag works for both methods; shimkit |
| 96 | +detects which provider and mounts accordingly. |
| 97 | + |
| 98 | +--- |
| 99 | + |
| 100 | +## Renewal |
| 101 | + |
| 102 | +Same as Cloudflare and webroot: |
| 103 | + |
| 104 | +```bash |
| 105 | +shimkit tls renew --yes |
| 106 | +``` |
| 107 | + |
| 108 | +certbot reads `/etc/letsencrypt/renewal/<domain>.conf` per cert |
| 109 | +(written at issuance time) and reuses the same method. The daily |
| 110 | +renewal cron from v0.8.0 covers all three methods. |
| 111 | + |
| 112 | +--- |
| 113 | + |
| 114 | +## Config |
| 115 | + |
| 116 | +```json |
| 117 | +{ |
| 118 | + "tools": { |
| 119 | + "tls": { |
| 120 | + "certbot_dns_route53_image": "certbot/dns-route53:v3.0.1", |
| 121 | + "route53_propagation_seconds": 60 |
| 122 | + } |
| 123 | + } |
| 124 | +} |
| 125 | +``` |
| 126 | + |
| 127 | +Pin the image to a specific version if you don't want auto- |
| 128 | +updates. Lower `route53_propagation_seconds` if Route53 propagates |
| 129 | +fast in your account (often 10-30s in practice). |
| 130 | + |
| 131 | +--- |
| 132 | + |
| 133 | +## Stats |
| 134 | + |
| 135 | +- Tests: 1116 → 1130 (+14) |
| 136 | +- Gates: pytest, ruff, mypy strict — all green |
| 137 | +- New optional extras: 0 |
| 138 | + |
| 139 | +--- |
| 140 | + |
| 141 | +## Upgrading |
| 142 | + |
| 143 | +```bash |
| 144 | +uv tool upgrade shimkit |
| 145 | +pipx upgrade shimkit |
| 146 | +``` |
| 147 | + |
| 148 | +Existing webroot + Cloudflare users see no behavioural change. To |
| 149 | +start using Route53, set up the IAM key + credentials file then |
| 150 | +pass `--method dns-route53 --credentials`. |
0 commit comments