Compare commits
40
Commits
v0.4.1-rc.1
...
v0.6.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
48f0082d8b | ||
|
|
d4399cf630 | ||
|
|
d2a25d654d | ||
|
|
87368c4aaf | ||
|
|
7d93c373d1 | ||
|
|
e94d3634b6 | ||
|
|
a8c7760fc8 | ||
|
|
5443e95897 | ||
|
|
ea26171875 | ||
|
|
250e734046 | ||
|
|
1b102a78f6 | ||
|
|
01ec37b9b2 | ||
|
|
fef916b7ab | ||
|
|
bfab83da6e | ||
|
|
304c89dba4 | ||
|
|
b1719ce362 | ||
|
|
ec16de875d | ||
|
|
b24c730b97 | ||
|
|
aa4b004a14 | ||
|
|
a3b054cc86 | ||
|
|
c27a6c10bd | ||
|
|
d33f573782 | ||
|
|
13ffd8cad4 | ||
|
|
67ae0091b3 | ||
|
|
c7e5bbb628 | ||
|
|
740f3cc328 | ||
|
|
5fcf4082c9 | ||
|
|
1cec6cc393 | ||
|
|
921bdd6c95 | ||
|
|
12820b17bb | ||
|
|
ead749dd3d | ||
|
|
66dcf53684 | ||
|
|
ebd3a3dfbe | ||
|
|
fd0cbb47a9 | ||
|
|
057433c198 | ||
|
|
6313fa51f8 | ||
|
|
88f63ffb0a | ||
|
|
88965096bb | ||
|
|
bad360107e | ||
|
|
bdd7acfd3b |
No files matched your search
@@ -3,3 +3,5 @@
|
|||||||
*.db
|
*.db
|
||||||
*.db-wal
|
*.db-wal
|
||||||
*.db-shm
|
*.db-shm
|
||||||
|
/jarl
|
||||||
|
/jarld
|
||||||
+280
@@ -6,14 +6,222 @@ All notable changes to Jarl are documented here. The format follows
|
|||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
|
## [0.6.0] - 2026-10-13
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Reverse zones made easy (docs/reverse.md):
|
||||||
|
- **Missing reverse zones**: the Zones page and `jarl zone
|
||||||
|
suggest-reverse` list the reverse zones the private views lack for
|
||||||
|
their A and AAAA records' addresses: the /24 of a private IPv4 network,
|
||||||
|
a /32 for a public address (the rest of its /24 belongs to others),
|
||||||
|
the /48 of IPv6 addresses. Create one, or all (`--create`), filled.
|
||||||
|
- **Fill**: `jarl zone create 10.0.10.0/24 --fill` (ticked in the New
|
||||||
|
zone dialog) adds a PTR record for each address the view's records use
|
||||||
|
there; `jarl zone fill-ptr` and the reverse zone's page add the ones
|
||||||
|
missing later. An address with several names gets its mail or name
|
||||||
|
server's name, else a host's.
|
||||||
|
- **The right view**: a reverse zone created without a view goes to the
|
||||||
|
private view whose records use its addresses.
|
||||||
|
- **PTR records kept in step** per zone (`jarl zone update ZONE
|
||||||
|
--auto-ptr`, zone settings → Reverse DNS): adding, changing,
|
||||||
|
disabling or deleting an A or AAAA record does the same to its PTR
|
||||||
|
record, as the Update PTR box does for one change.
|
||||||
|
- Suggestions come in two groups: **yours** (private networks, a ULA or
|
||||||
|
an IPv6 /48 this server has an address in), which Create all
|
||||||
|
creates, and **public addresses**, each a /32 or /128 to create only
|
||||||
|
if it is yours (not a web host's) or **Dismiss**. A view can turn
|
||||||
|
suggestions off (`jarl view update vps --reverse-suggestions=false`),
|
||||||
|
e.g. one only a VPS uses.
|
||||||
|
- A zone created inside another in the same view (a /24 inside a /8,
|
||||||
|
`lab.adbraun.lol` inside `adbraun.lol`) takes the parent's records
|
||||||
|
under it, which named would no longer serve from the parent; a
|
||||||
|
delegation and its glue stay.
|
||||||
|
- Zone commands take a network for a reverse zone: `jarl zone show
|
||||||
|
10.0.10.0/24`.
|
||||||
|
- **New reverse zone** (Zones page) lists the networks your records use
|
||||||
|
without a reverse zone, in every view, also where nothing is suggested
|
||||||
|
(suggestions off, dismissed, public views); pick one, change its size
|
||||||
|
(/48, /56, /64, /128 for IPv6, around the records' address) and create
|
||||||
|
it filled. With a view chosen, it also lists the addresses only other
|
||||||
|
views' records use, and fill names them from there (a VPS's AAAA in
|
||||||
|
external, its PTR in internal). `jarl zone suggest-reverse --all
|
||||||
|
[--view V]`. Both lists have a search, so hundreds of addresses stay
|
||||||
|
manageable: the public addresses fold away, show 25 at a time, and
|
||||||
|
**Dismiss these N** dismisses everything a search found in one change
|
||||||
|
(`--dismiss` takes several networks).
|
||||||
|
- Encrypted DNS: **several host names** (one certificate for all; the
|
||||||
|
health check says when the served certificate misses one), and **each
|
||||||
|
listen address gets its own views** for the host names' records
|
||||||
|
(`--address 10.0.10.5=internal`, a view checkbox per address in the
|
||||||
|
form), local to the view, with a warning when a public view would get
|
||||||
|
a private address. A view no longer ticked loses the address. The form
|
||||||
|
starts from where the records are now. The Certificates page and `jarl
|
||||||
|
cert show` say what named uses a certificate for (DNS over TLS or HTTPS,
|
||||||
|
on which addresses and ports).
|
||||||
|
- docs/encrypted-dns.md: forwarding to Quad9 or Cloudflare over TLS, how to
|
||||||
|
check it works, and why not over HTTPS.
|
||||||
|
- Comparing one name across views: `jarl zone diff adbraun.lol nas [A]`,
|
||||||
|
and a **Compare** button on each record.
|
||||||
|
|
||||||
|
- **Exploring the statistics**: jarld keeps every answer for a while
|
||||||
|
(`stats.retention.queries`, default 7 days), and every client, name,
|
||||||
|
view, record type, result and blocklist on the Statistics page leads to
|
||||||
|
an explore page for it: answers over time, the top clients, names,
|
||||||
|
views, types, results and blocklists among them (each a link that
|
||||||
|
narrows it further), and the latest answers. "NXDOMAIN in external" →
|
||||||
|
the clients asking → everything one of them asks. A filter bar types
|
||||||
|
filters in, several values each (any of them), `!value` to leave one
|
||||||
|
out and `*.example.com` for a domain and below; **hide** on a list entry
|
||||||
|
leaves it out. **Explore the answers** opens the page from the
|
||||||
|
Statistics page. `GET /stats/explore`.
|
||||||
|
- **Storage** on the dashboard: the size of Jarl's databases (and how many
|
||||||
|
answers the query log holds), and per disk Jarl uses a bar of how full it
|
||||||
|
is and how much of it the databases take. The Statistics page shows the
|
||||||
|
statistics database's size too, and its disk tiles get the same bar.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- `jarl option set tls NAME …` (and `key`, `remote-servers`, `http`,
|
||||||
|
`dnssec-policy`, `server` …) replaces only the statement with that name:
|
||||||
|
setting `tls cloudflare` used to replace `tls quad9`. `jarl option unset
|
||||||
|
tls cloudflare` removes one by its name.
|
||||||
|
- **Compare views** and `jarl zone diff` are rebuilt around the view
|
||||||
|
you're on (docs/views.md#comparing-views): a summary per view, then
|
||||||
|
what is answered differently (a view's own records in linked zones,
|
||||||
|
drift otherwise) with **Use this everywhere**, the names only some
|
||||||
|
views have, grouped, with **Add to VIEW**, and how many are the same.
|
||||||
|
One line per record: the CLI cuts long TXT records to the terminal
|
||||||
|
(`--wide` shows them whole). `--with` picks the views to compare with.
|
||||||
|
`GET /zones/{zone}/compare` returns these sections instead of `rows`.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Encrypted DNS: the client hints tested with kdig (Knot's, often not
|
||||||
|
installed) and with curl's JSON API, which named's DoH doesn't speak;
|
||||||
|
they use BIND's `dig +tls` / `dig +https` now.
|
||||||
|
- Server options → Added by Jarl: long statements didn't wrap, and the
|
||||||
|
browser console reported a Content Security Policy violation (an inline
|
||||||
|
style the page's policy blocks).
|
||||||
|
|
||||||
|
### Upgrading from 0.5
|
||||||
|
|
||||||
|
- Tested: 0.5.2 packages with views, a linked zone, a reverse zone,
|
||||||
|
blocking, a `tls` statement and statistics, upgraded in place in Debian
|
||||||
|
13 (BIND 9.20.29): everything kept and answered as before, the new
|
||||||
|
features worked on the upgraded data, and a 0.5.2 backup restored.
|
||||||
|
- The database gets two new versions (12 and 13), applied when jarld
|
||||||
|
starts; a 0.5 jarld can't open it afterwards, so take a backup first (`sudo
|
||||||
|
jarld backup`). Nothing changes until you turn `auto_ptr` on for a
|
||||||
|
zone.
|
||||||
|
- The statistics database gets a new version too (the query log); 0.5
|
||||||
|
can't open it afterwards either. It starts empty and fills from then on.
|
||||||
|
|
||||||
|
## [0.5.2] - 2026-10-12
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Mail reverse DNS check: the addresses of the public zones' MX hosts and
|
||||||
|
SPF records are looked up as the internet sees them, every 6 hours: a
|
||||||
|
PTR record whose name resolves back to the address, which Gmail and
|
||||||
|
Outlook require. It says who runs the reverse zone (your provider) and
|
||||||
|
what to set there, and notes when Jarl has its own reverse zone for the
|
||||||
|
address, which only your clients see. The Exposure page (Check now),
|
||||||
|
`jarl exposure mail` and Prometheus `jarl_mail_reverse_dns_ok`.
|
||||||
|
- Added by Jarl: the Server options page, `jarl option generated` and
|
||||||
|
`GET /options/generated` list what Jarl writes into named.conf by
|
||||||
|
itself (keys.conf, the statistics channel and logging, blocking's
|
||||||
|
response-policy, the view keys), why, and what controls each.
|
||||||
|
- `stats.rate_limit_log` (default true): `false` stops Jarl adding named's
|
||||||
|
`query-errors` category to its log channel when rate limiting is set.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- Option values with a list of three or more elements (allow-query,
|
||||||
|
forwarders, listen-on, ...) are shown one element per line.
|
||||||
|
|
||||||
|
## [0.5.1] - 2026-10-12
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Encrypted DNS health: jarld checks the DoT and DoH listeners every 10
|
||||||
|
minutes as a client would (the certificate is for the host name,
|
||||||
|
current and the one Jarl last wrote; a question gets an answer) and
|
||||||
|
says what is wrong: nothing listening, a firewall, the wrong or an
|
||||||
|
older certificate. On the Encrypted DNS page (Check now), the
|
||||||
|
dashboard, `jarl encrypted-dns health` and Prometheus
|
||||||
|
`jarl_encrypted_dns_up`.
|
||||||
|
- Comparing a zone's views: the Compare views tab and `jarl zone diff`
|
||||||
|
show the names and types that differ between the views that have a
|
||||||
|
zone, linked or not, with "Use this version" to share one view's
|
||||||
|
version. `GET /zones/{zone}/compare`.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- `--local` (and `"local": true`) works on zones that aren't linked too:
|
||||||
|
their records are local anyway. `--shared` there is still refused.
|
||||||
|
- When `certificates.dir` changes, jarld points the `tls` statements
|
||||||
|
encrypted DNS wrote at the new place when it starts; named kept the old
|
||||||
|
copies before, which renewals no longer updated.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Sharing a view's version of a name that was shared already (Use this
|
||||||
|
version on the shared side) didn't replace another view's override; it
|
||||||
|
said there was nothing to do.
|
||||||
|
|
||||||
|
## [0.5.0] - 2026-10-12
|
||||||
|
|
||||||
### Upgrading from 0.4
|
### Upgrading from 0.4
|
||||||
|
|
||||||
|
- The database gets three new versions (internet exposure, certificates,
|
||||||
|
linked zones), applied when jarld starts; a 0.4 jarld can't open it
|
||||||
|
afterwards, so take a backup first (`sudo jarld backup`). Backups made
|
||||||
|
by 0.4 restore into this version. Tested: 0.4.0 packages with views,
|
||||||
|
zones, records, blocking and statistics, upgraded in place and
|
||||||
|
restored from a 0.4.0 backup.
|
||||||
|
|
||||||
|
- Statistics per view start with this version: earlier figures are for
|
||||||
|
all views together.
|
||||||
|
|
||||||
|
- New exposure warnings (docs/exposure.md) appear for views reachable from
|
||||||
|
the internet, e.g. "no rate-limit" or "version visible" on an external
|
||||||
|
view: fix them from the Exposure page, or acknowledge them. A change
|
||||||
|
that newly opens a public view up (an open resolver, say) now needs
|
||||||
|
`--accept-risk`, or the checkbox on the Changes page.
|
||||||
|
|
||||||
- Once you use address ranges, the database can't go back to 0.4: its
|
- Once you use address ranges, the database can't go back to 0.4: its
|
||||||
parser doesn't know them. Remove the ranges first if you need to
|
parser doesn't know them. Remove the ranges first if you need to
|
||||||
downgrade.
|
downgrade.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- The web UI's top bar had grown too long, and the user name, Users and
|
||||||
|
Log out ended up on a second line on the left. The server's
|
||||||
|
configuration and security pages (Server options, ACLs, TSIG keys,
|
||||||
|
Exposure, Certificates, Encrypted DNS, Audit log) are now in a
|
||||||
|
**Server** menu, and Account, Users and Log out in a menu under your
|
||||||
|
name. On narrow screens the search box and your name stay together on
|
||||||
|
the right.
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
|
- "update PTR" when editing a record (`jarl record update ID --ptr`) did
|
||||||
|
nothing unless the name or address changed too, and the web UI didn't
|
||||||
|
even send it alone: a reverse zone created after the record never got
|
||||||
|
its PTR. Alone, it now adds the PTR record if it is missing (or enables
|
||||||
|
it). For records of linked zones, the reverse zones of every linked view
|
||||||
|
count, not only the record's own view.
|
||||||
|
|
||||||
|
- Option values in the web UI looked different from the editor: a long
|
||||||
|
line wrapped back to the left edge, losing its indentation, and the
|
||||||
|
column changed width when Edit opened. Values now keep their layout
|
||||||
|
(a long line scrolls), with the same width and padding as the editor.
|
||||||
|
The "{ } around the list are optional" hint only shows for options that
|
||||||
|
end in a list (not rate-limit, which only has one inside).
|
||||||
|
- Query statistics skipped every query signed with a TSIG key (named
|
||||||
|
writes "/key NAME" after the client's port), such as queries with a
|
||||||
|
view's key: they are counted now.
|
||||||
- A changeset with a staged record delete could not be applied after that
|
- A changeset with a staged record delete could not be applied after that
|
||||||
record was deleted elsewhere (e.g. with the CLI), and it was hard to see
|
record was deleted elsewhere (e.g. with the CLI), and it was hard to see
|
||||||
which operation to remove: the error only said "record 832 does not
|
which operation to remove: the error only said "record 832 does not
|
||||||
@@ -25,6 +233,78 @@ All notable changes to Jarl are documented here. The format follows
|
|||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
|
- Statistics per view ([docs/stats.md](docs/stats.md#views)): the
|
||||||
|
Statistics page has a toggle per view, with All and None, remembered in
|
||||||
|
the browser, to see some views only or several together (linked views,
|
||||||
|
say). Answers, result codes, record types, zones, blocking, rate
|
||||||
|
limiting and the top lists follow it; named's own counters stay for the
|
||||||
|
whole server, and the page says so. `jarl stats --view`, API
|
||||||
|
`?views=`. Per-view figures start with this version.
|
||||||
|
- DNS over TLS and HTTPS ([docs/encrypted-dns.md](docs/encrypted-dns.md)):
|
||||||
|
`jarl encrypted-dns setup --hostname NAME --address ADDR` (and the
|
||||||
|
Encrypted DNS page) obtains a certificate for the host name if needed,
|
||||||
|
checks that nothing else listens on port 853 and the DoH port (443 by
|
||||||
|
default) at those addresses, offering a free port, and stages named's
|
||||||
|
`tls` statement and listeners as one change, keeping port 53 where it
|
||||||
|
was, plus the host name's records in your private views (local to the
|
||||||
|
view in a linked zone). The page and `jarl encrypted-dns` say what to
|
||||||
|
give Android, Linux, Firefox, Chrome and Windows. A `tls` statement whose
|
||||||
|
files are missing is refused (`tls_file_missing`), and a certificate
|
||||||
|
named uses can't be deleted.
|
||||||
|
- Linked zones ([docs/views.md](docs/views.md#linked-zones)): zones of the
|
||||||
|
same name in different views can be linked, and Jarl keeps their shared
|
||||||
|
records in step: a change in one view reaches the others in the same
|
||||||
|
changeset (diff, permissions, history and undo cover every view). Each
|
||||||
|
view can still have records of its own (`--local`, "Only here"), which
|
||||||
|
override the shared records of that name and type there, and keeps its
|
||||||
|
own zone options. Linking existing zones changes no answer: what is the
|
||||||
|
same everywhere becomes shared, the rest stays local, and a view's
|
||||||
|
version can be shared later (`--shared`, "Share"). `jarl zone link` and
|
||||||
|
`unlink`, `zone create --link-with VIEW`, `record add|set|update
|
||||||
|
--local|--shared`, a LINK column in `record list`, "Keep them linked"
|
||||||
|
when copying a zone in the web UI, `POST /zones/{zone}/link` and
|
||||||
|
`/unlink`. ACME challenges are written once per link, and `--view all`
|
||||||
|
changes a link once.
|
||||||
|
- TLS certificates ([docs/certificates.md](docs/certificates.md)): Jarl
|
||||||
|
obtains certificates from Let's Encrypt or any ACME CA (account set up
|
||||||
|
in jarl.yaml under `acme.account`) and renews them itself, from the CA's
|
||||||
|
renewal information (ARI) or two thirds into their lifetime, with
|
||||||
|
back-off after failures. It answers the DNS-01 challenges in a zone it
|
||||||
|
serves, or through Porkbun's DNS API while Porkbun serves the domain;
|
||||||
|
`auto` decides from the domain's public name servers at every renewal,
|
||||||
|
so moving the domain to your own name servers needs no change. A CNAME
|
||||||
|
on `_acme-challenge` into a zone Jarl serves is followed, for domains
|
||||||
|
hosted elsewhere. A certificate is used for jarld's HTTPS ("web") and/or
|
||||||
|
written for named (`<bind.config_dir>/tls/NAME/`, "dns"; named rereads
|
||||||
|
it on renewal), and certificates you renew yourself can be used too
|
||||||
|
(reread when their files change). Certificates page and dashboard card
|
||||||
|
in the web UI, `jarl cert` (check, create, issue, update, delete,
|
||||||
|
account), `/api/v1/certificates`, Prometheus
|
||||||
|
`jarl_certificate_expiry_timestamp_seconds`, `jarl_certificate_failing`.
|
||||||
|
- jarld serves HTTPS and plain HTTP on the same ports once it has a
|
||||||
|
certificate (`tls.cert_file`, or one with the web use, which takes
|
||||||
|
effect without a restart): plain HTTP from the server itself and from
|
||||||
|
trusted proxies is served as before, browsers elsewhere are redirected
|
||||||
|
to HTTPS and API requests get `https_required`. Before, with
|
||||||
|
`tls.cert_file`, plain HTTP got an error even from localhost.
|
||||||
|
- Internet exposure ([docs/exposure.md](docs/exposure.md)): Jarl works out
|
||||||
|
which views are reachable from the internet (match-clients ending in a
|
||||||
|
catch-all; for a server without views, open allow-query and a
|
||||||
|
non-private listen address), with a per-view override, and checks them:
|
||||||
|
response rate limiting, open resolvers, ANY answers (minimal-any), cache
|
||||||
|
snooping, open NOTIFY and zone transfers, BIND version and host name,
|
||||||
|
management interfaces. Fixes are staged like any change, including
|
||||||
|
response rate limiting from ISC's example in log-only mode, with your
|
||||||
|
secondaries exempt, and a later "start enforcing". With statistics on,
|
||||||
|
Jarl reads named's rate limiting log lines and shows what was (or would
|
||||||
|
have been) limited: counts, client networks and names (Exposure page,
|
||||||
|
`jarl stats breakdown rrl`, top lists `ratelimited`, Prometheus
|
||||||
|
`jarl_ratelimit_logged_total`). A change that newly opens a public view
|
||||||
|
up must be confirmed (checkbox on the Changes page, `--accept-risk`, API
|
||||||
|
`accept_risk`; 409 `confirm_risk` otherwise). Findings can be
|
||||||
|
acknowledged with a reason: they stay visible as info, with who, when
|
||||||
|
and why. Exposure page and dashboard card in the web UI, `jarl
|
||||||
|
exposure` (fix, ack, unack), `GET /exposure`.
|
||||||
- `jarl changeset show`, `diff`, `apply`, `discard` and `remove` take the
|
- `jarl changeset show`, `diff`, `apply`, `discard` and `remove` take the
|
||||||
changeset from `-C` or `JARL_CHANGESET` when no ID is given
|
changeset from `-C` or `JARL_CHANGESET` when no ID is given
|
||||||
(`jarl changeset apply`). A changeset from `JARL_CHANGESET` is now
|
(`jarl changeset apply`). A changeset from `JARL_CHANGESET` is now
|
||||||
|
|||||||
@@ -25,7 +25,8 @@ error: www.adbraun.lol has a CNAME, so it can't have any other records (found A)
|
|||||||
## Features
|
## Features
|
||||||
|
|
||||||
* **Everything in one place**: primary, secondary, forward, stub, mirror,
|
* **Everything in one place**: primary, secondary, forward, stub, mirror,
|
||||||
hint, redirect and in-view zones, reverse zones from a CIDR, split DNS with
|
hint, redirect and in-view zones, reverse zones from a CIDR (suggested,
|
||||||
|
filled and kept in step from your A records), split DNS with
|
||||||
views, ACLs, TSIG keys, and every BIND 9.20 option at server, view, zone
|
views, ACLs, TSIG keys, and every BIND 9.20 option at server, view, zone
|
||||||
and top level, with the ARM's description and grammar built in.
|
and top level, with the ARM's description and grammar built in.
|
||||||
* **Safe changes.** Every change is validated as a whole (CNAME rules,
|
* **Safe changes.** Every change is validated as a whole (CNAME rules,
|
||||||
@@ -71,6 +72,14 @@ error: www.adbraun.lol has a CNAME, so it can't have any other records (found A)
|
|||||||
queries, record types, cache hit rate. Shown in the web UI and the CLI,
|
queries, record types, cache hit rate. Shown in the web UI and the CLI,
|
||||||
and exportable as JSON. Stored as aggregates in a separate database with
|
and exportable as JSON. Stored as aggregates in a separate database with
|
||||||
retention you set.
|
retention you set.
|
||||||
|
* **Internet exposure checks**: Jarl works out which views are reachable
|
||||||
|
from the internet (a GUA-addressed internal network still counts as
|
||||||
|
yours) and checks them: response rate limiting (set up in log-only mode
|
||||||
|
first, with what it would limit shown before you enforce it), open
|
||||||
|
resolvers, ANY amplification, cache snooping, version and host name
|
||||||
|
leaks, open management interfaces. Fixes are staged for review, changes
|
||||||
|
that open a public view up must be confirmed, and deliberate exceptions
|
||||||
|
can be acknowledged with a reason.
|
||||||
* **Prometheus metrics** (optional): health to alert on (named down,
|
* **Prometheus metrics** (optional): health to alert on (named down,
|
||||||
configuration problems, drift, failing blocklists, stale backups, DNSSEC
|
configuration problems, drift, failing blocklists, stale backups, DNSSEC
|
||||||
steps waiting at the parent, expiring tokens) and query counters per
|
steps waiting at the parent, expiring tokens) and query counters per
|
||||||
@@ -83,6 +92,18 @@ error: www.adbraun.lol has a CNAME, so it can't have any other records (found A)
|
|||||||
* **Let's Encrypt DNS-01** built in: `jarl acme` plus certbot, acme.sh and lego
|
* **Let's Encrypt DNS-01** built in: `jarl acme` plus certbot, acme.sh and lego
|
||||||
hooks, an HTTPS-only endpoint for lego's and Traefik's `httpreq` provider,
|
hooks, an HTTPS-only endpoint for lego's and Traefik's `httpreq` provider,
|
||||||
and CNAME delegation to a dedicated ACME zone.
|
and CNAME delegation to a dedicated ACME zone.
|
||||||
|
* **Certificates for the server itself**: Jarl obtains and renews TLS
|
||||||
|
certificates from Let's Encrypt (or any ACME CA), answering the DNS-01
|
||||||
|
challenge in its own zones or through Porkbun's API while Porkbun still
|
||||||
|
serves the domain, decided at every renewal. Use them for the web UI
|
||||||
|
(HTTPS without a restart) and for named's DNS over TLS and HTTPS (named
|
||||||
|
rereads them on renewal), or bring your own.
|
||||||
|
* **DNS over TLS and HTTPS** for your own devices in one step: the
|
||||||
|
certificate, named's listeners on the addresses you choose (after
|
||||||
|
checking the ports are free) and the host name in your private views.
|
||||||
|
* **Linked zones for split DNS**: the same zone in several views, with the
|
||||||
|
shared records kept in step by Jarl and a few records of each view's own
|
||||||
|
(an internal address for a public name, say).
|
||||||
* **Adopts an existing server**: imports named.conf and zone files
|
* **Adopts an existing server**: imports named.conf and zone files
|
||||||
(comments included), then switches named over with an automatic
|
(comments included), then switches named over with an automatic
|
||||||
fallback.
|
fallback.
|
||||||
@@ -124,7 +145,11 @@ in `/etc/jarl/jarl.yaml` to reach it from your management network.
|
|||||||
| [docs/views.md](docs/views.md) | Split DNS: adding views to a server that has none |
|
| [docs/views.md](docs/views.md) | Split DNS: adding views to a server that has none |
|
||||||
| [docs/dnssec.md](docs/dnssec.md) | DNSSEC signing, going public with your own name servers, Porkbun |
|
| [docs/dnssec.md](docs/dnssec.md) | DNSSEC signing, going public with your own name servers, Porkbun |
|
||||||
| [docs/acme.md](docs/acme.md) | Let's Encrypt DNS-01 with certbot, acme.sh, lego and Traefik |
|
| [docs/acme.md](docs/acme.md) | Let's Encrypt DNS-01 with certbot, acme.sh, lego and Traefik |
|
||||||
|
| [docs/encrypted-dns.md](docs/encrypted-dns.md) | DNS over TLS and HTTPS for your clients: setup, ports, client settings |
|
||||||
|
| [docs/certificates.md](docs/certificates.md) | TLS certificates Jarl obtains and renews for its web UI and named's DNS over TLS/HTTPS |
|
||||||
| [docs/stats.md](docs/stats.md) | Query statistics: enabling, what is collected, retention |
|
| [docs/stats.md](docs/stats.md) | Query statistics: enabling, what is collected, retention |
|
||||||
|
| [docs/reverse.md](docs/reverse.md) | Reverse zones: suggested from your records, created in the right view and filled, PTR records kept in step |
|
||||||
|
| [docs/exposure.md](docs/exposure.md) | Internet exposure: which views are public, hardening checks, response rate limiting |
|
||||||
| [docs/metrics.md](docs/metrics.md) | Prometheus metrics: access, what is exported, example alerts |
|
| [docs/metrics.md](docs/metrics.md) | Prometheus metrics: access, what is exported, example alerts |
|
||||||
| [docs/blocking.md](docs/blocking.md) | Blocking ads, trackers and malware: blocklists, your own rules, views, memory |
|
| [docs/blocking.md](docs/blocking.md) | Blocking ads, trackers and malware: blocklists, your own rules, views, memory |
|
||||||
| [docs/validation.md](docs/validation.md) | Every check Jarl makes |
|
| [docs/validation.md](docs/validation.md) | Every check Jarl makes |
|
||||||
@@ -177,9 +202,15 @@ review step.
|
|||||||
|
|
||||||
## Status
|
## Status
|
||||||
|
|
||||||
Version 0.4.0 is the current release, and 0.4.1 is in testing
|
Version 0.6.0 is the current release. It makes reverse zones easy (suggested from your records,
|
||||||
(0.4.1-rc.1): it adds Prometheus metrics, address ranges in ACLs and
|
created in the right view and filled, PTR records kept in step), rebuilds
|
||||||
other address match lists, and safer changeset handling. 0.4.0 added blocking (blocklists and
|
comparing a zone's views, lets you explore the statistics down to each
|
||||||
|
client and name (a query log), shows the databases' size, and gives
|
||||||
|
encrypted DNS several host names and views per listen address. 0.5 added Prometheus metrics,
|
||||||
|
address ranges in ACLs and other address match lists, safer changeset
|
||||||
|
handling, internet exposure checks with response rate limiting, TLS
|
||||||
|
certificates Jarl obtains and renews itself, linked zones for split DNS,
|
||||||
|
DNS over TLS and HTTPS, and statistics per view. 0.4.0 added blocking (blocklists and
|
||||||
your own rules, like Pi-hole, done by named, with different blocking for
|
your own rules, like Pi-hole, done by named, with different blocking for
|
||||||
different devices), disabling zones, server statistics and view keys, on
|
different devices), disabling zones, server statistics and view keys, on
|
||||||
top of 0.3.0's disabled records, script-friendly CLI output and client
|
top of 0.3.0's disabled records, script-friendly CLI output and client
|
||||||
|
|||||||
+1
-1
@@ -83,7 +83,7 @@ func acmeZones(c *client.Client, name, view string) ([]acme.Zone, error) {
|
|||||||
}
|
}
|
||||||
refs := make([]acme.Zone, len(zones))
|
refs := make([]acme.Zone, len(zones))
|
||||||
for i, z := range zones {
|
for i, z := range zones {
|
||||||
refs[i] = acme.Zone{Name: z.Name, View: z.View}
|
refs[i] = acme.Zone{Name: z.Name, View: z.View, Link: z.LinkGroup}
|
||||||
}
|
}
|
||||||
out := acme.Zones(name, refs, view)
|
out := acme.Zones(name, refs, view)
|
||||||
if len(out) == 0 {
|
if len(out) == 0 {
|
||||||
|
|||||||
@@ -0,0 +1,560 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/url"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
|
"jarl/internal/client"
|
||||||
|
)
|
||||||
|
|
||||||
|
type certStatus struct {
|
||||||
|
State string `json:"state"`
|
||||||
|
Message string `json:"message"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type certInfo struct {
|
||||||
|
ID int64 `json:"id"`
|
||||||
|
Name string `json:"name"`
|
||||||
|
Source string `json:"source"`
|
||||||
|
Domains []string `json:"domains"`
|
||||||
|
CertFile string `json:"cert_file,omitempty"`
|
||||||
|
KeyFile string `json:"key_file,omitempty"`
|
||||||
|
Uses []string `json:"uses"`
|
||||||
|
Challenge string `json:"challenge,omitempty"`
|
||||||
|
KeyType string `json:"key_type,omitempty"`
|
||||||
|
Comment string `json:"comment"`
|
||||||
|
Names []string `json:"names,omitempty"`
|
||||||
|
NotBefore *time.Time `json:"not_before,omitempty"`
|
||||||
|
NotAfter *time.Time `json:"not_after,omitempty"`
|
||||||
|
Issuer string `json:"issuer,omitempty"`
|
||||||
|
Serial string `json:"serial,omitempty"`
|
||||||
|
RenewAt *time.Time `json:"renew_at,omitempty"`
|
||||||
|
LastAttempt *time.Time `json:"last_attempt,omitempty"`
|
||||||
|
LastSuccess *time.Time `json:"last_success,omitempty"`
|
||||||
|
LastError string `json:"last_error,omitempty"`
|
||||||
|
Failures int `json:"failures,omitempty"`
|
||||||
|
LastRoutes []string `json:"last_routes,omitempty"`
|
||||||
|
Status certStatus `json:"status"`
|
||||||
|
NextAttempt *time.Time `json:"next_attempt,omitempty"`
|
||||||
|
IssuingSince *time.Time `json:"issuing_since,omitempty"`
|
||||||
|
Serving bool `json:"serving,omitempty"`
|
||||||
|
NamedUse []string `json:"named_use,omitempty"`
|
||||||
|
Files *struct {
|
||||||
|
Chain string `json:"chain"`
|
||||||
|
Key string `json:"key"`
|
||||||
|
} `json:"files,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type certAccount struct {
|
||||||
|
Directory string `json:"directory"`
|
||||||
|
Email string `json:"email"`
|
||||||
|
AgreeTOS bool `json:"agree_tos"`
|
||||||
|
EAB bool `json:"eab"`
|
||||||
|
Registered bool `json:"registered"`
|
||||||
|
URI string `json:"uri"`
|
||||||
|
RegisteredAt *time.Time `json:"registered_at"`
|
||||||
|
Porkbun bool `json:"porkbun"`
|
||||||
|
Resolvers []string `json:"resolvers"`
|
||||||
|
Dir string `json:"dir"`
|
||||||
|
ActiveWebCertificate string `json:"active_web_certificate"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type certRoute struct {
|
||||||
|
Domain string `json:"domain"`
|
||||||
|
Record string `json:"record"`
|
||||||
|
Target string `json:"target"`
|
||||||
|
Route string `json:"route"`
|
||||||
|
Zone string `json:"zone"`
|
||||||
|
PublicNS []string `json:"public_ns"`
|
||||||
|
Why string `json:"why"`
|
||||||
|
Error string `json:"error"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func certPath(name string) string { return "/certificates/" + url.PathEscape(name) }
|
||||||
|
|
||||||
|
func certCmd() *cobra.Command {
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "cert",
|
||||||
|
Aliases: []string{"certificate", "certificates"},
|
||||||
|
Short: "TLS certificates Jarl obtains and renews, or reads from files (docs/certificates.md)",
|
||||||
|
Long: `Certificates for jarld's own HTTPS (use "web") and for named's DNS over
|
||||||
|
TLS and HTTPS (use "dns": written where named can read them).
|
||||||
|
|
||||||
|
Jarl obtains them from an ACME CA (Let's Encrypt by default; the account is
|
||||||
|
set up in jarl.yaml under acme.account) and renews them itself. It answers
|
||||||
|
the DNS-01 challenges in a zone it serves, or through Porkbun's API while
|
||||||
|
Porkbun serves the domain ("auto" decides at every renewal from the
|
||||||
|
domain's public name servers). A certificate you renew yourself can be
|
||||||
|
used too (--cert-file and --key-file): Jarl rereads it when it changes.`,
|
||||||
|
Example: ` jarl cert check --domain ns1.adbraun.lol # where would the challenge go?
|
||||||
|
jarl cert create ns1 --domain ns1.adbraun.lol --use web --use dns
|
||||||
|
jarl cert create wild --domain adbraun.lol --domain '*.adbraun.lol' --use dns
|
||||||
|
jarl cert create own --cert-file /etc/ssl/ns1/fullchain.pem --key-file /etc/ssl/ns1/privkey.pem --use web
|
||||||
|
jarl cert list
|
||||||
|
jarl cert issue ns1 # renew now
|
||||||
|
jarl cert update ns1 --challenge porkbun # pin the route (auto, jarl or porkbun)`,
|
||||||
|
}
|
||||||
|
cmd.AddCommand(certListCmd(), certShowCmd(), certCreateCmd(), certUpdateCmd(), certIssueCmd(), certCheckCmd(), certDeleteCmd(), certAccountCmd())
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
func certListCmd() *cobra.Command {
|
||||||
|
return &cobra.Command{
|
||||||
|
Use: "list",
|
||||||
|
Aliases: []string{"ls"},
|
||||||
|
Short: "List certificates",
|
||||||
|
Args: cobra.NoArgs,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var r struct {
|
||||||
|
Certificates []certInfo `json:"certificates"`
|
||||||
|
}
|
||||||
|
if err := c.Get(ctx(), "/certificates", nil, &r); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return output(r.Certificates, func(w io.Writer) {
|
||||||
|
fmt.Fprintln(w, "NAME\tSOURCE\tUSES\tNAMES\tEXPIRES\tSTATUS")
|
||||||
|
for _, ci := range r.Certificates {
|
||||||
|
names := ci.Names
|
||||||
|
if len(names) == 0 {
|
||||||
|
names = ci.Domains
|
||||||
|
}
|
||||||
|
state := ci.Status.State
|
||||||
|
if ci.IssuingSince != nil {
|
||||||
|
state = "obtaining"
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\t%s\n", ci.Name, ci.Source, dash(strings.Join(ci.Uses, ",")), strings.Join(names, " "), fmtDate(ci.NotAfter), state)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func fmtDate(t *time.Time) string {
|
||||||
|
if t == nil {
|
||||||
|
return "-"
|
||||||
|
}
|
||||||
|
return t.Local().Format("2006-01-02")
|
||||||
|
}
|
||||||
|
|
||||||
|
func printCert(w io.Writer, ci certInfo) {
|
||||||
|
fmt.Fprintf(w, "Name:\t%s\n", ci.Name)
|
||||||
|
switch ci.Source {
|
||||||
|
case "acme":
|
||||||
|
fmt.Fprintf(w, "Source:\tacme (Jarl obtains and renews it)\n")
|
||||||
|
fmt.Fprintf(w, "Domains:\t%s\n", strings.Join(ci.Domains, " "))
|
||||||
|
fmt.Fprintf(w, "Challenge:\t%s\n", ci.Challenge)
|
||||||
|
fmt.Fprintf(w, "Key type:\t%s\n", ci.KeyType)
|
||||||
|
default:
|
||||||
|
fmt.Fprintf(w, "Source:\tfile (you renew it)\n")
|
||||||
|
fmt.Fprintf(w, "Cert file:\t%s\n", ci.CertFile)
|
||||||
|
fmt.Fprintf(w, "Key file:\t%s\n", ci.KeyFile)
|
||||||
|
}
|
||||||
|
uses := []string{}
|
||||||
|
for _, u := range ci.Uses {
|
||||||
|
switch u {
|
||||||
|
case "web":
|
||||||
|
s := "web (jarld's HTTPS"
|
||||||
|
if ci.Serving {
|
||||||
|
s += ", serving now"
|
||||||
|
}
|
||||||
|
uses = append(uses, s+")")
|
||||||
|
case "dns":
|
||||||
|
uses = append(uses, "dns (for named)")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "Uses:\t%s\n", dash(strings.Join(uses, ", ")))
|
||||||
|
for _, u := range ci.NamedUse {
|
||||||
|
fmt.Fprintf(w, "named:\t%s\n", u)
|
||||||
|
}
|
||||||
|
if ci.Comment != "" {
|
||||||
|
fmt.Fprintf(w, "Comment:\t%s\n", ci.Comment)
|
||||||
|
}
|
||||||
|
state := ci.Status.State
|
||||||
|
if ci.Status.Message != "" {
|
||||||
|
state += ": " + ci.Status.Message
|
||||||
|
}
|
||||||
|
if ci.IssuingSince != nil {
|
||||||
|
state = "obtaining since " + fmtTime(ci.IssuingSince)
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "Status:\t%s\n", state)
|
||||||
|
if ci.NotAfter != nil {
|
||||||
|
fmt.Fprintf(w, "Names:\t%s\n", strings.Join(ci.Names, " "))
|
||||||
|
fmt.Fprintf(w, "Valid:\t%s to %s\n", fmtTime(ci.NotBefore), fmtTime(ci.NotAfter))
|
||||||
|
fmt.Fprintf(w, "Issuer:\t%s\n", ci.Issuer)
|
||||||
|
fmt.Fprintf(w, "Serial:\t%s\n", ci.Serial)
|
||||||
|
}
|
||||||
|
if ci.Source == "acme" {
|
||||||
|
if ci.NextAttempt != nil && ci.NotAfter != nil {
|
||||||
|
fmt.Fprintf(w, "Renews:\t%s\n", fmtTime(ci.NextAttempt))
|
||||||
|
} else if ci.NextAttempt != nil {
|
||||||
|
fmt.Fprintf(w, "Next try:\t%s\n", fmtTime(ci.NextAttempt))
|
||||||
|
}
|
||||||
|
if len(ci.LastRoutes) > 0 {
|
||||||
|
fmt.Fprintf(w, "Challenges:\t%s\n", strings.Join(ci.LastRoutes, "; "))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if ci.LastSuccess != nil {
|
||||||
|
fmt.Fprintf(w, "Last success:\t%s\n", fmtTime(ci.LastSuccess))
|
||||||
|
}
|
||||||
|
if ci.LastError != "" {
|
||||||
|
fmt.Fprintf(w, "Last error:\t%s\n", ci.LastError)
|
||||||
|
}
|
||||||
|
if ci.Files != nil {
|
||||||
|
fmt.Fprintf(w, "For named:\t%s\n\t%s\n", ci.Files.Chain, ci.Files.Key)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func certShowCmd() *cobra.Command {
|
||||||
|
return &cobra.Command{
|
||||||
|
Use: "show NAME",
|
||||||
|
Short: "Show a certificate",
|
||||||
|
Args: cobra.ExactArgs(1),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var ci certInfo
|
||||||
|
if err := c.Get(ctx(), certPath(args[0]), nil, &ci); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return output(ci, func(w io.Writer) { printCert(w, ci) })
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type certFlags struct {
|
||||||
|
domains []string
|
||||||
|
uses []string
|
||||||
|
challenge, keyType string
|
||||||
|
comment string
|
||||||
|
certFile, keyFile string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *certFlags) add(cmd *cobra.Command) {
|
||||||
|
fl := cmd.Flags()
|
||||||
|
fl.StringArrayVarP(&f.domains, "domain", "d", nil, "a name on the certificate (repeat for several; *.example.com for a wildcard)")
|
||||||
|
fl.StringArrayVarP(&f.uses, "use", "u", nil, "what it is for: web (jarld's HTTPS) or dns (named's DNS over TLS/HTTPS); repeat for both")
|
||||||
|
fl.StringVar(&f.challenge, "challenge", "", "where DNS-01 challenges go: auto (from the domain's public name servers), jarl or porkbun")
|
||||||
|
fl.StringVar(&f.keyType, "key-type", "", "key type: ec256 (default), ec384, rsa2048, rsa3072 or rsa4096")
|
||||||
|
fl.StringVar(&f.comment, "comment", "", "a comment")
|
||||||
|
fl.StringVar(&f.certFile, "cert-file", "", "a certificate you renew yourself: the full chain (PEM)")
|
||||||
|
fl.StringVar(&f.keyFile, "key-file", "", "its private key (PEM)")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *certFlags) body(cmd *cobra.Command) map[string]any {
|
||||||
|
b := map[string]any{}
|
||||||
|
ch := cmd.Flags().Changed
|
||||||
|
if ch("domain") {
|
||||||
|
b["domains"] = f.domains
|
||||||
|
}
|
||||||
|
if ch("use") {
|
||||||
|
uses := []string{}
|
||||||
|
for _, u := range f.uses {
|
||||||
|
for _, x := range strings.Split(u, ",") {
|
||||||
|
if x = strings.TrimSpace(x); x != "" && x != "none" {
|
||||||
|
uses = append(uses, x)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
b["uses"] = uses
|
||||||
|
}
|
||||||
|
for flag, key := range map[string]string{"challenge": "challenge", "key-type": "key_type", "comment": "comment", "cert-file": "cert_file", "key-file": "key_file"} {
|
||||||
|
if ch(flag) {
|
||||||
|
v, _ := cmd.Flags().GetString(flag)
|
||||||
|
b[key] = v
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
func certCreateCmd() *cobra.Command {
|
||||||
|
var f certFlags
|
||||||
|
var noIssue, noWait bool
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "create NAME",
|
||||||
|
Short: "Add a certificate: obtained by Jarl (--domain), or one you renew (--cert-file, --key-file)",
|
||||||
|
Long: `Adds a certificate. With --domain, Jarl obtains it from the CA at once
|
||||||
|
(and renews it from then on); the command waits for the outcome. With
|
||||||
|
--cert-file and --key-file it is a certificate you renew yourself, which
|
||||||
|
Jarl reads (and rereads when the files change).
|
||||||
|
|
||||||
|
The name is used for the files for named (<certificates.dir>/NAME/).`,
|
||||||
|
Args: cobra.ExactArgs(1),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
b := f.body(cmd)
|
||||||
|
b["name"] = args[0]
|
||||||
|
b["source"] = "acme"
|
||||||
|
if f.certFile != "" || f.keyFile != "" {
|
||||||
|
b["source"] = "file"
|
||||||
|
}
|
||||||
|
b["issue"] = !noIssue
|
||||||
|
var r struct {
|
||||||
|
Certificate certInfo `json:"certificate"`
|
||||||
|
Error string `json:"error"`
|
||||||
|
}
|
||||||
|
if err := c.Do(ctx(), "POST", "/certificates", nil, b, &r); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if r.Certificate.IssuingSince != nil && !noWait {
|
||||||
|
return waitIssue(c, args[0])
|
||||||
|
}
|
||||||
|
if r.Error != "" {
|
||||||
|
return errors.New(r.Error)
|
||||||
|
}
|
||||||
|
return output(r.Certificate, func(w io.Writer) { printCert(w, r.Certificate) })
|
||||||
|
},
|
||||||
|
}
|
||||||
|
f.add(cmd)
|
||||||
|
cmd.Flags().BoolVar(&noIssue, "no-issue", false, "don't obtain it now (jarld does within minutes)")
|
||||||
|
cmd.Flags().BoolVar(&noWait, "no-wait", false, "return at once instead of waiting for the CA")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
func certUpdateCmd() *cobra.Command {
|
||||||
|
var f certFlags
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "update NAME",
|
||||||
|
Short: "Change a certificate (--domain and --use replace the whole list)",
|
||||||
|
Long: `Changes a certificate. --domain and --use replace the whole list
|
||||||
|
(--use none for no use). New names or a new key type make Jarl obtain it
|
||||||
|
again soon (run 'jarl cert issue NAME' to do it now).`,
|
||||||
|
Example: ` jarl cert update ns1 --use web --use dns
|
||||||
|
jarl cert update ns1 --challenge auto
|
||||||
|
jarl cert update ns1 --domain ns1.adbraun.lol --domain dns.adbraun.lol`,
|
||||||
|
Args: cobra.ExactArgs(1),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
b := f.body(cmd)
|
||||||
|
if len(b) == 0 {
|
||||||
|
return errors.New("nothing to change")
|
||||||
|
}
|
||||||
|
var r struct {
|
||||||
|
Certificate certInfo `json:"certificate"`
|
||||||
|
}
|
||||||
|
if err := c.Do(ctx(), "PATCH", certPath(args[0]), nil, b, &r); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return output(r.Certificate, func(w io.Writer) { printCert(w, r.Certificate) })
|
||||||
|
},
|
||||||
|
}
|
||||||
|
f.add(cmd)
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
func certIssueCmd() *cobra.Command {
|
||||||
|
var noWait bool
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "issue NAME",
|
||||||
|
Aliases: []string{"renew"},
|
||||||
|
Short: "Obtain the certificate now (reread the files of one you renew yourself)",
|
||||||
|
Args: cobra.ExactArgs(1),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var r struct {
|
||||||
|
Certificate certInfo `json:"certificate"`
|
||||||
|
Error string `json:"error"`
|
||||||
|
}
|
||||||
|
if err := c.Do(ctx(), "POST", certPath(args[0])+"/issue", nil, map[string]any{}, &r); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if r.Error != "" {
|
||||||
|
return errors.New(r.Error)
|
||||||
|
}
|
||||||
|
if r.Certificate.IssuingSince != nil && !noWait {
|
||||||
|
return waitIssue(c, args[0])
|
||||||
|
}
|
||||||
|
return output(r.Certificate, func(w io.Writer) { printCert(w, r.Certificate) })
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.Flags().BoolVar(&noWait, "no-wait", false, "return at once instead of waiting for the CA")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
// waitIssue polls until jarld has finished obtaining the certificate and
|
||||||
|
// reports the outcome.
|
||||||
|
func waitIssue(c *client.Client, name string) error {
|
||||||
|
tty := !flagQuiet && flagOutput == "table"
|
||||||
|
if tty {
|
||||||
|
fmt.Fprintf(os.Stderr, "Obtaining %s from the CA (this can take a few minutes while the challenges reach every name server)", name)
|
||||||
|
}
|
||||||
|
deadline := time.Now().Add(20 * time.Minute)
|
||||||
|
var ci certInfo
|
||||||
|
for {
|
||||||
|
ci = certInfo{} // a field the answer leaves out must not keep the last value
|
||||||
|
if err := c.Get(ctx(), certPath(name), nil, &ci); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if ci.IssuingSince == nil || time.Now().After(deadline) {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if tty {
|
||||||
|
fmt.Fprint(os.Stderr, ".")
|
||||||
|
}
|
||||||
|
time.Sleep(2 * time.Second)
|
||||||
|
}
|
||||||
|
if tty {
|
||||||
|
fmt.Fprintln(os.Stderr)
|
||||||
|
}
|
||||||
|
if ci.IssuingSince != nil {
|
||||||
|
return fmt.Errorf("jarld is still obtaining %s; check later with: jarl cert show %s", name, name)
|
||||||
|
}
|
||||||
|
if err := output(ci, func(w io.Writer) { printCert(w, ci) }); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if ci.LastError != "" && (ci.LastSuccess == nil || ci.LastAttempt != nil && ci.LastAttempt.After(*ci.LastSuccess)) {
|
||||||
|
return fmt.Errorf("obtaining %s failed (jarld tries again at %s)", name, fmtTime(ci.NextAttempt))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func certCheckCmd() *cobra.Command {
|
||||||
|
var f certFlags
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "check [NAME]",
|
||||||
|
Short: "Show where each name's DNS-01 challenge would go, without asking the CA",
|
||||||
|
Long: `For an existing certificate, or for --domain names, shows where Jarl would
|
||||||
|
publish each DNS-01 challenge (in a zone it serves, or at Porkbun) and why,
|
||||||
|
seen from the resolvers in acme.resolvers, as the CA would see it. Nothing
|
||||||
|
is published and the CA isn't asked.`,
|
||||||
|
Example: ` jarl cert check ns1
|
||||||
|
jarl cert check --domain ns1.adbraun.lol --domain '*.adbraun.lol'`,
|
||||||
|
Args: cobra.MaximumNArgs(1),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var r struct {
|
||||||
|
OK bool `json:"ok"`
|
||||||
|
Routes []certRoute `json:"routes"`
|
||||||
|
Account certAccount `json:"account"`
|
||||||
|
}
|
||||||
|
if len(args) == 1 {
|
||||||
|
err = c.Do(ctx(), "POST", certPath(args[0])+"/check", nil, map[string]any{}, &r)
|
||||||
|
} else {
|
||||||
|
b := f.body(cmd)
|
||||||
|
if b["domains"] == nil {
|
||||||
|
return errors.New("give a certificate name, or --domain")
|
||||||
|
}
|
||||||
|
err = c.Do(ctx(), "POST", "/certificates/check", nil, b, &r)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := output(r, func(w io.Writer) {
|
||||||
|
fmt.Fprintln(w, "NAME\tROUTE\tRECORD\tWHY")
|
||||||
|
for _, rt := range r.Routes {
|
||||||
|
rec := strings.TrimSuffix(rt.Target, ".")
|
||||||
|
if rt.Target != rt.Record && rt.Target != "" {
|
||||||
|
rec += " (CNAME from " + strings.TrimSuffix(rt.Record, ".") + ")"
|
||||||
|
}
|
||||||
|
if rt.Error != "" {
|
||||||
|
fmt.Fprintf(w, "%s\t%s\t%s\t%s\n", rt.Domain, "none", dash(rec), rt.Error)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "%s\t%s\t%s\t%s\n", rt.Domain, rt.Route, rec, rt.Why)
|
||||||
|
}
|
||||||
|
if !r.Account.AgreeTOS {
|
||||||
|
fmt.Fprintln(w, "\nNote: acme.account.agree_tos isn't set in jarl.yaml, so Jarl can't register with the CA yet.")
|
||||||
|
}
|
||||||
|
}); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !r.OK {
|
||||||
|
return errors.New("not every name can be validated")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.Flags().StringArrayVarP(&f.domains, "domain", "d", nil, "a name to check (repeat for several)")
|
||||||
|
cmd.Flags().StringVar(&f.challenge, "challenge", "", "the challenge setting to check with: auto, jarl or porkbun")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
func certDeleteCmd() *cobra.Command {
|
||||||
|
var yes bool
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "delete NAME",
|
||||||
|
Short: "Delete a certificate (and its files for named)",
|
||||||
|
Long: `Deletes a certificate. Its files for named are removed, so take it out of
|
||||||
|
any tls block in named's configuration first. If jarld served it, jarld
|
||||||
|
goes back to tls.cert_file, or to plain HTTP.`,
|
||||||
|
Args: cobra.ExactArgs(1),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
if !confirm("Delete certificate "+args[0]+"?", yes) {
|
||||||
|
return errors.New("aborted")
|
||||||
|
}
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := c.Do(ctx(), "DELETE", certPath(args[0]), nil, nil, nil); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !flagQuiet {
|
||||||
|
fmt.Println("deleted certificate", args[0])
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.Flags().BoolVarP(&yes, "yes", "y", false, "don't ask")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
func certAccountCmd() *cobra.Command {
|
||||||
|
return &cobra.Command{
|
||||||
|
Use: "account",
|
||||||
|
Short: "Show the ACME account and settings (set in jarl.yaml under acme)",
|
||||||
|
Args: cobra.NoArgs,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var r struct {
|
||||||
|
Account certAccount `json:"account"`
|
||||||
|
}
|
||||||
|
if err := c.Get(ctx(), "/certificates", nil, &r); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
a := r.Account
|
||||||
|
return output(a, func(w io.Writer) {
|
||||||
|
fmt.Fprintf(w, "Directory:\t%s\n", a.Directory)
|
||||||
|
fmt.Fprintf(w, "Email:\t%s\n", dash(a.Email))
|
||||||
|
fmt.Fprintf(w, "Terms agreed:\t%v\n", a.AgreeTOS)
|
||||||
|
if a.Registered {
|
||||||
|
fmt.Fprintf(w, "Account:\t%s (since %s)\n", a.URI, fmtTime(a.RegisteredAt))
|
||||||
|
} else {
|
||||||
|
fmt.Fprintf(w, "Account:\tnot registered yet (it is, with the first certificate)\n")
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "EAB:\t%v\n", a.EAB)
|
||||||
|
fmt.Fprintf(w, "Porkbun:\t%v\n", a.Porkbun)
|
||||||
|
fmt.Fprintf(w, "Resolvers:\t%s\n", strings.Join(a.Resolvers, " "))
|
||||||
|
fmt.Fprintf(w, "Files for named:\t%s\n", a.Dir)
|
||||||
|
fmt.Fprintf(w, "Serving HTTPS with:\t%s\n", dash(a.ActiveWebCertificate))
|
||||||
|
})
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
+2
-2
@@ -130,7 +130,7 @@ func submitBatch(c *client.Client, description string, reqs []api.ChangeRequest)
|
|||||||
}
|
}
|
||||||
return report(&resp)
|
return report(&resp)
|
||||||
}
|
}
|
||||||
if err := c.Do(ctx(), "POST", "/apply", nil, api.BatchRequest{Description: description, Ops: reqs, DryRun: c.DryRun, Force: c.Force}, &resp); err != nil {
|
if err := c.Do(ctx(), "POST", "/apply", nil, api.BatchRequest{Description: description, Ops: reqs, DryRun: c.DryRun, Force: c.Force, AcceptRisk: c.AcceptRisk}, &resp); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return report(&resp)
|
return report(&resp)
|
||||||
@@ -349,7 +349,7 @@ func changesetCmd() *cobra.Command {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
var resp api.MutationResponse
|
var resp api.MutationResponse
|
||||||
if err := c.Do(ctx(), "POST", "/changesets/"+id+"/apply", nil, map[string]any{"force": c.Force, "dry_run": c.DryRun}, &resp); err != nil {
|
if err := c.Do(ctx(), "POST", "/changesets/"+id+"/apply", nil, map[string]any{"force": c.Force, "dry_run": c.DryRun, "accept_risk": c.AcceptRisk}, &resp); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if err := report(&resp); err != nil {
|
if err := report(&resp); err != nil {
|
||||||
|
|||||||
@@ -0,0 +1,57 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"unicode/utf8"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestPrintCompare(t *testing.T) {
|
||||||
|
long := `"v=spf1 ` + strings.Repeat("include:_spf.example.net ", 10) + `-all"`
|
||||||
|
r := &compareReport{Zone: "adbraun.lol", Base: "internal", Views: []string{"internal", "external"}, Linked: true}
|
||||||
|
r.Summary = append(r.Summary, struct {
|
||||||
|
View string `json:"view"`
|
||||||
|
Different int `json:"different"`
|
||||||
|
OnlyBase int `json:"only_base"`
|
||||||
|
OnlyOther int `json:"only_other"`
|
||||||
|
Same int `json:"same"`
|
||||||
|
}{View: "external", Different: 1, OnlyBase: 1, Same: 5})
|
||||||
|
r.Different = []compareRow{{Name: "@", Type: "TXT", Views: []compareSet{
|
||||||
|
{View: "internal", Records: []string{long, `"short"`}, IDs: []int64{7, 8}, Linked: "local"},
|
||||||
|
{View: "external", Records: []string{`"other"`}, IDs: []int64{9}, Linked: "local"},
|
||||||
|
}}}
|
||||||
|
r.Only = append(r.Only, struct {
|
||||||
|
Views []string `json:"views"`
|
||||||
|
Rows []compareRow `json:"rows"`
|
||||||
|
}{Views: []string{"internal"}, Rows: []compareRow{{Name: "nas", Type: "A", Views: []compareSet{{View: "internal", Records: []string{"10.0.10.20"}}, {View: "external"}}}}})
|
||||||
|
r.Same = 5
|
||||||
|
|
||||||
|
var b bytes.Buffer
|
||||||
|
printCompare(&b, r, false, 60)
|
||||||
|
out := b.String()
|
||||||
|
// Record lines fit (the heading and summary are prose, and may wrap).
|
||||||
|
for _, l := range strings.Split(strings.TrimRight(out, "\n"), "\n")[3:] {
|
||||||
|
if n := utf8.RuneCountInString(l); n > 60 {
|
||||||
|
t.Errorf("line of %d characters: %q", n, l)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, want := range []string{
|
||||||
|
"adbraun.lol in internal, compared with external\n linked: ",
|
||||||
|
" external: 1 answered differently, 1 only in internal, 0 only in external, 5 the same",
|
||||||
|
"ANSWERED DIFFERENTLY (1)\n @ TXT\n internal \"v=spf1 include:",
|
||||||
|
"…\n \"short\"\n external \"other\" [local, id 9]",
|
||||||
|
"ONLY IN INTERNAL (1)\n nas A 10.0.10.20",
|
||||||
|
"5 names and types are the same (--all lists them)",
|
||||||
|
} {
|
||||||
|
if !strings.Contains(out, want) {
|
||||||
|
t.Errorf("output lacks %q:\n%s", want, out)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Width 0: whole.
|
||||||
|
b.Reset()
|
||||||
|
printCompare(&b, r, false, 0)
|
||||||
|
if !strings.Contains(b.String(), long+" [local, id 7]") {
|
||||||
|
t.Errorf("whole: %s", b.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
+95
-9
@@ -36,8 +36,8 @@ func viewCmd() *cobra.Command {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
var clients, dests []string
|
var clients, dests []string
|
||||||
var recursiveOnly, comment string
|
var recursiveOnly, comment, exposure string
|
||||||
var adopt, cascade, yes bool
|
var adopt, cascade, yes, reverseSuggest bool
|
||||||
viewBody := func(cmd *cobra.Command) map[string]any {
|
viewBody := func(cmd *cobra.Command) map[string]any {
|
||||||
body := map[string]any{}
|
body := map[string]any{}
|
||||||
f := cmd.Flags()
|
f := cmd.Flags()
|
||||||
@@ -60,6 +60,12 @@ func viewCmd() *cobra.Command {
|
|||||||
if f.Changed("comment") {
|
if f.Changed("comment") {
|
||||||
body["comment"] = comment
|
body["comment"] = comment
|
||||||
}
|
}
|
||||||
|
if f.Changed("exposure") {
|
||||||
|
body["exposure"] = exposure
|
||||||
|
}
|
||||||
|
if f.Changed("reverse-suggestions") {
|
||||||
|
body["reverse_suggestions"] = reverseSuggest
|
||||||
|
}
|
||||||
return body
|
return body
|
||||||
}
|
}
|
||||||
addViewFlags := func(c *cobra.Command) {
|
addViewFlags := func(c *cobra.Command) {
|
||||||
@@ -67,6 +73,8 @@ func viewCmd() *cobra.Command {
|
|||||||
c.Flags().StringSliceVar(&dests, "match-destinations", nil, "match-destinations elements")
|
c.Flags().StringSliceVar(&dests, "match-destinations", nil, "match-destinations elements")
|
||||||
c.Flags().StringVar(&recursiveOnly, "recursive-only", "", "match-recursive-only: yes, no or default")
|
c.Flags().StringVar(&recursiveOnly, "recursive-only", "", "match-recursive-only: yes, no or default")
|
||||||
c.Flags().StringVar(&comment, "comment", "", "comment")
|
c.Flags().StringVar(&comment, "comment", "", "comment")
|
||||||
|
c.Flags().StringVar(&exposure, "exposure", "", "reachable from the internet: auto (worked out), public or private (docs/exposure.md)")
|
||||||
|
c.Flags().BoolVar(&reverseSuggest, "reverse-suggestions", true, "suggest reverse zones for the view's addresses (--reverse-suggestions=false: don't; docs/reverse.md)")
|
||||||
}
|
}
|
||||||
create := &cobra.Command{
|
create := &cobra.Command{
|
||||||
Use: "create NAME",
|
Use: "create NAME",
|
||||||
@@ -578,6 +586,12 @@ func optionCmd() *cobra.Command {
|
|||||||
Short: "Set an option (replaces an existing option of the same name)",
|
Short: "Set an option (replaces an existing option of the same name)",
|
||||||
Long: `Set an option; VALUE is named.conf syntax without the trailing semicolon.
|
Long: `Set an option; VALUE is named.conf syntax without the trailing semicolon.
|
||||||
|
|
||||||
|
It replaces the option of that name. Statements told apart by the name
|
||||||
|
after the keyword (tls NAME, key NAME, remote-servers NAME, http NAME,
|
||||||
|
dnssec-policy NAME, server ADDRESS, ...) replace only the one with that
|
||||||
|
name: setting tls cloudflare leaves tls quad9 alone. --add adds another
|
||||||
|
instance of any other option that may occur several times.
|
||||||
|
|
||||||
jarl option set recursion no
|
jarl option set recursion no
|
||||||
jarl option set allow-recursion '{ homelab; localhost; }'
|
jarl option set allow-recursion '{ homelab; localhost; }'
|
||||||
jarl option set forwarders '{ 1.1.1.1; 9.9.9.9; }'
|
jarl option set forwarders '{ 1.1.1.1; 9.9.9.9; }'
|
||||||
@@ -602,7 +616,11 @@ func optionCmd() *cobra.Command {
|
|||||||
if cmd.Flags().Changed("comment") {
|
if cmd.Flags().Changed("comment") {
|
||||||
body["comment"] = comment
|
body["comment"] = comment
|
||||||
}
|
}
|
||||||
|
label := optionLabel(strings.ToLower(args[0]), value)
|
||||||
for _, o := range opts {
|
for _, o := range opts {
|
||||||
|
if label != "" && optionLabel(o.Name, o.Value) != label {
|
||||||
|
continue // another tls (key, server, ...) statement
|
||||||
|
}
|
||||||
if o.Name == strings.ToLower(args[0]) && !multiple {
|
if o.Name == strings.ToLower(args[0]) && !multiple {
|
||||||
resp, err := c.Mutate(ctx(), "PATCH", fmt.Sprintf("/options/%d", o.ID), nil, body)
|
resp, err := c.Mutate(ctx(), "PATCH", fmt.Sprintf("/options/%d", o.ID), nil, body)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -623,7 +641,7 @@ func optionCmd() *cobra.Command {
|
|||||||
set.Flags().StringVar(&comment, "comment", "", "comment")
|
set.Flags().StringVar(&comment, "comment", "", "comment")
|
||||||
set.Flags().BoolVar(&multiple, "add", false, "add another instance instead of replacing (for options that may occur several times)")
|
set.Flags().BoolVar(&multiple, "add", false, "add another instance instead of replacing (for options that may occur several times)")
|
||||||
unset := &cobra.Command{
|
unset := &cobra.Command{
|
||||||
Use: "unset NAME | unset --id ID",
|
Use: "unset NAME [LABEL] | unset --id ID",
|
||||||
Short: "Remove an option (BIND's default applies again)",
|
Short: "Remove an option (BIND's default applies again)",
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
c, err := newClient()
|
c, err := newClient()
|
||||||
@@ -637,8 +655,8 @@ func optionCmd() *cobra.Command {
|
|||||||
}
|
}
|
||||||
return report(resp)
|
return report(resp)
|
||||||
}
|
}
|
||||||
if len(args) != 1 {
|
if len(args) < 1 || len(args) > 2 {
|
||||||
return fmt.Errorf("give the option name or --id")
|
return fmt.Errorf("give the option name (and the name after it, for tls NAME and the like) or --id")
|
||||||
}
|
}
|
||||||
sc, id, err := scope()
|
sc, id, err := scope()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -650,15 +668,24 @@ func optionCmd() *cobra.Command {
|
|||||||
}
|
}
|
||||||
var matches []api.Option
|
var matches []api.Option
|
||||||
for _, o := range opts {
|
for _, o := range opts {
|
||||||
if o.Name == strings.ToLower(args[0]) {
|
if o.Name == strings.ToLower(args[0]) && (len(args) == 1 || strings.EqualFold(optionLabel(o.Name, o.Value), strings.Trim(args[1], `"`))) {
|
||||||
matches = append(matches, o)
|
matches = append(matches, o)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
switch len(matches) {
|
switch len(matches) {
|
||||||
case 0:
|
case 0:
|
||||||
return fmt.Errorf("option %s is not set here", args[0])
|
return fmt.Errorf("option %s is not set here", strings.Join(args, " "))
|
||||||
case 1:
|
case 1:
|
||||||
default:
|
default:
|
||||||
|
var labels []string
|
||||||
|
for _, o := range matches {
|
||||||
|
if l := optionLabel(o.Name, o.Value); l != "" {
|
||||||
|
labels = append(labels, l)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(labels) == len(matches) {
|
||||||
|
return fmt.Errorf("option %s is set %d times (%s); say which: jarl option unset %s %s", args[0], len(matches), strings.Join(labels, ", "), args[0], labels[0])
|
||||||
|
}
|
||||||
return fmt.Errorf("option %s is set %d times; remove one with --id", args[0], len(matches))
|
return fmt.Errorf("option %s is set %d times; remove one with --id", args[0], len(matches))
|
||||||
}
|
}
|
||||||
resp, err := c.Mutate(ctx(), "DELETE", fmt.Sprintf("/options/%d", matches[0].ID), nil, nil)
|
resp, err := c.Mutate(ctx(), "DELETE", fmt.Sprintf("/options/%d", matches[0].ID), nil, nil)
|
||||||
@@ -717,7 +744,35 @@ func optionCmd() *cobra.Command {
|
|||||||
}
|
}
|
||||||
scopeArgs(describe)
|
scopeArgs(describe)
|
||||||
describe.Flags().StringVar(&zoneType, "zone-type", "primary", "with --zone: the zone type")
|
describe.Flags().StringVar(&zoneType, "zone-type", "primary", "with --zone: the zone type")
|
||||||
cmd.AddCommand(list, set, unset, describe)
|
generated := &cobra.Command{
|
||||||
|
Use: "generated",
|
||||||
|
Short: "What Jarl adds to named.conf by itself, why, and what controls it",
|
||||||
|
Args: cobra.NoArgs,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var gen []struct {
|
||||||
|
Where string `json:"where"`
|
||||||
|
Text string `json:"text"`
|
||||||
|
Why string `json:"why"`
|
||||||
|
Setting string `json:"setting"`
|
||||||
|
}
|
||||||
|
if err := c.Get(ctx(), "/options/generated", nil, &gen); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return output(gen, func(w io.Writer) {
|
||||||
|
for i, g := range gen {
|
||||||
|
if i > 0 {
|
||||||
|
fmt.Fprintln(w)
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "# %s: %s\n# controlled by: %s\n%s\n", g.Where, g.Why, g.Setting, g.Text)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.AddCommand(list, set, unset, describe, generated)
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -756,7 +811,7 @@ func settingsCmd() *cobra.Command {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
var ns []string
|
var ns []string
|
||||||
var contact, policy string
|
var contact, policy, srvExposure string
|
||||||
var ttl, refresh, retry, expire, neg uint32
|
var ttl, refresh, retry, expire, neg uint32
|
||||||
set := &cobra.Command{
|
set := &cobra.Command{
|
||||||
Use: "set",
|
Use: "set",
|
||||||
@@ -777,6 +832,9 @@ func settingsCmd() *cobra.Command {
|
|||||||
if f.Changed("serial-policy") {
|
if f.Changed("serial-policy") {
|
||||||
body["serial_policy"] = policy
|
body["serial_policy"] = policy
|
||||||
}
|
}
|
||||||
|
if f.Changed("exposure") {
|
||||||
|
body["exposure"] = srvExposure
|
||||||
|
}
|
||||||
for name, v := range map[string]uint32{"ttl": ttl, "refresh": refresh, "retry": retry, "expire": expire, "negative-ttl": neg} {
|
for name, v := range map[string]uint32{"ttl": ttl, "refresh": refresh, "retry": retry, "expire": expire, "negative-ttl": neg} {
|
||||||
if f.Changed(name) {
|
if f.Changed(name) {
|
||||||
key := map[string]string{"ttl": "default_ttl", "negative-ttl": "negative_ttl"}[name]
|
key := map[string]string{"ttl": "default_ttl", "negative-ttl": "negative_ttl"}[name]
|
||||||
@@ -799,6 +857,7 @@ func settingsCmd() *cobra.Command {
|
|||||||
set.Flags().StringSliceVar(&ns, "ns", nil, "default name servers")
|
set.Flags().StringSliceVar(&ns, "ns", nil, "default name servers")
|
||||||
set.Flags().StringVar(&contact, "contact", "", "default SOA contact")
|
set.Flags().StringVar(&contact, "contact", "", "default SOA contact")
|
||||||
set.Flags().StringVar(&policy, "serial-policy", "", "date, increment or unixtime")
|
set.Flags().StringVar(&policy, "serial-policy", "", "date, increment or unixtime")
|
||||||
|
set.Flags().StringVar(&srvExposure, "exposure", "", "without views: is the server reachable from the internet? auto, public or private (docs/exposure.md)")
|
||||||
set.Flags().Uint32Var(&ttl, "ttl", 0, "default TTL")
|
set.Flags().Uint32Var(&ttl, "ttl", 0, "default TTL")
|
||||||
set.Flags().Uint32Var(&refresh, "refresh", 0, "SOA refresh")
|
set.Flags().Uint32Var(&refresh, "refresh", 0, "SOA refresh")
|
||||||
set.Flags().Uint32Var(&retry, "retry", 0, "SOA retry")
|
set.Flags().Uint32Var(&retry, "retry", 0, "SOA retry")
|
||||||
@@ -807,3 +866,30 @@ func settingsCmd() *cobra.Command {
|
|||||||
cmd.AddCommand(show, set)
|
cmd.AddCommand(show, set)
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// labelled are the statements told apart by the name after the keyword:
|
||||||
|
// tls quad9 { ... }, key xfer { ... }, server 192.0.2.1 { ... }.
|
||||||
|
var labelled = map[string]bool{"tls": true, "http": true, "key": true, "remote-servers": true, "primaries": true, "masters": true,
|
||||||
|
"parental-agents": true, "dnssec-policy": true, "key-store": true, "server": true, "view": true, "acl": true, "zone": true}
|
||||||
|
|
||||||
|
// optionLabel returns the name a labelled statement's value starts with
|
||||||
|
// ("quad9" for tls quad9 { ... }), lowercase; "" for other statements.
|
||||||
|
func optionLabel(name, value string) string {
|
||||||
|
if !labelled[name] {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
v := strings.TrimSpace(value)
|
||||||
|
if v == "" || strings.HasPrefix(v, "{") {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
if strings.HasPrefix(v, `"`) {
|
||||||
|
if end := strings.Index(v[1:], `"`); end >= 0 {
|
||||||
|
return strings.ToLower(v[1 : end+1])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
end := strings.IndexAny(v, " \t\n{;")
|
||||||
|
if end < 0 {
|
||||||
|
end = len(v)
|
||||||
|
}
|
||||||
|
return strings.ToLower(v[:end])
|
||||||
|
}
|
||||||
@@ -0,0 +1,465 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/url"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
)
|
||||||
|
|
||||||
|
type encEndpoint struct {
|
||||||
|
Address string `json:"address"`
|
||||||
|
Port int `json:"port"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type encStatus struct {
|
||||||
|
Enabled bool `json:"enabled"`
|
||||||
|
Certificate string `json:"certificate"`
|
||||||
|
Hostname string `json:"hostname"`
|
||||||
|
Hostnames []string `json:"hostnames"`
|
||||||
|
AddrViews map[string][]string `json:"address_views"`
|
||||||
|
DoTHost string `json:"dot_host"`
|
||||||
|
DoHURL string `json:"doh_url"`
|
||||||
|
DoT []encEndpoint `json:"dot"`
|
||||||
|
DoH []encEndpoint `json:"doh"`
|
||||||
|
Other bool `json:"other"`
|
||||||
|
Health *encHealth `json:"health"`
|
||||||
|
Addresses []struct {
|
||||||
|
Address string `json:"address"`
|
||||||
|
Private bool `json:"private"`
|
||||||
|
} `json:"addresses"`
|
||||||
|
Views []struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Public bool `json:"public"`
|
||||||
|
HasZone bool `json:"has_zone"`
|
||||||
|
} `json:"views"`
|
||||||
|
Certificates []struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Names []string `json:"names"`
|
||||||
|
Domains []string `json:"domains"`
|
||||||
|
DNS bool `json:"dns"`
|
||||||
|
Obtained bool `json:"obtained"`
|
||||||
|
} `json:"certificates"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type encConflict struct {
|
||||||
|
Address string `json:"address"`
|
||||||
|
Port int `json:"port"`
|
||||||
|
What string `json:"what"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func endpoints(es []encEndpoint) string {
|
||||||
|
var out []string
|
||||||
|
for _, e := range es {
|
||||||
|
out = append(out, fmt.Sprintf("%s port %d", e.Address, e.Port))
|
||||||
|
}
|
||||||
|
return strings.Join(out, ", ")
|
||||||
|
}
|
||||||
|
|
||||||
|
func encryptedDNSCmd() *cobra.Command {
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "encrypted-dns",
|
||||||
|
Aliases: []string{"encdns"},
|
||||||
|
Short: "DNS over TLS and HTTPS for your clients (docs/encrypted-dns.md)",
|
||||||
|
Long: `Shows whether named serves DNS over TLS (DoT) and DNS over HTTPS (DoH),
|
||||||
|
where, and what to give clients. 'setup' sets it up: a certificate for the
|
||||||
|
host name (obtained if needed), named's tls statement and listeners on the
|
||||||
|
addresses you choose, and the host name's address records in your private
|
||||||
|
views.`,
|
||||||
|
Example: ` jarl encrypted-dns
|
||||||
|
jarl encrypted-dns setup --hostname dns.adbraun.lol --address 10.0.10.5 --address 2a02:8013:7f3d:10::5
|
||||||
|
jarl encrypted-dns setup --hostname dns.adbraun.lol --address 10.0.10.5 --no-doh
|
||||||
|
jarl encrypted-dns check --address 10.0.10.5 --doh-port 443
|
||||||
|
jarl encrypted-dns disable`,
|
||||||
|
Args: cobra.NoArgs,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var s encStatus
|
||||||
|
if err := c.Get(ctx(), "/encrypted-dns", nil, &s); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return output(s, func(w io.Writer) {
|
||||||
|
if !s.Enabled {
|
||||||
|
fmt.Fprintln(w, "Encrypted DNS:\toff (jarl encrypted-dns setup --hostname NAME --address ADDR)")
|
||||||
|
} else {
|
||||||
|
fmt.Fprintf(w, "Host names:\t%s\n", strings.Join(s.Hostnames, ", "))
|
||||||
|
fmt.Fprintf(w, "Certificate:\t%s\n", s.Certificate)
|
||||||
|
for _, e := range append(append([]encEndpoint{}, s.DoT...), s.DoH...) {
|
||||||
|
if vs, ok := s.AddrViews[e.Address]; ok {
|
||||||
|
fmt.Fprintf(w, "Records:\t%s in %s\n", e.Address, strings.Join(vs, ", "))
|
||||||
|
delete(s.AddrViews, e.Address)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(s.DoT) > 0 {
|
||||||
|
fmt.Fprintf(w, "DNS over TLS:\t%s\n", endpoints(s.DoT))
|
||||||
|
}
|
||||||
|
if len(s.DoH) > 0 {
|
||||||
|
fmt.Fprintf(w, "DNS over HTTPS:\t%s\n", endpoints(s.DoH))
|
||||||
|
}
|
||||||
|
if s.DoTHost != "" {
|
||||||
|
fmt.Fprintf(w, "For DoT clients:\t%s (Android: Private DNS hostname; Linux: DNS=ADDRESS#%s, DNSOverTLS=yes)\n", s.DoTHost, s.Hostname)
|
||||||
|
}
|
||||||
|
if s.DoHURL != "" {
|
||||||
|
fmt.Fprintf(w, "For DoH clients:\t%s (Firefox, Chrome, Windows 11)\n", s.DoHURL)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if s.Enabled {
|
||||||
|
printHealth(w, s.Health)
|
||||||
|
}
|
||||||
|
if s.Other {
|
||||||
|
fmt.Fprintln(w, "Note:\tnamed has DoT or DoH listeners written by hand too; setup leaves them alone")
|
||||||
|
}
|
||||||
|
var addrs []string
|
||||||
|
for _, a := range s.Addresses {
|
||||||
|
t := a.Address
|
||||||
|
if !a.Private {
|
||||||
|
t += " (public)"
|
||||||
|
}
|
||||||
|
addrs = append(addrs, t)
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "This server's addresses:\t%s\n", strings.Join(addrs, ", "))
|
||||||
|
})
|
||||||
|
},
|
||||||
|
}
|
||||||
|
var hostList []string
|
||||||
|
var certName string
|
||||||
|
var addrs, views []string
|
||||||
|
var noDoT, noDoH bool
|
||||||
|
var dohPort, dotPort int
|
||||||
|
setup := &cobra.Command{
|
||||||
|
Use: "setup --hostname NAME... --address ADDR[=VIEW,...]...",
|
||||||
|
Short: "Set up DNS over TLS and HTTPS (obtaining a certificate if needed)",
|
||||||
|
Long: `Sets up DoT (port 853) and DoH (port 443, or --doh-port) on the addresses
|
||||||
|
given, which should be this server's addresses on your own networks:
|
||||||
|
|
||||||
|
- the certificate: --certificate, or one with the dns use whose names
|
||||||
|
cover the host name, or a new one Jarl obtains for it (and waits for);
|
||||||
|
- a check that nothing else listens on those ports there;
|
||||||
|
- named's tls statement and listen-on statements (and an explicit
|
||||||
|
listen-on { any; } when there was none, as the first listen-on would
|
||||||
|
otherwise stop named listening on port 53 everywhere);
|
||||||
|
- the host names' A and AAAA records, local to each view: per address,
|
||||||
|
the views after = (--address 10.0.10.5=internal,lab), or the views of
|
||||||
|
--view for every address (default: the private views that have the
|
||||||
|
zone). A view no longer given loses the address.
|
||||||
|
|
||||||
|
Several --hostname: the certificate must be for all of them. It is one
|
||||||
|
change, staged or applied like any other. Running it again replaces the
|
||||||
|
earlier setup, ports included.`,
|
||||||
|
Example: ` jarl encrypted-dns setup --hostname dns.adbraun.lol --address 10.0.10.5=internal --address fdab:abab:abab:10::5=internal
|
||||||
|
jarl encrypted-dns setup --hostname dns.adbraun.lol --hostname doh.adbraun.lol --address 10.0.10.5 --view internal --dot-port 8853`,
|
||||||
|
Args: cobra.NoArgs,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var hosts []string
|
||||||
|
for _, h := range hostList {
|
||||||
|
for _, x := range strings.Split(h, ",") {
|
||||||
|
if x = strings.ToLower(strings.TrimSuffix(strings.TrimSpace(x), ".")); x != "" {
|
||||||
|
hosts = append(hosts, x)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(hosts) == 0 {
|
||||||
|
return errors.New("give --hostname, the name clients connect to (e.g. dns.adbraun.lol)")
|
||||||
|
}
|
||||||
|
host := hosts[0]
|
||||||
|
var s encStatus
|
||||||
|
if err := c.Get(ctx(), "/encrypted-dns", q("hostname", strings.Join(hosts, ",")), &s); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
// ADDR=VIEW,VIEW gives an address its own views.
|
||||||
|
addrViews := map[string][]string{}
|
||||||
|
perAddress := false
|
||||||
|
for i, a := range addrs {
|
||||||
|
addr, vs, ok := strings.Cut(a, "=")
|
||||||
|
addrs[i] = strings.TrimSpace(addr)
|
||||||
|
if ok {
|
||||||
|
perAddress = true
|
||||||
|
addrViews[addrs[i]] = nil
|
||||||
|
for _, v := range strings.Split(vs, ",") {
|
||||||
|
if v = strings.TrimSpace(v); v != "" {
|
||||||
|
addrViews[addrs[i]] = append(addrViews[addrs[i]], v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if perAddress && len(views) > 0 {
|
||||||
|
return errors.New("give the views per address (--address ADDR=VIEW,...) or for all of them (--view), not both")
|
||||||
|
}
|
||||||
|
if len(addrs) == 0 {
|
||||||
|
var list []string
|
||||||
|
for _, a := range s.Addresses {
|
||||||
|
list = append(list, a.Address)
|
||||||
|
}
|
||||||
|
return fmt.Errorf("give --address (this server's addresses on your own networks); it has %s", strings.Join(list, ", "))
|
||||||
|
}
|
||||||
|
// The certificate.
|
||||||
|
if certName == "" {
|
||||||
|
certs:
|
||||||
|
for _, ci := range s.Certificates {
|
||||||
|
for _, h := range hosts {
|
||||||
|
if !coversName(append(ci.Names, ci.Domains...), h) {
|
||||||
|
continue certs
|
||||||
|
}
|
||||||
|
}
|
||||||
|
certName = ci.Name
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if certName == "" {
|
||||||
|
certName = strings.SplitN(host, ".", 2)[0]
|
||||||
|
fmt.Printf("Creating certificate %s for %s\n", certName, strings.Join(hosts, ", "))
|
||||||
|
var r struct {
|
||||||
|
Certificate certInfo `json:"certificate"`
|
||||||
|
}
|
||||||
|
if err := c.Do(ctx(), "POST", "/certificates", nil, map[string]any{"name": certName, "domains": hosts, "uses": []string{"dns"}}, &r); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := waitIssue(c, certName); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
var ci certInfo
|
||||||
|
if err := c.Get(ctx(), certPath(certName), nil, &ci); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !contains(ci.Uses, "dns") {
|
||||||
|
fmt.Printf("Adding the dns use to certificate %s\n", certName)
|
||||||
|
if err := c.Do(ctx(), "PATCH", certPath(certName), nil, map[string]any{"uses": append(ci.Uses, "dns")}, nil); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if ci.NotAfter == nil {
|
||||||
|
if ci.IssuingSince == nil {
|
||||||
|
if err := c.Do(ctx(), "POST", certPath(certName)+"/issue", nil, map[string]any{}, nil); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := waitIssue(c, certName); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
body := map[string]any{"hostnames": hosts, "certificate": certName, "addresses": addrs, "dot": !noDoT, "doh": !noDoH}
|
||||||
|
if cmd.Flags().Changed("doh-port") {
|
||||||
|
body["doh_port"] = dohPort
|
||||||
|
}
|
||||||
|
if cmd.Flags().Changed("dot-port") {
|
||||||
|
body["dot_port"] = dotPort
|
||||||
|
}
|
||||||
|
// Nothing else may listen there.
|
||||||
|
var chk struct {
|
||||||
|
Conflicts []encConflict `json:"conflicts"`
|
||||||
|
FreeDoHPort int `json:"free_doh_port"`
|
||||||
|
Error string `json:"error"`
|
||||||
|
}
|
||||||
|
if err := c.Do(ctx(), "POST", "/encrypted-dns/check", nil, body, &chk); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if len(chk.Conflicts) > 0 {
|
||||||
|
var msgs []string
|
||||||
|
for _, cf := range chk.Conflicts {
|
||||||
|
msgs = append(msgs, fmt.Sprintf("%s listens on %s port %d", cf.What, cf.Address, cf.Port))
|
||||||
|
}
|
||||||
|
hint := ""
|
||||||
|
if chk.FreeDoHPort != 0 && !noDoH {
|
||||||
|
hint = fmt.Sprintf("; for DoH, port %d is free there (--doh-port %d)", chk.FreeDoHPort, chk.FreeDoHPort)
|
||||||
|
}
|
||||||
|
return fmt.Errorf("%s%s", strings.Join(msgs, "; "), hint)
|
||||||
|
}
|
||||||
|
if chk.Error != "" && !flagQuiet {
|
||||||
|
fmt.Println("Note:", chk.Error)
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case perAddress:
|
||||||
|
for _, a := range addrs {
|
||||||
|
if _, ok := addrViews[a]; !ok {
|
||||||
|
addrViews[a] = []string{} // no records for it
|
||||||
|
}
|
||||||
|
}
|
||||||
|
body["address_views"] = addrViews
|
||||||
|
default:
|
||||||
|
if len(views) == 0 {
|
||||||
|
for _, v := range s.Views {
|
||||||
|
if !v.Public && v.HasZone {
|
||||||
|
views = append(views, v.Name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
body["views"] = views
|
||||||
|
}
|
||||||
|
resp, err := c.Mutate(ctx(), "POST", "/encrypted-dns", nil, body)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return report(resp)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
f := setup.Flags()
|
||||||
|
f.StringArrayVar(&hostList, "hostname", nil, "a name clients connect to (repeat, or comma separated, for several; the certificate must be for all)")
|
||||||
|
f.StringVar(&certName, "certificate", "", "the Jarl certificate to serve (default: one for the host name, obtained if there is none)")
|
||||||
|
f.StringArrayVar(&addrs, "address", nil, "this server's address to listen on, with the views that get it: 10.0.10.5=internal,lab (repeat for several)")
|
||||||
|
f.BoolVar(&noDoT, "no-dot", false, "no DNS over TLS")
|
||||||
|
f.BoolVar(&noDoH, "no-doh", false, "no DNS over HTTPS")
|
||||||
|
f.IntVar(&dohPort, "doh-port", 443, "port for DNS over HTTPS")
|
||||||
|
f.IntVar(&dotPort, "dot-port", 853, "port for DNS over TLS (clients expect 853)")
|
||||||
|
f.StringArrayVar(&views, "view", nil, "views where every address gets the host names' records (default: the private views that have the zone); per address: --address ADDR=VIEW")
|
||||||
|
|
||||||
|
var cAddrs []string
|
||||||
|
var cDoH int
|
||||||
|
check := &cobra.Command{
|
||||||
|
Use: "check --address ADDR...",
|
||||||
|
Short: "See whether something already listens on the DoT and DoH ports",
|
||||||
|
Args: cobra.NoArgs,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var r struct {
|
||||||
|
Conflicts []encConflict `json:"conflicts"`
|
||||||
|
FreeDoHPort int `json:"free_doh_port"`
|
||||||
|
Error string `json:"error"`
|
||||||
|
}
|
||||||
|
if err := c.Do(ctx(), "POST", "/encrypted-dns/check", nil, map[string]any{"addresses": cAddrs, "dot": true, "doh": true, "doh_port": cDoH}, &r); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return output(r, func(w io.Writer) {
|
||||||
|
if r.Error != "" {
|
||||||
|
fmt.Fprintln(w, r.Error)
|
||||||
|
}
|
||||||
|
if len(r.Conflicts) == 0 {
|
||||||
|
fmt.Fprintln(w, "The ports are free.")
|
||||||
|
}
|
||||||
|
for _, cf := range r.Conflicts {
|
||||||
|
fmt.Fprintf(w, "%s port %d:\t%s listens there\n", cf.Address, cf.Port, cf.What)
|
||||||
|
}
|
||||||
|
if r.FreeDoHPort != 0 {
|
||||||
|
fmt.Fprintf(w, "Free for DoH:\tport %d\n", r.FreeDoHPort)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
},
|
||||||
|
}
|
||||||
|
check.Flags().StringArrayVar(&cAddrs, "address", nil, "address to check (repeat for several)")
|
||||||
|
check.Flags().IntVar(&cDoH, "doh-port", 443, "port for DNS over HTTPS")
|
||||||
|
|
||||||
|
disable := &cobra.Command{
|
||||||
|
Use: "disable",
|
||||||
|
Short: "Turn DNS over TLS and HTTPS off (the certificate and records stay)",
|
||||||
|
Args: cobra.NoArgs,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
resp, err := c.Mutate(ctx(), "DELETE", "/encrypted-dns", url.Values{}, nil)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return report(resp)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
health := &cobra.Command{
|
||||||
|
Use: "health",
|
||||||
|
Short: "Check the DoT and DoH listeners now, as a client would",
|
||||||
|
Long: `Connects to each listener, checks the certificate it serves (for the
|
||||||
|
host name, current, the one Jarl last wrote) and asks a question. jarld
|
||||||
|
also does this every 10 minutes; the dashboard and Prometheus
|
||||||
|
(jarl_encrypted_dns_up) show the result. Exits 1 when a listener doesn't
|
||||||
|
work.`,
|
||||||
|
Args: cobra.NoArgs,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var h encHealth
|
||||||
|
if err := c.Do(ctx(), "POST", "/encrypted-dns/health", nil, map[string]any{}, &h); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := output(h, func(w io.Writer) { printHealth(w, &h) }); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
ok := true
|
||||||
|
for _, p := range h.Probes {
|
||||||
|
ok = ok && p.OK
|
||||||
|
}
|
||||||
|
if !ok {
|
||||||
|
return errors.New("encrypted DNS isn't working everywhere")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.AddCommand(setup, check, disable, health)
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
// coversName reports whether certificate names cover host (a wildcard
|
||||||
|
// covers one label).
|
||||||
|
func coversName(names []string, host string) bool {
|
||||||
|
for _, n := range names {
|
||||||
|
n = strings.ToLower(strings.TrimSuffix(n, "."))
|
||||||
|
if n == host {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if base, ok := strings.CutPrefix(n, "*."); ok {
|
||||||
|
if _, rest, ok := strings.Cut(host, "."); ok && rest == base {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func contains(list []string, s string) bool {
|
||||||
|
for _, x := range list {
|
||||||
|
if x == s {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
type encHealth struct {
|
||||||
|
Checked time.Time `json:"checked"`
|
||||||
|
Probes []struct {
|
||||||
|
Kind string `json:"kind"`
|
||||||
|
Address string `json:"address"`
|
||||||
|
Port int `json:"port"`
|
||||||
|
OK bool `json:"ok"`
|
||||||
|
Problem string `json:"problem"`
|
||||||
|
Warning string `json:"warning"`
|
||||||
|
RCode string `json:"rcode"`
|
||||||
|
Ms int64 `json:"ms"`
|
||||||
|
} `json:"probes"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func printHealth(w io.Writer, h *encHealth) bool {
|
||||||
|
if h == nil {
|
||||||
|
fmt.Fprintln(w, "Health:\tnot checked yet (jarl encrypted-dns health)")
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
ok := true
|
||||||
|
for _, p := range h.Probes {
|
||||||
|
kind := map[string]string{"dot": "DoT", "doh": "DoH"}[p.Kind]
|
||||||
|
state := fmt.Sprintf("working (%s in %d ms)", p.RCode, p.Ms)
|
||||||
|
if !p.OK {
|
||||||
|
state, ok = "NOT WORKING: "+p.Problem, false
|
||||||
|
} else if p.Warning != "" {
|
||||||
|
state += "; " + p.Warning
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "%s %s port %d:\t%s\n", kind, p.Address, p.Port, state)
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "Checked:\t%s\n", h.Checked.Local().Format("2006-01-02 15:04:05"))
|
||||||
|
return ok
|
||||||
|
}
|
||||||
@@ -0,0 +1,271 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/spf13/cobra"
|
||||||
|
)
|
||||||
|
|
||||||
|
type exposureFinding struct {
|
||||||
|
Severity string `json:"severity"`
|
||||||
|
Code string `json:"code"`
|
||||||
|
Message string `json:"message"`
|
||||||
|
View string `json:"view"`
|
||||||
|
Fix string `json:"fix"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type exposureReport struct {
|
||||||
|
Scopes []struct {
|
||||||
|
ViewID int64 `json:"view_id"`
|
||||||
|
View string `json:"view"`
|
||||||
|
Public bool `json:"public"`
|
||||||
|
Override string `json:"override"`
|
||||||
|
Reason string `json:"reason"`
|
||||||
|
RateLimit string `json:"rate_limit"`
|
||||||
|
Findings []exposureFinding `json:"findings"`
|
||||||
|
} `json:"scopes"`
|
||||||
|
Server []exposureFinding `json:"server"`
|
||||||
|
RateLimiting *struct {
|
||||||
|
Since string `json:"since"`
|
||||||
|
Counts []struct {
|
||||||
|
Key string
|
||||||
|
Count int64
|
||||||
|
} `json:"counts"`
|
||||||
|
Networks []struct {
|
||||||
|
Key string
|
||||||
|
Count int64
|
||||||
|
} `json:"networks"`
|
||||||
|
Names []struct {
|
||||||
|
Key string
|
||||||
|
Count int64
|
||||||
|
} `json:"names"`
|
||||||
|
} `json:"rate_limiting"`
|
||||||
|
Mail *mailReport `json:"mail"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type mailReport struct {
|
||||||
|
Checked string `json:"checked"`
|
||||||
|
Results []struct {
|
||||||
|
Zone string `json:"zone"`
|
||||||
|
Address string `json:"address"`
|
||||||
|
Roles []string `json:"roles"`
|
||||||
|
PTR []string `json:"ptr"`
|
||||||
|
OK bool `json:"ok"`
|
||||||
|
Level string `json:"level"`
|
||||||
|
Message string `json:"message"`
|
||||||
|
ManagedBy string `json:"managed_by"`
|
||||||
|
LocalZone string `json:"local_zone"`
|
||||||
|
} `json:"results"`
|
||||||
|
Errors []string `json:"errors"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func printMail(w io.Writer, m *mailReport) {
|
||||||
|
if len(m.Results) == 0 && len(m.Errors) == 0 {
|
||||||
|
fmt.Fprintln(w, "No mail addresses: no public zone has an MX record or SPF addresses.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
fmt.Fprintln(w, "ZONE\tADDRESS\tFOR\tPTR\tSTATUS")
|
||||||
|
for _, r := range m.Results {
|
||||||
|
ptr := strings.Join(r.PTR, ",")
|
||||||
|
if ptr == "" {
|
||||||
|
ptr = "-"
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "%s\t%s\t%s\t%s\t%s\n", r.Zone, r.Address, strings.Join(r.Roles, ", "), ptr, r.Level)
|
||||||
|
if r.Level != "ok" {
|
||||||
|
fmt.Fprintf(w, " %s\n", r.Message)
|
||||||
|
}
|
||||||
|
if r.LocalZone != "" {
|
||||||
|
fmt.Fprintf(w, " Jarl's reverse zone %s only answers inside: receivers ask %s\n", r.LocalZone, orOwner(r.ManagedBy))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, e := range m.Errors {
|
||||||
|
fmt.Fprintf(w, "error: %s\n", e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func orOwner(s string) string {
|
||||||
|
if s == "" {
|
||||||
|
return "the address's owner"
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// exposureScope turns "server" (or "") into the server, anything else
|
||||||
|
// into a view name.
|
||||||
|
func exposureScope(s string) map[string]any {
|
||||||
|
if s == "" || strings.EqualFold(s, "server") {
|
||||||
|
return map[string]any{}
|
||||||
|
}
|
||||||
|
return map[string]any{"view": s}
|
||||||
|
}
|
||||||
|
|
||||||
|
func exposureCmd() *cobra.Command {
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "exposure",
|
||||||
|
Short: "What is reachable from the internet, and what to harden (docs/exposure.md)",
|
||||||
|
Long: `Shows which views (or the server, without views) are reachable from the
|
||||||
|
internet and why, their rate limiting, and the exposure findings with the
|
||||||
|
fix Jarl can stage for each.`,
|
||||||
|
Example: ` jarl exposure
|
||||||
|
jarl exposure fix external exposure_rate_limit # rate limiting, log-only first
|
||||||
|
jarl exposure fix external exposure_rate_limit_log_only # then start enforcing
|
||||||
|
jarl exposure fix server exposure_version
|
||||||
|
jarl exposure ack external security_open_resolver --reason "public resolver for the club"
|
||||||
|
jarl view update external --exposure public # override the classification`,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var r exposureReport
|
||||||
|
if err := c.Get(ctx(), "/exposure", nil, &r); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return output(r, func(w io.Writer) {
|
||||||
|
fmt.Fprintln(w, "VIEW\tEXPOSURE\tRATE LIMIT\tWHY")
|
||||||
|
for _, s := range r.Scopes {
|
||||||
|
name, exp := s.View, "private"
|
||||||
|
if name == "" {
|
||||||
|
name = "(server)"
|
||||||
|
}
|
||||||
|
if s.Public {
|
||||||
|
exp = "public"
|
||||||
|
}
|
||||||
|
if s.Override != "" {
|
||||||
|
exp += " (set)"
|
||||||
|
}
|
||||||
|
rl := s.RateLimit
|
||||||
|
if !s.Public && rl == "off" {
|
||||||
|
rl = "-"
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "%s\t%s\t%s\t%s\n", name, exp, rl, s.Reason)
|
||||||
|
}
|
||||||
|
var all []exposureFinding
|
||||||
|
for _, s := range r.Scopes {
|
||||||
|
all = append(all, s.Findings...)
|
||||||
|
}
|
||||||
|
all = append(all, r.Server...)
|
||||||
|
fmt.Fprintln(w)
|
||||||
|
if len(all) == 0 {
|
||||||
|
fmt.Fprintln(w, "No findings.")
|
||||||
|
} else {
|
||||||
|
fmt.Fprintln(w, "SEVERITY\tWHERE\tCODE\tFINDING")
|
||||||
|
for _, f := range all {
|
||||||
|
where := f.View
|
||||||
|
if where == "" {
|
||||||
|
where = "server"
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "%s\t%s\t%s\t%s\n", f.Severity, where, f.Code, f.Message)
|
||||||
|
if f.Fix != "" {
|
||||||
|
fmt.Fprintf(w, "\t\t\tfix: jarl exposure fix %s %s (%s)\n", where, f.Code, f.Fix)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if r.Mail != nil {
|
||||||
|
fmt.Fprintln(w, "\nMAIL REVERSE DNS")
|
||||||
|
printMail(w, r.Mail)
|
||||||
|
}
|
||||||
|
if a := r.RateLimiting; a != nil && len(a.Counts) > 0 {
|
||||||
|
fmt.Fprintf(w, "\nRATE LIMITING, LAST %s\n", a.Since)
|
||||||
|
for _, e := range a.Counts {
|
||||||
|
fmt.Fprintf(w, "%s\t%d\n", e.Key, e.Count)
|
||||||
|
}
|
||||||
|
for _, e := range a.Networks {
|
||||||
|
fmt.Fprintf(w, "network %s\t%d\n", e.Key, e.Count)
|
||||||
|
}
|
||||||
|
for _, e := range a.Names {
|
||||||
|
fmt.Fprintf(w, "name %s\t%d\n", e.Key, e.Count)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
},
|
||||||
|
}
|
||||||
|
fix := &cobra.Command{
|
||||||
|
Use: "fix VIEW|server CODE",
|
||||||
|
Short: "Stage (or apply) the fix Jarl suggests for a finding",
|
||||||
|
Args: cobra.ExactArgs(2),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
body := exposureScope(args[0])
|
||||||
|
body["code"] = args[1]
|
||||||
|
resp, err := c.Mutate(ctx(), "POST", "/exposure/fix", nil, body)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return report(resp)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
var reason string
|
||||||
|
ack := &cobra.Command{
|
||||||
|
Use: "ack VIEW|server CODE --reason TEXT",
|
||||||
|
Short: "Accept a finding on purpose: it stays, as info, with who and why",
|
||||||
|
Args: cobra.ExactArgs(2),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
body := exposureScope(args[0])
|
||||||
|
body["code"], body["reason"] = args[1], reason
|
||||||
|
resp, err := c.Mutate(ctx(), "POST", "/exposure/ack", nil, body)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return report(resp)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
ack.Flags().StringVar(&reason, "reason", "", "why the finding is accepted (required)")
|
||||||
|
unack := &cobra.Command{
|
||||||
|
Use: "unack VIEW|server CODE",
|
||||||
|
Short: "Take an acknowledgement back: the finding warns again",
|
||||||
|
Args: cobra.ExactArgs(2),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
body := exposureScope(args[0])
|
||||||
|
body["code"] = args[1]
|
||||||
|
resp, err := c.Mutate(ctx(), "POST", "/exposure/unack", nil, body)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return report(resp)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
mail := &cobra.Command{
|
||||||
|
Use: "mail",
|
||||||
|
Short: "Check the reverse DNS of the addresses that send and receive your mail, now",
|
||||||
|
Long: `Finds the addresses of the public zones' MX hosts and SPF records and checks,
|
||||||
|
through public resolvers, that each has a PTR record whose name resolves
|
||||||
|
back to it, as Gmail and Outlook do. Exits 1 when one doesn't.`,
|
||||||
|
Args: cobra.NoArgs,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var m mailReport
|
||||||
|
if err := c.Do(ctx(), "POST", "/exposure/mail", nil, map[string]any{}, &m); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := output(m, func(w io.Writer) { printMail(w, &m) }); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
for _, r := range m.Results {
|
||||||
|
if !r.OK {
|
||||||
|
return errors.New("some mail addresses have no working reverse DNS")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.AddCommand(fix, ack, unack, mail)
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
+12
-2
@@ -9,6 +9,7 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
|
"net/netip"
|
||||||
"net/url"
|
"net/url"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
@@ -23,6 +24,7 @@ import (
|
|||||||
|
|
||||||
"jarl/internal/api"
|
"jarl/internal/api"
|
||||||
"jarl/internal/client"
|
"jarl/internal/client"
|
||||||
|
"jarl/internal/dnsname"
|
||||||
"jarl/internal/version"
|
"jarl/internal/version"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -47,6 +49,7 @@ var (
|
|||||||
flagChangeset int64
|
flagChangeset int64
|
||||||
flagDryRun bool
|
flagDryRun bool
|
||||||
flagForce bool
|
flagForce bool
|
||||||
|
flagRisk bool
|
||||||
flagOutput string
|
flagOutput string
|
||||||
flagInsecure bool
|
flagInsecure bool
|
||||||
flagCACert string
|
flagCACert string
|
||||||
@@ -162,7 +165,7 @@ func newClient() (*client.Client, error) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
c.DryRun, c.Force = flagDryRun || c.Preflight, flagForce
|
c.DryRun, c.Force, c.AcceptRisk = flagDryRun || c.Preflight, flagForce, flagRisk
|
||||||
if !c.Preflight {
|
if !c.Preflight {
|
||||||
c.OnTokenExpiry = tokenExpiryWarning(t.Name)
|
c.OnTokenExpiry = tokenExpiryWarning(t.Name)
|
||||||
}
|
}
|
||||||
@@ -244,6 +247,7 @@ Exit codes: 0 ok, 1 error, 3 not authenticated or not allowed, 4 not found,
|
|||||||
pf.Int64VarP(&flagChangeset, "changeset", "C", 0, "stage changes into this changeset instead of applying them (env JARL_CHANGESET)")
|
pf.Int64VarP(&flagChangeset, "changeset", "C", 0, "stage changes into this changeset instead of applying them (env JARL_CHANGESET)")
|
||||||
pf.BoolVarP(&flagDryRun, "dry-run", "n", false, "validate and show the changes without applying them")
|
pf.BoolVarP(&flagDryRun, "dry-run", "n", false, "validate and show the changes without applying them")
|
||||||
pf.BoolVar(&flagForce, "force", false, "overwrite BIND files that were changed outside Jarl")
|
pf.BoolVar(&flagForce, "force", false, "overwrite BIND files that were changed outside Jarl")
|
||||||
|
pf.BoolVar(&flagRisk, "accept-risk", false, "confirm a change that opens a public view up, such as an open resolver (docs/exposure.md)")
|
||||||
pf.StringVarP(&flagOutput, "output", "o", "table", "output format: table, json, yaml, id (just the IDs) or field=NAME[,NAME...] (just those fields, e.g. field=view or field=soa.serial)")
|
pf.StringVarP(&flagOutput, "output", "o", "table", "output format: table, json, yaml, id (just the IDs) or field=NAME[,NAME...] (just those fields, e.g. field=view or field=soa.serial)")
|
||||||
pf.BoolVar(&flagInsecure, "insecure", false, "don't verify the server's TLS certificate")
|
pf.BoolVar(&flagInsecure, "insecure", false, "don't verify the server's TLS certificate")
|
||||||
pf.StringVar(&flagCACert, "ca-cert", "", "PEM file with a CA to trust for the server's certificate")
|
pf.StringVar(&flagCACert, "ca-cert", "", "PEM file with a CA to trust for the server's certificate")
|
||||||
@@ -257,7 +261,7 @@ Exit codes: 0 ok, 1 error, 3 not authenticated or not allowed, 4 not found,
|
|||||||
}
|
}
|
||||||
add("dns", zoneCmd(), recordCmd(), viewCmd(), aclCmd(), tsigCmd(), optionCmd(), settingsCmd(), blockCmd(), blocklistCmd(), acmeCmd(), searchCmd(), statsCmd())
|
add("dns", zoneCmd(), recordCmd(), viewCmd(), aclCmd(), tsigCmd(), optionCmd(), settingsCmd(), blockCmd(), blocklistCmd(), acmeCmd(), searchCmd(), statsCmd())
|
||||||
add("changes", applyCmd(), changesetCmd(), historyCmd())
|
add("changes", applyCmd(), changesetCmd(), historyCmd())
|
||||||
add("admin", statusCmd(), whoamiCmd(), userCmd(), tokenCmd(), auditCmd(), checkCmd(), resyncCmd(), configCmd())
|
add("admin", statusCmd(), exposureCmd(), certCmd(), encryptedDNSCmd(), whoamiCmd(), userCmd(), tokenCmd(), auditCmd(), checkCmd(), resyncCmd(), configCmd())
|
||||||
setupCompletion(root)
|
setupCompletion(root)
|
||||||
return root
|
return root
|
||||||
}
|
}
|
||||||
@@ -567,7 +571,13 @@ func q(kv ...string) url.Values {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// zonePath returns the API path for a zone given by name or ID.
|
// zonePath returns the API path for a zone given by name or ID.
|
||||||
|
// A network names its reverse zone: 10.0.10.0/24 is 10.0.10.in-addr.arpa.
|
||||||
func zonePath(zone, view string) (string, url.Values) {
|
func zonePath(zone, view string) (string, url.Values) {
|
||||||
|
if p, err := netip.ParsePrefix(strings.TrimSpace(zone)); err == nil {
|
||||||
|
if name, err := dnsname.ReverseZone(p); err == nil {
|
||||||
|
zone = name
|
||||||
|
}
|
||||||
|
}
|
||||||
z := strings.TrimSuffix(zone, ".")
|
z := strings.TrimSuffix(zone, ".")
|
||||||
if zone == "." {
|
if zone == "." {
|
||||||
z = "root"
|
z = "root"
|
||||||
|
|||||||
@@ -232,3 +232,20 @@ func TestOutputFields(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestOptionLabel(t *testing.T) {
|
||||||
|
for _, c := range []struct{ name, value, want string }{
|
||||||
|
{"tls", `quad9 { remote-hostname "dns.quad9.net"; }`, "quad9"},
|
||||||
|
{"tls", `Cloudflare{ remote-hostname "cloudflare-dns.com"; }`, "cloudflare"},
|
||||||
|
{"key", `"xfer key" { algorithm hmac-sha256; secret "x"; }`, "xfer key"},
|
||||||
|
{"server", "192.0.2.1 { keys { xfer; }; }", "192.0.2.1"},
|
||||||
|
{"remote-servers", "secondaries { 192.0.2.53; }", "secondaries"},
|
||||||
|
{"forwarders", "{ 9.9.9.9; }", ""},
|
||||||
|
{"logging", "{ channel x { stderr; }; }", ""},
|
||||||
|
{"tls", "", ""},
|
||||||
|
} {
|
||||||
|
if got := optionLabel(c.name, c.value); got != c.want {
|
||||||
|
t.Errorf("optionLabel(%q, %q) = %q, want %q", c.name, c.value, got, c.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+38
-12
@@ -12,34 +12,60 @@ import (
|
|||||||
// zoneViews expands a --view value for a record command: "" or one view
|
// zoneViews expands a --view value for a record command: "" or one view
|
||||||
// as it is, "a,b" to those views, and "all" to every view that has the
|
// as it is, "a,b" to those views, and "all" to every view that has the
|
||||||
// zone.
|
// zone.
|
||||||
|
// localFanOut is set by commands making local changes (--local), which
|
||||||
|
// go to every view named even when the zones are linked.
|
||||||
|
var localFanOut bool
|
||||||
|
|
||||||
func zoneViews(c *client.Client, zone, view string) ([]string, error) {
|
func zoneViews(c *client.Client, zone, view string) ([]string, error) {
|
||||||
if view != "all" && !strings.Contains(view, ",") {
|
if view != "all" && !strings.Contains(view, ",") {
|
||||||
return []string{view}, nil
|
return []string{view}, nil
|
||||||
}
|
}
|
||||||
if view != "all" {
|
|
||||||
var out []string
|
|
||||||
for _, v := range strings.Split(view, ",") {
|
|
||||||
if v = strings.TrimSpace(v); v != "" {
|
|
||||||
out = append(out, v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return out, nil
|
|
||||||
}
|
|
||||||
var zones []api.Zone
|
var zones []api.Zone
|
||||||
if err := c.Get(ctx(), "/zones", nil, &zones); err != nil {
|
if err := c.Get(ctx(), "/zones", nil, &zones); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
want := strings.ToLower(strings.TrimSuffix(zone, "."))
|
want := strings.ToLower(strings.TrimSuffix(zone, "."))
|
||||||
|
link := map[string]int64{}
|
||||||
var out []string
|
var out []string
|
||||||
for _, z := range zones {
|
for _, z := range zones {
|
||||||
if strings.ToLower(strings.TrimSuffix(z.Display, ".")) == want && z.View != "" {
|
if strings.ToLower(strings.TrimSuffix(z.Display, ".")) == want && z.View != "" {
|
||||||
out = append(out, z.View)
|
link[z.View] = z.LinkGroup
|
||||||
|
if view == "all" {
|
||||||
|
out = append(out, z.View)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if view != "all" {
|
||||||
|
for _, v := range strings.Split(view, ",") {
|
||||||
|
if v = strings.TrimSpace(v); v != "" {
|
||||||
|
out = append(out, v)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if len(out) == 0 {
|
if len(out) == 0 {
|
||||||
return nil, fmt.Errorf("zone %s is in no view", zone)
|
return nil, fmt.Errorf("zone %s is in no view", zone)
|
||||||
}
|
}
|
||||||
return out, nil
|
// Linked zones (docs/views.md#linked-zones) get a shared change once:
|
||||||
|
// Jarl copies it to the others. A local change goes to each.
|
||||||
|
if localFanOut {
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
var dedup []string
|
||||||
|
first := map[int64]string{}
|
||||||
|
for _, v := range out {
|
||||||
|
g := link[v]
|
||||||
|
if g != 0 {
|
||||||
|
if f, ok := first[g]; ok {
|
||||||
|
if !flagQuiet {
|
||||||
|
fmt.Fprintf(os.Stderr, "view %s: linked with %s, so it gets the change from there\n", v, f)
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
first[g] = v
|
||||||
|
}
|
||||||
|
dedup = append(dedup, v)
|
||||||
|
}
|
||||||
|
return dedup, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// perView runs a record command once per view. With several views, the
|
// perView runs a record command once per view. With several views, the
|
||||||
@@ -90,7 +116,7 @@ func perView(c *client.Client, views []string, description string, do func(c *cl
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
var resp api.MutationResponse
|
var resp api.MutationResponse
|
||||||
err := c.Do(ctx(), "POST", fmt.Sprintf("/changesets/%d/apply", cs.ID), nil, map[string]any{"force": c.Force, "dry_run": c.DryRun}, &resp)
|
err := c.Do(ctx(), "POST", fmt.Sprintf("/changesets/%d/apply", cs.ID), nil, map[string]any{"force": c.Force, "dry_run": c.DryRun, "accept_risk": c.AcceptRisk}, &resp)
|
||||||
if err != nil || c.DryRun {
|
if err != nil || c.DryRun {
|
||||||
discard()
|
discard()
|
||||||
}
|
}
|
||||||
|
|||||||
+43
-11
@@ -4,6 +4,7 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"math"
|
"math"
|
||||||
|
"net/url"
|
||||||
"slices"
|
"slices"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -21,8 +22,22 @@ func statsCmd() *cobra.Command {
|
|||||||
Long: `Query statistics collected from named (see docs/stats.md). They must be
|
Long: `Query statistics collected from named (see docs/stats.md). They must be
|
||||||
enabled in /etc/jarl/jarl.yaml (stats.enabled: true).
|
enabled in /etc/jarl/jarl.yaml (stats.enabled: true).
|
||||||
|
|
||||||
Ranges are given with --since: 90m, 24h, 7d, 2w. Use -o json or -o yaml to
|
Ranges are given with --since: 90m, 24h, 7d, 2w. --view limits the figures
|
||||||
export the data.`,
|
to some views (repeat it, or separate with commas): answers from named's
|
||||||
|
response log, per view; named's own counters stay for the whole server.
|
||||||
|
Use -o json or -o yaml to export the data.`,
|
||||||
|
}
|
||||||
|
var statsViews []string
|
||||||
|
cmd.PersistentFlags().StringSliceVar(&statsViews, "view", nil, "only these views (repeat, or comma separated)")
|
||||||
|
// withViews adds the --view filter to a query.
|
||||||
|
withViews := func(v url.Values) url.Values {
|
||||||
|
if len(statsViews) > 0 {
|
||||||
|
if v == nil {
|
||||||
|
v = url.Values{}
|
||||||
|
}
|
||||||
|
v.Set("views", strings.Join(statsViews, ","))
|
||||||
|
}
|
||||||
|
return v
|
||||||
}
|
}
|
||||||
// Each command has its own --since variable: their defaults differ, and
|
// Each command has its own --since variable: their defaults differ, and
|
||||||
// a shared variable would take the last default for all of them.
|
// a shared variable would take the last default for all of them.
|
||||||
@@ -77,14 +92,27 @@ export the data.`,
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
var s stats.Summary
|
var s stats.Summary
|
||||||
if err := c.Get(ctx(), "/stats/summary", q("since", summarySince, "top", strconv.Itoa(topN)), &s); err != nil {
|
if err := c.Get(ctx(), "/stats/summary", withViews(q("since", summarySince, "top", strconv.Itoa(topN))), &s); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return output(s, func(w io.Writer) {
|
return output(s, func(w io.Writer) {
|
||||||
fmt.Fprintf(w, "Range:\t%s to %s\n", s.From.Local().Format("2006-01-02 15:04"), s.To.Local().Format("2006-01-02 15:04"))
|
fmt.Fprintf(w, "Range:\t%s to %s\n", s.From.Local().Format("2006-01-02 15:04"), s.To.Local().Format("2006-01-02 15:04"))
|
||||||
fmt.Fprintf(w, "Queries:\t%d (%.2f per second on average)\n", s.Queries, s.AvgQPS)
|
if len(s.FilterViews) > 0 {
|
||||||
|
since := ""
|
||||||
|
if s.ViewsSince != nil {
|
||||||
|
since = ", per view since " + s.ViewsSince.Local().Format("2006-01-02 15:04")
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "Views:\t%s (from the response log%s; named's own counters are left out)\n", strings.Join(s.FilterViews, ", "), since)
|
||||||
|
fmt.Fprintf(w, "Answers:\t%d (%.2f per second on average)\n", s.Queries, s.AvgQPS)
|
||||||
|
} else {
|
||||||
|
fmt.Fprintf(w, "Queries:\t%d (%.2f per second on average)\n", s.Queries, s.AvgQPS)
|
||||||
|
}
|
||||||
if s.Peak != nil {
|
if s.Peak != nil {
|
||||||
fmt.Fprintf(w, "Busiest %s:\t%s with %d queries\n", s.Peak.Per, s.Peak.Time.Local().Format("2006-01-02 15:04"), s.Peak.Queries)
|
what := "queries"
|
||||||
|
if len(s.FilterViews) > 0 {
|
||||||
|
what = "answers"
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "Busiest %s:\t%s with %d %s\n", s.Peak.Per, s.Peak.Time.Local().Format("2006-01-02 15:04"), s.Peak.Queries, what)
|
||||||
}
|
}
|
||||||
if s.CacheHitRatio != nil {
|
if s.CacheHitRatio != nil {
|
||||||
fmt.Fprintf(w, "Cache hit ratio:\t%.1f%%\n", *s.CacheHitRatio*100)
|
fmt.Fprintf(w, "Cache hit ratio:\t%.1f%%\n", *s.CacheHitRatio*100)
|
||||||
@@ -128,14 +156,15 @@ export the data.`,
|
|||||||
|
|
||||||
var limit int
|
var limit int
|
||||||
top := &cobra.Command{
|
top := &cobra.Command{
|
||||||
Use: "top [names|clients|nxdomain|servfail|refused|blocked|blocked-clients]",
|
Use: "top [names|clients|nxdomain|servfail|refused|blocked|blocked-clients|ratelimited|ratelimited-names]",
|
||||||
Short: "The most queried names, busiest clients, names with errors, refused clients, blocked names",
|
Short: "The most queried names, busiest clients, names with errors, refused clients, blocked names",
|
||||||
Example: ` jarl stats top names --since 7d
|
Example: ` jarl stats top names --since 7d
|
||||||
jarl stats top clients --limit 50
|
jarl stats top clients --limit 50
|
||||||
jarl stats top nxdomain # misconfigured hosts and typos
|
jarl stats top nxdomain # misconfigured hosts and typos
|
||||||
jarl stats top refused # who is asking for what they may not have
|
jarl stats top refused # who is asking for what they may not have
|
||||||
jarl stats top blocked # what blocking stops most (docs/blocking.md)
|
jarl stats top blocked # what blocking stops most (docs/blocking.md)
|
||||||
jarl stats top blocked-clients # the devices blocking stops most`,
|
jarl stats top blocked-clients # the devices blocking stops most
|
||||||
|
jarl stats top ratelimited # client networks rate limiting limits, or would (docs/exposure.md)`,
|
||||||
Args: cobra.MaximumNArgs(1),
|
Args: cobra.MaximumNArgs(1),
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
kind := stats.KindName
|
kind := stats.KindName
|
||||||
@@ -147,13 +176,16 @@ export the data.`,
|
|||||||
if kind == "blocked-client" {
|
if kind == "blocked-client" {
|
||||||
kind = stats.KindBlockedClient
|
kind = stats.KindBlockedClient
|
||||||
}
|
}
|
||||||
|
if kind == "ratelimited-name" {
|
||||||
|
kind = stats.KindRateLimitedName
|
||||||
|
}
|
||||||
}
|
}
|
||||||
c, err := newClient()
|
c, err := newClient()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
var es []stats.Entry
|
var es []stats.Entry
|
||||||
if err := c.Get(ctx(), "/stats/top", q("kind", kind, "since", topSince, "limit", strconv.Itoa(limit)), &es); err != nil {
|
if err := c.Get(ctx(), "/stats/top", withViews(q("kind", kind, "since", topSince, "limit", strconv.Itoa(limit))), &es); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return output(es, func(w io.Writer) {
|
return output(es, func(w io.Writer) {
|
||||||
@@ -203,7 +235,7 @@ export the data.`,
|
|||||||
qv.Add("key", k)
|
qv.Add("key", k)
|
||||||
}
|
}
|
||||||
var tl stats.Timeline
|
var tl stats.Timeline
|
||||||
if err := c.Get(ctx(), "/stats/timeline", qv, &tl); err != nil {
|
if err := c.Get(ctx(), "/stats/timeline", withViews(qv), &tl); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return output(tl, func(w io.Writer) {
|
return output(tl, func(w io.Writer) {
|
||||||
@@ -252,7 +284,7 @@ export the data.`,
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
var hm stats.Heatmap
|
var hm stats.Heatmap
|
||||||
if err := c.Get(ctx(), "/stats/heatmap", q("since", heatmapSince, "key", hmKey), &hm); err != nil {
|
if err := c.Get(ctx(), "/stats/heatmap", withViews(q("since", heatmapSince, "key", hmKey)), &hm); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return output(hm, func(w io.Writer) {
|
return output(hm, func(w io.Writer) {
|
||||||
@@ -304,7 +336,7 @@ export the data.`,
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
var es []stats.Entry
|
var es []stats.Entry
|
||||||
if err := c.Get(ctx(), "/stats/breakdown", q("group", args[0], "since", breakdownSince), &es); err != nil {
|
if err := c.Get(ctx(), "/stats/breakdown", withViews(q("group", args[0], "since", breakdownSince)), &es); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
return output(es, func(w io.Writer) {
|
return output(es, func(w io.Writer) {
|
||||||
|
|||||||
+499
-6
@@ -93,6 +93,18 @@ func zoneCmd() *cobra.Command {
|
|||||||
if z.InView != "" {
|
if z.InView != "" {
|
||||||
fmt.Fprintf(w, "In view:\t%s\n", z.InView)
|
fmt.Fprintf(w, "In view:\t%s\n", z.InView)
|
||||||
}
|
}
|
||||||
|
if z.AutoPTR {
|
||||||
|
fmt.Fprintf(w, "PTR records:\tkept in step with the A and AAAA records\n")
|
||||||
|
}
|
||||||
|
if z.Prefix != "" {
|
||||||
|
fmt.Fprintf(w, "Network:\t%s\n", z.Prefix)
|
||||||
|
if z.PTRMissing > 0 {
|
||||||
|
fmt.Fprintf(w, "Missing PTRs:\t%d (addresses the view's records use here; add them: jarl zone fill-ptr %s)\n", z.PTRMissing, args[0])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(z.LinkedWith) > 0 {
|
||||||
|
fmt.Fprintf(w, "Linked with:\t%s (shared records are kept in step; 'jarl record list' shows which are local)\n", strings.Join(z.LinkedWith, ", "))
|
||||||
|
}
|
||||||
if z.ZoneFile != "" {
|
if z.ZoneFile != "" {
|
||||||
fmt.Fprintf(w, "File:\t%s\n", z.ZoneFile)
|
fmt.Fprintf(w, "File:\t%s\n", z.ZoneFile)
|
||||||
}
|
}
|
||||||
@@ -105,22 +117,27 @@ func zoneCmd() *cobra.Command {
|
|||||||
show.Flags().StringVar(&view, "view", "", "view of the zone (when the name exists in several views)")
|
show.Flags().StringVar(&view, "view", "", "view of the zone (when the name exists in several views)")
|
||||||
|
|
||||||
var ns, records, primaries, forwarders, opts []string
|
var ns, records, primaries, forwarders, opts []string
|
||||||
var contact, comment, cloneFrom, file, inView, forward string
|
var contact, comment, cloneFrom, file, inView, forward, linkWith string
|
||||||
var ttl uint32
|
var ttl uint32
|
||||||
|
var fill bool
|
||||||
create := &cobra.Command{
|
create := &cobra.Command{
|
||||||
Use: "create NAME",
|
Use: "create NAME",
|
||||||
Short: "Create a zone",
|
Short: "Create a zone",
|
||||||
Long: `Create a zone. NAME may be a network (192.168.1.0/24, 2001:db8::/48) to
|
Long: `Create a zone. NAME may be a network (192.168.1.0/24, 2001:db8::/48) to
|
||||||
create its reverse zone: a /32 (or /128) gives a zone for that one address,
|
create its reverse zone: a /32 (or /128) gives a zone for that one address,
|
||||||
and a network between octet boundaries, like a /22, gets one zone per /24
|
and a network between octet boundaries, like a /22, gets one zone per /24
|
||||||
(created together).
|
(created together). Without --view, a reverse zone goes to the private
|
||||||
|
view whose records use its addresses; --fill adds a PTR record for each
|
||||||
|
of them (docs/reverse.md).
|
||||||
|
|
||||||
jarl zone create example.com --ns ns1.example.com. --record "ns1 A 192.0.2.1"
|
jarl zone create example.com --ns ns1.example.com. --record "ns1 A 192.0.2.1"
|
||||||
jarl zone create 192.168.1.0/24
|
jarl zone create 192.168.1.0/24
|
||||||
jarl zone create 10.0.8.0/22 # 8-11.0.10.in-addr.arpa
|
jarl zone create 10.0.8.0/22 # 8-11.0.10.in-addr.arpa
|
||||||
|
jarl zone create 10.0.10.0/24 --fill # with PTR records for the view's A records there
|
||||||
jarl zone create partner.example --type secondary --primary 192.0.2.53
|
jarl zone create partner.example --type secondary --primary 192.0.2.53
|
||||||
jarl zone create consul --type forward --forwarder "127.0.0.1 port 8600"
|
jarl zone create consul --type forward --forwarder "127.0.0.1 port 8600"
|
||||||
jarl zone create example.com --view external --clone-from example.com --clone-view internal`,
|
jarl zone create example.com --view external --clone-from example.com --clone-view internal
|
||||||
|
jarl zone create example.com --view vps --link-with external # linked: shared records kept in step`,
|
||||||
Args: cobra.ExactArgs(1),
|
Args: cobra.ExactArgs(1),
|
||||||
RunE: func(cmd *cobra.Command, args []string) error {
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
c, err := newClient()
|
c, err := newClient()
|
||||||
@@ -149,6 +166,12 @@ and a network between octet boundaries, like a /22, gets one zone per /24
|
|||||||
if inView != "" {
|
if inView != "" {
|
||||||
body["in_view"] = inView
|
body["in_view"] = inView
|
||||||
}
|
}
|
||||||
|
if linkWith != "" {
|
||||||
|
body["link_with"] = linkWith
|
||||||
|
}
|
||||||
|
if fill {
|
||||||
|
body["fill"] = true
|
||||||
|
}
|
||||||
var recs []map[string]any
|
var recs []map[string]any
|
||||||
for _, r := range records {
|
for _, r := range records {
|
||||||
f := strings.Fields(r)
|
f := strings.Fields(r)
|
||||||
@@ -219,10 +242,13 @@ and a network between octet boundaries, like a /22, gets one zone per /24
|
|||||||
create.Flags().StringVar(&cloneView, "clone-view", "", "view of --clone-from")
|
create.Flags().StringVar(&cloneView, "clone-view", "", "view of --clone-from")
|
||||||
create.Flags().StringVar(&file, "file", "", "zone file (hint and redirect zones)")
|
create.Flags().StringVar(&file, "file", "", "zone file (hint and redirect zones)")
|
||||||
create.Flags().StringVar(&inView, "in-view", "", "for in-view zones: the view to share the zone from")
|
create.Flags().StringVar(&inView, "in-view", "", "for in-view zones: the view to share the zone from")
|
||||||
|
create.Flags().StringVar(&linkWith, "link-with", "", "link with the zone of the same name in this view: copy its shared records and keep them in step (docs/views.md#linked-zones)")
|
||||||
create.Flags().StringVar(&comment, "comment", "", "comment")
|
create.Flags().StringVar(&comment, "comment", "", "comment")
|
||||||
|
create.Flags().BoolVar(&fill, "fill", false, "reverse zones: add PTR records for the view's A and AAAA records in the network")
|
||||||
|
|
||||||
var refresh, retry, expire, minimum, serial uint32
|
var refresh, retry, expire, minimum, serial uint32
|
||||||
var mname, policy, moveView string
|
var mname, policy, moveView string
|
||||||
|
var autoPTR bool
|
||||||
update := &cobra.Command{
|
update := &cobra.Command{
|
||||||
Use: "update ZONE",
|
Use: "update ZONE",
|
||||||
Short: "Change a zone's settings (SOA, TTL, view, comment)",
|
Short: "Change a zone's settings (SOA, TTL, view, comment)",
|
||||||
@@ -264,6 +290,9 @@ and a network between octet boundaries, like a /22, gets one zone per /24
|
|||||||
if f.Changed("file") {
|
if f.Changed("file") {
|
||||||
body["file"] = file
|
body["file"] = file
|
||||||
}
|
}
|
||||||
|
if f.Changed("auto-ptr") {
|
||||||
|
body["auto_ptr"] = autoPTR
|
||||||
|
}
|
||||||
if len(body) == 0 {
|
if len(body) == 0 {
|
||||||
return fmt.Errorf("nothing to change (see --help)")
|
return fmt.Errorf("nothing to change (see --help)")
|
||||||
}
|
}
|
||||||
@@ -288,6 +317,7 @@ and a network between octet boundaries, like a /22, gets one zone per /24
|
|||||||
update.Flags().StringVar(&comment, "comment", "", "comment")
|
update.Flags().StringVar(&comment, "comment", "", "comment")
|
||||||
update.Flags().StringVar(&moveView, "move-to-view", "", "move the zone to this view")
|
update.Flags().StringVar(&moveView, "move-to-view", "", "move the zone to this view")
|
||||||
update.Flags().StringVar(&file, "file", "", "zone file (secondary, hint and redirect zones)")
|
update.Flags().StringVar(&file, "file", "", "zone file (secondary, hint and redirect zones)")
|
||||||
|
update.Flags().BoolVar(&autoPTR, "auto-ptr", false, "keep the PTR records of the zone's A and AAAA records in step (--auto-ptr=false: stop)")
|
||||||
|
|
||||||
var yes bool
|
var yes bool
|
||||||
del := &cobra.Command{
|
del := &cobra.Command{
|
||||||
@@ -416,7 +446,7 @@ equal to the file: records not in the file are deleted.`,
|
|||||||
importCmd.Flags().BoolVar(&replace, "replace", false, "delete records that are not in the file")
|
importCmd.Flags().BoolVar(&replace, "replace", false, "delete records that are not in the file")
|
||||||
importCmd.Flags().BoolVar(&useSOA, "use-soa", false, "also take SOA timers and $TTL from the file")
|
importCmd.Flags().BoolVar(&useSOA, "use-soa", false, "also take SOA timers and $TTL from the file")
|
||||||
|
|
||||||
cmd.AddCommand(list, show, create, update, del, toggle(true), toggle(false), fileCmd, importCmd, zoneSerialsCmd(), zoneDelegationCmd(), zoneDNSSECCmd(), zoneRegistrarCmd())
|
cmd.AddCommand(list, show, create, update, del, toggle(true), toggle(false), fileCmd, importCmd, zoneSerialsCmd(), zoneDelegationCmd(), zoneDNSSECCmd(), zoneRegistrarCmd(), zoneLinkCmd(true), zoneLinkCmd(false), zoneDiffCmd(), zoneFillPTRCmd(), zoneSuggestReverseCmd())
|
||||||
return cmd
|
return cmd
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -456,8 +486,25 @@ const viewsFlagHelp = "view of the zone; several (internal,external) or \"all\"
|
|||||||
func recordCmd() *cobra.Command {
|
func recordCmd() *cobra.Command {
|
||||||
cmd := &cobra.Command{Use: "record", Aliases: []string{"records", "rr"}, Short: "Manage records in primary zones"}
|
cmd := &cobra.Command{Use: "record", Aliases: []string{"records", "rr"}, Short: "Manage records in primary zones"}
|
||||||
var view, name, typ, search, comment, ttlArg string
|
var view, name, typ, search, comment, ttlArg string
|
||||||
var ptr, missingOK, yes, onlyDisabled, wide bool
|
var ptr, missingOK, yes, onlyDisabled, wide, local, shared bool
|
||||||
var id int64
|
var id int64
|
||||||
|
// linkFlags adds --local and --shared (linked zones) to a command.
|
||||||
|
linkFlags := func(c *cobra.Command, what string) {
|
||||||
|
c.Flags().BoolVar(&local, "local", false, "linked zones: "+what+" in this view only (overriding the shared records of this name and type here)")
|
||||||
|
c.Flags().BoolVar(&shared, "shared", false, "linked zones: "+what+" in every linked view (this version becomes every view's)")
|
||||||
|
}
|
||||||
|
linkBody := func(body map[string]any) error {
|
||||||
|
switch {
|
||||||
|
case local && shared:
|
||||||
|
return fmt.Errorf("give --local or --shared, not both")
|
||||||
|
case local:
|
||||||
|
body["local"] = true
|
||||||
|
localFanOut = true
|
||||||
|
case shared:
|
||||||
|
body["local"] = false
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
list := &cobra.Command{
|
list := &cobra.Command{
|
||||||
Use: "list ZONE",
|
Use: "list ZONE",
|
||||||
@@ -479,8 +526,15 @@ func recordCmd() *cobra.Command {
|
|||||||
if err := c.Get(ctx(), path+"/records", qv, &recs); err != nil {
|
if err := c.Get(ctx(), path+"/records", qv, &recs); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
linked := false
|
||||||
|
for _, r := range recs {
|
||||||
|
linked = linked || r.Linked != ""
|
||||||
|
}
|
||||||
return output(recs, func(w io.Writer) {
|
return output(recs, func(w io.Writer) {
|
||||||
rows := [][]string{{"ID", "NAME", "TTL", "TYPE", "DATA", "COMMENT"}}
|
rows := [][]string{{"ID", "NAME", "TTL", "TYPE", "DATA", "COMMENT"}}
|
||||||
|
if linked {
|
||||||
|
rows[0] = []string{"ID", "NAME", "TTL", "TYPE", "LINK", "DATA", "COMMENT"}
|
||||||
|
}
|
||||||
for _, r := range recs {
|
for _, r := range recs {
|
||||||
ttl := fmt.Sprint(r.EffectiveTTL)
|
ttl := fmt.Sprint(r.EffectiveTTL)
|
||||||
if r.TTL == nil {
|
if r.TTL == nil {
|
||||||
@@ -490,10 +544,18 @@ func recordCmd() *cobra.Command {
|
|||||||
if r.Disabled {
|
if r.Disabled {
|
||||||
comment = strings.TrimSpace("[disabled] " + comment)
|
comment = strings.TrimSpace("[disabled] " + comment)
|
||||||
}
|
}
|
||||||
|
if linked {
|
||||||
|
rows = append(rows, []string{fmt.Sprint(r.ID), r.RelativeName, ttl, r.Type, r.Linked, r.Data, comment})
|
||||||
|
continue
|
||||||
|
}
|
||||||
rows = append(rows, []string{fmt.Sprint(r.ID), r.RelativeName, ttl, r.Type, r.Data, comment})
|
rows = append(rows, []string{fmt.Sprint(r.ID), r.RelativeName, ttl, r.Type, r.Data, comment})
|
||||||
}
|
}
|
||||||
if !wide {
|
if !wide {
|
||||||
fitColumn(rows, 4)
|
col := 4
|
||||||
|
if linked {
|
||||||
|
col = 5
|
||||||
|
}
|
||||||
|
fitColumn(rows, col)
|
||||||
}
|
}
|
||||||
for _, row := range rows {
|
for _, row := range rows {
|
||||||
fmt.Fprintln(w, strings.Join(row, "\t"))
|
fmt.Fprintln(w, strings.Join(row, "\t"))
|
||||||
@@ -535,6 +597,9 @@ and splitting are automatic).
|
|||||||
if ptr {
|
if ptr {
|
||||||
body["ptr"] = true
|
body["ptr"] = true
|
||||||
}
|
}
|
||||||
|
if err := linkBody(body); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
views, err := zoneViews(c, args[0], view)
|
views, err := zoneViews(c, args[0], view)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -549,6 +614,7 @@ and splitting are automatic).
|
|||||||
add.Flags().StringVar(&ttlArg, "ttl", "", "TTL in seconds (default: the RRset's or the zone's)")
|
add.Flags().StringVar(&ttlArg, "ttl", "", "TTL in seconds (default: the RRset's or the zone's)")
|
||||||
add.Flags().StringVar(&comment, "comment", "", "comment")
|
add.Flags().StringVar(&comment, "comment", "", "comment")
|
||||||
add.Flags().BoolVar(&ptr, "ptr", false, "also add the PTR record (A/AAAA)")
|
add.Flags().BoolVar(&ptr, "ptr", false, "also add the PTR record (A/AAAA)")
|
||||||
|
linkFlags(add, "add it")
|
||||||
|
|
||||||
var data string
|
var data string
|
||||||
update := &cobra.Command{
|
update := &cobra.Command{
|
||||||
@@ -582,6 +648,9 @@ and splitting are automatic).
|
|||||||
if ptr {
|
if ptr {
|
||||||
body["ptr"] = true
|
body["ptr"] = true
|
||||||
}
|
}
|
||||||
|
if err := linkBody(body); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
if len(body) == 0 {
|
if len(body) == 0 {
|
||||||
return fmt.Errorf("nothing to change (see --help)")
|
return fmt.Errorf("nothing to change (see --help)")
|
||||||
}
|
}
|
||||||
@@ -598,6 +667,8 @@ and splitting are automatic).
|
|||||||
update.Flags().StringVar(&ttlArg, "ttl", "", `new TTL, or "default" for the zone default`)
|
update.Flags().StringVar(&ttlArg, "ttl", "", `new TTL, or "default" for the zone default`)
|
||||||
update.Flags().StringVar(&comment, "comment", "", "new comment")
|
update.Flags().StringVar(&comment, "comment", "", "new comment")
|
||||||
update.Flags().BoolVar(&ptr, "ptr", false, "move the PTR record along (A/AAAA)")
|
update.Flags().BoolVar(&ptr, "ptr", false, "move the PTR record along (A/AAAA)")
|
||||||
|
update.Flags().BoolVar(&local, "local", false, "linked zones: make this name and type local to the record's view (an override)")
|
||||||
|
update.Flags().BoolVar(&shared, "shared", false, "linked zones: share this name and type with the linked views; this view's version becomes every view's")
|
||||||
|
|
||||||
del := &cobra.Command{
|
del := &cobra.Command{
|
||||||
Use: "delete ZONE NAME TYPE [DATA...] | delete --id ID",
|
Use: "delete ZONE NAME TYPE [DATA...] | delete --id ID",
|
||||||
@@ -678,6 +749,9 @@ spaces.
|
|||||||
if comment != "" {
|
if comment != "" {
|
||||||
body["comment"] = comment
|
body["comment"] = comment
|
||||||
}
|
}
|
||||||
|
if err := linkBody(body); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
views, err := zoneViews(c, args[0], view)
|
views, err := zoneViews(c, args[0], view)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -691,6 +765,7 @@ spaces.
|
|||||||
set.Flags().StringVar(&view, "view", "", viewsFlagHelp)
|
set.Flags().StringVar(&view, "view", "", viewsFlagHelp)
|
||||||
set.Flags().StringVar(&ttlArg, "ttl", "", "TTL for the RRset")
|
set.Flags().StringVar(&ttlArg, "ttl", "", "TTL for the RRset")
|
||||||
set.Flags().StringVar(&comment, "comment", "", "comment for new records")
|
set.Flags().StringVar(&comment, "comment", "", "comment for new records")
|
||||||
|
linkFlags(set, "set it")
|
||||||
|
|
||||||
toggle := func(disable bool) *cobra.Command {
|
toggle := func(disable bool) *cobra.Command {
|
||||||
verb := "enable"
|
verb := "enable"
|
||||||
@@ -829,3 +904,421 @@ func fitColumn(rows [][]string, col int) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// zoneLinkCmd is 'zone link' and 'zone unlink' (docs/views.md#linked-zones).
|
||||||
|
func zoneLinkCmd(link bool) *cobra.Command {
|
||||||
|
var view string
|
||||||
|
var with []string
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "link ZONE --view VIEW [--with VIEW...]",
|
||||||
|
Short: "Link zones of the same name in several views: shared records are kept in step",
|
||||||
|
Long: `Links a zone with the zones of the same name in other views (--with, or
|
||||||
|
every view that has one). Jarl then keeps their shared records in step: a
|
||||||
|
change to one reaches the others in the same changeset. Each view can
|
||||||
|
still have records of its own (record add/set --local), which override
|
||||||
|
the shared records of that name and type there, and every zone keeps its
|
||||||
|
own options, so views can still differ in who they answer and how.
|
||||||
|
|
||||||
|
Linking never changes what named answers: a name and type with the same
|
||||||
|
records in every view becomes shared, and one that differs stays local to
|
||||||
|
each view. Share one later from the view whose version is right:
|
||||||
|
jarl record update ID --shared.`,
|
||||||
|
Example: ` jarl zone link adbraun.lol --view external --with vps
|
||||||
|
jarl zone create adbraun.lol --view vps --link-with external # a new zone, linked from the start
|
||||||
|
jarl zone unlink adbraun.lol --view vps`,
|
||||||
|
Args: cobra.ExactArgs(1),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
path, qv := zonePath(args[0], view)
|
||||||
|
verb := "unlink"
|
||||||
|
var body any
|
||||||
|
if link {
|
||||||
|
verb = "link"
|
||||||
|
body = map[string]any{"with": with}
|
||||||
|
}
|
||||||
|
resp, err := c.Mutate(ctx(), "POST", path+"/"+verb, qv, body)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return report(resp)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.Flags().StringVar(&view, "view", "", "view of the zone")
|
||||||
|
if link {
|
||||||
|
cmd.Flags().StringSliceVar(&with, "with", nil, "views to link with (default: every view with a zone of that name)")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
cmd.Use = "unlink ZONE --view VIEW"
|
||||||
|
cmd.Short = "Take a zone out of its link: its records stay, all local"
|
||||||
|
cmd.Long = `Takes a zone out of its link. Its records stay as they are, all local to
|
||||||
|
its view, and the other zones of the link keep theirs. A link left with one
|
||||||
|
zone is dissolved.`
|
||||||
|
cmd.Example = " jarl zone unlink adbraun.lol --view vps"
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
// zoneDiffCmd is 'zone diff': a zone's records side by side in the views
|
||||||
|
// that have it.
|
||||||
|
type compareSet struct {
|
||||||
|
View string `json:"view"`
|
||||||
|
Records []string `json:"records"`
|
||||||
|
IDs []int64 `json:"ids"`
|
||||||
|
Linked string `json:"linked"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type compareRow struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Type string `json:"type"`
|
||||||
|
Views []compareSet `json:"views"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type compareReport struct {
|
||||||
|
Zone string `json:"zone"`
|
||||||
|
Base string `json:"base"`
|
||||||
|
Views []string `json:"views"`
|
||||||
|
Linked bool `json:"linked"`
|
||||||
|
Summary []struct {
|
||||||
|
View string `json:"view"`
|
||||||
|
Different int `json:"different"`
|
||||||
|
OnlyBase int `json:"only_base"`
|
||||||
|
OnlyOther int `json:"only_other"`
|
||||||
|
Same int `json:"same"`
|
||||||
|
} `json:"summary"`
|
||||||
|
Different []compareRow `json:"different"`
|
||||||
|
Only []struct {
|
||||||
|
Views []string `json:"views"`
|
||||||
|
Rows []compareRow `json:"rows"`
|
||||||
|
} `json:"only"`
|
||||||
|
Same int `json:"same"`
|
||||||
|
SameRows []compareRow `json:"same_rows"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func zoneDiffCmd() *cobra.Command {
|
||||||
|
var view string
|
||||||
|
var with []string
|
||||||
|
var all, wide bool
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "diff ZONE [NAME [TYPE]] [--view V] [--with W...] [--all] [--wide]",
|
||||||
|
Short: "Compare a zone with the same zone in other views",
|
||||||
|
Long: `Compares a zone in one view (--view, default the first view that has it)
|
||||||
|
with the same zone in the other views (--with, default all of them): how
|
||||||
|
many names each answers differently, the names and types only some views
|
||||||
|
have, and how many are the same. NAME (and TYPE) narrows it to one name,
|
||||||
|
the same records included. One line per record; long values are cut to
|
||||||
|
fit the terminal (--wide shows them whole).
|
||||||
|
|
||||||
|
In a linked zone a difference is a view's own (local) records, on
|
||||||
|
purpose; between zones that aren't linked it is drift. 'jarl record
|
||||||
|
update ID --shared' makes a linked view's version every view's.`,
|
||||||
|
Example: ` jarl zone diff adbraun.lol
|
||||||
|
jarl zone diff adbraun.lol --view internal --with external
|
||||||
|
jarl zone diff adbraun.lol nas
|
||||||
|
jarl zone diff adbraun.lol @ TXT --wide`,
|
||||||
|
Args: cobra.RangeArgs(1, 3),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
path, qv := zonePath(args[0], view)
|
||||||
|
if len(with) > 0 {
|
||||||
|
qv.Set("with", strings.Join(with, ","))
|
||||||
|
}
|
||||||
|
if len(args) > 1 {
|
||||||
|
qv.Set("name", args[1])
|
||||||
|
}
|
||||||
|
if len(args) > 2 {
|
||||||
|
qv.Set("type", args[2])
|
||||||
|
}
|
||||||
|
if all {
|
||||||
|
qv.Set("all", "1")
|
||||||
|
}
|
||||||
|
var r compareReport
|
||||||
|
if err := c.Get(ctx(), path+"/compare", qv, &r); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
width := 0
|
||||||
|
if !wide {
|
||||||
|
width = terminalWidth()
|
||||||
|
}
|
||||||
|
return output(r, func(w io.Writer) { printCompare(w, &r, len(args) > 1, width) })
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.Flags().StringVar(&view, "view", "", "the view to compare from (default: the first that has the zone)")
|
||||||
|
cmd.Flags().StringArrayVar(&with, "with", nil, "a view to compare with (repeat; default: every other view with the zone)")
|
||||||
|
cmd.Flags().BoolVar(&all, "all", false, "also list what is the same")
|
||||||
|
cmd.Flags().BoolVarP(&wide, "wide", "w", false, "show long values whole instead of cutting them to the terminal")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
// printCompare prints a comparison as sections, one line per record,
|
||||||
|
// each cut to width characters (0: whole).
|
||||||
|
func printCompare(w io.Writer, r *compareReport, oneName bool, width int) {
|
||||||
|
vw := 0 // the views column
|
||||||
|
for _, v := range r.Views {
|
||||||
|
vw = max(vw, len(v))
|
||||||
|
}
|
||||||
|
line := func(indent, label, text string) {
|
||||||
|
s := indent + label + text
|
||||||
|
if width > 0 && utf8.RuneCountInString(s) > width {
|
||||||
|
keep := max(width-utf8.RuneCountInString(indent+label)-1, 8)
|
||||||
|
text = string([]rune(text)[:min(keep, utf8.RuneCountInString(text))]) + "…"
|
||||||
|
}
|
||||||
|
fmt.Fprintln(w, indent+label+text)
|
||||||
|
}
|
||||||
|
link := "not linked, so a difference may have crept in ('jarl zone link " + r.Zone + "' keeps them in step)"
|
||||||
|
if r.Linked {
|
||||||
|
link = "linked: a difference is a view's own records, there on purpose"
|
||||||
|
}
|
||||||
|
fmt.Fprintf(w, "%s in %s, compared with %s\n %s\n", r.Zone, r.Base, strings.Join(r.Views[1:], ", "), link)
|
||||||
|
if !oneName {
|
||||||
|
for _, s := range r.Summary {
|
||||||
|
fmt.Fprintf(w, " %s: %d answered differently, %d only in %s, %d only in %s, %d the same\n", s.View, s.Different, s.OnlyBase, r.Base, s.OnlyOther, s.View, s.Same)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
name := func(row compareRow) string { return row.Name + " " + row.Type }
|
||||||
|
sets := func(row compareRow, local bool) {
|
||||||
|
for _, vs := range row.Views {
|
||||||
|
label := fmt.Sprintf(" %-*s ", vw, vs.View)
|
||||||
|
if len(vs.Records) == 0 {
|
||||||
|
line("", label, "-")
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for i, d := range vs.Records {
|
||||||
|
if i > 0 {
|
||||||
|
label = strings.Repeat(" ", 4+vw+2)
|
||||||
|
}
|
||||||
|
suffix := ""
|
||||||
|
if local && vs.Linked == "local" && i == 0 {
|
||||||
|
suffix = " [local, id " + fmt.Sprint(vs.IDs[0]) + "]"
|
||||||
|
}
|
||||||
|
line("", label, d+suffix)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(r.Different) > 0 {
|
||||||
|
fmt.Fprintf(w, "\nANSWERED DIFFERENTLY (%d)\n", len(r.Different))
|
||||||
|
for _, row := range r.Different {
|
||||||
|
fmt.Fprintln(w, " "+name(row))
|
||||||
|
sets(row, true)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, o := range r.Only {
|
||||||
|
fmt.Fprintf(w, "\nONLY IN %s (%d)\n", strings.ToUpper(strings.Join(o.Views, ", ")), len(o.Rows))
|
||||||
|
nw := 0
|
||||||
|
for _, row := range o.Rows {
|
||||||
|
nw = max(nw, len(name(row)))
|
||||||
|
}
|
||||||
|
for _, row := range o.Rows {
|
||||||
|
var recs []string
|
||||||
|
for _, vs := range row.Views {
|
||||||
|
if len(vs.Records) > 0 {
|
||||||
|
recs = vs.Records
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for i, d := range recs {
|
||||||
|
label := fmt.Sprintf(" %-*s ", nw, name(row))
|
||||||
|
if i > 0 {
|
||||||
|
label = strings.Repeat(" ", 2+nw+2)
|
||||||
|
}
|
||||||
|
line("", label, d)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(r.SameRows) > 0 {
|
||||||
|
fmt.Fprintf(w, "\nTHE SAME IN %s (%d)\n", strings.ToUpper(strings.Join(r.Views, ", ")), len(r.SameRows))
|
||||||
|
nw := 0
|
||||||
|
for _, row := range r.SameRows {
|
||||||
|
nw = max(nw, len(name(row)))
|
||||||
|
}
|
||||||
|
for _, row := range r.SameRows {
|
||||||
|
for i, d := range row.Views[0].Records {
|
||||||
|
label := fmt.Sprintf(" %-*s ", nw, name(row))
|
||||||
|
if i > 0 {
|
||||||
|
label = strings.Repeat(" ", 2+nw+2)
|
||||||
|
}
|
||||||
|
line("", label, d)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else if r.Same > 0 && !oneName {
|
||||||
|
fmt.Fprintf(w, "\n%d names and types are the same (--all lists them)\n", r.Same)
|
||||||
|
}
|
||||||
|
if oneName && len(r.Different) == 0 && len(r.Only) == 0 && len(r.SameRows) == 0 {
|
||||||
|
fmt.Fprintln(w, "\nNo records of that name in these views.")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// terminalWidth returns the terminal's width, or 0 when standard output
|
||||||
|
// isn't a terminal (then nothing is cut).
|
||||||
|
func terminalWidth() int {
|
||||||
|
fd := int(os.Stdout.Fd())
|
||||||
|
if !term.IsTerminal(fd) {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
width, _, err := term.GetSize(fd)
|
||||||
|
if err != nil || width <= 0 {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
return width
|
||||||
|
}
|
||||||
|
|
||||||
|
func zoneFillPTRCmd() *cobra.Command {
|
||||||
|
var view string
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "fill-ptr ZONE [--view VIEW]",
|
||||||
|
Short: "Add the PTR records a reverse zone lacks for its view's A and AAAA records",
|
||||||
|
Long: `Adds a PTR record to a reverse zone for every address in its network that
|
||||||
|
the view's A and AAAA records use and that has none yet. An address with
|
||||||
|
several names gets the mail or name server's name, else a host's rather
|
||||||
|
than the domain's, else the shortest (docs/reverse.md).`,
|
||||||
|
Example: ` jarl zone fill-ptr 10.0.10.0/24
|
||||||
|
jarl zone fill-ptr 10.0.10.in-addr.arpa --view internal`,
|
||||||
|
Args: cobra.ExactArgs(1),
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
path, qv := zonePath(args[0], view)
|
||||||
|
resp, err := c.Mutate(ctx(), "POST", path+"/fill-ptr", qv, nil)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return report(resp)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.Flags().StringVar(&view, "view", "", "view of the zone")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
type reverseSuggestion struct {
|
||||||
|
ViewID int64 `json:"view_id"`
|
||||||
|
View string `json:"view"`
|
||||||
|
Prefix string `json:"prefix"`
|
||||||
|
Zone string `json:"zone"`
|
||||||
|
Group string `json:"group"`
|
||||||
|
Hidden string `json:"hidden"`
|
||||||
|
Why string `json:"why"`
|
||||||
|
Fill int `json:"fill"`
|
||||||
|
Samples []string `json:"samples"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func zoneSuggestReverseCmd() *cobra.Command {
|
||||||
|
var create, all bool
|
||||||
|
var dismiss, undismiss []string
|
||||||
|
var view string
|
||||||
|
cmd := &cobra.Command{
|
||||||
|
Use: "suggest-reverse [--create] [--dismiss NETWORK --view V]",
|
||||||
|
Short: "The reverse zones your private views lack for their records' addresses",
|
||||||
|
Long: `Lists the reverse zones the private views (or the server, without views)
|
||||||
|
lack for the addresses of their A and AAAA records, in two groups:
|
||||||
|
|
||||||
|
yours the /24 of a private IPv4 network, the /48 of a ULA or of an IPv6
|
||||||
|
prefix this server has an address in
|
||||||
|
public a /32 (or /128) for any other public address: create it only if
|
||||||
|
the address is yours, not a web host's
|
||||||
|
|
||||||
|
--create creates the ones that are yours, filled with PTR records, in one
|
||||||
|
changeset; create a public one with 'jarl zone create NETWORK --view V
|
||||||
|
--fill'. --dismiss hides a suggestion for good (--undismiss shows it
|
||||||
|
again). A view can stop suggestions: jarl view update V
|
||||||
|
--reverse-suggestions=false (docs/reverse.md).
|
||||||
|
|
||||||
|
--all lists every network the views' records use without a reverse zone,
|
||||||
|
also where nothing is suggested unasked (a view with suggestions off, a
|
||||||
|
dismissed network, a public view), to create one by hand; --view narrows
|
||||||
|
the list to one view. Change the size as you need: a /48 suggested for
|
||||||
|
IPv6 can be created as a /56 or /64 instead.`,
|
||||||
|
Example: ` jarl zone suggest-reverse
|
||||||
|
jarl zone suggest-reverse --create
|
||||||
|
jarl zone create 139.144.144.154/32 --view internal --fill
|
||||||
|
jarl zone suggest-reverse --dismiss 185.199.108.153/32 --view internal
|
||||||
|
jarl zone suggest-reverse --all --view vps
|
||||||
|
jarl zone create 2a02:8013:7f3d::/48 --view internal --fill`,
|
||||||
|
Args: cobra.NoArgs,
|
||||||
|
RunE: func(cmd *cobra.Command, args []string) error {
|
||||||
|
c, err := newClient()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if len(dismiss) > 0 || len(undismiss) > 0 {
|
||||||
|
path, prefixes := "/reverse-zones/dismiss", dismiss
|
||||||
|
if len(undismiss) > 0 {
|
||||||
|
path, prefixes = "/reverse-zones/undismiss", undismiss
|
||||||
|
}
|
||||||
|
resp, err := c.Mutate(ctx(), "POST", path, nil, map[string]any{"view": view, "prefixes": prefixes})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return report(resp)
|
||||||
|
}
|
||||||
|
if create && (all || view != "") {
|
||||||
|
return fmt.Errorf("--create creates the suggestions that are yours; create others one by one: jarl zone create NETWORK --view VIEW --fill")
|
||||||
|
}
|
||||||
|
qv := q("view", view)
|
||||||
|
if all {
|
||||||
|
qv.Set("all", "1")
|
||||||
|
}
|
||||||
|
var sugg []reverseSuggestion
|
||||||
|
if err := c.Get(ctx(), "/reverse-zones/suggestions", qv, &sugg); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !create {
|
||||||
|
return output(sugg, func(w io.Writer) {
|
||||||
|
if len(sugg) == 0 {
|
||||||
|
fmt.Fprintln(w, "No reverse zones missing.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
head := "GROUP\tVIEW\tNETWORK\tZONE\tPTRS\tFOR EXAMPLE"
|
||||||
|
if all {
|
||||||
|
head = "GROUP\tVIEW\tNETWORK\tZONE\tPTRS\tHIDDEN\tFOR EXAMPLE"
|
||||||
|
}
|
||||||
|
fmt.Fprintln(w, head)
|
||||||
|
for _, s := range sugg {
|
||||||
|
v := s.View
|
||||||
|
if v == "" {
|
||||||
|
v = "-"
|
||||||
|
}
|
||||||
|
cols := []string{s.Group, v, s.Prefix, s.Zone, fmt.Sprint(s.Fill)}
|
||||||
|
if all {
|
||||||
|
cols = append(cols, orDash(s.Hidden))
|
||||||
|
}
|
||||||
|
cols = append(cols, strings.Join(s.Samples, ", "))
|
||||||
|
fmt.Fprintln(w, strings.Join(cols, "\t"))
|
||||||
|
}
|
||||||
|
fmt.Fprintln(w, "\nCreate yours, filled: jarl zone suggest-reverse --create. A public one only if the address is yours:\njarl zone create NETWORK --view VIEW --fill (or hide it: --dismiss NETWORK --view VIEW).")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
var reqs []api.ChangeRequest
|
||||||
|
for _, s := range sugg {
|
||||||
|
if s.Group != "yours" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
body := map[string]any{"name": s.Prefix, "fill": true}
|
||||||
|
if s.ViewID != 0 {
|
||||||
|
body["view_id"] = s.ViewID
|
||||||
|
}
|
||||||
|
data, err := json.Marshal(body)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
reqs = append(reqs, api.ChangeRequest{Op: "zone.create", Data: data})
|
||||||
|
}
|
||||||
|
if len(reqs) == 0 {
|
||||||
|
fmt.Println("No reverse zones of yours missing (public addresses are created one by one: see 'jarl zone suggest-reverse').")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return submitBatch(c, fmt.Sprintf("%d suggested reverse zones", len(reqs)), reqs)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
cmd.Flags().BoolVar(&create, "create", false, "create the ones that are yours, filled with PTR records")
|
||||||
|
cmd.Flags().StringSliceVar(&dismiss, "dismiss", nil, "hide the suggestions for these networks (comma separated or repeated)")
|
||||||
|
cmd.Flags().StringSliceVar(&undismiss, "undismiss", nil, "show dismissed suggestions again")
|
||||||
|
cmd.Flags().StringVar(&view, "view", "", "only this view; with --dismiss/--undismiss: the suggestion's view")
|
||||||
|
cmd.Flags().BoolVar(&all, "all", false, "also networks not suggested unasked (suggestions off, dismissed, public views)")
|
||||||
|
return cmd
|
||||||
|
}
|
||||||
+22
-1
@@ -24,9 +24,11 @@ import (
|
|||||||
|
|
||||||
"jarl/internal/auth"
|
"jarl/internal/auth"
|
||||||
"jarl/internal/bind"
|
"jarl/internal/bind"
|
||||||
|
"jarl/internal/certs"
|
||||||
"jarl/internal/config"
|
"jarl/internal/config"
|
||||||
"jarl/internal/engine"
|
"jarl/internal/engine"
|
||||||
"jarl/internal/model"
|
"jarl/internal/model"
|
||||||
|
"jarl/internal/nscheck"
|
||||||
"jarl/internal/porkbun"
|
"jarl/internal/porkbun"
|
||||||
"jarl/internal/render"
|
"jarl/internal/render"
|
||||||
"jarl/internal/server"
|
"jarl/internal/server"
|
||||||
@@ -122,6 +124,7 @@ func openApp(allowMissingConfig bool) (*app, error) {
|
|||||||
ReloadTimeout: time.Duration(cfg.BIND.ReloadTimeout),
|
ReloadTimeout: time.Duration(cfg.BIND.ReloadTimeout),
|
||||||
NoReload: cfg.BIND.NoReload,
|
NoReload: cfg.BIND.NoReload,
|
||||||
Extras: renderExtras(cfg),
|
Extras: renderExtras(cfg),
|
||||||
|
LocalAddrs: nscheck.LocalAddrs,
|
||||||
}, log)
|
}, log)
|
||||||
eng.Limits = engine.BlocklistLimits{
|
eng.Limits = engine.BlocklistLimits{
|
||||||
Refresh: time.Duration(cfg.Blocking.Refresh), RetryAfter: time.Hour, Timeout: 2 * time.Minute,
|
Refresh: time.Duration(cfg.Blocking.Refresh), RetryAfter: time.Hour, Timeout: 2 * time.Minute,
|
||||||
@@ -148,7 +151,8 @@ func statsOptions(cfg *config.Config) stats.Options {
|
|||||||
sc := cfg.Stats
|
sc := cfg.Stats
|
||||||
o := stats.Options{QueryLog: sc.QueryLog, LogFile: sc.LogFile, StatisticsChannel: sc.StatisticsChannel, TopN: sc.TopN,
|
o := stats.Options{QueryLog: sc.QueryLog, LogFile: sc.LogFile, StatisticsChannel: sc.StatisticsChannel, TopN: sc.TopN,
|
||||||
RetainMinute: time.Duration(sc.Retention.Minute), RetainHour: time.Duration(sc.Retention.Hour), RetainDay: time.Duration(sc.Retention.Day),
|
RetainMinute: time.Duration(sc.Retention.Minute), RetainHour: time.Duration(sc.Retention.Hour), RetainDay: time.Duration(sc.Retention.Day),
|
||||||
Anonymize: sc.AnonymizeClients, MainConfig: cfg.BIND.MainConfig}
|
RetainQueries: time.Duration(sc.Retention.Queries),
|
||||||
|
Anonymize: sc.AnonymizeClients, MainConfig: cfg.BIND.MainConfig}
|
||||||
for _, p := range sc.ExcludeClients {
|
for _, p := range sc.ExcludeClients {
|
||||||
if pf, err := config.ParsePrefix(p); err == nil {
|
if pf, err := config.ParsePrefix(p); err == nil {
|
||||||
o.Exclude = append(o.Exclude, pf.Masked())
|
o.Exclude = append(o.Exclude, pf.Masked())
|
||||||
@@ -185,6 +189,7 @@ func renderExtras(cfg *config.Config) render.Extras {
|
|||||||
h := &render.StatsHooks{Channel: netip.MustParseAddrPort(cfg.Stats.StatisticsChannel)}
|
h := &render.StatsHooks{Channel: netip.MustParseAddrPort(cfg.Stats.StatisticsChannel)}
|
||||||
if cfg.Stats.QueryLog {
|
if cfg.Stats.QueryLog {
|
||||||
h.LogFile, h.LogVersions, h.LogSize = cfg.Stats.LogFile, cfg.Stats.LogVersions, cfg.Stats.LogSize
|
h.LogFile, h.LogVersions, h.LogSize = cfg.Stats.LogFile, cfg.Stats.LogVersions, cfg.Stats.LogSize
|
||||||
|
h.NoRateLimitLog = !cfg.Stats.RateLimitLog
|
||||||
}
|
}
|
||||||
x.Stats = h
|
x.Stats = h
|
||||||
}
|
}
|
||||||
@@ -308,6 +313,18 @@ func serveCmd() *cobra.Command {
|
|||||||
a.log.Warn("the configuration file holds metrics.token and everyone can read it; make it readable only by root and jarld (chown root:jarl, chmod 640)", "file", configPath)
|
a.log.Warn("the configuration file holds metrics.token and everyone can read it; make it readable only by root and jarld (chown root:jarl, chmod 640)", "file", configPath)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
cm := certs.New(certs.Config{
|
||||||
|
Directory: a.cfg.ACME.Account.DirectoryURL(), Email: a.cfg.ACME.Account.Email, AgreeTOS: a.cfg.ACME.Account.AgreeTOS,
|
||||||
|
EABKeyID: a.cfg.ACME.Account.EABKeyID, EABHMAC: a.cfg.ACME.Account.EABHMAC,
|
||||||
|
Resolvers: a.cfg.ACME.Resolvers, CABundle: a.cfg.ACME.CABundle, CheckPropagation: a.cfg.ACME.CheckPropagation,
|
||||||
|
Dir: a.cfg.CertDir(), Version: version.String(), Porkbun: pb, PorkbunAllows: a.cfg.Porkbun.Allows,
|
||||||
|
}, a.store, a.eng, a.log)
|
||||||
|
cm.Start(ctx)
|
||||||
|
if a.cfg.ACME.Account.EABHMAC != "" {
|
||||||
|
if fi, err := os.Stat(configPath); err == nil && fi.Mode().Perm()&0o004 != 0 {
|
||||||
|
a.log.Warn("the configuration file holds acme.account.eab_hmac and everyone can read it; make it readable only by root and jarld (chown root:jarl, chmod 640)", "file", configPath)
|
||||||
|
}
|
||||||
|
}
|
||||||
srv := server.New(server.Config{
|
srv := server.New(server.Config{
|
||||||
Listen: a.cfg.Listen, TLSCertFile: a.cfg.TLS.CertFile, TLSKeyFile: a.cfg.TLS.KeyFile,
|
Listen: a.cfg.Listen, TLSCertFile: a.cfg.TLS.CertFile, TLSKeyFile: a.cfg.TLS.KeyFile,
|
||||||
TrustedProxies: a.cfg.Proxies(), SessionLifetime: time.Duration(a.cfg.Session.Lifetime),
|
TrustedProxies: a.cfg.Proxies(), SessionLifetime: time.Duration(a.cfg.Session.Lifetime),
|
||||||
@@ -318,6 +335,9 @@ func serveCmd() *cobra.Command {
|
|||||||
TOTPRequire: a.cfg.TOTP.Require, TOTPIssuer: a.cfg.TOTP.IssuerName(),
|
TOTPRequire: a.cfg.TOTP.Require, TOTPIssuer: a.cfg.TOTP.IssuerName(),
|
||||||
Metrics: server.Metrics{Enabled: a.cfg.Metrics.Enabled, Listen: a.cfg.Metrics.Listen,
|
Metrics: server.Metrics{Enabled: a.cfg.Metrics.Enabled, Listen: a.cfg.Metrics.Listen,
|
||||||
Allow: a.cfg.Metrics.AllowPrefixes(), Token: a.cfg.Metrics.Token},
|
Allow: a.cfg.Metrics.AllowPrefixes(), Token: a.cfg.Metrics.Token},
|
||||||
|
Certs: cm,
|
||||||
|
Resolvers: a.cfg.ACME.Resolvers,
|
||||||
|
RateLimitLog: a.cfg.Stats.Enabled && a.cfg.Stats.QueryLog && a.cfg.Stats.RateLimitLog,
|
||||||
HTTPReq: server.HTTPReq{
|
HTTPReq: server.HTTPReq{
|
||||||
Enabled: a.cfg.ACME.HTTPReq.Enabled,
|
Enabled: a.cfg.ACME.HTTPReq.Enabled,
|
||||||
AllowPlainHTTP: !a.cfg.ACME.HTTPReq.RequireHTTPS,
|
AllowPlainHTTP: !a.cfg.ACME.HTTPReq.RequireHTTPS,
|
||||||
@@ -335,6 +355,7 @@ func serveCmd() *cobra.Command {
|
|||||||
}()
|
}()
|
||||||
go auditRetention(ctx, a)
|
go auditRetention(ctx, a)
|
||||||
go blocklistLoop(ctx, a)
|
go blocklistLoop(ctx, a)
|
||||||
|
go cm.Run(ctx)
|
||||||
a.log.Info("jarld starting", "version", version.String(), "database", a.cfg.Database, "bind_config", a.cfg.BIND.ConfigDir)
|
a.log.Info("jarld starting", "version", version.String(), "database", a.cfg.Database, "bind_config", a.cfg.BIND.ConfigDir)
|
||||||
err = srv.Serve(ctx, func() { sdNotify("READY=1\nSTATUS=serving") })
|
err = srv.Serve(ctx, func() { sdNotify("READY=1\nSTATUS=serving") })
|
||||||
sdNotify("STOPPING=1")
|
sdNotify("STOPPING=1")
|
||||||
|
|||||||
@@ -1,5 +1,11 @@
|
|||||||
# Let's Encrypt (ACME DNS-01) with Jarl
|
# Let's Encrypt (ACME DNS-01) with Jarl
|
||||||
|
|
||||||
|
This page is about **other** ACME clients (certbot, acme.sh, lego,
|
||||||
|
Traefik) publishing their DNS-01 challenges through Jarl. For
|
||||||
|
certificates for the DNS server itself (Jarl's web UI, named's DNS over
|
||||||
|
TLS and HTTPS), Jarl can be the ACME client: see
|
||||||
|
[certificates.md](certificates.md).
|
||||||
|
|
||||||
The DNS-01 challenge proves that you control a domain by publishing a TXT
|
The DNS-01 challenge proves that you control a domain by publishing a TXT
|
||||||
record at `_acme-challenge.<domain>`. Jarl does this through its API, so no
|
record at `_acme-challenge.<domain>`. Jarl does this through its API, so no
|
||||||
dynamic updates (`allow-update`, nsupdate) are needed. That matters because
|
dynamic updates (`allow-update`, nsupdate) are needed. That matters because
|
||||||
|
|||||||
+57
-2
@@ -190,6 +190,7 @@ ZoneInput:
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "adbraun.lol", // or a CIDR like "192.168.1.0/24" for a reverse zone
|
"name": "adbraun.lol", // or a CIDR like "192.168.1.0/24" for a reverse zone
|
||||||
|
"fill": true, // reverse zones: PTR records for the view's A/AAAA records there
|
||||||
"view": "internal", // or "view_id"; moving a zone = PATCH with another view
|
"view": "internal", // or "view_id"; moving a zone = PATCH with another view
|
||||||
"type": "primary", // secondary, stub, static-stub, forward, mirror, hint, redirect, in-view
|
"type": "primary", // secondary, stub, static-stub, forward, mirror, hint, redirect, in-view
|
||||||
"in_view": "internal", // type in-view only
|
"in_view": "internal", // type in-view only
|
||||||
@@ -199,6 +200,7 @@ ZoneInput:
|
|||||||
"default_ttl": 3600,
|
"default_ttl": 3600,
|
||||||
"serial_policy": "date", // date, increment, unixtime
|
"serial_policy": "date", // date, increment, unixtime
|
||||||
"dnssec_policy": "default", // primary zones: "" (off), "default", a custom policy, "insecure" (turning off)
|
"dnssec_policy": "default", // primary zones: "" (off), "default", a custom policy, "insecure" (turning off)
|
||||||
|
"auto_ptr": true, // keep the PTRs of the zone's A/AAAA records in step (docs/reverse.md)
|
||||||
"comment": "",
|
"comment": "",
|
||||||
// create only:
|
// create only:
|
||||||
"nameservers": ["ns1.adbraun.lol."], // default: settings
|
"nameservers": ["ns1.adbraun.lol."], // default: settings
|
||||||
@@ -208,6 +210,11 @@ ZoneInput:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
A reverse zone created without a view goes to the private view whose
|
||||||
|
records use its addresses. Zones come back with `prefix` (reverse zones:
|
||||||
|
the network) and `ptr_missing` (addresses in it that the view's A and AAAA
|
||||||
|
records use, without a PTR record).
|
||||||
|
|
||||||
`/serials` and `/delegation` send DNS queries from the server, and only
|
`/serials` and `/delegation` send DNS queries from the server, and only
|
||||||
when called ([operations.md](operations.md#checking-name-servers-and-the-delegation)).
|
when called ([operations.md](operations.md#checking-name-servers-and-the-delegation)).
|
||||||
`/serials` works for primary, secondary and mirror zones:
|
`/serials` works for primary, secondary and mirror zones:
|
||||||
@@ -342,6 +349,25 @@ registrar_error`.
|
|||||||
|
|
||||||
### Records
|
### Records
|
||||||
|
|
||||||
|
In a linked zone ([views.md](views.md#linked-zones)), records carry
|
||||||
|
`shared_id` and `linked` (`shared` or `local`). Creating, updating
|
||||||
|
(`PATCH /records/{id}`) and setting (`PUT .../rrsets/...`) take `"local":
|
||||||
|
true` (this view only, an override) or `false` (shared; on an update or a
|
||||||
|
set it makes this view's version every view's). Zones carry `link_group`
|
||||||
|
and `linked_with` (the other views).
|
||||||
|
|
||||||
|
| Method | Path | Body |
|
||||||
|
|--------|------|------|
|
||||||
|
| POST | `/zones/{zone}/link` | `{"with": ["external"]}` (default: every view with that zone). Names and types that are the same everywhere become shared, the rest stay local |
|
||||||
|
| POST | `/zones/{zone}/unlink` | Takes the zone out of its link; its records stay, all local |
|
||||||
|
| POST | `/zones/{zone}/fill-ptr` | Adds the PTR records a reverse zone lacks for its view's A and AAAA records ([reverse.md](reverse.md)) |
|
||||||
|
| GET | `/reverse-zones/suggestions` | The reverse zones the private views lack (`?all=1`: also the ones not suggested unasked, with `hidden`: public view, suggestions off, dismissed; `?view=`: one view): `view_id`, `view`, `prefix`, `zone`, `group` (`yours`, or `public`: only if the address is yours), `why`, `fill` (PTR records it would get), `samples` |
|
||||||
|
| POST | `/reverse-zones/dismiss` | `{"view": "internal", "prefix": "185.199.108.153/32"}` (or `"prefixes": [...]` for several): don't suggest it again (`/undismiss` brings it back). A view's `reverse_suggestions: false` (PATCH `/views/{id}`) stops its suggestions |
|
||||||
|
| GET | `/zones/{zone}/compare` | The zone compared with the same zone in other views, from its own view ([views.md](views.md#comparing-views)): `?with=a,b` (default: all), `?name=www&type=A` (one name, the same records included), `?all=1`. Returns `base`, `views`, `linked`, `summary` (per other view: `different`, `only_base`, `only_other`, `same`), `different` and `only` (`views`, `rows`) rows (name, `fqdn`, type, per view `records`, `data`, `ids`, `ttl`, `linked`), `same`, `same_rows`. A zone named without its view is compared from the first view that has it |
|
||||||
|
|
||||||
|
`POST /zones` takes `"link_with": "VIEW"` to create a zone linked with
|
||||||
|
that view's zone of the same name.
|
||||||
|
|
||||||
| Method | Path | Body / query |
|
| Method | Path | Body / query |
|
||||||
|--------|------|--------------|
|
|--------|------|--------------|
|
||||||
| GET | `/zones/{zone}/records` | `?name=`, `?type=`, `?q=`, `?disabled=1` (only disabled records) or `0` (only enabled ones) |
|
| GET | `/zones/{zone}/records` | `?name=`, `?type=`, `?q=`, `?disabled=1` (only disabled records) or `0` (only enabled ones) |
|
||||||
@@ -454,7 +480,8 @@ listing with `?changeset=` marks them `pending`.
|
|||||||
|
|
||||||
| Method | Path | Body / query |
|
| Method | Path | Body / query |
|
||||||
|--------|------|--------------|
|
|--------|------|--------------|
|
||||||
| GET | `/options` | `?scope=options\|view\|zone\|toplevel&scope_id=ID` (none: everything you may see) |
|
| GET | `/options` | `?scope=options\|view\|zone\|toplevel&scope_id=ID` (none: everything you may see). `formatted` lays out a block over several lines, a list of three or more one element per line |
|
||||||
|
| GET | `/options/generated` | What Jarl adds to named.conf by itself: `where`, `text`, `why`, `setting` (what turns it on or off) |
|
||||||
| POST | `/options` | `{"scope": "zone", "scope_id": 11, "name": "allow-transfer", "value": "{ key xfer; }", "comment": "", "position": 0}` |
|
| POST | `/options` | `{"scope": "zone", "scope_id": 11, "name": "allow-transfer", "value": "{ key xfer; }", "comment": "", "position": 0}` |
|
||||||
| GET / PATCH / DELETE | `/options/{id}` | |
|
| GET / PATCH / DELETE | `/options/{id}` | |
|
||||||
| GET / PATCH | `/settings` | `{"nameservers": [...], "rname": "...", "default_ttl": 3600, "refresh": ..., "retry": ..., "expire": ..., "negative_ttl": ..., "serial_policy": "date"}` |
|
| GET / PATCH | `/settings` | `{"nameservers": [...], "rname": "...", "default_ttl": 3600, "refresh": ..., "retry": ..., "expire": ..., "negative_ttl": ..., "serial_policy": "date"}` |
|
||||||
@@ -471,6 +498,7 @@ written in Jarl's fixed order (docs/concepts.md).
|
|||||||
| GET | `/catalog/options` | scopes and zone types; with `?scope=options\|view\|toplevel\|zone:primary\|...` every statement allowed there (name, grammar, kind, status, ARM description). `?all=1` includes statements Jarl manages itself |
|
| GET | `/catalog/options` | scopes and zone types; with `?scope=options\|view\|toplevel\|zone:primary\|...` every statement allowed there (name, grammar, kind, status, ARM description). `?all=1` includes statements Jarl manages itself |
|
||||||
| GET | `/catalog/rrtypes` | record types with field hints and examples |
|
| GET | `/catalog/rrtypes` | record types with field hints and examples |
|
||||||
| GET | `/catalog/grants` | resources, roles and the grant syntax |
|
| GET | `/catalog/grants` | resources, roles and the grant syntax |
|
||||||
|
| GET | `/exposure` | which views are reachable from the internet, the exposure findings and their fixes ([exposure.md](exposure.md#api)); `POST /exposure/fix`, `/exposure/ack`, `/exposure/unack` |
|
||||||
| GET | `/catalog/ranges?r=A-B,C-D` | for each address range: `range` (canonical), `size` ("99 addresses"), and the `prefixes` it is written to named.conf as; or `error`. Text that isn't a range is left out |
|
| GET | `/catalog/ranges?r=A-B,C-D` | for each address range: `range` (canonical), `size` ("99 addresses"), and the `prefixes` it is written to named.conf as; or `error`. Text that isn't a range is left out |
|
||||||
| GET | `/search?q=text` | zones, records and ACLs matching the text |
|
| GET | `/search?q=text` | zones, records and ACLs matching the text |
|
||||||
|
|
||||||
@@ -523,6 +551,10 @@ in it and its records.
|
|||||||
|
|
||||||
### Query statistics
|
### Query statistics
|
||||||
|
|
||||||
|
Every statistics endpoint below takes `views=internal,vps` to limit the
|
||||||
|
figures to those views ([stats.md](stats.md#views)); a breakdown that only
|
||||||
|
exists for the whole server then answers `400 not_per_view`.
|
||||||
|
|
||||||
Needs `stats:read`. When statistics are disabled, every endpoint but
|
Needs `stats:read`. When statistics are disabled, every endpoint but
|
||||||
`status` answers 404 `stats_disabled`. See [stats.md](stats.md).
|
`status` answers 404 `stats_disabled`. See [stats.md](stats.md).
|
||||||
|
|
||||||
@@ -533,13 +565,36 @@ Needs `stats:read`. When statistics are disabled, every endpoint but
|
|||||||
| GET | `/stats/timeline` | `since`, `step` (auto, 1m, 5m, 15m, 1h, 6h, 1d), `key` (repeatable or comma separated; `rcode:*` = every counter of a group; default `queries`) | `{step, times: [unix...], series: [{key, values}]}` |
|
| GET | `/stats/timeline` | `since`, `step` (auto, 1m, 5m, 15m, 1h, 6h, 1d), `key` (repeatable or comma separated; `rcode:*` = every counter of a group; default `queries`) | `{step, times: [unix...], series: [{key, values}]}` |
|
||||||
| GET | `/stats/top` | `kind` (name, client, nxdomain, servfail, refused, blocked, blocked_client), `since`, `limit` (default 20) | `[{key, count}]`; client, refused and blocked_client entries add `name`, the host name of Jarl's record for the address (the summary's client list too) |
|
| GET | `/stats/top` | `kind` (name, client, nxdomain, servfail, refused, blocked, blocked_client), `since`, `limit` (default 20) | `[{key, count}]`; client, refused and blocked_client entries add `name`, the host name of Jarl's record for the address (the summary's client list too) |
|
||||||
| GET | `/stats/heatmap` | `since` (default 28d), `key` (default queries) | `{key, from, avg[7][24], samples[7][24]}`, Monday first, local time, `-1` = no data |
|
| GET | `/stats/heatmap` | `since` (default 28d), `key` (default queries) | `{key, from, avg[7][24], samples[7][24]}`, Monday first, local time, `-1` = no data |
|
||||||
| GET | `/stats/server` | | `{server: {rss, mem_in_use, cpu_percent, threads, pid, cache_rrsets, cache_mem, sockets_udp, sockets_tcp, recursion_highwater, tcp_highwater, version, boot_time, config_time, host: {mem_total, mem_available, load, cpus, uptime}}, named: {recursive_clients, tcp_clients, zones, cpus, worker_threads}, disks: [{path, holds, total, free}]}`; gauges over time: `/stats/timeline?key=g:named:rss` (averages, -1 without a sample) |
|
| GET | `/stats/explore` | `?client=&name=&domain=&view=&type=&rcode=&blocked=yes\|no\|LIST&since=24h&views=`; each takes several values, comma separated (any of them), `!value` to leave one out, and names `*.example.com` for it and below | The query log for a filter ([stats.md](stats.md#exploring)): `total`, `blocked`, `series` (per `step` seconds: `t`, `count`, `blocked`), `by` (top 15 of each dimension the filter leaves open: client, name, view, type, rcode, blocked; clients with `name`), `recent` (latest 100: ts, client, client_name, view, name, type, rcode, blocked), `oldest`, `retention`, `client_name`. 404 `query_log_off` without a query log |
|
||||||
|
| GET | `/stats/server` | | `{server: {rss, mem_in_use, cpu_percent, threads, pid, cache_rrsets, cache_mem, sockets_udp, sockets_tcp, recursion_highwater, tcp_highwater, version, boot_time, config_time, host: {mem_total, mem_available, load, cpus, uptime}}, named: {recursive_clients, tcp_clients, zones, cpus, worker_threads}, disks: [{path, holds, total, free}], database: {path, bytes, query_log_rows}}`; gauges over time: `/stats/timeline?key=g:named:rss` (averages, -1 without a sample) |
|
||||||
| GET | `/stats/breakdown` | `group` (qtype, rcode, view, zone, answer, transport, rtt, dnssec, cache, ratelimit, blocklist), `since` | `[{key, count}]` |
|
| GET | `/stats/breakdown` | `group` (qtype, rcode, view, zone, answer, transport, rtt, dnssec, cache, ratelimit, blocklist), `since` | `[{key, count}]` |
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
curl -sf -H "$AUTH" "$API/stats/top?kind=nxdomain&since=7d&limit=10" | jq -r '.[] | "\(.count)\t\(.key)"'
|
curl -sf -H "$AUTH" "$API/stats/top?kind=nxdomain&since=7d&limit=10" | jq -r '.[] | "\(.count)\t\(.key)"'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Encrypted DNS
|
||||||
|
|
||||||
|
See [encrypted-dns.md](encrypted-dns.md#api): `GET`, `POST` and `DELETE
|
||||||
|
/encrypted-dns`, `POST /encrypted-dns/check`.
|
||||||
|
|
||||||
|
### Certificates
|
||||||
|
|
||||||
|
Administrators only. See [certificates.md](certificates.md#api).
|
||||||
|
|
||||||
|
| Method | Path | Body |
|
||||||
|
|--------|------|------|
|
||||||
|
| GET | `/certificates` | `certificates` (with `status`, `next_attempt`, `issuing_since`, `serving`, `files`) and `account` |
|
||||||
|
| POST | `/certificates` | `{"name", "domains", "uses", "challenge", "key_type", "comment"}`, or `{"name", "source": "file", "cert_file", "key_file", "uses"}`; `"issue": false` doesn't start obtaining it |
|
||||||
|
| POST | `/certificates/check` | `{"domains", "challenge"}`: the route of each challenge |
|
||||||
|
| GET, PATCH, DELETE | `/certificates/{name}` | |
|
||||||
|
| POST | `/certificates/{name}/issue` | 202: being obtained (poll until `issuing_since` is gone); a file certificate is reread (200) |
|
||||||
|
| POST | `/certificates/{name}/check` | the routes of a certificate's names |
|
||||||
|
|
||||||
|
`GET /status` includes `certificates` for administrators: `total`,
|
||||||
|
`problems` (failing, expiring, expired), `next` and `next_after`,
|
||||||
|
`serving`.
|
||||||
|
|
||||||
### ACME: lego's httpreq provider
|
### ACME: lego's httpreq provider
|
||||||
|
|
||||||
Off unless `acme.httpreq.enabled` is set, and by default HTTPS only. The
|
Off unless `acme.httpreq.enabled` is set, and by default HTTPS only. The
|
||||||
|
|||||||
@@ -0,0 +1,260 @@
|
|||||||
|
# TLS certificates
|
||||||
|
|
||||||
|
Jarl can obtain TLS certificates from an ACME CA (Let's Encrypt by
|
||||||
|
default) and renew them itself, and put them where they are used:
|
||||||
|
|
||||||
|
- **web**: jarld's own HTTPS (the web UI, the API and the CLI's server).
|
||||||
|
- **dns**: files named can read, for DNS over TLS (DoT) and DNS over HTTPS
|
||||||
|
(DoH) in named's `tls` blocks.
|
||||||
|
|
||||||
|
One certificate can have both uses. Jarl answers the ACME DNS-01
|
||||||
|
challenge itself: in a zone it serves, or through Porkbun's API while
|
||||||
|
Porkbun still serves the domain. So no other ACME client, hook script or
|
||||||
|
DNS provider plugin is needed, and the server doesn't have to be
|
||||||
|
reachable on port 80 or 443 from the internet.
|
||||||
|
|
||||||
|
A certificate you renew some other way (certbot, acme.sh, your own CA)
|
||||||
|
can be used too: Jarl reads it from its files and rereads it when they
|
||||||
|
change.
|
||||||
|
|
||||||
|
In the web UI: **Certificates** (administrators). In the CLI: `jarl cert`.
|
||||||
|
In the API: `/api/v1/certificates`. All of it is for administrators only:
|
||||||
|
a certificate's key can impersonate your server.
|
||||||
|
|
||||||
|
## Quick start
|
||||||
|
|
||||||
|
1. Set up the ACME account in `/etc/jarl/jarl.yaml` and restart jarld
|
||||||
|
(`systemctl restart jarl`). Try Let's Encrypt's staging CA first: its
|
||||||
|
certificates aren't trusted by browsers, but its rate limits are
|
||||||
|
generous, so mistakes cost nothing.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
acme:
|
||||||
|
account:
|
||||||
|
directory: letsencrypt-staging # then: letsencrypt
|
||||||
|
email: you@adbraun.lol # optional
|
||||||
|
agree_tos: true # after reading https://letsencrypt.org/repository/
|
||||||
|
```
|
||||||
|
|
||||||
|
2. See where the challenges would go, without asking the CA for anything:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl cert check --domain ns1.adbraun.lol
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
NAME ROUTE RECORD WHY
|
||||||
|
ns1.adbraun.lol porkbun _acme-challenge.ns1.adbraun.lol adbraun.lol is served by Porkbun (curitiba.ns.porkbun.com, ...), so the record goes in through Porkbun's API
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Create the certificate. Jarl obtains it at once; the command waits for
|
||||||
|
the outcome (usually under a minute, a few minutes through Porkbun):
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl cert create ns1 --domain ns1.adbraun.lol --use web --use dns
|
||||||
|
```
|
||||||
|
|
||||||
|
4. When it works, switch `directory` to `letsencrypt`, restart jarld and
|
||||||
|
renew: `jarl cert issue ns1`.
|
||||||
|
|
||||||
|
From then on jarld renews it by itself.
|
||||||
|
|
||||||
|
## The ACME account
|
||||||
|
|
||||||
|
| Setting | Default | |
|
||||||
|
|--|--|--|
|
||||||
|
| `acme.account.directory` | `letsencrypt` | `letsencrypt`, `letsencrypt-staging`, or the directory URL of another ACME CA (ZeroSSL, Google, step-ca, ...). |
|
||||||
|
| `acme.account.email` | `""` | Contact address for the CA (optional; Let's Encrypt no longer sends expiry mails). |
|
||||||
|
| `acme.account.agree_tos` | `false` | You accept the CA's terms of service. Jarl registers no account without it, and says so. |
|
||||||
|
| `acme.account.eab_kid`, `eab_hmac` | `""` | External Account Binding, for CAs that need it (ZeroSSL, Google): from the CA's dashboard. |
|
||||||
|
| `acme.resolvers` | `1.1.1.1:53`, `9.9.9.9:53`, `8.8.8.8:53` | Recursive resolvers Jarl uses to see a domain as the CA does (below). |
|
||||||
|
| `acme.ca_bundle` | `""` | A PEM file of extra CA certificates to trust when talking to the ACME server (a private CA). |
|
||||||
|
| `acme.check_propagation` | `true` | Before telling the CA to look, wait until every name server of the zone serves the challenge (asked directly on port 53). |
|
||||||
|
| `certificates.dir` | `<bind.config_dir>/tls` | Where certificates with the dns use are written for named. |
|
||||||
|
|
||||||
|
The account is registered with the first certificate, and its key is
|
||||||
|
kept in Jarl's database. Changing `directory` registers a new account with
|
||||||
|
that CA; changing `email` updates the account.
|
||||||
|
|
||||||
|
## Where the challenge goes
|
||||||
|
|
||||||
|
For each name on a certificate, the CA looks up a TXT record at
|
||||||
|
`_acme-challenge.<name>` (a wildcard `*.example.com` uses
|
||||||
|
`_acme-challenge.example.com`). Jarl first looks the name up the way the
|
||||||
|
CA will, through `acme.resolvers` (public resolvers, not this server,
|
||||||
|
which may answer from an internal view), following a CNAME on
|
||||||
|
`_acme-challenge` if there is one. Then it finds the zone that holds the
|
||||||
|
record on the internet and that zone's public name servers:
|
||||||
|
|
||||||
|
| The zone's public name servers | Route | Jarl writes the record |
|
||||||
|
|--|--|--|
|
||||||
|
| Porkbun's (`*.ns.porkbun.com`), with `porkbun.api_key` set | `porkbun` | through Porkbun's DNS API (TTL 600, Porkbun's minimum), and deletes it afterwards. The key is the one the registrar features use ([configuration.md](configuration.md#porkbun-registrar-and-dns-host)); it needs DNS record write access, "API Access" switched on for the domain, and the domain in `porkbun.domains` if you set that |
|
||||||
|
| the name servers in Jarl's own zone of that name | `jarl` | in that zone, in every view that has it, as a change by `system` (in the history) |
|
||||||
|
| anything else | none | nowhere: the certificate fails with what to do |
|
||||||
|
|
||||||
|
The certificate's `challenge` setting chooses:
|
||||||
|
|
||||||
|
- **`auto`** (the default) decides again at **every** issue and renewal.
|
||||||
|
While Porkbun serves `adbraun.lol`, the challenge goes to Porkbun. Once
|
||||||
|
you point the domain's name servers at your own servers, the next
|
||||||
|
renewal writes into Jarl's zone instead. Nothing needs changing.
|
||||||
|
- **`jarl`** or **`porkbun`** pins the route. Jarl still checks that the
|
||||||
|
CA will see the record there and refuses to try otherwise (no wasted
|
||||||
|
attempt against the CA's rate limits).
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl cert update ns1 --challenge porkbun # or jarl, or auto
|
||||||
|
```
|
||||||
|
|
||||||
|
`jarl cert check NAME` (or **Check the names** in the web UI) shows the
|
||||||
|
route for each name, and why, at any time.
|
||||||
|
|
||||||
|
### Domains Jarl can't write to: a CNAME
|
||||||
|
|
||||||
|
For a domain whose DNS is elsewhere (Cloudflare, say), point the
|
||||||
|
challenge name at a zone this server serves on the internet, once, by
|
||||||
|
hand:
|
||||||
|
|
||||||
|
```
|
||||||
|
_acme-challenge.www.example.org. CNAME www-example-org.acme.adbraun.lol.
|
||||||
|
```
|
||||||
|
|
||||||
|
Jarl follows the CNAME and writes the record at its target, in its zone
|
||||||
|
`acme.adbraun.lol` (which must be delegated to this server). Renewals
|
||||||
|
never touch the other provider again. That is the same idea as
|
||||||
|
[acme.md section 7](acme.md#7-a-dedicated-acme-zone-cname-delegation).
|
||||||
|
|
||||||
|
## Renewal
|
||||||
|
|
||||||
|
jarld looks at every certificate every 10 minutes:
|
||||||
|
|
||||||
|
- A certificate Jarl obtains is renewed at the time the CA suggests
|
||||||
|
(ACME Renewal Information, RFC 9773; asked twice a day, so a CA that
|
||||||
|
needs to replace certificates early, e.g. after revoking them, gets its
|
||||||
|
way), or, without one, two thirds into its lifetime: day 60 of a 90-day
|
||||||
|
certificate. Each renewal makes a new key.
|
||||||
|
- When obtaining fails, jarld tries again after 1, 2, 4, 8, 16 hours, then
|
||||||
|
daily. The dashboard and the Certificates page show the error; so do
|
||||||
|
`jarl cert list` and Prometheus (`jarl_certificate_failing`).
|
||||||
|
- New names or a new key type on a certificate make it due at once.
|
||||||
|
- `jarl cert issue NAME` (**Renew** in the web UI) obtains it now. It runs
|
||||||
|
in the background: the command waits and reports, the web page updates
|
||||||
|
itself.
|
||||||
|
|
||||||
|
A certificate counts as **expiring** (a warning) when less than a sixth of
|
||||||
|
its lifetime is left, which for a renewing certificate means renewal has
|
||||||
|
been failing for a while; and **expired** after its end.
|
||||||
|
|
||||||
|
## Use: web (jarld's HTTPS)
|
||||||
|
|
||||||
|
Only one certificate can have the web use. As soon as it has been
|
||||||
|
obtained, jarld serves it on all its `listen` addresses, **without a
|
||||||
|
restart**: each port speaks HTTPS and plain HTTP side by side.
|
||||||
|
|
||||||
|
- HTTPS connections get the certificate (HTTP/2 included).
|
||||||
|
- Plain HTTP from this server itself (`127.0.0.1`, `::1`) is served as
|
||||||
|
before, so local scripts and `--server http://127.0.0.1:8053` keep
|
||||||
|
working. So is plain HTTP from `trusted_proxies`.
|
||||||
|
- Plain HTTP from anywhere else: browsers are redirected to
|
||||||
|
`https://<the same host and port>`; API requests get `400
|
||||||
|
https_required` (and, if they carried a token, a note that it crossed
|
||||||
|
the network unencrypted).
|
||||||
|
|
||||||
|
Point browsers and CLIs at the certificate's name:
|
||||||
|
`jarl config set server https://ns1.adbraun.lol:8053`. A CLI that uses the
|
||||||
|
server's IP address fails the name check.
|
||||||
|
|
||||||
|
A managed certificate takes over from `tls.cert_file`. Taking the web use
|
||||||
|
off (or deleting the certificate) goes back to `tls.cert_file`, or to
|
||||||
|
plain HTTP.
|
||||||
|
|
||||||
|
## Use: dns (for named)
|
||||||
|
|
||||||
|
Jarl writes the certificate to `<certificates.dir>/<name>/`:
|
||||||
|
|
||||||
|
```
|
||||||
|
/etc/bind/jarl/tls/ns1/fullchain.pem (0644)
|
||||||
|
/etc/bind/jarl/tls/ns1/privkey.pem (0640, group bind)
|
||||||
|
```
|
||||||
|
|
||||||
|
Debian's AppArmor profile lets named read `/etc/bind`, and group `bind`
|
||||||
|
lets it read the key. When a renewal changes the files and named's
|
||||||
|
configuration names them, Jarl runs `rndc reconfig`, and named serves the
|
||||||
|
new certificate at once (checked with BIND 9.20: DoT keeps working, with
|
||||||
|
the new certificate).
|
||||||
|
|
||||||
|
`jarl encrypted-dns setup` sets up DNS over TLS and HTTPS with it
|
||||||
|
([encrypted-dns.md](encrypted-dns.md)). By hand, a `tls` statement names
|
||||||
|
the files:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl option set tls 'dot { cert-file "/etc/bind/jarl/tls/ns1/fullchain.pem"; key-file "/etc/bind/jarl/tls/ns1/privkey.pem"; }' --toplevel
|
||||||
|
jarl option set listen-on 'port 853 tls dot { 10.0.10.5; }' --add
|
||||||
|
```
|
||||||
|
|
||||||
|
The Certificates page (and `jarl cert show`) says what named uses each
|
||||||
|
for: `DNS over TLS on 10.0.10.5, fd00::5 port 853`, `DNS over HTTPS on
|
||||||
|
… port 443`, or a hand-written `tls` statement no listener uses.
|
||||||
|
|
||||||
|
A certificate named uses can't be deleted or lose its `dns` use until
|
||||||
|
named no longer names its files. If you change `certificates.dir`, jarld
|
||||||
|
writes the certificates to the new place when it starts and points the
|
||||||
|
`tls` statements encrypted DNS wrote there (a hand-written `tls`
|
||||||
|
statement you change yourself).
|
||||||
|
|
||||||
|
## A certificate you renew yourself
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl cert create own --cert-file /etc/ssl/ns1/fullchain.pem --key-file /etc/ssl/ns1/privkey.pem --use web
|
||||||
|
```
|
||||||
|
|
||||||
|
Jarl checks that the key belongs to the certificate, warns when the file
|
||||||
|
holds only the certificate without its intermediates (use the full
|
||||||
|
chain), and rereads both files when they change (within 10 minutes, or at
|
||||||
|
once with `jarl cert issue own`). A pair that doesn't match is reported
|
||||||
|
and the last good one stays in use. jarld runs as user `jarl`, which must
|
||||||
|
be able to read both files (e.g. `chgrp jarl` and `chmod 640`, or have
|
||||||
|
your renewal hook copy them somewhere it can read).
|
||||||
|
|
||||||
|
## Security notes
|
||||||
|
|
||||||
|
- Certificates Jarl obtains, their keys and the ACME account key are kept
|
||||||
|
in Jarl's database, so they are in its backups (like TSIG secrets). The
|
||||||
|
API never returns a key.
|
||||||
|
- Every publicly trusted certificate is published in Certificate
|
||||||
|
Transparency logs, with all its names. A name like `ns1.adbraun.lol`
|
||||||
|
used for both the web UI and DNS reveals less than separate names. Avoid
|
||||||
|
wildcards where one name will do: a wildcard's key is good for every
|
||||||
|
name in the domain.
|
||||||
|
- Using one certificate for jarld and named puts its key in two places.
|
||||||
|
On one server, where jarld already writes named's configuration, that
|
||||||
|
changes little.
|
||||||
|
|
||||||
|
## API
|
||||||
|
|
||||||
|
| Method | Path | |
|
||||||
|
|--|--|--|
|
||||||
|
| GET | `/certificates` | `certificates` (each with `status` {`state`: ok, pending, failing, expiring, expired; `message`}, `next_attempt`, `issuing_since` while being obtained, `serving`, `files`) and `account` |
|
||||||
|
| POST | `/certificates` | `{"name": "ns1", "domains": [...], "uses": ["web", "dns"], "challenge": "auto", "key_type": "ec256"}`, or `{"name", "source": "file", "cert_file", "key_file", "uses"}`. One Jarl obtains starts being obtained at once (`"issue": false` leaves it to the loop) |
|
||||||
|
| POST | `/certificates/check` | `{"domains": [...], "challenge": "auto"}`: where each challenge would go (`routes`: `route`, `target`, `zone`, `public_ns`, `why` or `error`) |
|
||||||
|
| GET, PATCH, DELETE | `/certificates/{name}` | `domains` and `uses` replace the whole list |
|
||||||
|
| POST | `/certificates/{name}/issue` | obtain now: 202, then poll `GET /certificates/{name}` until `issuing_since` is gone; a file certificate is reread (200) |
|
||||||
|
| POST | `/certificates/{name}/check` | the routes for an existing certificate |
|
||||||
|
|
||||||
|
## Testing with Pebble
|
||||||
|
|
||||||
|
[Pebble](https://github.com/letsencrypt/pebble) is Let's Encrypt's test
|
||||||
|
CA. Point it at a test named, and Jarl at it:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker run -d --name pebble --network host -e PEBBLE_VA_NOSLEEP=1 \
|
||||||
|
ghcr.io/letsencrypt/pebble -config test/config/pebble-config.json -dnsserver 127.0.0.1:53
|
||||||
|
docker cp pebble:/test/certs/pebble.minica.pem /etc/jarl/pebble.pem
|
||||||
|
```
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
acme:
|
||||||
|
account: {directory: "https://localhost:14000/dir", agree_tos: true}
|
||||||
|
resolvers: ["127.0.0.1:53"]
|
||||||
|
ca_bundle: /etc/jarl/pebble.pem
|
||||||
|
```
|
||||||
+84
-1
@@ -143,6 +143,7 @@ to stderr with `-o json` or `-o yaml`, so stdout holds just the documents.
|
|||||||
| `-n, --dry-run` | Validate and show the diff without changing anything. |
|
| `-n, --dry-run` | Validate and show the diff without changing anything. |
|
||||||
| `-C, --changeset ID` | Stage the change into an open changeset instead of applying it. |
|
| `-C, --changeset ID` | Stage the change into an open changeset instead of applying it. |
|
||||||
| `--force` | Overwrite BIND files that were changed outside Jarl (drift). |
|
| `--force` | Overwrite BIND files that were changed outside Jarl (drift). |
|
||||||
|
| `--accept-risk` | Confirm a change that opens a public view up, such as an open resolver ([exposure.md](exposure.md)). Without it such a change stops with exit 5. |
|
||||||
| `-q, --quiet` | Print only errors, or just the IDs: of what a command creates, or what `show` and `list` find (like `-o id`). |
|
| `-q, --quiet` | Print only errors, or just the IDs: of what a command creates, or what `show` and `list` find (like `-o id`). |
|
||||||
|
|
||||||
## Exit codes
|
## Exit codes
|
||||||
@@ -176,6 +177,13 @@ jarl zone create lab.adbraun.lol --ns ns1.adbraun.lol.
|
|||||||
jarl zone create 192.168.20.0/24 # reverse zone from a network
|
jarl zone create 192.168.20.0/24 # reverse zone from a network
|
||||||
jarl zone create 10.0.8.0/22 # four zones, 8-11.0.10.in-addr.arpa
|
jarl zone create 10.0.8.0/22 # four zones, 8-11.0.10.in-addr.arpa
|
||||||
jarl zone create 10.0.10.100/32 # a zone for just that address
|
jarl zone create 10.0.10.100/32 # a zone for just that address
|
||||||
|
jarl zone create 10.0.10.0/24 --fill # in the view whose records use it, with their PTRs
|
||||||
|
jarl zone fill-ptr 10.0.10.0/24 # add the PTRs it lacks (zone commands take a network too)
|
||||||
|
jarl zone suggest-reverse [--create] # reverse zones your private views lack (--create: yours)
|
||||||
|
jarl zone suggest-reverse --dismiss 185.199.108.153/32,185.199.109.153/32 --view internal # not yours: don't suggest them again
|
||||||
|
jarl zone suggest-reverse --all [--view V] # every network without a reverse zone, also the hidden ones
|
||||||
|
jarl view update vps --reverse-suggestions=false # no suggestions for this view
|
||||||
|
jarl zone update adbraun.lol --auto-ptr # keep PTRs in step with the A/AAAA records (docs/reverse.md)
|
||||||
jarl zone create adbraun.lol --view external --clone-from adbraun.lol --clone-view internal
|
jarl zone create adbraun.lol --view external --clone-from adbraun.lol --clone-view internal
|
||||||
jarl zone create partner.example --type secondary --primary "192.0.2.53 key xfer"
|
jarl zone create partner.example --type secondary --primary "192.0.2.53 key xfer"
|
||||||
jarl zone create consul --type forward --forwarder "127.0.0.1 port 8600"
|
jarl zone create consul --type forward --forwarder "127.0.0.1 port 8600"
|
||||||
@@ -210,6 +218,20 @@ router, answers for the rest of the /24. IPv4 networks smaller than a /24
|
|||||||
are deleted. Try it with `--dry-run` first. `--option "NAME VALUE"` on
|
are deleted. Try it with `--dry-run` first. `--option "NAME VALUE"` on
|
||||||
`zone create` sets any zone option in the same step.
|
`zone create` sets any zone option in the same step.
|
||||||
|
|
||||||
|
Linked zones ([views.md](views.md#linked-zones)) keep their shared
|
||||||
|
records in step across views:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl zone link adbraun.lol --view internal --with external
|
||||||
|
jarl zone create adbraun.lol --view vps --link-with external
|
||||||
|
jarl zone unlink adbraun.lol --view vps
|
||||||
|
jarl record add adbraun.lol nas A 10.0.10.20 --view internal --local # this view only
|
||||||
|
jarl record set adbraun.lol www A 10.0.10.5 --view internal --local # override the shared www A here
|
||||||
|
jarl record update 1234 --local | --shared
|
||||||
|
jarl zone diff adbraun.lol [--view V] [--with W] [--all] [--wide] # compared with the same zone in other views
|
||||||
|
jarl zone diff adbraun.lol nas [A] # just one name
|
||||||
|
```
|
||||||
|
|
||||||
When a zone exists in several views, add `--view NAME` to commands that
|
When a zone exists in several views, add `--view NAME` to commands that
|
||||||
name it.
|
name it.
|
||||||
|
|
||||||
@@ -294,7 +316,9 @@ adds the quotes and splits long values into 255-byte strings. In reverse zones t
|
|||||||
host name (a bare `nas` is refused, since it would mean
|
host name (a bare `nas` is refused, since it would mean
|
||||||
`nas.0.10.10.in-addr.arpa.`). `--ptr`
|
`nas.0.10.10.in-addr.arpa.`). `--ptr`
|
||||||
keeps the PTR record in the reverse zone in step (when that zone is managed
|
keeps the PTR record in the reverse zone in step (when that zone is managed
|
||||||
by Jarl). Every record type BIND supports can be used. Jarl knows the
|
by Jarl); `jarl record update ID --ptr` with nothing else adds the PTR record
|
||||||
|
if it is missing, e.g. after creating the reverse zone. In linked zones, the
|
||||||
|
reverse zones of every linked view count. Every record type BIND supports can be used. Jarl knows the
|
||||||
syntax of the common ones and checks them strictly, and the rest are
|
syntax of the common ones and checks them strictly, and the rest are
|
||||||
validated by parsing.
|
validated by parsing.
|
||||||
|
|
||||||
@@ -382,6 +406,51 @@ an administrator).
|
|||||||
|
|
||||||
Changesets staged in the web UI show up here too, and the other way round.
|
Changesets staged in the web UI show up here too, and the other way round.
|
||||||
|
|
||||||
|
## Internet exposure
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl exposure # public views, findings, fixes, rate limiting
|
||||||
|
jarl exposure fix external exposure_rate_limit # rate limiting, log-only first
|
||||||
|
jarl exposure fix external exposure_rate_limit_log_only # then start enforcing
|
||||||
|
jarl exposure fix server exposure_version
|
||||||
|
jarl exposure mail # reverse DNS of the addresses that send and receive mail
|
||||||
|
jarl exposure ack external security_open_resolver --reason "public resolver, monitored"
|
||||||
|
jarl exposure unack external security_open_resolver
|
||||||
|
jarl view update external --exposure public|private|auto
|
||||||
|
```
|
||||||
|
|
||||||
|
See [exposure.md](exposure.md).
|
||||||
|
|
||||||
|
## Encrypted DNS
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl encrypted-dns # what is set up, what to give clients
|
||||||
|
jarl encrypted-dns setup --hostname dns.adbraun.lol --address 10.0.10.5 [--address IPv6] [--doh-port 8443] [--no-doh]
|
||||||
|
jarl encrypted-dns check --address 10.0.10.5 --doh-port 443
|
||||||
|
jarl encrypted-dns health # check the listeners now, as a client would
|
||||||
|
jarl encrypted-dns disable
|
||||||
|
```
|
||||||
|
|
||||||
|
See [encrypted-dns.md](encrypted-dns.md).
|
||||||
|
|
||||||
|
## Certificates
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl cert check --domain ns1.adbraun.lol # where each challenge would go, and why
|
||||||
|
jarl cert create ns1 --domain ns1.adbraun.lol --use web --use dns # obtained at once; waits
|
||||||
|
jarl cert create wild -d adbraun.lol -d '*.adbraun.lol' --use dns --key-type ec384
|
||||||
|
jarl cert create own --cert-file /etc/ssl/ns1/fullchain.pem --key-file /etc/ssl/ns1/privkey.pem --use web
|
||||||
|
jarl cert list
|
||||||
|
jarl cert show ns1
|
||||||
|
jarl cert issue ns1 # renew now (--no-wait to return at once)
|
||||||
|
jarl cert update ns1 --challenge porkbun # auto, jarl or porkbun
|
||||||
|
jarl cert update ns1 --use dns # --use and --domain replace the list (--use none)
|
||||||
|
jarl cert delete ns1
|
||||||
|
jarl cert account # the ACME account (set in jarl.yaml)
|
||||||
|
```
|
||||||
|
|
||||||
|
Administrators only. See [certificates.md](certificates.md).
|
||||||
|
|
||||||
## Views, ACLs, TSIG keys, options, settings
|
## Views, ACLs, TSIG keys, options, settings
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
@@ -413,11 +482,22 @@ jarl option set allow-transfer 'key xfer; 10.0.10.53' --zone adbraun.lol
|
|||||||
jarl option set allow-query '10.0.20.1-10.0.20.99; localhost' --view internal
|
jarl option set allow-query '10.0.20.1-10.0.20.99; localhost' --view internal
|
||||||
jarl option set response-policy '{ zone "rpz.local"; }' --view internal
|
jarl option set response-policy '{ zone "rpz.local"; }' --view internal
|
||||||
jarl option set logging '{ channel q { file "/var/log/named/query.log" versions 3 size 20m; }; category queries { q; }; }' --toplevel
|
jarl option set logging '{ channel q { file "/var/log/named/query.log" versions 3 size 20m; }; category queries { q; }; }' --toplevel
|
||||||
|
jarl option set tls 'quad9 { remote-hostname "dns.quad9.net"; ca-file "/etc/ssl/certs/ca-certificates.crt"; }' --toplevel
|
||||||
|
jarl option set tls 'cloudflare { remote-hostname "cloudflare-dns.com"; }' --toplevel # tls quad9 stays
|
||||||
|
jarl option unset tls cloudflare --toplevel # statements with a name: say which
|
||||||
jarl option unset forwarders
|
jarl option unset forwarders
|
||||||
jarl option describe # every option allowed at this scope
|
jarl option describe # every option allowed at this scope
|
||||||
jarl option describe allow-query-cache # grammar and ARM description
|
jarl option describe allow-query-cache # grammar and ARM description
|
||||||
|
jarl option generated # what Jarl adds to named.conf by itself, and why
|
||||||
```
|
```
|
||||||
|
|
||||||
|
`option set` replaces the option of that name. Statements told apart by
|
||||||
|
the name after the keyword (`tls NAME`, `key NAME`, `remote-servers NAME`,
|
||||||
|
`http NAME`, `dnssec-policy NAME`, `server ADDRESS`, ...) replace only the
|
||||||
|
one with that name; `--add` adds another instance of any other option that
|
||||||
|
may occur several times. Forwarding to Quad9 or Cloudflare over TLS:
|
||||||
|
[encrypted-dns.md](encrypted-dns.md#forwarding-over-tls).
|
||||||
|
|
||||||
Options that end in a list (`allow-*`, `forwarders`, `listen-on`, ...) may
|
Options that end in a list (`allow-*`, `forwarders`, `listen-on`, ...) may
|
||||||
be given without the braces: elements are separated by `;`, `,` or spaces,
|
be given without the braces: elements are separated by `;`, `,` or spaces,
|
||||||
and `key NAME` and `port N` stay with their element. Options are always
|
and `key NAME` and `port N` stay with their element. Options are always
|
||||||
@@ -472,6 +552,9 @@ working.
|
|||||||
|
|
||||||
## Query statistics
|
## Query statistics
|
||||||
|
|
||||||
|
`--view internal,vps` (or repeated) limits any `jarl stats` command to those
|
||||||
|
views ([stats.md](stats.md#views)).
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
jarl stats status
|
jarl stats status
|
||||||
jarl stats summary --since 7d
|
jarl stats summary --since 7d
|
||||||
|
|||||||
@@ -48,6 +48,14 @@ overwritten. Jarl records a checksum of every file it writes and reports
|
|||||||
**drift** when a file changes behind its back. It then refuses to overwrite
|
**drift** when a file changes behind its back. It then refuses to overwrite
|
||||||
the file until you say so (`--force`, or `jarl resync --force`).
|
the file until you say so (`--force`, or `jarl resync --force`).
|
||||||
|
|
||||||
|
Some of named.conf comes from Jarl itself rather than from your options:
|
||||||
|
the include of keys.conf, the statistics channel and the logging
|
||||||
|
statistics need, blocking's `response-policy` and policy zones, and the
|
||||||
|
view keys at the front of each view's `match-clients`. The Server options
|
||||||
|
page lists them under **Added by Jarl**, with why each is there and what
|
||||||
|
turns it on or off (`jarl option generated`). Where you have a statement
|
||||||
|
of your own (`logging`, `statistics-channels`), Jarl merges into it.
|
||||||
|
|
||||||
Comments are part of the data model: zones, records, ACLs, views, keys and
|
Comments are part of the data model: zones, records, ACLs, views, keys and
|
||||||
options can all carry a comment, and Jarl writes it into the generated file.
|
options can all carry a comment, and Jarl writes it into the generated file.
|
||||||
Comments in imported zone files are kept.
|
Comments in imported zone files are kept.
|
||||||
@@ -250,6 +258,11 @@ boundary. So:
|
|||||||
(RFC 2317 delegation, where an ISP hands you part of a /24, is set up by
|
(RFC 2317 delegation, where an ISP hands you part of a /24, is set up by
|
||||||
hand with CNAMEs.)
|
hand with CNAMEs.)
|
||||||
|
|
||||||
|
Jarl suggests the reverse zones your private views lack, creates them in
|
||||||
|
the right view filled with PTR records, and can keep PTR records in step
|
||||||
|
with a zone's A and AAAA records: [reverse.md](reverse.md). A zone created
|
||||||
|
inside another (a /24 inside a /8) takes the parent's records under it.
|
||||||
|
|
||||||
### Dynamic updates and TSIG keys
|
### Dynamic updates and TSIG keys
|
||||||
|
|
||||||
Jarl writes every zone file, so it can't let named change a zone through
|
Jarl writes every zone file, so it can't let named change a zone through
|
||||||
|
|||||||
+33
-7
@@ -20,7 +20,7 @@ The CLI has its own small configuration file, described in [cli.md](cli.md).
|
|||||||
|-----|---------|---------|
|
|-----|---------|---------|
|
||||||
| `listen` | `["127.0.0.1:8053"]` | Addresses to listen on (`host:port`, several allowed). Keep these on localhost and management networks. Ports below 1024 (`"192.168.10.2:443"`) work because `jarl.service` gives jarld the `CAP_NET_BIND_SERVICE` capability, and only that ([HTTPS on port 443](#example-https-on-port-443)). |
|
| `listen` | `["127.0.0.1:8053"]` | Addresses to listen on (`host:port`, several allowed). Keep these on localhost and management networks. Ports below 1024 (`"192.168.10.2:443"`) work because `jarl.service` gives jarld the `CAP_NET_BIND_SERVICE` capability, and only that ([HTTPS on port 443](#example-https-on-port-443)). |
|
||||||
| `socket` | `/run/jarl/jarl.sock` | A local unix socket for the API. Requests on it from root or jarld's own user need no token and have administrator rights; anyone else must send a token ([permissions.md](permissions.md#the-local-socket)). The `jarl` CLI uses it when no server is configured. At most 107 bytes long; `""` turns it off. If it can't be created, jarld logs a warning and serves the network addresses only. |
|
| `socket` | `/run/jarl/jarl.sock` | A local unix socket for the API. Requests on it from root or jarld's own user need no token and have administrator rights; anyone else must send a token ([permissions.md](permissions.md#the-local-socket)). The `jarl` CLI uses it when no server is configured. At most 107 bytes long; `""` turns it off. If it can't be created, jarld logs a warning and serves the network addresses only. |
|
||||||
| `tls.cert_file`, `tls.key_file` | (empty: plain HTTP) | PEM certificate chain and key. Both or neither. The files are rechecked every 10 minutes and on SIGHUP (`systemctl reload jarl`), so renewed certificates are used without a restart. |
|
| `tls.cert_file`, `tls.key_file` | (empty: plain HTTP) | PEM certificate chain and key. Both or neither. The files are rechecked every 10 minutes and on SIGHUP (`systemctl reload jarl`), so renewed certificates are used without a restart. Easier: let Jarl obtain and renew one ([certificates.md](certificates.md), use `web`), which takes over from these. With a certificate, the `listen` ports serve HTTPS and plain HTTP side by side: plain HTTP is still served to this server itself and to `trusted_proxies`; anyone else is sent to HTTPS. |
|
||||||
| `trusted_proxies` | `[]` | Addresses or prefixes of reverse proxies whose `X-Forwarded-For` and `X-Forwarded-Proto` (or `Forwarded: proto=`) headers are believed. Needed for correct client IPs in the audit log and for rate limiting behind a proxy, and for knowing that a proxied request came over HTTPS (the session cookie's Secure flag, `acme.httpreq`). From other addresses these headers are ignored. |
|
| `trusted_proxies` | `[]` | Addresses or prefixes of reverse proxies whose `X-Forwarded-For` and `X-Forwarded-Proto` (or `Forwarded: proto=`) headers are believed. Needed for correct client IPs in the audit log and for rate limiting behind a proxy, and for knowing that a proxied request came over HTTPS (the session cookie's Secure flag, `acme.httpreq`). From other addresses these headers are ignored. |
|
||||||
| `session.lifetime` | `12h` | A web session ends this long after login... |
|
| `session.lifetime` | `12h` | A web session ends this long after login... |
|
||||||
| `session.idle_timeout` | `2h` | ...or after this long without requests. |
|
| `session.idle_timeout` | `2h` | ...or after this long without requests. |
|
||||||
@@ -85,6 +85,23 @@ configuration. Changing it takes effect when jarld restarts.
|
|||||||
Query counters need `stats.enabled` as well. Changes take effect when jarld
|
Query counters need `stats.enabled` as well. Changes take effect when jarld
|
||||||
restarts.
|
restarts.
|
||||||
|
|
||||||
|
### Certificates (ACME account)
|
||||||
|
|
||||||
|
The account Jarl obtains certificates with, and where it writes them for
|
||||||
|
named. See [certificates.md](certificates.md). Changes take effect when
|
||||||
|
jarld restarts.
|
||||||
|
|
||||||
|
| Key | Default | Meaning |
|
||||||
|
|-----|---------|---------|
|
||||||
|
| `acme.account.directory` | `letsencrypt` | `letsencrypt`, `letsencrypt-staging` or an ACME directory URL (`https://...`). |
|
||||||
|
| `acme.account.email` | `""` | Contact address for the CA (optional). |
|
||||||
|
| `acme.account.agree_tos` | `false` | You accept the CA's terms of service; no account is registered without it. |
|
||||||
|
| `acme.account.eab_kid`, `acme.account.eab_hmac` | `""` | External Account Binding, for CAs that need it. Both or neither. Keep the file readable only by root and jarld. |
|
||||||
|
| `acme.resolvers` | `["1.1.1.1:53", "9.9.9.9:53", "8.8.8.8:53"]` | Recursive resolvers (`address:port`) used to see domains as the CA does: their zone, public name servers, and a CNAME on `_acme-challenge`. Not this server: it may answer from an internal view. |
|
||||||
|
| `acme.ca_bundle` | `""` | PEM file of extra CA certificates to trust for the ACME server (a private CA). |
|
||||||
|
| `acme.check_propagation` | `true` | Wait until every name server of the zone serves a challenge before the CA is told to look (they are asked directly, on port 53). |
|
||||||
|
| `certificates.dir` | `<bind.config_dir>/tls` | Where certificates with the `dns` use are written for named: `<dir>/<name>/fullchain.pem` and `privkey.pem`. |
|
||||||
|
|
||||||
### ACME (lego httpreq endpoint)
|
### ACME (lego httpreq endpoint)
|
||||||
|
|
||||||
An endpoint for lego's `httpreq` DNS provider, so lego and Traefik can
|
An endpoint for lego's `httpreq` DNS provider, so lego and Traefik can
|
||||||
@@ -126,18 +143,27 @@ there (`ReadWritePaths`). If you change them, update both
|
|||||||
ReadWritePaths=/srv/bind/jarl /srv/bind/zones
|
ReadWritePaths=/srv/bind/jarl /srv/bind/zones
|
||||||
```
|
```
|
||||||
|
|
||||||
### Porkbun (registrar)
|
### Porkbun (registrar and DNS host)
|
||||||
|
|
||||||
With an API key, Jarl can show and set a domain's name servers, glue
|
With an API key, Jarl can:
|
||||||
records and DNSSEC DS records at Porkbun, after checking that the change
|
|
||||||
won't break the domain ([dnssec.md](dnssec.md#porkbun)). Without a key
|
- show and set a domain's name servers, glue records and DNSSEC DS records
|
||||||
(the default) nothing about Porkbun shows up.
|
at Porkbun, after checking that the change won't break the domain
|
||||||
|
([dnssec.md](dnssec.md#porkbun));
|
||||||
|
- publish the DNS-01 challenges of certificates it obtains while Porkbun
|
||||||
|
still serves the domain's DNS ([certificates.md](certificates.md#where-the-challenge-goes)):
|
||||||
|
it only adds TXT records at `_acme-challenge` names and removes them
|
||||||
|
again.
|
||||||
|
|
||||||
|
Without a key (the default) nothing about Porkbun shows up, and
|
||||||
|
certificates for domains Porkbun serves can't be obtained (`jarl cert
|
||||||
|
check` says so).
|
||||||
|
|
||||||
| Key | Default | Meaning |
|
| Key | Default | Meaning |
|
||||||
|-----|---------|---------|
|
|-----|---------|---------|
|
||||||
| `porkbun.api_key` | `""` | The API key (`pk1_...`). Set both or neither. |
|
| `porkbun.api_key` | `""` | The API key (`pk1_...`). Set both or neither. |
|
||||||
| `porkbun.secret_api_key` | `""` | Its secret (`sk1_...`). |
|
| `porkbun.secret_api_key` | `""` | Its secret (`sk1_...`). |
|
||||||
| `porkbun.domains` | `[]` | Only these domains (default: every primary zone the key can reach). |
|
| `porkbun.domains` | `[]` | Only these domains, for both uses (default: any domain the key can reach). |
|
||||||
|
|
||||||
The key can move your domain anywhere, so it is only ever read from this
|
The key can move your domain anywhere, so it is only ever read from this
|
||||||
file: it isn't stored in the database or backups, and there is no API to
|
file: it isn't stored in the database or backups, and there is no API to
|
||||||
|
|||||||
+7
-1
@@ -118,7 +118,13 @@ checker tests work with the installed `bind9-utils` too.
|
|||||||
ACME hooks, DNSSEC signing, backup and restore with keys, audit) and checks
|
ACME hooks, DNSSEC signing, backup and restore with keys, audit) and checks
|
||||||
the answers with `dig`. The Porkbun code is tested against
|
the answers with `dig`. The Porkbun code is tested against
|
||||||
`porkbun.Fake`, an in-memory stand-in for its API; nothing calls the real
|
`porkbun.Fake`, an in-memory stand-in for its API; nothing calls the real
|
||||||
one. `KEEP=1` leaves named
|
one. With Docker, certificates are tested end to end against
|
||||||
|
[Pebble](https://github.com/letsencrypt/pebble), Let's Encrypt's test CA
|
||||||
|
(`ghcr.io/letsencrypt/pebble`, host network, ports 14000 and 15000),
|
||||||
|
which checks the challenges against the test named: obtaining, HTTPS
|
||||||
|
from jarld, DNS over TLS from named, renewal. `PEBBLE=0` skips that; the
|
||||||
|
certs package's own tests use a fake DNS server and `porkbun.Fake`, and
|
||||||
|
never a real CA. `KEEP=1` leaves named
|
||||||
and jarld running afterwards. The output says where; set `JARL_CLI_CONFIG`
|
and jarld running afterwards. The output says where; set `JARL_CLI_CONFIG`
|
||||||
to that directory's `cli.yaml` to keep using the CLI against it.
|
to that directory's `cli.yaml` to keep using the CLI against it.
|
||||||
|
|
||||||
|
|||||||
+7
-3
@@ -175,13 +175,17 @@ Before you go public:
|
|||||||
## Porkbun
|
## Porkbun
|
||||||
|
|
||||||
With a Porkbun API key, Jarl manages a domain's name servers, glue records
|
With a Porkbun API key, Jarl manages a domain's name servers, glue records
|
||||||
and DS records at Porkbun, and checks each change before making it.
|
and DS records at Porkbun, and checks each change before making it. The
|
||||||
|
same key also lets Jarl publish the DNS-01 challenges of its own
|
||||||
|
certificates while Porkbun serves the domain's DNS
|
||||||
|
([certificates.md](certificates.md#where-the-challenge-goes)).
|
||||||
|
|
||||||
**Setting it up**
|
**Setting it up**
|
||||||
|
|
||||||
1. At porkbun.com, *Account → API Access*: create a key. If you can,
|
1. At porkbun.com, *Account → API Access*: create a key. If you can,
|
||||||
limit it to the domain and the permissions it needs (domains, read),
|
limit it to the domain and the permissions it needs, and to your
|
||||||
and to your server's address.
|
server's address. The registrar features need the domain permissions;
|
||||||
|
certificate challenges need DNS record write access too.
|
||||||
2. On the domain's page, switch **API Access** on (Porkbun refuses API
|
2. On the domain's page, switch **API Access** on (Porkbun refuses API
|
||||||
calls for a domain until you do).
|
calls for a domain until you do).
|
||||||
3. Put the key in `/etc/jarl/jarl.yaml` and restart jarld:
|
3. Put the key in `/etc/jarl/jarl.yaml` and restart jarld:
|
||||||
|
|||||||
@@ -0,0 +1,237 @@
|
|||||||
|
# DNS over TLS and HTTPS
|
||||||
|
|
||||||
|
named (BIND 9.20) can answer over encrypted connections itself: DNS over
|
||||||
|
TLS (DoT, port 853) and DNS over HTTPS (DoH, at `/dns-query`). Your
|
||||||
|
phones, laptops and browsers then ask this server without anyone on the
|
||||||
|
network seeing or changing their queries, and they get exactly what plain
|
||||||
|
DNS gives them: the same views, the same records and the same blocking.
|
||||||
|
|
||||||
|
Jarl sets it up in one step: a certificate for the host name clients
|
||||||
|
connect to (obtained and renewed by Jarl, [certificates.md](certificates.md)),
|
||||||
|
named's `tls` statement and listeners on the addresses you choose, and the
|
||||||
|
host name's address records in your private views.
|
||||||
|
|
||||||
|
In the web UI: **Encrypted DNS** (administrators). In the CLI: `jarl
|
||||||
|
encrypted-dns`. In the API: `/api/v1/encrypted-dns`.
|
||||||
|
|
||||||
|
That is encryption between your clients and this server. For encryption
|
||||||
|
between this server and the resolvers it forwards to (Quad9, Cloudflare),
|
||||||
|
see [Forwarding over TLS](#forwarding-over-tls) below.
|
||||||
|
|
||||||
|
## Setting it up
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl encrypted-dns setup --hostname dns.adbraun.lol --address 10.0.10.5 --address 2a02:8013:7f3d:10::5
|
||||||
|
jarl encrypted-dns setup --hostname dns.adbraun.lol --address 10.0.10.5=internal --address 203.0.113.5=external
|
||||||
|
```
|
||||||
|
|
||||||
|
This:
|
||||||
|
|
||||||
|
1. **finds or obtains the certificate**: one Jarl manages whose names cover
|
||||||
|
the host name (`--certificate NAME` to pick one), or a new one named
|
||||||
|
after the host name's first label, which Jarl obtains from the CA (the
|
||||||
|
command waits). The certificate gets the `dns` use, so it is written
|
||||||
|
where named can read it, and named rereads it on every renewal.
|
||||||
|
2. **checks the ports**: nothing else may listen on the chosen addresses
|
||||||
|
on port 853 or the DoH port. Jarl looks at the host's listening sockets
|
||||||
|
(it binds nothing) and says what is in the way, e.g. `jarld (Jarl's web
|
||||||
|
UI and API) listens on 10.0.10.5 port 443`, and which port is free
|
||||||
|
instead (`--doh-port 8443`).
|
||||||
|
3. **stages named's configuration**, as one change you can review:
|
||||||
|
|
||||||
|
```
|
||||||
|
tls jarl-dns { cert-file ".../tls/dns/fullchain.pem"; key-file ".../tls/dns/privkey.pem"; protocols { TLSv1.2; TLSv1.3; }; };
|
||||||
|
options {
|
||||||
|
listen-on port 853 tls jarl-dns { 10.0.10.5; };
|
||||||
|
listen-on port 443 tls jarl-dns http default { 10.0.10.5; };
|
||||||
|
listen-on-v6 port 853 tls jarl-dns { 2a02:8013:7f3d:10::5; };
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
named listens on port 53 on every address only while there is no
|
||||||
|
`listen-on` statement at all. The first one, for DoT, would end that, so
|
||||||
|
when you have none the setup adds `listen-on { any; };` (and the same
|
||||||
|
for IPv6) to keep plain DNS where it was.
|
||||||
|
4. **adds the host names' A and AAAA records**, each address in the views
|
||||||
|
you give it: `--address 10.0.10.5=internal,lab`, or every address in
|
||||||
|
the views of `--view` (default: the private views that have a zone for
|
||||||
|
the name). A view's clients should only be given an address they can
|
||||||
|
reach, so a private address in a public view gets a warning. The
|
||||||
|
records are local to their view (in a linked zone the other views keep
|
||||||
|
theirs), and a view you no longer give an address loses it; other
|
||||||
|
records of the names stay.
|
||||||
|
|
||||||
|
**Several host names** (`--hostname dns.adbraun.lol --hostname
|
||||||
|
doh.adbraun.lol`, or comma separated): each gets the records, the
|
||||||
|
certificate must be for all of them (a new one is obtained with all of
|
||||||
|
them), and the health check says when the certificate named serves misses
|
||||||
|
one. Clients may use any of them; the client hints use the first.
|
||||||
|
|
||||||
|
Running it again replaces the earlier setup: other addresses, views, host
|
||||||
|
names, **ports** (clients set up with another port need theirs changed
|
||||||
|
too), DoT or DoH only with `--no-doh` / `--no-dot`. The web UI's form
|
||||||
|
starts from the current setup, with each address's views as its records
|
||||||
|
are now. `jarl encrypted-dns disable` takes the listeners and the `tls`
|
||||||
|
statement out; the certificate and the records stay.
|
||||||
|
|
||||||
|
| Option | Default | |
|
||||||
|
|--|--|--|
|
||||||
|
| `--hostname` | | A name clients connect to (repeat for several); the certificate is for all of them |
|
||||||
|
| `--address` | | This server's addresses to listen on (repeat), with the views that get its records after `=` (`10.0.10.5=internal`). Choose your own networks' addresses: a listener on a public address answers anyone who reaches it, like port 53 there |
|
||||||
|
| `--certificate` | one for the host name, obtained if needed | A certificate Jarl manages |
|
||||||
|
| `--no-dot`, `--no-doh` | both on | |
|
||||||
|
| `--dot-port` | 853 | Clients expect 853 |
|
||||||
|
| `--doh-port` | 443 | Any free port; clients take it in the URL |
|
||||||
|
| `--view` | private views with the zone | Where every address's records go, when `--address` gives no views |
|
||||||
|
|
||||||
|
In the web UI the same form checks the ports as you choose, offers the
|
||||||
|
free port, and obtains the certificate before setting up.
|
||||||
|
|
||||||
|
## Which view clients get
|
||||||
|
|
||||||
|
A DoT or DoH client gets the view its address matches, as over plain DNS:
|
||||||
|
your phone at home gets the internal view, with its records and blocking.
|
||||||
|
Choosing a view by key (`match-clients { key ...; }`) doesn't work over
|
||||||
|
DoT and DoH, as clients don't sign their queries.
|
||||||
|
|
||||||
|
## Clients
|
||||||
|
|
||||||
|
`jarl encrypted-dns` (and the page) shows what to give them:
|
||||||
|
|
||||||
|
```
|
||||||
|
For DoT clients: dns.adbraun.lol
|
||||||
|
For DoH clients: https://dns.adbraun.lol/dns-query
|
||||||
|
```
|
||||||
|
|
||||||
|
| Client | Where |
|
||||||
|
|--|--|
|
||||||
|
| Android 9+ | Settings → Network → Private DNS → Private DNS provider hostname: `dns.adbraun.lol` (DoT) |
|
||||||
|
| Linux (systemd-resolved) | `/etc/systemd/resolved.conf`: `DNS=10.0.10.5#dns.adbraun.lol` and `DNSOverTLS=yes` (or `opportunistic`, which falls back to plain DNS) |
|
||||||
|
| Firefox | Settings → Privacy & Security → DNS over HTTPS → Increased protection → Custom: the DoH URL |
|
||||||
|
| Chrome, Edge | Settings → Privacy and security → Security → Use secure DNS → custom: the DoH URL |
|
||||||
|
| Windows 11 | Settings → Network → your connection → DNS server assignment → Edit: the server's address, DNS over HTTPS on (manual template), the DoH URL |
|
||||||
|
|
||||||
|
Test from a machine on your network, with BIND's own `dig` (9.18 or
|
||||||
|
later; `bind9-dnsutils` on Debian):
|
||||||
|
|
||||||
|
```sh
|
||||||
|
dig +tls +tls-ca +tls-hostname=dns.adbraun.lol @10.0.10.5 example.com # DoT, port 853
|
||||||
|
dig +https +tls-ca +tls-hostname=dns.adbraun.lol @10.0.10.5 example.com # DoH, port 443, /dns-query
|
||||||
|
```
|
||||||
|
|
||||||
|
`+tls-ca` checks the certificate against the system's CAs and
|
||||||
|
`+tls-hostname` against the host name, as clients do; add `-p PORT` for
|
||||||
|
another port. Without `+tls-ca` the query is still encrypted, but the
|
||||||
|
certificate isn't checked. named's DoH speaks the standard wire format
|
||||||
|
(RFC 8484), not the JSON API some public resolvers also offer, so
|
||||||
|
`curl ... accept: application/dns-json` doesn't work against it.
|
||||||
|
|
||||||
|
**Android away from home.** Private DNS in hostname mode applies on every
|
||||||
|
network. Away from home, your server can't be reached, and Android then
|
||||||
|
resolves nothing at all ("Private DNS server cannot be accessed"). Use a
|
||||||
|
VPN home (WireGuard) when you're out, or switch Private DNS to
|
||||||
|
*Automatic* when you leave. Firefox's *Increased protection* and
|
||||||
|
systemd-resolved's `opportunistic` fall back to normal DNS by themselves.
|
||||||
|
|
||||||
|
Clients check the certificate against the host name, so the name must
|
||||||
|
resolve to this server for them: the setup adds it to your private views.
|
||||||
|
Open the ports in the server's firewall for your own networks only.
|
||||||
|
|
||||||
|
## Health
|
||||||
|
|
||||||
|
jarld checks the listeners itself, a minute after it starts and then
|
||||||
|
every 10 minutes, the way a client would: it connects to each, checks the
|
||||||
|
certificate named serves (for the host name, current, and the one Jarl
|
||||||
|
last wrote, so a renewal named hasn't reread shows up) and asks for the
|
||||||
|
host name. The Encrypted DNS page shows the result per listener (**Check
|
||||||
|
now** checks again), the dashboard a card and the problems, Prometheus
|
||||||
|
`jarl_encrypted_dns_up{kind,address,port}`:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl encrypted-dns health # check now; exit 1 when a listener doesn't work
|
||||||
|
```
|
||||||
|
|
||||||
|
What it can say:
|
||||||
|
|
||||||
|
| | |
|
||||||
|
|--|--|
|
||||||
|
| nothing listens on ADDR port P | named couldn't bind the port: look in named's log (ports below 1024 need named to start as root, as the Debian service does) |
|
||||||
|
| no answer within 5s | a firewall on the server |
|
||||||
|
| a certificate for X, not HOST | named serves another certificate |
|
||||||
|
| an older certificate | named hasn't reread the renewed files (`rndc reconfig`) |
|
||||||
|
| not from a CA this server trusts (warning) | a staging or test CA: clients reject it unless they trust it |
|
||||||
|
| REFUSED (warning) | it works, but this server's own address gets a view that doesn't answer for the host name |
|
||||||
|
|
||||||
|
## Forwarding over TLS
|
||||||
|
|
||||||
|
When a view forwards its recursive queries (to Quad9, Cloudflare, your
|
||||||
|
ISP's resolver), named can send them over TLS, so your ISP doesn't see the
|
||||||
|
names you look up: only connections to the forwarder on port 853. It takes
|
||||||
|
two options, a `tls` statement for each provider (the name its certificate
|
||||||
|
must have) and the view's `forwarders` using it. Stage them in one
|
||||||
|
changeset, so one revert undoes them:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
CS=$(jarl changeset create "internal: forward to Quad9 over TLS" -q)
|
||||||
|
jarl option set tls 'quad9 { remote-hostname "dns.quad9.net"; ca-file "/etc/ssl/certs/ca-certificates.crt"; }' --toplevel -C $CS
|
||||||
|
jarl option set forwarders '{ 9.9.9.9 port 853 tls quad9; 149.112.112.112 port 853 tls quad9; 2620:fe::fe port 853 tls quad9; 2620:fe::9 port 853 tls quad9; }' --view internal -C $CS
|
||||||
|
jarl option set forward only --view internal -C $CS
|
||||||
|
jarl changeset diff $CS # what named.conf gets
|
||||||
|
jarl changeset apply $CS
|
||||||
|
# undo: jarl changeset apply $(jarl changeset revert $CS -q)
|
||||||
|
```
|
||||||
|
|
||||||
|
* **`remote-hostname` and `ca-file`** make named check the forwarder's
|
||||||
|
certificate against that name (Debian's CA bundle at that path). Without
|
||||||
|
them the connection is encrypted but anyone in between could answer.
|
||||||
|
* **`forward only`** stops named falling back to plain DNS (to the root
|
||||||
|
servers) when the forwarders don't answer: lookups then fail instead
|
||||||
|
(SERVFAIL), which you notice, rather than quietly going unencrypted.
|
||||||
|
* **Several providers**: a `tls` statement each, and their addresses in one
|
||||||
|
`forwarders` list. Setting `tls cloudflare` doesn't touch `tls quad9`:
|
||||||
|
`jarl option set` replaces only the statement of that name.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl option set tls 'cloudflare { remote-hostname "cloudflare-dns.com"; ca-file "/etc/ssl/certs/ca-certificates.crt"; }' --toplevel
|
||||||
|
jarl option set forwarders '{ 9.9.9.9 port 853 tls quad9; 149.112.112.112 port 853 tls quad9; 1.1.1.1 port 853 tls cloudflare; 1.0.0.1 port 853 tls cloudflare; 2606:4700:4700::1111 port 853 tls cloudflare; 2606:4700:4700::1001 port 853 tls cloudflare; }' --view internal
|
||||||
|
```
|
||||||
|
|
||||||
|
named sends each query to whichever forwarder has answered fastest, not
|
||||||
|
in order, and the providers filter differently (Quad9 blocks known
|
||||||
|
malicious domains, Cloudflare's 1.1.1.1 doesn't; 1.1.1.2 does, with
|
||||||
|
`remote-hostname "security.cloudflare-dns.com"`).
|
||||||
|
* **DNS over HTTPS** can't be used for forwarding: BIND serves DoH to
|
||||||
|
clients but forwards only over plain DNS or TLS. For a DoH upstream, run
|
||||||
|
a local proxy (dnscrypt-proxy, cloudflared) and forward to it on
|
||||||
|
`127.0.0.1`.
|
||||||
|
* Providers write their DoT address as `tls://dns.quad9.net`: the name is
|
||||||
|
`remote-hostname`, and the addresses it resolves to go in `forwarders`
|
||||||
|
(named needs addresses there, not names).
|
||||||
|
|
||||||
|
**Checking it works**: Quad9 says how a query reached it.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
dig +short TXT proto.on.quad9.net @YOUR-SERVER # "dot": over TLS
|
||||||
|
```
|
||||||
|
|
||||||
|
`do53-udp` means plain DNS. `ss -tnp | grep :853` shows named's connections
|
||||||
|
only briefly: it closes them when idle. `tcpdump -ni any port 853` shows
|
||||||
|
the traffic as it happens.
|
||||||
|
|
||||||
|
## What Jarl checks
|
||||||
|
|
||||||
|
* A `tls` statement whose files don't exist is an error
|
||||||
|
(`tls_file_missing`): named won't load its configuration without them.
|
||||||
|
* A certificate named uses can't be deleted, nor lose its `dns` use: turn
|
||||||
|
encrypted DNS off first.
|
||||||
|
* Listeners you wrote yourself are left alone; the page notes them.
|
||||||
|
|
||||||
|
## API
|
||||||
|
|
||||||
|
| Method | Path | Body |
|
||||||
|
|--------|------|------|
|
||||||
|
| GET | `/encrypted-dns` | `enabled`, `certificate`, `hostnames` (and `hostname`, the first), `dot` and `doh` (address and port), `address_views` (per address, the views whose records give a host name it), `dot_host`, `doh_url`, `listeners`; for the form: `addresses` (this server's, with `private`), `views` (with `public`, and `has_zone`), `certificates`. `?hostname=a,b` asks about other names |
|
||||||
|
| POST | `/encrypted-dns/check` | `{"addresses", "dot", "doh", "dot_port", "doh_port"}`: `conflicts` (address, port, what) and `free_doh_port` |
|
||||||
|
| POST | `/encrypted-dns` | `{"hostnames", "certificate", "addresses", "address_views": {"10.0.10.5": ["internal"]}, "dot", "doh", "dot_port", "doh_port"}` (`"hostname"` and `"views"`, every address in each, work too): staged or applied like any change; 409 while the certificate hasn't been obtained |
|
||||||
|
| DELETE | `/encrypted-dns` | Turns it off |
|
||||||
|
| POST | `/encrypted-dns/health` | Checks the listeners now: `checked`, `probes` (kind, address, port, `ok`, `problem`, `warning`, certificate names, expiry and serial, `trusted`, `rcode`, `ms`). `GET /encrypted-dns` has the last check as `health` |
|
||||||
@@ -0,0 +1,247 @@
|
|||||||
|
# Internet exposure
|
||||||
|
|
||||||
|
When a view (or the whole server) can be reached from the internet, a few
|
||||||
|
things matter that don't on your own network: it shouldn't help attackers
|
||||||
|
flood others with DNS answers (amplification), recurse for strangers, or
|
||||||
|
tell scanners its exact version. Jarl works out which views are public,
|
||||||
|
checks them, and stages the fixes for you to review.
|
||||||
|
|
||||||
|
In the web UI: **Exposure** (and its card on the dashboard). In the CLI:
|
||||||
|
`jarl exposure`. In the API: `GET /api/v1/exposure`.
|
||||||
|
|
||||||
|
## Which views are public
|
||||||
|
|
||||||
|
A view is **public** when its `match-clients` let in anyone: after ACLs
|
||||||
|
and ranges are filled in, they end in a catch-all (`any`, `0.0.0.0/0`,
|
||||||
|
`::/0`, or a prefix wider than /8 for IPv4 or /16 for IPv6), or they are
|
||||||
|
empty, which named reads as "any". A typical external view
|
||||||
|
(`match-clients { any; }` or `{ !internal; any; }`) is public.
|
||||||
|
|
||||||
|
A view that lists the networks it serves is **private**, whatever kind of
|
||||||
|
addresses those are. An internal view for your global IPv6 prefix
|
||||||
|
(`2a02:8013:7f3d:10::/64`) is as private as one for `192.168.1.0/24`:
|
||||||
|
listing a network says "these are mine". Jarl doesn't look at whether
|
||||||
|
addresses are private (RFC 1918, ULA) for this, because on IPv6 your own
|
||||||
|
devices have global addresses.
|
||||||
|
|
||||||
|
A view whose `match-destinations` list only private addresses (it answers
|
||||||
|
only on a private interface) is private too.
|
||||||
|
|
||||||
|
**A server without views** has no match list, so Jarl looks at
|
||||||
|
`allow-query` and where named listens: it is public when anyone may query
|
||||||
|
it (`allow-query` unset, or with a catch-all) **and** named listens on an
|
||||||
|
address that isn't private (a public IPv4 address or a global IPv6
|
||||||
|
address of this host). This can't see your firewall, so it is a guess.
|
||||||
|
|
||||||
|
**When Jarl gets it wrong**, override it per view: `public`, `private` or
|
||||||
|
`auto`. For example, behind a NAT port forward named only ever sees
|
||||||
|
private addresses although it is reachable from the internet.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl view update external --exposure public
|
||||||
|
jarl settings set --exposure private # a server without views
|
||||||
|
```
|
||||||
|
|
||||||
|
The Exposure page shows each view's classification and the reason
|
||||||
|
("match-clients ends in any", "match-clients lists only homelab, no
|
||||||
|
catch-all"), with a selector for the override.
|
||||||
|
|
||||||
|
## The checks
|
||||||
|
|
||||||
|
They run on public views only, and are warnings (they don't stop you
|
||||||
|
applying) unless acknowledged.
|
||||||
|
|
||||||
|
| Code | What | Fix Jarl can stage |
|
||||||
|
|------|------|-------------------|
|
||||||
|
| `exposure_rate_limit` | No response rate limiting: the view can be used to flood others with its answers (DNS amplification) | `rate-limit { responses-per-second 10; log-only yes; exempt-clients { your secondaries }; }` |
|
||||||
|
| `exposure_rate_limit_log_only` (info) | Rate limiting only logs | The same block without `log-only`: start enforcing |
|
||||||
|
| `security_open_resolver` | Recursion for anyone: an open resolver | `recursion no` in that view |
|
||||||
|
| `exposure_minimal_any` | ANY queries get full answers, a favourite for amplification | `minimal-any yes` |
|
||||||
|
| `exposure_cache_snooping` | `allow-query-cache` lets anyone see what your clients look up | `allow-query-cache { none; }` |
|
||||||
|
| `security_open_transfer` | Zone transfers for anyone | none: allow your secondaries or a TSIG key |
|
||||||
|
| `exposure_open_notify` | `allow-notify` accepts NOTIFY from anyone | none: allow your primaries |
|
||||||
|
| `exposure_version` | `dig CH TXT version.bind` shows the exact BIND version | `version none` |
|
||||||
|
| `exposure_hostname` | `dig CH TXT hostname.bind` shows the host name | `hostname none` |
|
||||||
|
| `exposure_management` | `controls` or `statistics-channels` on an address that isn't loopback, open to anyone | none: use 127.0.0.1 or an allow list |
|
||||||
|
|
||||||
|
The last three are server-wide: they are checked when any view is public.
|
||||||
|
|
||||||
|
A **fix** goes into your pending changes like any edit (or is applied at
|
||||||
|
once in live mode), so you see the named.conf diff before it reaches named:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl exposure # classification, findings, fixes
|
||||||
|
jarl exposure fix external exposure_rate_limit
|
||||||
|
jarl exposure fix server exposure_version
|
||||||
|
```
|
||||||
|
|
||||||
|
## Response rate limiting
|
||||||
|
|
||||||
|
Response rate limiting (RRL, BIND's `rate-limit`) counts identical
|
||||||
|
responses sent to the same client network. Past the limit, named drops
|
||||||
|
some and "slips" others: it sends a short reply asking the client to retry
|
||||||
|
over TCP (or with a DNS cookie). A real client does; the spoofed victim of
|
||||||
|
an amplification attack never sees the answers it didn't ask for. ISC
|
||||||
|
recommends it for authoritative servers only, so Jarl only suggests it for
|
||||||
|
public views, never for your internal resolver.
|
||||||
|
|
||||||
|
Jarl starts from ISC's example, 10 identical responses per second per
|
||||||
|
client network, and exempts the servers your zones notify and allow
|
||||||
|
transfers to (`also-notify` and `allow-transfer` addresses, through ACLs
|
||||||
|
too): limiting your own secondaries is the classic RRL mistake.
|
||||||
|
|
||||||
|
**Rollout in two steps:**
|
||||||
|
|
||||||
|
1. The fix turns rate limiting on with `log-only yes`. named answers
|
||||||
|
everyone as before, but logs every response it *would* have limited.
|
||||||
|
With [query statistics](stats.md) on, Jarl reads those lines: the
|
||||||
|
Exposure page shows how many responses would have been limited, and
|
||||||
|
which client networks and names. Check that your secondaries,
|
||||||
|
monitoring, or a big shared resolver aren't among them (add them to
|
||||||
|
`exempt-clients` if they are).
|
||||||
|
2. When you're happy, **Start enforcing** (the fix of
|
||||||
|
`exposure_rate_limit_log_only`) removes `log-only`.
|
||||||
|
|
||||||
|
In log-only mode named's own counters don't move: what would be limited
|
||||||
|
is only in its log (category `query-errors`). That is why the activity
|
||||||
|
needs query statistics; without them, look at named's log for
|
||||||
|
`would rate limit`. When rate limiting is configured and statistics are
|
||||||
|
on, Jarl adds `query-errors` to its log channel (keeping named's syslog
|
||||||
|
destination for it). `stats.rate_limit_log: false` in jarl.yaml leaves
|
||||||
|
`query-errors` alone; the page then can't show what rate limiting does.
|
||||||
|
The Server options page lists this, and everything else Jarl adds to
|
||||||
|
named.conf by itself, under **Added by Jarl** (`jarl option generated`).
|
||||||
|
|
||||||
|
The statistics also count it: the `rrl` breakdown (`drop`, `slip`,
|
||||||
|
`would-drop`, `would-slip`), the `ratelimited` and `ratelimited_name` top
|
||||||
|
lists, and in Prometheus `jarl_ratelimit_logged_total{action}` next to
|
||||||
|
named's own `jarl_ratelimit_responses_total` ([metrics.md](metrics.md)).
|
||||||
|
|
||||||
|
### Settings
|
||||||
|
|
||||||
|
You can tune the block like any option; `option set` replaces the whole
|
||||||
|
block, so copy the current value from `jarl option list --view external`
|
||||||
|
and edit it:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl option set rate-limit '{ responses-per-second 20; window 15; slip 2; exempt-clients { 192.0.2.53; }; log-only yes; }' --view external
|
||||||
|
```
|
||||||
|
|
||||||
|
named counts **identical responses** to the same **client network** (a
|
||||||
|
/24 for IPv4, a /56 for IPv6) over a **window**, and limits each kind of
|
||||||
|
response separately. These are the settings (BIND 9.20; the ARM has the
|
||||||
|
full text):
|
||||||
|
|
||||||
|
| Setting | Default | What it does | When to change it |
|
||||||
|
|---------|---------|--------------|-------------------|
|
||||||
|
| `responses-per-second` | 0 (off) | Answers with data for the same name and type, per client network. Wildcard answers count as the zone's apex. This is the main limit; Jarl's fix sets 10 | Raise it if a legitimate network shows up in log-only mode, e.g. a large shared resolver (mobile carriers, public resolvers) asking for your popular names |
|
||||||
|
| `nxdomains-per-second` | same as `responses-per-second` | NXDOMAIN answers (names that don't exist), counted together for a domain whatever the name asked | `0` turns NXDOMAIN limiting off, for zones that legitimately get many lookups of missing names |
|
||||||
|
| `nodata-per-second` | same as `responses-per-second` | Empty answers (the name exists, the type doesn't), counted together whatever the type | Rarely |
|
||||||
|
| `referrals-per-second` | same as `responses-per-second` | Referrals to child zones you delegate | Only if you delegate subdomains to other servers |
|
||||||
|
| `errors-per-second` | same as `responses-per-second` | Other errors (REFUSED, SERVFAIL, FORMERR), counted together whatever the name | Rarely. REFUSED and SERVFAIL can't be truncated, so slipped ones still go out at the slip rate |
|
||||||
|
| `all-per-second` | 0 (off) | All UDP answers to a client network, of any kind, like a firewall rate limit; over it, answers are only **dropped** (`slip` doesn't apply) | Usually leave off; if you use it, ISC says at least 4 times the other limits |
|
||||||
|
| `window` | 15 seconds (1–3600) | How far back named counts. A client over the limit stays limited until its rate over the window falls again | Longer windows remember attackers longer and also punish short legitimate bursts longer |
|
||||||
|
| `slip` | 2 (0–10) | Of the limited answers, every n-th "slips": instead of being dropped it gets a short reply asking the client to retry: truncated (TC) so it retries over TCP, or, when the query carried a DNS cookie, BADCOOKIE with a server cookie that lets it through on its retry. `0` drops all, `1` slips all | `1` if you'd rather every real client gets a retry hint; `0` drops all (spoofed victims see nothing, but real clients just time out) |
|
||||||
|
| `ipv4-prefix-length` | 24 | The size of the client network answers are counted for (IPv4) | `32` counts each address on its own: fairer to neighbours, more memory |
|
||||||
|
| `ipv6-prefix-length` | 56 | The same for IPv6 | `64` if one /56 holds many independent clients; `48` to treat a whole site as one |
|
||||||
|
| `exempt-clients` | none | Address match list (addresses, prefixes, [ranges](concepts.md#model-views-zones-records-options), ACLs) that is never limited. Jarl's fix puts your secondaries here | Add monitoring, other servers of yours, and anything legitimate that log-only mode shows |
|
||||||
|
| `log-only` | no | Count and log what would be limited, answer everyone normally | Jarl starts with `yes`; the "start enforcing" fix removes it |
|
||||||
|
| `qps-scale` | off | When the total query rate is above this, all limits shrink in proportion (at a rate of 1000 with `qps-scale 250`, a limit of 20 becomes 5) | Only on busy servers that see attacks spread over many networks |
|
||||||
|
| `max-table-size`, `min-table-size` | min 500 entries | The table of client networks named tracks (40–80 bytes per entry) | Only on busy servers |
|
||||||
|
|
||||||
|
What Jarl checked against real named: TCP answers are never limited;
|
||||||
|
`nxdomains-per-second` falls back to `responses-per-second` and `0`
|
||||||
|
turns it off; NXDOMAIN answers for different missing names in a zone
|
||||||
|
share one limit; `all-per-second` only drops; with `slip 1`, clients
|
||||||
|
without DNS cookies get truncated answers, and clients with cookies (dig
|
||||||
|
sends them by default) get through on their retry with the server's
|
||||||
|
cookie; `exempt-clients` is never limited; in log-only mode nothing is
|
||||||
|
limited and only the log shows what would be.
|
||||||
|
|
||||||
|
Rate limiting is per view: put it in the external view (`--view
|
||||||
|
external`). Set in the server options, it applies to every view that has
|
||||||
|
none of its own, your internal resolver included, which RRL isn't meant
|
||||||
|
for.
|
||||||
|
|
||||||
|
## Mail
|
||||||
|
|
||||||
|
Receivers such as Gmail and Outlook check the address mail comes from: it
|
||||||
|
needs a PTR record (reverse DNS), and the name it gives must resolve back
|
||||||
|
to the address. Without that, mail is rejected or marked as spam. The PTR
|
||||||
|
records of your public addresses live in the reverse zones of whoever
|
||||||
|
owns the addresses, your hosting provider or ISP: you set them in their
|
||||||
|
panel, not in Jarl. A reverse zone you create in Jarl only answers your
|
||||||
|
own clients (unless the owner delegated it to you).
|
||||||
|
|
||||||
|
So Jarl checks them as the internet sees them, through the public
|
||||||
|
resolvers of `acme.resolvers`: the addresses of every public zone's MX
|
||||||
|
hosts (receiving) and SPF `ip4:`, `ip6:`, `a` and `a:` addresses
|
||||||
|
(sending). The Exposure page's **Mail reverse DNS** panel shows each
|
||||||
|
address, its PTR, who runs its reverse zone (the provider, from the
|
||||||
|
zone's name server) and what to do; jarld checks a minute after it starts
|
||||||
|
and every 6 hours, and logs an address that goes wrong.
|
||||||
|
|
||||||
|
```
|
||||||
|
$ jarl exposure mail
|
||||||
|
ZONE ADDRESS FOR PTR STATUS
|
||||||
|
adbraun.lol 172.235.168.106 SPF ip4, MX mail.adbraun.lol mail.adbraun.lol ok
|
||||||
|
```
|
||||||
|
|
||||||
|
It warns when an address has no PTR record, or when its name doesn't
|
||||||
|
resolve back to it; notes when the name is an alias (CNAME), or isn't the
|
||||||
|
MX name (fine if the mail server uses it in HELO). `jarl exposure mail`
|
||||||
|
exits 1 when an address isn't right; Prometheus has
|
||||||
|
`jarl_mail_reverse_dns_ok{zone,address}`.
|
||||||
|
|
||||||
|
## Confirming a change that opens a view up
|
||||||
|
|
||||||
|
A change that *introduces* an open resolver, open zone transfers, cache
|
||||||
|
snooping, open NOTIFY or an open management interface on a public view
|
||||||
|
must be confirmed:
|
||||||
|
|
||||||
|
- **Web UI:** the Changes page shows the finding with a checkbox (*I
|
||||||
|
understand: …*); **Apply** stays disabled until it is ticked.
|
||||||
|
- **CLI:** the command stops (exit 5) and says why; run it again with
|
||||||
|
`--accept-risk`.
|
||||||
|
- **API:** `accept_risk: true` in the apply body, or `?accept_risk=1` on a
|
||||||
|
change applied at once; without it the answer is 409 `confirm_risk`.
|
||||||
|
Previews (`GET /changesets/{id}/preview`) list them as `risks`.
|
||||||
|
|
||||||
|
Only changes that newly open something up ask: an unrelated change to a
|
||||||
|
view that is already open, or taking back an acknowledgement, doesn't.
|
||||||
|
|
||||||
|
## Acknowledging a finding
|
||||||
|
|
||||||
|
Some findings are deliberate: a public resolver for a club's network, a
|
||||||
|
visible version string. Acknowledge them with a reason:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl exposure ack external security_open_resolver --reason "public resolver for the club, monitored"
|
||||||
|
jarl exposure ack server exposure_version --reason "version shown on purpose"
|
||||||
|
jarl exposure unack external security_open_resolver
|
||||||
|
```
|
||||||
|
|
||||||
|
The finding doesn't disappear: it stays visible as **info**, with who
|
||||||
|
accepted it, when and why (*open resolver … (acknowledged by adam on 12
|
||||||
|
Oct 2026: public resolver for the club, monitored)*), on the Exposure page,
|
||||||
|
the dashboard and in `jarl check`. An acknowledgement covers that one
|
||||||
|
finding on that one view (or the server); the same finding elsewhere
|
||||||
|
warns as usual. Acknowledging is a configuration change like any other,
|
||||||
|
so it is in the history and audit log, and can be reverted.
|
||||||
|
|
||||||
|
Jarl isn't designed to run an open resolver, and an acknowledgement makes
|
||||||
|
one deliberate and visible, not safe: a public resolver also needs abuse
|
||||||
|
monitoring, response size limits and usually a machine of its own.
|
||||||
|
|
||||||
|
## API
|
||||||
|
|
||||||
|
| Method | Path | Body |
|
||||||
|
|--------|------|------|
|
||||||
|
| GET | `/exposure` | `scopes` (per view, or the server: `public`, `override`, `reason`, `rate_limit` off/log-only/enforcing, `findings` with `fix` where Jarl has one), `server` (server-wide findings), `rate_limiting` (last 24h, with statistics: `counts`, `networks`, `names`), `rate_limit_log`, `mail` (the last mail check) |
|
||||||
|
| POST | `/exposure/mail` | Checks the mail addresses' reverse DNS now: `checked`, `results` (`zone`, `address`, `roles`, `ptr`, `ok`, `level` ok/info/warning, `message`, `reverse_zone`, `managed_by`, `local_zone`), `errors` |
|
||||||
|
| POST | `/exposure/fix` | `{"view": "external", "code": "exposure_rate_limit"}` (`view_id` works too; no view: the server). Staged with `?changeset=` like any change |
|
||||||
|
| POST | `/exposure/ack` | `{"view": "external", "code": "security_open_resolver", "reason": "..."}` |
|
||||||
|
| POST | `/exposure/unack` | `{"view": "external", "code": "security_open_resolver"}` |
|
||||||
|
|
||||||
|
The override is a view's `exposure` field (`PATCH /views/{id}`), or the
|
||||||
|
settings' for a server without views (`PATCH /settings`).
|
||||||
+25
-1
@@ -129,6 +129,11 @@ same values.
|
|||||||
| `jarl_blocklist_last_check_timestamp_seconds{list}`, `jarl_blocklist_last_change_timestamp_seconds{list}` | When the list was last checked, and last changed. |
|
| `jarl_blocklist_last_check_timestamp_seconds{list}`, `jarl_blocklist_last_change_timestamp_seconds{list}` | When the list was last checked, and last changed. |
|
||||||
| `jarl_dnssec_phase{zone,view,phase}` | Always 1, one per signed zone; `phase` is one of the [DNSSEC phases](dnssec.md). `ready` means: add the DS at the parent. `removing_ds`: remove it. |
|
| `jarl_dnssec_phase{zone,view,phase}` | Always 1, one per signed zone; `phase` is one of the [DNSSEC phases](dnssec.md). `ready` means: add the DS at the parent. `removing_ds`: remove it. |
|
||||||
| `jarl_token_expiry_timestamp_seconds{id,user,token}` | When each API token with an expiry date expires. |
|
| `jarl_token_expiry_timestamp_seconds{id,user,token}` | When each API token with an expiry date expires. |
|
||||||
|
| `jarl_certificate_expiry_timestamp_seconds{certificate,source}` | When each certificate Jarl manages expires ([certificates.md](certificates.md)). |
|
||||||
|
| `jarl_certificate_failing{certificate,source}` | 1 when obtaining (or reading) the certificate failed the last time, or it has expired. |
|
||||||
|
| `jarl_certificate_renewal_failures{certificate}` | Failed attempts to obtain a certificate since its last success. |
|
||||||
|
| `jarl_mail_reverse_dns_ok{zone,address}` | 1 when an address that sends or receives a public zone's mail has a PTR record that resolves back to it, at the last check, every 6 hours ([exposure.md](exposure.md#mail)). |
|
||||||
|
| `jarl_encrypted_dns_up{kind,address,port}` | 1 when the DoT or DoH listener answered with the right, current certificate at the last check ([encrypted-dns.md](encrypted-dns.md#health)). |
|
||||||
|
|
||||||
### Queries (with `stats.enabled`)
|
### Queries (with `stats.enabled`)
|
||||||
|
|
||||||
@@ -148,7 +153,8 @@ for them.
|
|||||||
| `jarl_queries_by_transport_total{transport}` | `udp` and `tcp`. |
|
| `jarl_queries_by_transport_total{transport}` | `udp` and `tcp`. |
|
||||||
| `jarl_answers_total{source}` | `authoritative` or `recursive`. |
|
| `jarl_answers_total{source}` | `authoritative` or `recursive`. |
|
||||||
| `jarl_recursion_queries_total`, `jarl_dropped_queries_total`, `jarl_duplicate_queries_total` | Queries that caused recursion, that named dropped, and duplicates. |
|
| `jarl_recursion_queries_total`, `jarl_dropped_queries_total`, `jarl_duplicate_queries_total` | Queries that caused recursion, that named dropped, and duplicates. |
|
||||||
| `jarl_ratelimit_responses_total{action}` | Responses rate limiting `dropped` or `slipped`. |
|
| `jarl_ratelimit_responses_total{action}` | Responses rate limiting `dropped` or `slipped` (named's counters; they don't move in log-only mode). |
|
||||||
|
| `jarl_ratelimit_logged_total{action}` | Rate limited responses from named's log: `drop`, `slip`, and in log-only mode `would-drop`, `would-slip` ([exposure.md](exposure.md#response-rate-limiting)). |
|
||||||
| `jarl_upstream_responses_by_rtt_total{rtt}` | Upstream answers during recursion by round-trip time (`<10ms` … `>1600ms`). |
|
| `jarl_upstream_responses_by_rtt_total{rtt}` | Upstream answers during recursion by round-trip time (`<10ms` … `>1600ms`). |
|
||||||
| `jarl_dnssec_validations_total{result}` | `valid`, `valid-negative` and `failed`. |
|
| `jarl_dnssec_validations_total{result}` | `valid`, `valid-negative` and `failed`. |
|
||||||
| `jarl_cache_lookups_total{result}` | `hits` and `misses`. |
|
| `jarl_cache_lookups_total{result}` | `hits` and `misses`. |
|
||||||
@@ -219,6 +225,24 @@ groups:
|
|||||||
expr: jarl_token_expiry_timestamp_seconds - time() < 7 * 86400
|
expr: jarl_token_expiry_timestamp_seconds - time() < 7 * 86400
|
||||||
annotations:
|
annotations:
|
||||||
summary: "API token {{ $labels.token }} of {{ $labels.user }} expires within a week"
|
summary: "API token {{ $labels.token }} of {{ $labels.user }} expires within a week"
|
||||||
|
- alert: CertificateFailing
|
||||||
|
expr: jarl_certificate_failing == 1
|
||||||
|
for: 12h
|
||||||
|
annotations:
|
||||||
|
summary: "Certificate {{ $labels.certificate }} can't be renewed (see the Certificates page)"
|
||||||
|
- alert: CertificateExpiresSoon
|
||||||
|
expr: jarl_certificate_expiry_timestamp_seconds - time() < 10 * 86400
|
||||||
|
annotations:
|
||||||
|
summary: "Certificate {{ $labels.certificate }} expires within 10 days"
|
||||||
|
- alert: EncryptedDNSDown
|
||||||
|
expr: jarl_encrypted_dns_up == 0
|
||||||
|
for: 20m
|
||||||
|
annotations:
|
||||||
|
summary: "DNS over {{ $labels.kind }} on {{ $labels.address }} port {{ $labels.port }} isn't working (see the Encrypted DNS page)"
|
||||||
|
- alert: MailReverseDNS
|
||||||
|
expr: jarl_mail_reverse_dns_ok == 0
|
||||||
|
annotations:
|
||||||
|
summary: "{{ $labels.address }} ({{ $labels.zone }} mail) has no reverse DNS that resolves back: receivers may reject its mail"
|
||||||
- alert: BlockingPausedForLong
|
- alert: BlockingPausedForLong
|
||||||
expr: jarl_blocking_paused == 1
|
expr: jarl_blocking_paused == 1
|
||||||
for: 24h
|
for: 24h
|
||||||
|
|||||||
+3
-2
@@ -116,8 +116,9 @@ demote or delete the last enabled administrator.
|
|||||||
|
|
||||||
A user's permissions are a list of grants. Administrators (`admin: true`)
|
A user's permissions are a list of grants. Administrators (`admin: true`)
|
||||||
may do everything, and only they can manage users, see everyone's tokens,
|
may do everything, and only they can manage users, see everyone's tokens,
|
||||||
run `resync`, wipe a zone's DNSSEC keys, and use the registrar (Porkbun,
|
run `resync`, wipe a zone's DNSSEC keys, use the registrar (Porkbun,
|
||||||
whose key can move the domain).
|
whose key can move the domain), and manage TLS certificates (whose keys
|
||||||
|
can impersonate the server; [certificates.md](certificates.md)).
|
||||||
|
|
||||||
A grant is written as:
|
A grant is written as:
|
||||||
|
|
||||||
|
|||||||
+163
@@ -0,0 +1,163 @@
|
|||||||
|
# Reverse zones
|
||||||
|
|
||||||
|
A reverse zone answers "which host has this address?" with PTR records:
|
||||||
|
`20.10.0.10.in-addr.arpa. PTR nas.adbraun.lol.`. Your own clients use them
|
||||||
|
for names in logs, `traceroute`, the router's client list and `ssh`
|
||||||
|
warnings. For your private networks they only exist if this server has
|
||||||
|
them, and they are easy to forget, so Jarl can work them out from the
|
||||||
|
records you already have.
|
||||||
|
|
||||||
|
Who asks matters:
|
||||||
|
|
||||||
|
* **Your own clients** ask this server, so a reverse zone in a private
|
||||||
|
view (internal) answers them.
|
||||||
|
* **The internet** asks whoever owns the address: your ISP or hosting
|
||||||
|
provider for public addresses. Mail servers check those PTR records, and
|
||||||
|
you set them in the provider's panel, not in Jarl. The Exposure page
|
||||||
|
checks them ([exposure.md](exposure.md#mail)). A reverse zone for a
|
||||||
|
public address in a public view (external) does nothing unless the owner
|
||||||
|
delegated it to you.
|
||||||
|
|
||||||
|
So reverse zones belong in private views. A view whose clients reach it
|
||||||
|
from the internet gets no suggestions, and neither does a view you turn
|
||||||
|
them off for: a view only a few servers use, such as one for your VPS,
|
||||||
|
matches only their addresses and so counts as private, but its clients
|
||||||
|
don't need reverse zones (`jarl view update vps
|
||||||
|
--reverse-suggestions=false`, or the view's settings). Exposure doesn't
|
||||||
|
change.
|
||||||
|
|
||||||
|
## Missing reverse zones
|
||||||
|
|
||||||
|
The Zones page lists, under **Missing reverse zones**, the reverse zones a
|
||||||
|
private view lacks for the addresses of its A and AAAA records, in two
|
||||||
|
groups:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ jarl zone suggest-reverse
|
||||||
|
GROUP VIEW NETWORK ZONE PTRS FOR EXAMPLE
|
||||||
|
yours internal 10.0.10.0/24 10.0.10.in-addr.arpa 14 10.0.10.1 router.adbraun.lol, ...
|
||||||
|
yours internal 2a02:8013:7f3d::/48 d.3.f.7.3.1.0.8.2.0.a.2.ip6.arpa 9 2a02:8013:7f3d:10::5 nas.adbraun.lol, ...
|
||||||
|
public internal 139.144.144.154/32 154.144.144.139.in-addr.arpa 1 139.144.144.154 ldn.adbraun.lol
|
||||||
|
public internal 185.199.108.153/32 153.108.199.185.in-addr.arpa 1 185.199.108.153 blog.adbraun.lol
|
||||||
|
|
||||||
|
$ jarl zone suggest-reverse --create # yours, filled, in one changeset
|
||||||
|
$ jarl zone create 139.144.144.154/32 --view internal --fill # a public one that is yours
|
||||||
|
$ jarl zone suggest-reverse --dismiss 185.199.108.153/32 --view internal # GitHub's, not yours
|
||||||
|
```
|
||||||
|
|
||||||
|
**Yours**, created by **Create all** (`--create`):
|
||||||
|
|
||||||
|
* the **/24** of a private IPv4 address (10/8, 172.16/12, 192.168/16,
|
||||||
|
100.64/10);
|
||||||
|
* the **/48** of a ULA (fd00::/8), or of a public IPv6 prefix this server
|
||||||
|
has an address in (the /48 your ISP delegates): one zone for all its
|
||||||
|
subnets. If you have a /56, create that instead (`jarl zone create
|
||||||
|
2a02:db8:1:ab00::/56`).
|
||||||
|
|
||||||
|
**Public addresses, only if they're yours**: any other public address,
|
||||||
|
each as a /32 (or /128) of its own. Jarl can't tell your VPS from a web
|
||||||
|
host's server (a `blog` record pointing at GitHub Pages), and a zone for
|
||||||
|
someone else's address would show your clients your name for it instead
|
||||||
|
of theirs. The rest of the /24 belongs to others: a /24 zone here would
|
||||||
|
answer NXDOMAIN to your clients for all of their addresses. Create the
|
||||||
|
ones that are yours one by one, and **Dismiss** the others: Jarl
|
||||||
|
remembers, per view (`--undismiss` brings one back).
|
||||||
|
|
||||||
|
There can be hundreds of public addresses (records pointing at a web
|
||||||
|
host or a CDN), so the group is folded away when it is long. Opened, it
|
||||||
|
has a search and shows 25 at a time; **Dismiss these N** dismisses every
|
||||||
|
address the search found, in one change: search `104.16.` and dismiss
|
||||||
|
the CDN's addresses together. From the CLI, `--dismiss` takes several
|
||||||
|
networks (comma separated or repeated). The New reverse zone list has a
|
||||||
|
search too.
|
||||||
|
|
||||||
|
Loopback and link-local addresses, wildcards and disabled records are left
|
||||||
|
out.
|
||||||
|
|
||||||
|
## Creating one by hand
|
||||||
|
|
||||||
|
Where nothing is suggested (a view with suggestions off, a dismissed
|
||||||
|
network, a public view) or the suggested size isn't the one you want,
|
||||||
|
**New reverse zone** on the Zones page lists every network your records
|
||||||
|
use that has no reverse zone, in every view, marked when it isn't
|
||||||
|
suggested unasked. Pick one: the network and the view are filled in.
|
||||||
|
Then the **Size** buttons change it, around the address of one of the
|
||||||
|
records: a suggested `2a02:8013:7f3d::/48` becomes
|
||||||
|
`2a02:8013:7f3d:10::/64` for the subnet the records are in, or `/128`
|
||||||
|
for one address. The zone name shows as you go, and **PTR records** stays
|
||||||
|
ticked, so the zone is created with a PTR record for each address
|
||||||
|
(IPv6 nibble names written for you).
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl zone suggest-reverse --all --view vps # every network, hidden ones marked
|
||||||
|
jarl zone create 2a02:8013:7f3d:10::/64 --view internal --fill
|
||||||
|
```
|
||||||
|
|
||||||
|
**Records in another view.** With a view chosen (`--view internal`, or
|
||||||
|
the dialog's View), the list also has the addresses only other views'
|
||||||
|
records use, marked "records in external": say a VPS's AAAA record that
|
||||||
|
only the external view has. Fill names those from the other view's
|
||||||
|
record, when the zone's own view has none for the address, and says so.
|
||||||
|
Keeping PTR records in step (below) stays within a zone's own view and
|
||||||
|
its linked views: a later change to that external record doesn't reach
|
||||||
|
the internal reverse zone.
|
||||||
|
|
||||||
|
## Creating and filling
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl zone create 10.0.10.0/24 --fill # the view whose records use 10.0.10.x
|
||||||
|
jarl zone fill-ptr 10.0.10.0/24 # later: add what is missing
|
||||||
|
```
|
||||||
|
|
||||||
|
**The view.** A reverse zone created without `--view` goes to the private
|
||||||
|
view whose records use addresses in its network (views with suggestions
|
||||||
|
off don't count). If none does, it goes to the only private view. If
|
||||||
|
several do, Jarl asks you to name the view, or to create the zone in each.
|
||||||
|
|
||||||
|
**Inside another zone.** A zone created inside an existing one in the same
|
||||||
|
view, a /24 inside a /8 or `lab.adbraun.lol` inside `adbraun.lol`, takes
|
||||||
|
the parent's records under it, in the same changeset: named answers those
|
||||||
|
names from the new zone, so left in the parent they would never be served
|
||||||
|
again. PTR records you added by hand come along; `--fill` then adds only
|
||||||
|
what is still missing. A delegation (NS records at the new zone's name,
|
||||||
|
with their glue) stays in the parent. A linked parent keeps its records,
|
||||||
|
with a warning, since its other views would lose them too.
|
||||||
|
|
||||||
|
**Fill** adds a PTR record for every address in the network that the
|
||||||
|
view's A and AAAA records use. An address with several names gets one PTR:
|
||||||
|
|
||||||
|
1. the name of a mail or name server (an MX or NS target), else
|
||||||
|
2. a host's name rather than the domain's own (`nas.adbraun.lol`, not
|
||||||
|
`adbraun.lol`), else
|
||||||
|
3. the shortest name, then the first alphabetically.
|
||||||
|
|
||||||
|
Jarl says which name it chose, and which it didn't, so you can change it.
|
||||||
|
A reverse zone's page shows how many addresses still lack a PTR, with a
|
||||||
|
button to add them. `jarl zone show` shows it as `Missing PTRs`.
|
||||||
|
|
||||||
|
## Keeping PTR records in step
|
||||||
|
|
||||||
|
The **Update PTR** box on an A or AAAA record (`--ptr`) moves the PTR record
|
||||||
|
along with that one change. To have that on every change, turn it on for
|
||||||
|
the forward zone:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl zone update adbraun.lol --view internal --auto-ptr # off: --auto-ptr=false
|
||||||
|
```
|
||||||
|
|
||||||
|
(Zone settings → **Reverse DNS** in the web UI.) Then adding, changing,
|
||||||
|
disabling, enabling or deleting an A or AAAA record in the zone does the
|
||||||
|
same to its PTR record, in the reverse zones of the zone's view and of the
|
||||||
|
views it is linked with ([views.md](views.md#linked-zones)). A whole set
|
||||||
|
replaced at once (`jarl record set`, a batch) works too.
|
||||||
|
|
||||||
|
* **One name per address.** When an address's PTR record names another
|
||||||
|
host, it stays: a second A record for the same address doesn't add a
|
||||||
|
second PTR record.
|
||||||
|
* **No reverse zone, no PTR.** An address without a reverse zone in the
|
||||||
|
view, such as a public address in the external view, is skipped without
|
||||||
|
a warning. The suggestions above show what is missing.
|
||||||
|
* **Wildcards** (`*.dev`) never get a PTR record.
|
||||||
|
|
||||||
|
The PTR changes are part of the same changeset, so you review them, and
|
||||||
|
they are applied or undone together with the record.
|
||||||
+76
-1
@@ -60,6 +60,7 @@ off again. The statistics database stays until you delete it
|
|||||||
stats:
|
stats:
|
||||||
enabled: false
|
enabled: false
|
||||||
query_log: true # per-query data; false = named's counters only
|
query_log: true # per-query data; false = named's counters only
|
||||||
|
rate_limit_log: true # with a rate-limit: also log what it limits (query-errors)
|
||||||
database: /var/lib/jarl/stats.db
|
database: /var/lib/jarl/stats.db
|
||||||
statistics_channel: 127.0.0.1:8058 # must be a loopback address
|
statistics_channel: 127.0.0.1:8058 # must be a loopback address
|
||||||
log_file: /var/log/named/jarl-responses.log
|
log_file: /var/log/named/jarl-responses.log
|
||||||
@@ -69,6 +70,7 @@ stats:
|
|||||||
minute: 7d # per-minute counters
|
minute: 7d # per-minute counters
|
||||||
hour: 90d # hourly counters and top lists
|
hour: 90d # hourly counters and top lists
|
||||||
day: 730d # daily counters and top lists
|
day: 730d # daily counters and top lists
|
||||||
|
queries: 7d # every answer, for exploring (0: none)
|
||||||
top_n: 100 # names and clients kept per hour and per day
|
top_n: 100 # names and clients kept per hour and per day
|
||||||
anonymize_clients: false # store 10.10.0.0/24 instead of 10.10.0.37 (IPv6: /48)
|
anonymize_clients: false # store 10.10.0.0/24 instead of 10.10.0.37 (IPv6: /48)
|
||||||
exclude_clients: [] # e.g. [10.10.0.250] to ignore a monitoring probe
|
exclude_clients: [] # e.g. [10.10.0.250] to ignore a monitoring probe
|
||||||
@@ -81,6 +83,13 @@ the response log. Logging every answer costs named some CPU and disk I/O,
|
|||||||
which is negligible at homelab volumes. At tens of thousands of queries per
|
which is negligible at homelab volumes. At tens of thousands of queries per
|
||||||
second, consider counters only.
|
second, consider counters only.
|
||||||
|
|
||||||
|
`rate_limit_log` matters only with a `rate-limit` set: Jarl then sends
|
||||||
|
named's `query-errors` category (where rate limiting logs what it limits,
|
||||||
|
or would in log-only mode) to the response log too, and keeps it in
|
||||||
|
syslog. That other query errors come along is the price; `false` stops it,
|
||||||
|
and the Exposure page can't show rate limiting's activity then
|
||||||
|
([exposure.md](exposure.md#response-rate-limiting)).
|
||||||
|
|
||||||
`exclude_clients` drops those clients from the log-derived figures (top
|
`exclude_clients` drops those clients from the log-derived figures (top
|
||||||
lists, views, zones). named's own counters can't be filtered.
|
lists, views, zones). named's own counters can't be filtered.
|
||||||
|
|
||||||
@@ -103,6 +112,7 @@ lists, views, zones). named's own counters can't be filtered.
|
|||||||
| `zone:NAME` | response log | answers per local zone; `zone:-` for names in none of your zones |
|
| `zone:NAME` | response log | answers per local zone; `zone:-` for names in none of your zones |
|
||||||
| `responses` | response log | lines read (a health check) |
|
| `responses` | response log | lines read (a health check) |
|
||||||
| `blocked`, `blocklist:NAME` | response log | queries [blocking](blocking.md) answered, and by which list (`blocklist:rules` for your own rules) |
|
| `blocked`, `blocklist:NAME` | response log | queries [blocking](blocking.md) answered, and by which list (`blocklist:rules` for your own rules) |
|
||||||
|
| `rrl:drop`, `rrl:slip`, `rrl:would-drop`, `rrl:would-slip` | response log | responses [rate limiting](exposure.md#response-rate-limiting) limited, or would have in log-only mode (named's own `ratelimit:*` counters don't move then) |
|
||||||
|
|
||||||
**Server** (sampled every minute; stored as gauges, `g:KEY` the sum of
|
**Server** (sampled every minute; stored as gauges, `g:KEY` the sum of
|
||||||
the samples and `gn:KEY` their number, so a chart shows the average):
|
the samples and `gn:KEY` their number, so a chart shows the average):
|
||||||
@@ -167,7 +177,8 @@ jarl stats top refused # who asks for what they may not have
|
|||||||
jarl stats timeline --since 6h # sparkline; --table for every bucket
|
jarl stats timeline --since 6h # sparkline; --table for every bucket
|
||||||
jarl stats timeline --since 7d --key rcode:NXDOMAIN --key rcode:SERVFAIL
|
jarl stats timeline --since 7d --key rcode:NXDOMAIN --key rcode:SERVFAIL
|
||||||
jarl stats heatmap --since 28d
|
jarl stats heatmap --since 28d
|
||||||
jarl stats breakdown qtype | rcode | view | zone | answer | rtt | dnssec | cache | transport | ratelimit
|
jarl stats breakdown qtype | rcode | view | zone | answer | rtt | dnssec | cache | transport | ratelimit | rrl
|
||||||
|
jarl stats top ratelimited # client networks rate limiting limits (or would)
|
||||||
jarl stats server # memory, CPU, cache, clients, host, disks now
|
jarl stats server # memory, CPU, cache, clients, host, disks now
|
||||||
jarl stats timeline --since 7d --key g:named:rss --table # named's memory over a week
|
jarl stats timeline --since 7d --key g:named:rss --table # named's memory over a week
|
||||||
jarl stats summary --since 30d -o json # export (also -o yaml)
|
jarl stats summary --since 30d -o json # export (also -o yaml)
|
||||||
@@ -182,6 +193,70 @@ jarl stats summary --since 30d -o json # export (also -o yaml)
|
|||||||
`operator` roles include it, `dns-editor` doesn't. Statistics show client
|
`operator` roles include it, `dns-editor` doesn't. Statistics show client
|
||||||
addresses and what they look up, so grant it with care.
|
addresses and what they look up, so grant it with care.
|
||||||
|
|
||||||
|
## Exploring
|
||||||
|
|
||||||
|
The counters and top lists say how much, not who asked for what: "100
|
||||||
|
NXDOMAIN answers in the external view" can't tell you which clients asked.
|
||||||
|
For that, jarld also keeps every answer for a while, the **query log**: time,
|
||||||
|
client, view, name, record type, result, and the blocklist (or your rules)
|
||||||
|
that blocked it. It is in the statistics database, from the response log
|
||||||
|
named writes anyway, and answers older than `retention.queries` (default
|
||||||
|
7 days) are deleted every hour; `0` keeps none.
|
||||||
|
|
||||||
|
With it, every client, name, view, record type, result and blocklist on the
|
||||||
|
Statistics page is a link to the **explore** page (`#/stats/explore`),
|
||||||
|
which shows, for what you clicked:
|
||||||
|
|
||||||
|
* the answers over time (and how many were blocked);
|
||||||
|
* the top clients, names, views, record types, results and blocklists
|
||||||
|
among them, each a link that narrows the filter further;
|
||||||
|
* the latest 100 answers, every cell a link.
|
||||||
|
|
||||||
|
So "external, NXDOMAIN" leads to the clients asking, a client to everything
|
||||||
|
it asks, one of its names to who else asks for it. The page also opens
|
||||||
|
from **Explore the answers** at the top of the Statistics page, and has a
|
||||||
|
filter bar to type filters in: clients, names, views, record types,
|
||||||
|
results, blocked or not; it suggests values from what is shown.
|
||||||
|
|
||||||
|
Each kind of filter takes several values, comma separated, and matches
|
||||||
|
any of them: `10.0.0.5, 10.0.0.7` is either client. `!value` leaves one
|
||||||
|
out (`!10.0.0.250` hides a monitoring probe), and `*.example.com` is the
|
||||||
|
name and every name below it, so `!*.apple.com` drops a chatty device's
|
||||||
|
noise. Kinds combine: this client, in this view, NXDOMAIN, not that name.
|
||||||
|
In the lists, clicking a value adds it and **hide** leaves it out; every
|
||||||
|
value has a chip with a ✕ to take it out again. Filters combine (this
|
||||||
|
client, in this view, blocked only) and each has a ✕ to take it out. A name
|
||||||
|
can be widened to the names below it (`domain=`). The Statistics page's
|
||||||
|
view switches apply here too.
|
||||||
|
|
||||||
|
`anonymize_clients` and `exclude_clients` apply to the query log as to
|
||||||
|
everything else. Its size: each answer takes about 150 to 200 bytes with
|
||||||
|
its indexes, so 50,000 answers a day for 7 days is about 60 MB, 200,000 a
|
||||||
|
day about 250 MB. The Statistics page's server section shows the
|
||||||
|
statistics database's size and how many answers the query log holds, next
|
||||||
|
to the disks (with a bar of how full each is); the dashboard's Storage
|
||||||
|
panel has all of Jarl's databases.
|
||||||
|
|
||||||
|
## Views
|
||||||
|
|
||||||
|
With views, the Statistics page has a toggle per view (and **All** and
|
||||||
|
**None**): switch some off to see only the others, for example your
|
||||||
|
internal and VPS views without the internet's noise on the external one,
|
||||||
|
or several linked views together. The choice is remembered in your
|
||||||
|
browser. The CLI takes `--view` on every `jarl stats` command (repeat it,
|
||||||
|
or separate views with commas), and the API `?views=internal,vps`.
|
||||||
|
|
||||||
|
Only what named's response log says can be split by view: answers (shown
|
||||||
|
as *answers* instead of queries), result codes, record types, zones,
|
||||||
|
blocking, rate limiting and the top lists. named's own counters (answer
|
||||||
|
sources, transport, upstream response times, DNSSEC, the cache and the
|
||||||
|
server) are for the whole server, and the page says so; asking for them
|
||||||
|
per view (`jarl stats breakdown answer --view internal`) is refused.
|
||||||
|
|
||||||
|
Per-view figures are kept from the version that added them (Jarl 0.4.1);
|
||||||
|
the page says since when. They take some more room in the statistics
|
||||||
|
database, roughly in proportion to the number of views.
|
||||||
|
|
||||||
## How data is kept
|
## How data is kept
|
||||||
|
|
||||||
- Minute counters are kept for `retention.minute`, hourly counters and top
|
- Minute counters are kept for `retention.minute`, hourly counters and top
|
||||||
|
|||||||
@@ -104,6 +104,26 @@ applied.
|
|||||||
| `dnssec_old_keys` | info | Signing a zone whose key directory still has old keys |
|
| `dnssec_old_keys` | info | Signing a zone whose key directory still has old keys |
|
||||||
| `serial_not_higher` | error | An explicit serial on a signed zone must be above the one named has loaded (automatic serials are raised by themselves) |
|
| `serial_not_higher` | error | An explicit serial on a signed zone must be above the one named has loaded (automatic serials are raised by themselves) |
|
||||||
|
|
||||||
|
## TLS
|
||||||
|
|
||||||
|
| Code | Severity | Check |
|
||||||
|
|------|----------|-------|
|
||||||
|
| `tls_file_missing` | error | The files a top-level `tls` statement names (certificate, key, CA) exist: named doesn't load its configuration without them |
|
||||||
|
|
||||||
|
## Linked zones
|
||||||
|
|
||||||
|
See [views.md](views.md#linked-zones). Jarl keeps linked zones in step
|
||||||
|
itself, so these only show when something got past it (a change staged
|
||||||
|
before the zones were linked, or the database edited by hand).
|
||||||
|
|
||||||
|
| Code | Severity | Check |
|
||||||
|
|------|----------|-------|
|
||||||
|
| `linked_zone_type` | error | Only primary zones can be linked |
|
||||||
|
| `linked_zone_name` | error | Linked zones have the same name |
|
||||||
|
| `linked_mixed` | error | A name and type in a zone is either shared or local, not both |
|
||||||
|
| `linked_out_of_sync` | error | Every view that doesn't override a shared name and type has the same records for it. Link the zones again (`jarl zone link`) to work out what is shared |
|
||||||
|
| `linked_zone_alone` | info | A zone linked with no other zone |
|
||||||
|
|
||||||
## Blocking
|
## Blocking
|
||||||
|
|
||||||
From [blocking.md](blocking.md).
|
From [blocking.md](blocking.md).
|
||||||
@@ -124,11 +144,26 @@ From [blocking.md](blocking.md).
|
|||||||
|
|
||||||
## Security lints
|
## Security lints
|
||||||
|
|
||||||
|
These and the exposure checks below only look at views that are
|
||||||
|
reachable from the internet ([exposure.md](exposure.md)); without views,
|
||||||
|
the open resolver and open transfer checks look at the server. Any of them
|
||||||
|
can be acknowledged (it then shows as info, with who accepted it and why),
|
||||||
|
and a change that newly introduces an open resolver, open transfers, cache
|
||||||
|
snooping, open NOTIFY or an open management interface on a public view
|
||||||
|
must be confirmed (`--accept-risk`).
|
||||||
|
|
||||||
| Code | Severity | What it catches |
|
| Code | Severity | What it catches |
|
||||||
|------|----------|-----------------|
|
|------|----------|-----------------|
|
||||||
| `security_open_resolver` | warning | A view (or the server) where recursion is on and reachable by any client. This includes the BIND trap where `allow-recursion` is unset and inherits `allow-query { any; }`. Open resolvers are abused for DDoS amplification. Set `allow-recursion` to your own networks |
|
| `security_open_resolver` | warning | A view (or the server) where recursion is on and reachable by any client. This includes the BIND trap where `allow-recursion` is unset and inherits `allow-query { any; }`. Open resolvers are abused for DDoS amplification. Set `allow-recursion` to your own networks |
|
||||||
| `security_open_transfer` | warning | `allow-transfer` open to anyone. Restrict it to your secondaries or a TSIG key |
|
| `security_open_transfer` | warning | `allow-transfer` open to anyone. Restrict it to your secondaries or a TSIG key |
|
||||||
| `dynamic_update_unsupported` | error | `allow-update` / `update-policy` on a Jarl zone. named would write to files that Jarl regenerates, losing the updates. Use the API (e.g. `jarl acme`) instead |
|
| `dynamic_update_unsupported` | error | `allow-update` / `update-policy` on a Jarl zone. named would write to files that Jarl regenerates, losing the updates. Use the API (e.g. `jarl acme`) instead |
|
||||||
|
| `exposure_rate_limit` | warning | A public view without response rate limiting (`rate-limit`) |
|
||||||
|
| `exposure_rate_limit_log_only` | info | Rate limiting in log-only mode: check what it would limit, then enforce |
|
||||||
|
| `exposure_minimal_any` | warning | A public view answering ANY queries in full (`minimal-any` off) |
|
||||||
|
| `exposure_cache_snooping` | warning | A public view without recursion whose cache anyone may query (`allow-query-cache`) |
|
||||||
|
| `exposure_open_notify` | warning | A public view accepting NOTIFY from anyone (`allow-notify`) |
|
||||||
|
| `exposure_version`, `exposure_hostname` | warning | The server is public and shows its BIND version or host name to anyone (`version none`, `hostname none`) |
|
||||||
|
| `exposure_management` | warning | `controls` or `statistics-channels` on an address that isn't loopback, open to anyone, while the server is public |
|
||||||
|
|
||||||
## What only BIND checks
|
## What only BIND checks
|
||||||
|
|
||||||
|
|||||||
+137
-9
@@ -81,21 +81,34 @@ avoids named-checkconf's warning that `allow-recursion` is still active in a
|
|||||||
view with recursion off. Jarl warns (`security_open_resolver`) if a view
|
view with recursion off. Jarl warns (`security_open_resolver`) if a view
|
||||||
ever offers recursion to everyone.
|
ever offers recursion to everyone.
|
||||||
|
|
||||||
|
Jarl counts the external view as reachable from the internet (its
|
||||||
|
match-clients end in `any`) and checks it: rate limiting, ANY queries,
|
||||||
|
the version string and more. See the **Exposure** page or `jarl exposure`,
|
||||||
|
and [exposure.md](exposure.md) to set up response rate limiting.
|
||||||
|
|
||||||
### 4. Give the external view its zones
|
### 4. Give the external view its zones
|
||||||
|
|
||||||
**Different data per view (split DNS).** Copy the zone, then change what
|
**Mostly the same, a few differences (split DNS).** Create the external
|
||||||
should differ:
|
copy *linked* ([below](#linked-zones)): Jarl keeps the shared records the
|
||||||
|
same in both views, and each view can have records of its own:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl zone create adbraun.lol --view external --link-with internal
|
||||||
|
jarl record set adbraun.lol www A 203.0.113.20 --view external --local # public address, external only
|
||||||
|
jarl record delete adbraun.lol nas-internal A --view external # gone from both: it was shared
|
||||||
|
```
|
||||||
|
|
||||||
|
Delete records you don't want outside before you link, or make them local
|
||||||
|
to the internal view first (`jarl record update ID --local`): a shared
|
||||||
|
record is in both views.
|
||||||
|
|
||||||
|
**Two separate copies.** `--clone-from` copies the zone once; from then on
|
||||||
|
the two are separate zones, and a record added to one isn't in the other:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
jarl zone create adbraun.lol --view external --clone-from adbraun.lol --clone-view internal
|
jarl zone create adbraun.lol --view external --clone-from adbraun.lol --clone-view internal
|
||||||
jarl record list adbraun.lol --view external
|
|
||||||
jarl record update <id> --data 203.0.113.20 # public address instead of 10.10.0.20
|
|
||||||
jarl record delete adbraun.lol nas-internal A --view external
|
|
||||||
```
|
```
|
||||||
|
|
||||||
From then on the two copies are separate zones. A record added to one isn't
|
|
||||||
in the other, and the serials are separate.
|
|
||||||
|
|
||||||
**The same data in both views.** Use an `in-view` zone. The external view
|
**The same data in both views.** Use an `in-view` zone. The external view
|
||||||
then serves the internal view's zone, so there is one copy to maintain:
|
then serves the internal view's zone, so there is one copy to maintain:
|
||||||
|
|
||||||
@@ -155,6 +168,118 @@ shows one (it needs `tsig:write` and is audited). Key names starting with
|
|||||||
`jarl-view-` are reserved, and the view keys can be used in your own
|
`jarl-view-` are reserved, and the view keys can be used in your own
|
||||||
options (`allow-transfer { key jarl-view-external; }`).
|
options (`allow-transfer { key jarl-view-external; }`).
|
||||||
|
|
||||||
|
## Linked zones
|
||||||
|
|
||||||
|
Most split-horizon zones are the same in every view apart from a few
|
||||||
|
names. Linking zones of the same name in different views lets Jarl keep
|
||||||
|
the shared records in step, while each view can still have records of its
|
||||||
|
own and its own zone options.
|
||||||
|
|
||||||
|
* **Shared records** are in every linked view. Adding, changing,
|
||||||
|
disabling or deleting one in any view does the same in the others, in
|
||||||
|
the same changeset: the diff shows every view, and history, undo and
|
||||||
|
`jarl check` treat them together.
|
||||||
|
* **Local records** are in one view only (`--local`, or **Only here** in
|
||||||
|
the web UI). A local record overrides the shared records of the same name
|
||||||
|
and type in that view: `www A 10.0.10.5` local to internal, while the
|
||||||
|
external view keeps the shared `www A 203.0.113.20`. Delete the local
|
||||||
|
records and the view gets the shared ones back.
|
||||||
|
* A new record joins the set of the same name and type: local if that set
|
||||||
|
is local in its view, shared otherwise.
|
||||||
|
* **Sharing a version** (`jarl record update ID --shared`, **Share** in the
|
||||||
|
web UI) makes that view's records of that name and type the shared
|
||||||
|
version: the other views' records of that name and type are replaced.
|
||||||
|
* Zones stay separate in named, so each keeps its own serial, options
|
||||||
|
(allow-transfer, DNSSEC signing, ...) and file, and the views keep their
|
||||||
|
own `match-clients`, recursion and order.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
jarl zone link adbraun.lol --view internal --with external # link two existing zones
|
||||||
|
jarl zone create adbraun.lol --view vps --link-with external # a new zone, linked from the start
|
||||||
|
jarl record list adbraun.lol --view internal # LINK column: shared or local
|
||||||
|
jarl record add adbraun.lol nas A 10.0.10.20 --view internal --local
|
||||||
|
jarl record update 1234 --local # this name and type: only this view
|
||||||
|
jarl record update 1234 --shared # this view's version, everywhere
|
||||||
|
jarl zone unlink adbraun.lol --view vps # records stay, all local
|
||||||
|
```
|
||||||
|
|
||||||
|
**Linking never changes what named answers.** A name and type with the
|
||||||
|
same records in every view becomes shared; one that differs stays local to
|
||||||
|
each view (Jarl lists them). Share the right version afterwards. Unlinking
|
||||||
|
keeps every record, all local; a link left with one zone is dissolved, as
|
||||||
|
when the other zone is deleted.
|
||||||
|
|
||||||
|
`--local` also works on a zone that isn't linked (its records are local
|
||||||
|
anyway), so scripts don't need to know; `--shared` there is refused.
|
||||||
|
|
||||||
|
**Permissions** are checked in every view a change reaches. A token with
|
||||||
|
a grant for one view only (`views=internal`) can change that view's local
|
||||||
|
records and make overrides, but not a shared record, since that would
|
||||||
|
change the other views too: Jarl says so and suggests a local record. A
|
||||||
|
grant without a view (the usual `zones=adbraun.lol`) covers every view.
|
||||||
|
|
||||||
|
**Importing a zone file** into a linked zone (`jarl zone import`) adds
|
||||||
|
the records like any others: shared, unless the name and type is local
|
||||||
|
there. With `--replace`, shared records missing from the file are deleted
|
||||||
|
in every linked view.
|
||||||
|
|
||||||
|
**ACME challenges** are written once per link, and so reach every linked
|
||||||
|
view; `jarl acme`, lego's httpreq and certificates Jarl obtains all do
|
||||||
|
this.
|
||||||
|
|
||||||
|
**Compared with BIND's `in-view`**, where one view serves another's zone
|
||||||
|
as it is: linked zones can differ per view, keep their own options, and
|
||||||
|
don't depend on the view order (`in-view` can only use a view defined
|
||||||
|
before it).
|
||||||
|
|
||||||
|
## Comparing views
|
||||||
|
|
||||||
|
A zone's **Compare views** tab, or `jarl zone diff`, compares it with the
|
||||||
|
same zone in another view (or all of them), from the view you're on:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ jarl zone diff adbraun.lol --view internal
|
||||||
|
adbraun.lol in internal, compared with external
|
||||||
|
linked: a difference is a view's own records, there on purpose
|
||||||
|
external: 1 answered differently, 24 only in internal, 2 only in external, 31 the same
|
||||||
|
|
||||||
|
ANSWERED DIFFERENTLY (1)
|
||||||
|
nas A
|
||||||
|
internal 10.0.10.20 [local, id 812]
|
||||||
|
external 203.0.113.20 [local, id 790]
|
||||||
|
|
||||||
|
ONLY IN INTERNAL (24)
|
||||||
|
printer A 10.0.10.30
|
||||||
|
router A 10.0.10.1
|
||||||
|
...
|
||||||
|
|
||||||
|
ONLY IN EXTERNAL (2)
|
||||||
|
_acme-challenge TXT "…"
|
||||||
|
...
|
||||||
|
|
||||||
|
31 names and types are the same (--all lists them)
|
||||||
|
```
|
||||||
|
|
||||||
|
* **Answered differently**: names and types more than one view has, with
|
||||||
|
different records. In linked zones that is a view's own (local)
|
||||||
|
records, there on purpose; between zones that aren't linked, it is a
|
||||||
|
difference that crept in. **Use this everywhere** gives every view one
|
||||||
|
view's records (in linked zones by sharing them: `jarl record update ID
|
||||||
|
--shared`).
|
||||||
|
* **Only in …**: names and types some views lack. **Add to external**
|
||||||
|
gives that view the same records, its own.
|
||||||
|
* **The same**: how many; `--all` (or "List them") shows them.
|
||||||
|
|
||||||
|
One line per record: the CLI cuts long values to fit the terminal
|
||||||
|
(`--wide` shows them whole); the web UI shows the whole value on hover.
|
||||||
|
The apex NS records are left out, since views often list their name
|
||||||
|
servers differently on purpose.
|
||||||
|
|
||||||
|
**One name.** `jarl zone diff adbraun.lol nas` (and a type: `... @ TXT`)
|
||||||
|
shows just that name in every view, the same records included. In the
|
||||||
|
web UI, a record's **Compare** button does the same. `--with external`
|
||||||
|
(repeat it) picks the views to compare with.
|
||||||
|
|
||||||
## Living with views
|
## Living with views
|
||||||
|
|
||||||
* Commands that name a zone that exists in several views need `--view`
|
* Commands that name a zone that exists in several views need `--view`
|
||||||
@@ -162,7 +287,10 @@ options (`allow-transfer { key jarl-view-external; }`).
|
|||||||
guess.
|
guess.
|
||||||
* `jarl acme` writes challenge records into **every** view that has the
|
* `jarl acme` writes challenge records into **every** view that has the
|
||||||
zone, so Let's Encrypt (external) and internal clients see the same
|
zone, so Let's Encrypt (external) and internal clients see the same
|
||||||
thing. Use `--view` to limit it.
|
thing (once per link, for linked zones). Use `--view` to limit it.
|
||||||
|
* `--view all` (or a list) on record commands changes each linked zone
|
||||||
|
once: the change reaches the others through the link. With `--local` it
|
||||||
|
goes to each view named.
|
||||||
* `jarl view order internal external` changes the match order, and
|
* `jarl view order internal external` changes the match order, and
|
||||||
`jarl view list` shows it.
|
`jarl view list` shows it.
|
||||||
* Deleting a view is refused while it still has zones, unless you pass
|
* Deleting a view is refused while it still has zones, unless you pass
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ go 1.27.1
|
|||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/aymanbagabas/go-udiff v0.4.1
|
github.com/aymanbagabas/go-udiff v0.4.1
|
||||||
|
github.com/go-acme/lego/v4 v4.35.2
|
||||||
github.com/miekg/dns v1.1.73
|
github.com/miekg/dns v1.1.73
|
||||||
github.com/spf13/cobra v1.10.2
|
github.com/spf13/cobra v1.10.2
|
||||||
go.yaml.in/yaml/v3 v3.0.5
|
go.yaml.in/yaml/v3 v3.0.5
|
||||||
@@ -15,7 +16,9 @@ require (
|
|||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
|
github.com/cenkalti/backoff/v5 v5.0.3 // indirect
|
||||||
github.com/dustin/go-humanize v1.0.1 // indirect
|
github.com/dustin/go-humanize v1.0.1 // indirect
|
||||||
|
github.com/go-jose/go-jose/v4 v4.1.4 // indirect
|
||||||
github.com/google/uuid v1.6.0 // indirect
|
github.com/google/uuid v1.6.0 // indirect
|
||||||
github.com/inconshreveable/mousetrap v1.1.0 // indirect
|
github.com/inconshreveable/mousetrap v1.1.0 // indirect
|
||||||
github.com/mattn/go-isatty v0.0.24 // indirect
|
github.com/mattn/go-isatty v0.0.24 // indirect
|
||||||
|
|||||||
@@ -1,8 +1,16 @@
|
|||||||
github.com/aymanbagabas/go-udiff v0.4.1 h1:OEIrQ8maEeDBXQDoGCbbTTXYJMYRCRO1fnodZ12Gv5o=
|
github.com/aymanbagabas/go-udiff v0.4.1 h1:OEIrQ8maEeDBXQDoGCbbTTXYJMYRCRO1fnodZ12Gv5o=
|
||||||
github.com/aymanbagabas/go-udiff v0.4.1/go.mod h1:0L9PGwj20lrtmEMeyw4WKJ/TMyDtvAoK9bf2u/mNo3w=
|
github.com/aymanbagabas/go-udiff v0.4.1/go.mod h1:0L9PGwj20lrtmEMeyw4WKJ/TMyDtvAoK9bf2u/mNo3w=
|
||||||
|
github.com/cenkalti/backoff/v5 v5.0.3 h1:ZN+IMa753KfX5hd8vVaMixjnqRZ3y8CuJKRKj1xcsSM=
|
||||||
|
github.com/cenkalti/backoff/v5 v5.0.3/go.mod h1:rkhZdG3JZukswDf7f0cwqPNk4K0sa+F97BxZthm/crw=
|
||||||
github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
|
github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
|
||||||
github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
|
github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
|
||||||
github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
|
github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
|
||||||
|
github.com/go-acme/lego/v4 v4.35.2 h1:uVQg+KC/yj9R2g7Q9W5wDqhvQvxV5SMu5eqFVoN5xZU=
|
||||||
|
github.com/go-acme/lego/v4 v4.35.2/go.mod h1:pX2jN5n8OphMGY1IaMjYm5DAEzguBaKRt8AvJAgJXpc=
|
||||||
|
github.com/go-jose/go-jose/v4 v4.1.4 h1:moDMcTHmvE6Groj34emNPLs/qtYXRVcd6S7NHbHz3kA=
|
||||||
|
github.com/go-jose/go-jose/v4 v4.1.4/go.mod h1:x4oUasVrzR7071A4TnHLGSPpNOm2a21K9Kf04k1rs08=
|
||||||
|
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
|
||||||
|
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
|
||||||
github.com/google/pprof v0.0.0-20260802141513-ef3492d7dac3 h1:LMLX+LgTNWpfvCBdFebv6EsYotImrt/Ppc5cXIriCSo=
|
github.com/google/pprof v0.0.0-20260802141513-ef3492d7dac3 h1:LMLX+LgTNWpfvCBdFebv6EsYotImrt/Ppc5cXIriCSo=
|
||||||
github.com/google/pprof v0.0.0-20260802141513-ef3492d7dac3/go.mod h1:jl5iWTm0/hd5PjEYEOuwAJ57L/CibdZfrqZ5XA5GrCk=
|
github.com/google/pprof v0.0.0-20260802141513-ef3492d7dac3/go.mod h1:jl5iWTm0/hd5PjEYEOuwAJ57L/CibdZfrqZ5XA5GrCk=
|
||||||
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
||||||
@@ -24,6 +32,8 @@ github.com/spf13/cobra v1.10.2 h1:DMTTonx5m65Ic0GOoRY2c16WCbHxOOw6xxezuLaBpcU=
|
|||||||
github.com/spf13/cobra v1.10.2/go.mod h1:7C1pvHqHw5A4vrJfjNwvOdzYu0Gml16OCs2GRiTUUS4=
|
github.com/spf13/cobra v1.10.2/go.mod h1:7C1pvHqHw5A4vrJfjNwvOdzYu0Gml16OCs2GRiTUUS4=
|
||||||
github.com/spf13/pflag v1.0.9 h1:9exaQaMOCwffKiiiYk6/BndUBv+iRViNW+4lEMi0PvY=
|
github.com/spf13/pflag v1.0.9 h1:9exaQaMOCwffKiiiYk6/BndUBv+iRViNW+4lEMi0PvY=
|
||||||
github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
||||||
|
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
|
||||||
|
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
|
||||||
go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
|
go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
|
||||||
go.yaml.in/yaml/v3 v3.0.5 h1:N6y/pJk8buWs9NY5ERU2HSMfm+IuD/OtfdAnq6kESPw=
|
go.yaml.in/yaml/v3 v3.0.5 h1:N6y/pJk8buWs9NY5ERU2HSMfm+IuD/OtfdAnq6kESPw=
|
||||||
go.yaml.in/yaml/v3 v3.0.5/go.mod h1:HVTZu1O7/Vkt2N+BFy8Zza+lnLsABggaTM2ZpNIGuKg=
|
go.yaml.in/yaml/v3 v3.0.5/go.mod h1:HVTZu1O7/Vkt2N+BFy8Zza+lnLsABggaTM2ZpNIGuKg=
|
||||||
|
|||||||
+17
-1
@@ -21,6 +21,10 @@ const Comment = "ACME DNS-01 challenge"
|
|||||||
type Zone struct {
|
type Zone struct {
|
||||||
Name string // as Jarl stores it, e.g. "adbraun.lol."
|
Name string // as Jarl stores it, e.g. "adbraun.lol."
|
||||||
View string // "" when views are not used
|
View string // "" when views are not used
|
||||||
|
// Link is the zone's link group (0: not linked). A record written
|
||||||
|
// into one zone of a link reaches the others (docs/views.md#linked-zones),
|
||||||
|
// so only one of them is written to.
|
||||||
|
Link int64
|
||||||
}
|
}
|
||||||
|
|
||||||
// Zones returns the zones that hold name: the longest matching zone, in
|
// Zones returns the zones that hold name: the longest matching zone, in
|
||||||
@@ -46,7 +50,19 @@ func Zones(name string, zones []Zone, view string) []Zone {
|
|||||||
out = append(out, z)
|
out = append(out, z)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return out
|
// One zone per link: Jarl writes the shared record into the others.
|
||||||
|
var dedup []Zone
|
||||||
|
links := map[int64]bool{}
|
||||||
|
for _, z := range out {
|
||||||
|
if z.Link != 0 {
|
||||||
|
if links[z.Link] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
links[z.Link] = true
|
||||||
|
}
|
||||||
|
dedup = append(dedup, z)
|
||||||
|
}
|
||||||
|
return dedup
|
||||||
}
|
}
|
||||||
|
|
||||||
// Requests returns the changes that set (or, with set false, remove) the
|
// Requests returns the changes that set (or, with set false, remove) the
|
||||||
|
|||||||
@@ -29,6 +29,19 @@ type Zone struct {
|
|||||||
// Registrar names the registrar Jarl can manage the domain at
|
// Registrar names the registrar Jarl can manage the domain at
|
||||||
// ("porkbun"), when one is configured for it.
|
// ("porkbun"), when one is configured for it.
|
||||||
Registrar string `json:"registrar,omitempty"`
|
Registrar string `json:"registrar,omitempty"`
|
||||||
|
// LinkedWith are the views of the zones this one is linked with
|
||||||
|
// (docs/views.md#linked-zones).
|
||||||
|
LinkedWith []string `json:"linked_with,omitempty"`
|
||||||
|
// Links are the zones this one is linked with, with their views.
|
||||||
|
Links []ZoneLink `json:"links,omitempty"`
|
||||||
|
// OtherViews are the other views with a primary zone of this name
|
||||||
|
// (linked or not): what GET /zones/{zone}/compare compares.
|
||||||
|
OtherViews []string `json:"other_views,omitempty"`
|
||||||
|
// Prefix is the network a reverse zone answers for; PTRMissing how
|
||||||
|
// many of its view's A and AAAA addresses in it have no PTR record
|
||||||
|
// (POST /zones/{zone}/fill-ptr adds them).
|
||||||
|
Prefix string `json:"prefix,omitempty"`
|
||||||
|
PTRMissing int `json:"ptr_missing,omitempty"`
|
||||||
// Pending is set when listing with a changeset: add, change or delete.
|
// Pending is set when listing with a changeset: add, change or delete.
|
||||||
Pending string `json:"pending,omitempty"`
|
Pending string `json:"pending,omitempty"`
|
||||||
}
|
}
|
||||||
@@ -40,6 +53,8 @@ type Record struct {
|
|||||||
View string `json:"view,omitempty"`
|
View string `json:"view,omitempty"`
|
||||||
RelativeName string `json:"relative_name"`
|
RelativeName string `json:"relative_name"`
|
||||||
EffectiveTTL uint32 `json:"effective_ttl"`
|
EffectiveTTL uint32 `json:"effective_ttl"`
|
||||||
|
// Linked is "shared" or "local" for a record of a linked zone ("" otherwise).
|
||||||
|
Linked string `json:"linked,omitempty"`
|
||||||
// Text is the decoded value of TXT and SPF records.
|
// Text is the decoded value of TXT and SPF records.
|
||||||
Text *string `json:"text,omitempty"`
|
Text *string `json:"text,omitempty"`
|
||||||
// Pending is set when listing with a changeset: add, change, delete,
|
// Pending is set when listing with a changeset: add, change, delete,
|
||||||
@@ -208,6 +223,9 @@ type BatchRequest struct {
|
|||||||
Ops []ChangeRequest `json:"ops"`
|
Ops []ChangeRequest `json:"ops"`
|
||||||
DryRun bool `json:"dry_run,omitempty"`
|
DryRun bool `json:"dry_run,omitempty"`
|
||||||
Force bool `json:"force,omitempty"`
|
Force bool `json:"force,omitempty"`
|
||||||
|
// AcceptRisk confirms a change that opens the server up
|
||||||
|
// (docs/exposure.md).
|
||||||
|
AcceptRisk bool `json:"accept_risk,omitempty"`
|
||||||
// Apply (for POST /changesets) applies the new changeset at once.
|
// Apply (for POST /changesets) applies the new changeset at once.
|
||||||
Apply bool `json:"apply,omitempty"`
|
Apply bool `json:"apply,omitempty"`
|
||||||
}
|
}
|
||||||
@@ -253,6 +271,63 @@ type StatusResponse struct {
|
|||||||
// BlockingPausedIndefinitely while it is paused until resumed.
|
// BlockingPausedIndefinitely while it is paused until resumed.
|
||||||
BlockingPausedUntil *time.Time `json:"blocking_paused_until,omitempty"`
|
BlockingPausedUntil *time.Time `json:"blocking_paused_until,omitempty"`
|
||||||
BlockingPausedIndefinitely bool `json:"blocking_paused_indefinitely,omitempty"`
|
BlockingPausedIndefinitely bool `json:"blocking_paused_indefinitely,omitempty"`
|
||||||
|
// Certificates sums up the TLS certificates Jarl manages
|
||||||
|
// (administrators only, when there are any).
|
||||||
|
Certificates *CertSummary `json:"certificates,omitempty"`
|
||||||
|
// EncryptedDNS is the last check of DNS over TLS and HTTPS, when it
|
||||||
|
// is set up (for those who may see options).
|
||||||
|
EncryptedDNS *EncDNSSummary `json:"encrypted_dns,omitempty"`
|
||||||
|
// Storage is the size of Jarl's databases and how full the disks Jarl
|
||||||
|
// uses are (administrators only).
|
||||||
|
Storage *Storage `json:"storage,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Storage is the size of Jarl's databases and the disks Jarl uses.
|
||||||
|
type Storage struct {
|
||||||
|
Databases []Database `json:"databases"`
|
||||||
|
Total int64 `json:"total"` // the databases' bytes
|
||||||
|
Disks []Disk `json:"disks"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Database is one of Jarl's databases: its file with its -wal and -shm.
|
||||||
|
type Database struct {
|
||||||
|
Label string `json:"label"`
|
||||||
|
Path string `json:"path"`
|
||||||
|
Bytes int64 `json:"bytes"`
|
||||||
|
// Rows is how many answers the query log holds (statistics only),
|
||||||
|
// and QueryLogRetention how long it keeps them ("7d").
|
||||||
|
QueryLogRows *int64 `json:"query_log_rows,omitempty"`
|
||||||
|
QueryLogRetention string `json:"query_log_retention,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Disk is a file system Jarl uses: what of Jarl's it holds, its size,
|
||||||
|
// what is free, and how much of it the databases take.
|
||||||
|
type Disk struct {
|
||||||
|
Path string `json:"path"`
|
||||||
|
Holds []string `json:"holds"`
|
||||||
|
Total int64 `json:"total"`
|
||||||
|
Free int64 `json:"free"`
|
||||||
|
Databases int64 `json:"databases"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CertSummary is what the dashboard reports about certificates.
|
||||||
|
type CertSummary struct {
|
||||||
|
Total int `json:"total"`
|
||||||
|
// Problems are the certificates that aren't fine: failing, expiring,
|
||||||
|
// expired (not ones still being obtained for the first time).
|
||||||
|
Problems []CertProblem `json:"problems"`
|
||||||
|
// Next is the certificate that expires first, and when.
|
||||||
|
Next string `json:"next,omitempty"`
|
||||||
|
NextAfter *time.Time `json:"next_after,omitempty"`
|
||||||
|
// Serving is the certificate jarld serves HTTPS with ("" for none or tls.cert_file).
|
||||||
|
Serving string `json:"serving,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CertProblem is a certificate that needs attention.
|
||||||
|
type CertProblem struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
State string `json:"state"`
|
||||||
|
Message string `json:"message"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// BlocklistError is a blocklist whose last update failed. UpdatedAt is
|
// BlocklistError is a blocklist whose last update failed. UpdatedAt is
|
||||||
@@ -536,3 +611,17 @@ type BlockRule struct {
|
|||||||
AutoViews bool `json:"auto_views,omitempty"`
|
AutoViews bool `json:"auto_views,omitempty"`
|
||||||
Pending string `json:"pending,omitempty"`
|
Pending string `json:"pending,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ZoneLink is a zone a zone is linked with.
|
||||||
|
type ZoneLink struct {
|
||||||
|
ID int64 `json:"id"`
|
||||||
|
View string `json:"view"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncDNSSummary is what the dashboard says about encrypted DNS.
|
||||||
|
type EncDNSSummary struct {
|
||||||
|
Checked time.Time `json:"checked"`
|
||||||
|
OK bool `json:"ok"`
|
||||||
|
Problems []string `json:"problems"`
|
||||||
|
Warnings []string `json:"warnings"`
|
||||||
|
}
|
||||||
@@ -0,0 +1,406 @@
|
|||||||
|
package certs
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto"
|
||||||
|
"crypto/ecdsa"
|
||||||
|
"crypto/elliptic"
|
||||||
|
"crypto/rand"
|
||||||
|
"crypto/tls"
|
||||||
|
"crypto/x509"
|
||||||
|
"encoding/json"
|
||||||
|
"encoding/pem"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/go-acme/lego/v4/certcrypto"
|
||||||
|
"github.com/go-acme/lego/v4/certificate"
|
||||||
|
"github.com/go-acme/lego/v4/challenge/dns01"
|
||||||
|
"github.com/go-acme/lego/v4/lego"
|
||||||
|
"github.com/go-acme/lego/v4/registration"
|
||||||
|
|
||||||
|
"jarl/internal/acme"
|
||||||
|
"jarl/internal/auth"
|
||||||
|
"jarl/internal/engine"
|
||||||
|
"jarl/internal/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Account is the ACME account certificates are obtained with. Its key is
|
||||||
|
// kept in Jarl's database (and so in backups), like TSIG secrets.
|
||||||
|
type Account struct {
|
||||||
|
Directory string `json:"directory"`
|
||||||
|
Email string `json:"email,omitempty"`
|
||||||
|
URI string `json:"uri,omitempty"` // the account at the CA
|
||||||
|
RegisteredAt time.Time `json:"registered_at"`
|
||||||
|
KeyPEM string `json:"key_pem,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
const metaAccount = "acme.account"
|
||||||
|
|
||||||
|
// account returns the stored account (nil when there is none).
|
||||||
|
func (m *Manager) account(ctx context.Context) *Account {
|
||||||
|
raw, err := m.store.GetMeta(ctx, metaAccount)
|
||||||
|
if err != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
var a Account
|
||||||
|
if json.Unmarshal([]byte(raw), &a) != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return &a
|
||||||
|
}
|
||||||
|
|
||||||
|
type legoUser struct {
|
||||||
|
email string
|
||||||
|
reg *registration.Resource
|
||||||
|
key crypto.PrivateKey
|
||||||
|
}
|
||||||
|
|
||||||
|
func (u *legoUser) GetEmail() string { return u.email }
|
||||||
|
func (u *legoUser) GetRegistration() *registration.Resource { return u.reg }
|
||||||
|
func (u *legoUser) GetPrivateKey() crypto.PrivateKey { return u.key }
|
||||||
|
|
||||||
|
// ErrTermsNotAgreed means acme.account.agree_tos isn't set.
|
||||||
|
var ErrTermsNotAgreed = errors.New("acme.account.agree_tos isn't set")
|
||||||
|
|
||||||
|
func (m *Manager) httpClient() (*http.Client, error) {
|
||||||
|
tr := http.DefaultTransport.(*http.Transport).Clone()
|
||||||
|
tr.TLSClientConfig = &tls.Config{MinVersion: tls.VersionTLS12}
|
||||||
|
if m.cfg.CABundle != "" {
|
||||||
|
pem, err := os.ReadFile(m.cfg.CABundle)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("acme.ca_bundle: %w", err)
|
||||||
|
}
|
||||||
|
pool, err := x509.SystemCertPool()
|
||||||
|
if err != nil || pool == nil {
|
||||||
|
pool = x509.NewCertPool()
|
||||||
|
}
|
||||||
|
if !pool.AppendCertsFromPEM(pem) {
|
||||||
|
return nil, fmt.Errorf("acme.ca_bundle: no certificates in %s", m.cfg.CABundle)
|
||||||
|
}
|
||||||
|
tr.TLSClientConfig.RootCAs = pool
|
||||||
|
}
|
||||||
|
return &http.Client{Timeout: 2 * time.Minute, Transport: tr}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// client returns a lego client for the account (registering it when
|
||||||
|
// needed) that makes keys of keyType.
|
||||||
|
func (m *Manager) client(ctx context.Context, keyType string) (*lego.Client, error) {
|
||||||
|
dir := m.cfg.Directory
|
||||||
|
hc, err := m.httpClient()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
a := m.account(ctx)
|
||||||
|
user := &legoUser{email: m.cfg.Email}
|
||||||
|
if a != nil && a.Directory == dir && a.KeyPEM != "" {
|
||||||
|
if user.key, err = parseKey(a.KeyPEM); err != nil {
|
||||||
|
return nil, fmt.Errorf("the stored ACME account key: %w", err)
|
||||||
|
}
|
||||||
|
if a.URI != "" {
|
||||||
|
user.reg = ®istration.Resource{URI: a.URI}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
k, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
user.key = k
|
||||||
|
}
|
||||||
|
cfg := lego.NewConfig(user)
|
||||||
|
cfg.CADirURL, cfg.HTTPClient, cfg.UserAgent = dir, hc, "jarl/"+m.cfg.Version
|
||||||
|
cfg.Certificate.KeyType = legoKeyType(keyType)
|
||||||
|
cfg.Certificate.Timeout = 90 * time.Second
|
||||||
|
c, err := lego.NewClient(cfg)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("ACME server %s: %w", dir, err)
|
||||||
|
}
|
||||||
|
if user.reg != nil && (a.Email == m.cfg.Email) {
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
if user.reg != nil {
|
||||||
|
// Only the email changed: update the account.
|
||||||
|
if reg, err := c.Registration.UpdateRegistration(registration.RegisterOptions{TermsOfServiceAgreed: true}); err == nil {
|
||||||
|
user.reg = reg
|
||||||
|
return c, m.saveAccount(ctx, user, dir)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !m.cfg.AgreeTOS {
|
||||||
|
tos := c.GetToSURL()
|
||||||
|
if tos == "" {
|
||||||
|
tos = "on the CA's website"
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("%w: Jarl registers an account with %s only after you accept its terms of service (%s): set acme.account.agree_tos: true in jarl.yaml and restart jarld", ErrTermsNotAgreed, dir, tos)
|
||||||
|
}
|
||||||
|
var reg *registration.Resource
|
||||||
|
if m.cfg.EABKeyID != "" {
|
||||||
|
reg, err = c.Registration.RegisterWithExternalAccountBinding(registration.RegisterEABOptions{TermsOfServiceAgreed: true, Kid: m.cfg.EABKeyID, HmacEncoded: m.cfg.EABHMAC})
|
||||||
|
} else {
|
||||||
|
if c.GetExternalAccountRequired() {
|
||||||
|
return nil, fmt.Errorf("%s needs External Account Binding: set acme.account.eab_kid and eab_hmac in jarl.yaml (from the CA's dashboard)", dir)
|
||||||
|
}
|
||||||
|
reg, err = c.Registration.Register(registration.RegisterOptions{TermsOfServiceAgreed: true})
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("registering the ACME account: %w", err)
|
||||||
|
}
|
||||||
|
user.reg = reg
|
||||||
|
m.log.Info("ACME account registered", "directory", dir, "account", reg.URI)
|
||||||
|
return c, m.saveAccount(ctx, user, dir)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *Manager) saveAccount(ctx context.Context, u *legoUser, dir string) error {
|
||||||
|
der, err := x509.MarshalPKCS8PrivateKey(u.key)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
a := Account{Directory: dir, Email: u.email, URI: u.reg.URI, RegisteredAt: time.Now().UTC(),
|
||||||
|
KeyPEM: string(pem.EncodeToMemory(&pem.Block{Type: "PRIVATE KEY", Bytes: der}))}
|
||||||
|
b, _ := json.Marshal(a)
|
||||||
|
return m.store.SetMeta(ctx, metaAccount, string(b))
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseKey(s string) (crypto.PrivateKey, error) {
|
||||||
|
b, _ := pem.Decode([]byte(s))
|
||||||
|
if b == nil {
|
||||||
|
return nil, errors.New("not PEM")
|
||||||
|
}
|
||||||
|
return x509.ParsePKCS8PrivateKey(b.Bytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
func legoKeyType(t string) certcrypto.KeyType {
|
||||||
|
switch t {
|
||||||
|
case "ec384":
|
||||||
|
return certcrypto.EC384
|
||||||
|
case "rsa2048":
|
||||||
|
return certcrypto.RSA2048
|
||||||
|
case "rsa3072":
|
||||||
|
return certcrypto.RSA3072
|
||||||
|
case "rsa4096":
|
||||||
|
return certcrypto.RSA4096
|
||||||
|
}
|
||||||
|
return certcrypto.EC256
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeyTypes are the key types a certificate Jarl obtains can have.
|
||||||
|
var KeyTypes = []string{"ec256", "ec384", "rsa2048", "rsa3072", "rsa4096"}
|
||||||
|
|
||||||
|
// provider answers DNS-01 challenges for one issue: in a zone Jarl serves,
|
||||||
|
// or at Porkbun, as route decides for each name.
|
||||||
|
type provider struct {
|
||||||
|
m *Manager
|
||||||
|
ctx context.Context
|
||||||
|
cert *model.Certificate
|
||||||
|
mu sync.Mutex
|
||||||
|
cleanups map[string]func() error
|
||||||
|
routes []Route
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *provider) Present(domain, token, keyAuth string) error {
|
||||||
|
info := dns01.GetChallengeInfo(domain, keyAuth)
|
||||||
|
st, err := p.m.store.LoadState(p.ctx)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
r := p.m.route(p.ctx, st, p.cert.Challenge, domain, info.EffectiveFQDN)
|
||||||
|
p.mu.Lock()
|
||||||
|
p.routes = append(p.routes, r)
|
||||||
|
p.mu.Unlock()
|
||||||
|
if r.Error != "" {
|
||||||
|
return errors.New(r.Error)
|
||||||
|
}
|
||||||
|
key := info.EffectiveFQDN + " " + info.Value
|
||||||
|
var cleanup func() error
|
||||||
|
switch r.Route {
|
||||||
|
case model.ChallengeJarl:
|
||||||
|
if err := p.m.publish(p.ctx, p.cert, info.EffectiveFQDN, info.Value, true); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
cleanup = func() error {
|
||||||
|
return p.m.publish(context.WithoutCancel(p.ctx), p.cert, info.EffectiveFQDN, info.Value, false)
|
||||||
|
}
|
||||||
|
case model.ChallengePorkbun:
|
||||||
|
zone := strings.TrimSuffix(r.Zone, ".")
|
||||||
|
id, err := p.m.cfg.Porkbun.CreateTXT(p.ctx, zone, strings.TrimSuffix(info.EffectiveFQDN, "."), info.Value)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("publishing the challenge for %s at Porkbun: %w", domain, err)
|
||||||
|
}
|
||||||
|
cleanup = func() error { return p.m.cfg.Porkbun.DeleteRecord(context.WithoutCancel(p.ctx), zone, id) }
|
||||||
|
}
|
||||||
|
p.mu.Lock()
|
||||||
|
p.cleanups[key] = cleanup
|
||||||
|
p.mu.Unlock()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *provider) CleanUp(domain, token, keyAuth string) error {
|
||||||
|
info := dns01.GetChallengeInfo(domain, keyAuth)
|
||||||
|
key := info.EffectiveFQDN + " " + info.Value
|
||||||
|
p.mu.Lock()
|
||||||
|
f := p.cleanups[key]
|
||||||
|
delete(p.cleanups, key)
|
||||||
|
p.mu.Unlock()
|
||||||
|
if f == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := f(); err != nil {
|
||||||
|
p.m.log.Warn("removing an ACME challenge record failed", "certificate", p.cert.Name, "record", info.EffectiveFQDN, "err", err)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Timeout is how long lego waits for the record to reach every name
|
||||||
|
// server of the zone: Porkbun's take a few minutes.
|
||||||
|
func (p *provider) Timeout() (timeout, interval time.Duration) {
|
||||||
|
if p.m.cfg.PropagationTimeout > 0 {
|
||||||
|
return p.m.cfg.PropagationTimeout, 2 * time.Second
|
||||||
|
}
|
||||||
|
return 10 * time.Minute, 10 * time.Second
|
||||||
|
}
|
||||||
|
|
||||||
|
// publish writes (or removes) a challenge TXT record in the Jarl zone that
|
||||||
|
// holds name, in every view that has it, and returns once named serves it.
|
||||||
|
func (m *Manager) publish(ctx context.Context, c *model.Certificate, name, value string, set bool) error {
|
||||||
|
st, err := m.store.LoadState(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
zones := acme.Zones(name, primaryZones(st), "")
|
||||||
|
if len(zones) == 0 {
|
||||||
|
return fmt.Errorf("no primary zone in Jarl contains %s", strings.TrimSuffix(name, "."))
|
||||||
|
}
|
||||||
|
var reqs []engine.Request
|
||||||
|
for _, r := range acme.Requests(name, zones, []string{value}, set, acme.DefaultTTL) {
|
||||||
|
reqs = append(reqs, engine.Request{Op: r.Op, ID: r.ID, BaseVersion: r.BaseVersion, Data: r.Data})
|
||||||
|
}
|
||||||
|
desc := acme.Description(name, set) + " (certificate " + c.Name + ")"
|
||||||
|
if _, err := m.eng.Submit(ctx, reqs, auth.System, "acme", desc, engine.ApplyOptions{}); err != nil {
|
||||||
|
return fmt.Errorf("writing the challenge record %s: %w", strings.TrimSuffix(name, "."), err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// obtain gets a new certificate for c from the CA. old is the certificate
|
||||||
|
// it replaces (nil for the first), so the CA can link them (ARI).
|
||||||
|
func (m *Manager) obtain(ctx context.Context, c *model.Certificate, old *x509.Certificate) (*certificate.Resource, []Route, error) {
|
||||||
|
m.legoMu.Lock()
|
||||||
|
defer m.legoMu.Unlock()
|
||||||
|
client, err := m.client(ctx, c.KeyType)
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
p := &provider{m: m, ctx: ctx, cert: c, cleanups: map[string]func() error{}}
|
||||||
|
opts := []dns01.ChallengeOption{dns01.AddRecursiveNameservers(m.cfg.Resolvers), dns01.AddDNSTimeout(10 * time.Second)}
|
||||||
|
if m.cfg.SkipPropagationCheck {
|
||||||
|
opts = append(opts, dns01.DisableAuthoritativeNssPropagationRequirement())
|
||||||
|
}
|
||||||
|
if err := client.Challenge.SetDNS01Provider(p, opts...); err != nil {
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
req := certificate.ObtainRequest{Domains: c.Domains, Bundle: true}
|
||||||
|
if old != nil {
|
||||||
|
if id, err := certificate.MakeARICertID(old); err == nil {
|
||||||
|
req.ReplacesCertID = id
|
||||||
|
}
|
||||||
|
}
|
||||||
|
res, err := client.Certificate.Obtain(req)
|
||||||
|
if err != nil && req.ReplacesCertID != "" && len(p.routes) == 0 && ctx.Err() == nil {
|
||||||
|
// The CA refused the order itself, before any challenge: it may
|
||||||
|
// not link the new certificate to the old one (another CA, one
|
||||||
|
// already replaced, or its own bug). Ask for a plain new one.
|
||||||
|
m.log.Info("the CA refused to link the renewal to the old certificate; asking for a new one", "certificate", c.Name, "err", cleanLegoError(err))
|
||||||
|
req.ReplacesCertID = ""
|
||||||
|
res, err = client.Certificate.Obtain(req)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, p.routes, cleanLegoError(err)
|
||||||
|
}
|
||||||
|
return res, p.routes, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// renewalInfo asks the CA when to renew (ARI, RFC 9773). nil, nil when
|
||||||
|
// it doesn't say.
|
||||||
|
func (m *Manager) renewalInfo(ctx context.Context, c *model.Certificate, leaf *x509.Certificate) (*time.Time, error) {
|
||||||
|
m.legoMu.Lock()
|
||||||
|
defer m.legoMu.Unlock()
|
||||||
|
client, err := m.client(ctx, c.KeyType)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
ri, err := client.Certificate.GetRenewalInfo(certificate.RenewalInfoRequest{Cert: leaf})
|
||||||
|
if err != nil {
|
||||||
|
if strings.Contains(err.Error(), "does not advertise a renewal info endpoint") {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
// A time within the CA's window (now if it has started); never later
|
||||||
|
// than two thirds into the lifetime, in case the window is odd.
|
||||||
|
at := ri.ShouldRenewAt(time.Now(), 10*365*24*time.Hour)
|
||||||
|
if at == nil {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
t := at.UTC().Truncate(time.Second)
|
||||||
|
if limit := twoThirds(leaf.NotBefore, leaf.NotAfter); t.After(limit) {
|
||||||
|
t = limit
|
||||||
|
}
|
||||||
|
return &t, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func twoThirds(nb, na time.Time) time.Time {
|
||||||
|
return nb.Add(na.Sub(nb) * 2 / 3).UTC().Truncate(time.Second)
|
||||||
|
}
|
||||||
|
|
||||||
|
// cleanLegoError shortens lego's errors, which wrap each name's problem in
|
||||||
|
// several prefixes and the whole ACME problem document:
|
||||||
|
//
|
||||||
|
// error: one or more domains had a problem:
|
||||||
|
// [a.example.com] [a.example.com] acme: error presenting token: MSG
|
||||||
|
// [b.example.com] acme: error: 403 :: urn:ietf:params:acme:error:unauthorized :: MSG
|
||||||
|
//
|
||||||
|
// becomes "a.example.com: MSG; b.example.com: the CA refused (unauthorized): MSG".
|
||||||
|
func cleanLegoError(err error) error {
|
||||||
|
msg := strings.TrimSpace(strings.Replace(err.Error(), "error: one or more domains had a problem:", "", 1))
|
||||||
|
var out []string
|
||||||
|
for _, line := range strings.Split(msg, "\n") {
|
||||||
|
line = strings.TrimSpace(line)
|
||||||
|
if line == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
domain := ""
|
||||||
|
for strings.HasPrefix(line, "[") {
|
||||||
|
end := strings.Index(line, "] ")
|
||||||
|
if end < 0 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if domain == "" {
|
||||||
|
domain = line[1:end]
|
||||||
|
}
|
||||||
|
line = line[end+2:]
|
||||||
|
}
|
||||||
|
for _, p := range []string{"acme: error presenting token: ", "acme: error: ", "acme: "} {
|
||||||
|
line = strings.TrimPrefix(line, p)
|
||||||
|
}
|
||||||
|
if m := acmeProblemRe.FindStringSubmatch(line); m != nil {
|
||||||
|
line = "the CA refused (" + m[2] + "): " + m[3]
|
||||||
|
}
|
||||||
|
if domain != "" {
|
||||||
|
line = domain + ": " + line
|
||||||
|
}
|
||||||
|
out = append(out, line)
|
||||||
|
}
|
||||||
|
if len(out) == 0 {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return errors.New(strings.Join(out, "; "))
|
||||||
|
}
|
||||||
|
|
||||||
|
// acmeProblemRe matches "403 :: urn:ietf:params:acme:error:unauthorized :: detail".
|
||||||
|
var acmeProblemRe = regexp.MustCompile(`^(\d+) :: urn:ietf:params:acme:error:(\w+) :: (.*)$`)
|
||||||
@@ -0,0 +1,522 @@
|
|||||||
|
package certs
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/ecdsa"
|
||||||
|
"crypto/elliptic"
|
||||||
|
"crypto/rand"
|
||||||
|
"crypto/x509"
|
||||||
|
"crypto/x509/pkix"
|
||||||
|
"encoding/pem"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"log/slog"
|
||||||
|
"math/big"
|
||||||
|
"net"
|
||||||
|
"net/http/httptest"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/go-acme/lego/v4/challenge/dns01"
|
||||||
|
"github.com/miekg/dns"
|
||||||
|
|
||||||
|
"jarl/internal/auth"
|
||||||
|
"jarl/internal/encdns"
|
||||||
|
"jarl/internal/engine"
|
||||||
|
"jarl/internal/model"
|
||||||
|
"jarl/internal/porkbun"
|
||||||
|
"jarl/internal/render"
|
||||||
|
"jarl/internal/store"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fakeDNS answers like the internet would: zones with their public name
|
||||||
|
// servers, CNAME records, and TXT records (Porkbun's, from the fake API).
|
||||||
|
type fakeDNS struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
zones map[string][]string // zone -> NS
|
||||||
|
cnames map[string]string
|
||||||
|
txt func(name string) []string
|
||||||
|
addr string
|
||||||
|
}
|
||||||
|
|
||||||
|
func newFakeDNS(t *testing.T) *fakeDNS {
|
||||||
|
f := &fakeDNS{zones: map[string][]string{}, cnames: map[string]string{}, txt: func(string) []string { return nil }}
|
||||||
|
pc, err := net.ListenPacket("udp", "127.0.0.1:0")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
srv := &dns.Server{PacketConn: pc, Handler: f}
|
||||||
|
go srv.ActivateAndServe()
|
||||||
|
t.Cleanup(func() { srv.Shutdown() })
|
||||||
|
f.addr = pc.LocalAddr().String()
|
||||||
|
return f
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *fakeDNS) ServeDNS(w dns.ResponseWriter, r *dns.Msg) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
m := new(dns.Msg)
|
||||||
|
m.SetReply(r)
|
||||||
|
q := r.Question[0]
|
||||||
|
name := strings.ToLower(q.Name)
|
||||||
|
zone := ""
|
||||||
|
for z := range f.zones {
|
||||||
|
if dns.IsSubDomain(z, name) && len(z) > len(zone) {
|
||||||
|
zone = z
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if zone == "" {
|
||||||
|
m.Rcode = dns.RcodeNameError
|
||||||
|
w.WriteMsg(m)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
soa := &dns.SOA{Hdr: dns.RR_Header{Name: zone, Rrtype: dns.TypeSOA, Class: dns.ClassINET, Ttl: 60}, Ns: f.zones[zone][0], Mbox: "h." + zone, Serial: 1, Refresh: 1, Retry: 1, Expire: 1, Minttl: 60}
|
||||||
|
switch {
|
||||||
|
case q.Qtype == dns.TypeSOA && name == zone:
|
||||||
|
m.Answer = append(m.Answer, soa)
|
||||||
|
case q.Qtype == dns.TypeNS && name == zone:
|
||||||
|
for _, ns := range f.zones[zone] {
|
||||||
|
m.Answer = append(m.Answer, &dns.NS{Hdr: dns.RR_Header{Name: zone, Rrtype: dns.TypeNS, Class: dns.ClassINET, Ttl: 60}, Ns: ns})
|
||||||
|
}
|
||||||
|
case f.cnames[name] != "":
|
||||||
|
m.Answer = append(m.Answer, &dns.CNAME{Hdr: dns.RR_Header{Name: name, Rrtype: dns.TypeCNAME, Class: dns.ClassINET, Ttl: 60}, Target: f.cnames[name]})
|
||||||
|
case q.Qtype == dns.TypeTXT && len(f.txt(name)) > 0:
|
||||||
|
for _, v := range f.txt(name) {
|
||||||
|
m.Answer = append(m.Answer, &dns.TXT{Hdr: dns.RR_Header{Name: name, Rrtype: dns.TypeTXT, Class: dns.ClassINET, Ttl: 60}, Txt: []string{v}})
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
m.Ns = append(m.Ns, soa)
|
||||||
|
}
|
||||||
|
w.WriteMsg(m)
|
||||||
|
}
|
||||||
|
|
||||||
|
type env struct {
|
||||||
|
t *testing.T
|
||||||
|
m *Manager
|
||||||
|
st *store.Store
|
||||||
|
eng *engine.Engine
|
||||||
|
dns *fakeDNS
|
||||||
|
pb *porkbun.Fake
|
||||||
|
dir string
|
||||||
|
}
|
||||||
|
|
||||||
|
// newEnv sets up Jarl with zone example.com (name server
|
||||||
|
// ns1.example.com, which the internet also uses), a fake internet and a
|
||||||
|
// fake Porkbun account with pb.test.
|
||||||
|
func newEnv(t *testing.T, withPorkbun bool) *env {
|
||||||
|
dir := t.TempDir()
|
||||||
|
st, err := store.Open(filepath.Join(dir, "jarl.db"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
t.Cleanup(func() { st.Close() })
|
||||||
|
quiet := slog.New(slog.NewTextHandler(io.Discard, nil))
|
||||||
|
eng := engine.New(st, nil, engine.Config{
|
||||||
|
Paths: render.Paths{ConfigDir: filepath.Join(dir, "etc"), ZoneDir: filepath.Join(dir, "zones"), CacheDir: filepath.Join(dir, "cache")},
|
||||||
|
StagingDir: filepath.Join(dir, "staging"), NoReload: true, SkipCheck: true,
|
||||||
|
}, quiet)
|
||||||
|
e := &env{t: t, st: st, eng: eng, dns: newFakeDNS(t), dir: dir}
|
||||||
|
e.submit(engine.NewRequest(engine.OpSettingsUpdate, 0, engine.SettingsInput{Nameservers: &[]string{"ns1.example.net."}}),
|
||||||
|
engine.NewRequest(engine.OpZoneCreate, 0, engine.ZoneInput{Name: model.Ptr("example.com")}))
|
||||||
|
e.dns.mu.Lock()
|
||||||
|
e.dns.zones["example.com."] = []string{"ns1.example.net."}
|
||||||
|
e.dns.zones["pb.test."] = []string{"curitiba.ns.porkbun.com.", "fortaleza.ns.porkbun.com."}
|
||||||
|
e.dns.zones["other.test."] = []string{"a.ns.cloudflare.com."}
|
||||||
|
e.dns.mu.Unlock()
|
||||||
|
cfg := Config{Resolvers: []string{e.dns.addr}, Dir: filepath.Join(dir, "tls"), Directory: "https://acme.invalid/dir"}
|
||||||
|
if withPorkbun {
|
||||||
|
e.pb = porkbun.NewFake("pk1_test", "sk1_test", "pb.test")
|
||||||
|
ts := httptest.NewServer(e.pb)
|
||||||
|
t.Cleanup(ts.Close)
|
||||||
|
cfg.Porkbun = &porkbun.Client{BaseURL: ts.URL + "/api/json/v3", APIKey: "pk1_test", Secret: "sk1_test"}
|
||||||
|
e.dns.mu.Lock()
|
||||||
|
e.dns.txt = func(name string) []string { return e.pb.TXT(name) }
|
||||||
|
e.dns.mu.Unlock()
|
||||||
|
}
|
||||||
|
e.m = New(cfg, st, eng, quiet)
|
||||||
|
// lego's own lookups (CNAME following) use the fake internet too.
|
||||||
|
dns01.AddRecursiveNameservers([]string{e.dns.addr})(nil)
|
||||||
|
return e
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *env) submit(reqs ...engine.Request) {
|
||||||
|
e.t.Helper()
|
||||||
|
if _, err := e.eng.Submit(context.Background(), reqs, auth.System, "test", "", engine.ApplyOptions{}); err != nil {
|
||||||
|
e.t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *env) state() *model.State {
|
||||||
|
st, err := e.st.LoadState(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
e.t.Fatal(err)
|
||||||
|
}
|
||||||
|
return st
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRoute(t *testing.T) {
|
||||||
|
e := newEnv(t, true)
|
||||||
|
ctx := context.Background()
|
||||||
|
e.dns.mu.Lock()
|
||||||
|
e.dns.cnames["_acme-challenge.www.other.test."] = "www-other.acme.example.com."
|
||||||
|
e.dns.mu.Unlock()
|
||||||
|
cases := []struct {
|
||||||
|
challenge, domain string
|
||||||
|
route string // "" for an error
|
||||||
|
target string
|
||||||
|
errHas string
|
||||||
|
}{
|
||||||
|
{"auto", "www.example.com", "jarl", "_acme-challenge.www.example.com.", ""},
|
||||||
|
{"auto", "*.example.com", "jarl", "_acme-challenge.example.com.", ""},
|
||||||
|
{"auto", "ns1.pb.test", "porkbun", "_acme-challenge.ns1.pb.test.", ""},
|
||||||
|
{"auto", "www.other.test", "jarl", "www-other.acme.example.com.", ""},
|
||||||
|
{"auto", "mail.other.test", "", "", "Point _acme-challenge.mail.other.test with a CNAME"},
|
||||||
|
{"porkbun", "www.example.com", "", "", "not Porkbun"},
|
||||||
|
{"jarl", "ns1.pb.test", "", "", "no primary zone in Jarl is pb.test"},
|
||||||
|
{"jarl", "www.example.com", "jarl", "_acme-challenge.www.example.com.", ""},
|
||||||
|
}
|
||||||
|
for _, c := range cases {
|
||||||
|
r := e.m.route(ctx, e.state(), c.challenge, c.domain, "")
|
||||||
|
if r.Route != c.route || c.target != "" && r.Target != c.target || c.errHas != "" && !strings.Contains(r.Error, c.errHas) {
|
||||||
|
t.Errorf("%s %s: route %q target %q error %q", c.challenge, c.domain, r.Route, r.Target, r.Error)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The move from Porkbun to Jarl: while the internet still asks
|
||||||
|
// Porkbun, auto goes there even though Jarl has the zone; once the
|
||||||
|
// name servers change, it comes to Jarl.
|
||||||
|
e.submit(engine.NewRequest(engine.OpZoneCreate, 0, engine.ZoneInput{Name: model.Ptr("pb.test")}))
|
||||||
|
if r := e.m.route(ctx, e.state(), "auto", "ns1.pb.test", ""); r.Route != "porkbun" {
|
||||||
|
t.Errorf("before the move: %+v", r)
|
||||||
|
}
|
||||||
|
if r := e.m.route(ctx, e.state(), "jarl", "ns1.pb.test", ""); !strings.Contains(r.Error, "not by the name servers in Jarl's zone (ns1.example.net)") {
|
||||||
|
t.Errorf("jarl before the move: %+v", r)
|
||||||
|
}
|
||||||
|
e.dns.mu.Lock()
|
||||||
|
e.dns.zones["pb.test."] = []string{"ns1.example.net."}
|
||||||
|
e.dns.mu.Unlock()
|
||||||
|
if r := e.m.route(ctx, e.state(), "auto", "ns1.pb.test", ""); r.Route != "jarl" {
|
||||||
|
t.Errorf("after the move: %+v", r)
|
||||||
|
}
|
||||||
|
if r := e.m.route(ctx, e.state(), "porkbun", "ns1.pb.test", ""); !strings.Contains(r.Error, "not Porkbun") {
|
||||||
|
t.Errorf("porkbun after the move: %+v", r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Without a Porkbun key, a Porkbun domain says what is missing.
|
||||||
|
e2 := newEnv(t, false)
|
||||||
|
if r := e2.m.route(ctx, e2.state(), "auto", "ns1.pb.test", ""); !strings.Contains(r.Error, "no porkbun.api_key") {
|
||||||
|
t.Errorf("without a key: %+v", r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProvider(t *testing.T) {
|
||||||
|
e := newEnv(t, true)
|
||||||
|
ctx := context.Background()
|
||||||
|
c := &model.Certificate{Name: "t", Challenge: "auto"}
|
||||||
|
p := &provider{m: e.m, ctx: ctx, cert: c, cleanups: map[string]func() error{}}
|
||||||
|
|
||||||
|
// Porkbun: the record goes in through the API and is removed again.
|
||||||
|
info := dns01.GetChallengeInfo("ns1.pb.test", "key-auth-1")
|
||||||
|
if err := p.Present("ns1.pb.test", "tok", "key-auth-1"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got := e.pb.TXT("_acme-challenge.ns1.pb.test"); len(got) != 1 || got[0] != info.Value {
|
||||||
|
t.Fatalf("Porkbun TXT = %v, want %s", got, info.Value)
|
||||||
|
}
|
||||||
|
if err := p.CleanUp("ns1.pb.test", "tok", "key-auth-1"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got := e.pb.TXT("_acme-challenge.ns1.pb.test"); len(got) != 0 {
|
||||||
|
t.Fatalf("Porkbun TXT after cleanup = %v", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Jarl: the record goes into the zone, in a changeset by the system.
|
||||||
|
txt := func() []string {
|
||||||
|
var out []string
|
||||||
|
st := e.state()
|
||||||
|
for _, r := range st.Records {
|
||||||
|
if r.Type == "TXT" && r.Name == "_acme-challenge.www.example.com." {
|
||||||
|
out = append(out, r.Data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
info = dns01.GetChallengeInfo("www.example.com", "key-auth-2")
|
||||||
|
if err := p.Present("www.example.com", "tok", "key-auth-2"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got := txt(); len(got) != 1 || !strings.Contains(got[0], info.Value) {
|
||||||
|
t.Fatalf("Jarl TXT = %v, want %s", got, info.Value)
|
||||||
|
}
|
||||||
|
if err := p.CleanUp("www.example.com", "tok", "key-auth-2"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got := txt(); len(got) != 0 {
|
||||||
|
t.Fatalf("Jarl TXT after cleanup = %v", got)
|
||||||
|
}
|
||||||
|
if len(p.routes) != 2 || p.routes[0].Route != "porkbun" || p.routes[1].Route != "jarl" {
|
||||||
|
t.Errorf("routes = %+v", p.routes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A name nobody can answer for fails before anything is published.
|
||||||
|
if err := p.Present("mail.other.test", "tok", "k"); err == nil || !strings.Contains(err.Error(), "CNAME") {
|
||||||
|
t.Errorf("other.test: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// makeCert returns a certificate for names (signed by a CA unless
|
||||||
|
// selfSigned) and its key, as PEM; withCA appends the CA certificate.
|
||||||
|
func makeCert(t *testing.T, names []string, notBefore, notAfter time.Time, withCA bool) (certPEM, keyPEM []byte) {
|
||||||
|
t.Helper()
|
||||||
|
caKey, _ := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
|
||||||
|
ca := &x509.Certificate{SerialNumber: big.NewInt(1), Subject: pkix.Name{CommonName: "Test CA", Organization: []string{"Jarl"}},
|
||||||
|
NotBefore: notBefore, NotAfter: notAfter.Add(time.Hour), IsCA: true, BasicConstraintsValid: true, KeyUsage: x509.KeyUsageCertSign}
|
||||||
|
caDER, _ := x509.CreateCertificate(rand.Reader, ca, ca, &caKey.PublicKey, caKey)
|
||||||
|
caCert, _ := x509.ParseCertificate(caDER)
|
||||||
|
key, _ := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
|
||||||
|
leaf := &x509.Certificate{SerialNumber: big.NewInt(time.Now().UnixNano()), Subject: pkix.Name{CommonName: names[0]}, DNSNames: names,
|
||||||
|
NotBefore: notBefore, NotAfter: notAfter, ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth}}
|
||||||
|
der, err := x509.CreateCertificate(rand.Reader, leaf, caCert, &key.PublicKey, caKey)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
certPEM = pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: der})
|
||||||
|
if withCA {
|
||||||
|
certPEM = append(certPEM, pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: caDER})...)
|
||||||
|
}
|
||||||
|
kd, _ := x509.MarshalPKCS8PrivateKey(key)
|
||||||
|
return certPEM, pem.EncodeToMemory(&pem.Block{Type: "PRIVATE KEY", Bytes: kd})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInspect(t *testing.T) {
|
||||||
|
now := time.Now()
|
||||||
|
cert, key := makeCert(t, []string{"ns1.example.com", "*.example.com"}, now, now.Add(90*24*time.Hour), true)
|
||||||
|
in, pair, err := Inspect(cert, key)
|
||||||
|
if err != nil || pair == nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if strings.Join(in.Names, " ") != "ns1.example.com *.example.com" || in.Issuer != "Jarl Test CA" || in.KeyType != "ec256" || len(in.Warnings) != 0 {
|
||||||
|
t.Errorf("info = %+v", in)
|
||||||
|
}
|
||||||
|
leafOnly, _ := makeCert(t, []string{"a.example.com"}, now, now.Add(time.Hour), false)
|
||||||
|
_, otherKey := makeCert(t, []string{"b.example.com"}, now, now.Add(time.Hour), false)
|
||||||
|
if _, _, err := Inspect(cert, otherKey); err == nil || !strings.Contains(err.Error(), "doesn't belong") {
|
||||||
|
t.Errorf("mismatched key: %v", err)
|
||||||
|
}
|
||||||
|
leafCert, leafKey := makeCert(t, []string{"a.example.com"}, now, now.Add(time.Hour), false)
|
||||||
|
if in, _, err := Inspect(leafCert, leafKey); err != nil || len(in.Warnings) != 1 || !strings.Contains(in.Warnings[0], "full chain") {
|
||||||
|
t.Errorf("leaf only: %+v %v", in, err)
|
||||||
|
}
|
||||||
|
_ = leafOnly
|
||||||
|
if !Covers([]string{"*.example.com"}, []string{"www.example.com"}) || Covers([]string{"*.example.com"}, []string{"a.b.example.com"}) || Covers([]string{"example.com"}, []string{"www.example.com"}) {
|
||||||
|
t.Error("Covers")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDueAndStatus(t *testing.T) {
|
||||||
|
m := &Manager{now: time.Now}
|
||||||
|
now := time.Now().UTC().Truncate(time.Second)
|
||||||
|
nb, na := now.Add(-80*24*time.Hour), now.Add(10*24*time.Hour)
|
||||||
|
c := &model.Certificate{Source: model.CertSourceACME, CreatedAt: now.Add(-time.Hour)}
|
||||||
|
if got := m.Due(c); !got.Equal(c.CreatedAt) {
|
||||||
|
t.Errorf("never obtained: due %v", got)
|
||||||
|
}
|
||||||
|
if s := m.StatusOf(c); s.State != "pending" {
|
||||||
|
t.Errorf("pending: %+v", s)
|
||||||
|
}
|
||||||
|
c.CertPEM, c.NotBefore, c.NotAfter = "x", &nb, &na
|
||||||
|
if got, want := m.Due(c), twoThirds(nb, na); !got.Equal(want) {
|
||||||
|
t.Errorf("due %v, want two thirds %v", got, want)
|
||||||
|
}
|
||||||
|
ari := now.Add(time.Hour)
|
||||||
|
c.RenewAt = &ari
|
||||||
|
if got := m.Due(c); !got.Equal(ari) {
|
||||||
|
t.Errorf("due %v, want the CA's %v", got, ari)
|
||||||
|
}
|
||||||
|
// 10 days left of 90 is less than a sixth: expiring.
|
||||||
|
if s := m.StatusOf(c); s.State != "expiring" {
|
||||||
|
t.Errorf("status %+v", s)
|
||||||
|
}
|
||||||
|
// After three failures it waits four hours from the last attempt.
|
||||||
|
last := now.Add(-time.Hour)
|
||||||
|
c.Failures, c.LastAttempt, c.LastError = 3, &last, "boom"
|
||||||
|
if got := m.Due(c); !got.Equal(last.Add(4 * time.Hour)) {
|
||||||
|
t.Errorf("backoff: due %v", got)
|
||||||
|
}
|
||||||
|
if s := m.StatusOf(c); s.State != "failing" || !strings.Contains(s.Message, "boom") {
|
||||||
|
t.Errorf("failing: %+v", s)
|
||||||
|
}
|
||||||
|
c.Failures = 30
|
||||||
|
if got := m.Due(c); !got.Equal(last.Add(24 * time.Hour)) {
|
||||||
|
t.Errorf("backoff is at most a day: due %v", got)
|
||||||
|
}
|
||||||
|
old := now.Add(-time.Hour)
|
||||||
|
c.NotAfter = &old
|
||||||
|
if s := m.StatusOf(c); s.State != "expired" {
|
||||||
|
t.Errorf("expired: %+v", s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInput(t *testing.T) {
|
||||||
|
e := newEnv(t, false)
|
||||||
|
ctx := context.Background()
|
||||||
|
admin := &auth.Principal{User: &model.User{Username: "admin", Admin: true}}
|
||||||
|
bad := []Input{
|
||||||
|
{Name: model.Ptr("Bad Name"), Domains: &[]string{"a.example.com"}},
|
||||||
|
{Name: model.Ptr("x"), Domains: &[]string{"localhost"}},
|
||||||
|
{Name: model.Ptr("x"), Domains: &[]string{"a.*.example.com"}},
|
||||||
|
{Name: model.Ptr("x"), Domains: &[]string{}},
|
||||||
|
{Name: model.Ptr("x"), Domains: &[]string{"a.example.com"}, Uses: &[]string{"mail"}},
|
||||||
|
{Name: model.Ptr("x"), Domains: &[]string{"a.example.com"}, Challenge: model.Ptr("http")},
|
||||||
|
{Name: model.Ptr("x"), Domains: &[]string{"a.example.com"}, KeyType: model.Ptr("rsa1024")},
|
||||||
|
{Name: model.Ptr("x"), Source: model.Ptr("file"), CertFile: model.Ptr("rel.pem"), KeyFile: model.Ptr("/k.pem")},
|
||||||
|
{Name: model.Ptr("x"), Domains: &[]string{"a.example.com"}, CertFile: model.Ptr("/c.pem")},
|
||||||
|
}
|
||||||
|
for _, in := range bad {
|
||||||
|
if _, err := e.m.Create(ctx, in, admin); err == nil {
|
||||||
|
t.Errorf("accepted %+v", in)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
c, err := e.m.Create(ctx, Input{Name: model.Ptr("web"), Domains: &[]string{"WWW.Example.com.", "www.example.com", "*.example.com"}, Uses: &[]string{"web", "dns", "web"}}, admin)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if strings.Join(c.Domains, " ") != "www.example.com *.example.com" || strings.Join(c.Uses, ",") != "dns,web" || c.Challenge != "auto" || c.KeyType != "ec256" {
|
||||||
|
t.Errorf("normalized: %+v", c)
|
||||||
|
}
|
||||||
|
// Only one certificate serves jarld's HTTPS.
|
||||||
|
if _, err := e.m.Create(ctx, Input{Name: model.Ptr("web2"), Domains: &[]string{"a.example.com"}, Uses: &[]string{"web"}}, admin); err == nil || !strings.Contains(err.Error(), "already used for jarld's HTTPS") {
|
||||||
|
t.Errorf("second web certificate: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := e.m.Create(ctx, Input{Name: model.Ptr("web"), Domains: &[]string{"a.example.com"}}, admin); err != ErrConflict {
|
||||||
|
t.Errorf("duplicate name: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := e.m.Update(ctx, "web", Input{Name: model.Ptr("renamed")}, admin); err == nil {
|
||||||
|
t.Error("rename accepted")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFileSource(t *testing.T) {
|
||||||
|
e := newEnv(t, false)
|
||||||
|
ctx := context.Background()
|
||||||
|
admin := &auth.Principal{User: &model.User{Username: "admin", Admin: true}}
|
||||||
|
now := time.Now()
|
||||||
|
certFile, keyFile := filepath.Join(e.dir, "fullchain.pem"), filepath.Join(e.dir, "privkey.pem")
|
||||||
|
cert, key := makeCert(t, []string{"ns1.example.com"}, now.Add(-time.Hour), now.Add(60*24*time.Hour), true)
|
||||||
|
os.WriteFile(certFile, cert, 0o600)
|
||||||
|
os.WriteFile(keyFile, key, 0o600)
|
||||||
|
|
||||||
|
c, err := e.m.Create(ctx, Input{Name: model.Ptr("own"), Source: model.Ptr("file"), CertFile: &certFile, KeyFile: &keyFile, Uses: &[]string{"web", "dns"}}, admin)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
c, _ = e.m.Get(ctx, "own")
|
||||||
|
if strings.Join(c.Domains, " ") != "ns1.example.com" || c.NotAfter == nil || c.CertPEM != "" {
|
||||||
|
t.Errorf("read: %+v", c)
|
||||||
|
}
|
||||||
|
if e.m.WebCertificate() == nil || e.m.WebName() != "own" {
|
||||||
|
t.Error("not served for HTTPS")
|
||||||
|
}
|
||||||
|
chain := filepath.Join(e.m.FilesDir("own"), ChainFile)
|
||||||
|
if b, err := os.ReadFile(chain); err != nil || string(b) != string(cert) {
|
||||||
|
t.Fatalf("files for named: %v", err)
|
||||||
|
}
|
||||||
|
if fi, err := os.Stat(filepath.Join(e.m.FilesDir("own"), KeyFile)); err != nil || fi.Mode().Perm() != 0o640 {
|
||||||
|
t.Errorf("key file: %v %v", fi, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Renewed by its owner: the loop notices and puts the new one in place.
|
||||||
|
cert2, key2 := makeCert(t, []string{"ns1.example.com", "dns.example.com"}, now, now.Add(90*24*time.Hour), true)
|
||||||
|
os.WriteFile(certFile, cert2, 0o600)
|
||||||
|
os.WriteFile(keyFile, key2, 0o600)
|
||||||
|
future := now.Add(time.Minute)
|
||||||
|
os.Chtimes(certFile, future, future)
|
||||||
|
e.m.Tick(ctx)
|
||||||
|
c, _ = e.m.Get(ctx, "own")
|
||||||
|
if strings.Join(c.Domains, " ") != "ns1.example.com dns.example.com" {
|
||||||
|
t.Errorf("not reread: %v", c.Domains)
|
||||||
|
}
|
||||||
|
if b, _ := os.ReadFile(chain); string(b) != string(cert2) {
|
||||||
|
t.Error("files for named not updated")
|
||||||
|
}
|
||||||
|
if got := e.m.WebCertificate(); got == nil || len(got.Leaf.DNSNames) != 2 {
|
||||||
|
t.Error("HTTPS still serves the old certificate")
|
||||||
|
}
|
||||||
|
|
||||||
|
// A broken renewal keeps the last good certificate in place.
|
||||||
|
os.WriteFile(keyFile, key, 0o600)
|
||||||
|
os.Chtimes(keyFile, future.Add(time.Minute), future.Add(time.Minute))
|
||||||
|
e.m.Tick(ctx)
|
||||||
|
c, _ = e.m.Get(ctx, "own")
|
||||||
|
if !strings.Contains(c.LastError, "doesn't belong") || e.m.StatusOf(c).State != "failing" {
|
||||||
|
t.Errorf("mismatch not reported: %+v", c)
|
||||||
|
}
|
||||||
|
if b, _ := os.ReadFile(chain); string(b) != string(cert2) {
|
||||||
|
t.Error("files for named replaced by a broken pair")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Without the dns use the files go; deleting stops HTTPS.
|
||||||
|
if _, err := e.m.Update(ctx, "own", Input{Uses: &[]string{"web"}}, admin); err != nil {
|
||||||
|
// The pair is broken now; put the good key back first.
|
||||||
|
t.Log(err)
|
||||||
|
}
|
||||||
|
os.WriteFile(keyFile, key2, 0o600)
|
||||||
|
if _, err := e.m.Update(ctx, "own", Input{Uses: &[]string{"web"}}, admin); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(e.m.FilesDir("own")); !os.IsNotExist(err) {
|
||||||
|
t.Errorf("files for named left behind: %v", err)
|
||||||
|
}
|
||||||
|
if err := e.m.Delete(ctx, "own", admin); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if e.m.WebCertificate() != nil {
|
||||||
|
t.Error("still serving a deleted certificate")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCleanLegoError(t *testing.T) {
|
||||||
|
in := errors.New("error: one or more domains had a problem:\n[www.example.org] [www.example.org] acme: error presenting token: example.org is served by x, which Jarl can't write to\n[a.example.com] acme: error: 403 :: urn:ietf:params:acme:error:unauthorized :: Incorrect TXT record \"abc\" found at _acme-challenge.a.example.com\n")
|
||||||
|
want := `www.example.org: example.org is served by x, which Jarl can't write to; a.example.com: the CA refused (unauthorized): Incorrect TXT record "abc" found at _acme-challenge.a.example.com`
|
||||||
|
if got := cleanLegoError(in).Error(); got != want {
|
||||||
|
t.Errorf("got %s\nwant %s", got, want)
|
||||||
|
}
|
||||||
|
if got := cleanLegoError(errors.New("acme: error: 429 :: urn:ietf:params:acme:error:rateLimited :: too many")).Error(); got != "the CA refused (rateLimited): too many" {
|
||||||
|
t.Errorf("rate limit: %s", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// When certificates.dir changes, Start writes the certificates to the new
|
||||||
|
// place and points encrypted DNS's tls statement there.
|
||||||
|
func TestDirChangeFollowed(t *testing.T) {
|
||||||
|
e := newEnv(t, false)
|
||||||
|
ctx := context.Background()
|
||||||
|
admin := &auth.Principal{User: &model.User{Username: "admin", Admin: true}}
|
||||||
|
now := time.Now()
|
||||||
|
certFile, keyFile := filepath.Join(e.dir, "c.pem"), filepath.Join(e.dir, "k.pem")
|
||||||
|
cert, key := makeCert(t, []string{"dns.example.com"}, now.Add(-time.Hour), now.Add(60*24*time.Hour), true)
|
||||||
|
os.WriteFile(certFile, cert, 0o600)
|
||||||
|
os.WriteFile(keyFile, key, 0o600)
|
||||||
|
if _, err := e.m.Create(ctx, Input{Name: model.Ptr("dns"), Source: model.Ptr("file"), CertFile: &certFile, KeyFile: &keyFile, Uses: &[]string{"dns"}}, admin); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
e.submit(engine.NewRequest(engine.OpOptionCreate, 0, engine.OptionInput{Scope: model.Ptr(model.ScopeTopLevel), Name: model.Ptr("tls"), Value: model.Ptr(encdns.TLSValue("dns", e.m.cfg.Dir))}))
|
||||||
|
|
||||||
|
moved := filepath.Join(e.dir, "tls-moved")
|
||||||
|
cfg := e.m.cfg
|
||||||
|
cfg.Dir = moved
|
||||||
|
m2 := New(cfg, e.st, e.eng, slog.New(slog.NewTextHandler(io.Discard, nil)))
|
||||||
|
m2.Start(ctx)
|
||||||
|
if _, err := os.Stat(filepath.Join(moved, "dns", ChainFile)); err != nil {
|
||||||
|
t.Fatalf("not written to the new place: %v", err)
|
||||||
|
}
|
||||||
|
for _, o := range e.state().ScopedOptions(model.ScopeTopLevel, 0) {
|
||||||
|
if o.Name == "tls" && !strings.Contains(o.Value, moved+"/dns/fullchain.pem") {
|
||||||
|
t.Errorf("tls statement still points elsewhere: %s", o.Value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,118 @@
|
|||||||
|
// Package certs manages TLS certificates (docs/certificates.md): ones Jarl
|
||||||
|
// obtains and renews itself over ACME, answering the DNS-01 challenges in
|
||||||
|
// its own zones or at Porkbun, and ones you renew yourself that Jarl only
|
||||||
|
// reads. A certificate is used for jarld's HTTPS ("web") and/or written
|
||||||
|
// where named can read it ("dns", for DNS over TLS and HTTPS).
|
||||||
|
package certs
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/ecdsa"
|
||||||
|
"crypto/ed25519"
|
||||||
|
"crypto/rsa"
|
||||||
|
"crypto/tls"
|
||||||
|
"crypto/x509"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Info is what a certificate says about itself.
|
||||||
|
type Info struct {
|
||||||
|
Names []string
|
||||||
|
NotBefore time.Time
|
||||||
|
NotAfter time.Time
|
||||||
|
Issuer string
|
||||||
|
Serial string
|
||||||
|
KeyType string // ec256, ec384, rsa2048, ...
|
||||||
|
Leaf *x509.Certificate
|
||||||
|
// Warnings are problems that don't stop it working everywhere (a
|
||||||
|
// missing intermediate certificate).
|
||||||
|
Warnings []string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Inspect checks that certPEM (the certificate, then its intermediates)
|
||||||
|
// and keyPEM belong together and returns what the certificate says, and
|
||||||
|
// the pair ready to serve.
|
||||||
|
func Inspect(certPEM, keyPEM []byte) (*Info, *tls.Certificate, error) {
|
||||||
|
pair, err := tls.X509KeyPair(certPEM, keyPEM)
|
||||||
|
if err != nil {
|
||||||
|
msg := err.Error()
|
||||||
|
switch {
|
||||||
|
case strings.Contains(msg, "private key does not match public key"):
|
||||||
|
return nil, nil, errors.New("the key doesn't belong to the certificate")
|
||||||
|
case strings.Contains(msg, "failed to find any PEM data in certificate"):
|
||||||
|
return nil, nil, errors.New("no certificate found (expected PEM: -----BEGIN CERTIFICATE-----)")
|
||||||
|
case strings.Contains(msg, "failed to find any PEM data in key"), strings.Contains(msg, "failed to find PEM block with type ending in \"PRIVATE KEY\""):
|
||||||
|
return nil, nil, errors.New("no private key found (expected PEM: -----BEGIN ... PRIVATE KEY-----)")
|
||||||
|
}
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
leaf := pair.Leaf
|
||||||
|
if leaf == nil {
|
||||||
|
if leaf, err = x509.ParseCertificate(pair.Certificate[0]); err != nil {
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
pair.Leaf = leaf
|
||||||
|
}
|
||||||
|
in := &Info{NotBefore: leaf.NotBefore, NotAfter: leaf.NotAfter, Serial: fmt.Sprintf("%x", leaf.SerialNumber), Leaf: leaf, KeyType: keyType(leaf)}
|
||||||
|
in.Names = append(in.Names, leaf.DNSNames...)
|
||||||
|
for _, ip := range leaf.IPAddresses {
|
||||||
|
in.Names = append(in.Names, ip.String())
|
||||||
|
}
|
||||||
|
if len(in.Names) == 0 && leaf.Subject.CommonName != "" {
|
||||||
|
in.Names = []string{leaf.Subject.CommonName}
|
||||||
|
}
|
||||||
|
in.Issuer = leaf.Issuer.CommonName
|
||||||
|
if len(leaf.Issuer.Organization) > 0 {
|
||||||
|
if in.Issuer == "" {
|
||||||
|
in.Issuer = leaf.Issuer.Organization[0]
|
||||||
|
} else {
|
||||||
|
in.Issuer = leaf.Issuer.Organization[0] + " " + in.Issuer
|
||||||
|
}
|
||||||
|
}
|
||||||
|
selfSigned := leaf.Issuer.String() == leaf.Subject.String()
|
||||||
|
if len(pair.Certificate) == 1 && !selfSigned {
|
||||||
|
in.Warnings = append(in.Warnings, "the file holds only the certificate, without its intermediate certificate: many clients will reject it; use the full chain (fullchain.pem)")
|
||||||
|
}
|
||||||
|
return in, &pair, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func keyType(c *x509.Certificate) string {
|
||||||
|
switch k := c.PublicKey.(type) {
|
||||||
|
case *ecdsa.PublicKey:
|
||||||
|
return fmt.Sprintf("ec%d", k.Curve.Params().BitSize)
|
||||||
|
case *rsa.PublicKey:
|
||||||
|
return fmt.Sprintf("rsa%d", k.N.BitLen())
|
||||||
|
case ed25519.PublicKey:
|
||||||
|
return "ed25519"
|
||||||
|
}
|
||||||
|
return "unknown"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Covers reports whether the certificate names cover every name in want
|
||||||
|
// (a wildcard covers one label).
|
||||||
|
func Covers(names, want []string) bool {
|
||||||
|
for _, w := range want {
|
||||||
|
if !covered(names, w) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
func covered(names []string, want string) bool {
|
||||||
|
want = strings.ToLower(strings.TrimSuffix(want, "."))
|
||||||
|
for _, n := range names {
|
||||||
|
n = strings.ToLower(n)
|
||||||
|
if n == want {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if base, ok := strings.CutPrefix(n, "*."); ok && !strings.HasPrefix(want, "*.") {
|
||||||
|
if _, rest, ok := strings.Cut(want, "."); ok && rest == base {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
@@ -0,0 +1,128 @@
|
|||||||
|
package certs
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/miekg/dns"
|
||||||
|
)
|
||||||
|
|
||||||
|
// resolver asks recursive resolvers (acme.resolvers: public ones by
|
||||||
|
// default), to see a domain as the CA does rather than as this server's
|
||||||
|
// own views answer it.
|
||||||
|
type resolver struct {
|
||||||
|
servers []string
|
||||||
|
timeout time.Duration
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r resolver) query(ctx context.Context, name string, qtype uint16) (*dns.Msg, error) {
|
||||||
|
if len(r.servers) == 0 {
|
||||||
|
return nil, errors.New("no resolvers configured (acme.resolvers)")
|
||||||
|
}
|
||||||
|
m := new(dns.Msg)
|
||||||
|
m.SetQuestion(dns.Fqdn(name), qtype)
|
||||||
|
m.SetEdns0(1232, false)
|
||||||
|
m.RecursionDesired = true
|
||||||
|
timeout := r.timeout
|
||||||
|
if timeout == 0 {
|
||||||
|
timeout = 5 * time.Second
|
||||||
|
}
|
||||||
|
var errs []error
|
||||||
|
for _, s := range r.servers {
|
||||||
|
c := &dns.Client{Timeout: timeout}
|
||||||
|
in, _, err := c.ExchangeContext(ctx, m, s)
|
||||||
|
if err == nil && in.Truncated {
|
||||||
|
c.Net = "tcp"
|
||||||
|
in, _, err = c.ExchangeContext(ctx, m, s)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
errs = append(errs, fmt.Errorf("%s: %w", s, err))
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if in.Rcode == dns.RcodeServerFailure || in.Rcode == dns.RcodeRefused {
|
||||||
|
errs = append(errs, fmt.Errorf("%s answered %s", s, dns.RcodeToString[in.Rcode]))
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
return in, nil
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("looking up %s %s: %w", strings.TrimSuffix(name, "."), dns.TypeToString[qtype], errors.Join(errs...))
|
||||||
|
}
|
||||||
|
|
||||||
|
// zoneOf returns the zone that name is in on the internet (the owner of
|
||||||
|
// the SOA record that answers for it).
|
||||||
|
func (r resolver) zoneOf(ctx context.Context, name string) (string, error) {
|
||||||
|
name = dns.Fqdn(strings.ToLower(name))
|
||||||
|
for cand := name; ; {
|
||||||
|
in, err := r.query(ctx, cand, dns.TypeSOA)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
for _, sec := range [][]dns.RR{in.Answer, in.Ns} {
|
||||||
|
for _, rr := range sec {
|
||||||
|
if soa, ok := rr.(*dns.SOA); ok && dns.IsSubDomain(soa.Hdr.Name, name) {
|
||||||
|
return strings.ToLower(soa.Hdr.Name), nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
i, end := dns.NextLabel(cand, 0)
|
||||||
|
if end {
|
||||||
|
return "", fmt.Errorf("no zone found for %s", strings.TrimSuffix(name, "."))
|
||||||
|
}
|
||||||
|
cand = cand[i:]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// nameServers returns the zone's name servers on the internet (lowercase,
|
||||||
|
// without trailing dots, sorted).
|
||||||
|
func (r resolver) nameServers(ctx context.Context, zone string) ([]string, error) {
|
||||||
|
in, err := r.query(ctx, zone, dns.TypeNS)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
var out []string
|
||||||
|
for _, rr := range in.Answer {
|
||||||
|
if ns, ok := rr.(*dns.NS); ok && strings.EqualFold(ns.Hdr.Name, dns.Fqdn(zone)) {
|
||||||
|
out = append(out, normName(ns.Ns))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(out) == 0 {
|
||||||
|
return nil, fmt.Errorf("%s has no name servers on the internet (%s)", strings.TrimSuffix(zone, "."), dns.RcodeToString[in.Rcode])
|
||||||
|
}
|
||||||
|
slices.Sort(out)
|
||||||
|
return slices.Compact(out), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// follow returns where name leads after its CNAME records (name itself
|
||||||
|
// when it has none).
|
||||||
|
func (r resolver) follow(ctx context.Context, name string) (string, error) {
|
||||||
|
name = dns.Fqdn(strings.ToLower(name))
|
||||||
|
for range 10 {
|
||||||
|
in, err := r.query(ctx, name, dns.TypeCNAME)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
next := ""
|
||||||
|
for _, rr := range in.Answer {
|
||||||
|
if c, ok := rr.(*dns.CNAME); ok && strings.EqualFold(c.Hdr.Name, name) {
|
||||||
|
next = strings.ToLower(c.Target)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if next == "" {
|
||||||
|
return name, nil
|
||||||
|
}
|
||||||
|
name = next
|
||||||
|
}
|
||||||
|
return "", fmt.Errorf("%s: more than 10 CNAME records in a row", name)
|
||||||
|
}
|
||||||
|
|
||||||
|
func normName(n string) string { return strings.ToLower(strings.TrimSuffix(n, ".")) }
|
||||||
|
|
||||||
|
// challengeName is the DNS-01 record name for a certificate name (a
|
||||||
|
// wildcard shares its base name's).
|
||||||
|
func challengeName(domain string) string {
|
||||||
|
return "_acme-challenge." + dns.Fqdn(strings.TrimPrefix(strings.ToLower(domain), "*."))
|
||||||
|
}
|
||||||
@@ -0,0 +1,964 @@
|
|||||||
|
package certs
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"crypto/tls"
|
||||||
|
"crypto/x509"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io/fs"
|
||||||
|
"log"
|
||||||
|
"log/slog"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"regexp"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
legolog "github.com/go-acme/lego/v4/log"
|
||||||
|
|
||||||
|
"jarl/internal/auth"
|
||||||
|
"jarl/internal/encdns"
|
||||||
|
"jarl/internal/engine"
|
||||||
|
"jarl/internal/model"
|
||||||
|
"jarl/internal/porkbun"
|
||||||
|
"jarl/internal/store"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Config configures the manager (acme and certificates in jarl.yaml).
|
||||||
|
type Config struct {
|
||||||
|
Directory string // ACME directory URL
|
||||||
|
Email string
|
||||||
|
AgreeTOS bool
|
||||||
|
EABKeyID string
|
||||||
|
EABHMAC string
|
||||||
|
Resolvers []string
|
||||||
|
CABundle string
|
||||||
|
// Dir is where certificates with the dns use are written for named.
|
||||||
|
Dir string
|
||||||
|
Version string
|
||||||
|
// Porkbun publishes challenges for domains Porkbun serves (nil
|
||||||
|
// without an API key); PorkbunAllows limits it to porkbun.domains.
|
||||||
|
Porkbun *porkbun.Client
|
||||||
|
PorkbunAllows func(domain string) bool
|
||||||
|
// CheckPropagation makes lego wait until every name server of the
|
||||||
|
// zone serves the challenge before telling the CA (acme.check_propagation).
|
||||||
|
CheckPropagation bool
|
||||||
|
// PropagationTimeout is how long to wait for that (default 10 minutes).
|
||||||
|
PropagationTimeout time.Duration
|
||||||
|
// SkipPropagationCheck is !CheckPropagation (set by New).
|
||||||
|
SkipPropagationCheck bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// Manager keeps certificates current and serves jarld's own.
|
||||||
|
type Manager struct {
|
||||||
|
cfg Config
|
||||||
|
store *store.Store
|
||||||
|
eng *engine.Engine
|
||||||
|
log *slog.Logger
|
||||||
|
res resolver
|
||||||
|
|
||||||
|
// legoMu: lego keeps its DNS settings in package variables, so one
|
||||||
|
// client works at a time. issueMu: one issue at a time.
|
||||||
|
legoMu sync.Mutex
|
||||||
|
issueMu sync.Mutex
|
||||||
|
|
||||||
|
web atomic.Pointer[webCert]
|
||||||
|
mu sync.Mutex
|
||||||
|
files map[int64]fileStamp // file-source certificates: what was read last
|
||||||
|
kick chan struct{}
|
||||||
|
now func() time.Time
|
||||||
|
// issuing holds the names being obtained now, with when it started.
|
||||||
|
issuing sync.Map
|
||||||
|
// base is the context background issues run in (jarld's lifetime).
|
||||||
|
base context.Context
|
||||||
|
}
|
||||||
|
|
||||||
|
type webCert struct {
|
||||||
|
name string
|
||||||
|
pair *tls.Certificate
|
||||||
|
}
|
||||||
|
|
||||||
|
type fileStamp struct {
|
||||||
|
certMod, keyMod time.Time
|
||||||
|
certSize int64
|
||||||
|
}
|
||||||
|
|
||||||
|
// New returns a manager. Call Start before serving, then Run.
|
||||||
|
func New(cfg Config, st *store.Store, eng *engine.Engine, logger *slog.Logger) *Manager {
|
||||||
|
if logger == nil {
|
||||||
|
logger = slog.Default()
|
||||||
|
}
|
||||||
|
cfg.SkipPropagationCheck = !cfg.CheckPropagation
|
||||||
|
m := &Manager{cfg: cfg, store: st, eng: eng, log: logger, res: resolver{servers: cfg.Resolvers},
|
||||||
|
files: map[int64]fileStamp{}, kick: make(chan struct{}, 1), now: time.Now, base: context.Background()}
|
||||||
|
// lego logs every step; keep it at debug level.
|
||||||
|
legolog.Logger = log.New(slogWriter{logger}, "", 0)
|
||||||
|
return m
|
||||||
|
}
|
||||||
|
|
||||||
|
type slogWriter struct{ l *slog.Logger }
|
||||||
|
|
||||||
|
func (w slogWriter) Write(p []byte) (int, error) {
|
||||||
|
w.l.Debug("lego: " + strings.TrimSpace(string(p)))
|
||||||
|
return len(p), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Errors for the API.
|
||||||
|
var (
|
||||||
|
ErrNotFound = errors.New("no such certificate")
|
||||||
|
ErrConflict = errors.New("a certificate with that name exists")
|
||||||
|
)
|
||||||
|
|
||||||
|
// InputError is a request Jarl refuses.
|
||||||
|
type InputError struct{ Msg string }
|
||||||
|
|
||||||
|
func (e *InputError) Error() string { return e.Msg }
|
||||||
|
|
||||||
|
func inputErr(format string, a ...any) error { return &InputError{Msg: fmt.Sprintf(format, a...)} }
|
||||||
|
|
||||||
|
// Input creates or changes a certificate; nil fields are left alone.
|
||||||
|
type Input struct {
|
||||||
|
Name *string `json:"name"`
|
||||||
|
Source *string `json:"source"`
|
||||||
|
Domains *[]string `json:"domains"`
|
||||||
|
CertFile *string `json:"cert_file"`
|
||||||
|
KeyFile *string `json:"key_file"`
|
||||||
|
Uses *[]string `json:"uses"`
|
||||||
|
Challenge *string `json:"challenge"`
|
||||||
|
KeyType *string `json:"key_type"`
|
||||||
|
Comment *string `json:"comment"`
|
||||||
|
}
|
||||||
|
|
||||||
|
var nameRe = regexp.MustCompile(`^[a-z0-9][a-z0-9_-]{0,62}$`)
|
||||||
|
var labelRe = regexp.MustCompile(`^[a-z0-9_]([a-z0-9_-]{0,61}[a-z0-9_])?$`)
|
||||||
|
|
||||||
|
func normDomains(in []string) ([]string, error) {
|
||||||
|
var out []string
|
||||||
|
for _, d := range in {
|
||||||
|
d = strings.ToLower(strings.TrimSuffix(strings.TrimSpace(d), "."))
|
||||||
|
if d == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
labels := strings.Split(d, ".")
|
||||||
|
if len(labels) < 2 {
|
||||||
|
return nil, inputErr("%q isn't a domain name a CA will sign (it needs at least two labels)", d)
|
||||||
|
}
|
||||||
|
for i, l := range labels {
|
||||||
|
if l == "*" && i == 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !labelRe.MatchString(l) {
|
||||||
|
return nil, inputErr("%q isn't a valid domain name (a wildcard is only allowed as the first label: *.example.com)", d)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(d) > 253 {
|
||||||
|
return nil, inputErr("%q is too long", d)
|
||||||
|
}
|
||||||
|
if !slices.Contains(out, d) {
|
||||||
|
out = append(out, d)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(out) == 0 {
|
||||||
|
return nil, inputErr("give at least one domain name")
|
||||||
|
}
|
||||||
|
if len(out) > 100 {
|
||||||
|
return nil, inputErr("at most 100 names per certificate")
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *Manager) apply(c *model.Certificate, in Input, creating bool) error {
|
||||||
|
if in.Name != nil {
|
||||||
|
if !creating && *in.Name != c.Name {
|
||||||
|
return inputErr("a certificate can't be renamed (its files for named are named after it): create a new one and delete this one")
|
||||||
|
}
|
||||||
|
c.Name = *in.Name
|
||||||
|
}
|
||||||
|
if !nameRe.MatchString(c.Name) {
|
||||||
|
return inputErr("name %q: use lowercase letters, digits, - and _ (at most 63)", c.Name)
|
||||||
|
}
|
||||||
|
if in.Source != nil {
|
||||||
|
if !creating && *in.Source != c.Source {
|
||||||
|
return inputErr("a certificate's source can't change: create a new one")
|
||||||
|
}
|
||||||
|
c.Source = *in.Source
|
||||||
|
}
|
||||||
|
if c.Source == "" {
|
||||||
|
c.Source = model.CertSourceACME
|
||||||
|
}
|
||||||
|
if in.Uses != nil {
|
||||||
|
c.Uses = nil
|
||||||
|
for _, u := range *in.Uses {
|
||||||
|
u = strings.ToLower(strings.TrimSpace(u))
|
||||||
|
if u != model.CertUseWeb && u != model.CertUseDNS {
|
||||||
|
return inputErr("unknown use %q: web (jarld's HTTPS) or dns (for named: DNS over TLS and HTTPS)", u)
|
||||||
|
}
|
||||||
|
if !slices.Contains(c.Uses, u) {
|
||||||
|
c.Uses = append(c.Uses, u)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
slices.Sort(c.Uses)
|
||||||
|
}
|
||||||
|
if c.Uses == nil {
|
||||||
|
c.Uses = []string{}
|
||||||
|
}
|
||||||
|
if in.Comment != nil {
|
||||||
|
c.Comment = *in.Comment
|
||||||
|
}
|
||||||
|
switch c.Source {
|
||||||
|
case model.CertSourceACME:
|
||||||
|
if in.CertFile != nil && *in.CertFile != "" || in.KeyFile != nil && *in.KeyFile != "" {
|
||||||
|
return inputErr("cert_file and key_file are for --source file; Jarl keeps the files of certificates it obtains itself")
|
||||||
|
}
|
||||||
|
if in.Domains != nil {
|
||||||
|
d, err := normDomains(*in.Domains)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
c.Domains = d
|
||||||
|
}
|
||||||
|
if len(c.Domains) == 0 {
|
||||||
|
return inputErr("give the domain names the certificate is for")
|
||||||
|
}
|
||||||
|
if in.Challenge != nil {
|
||||||
|
c.Challenge = *in.Challenge
|
||||||
|
}
|
||||||
|
switch c.Challenge {
|
||||||
|
case "":
|
||||||
|
c.Challenge = model.ChallengeAuto
|
||||||
|
case model.ChallengeAuto, model.ChallengeJarl, model.ChallengePorkbun:
|
||||||
|
default:
|
||||||
|
return inputErr("challenge must be auto, jarl or porkbun")
|
||||||
|
}
|
||||||
|
if in.KeyType != nil {
|
||||||
|
c.KeyType = *in.KeyType
|
||||||
|
}
|
||||||
|
if c.KeyType == "" {
|
||||||
|
c.KeyType = "ec256"
|
||||||
|
}
|
||||||
|
if !slices.Contains(KeyTypes, c.KeyType) {
|
||||||
|
return inputErr("key type must be one of %s", strings.Join(KeyTypes, ", "))
|
||||||
|
}
|
||||||
|
case model.CertSourceFile:
|
||||||
|
if in.Challenge != nil && *in.Challenge != "" || in.KeyType != nil && *in.KeyType != "" {
|
||||||
|
return inputErr("challenge and key type are for certificates Jarl obtains (--source acme)")
|
||||||
|
}
|
||||||
|
if in.CertFile != nil {
|
||||||
|
c.CertFile = *in.CertFile
|
||||||
|
}
|
||||||
|
if in.KeyFile != nil {
|
||||||
|
c.KeyFile = *in.KeyFile
|
||||||
|
}
|
||||||
|
if !filepath.IsAbs(c.CertFile) || !filepath.IsAbs(c.KeyFile) {
|
||||||
|
return inputErr("cert_file and key_file must be absolute paths (the full chain, and its key)")
|
||||||
|
}
|
||||||
|
c.Challenge, c.KeyType = "", ""
|
||||||
|
default:
|
||||||
|
return inputErr("source must be acme (Jarl obtains and renews it) or file (you renew it)")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// checkUses refuses a second certificate for jarld's HTTPS.
|
||||||
|
func (m *Manager) checkUses(ctx context.Context, c *model.Certificate) error {
|
||||||
|
if !c.HasUse(model.CertUseWeb) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
all, err := m.store.Certificates(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
for _, o := range all {
|
||||||
|
if o.ID != c.ID && o.HasUse(model.CertUseWeb) {
|
||||||
|
return inputErr("certificate %s is already used for jarld's HTTPS; take the web use off it first (jarl cert update %s --use ...)", o.Name, o.Name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// List returns every certificate.
|
||||||
|
func (m *Manager) List(ctx context.Context) ([]*model.Certificate, error) {
|
||||||
|
return m.store.Certificates(ctx)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get returns one certificate.
|
||||||
|
func (m *Manager) Get(ctx context.Context, name string) (*model.Certificate, error) {
|
||||||
|
c, err := m.store.CertificateByName(ctx, name)
|
||||||
|
if errors.Is(err, store.ErrNotFound) {
|
||||||
|
return nil, ErrNotFound
|
||||||
|
}
|
||||||
|
return c, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create adds a certificate. A file-source certificate is read at once;
|
||||||
|
// one Jarl obtains is left for Issue (or the background loop).
|
||||||
|
func (m *Manager) Create(ctx context.Context, in Input, p *auth.Principal) (*model.Certificate, error) {
|
||||||
|
c := &model.Certificate{CreatedBy: p.Name(), UpdatedBy: p.Name()}
|
||||||
|
if err := m.apply(c, in, true); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := m.checkUses(ctx, c); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if c.Source == model.CertSourceFile {
|
||||||
|
if _, err := m.readFiles(c); err != nil {
|
||||||
|
return nil, inputErr("%v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := m.store.CreateCertificate(ctx, c); err != nil {
|
||||||
|
if errors.Is(err, store.ErrConflict) {
|
||||||
|
return nil, ErrConflict
|
||||||
|
}
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
m.eng.Audit(ctx, p, "certificate.create", "certificate", c.ID, c.Name, "ok", describe(c))
|
||||||
|
if c.Source == model.CertSourceFile {
|
||||||
|
m.refreshFile(ctx, c, true)
|
||||||
|
}
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update changes a certificate. New names or a new key type make one Jarl
|
||||||
|
// obtains due at once.
|
||||||
|
func (m *Manager) Update(ctx context.Context, name string, in Input, p *auth.Principal) (*model.Certificate, error) {
|
||||||
|
c, err := m.Get(ctx, name)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
before := *c
|
||||||
|
if err := m.apply(c, in, false); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := m.checkUses(ctx, c); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if before.HasUse(model.CertUseDNS) && !c.HasUse(model.CertUseDNS) && m.namedUses(ctx, m.FilesDir(c.Name)) {
|
||||||
|
return nil, inputErr("named's configuration uses certificate %s (a tls statement names its files), so it keeps the dns use: take it out of named first (jarl encrypted-dns disable)", c.Name)
|
||||||
|
}
|
||||||
|
if c.Source == model.CertSourceFile && (c.CertFile != before.CertFile || c.KeyFile != before.KeyFile) {
|
||||||
|
if _, err := m.readFiles(c); err != nil {
|
||||||
|
return nil, inputErr("%v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if c.Source == model.CertSourceACME && c.CertPEM != "" && (!slices.Equal(c.Domains, before.Domains) || c.KeyType != before.KeyType) {
|
||||||
|
now := m.now().UTC()
|
||||||
|
c.RenewAt, c.Failures = &now, 0
|
||||||
|
}
|
||||||
|
c.UpdatedBy = p.Name()
|
||||||
|
if err := m.store.UpdateCertificate(ctx, c); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
m.eng.Audit(ctx, p, "certificate.update", "certificate", c.ID, c.Name, "ok", describe(c))
|
||||||
|
if c.Source == model.CertSourceFile {
|
||||||
|
m.mu.Lock()
|
||||||
|
delete(m.files, c.ID)
|
||||||
|
m.mu.Unlock()
|
||||||
|
m.refreshFile(ctx, c, true)
|
||||||
|
} else if c.CertPEM != "" {
|
||||||
|
if err := m.deploy(ctx, c, []byte(c.CertPEM), []byte(c.KeyPEM)); err != nil {
|
||||||
|
m.log.Warn("writing certificate files failed", "certificate", c.Name, "err", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if before.HasUse(model.CertUseWeb) && !c.HasUse(model.CertUseWeb) {
|
||||||
|
m.dropWeb(c.Name)
|
||||||
|
}
|
||||||
|
m.Kick()
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Delete removes a certificate and its files for named.
|
||||||
|
func (m *Manager) Delete(ctx context.Context, name string, p *auth.Principal) error {
|
||||||
|
c, err := m.Get(ctx, name)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if c.HasUse(model.CertUseDNS) && m.namedUses(ctx, m.FilesDir(c.Name)) {
|
||||||
|
return inputErr("named's configuration uses certificate %s (a tls statement names its files): take it out first (jarl encrypted-dns disable, or remove the tls statement)", c.Name)
|
||||||
|
}
|
||||||
|
if err := m.store.DeleteCertificate(ctx, c.ID); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
m.dropWeb(c.Name)
|
||||||
|
if err := m.removeFiles(c.Name); err != nil {
|
||||||
|
m.log.Warn("removing certificate files failed", "certificate", c.Name, "err", err)
|
||||||
|
}
|
||||||
|
m.mu.Lock()
|
||||||
|
delete(m.files, c.ID)
|
||||||
|
m.mu.Unlock()
|
||||||
|
m.eng.Audit(ctx, p, "certificate.delete", "certificate", c.ID, c.Name, "ok", "")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func describe(c *model.Certificate) string {
|
||||||
|
s := c.Source
|
||||||
|
if c.Source == model.CertSourceACME {
|
||||||
|
s += " " + strings.Join(c.Domains, " ") + ", challenge " + c.Challenge
|
||||||
|
} else {
|
||||||
|
s += " " + c.CertFile
|
||||||
|
}
|
||||||
|
if len(c.Uses) > 0 {
|
||||||
|
s += ", uses " + strings.Join(c.Uses, ",")
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// Preview checks a new certificate's fields without saving it.
|
||||||
|
func (m *Manager) Preview(in Input) (*model.Certificate, error) {
|
||||||
|
c := &model.Certificate{}
|
||||||
|
if err := m.apply(c, in, true); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check works out where each name's challenge would go, without asking
|
||||||
|
// the CA for anything.
|
||||||
|
func (m *Manager) Check(ctx context.Context, c *model.Certificate) ([]Route, error) {
|
||||||
|
if c.Source != model.CertSourceACME {
|
||||||
|
return nil, inputErr("certificate %s is renewed by you (source file); there is nothing to check", c.Name)
|
||||||
|
}
|
||||||
|
st, err := m.store.LoadState(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
var out []Route
|
||||||
|
for _, d := range c.Domains {
|
||||||
|
out = append(out, m.route(ctx, st, c.Challenge, d, ""))
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// IssueResult is the outcome of an issue.
|
||||||
|
type IssueResult struct {
|
||||||
|
Certificate *model.Certificate `json:"certificate"`
|
||||||
|
Routes []Route `json:"routes"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Issuing reports since when the certificate is being obtained (zero when
|
||||||
|
// it isn't).
|
||||||
|
func (m *Manager) Issuing(name string) time.Time {
|
||||||
|
if v, ok := m.issuing.Load(name); ok {
|
||||||
|
return v.(time.Time)
|
||||||
|
}
|
||||||
|
return time.Time{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// IssueAsync starts obtaining a certificate in the background and returns
|
||||||
|
// at once: talking to the CA and waiting for every name server to serve
|
||||||
|
// the challenge can take minutes. Issuing tells when it is done; the
|
||||||
|
// outcome is in the certificate (last_success, last_error).
|
||||||
|
func (m *Manager) IssueAsync(ctx context.Context, name string, p *auth.Principal) (*model.Certificate, error) {
|
||||||
|
c, err := m.Get(ctx, name)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if c.Source == model.CertSourceFile {
|
||||||
|
res, err := m.Issue(ctx, name, p)
|
||||||
|
if res != nil {
|
||||||
|
return res.Certificate, err
|
||||||
|
}
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if _, busy := m.issuing.LoadOrStore(name, m.now()); busy {
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
go func() {
|
||||||
|
defer m.issuing.Delete(name)
|
||||||
|
m.issue(m.base, c, p)
|
||||||
|
}()
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Issue obtains a new certificate for c now (a file-source certificate is
|
||||||
|
// reread instead).
|
||||||
|
func (m *Manager) Issue(ctx context.Context, name string, p *auth.Principal) (*IssueResult, error) {
|
||||||
|
c, err := m.Get(ctx, name)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if c.Source == model.CertSourceFile {
|
||||||
|
m.mu.Lock()
|
||||||
|
delete(m.files, c.ID)
|
||||||
|
m.mu.Unlock()
|
||||||
|
if err := m.refreshFile(ctx, c, true); err != nil {
|
||||||
|
return &IssueResult{Certificate: c}, err
|
||||||
|
}
|
||||||
|
return &IssueResult{Certificate: c}, nil
|
||||||
|
}
|
||||||
|
return m.issue(ctx, c, p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *Manager) issue(ctx context.Context, c *model.Certificate, p *auth.Principal) (*IssueResult, error) {
|
||||||
|
m.issueMu.Lock()
|
||||||
|
defer m.issueMu.Unlock()
|
||||||
|
// Reload: another issue may have finished while this one waited.
|
||||||
|
if fresh, err := m.Get(ctx, c.Name); err == nil {
|
||||||
|
c = fresh
|
||||||
|
}
|
||||||
|
var old *x509.Certificate
|
||||||
|
if c.CertPEM != "" {
|
||||||
|
if in, _, err := Inspect([]byte(c.CertPEM), []byte(c.KeyPEM)); err == nil {
|
||||||
|
old = in.Leaf
|
||||||
|
}
|
||||||
|
}
|
||||||
|
m.log.Info("obtaining certificate", "certificate", c.Name, "domains", strings.Join(c.Domains, " "), "by", p.Name())
|
||||||
|
now := m.now().UTC()
|
||||||
|
c.LastAttempt = &now
|
||||||
|
res, routes, err := m.obtain(ctx, c, old)
|
||||||
|
c.LastRoutes = nil
|
||||||
|
for _, r := range routes {
|
||||||
|
if r.Error == "" {
|
||||||
|
c.LastRoutes = append(c.LastRoutes, r.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var info *Info
|
||||||
|
if err == nil {
|
||||||
|
info, _, err = Inspect(res.Certificate, res.PrivateKey)
|
||||||
|
if err != nil {
|
||||||
|
err = fmt.Errorf("the CA's certificate is unusable: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
c.Failures++
|
||||||
|
c.LastError = err.Error()
|
||||||
|
if serr := m.store.UpdateCertificate(ctx, c); serr != nil {
|
||||||
|
m.log.Error("saving certificate state failed", "certificate", c.Name, "err", serr)
|
||||||
|
}
|
||||||
|
m.log.Warn("obtaining certificate failed", "certificate", c.Name, "failures", c.Failures, "err", err)
|
||||||
|
m.eng.Audit(ctx, p, "certificate.issue", "certificate", c.ID, c.Name, "error", err.Error())
|
||||||
|
return &IssueResult{Certificate: c, Routes: routes}, err
|
||||||
|
}
|
||||||
|
c.CertPEM, c.KeyPEM = string(res.Certificate), string(res.PrivateKey)
|
||||||
|
setInfo(c, info)
|
||||||
|
done := m.now().UTC()
|
||||||
|
c.LastSuccess, c.Failures, c.LastError = &done, 0, ""
|
||||||
|
at := twoThirds(info.NotBefore, info.NotAfter)
|
||||||
|
c.RenewAt, c.ARICheckedAt = &at, nil
|
||||||
|
if t, err := m.renewalInfo(ctx, c, info.Leaf); err == nil && t != nil {
|
||||||
|
c.RenewAt, c.ARICheckedAt = t, &done
|
||||||
|
}
|
||||||
|
if err := m.store.UpdateCertificate(ctx, c); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
m.log.Info("certificate obtained", "certificate", c.Name, "expires", info.NotAfter.Format(time.DateOnly), "renew_at", c.RenewAt.Format(time.RFC3339), "routes", strings.Join(c.LastRoutes, "; "))
|
||||||
|
m.eng.Audit(ctx, p, "certificate.issue", "certificate", c.ID, c.Name, "ok", fmt.Sprintf("%s, valid until %s, from %s", strings.Join(info.Names, " "), info.NotAfter.Format(time.DateOnly), info.Issuer))
|
||||||
|
if err := m.deploy(ctx, c, res.Certificate, res.PrivateKey); err != nil {
|
||||||
|
m.log.Error("writing certificate files failed", "certificate", c.Name, "err", err)
|
||||||
|
return &IssueResult{Certificate: c, Routes: routes}, fmt.Errorf("the certificate was obtained, but writing it for named failed: %w", err)
|
||||||
|
}
|
||||||
|
return &IssueResult{Certificate: c, Routes: routes}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func setInfo(c *model.Certificate, in *Info) {
|
||||||
|
nb, na := in.NotBefore.UTC(), in.NotAfter.UTC()
|
||||||
|
c.Names, c.NotBefore, c.NotAfter, c.Issuer, c.Serial = in.Names, &nb, &na, in.Issuer, in.Serial
|
||||||
|
}
|
||||||
|
|
||||||
|
// readFiles reads a file-source certificate and checks it.
|
||||||
|
func (m *Manager) readFiles(c *model.Certificate) (*Info, error) {
|
||||||
|
cert, err := os.ReadFile(c.CertFile)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fileErr(err)
|
||||||
|
}
|
||||||
|
key, err := os.ReadFile(c.KeyFile)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fileErr(err)
|
||||||
|
}
|
||||||
|
in, _, err := Inspect(cert, key)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("%s and %s: %w", c.CertFile, c.KeyFile, err)
|
||||||
|
}
|
||||||
|
return in, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func fileErr(err error) error {
|
||||||
|
if errors.Is(err, fs.ErrPermission) {
|
||||||
|
return fmt.Errorf("%w: jarld runs as its own user (jarl) and must be able to read the certificate and its key; e.g. give the files group jarl (chgrp jarl FILE; chmod 640 FILE), or copy them somewhere it can read in your renewal hook", err)
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// refreshFile rereads a file-source certificate when its files changed
|
||||||
|
// (always with force) and deploys it.
|
||||||
|
func (m *Manager) refreshFile(ctx context.Context, c *model.Certificate, force bool) error {
|
||||||
|
cs, err1 := os.Stat(c.CertFile)
|
||||||
|
ks, err2 := os.Stat(c.KeyFile)
|
||||||
|
var stamp fileStamp
|
||||||
|
if err1 == nil && err2 == nil {
|
||||||
|
stamp = fileStamp{certMod: cs.ModTime(), keyMod: ks.ModTime(), certSize: cs.Size()}
|
||||||
|
m.mu.Lock()
|
||||||
|
prev, ok := m.files[c.ID]
|
||||||
|
m.mu.Unlock()
|
||||||
|
if ok && prev == stamp && !force {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
in, err := m.readFiles(c)
|
||||||
|
now := m.now().UTC()
|
||||||
|
c.LastAttempt = &now
|
||||||
|
if err != nil {
|
||||||
|
if c.LastError != err.Error() {
|
||||||
|
m.log.Warn("reading certificate failed", "certificate", c.Name, "err", err)
|
||||||
|
}
|
||||||
|
c.LastError = err.Error()
|
||||||
|
c.Failures = max(c.Failures, 1)
|
||||||
|
m.store.UpdateCertificate(ctx, c)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if c.Serial != in.Serial {
|
||||||
|
m.log.Info("certificate read", "certificate", c.Name, "file", c.CertFile, "expires", in.NotAfter.Format(time.DateOnly))
|
||||||
|
}
|
||||||
|
setInfo(c, in)
|
||||||
|
c.Domains = in.Names
|
||||||
|
c.LastSuccess, c.LastError, c.Failures = &now, "", 0
|
||||||
|
if len(in.Warnings) > 0 {
|
||||||
|
c.LastError = in.Warnings[0]
|
||||||
|
}
|
||||||
|
if err := m.store.UpdateCertificate(ctx, c); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
cert, _ := os.ReadFile(c.CertFile)
|
||||||
|
key, _ := os.ReadFile(c.KeyFile)
|
||||||
|
if err := m.deploy(ctx, c, cert, key); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
m.mu.Lock()
|
||||||
|
m.files[c.ID] = stamp
|
||||||
|
m.mu.Unlock()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// FilesDir is where a certificate with the dns use is written for named.
|
||||||
|
func (m *Manager) FilesDir(name string) string { return filepath.Join(m.cfg.Dir, name) }
|
||||||
|
|
||||||
|
// Files names a certificate's files for named.
|
||||||
|
const (
|
||||||
|
ChainFile = "fullchain.pem"
|
||||||
|
KeyFile = "privkey.pem"
|
||||||
|
)
|
||||||
|
|
||||||
|
// deploy puts a certificate where it is used: jarld's HTTPS and/or the
|
||||||
|
// files named reads. When those files change and named's configuration
|
||||||
|
// names them, named rereads it.
|
||||||
|
func (m *Manager) deploy(ctx context.Context, c *model.Certificate, cert, key []byte) error {
|
||||||
|
_, pair, err := Inspect(cert, key)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if c.HasUse(model.CertUseWeb) {
|
||||||
|
m.web.Store(&webCert{name: c.Name, pair: pair})
|
||||||
|
} else {
|
||||||
|
m.dropWeb(c.Name)
|
||||||
|
}
|
||||||
|
if !c.HasUse(model.CertUseDNS) {
|
||||||
|
return m.removeFiles(c.Name)
|
||||||
|
}
|
||||||
|
dir := m.FilesDir(c.Name)
|
||||||
|
changed := false
|
||||||
|
for _, f := range []struct {
|
||||||
|
name string
|
||||||
|
content []byte
|
||||||
|
mode fs.FileMode
|
||||||
|
}{{ChainFile, cert, 0o644}, {KeyFile, key, 0o640}} {
|
||||||
|
path := filepath.Join(dir, f.name)
|
||||||
|
if old, err := os.ReadFile(path); err == nil && bytes.Equal(old, f.content) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if err := m.eng.WriteFile(path, f.content, f.mode); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
changed = true
|
||||||
|
}
|
||||||
|
if changed && m.namedUses(ctx, dir) {
|
||||||
|
if err := m.eng.Reconfig(ctx); err != nil {
|
||||||
|
return fmt.Errorf("named didn't reread its configuration for the new certificate: %w", err)
|
||||||
|
}
|
||||||
|
m.log.Info("named rereads the new certificate", "certificate", c.Name)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// namedUses reports whether named's configuration names files in dir.
|
||||||
|
func (m *Manager) namedUses(ctx context.Context, dir string) bool {
|
||||||
|
st, err := m.store.LoadState(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
for _, o := range st.Options {
|
||||||
|
if strings.Contains(o.Value, dir+"/") {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *Manager) removeFiles(name string) error {
|
||||||
|
if name == "" || strings.ContainsAny(name, "/.") {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
dir := m.FilesDir(name)
|
||||||
|
if _, err := os.Stat(dir); err != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return os.RemoveAll(dir)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *Manager) dropWeb(name string) {
|
||||||
|
if w := m.web.Load(); w != nil && w.name == name {
|
||||||
|
m.web.CompareAndSwap(w, nil)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WebCertificate is the certificate for jarld's HTTPS (nil when no
|
||||||
|
// certificate has the web use, or it has none yet).
|
||||||
|
func (m *Manager) WebCertificate() *tls.Certificate {
|
||||||
|
if w := m.web.Load(); w != nil {
|
||||||
|
return w.pair
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// WebName is the name of the certificate jarld serves ("" for none).
|
||||||
|
func (m *Manager) WebName() string {
|
||||||
|
if w := m.web.Load(); w != nil {
|
||||||
|
return w.name
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// HasWeb reports whether a certificate has the web use (whether or not
|
||||||
|
// it has been obtained yet).
|
||||||
|
func (m *Manager) HasWeb(ctx context.Context) bool {
|
||||||
|
all, err := m.store.Certificates(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return slices.ContainsFunc(all, func(c *model.Certificate) bool { return c.HasUse(model.CertUseWeb) })
|
||||||
|
}
|
||||||
|
|
||||||
|
// Kick makes the loop look at the certificates now.
|
||||||
|
func (m *Manager) Kick() {
|
||||||
|
select {
|
||||||
|
case m.kick <- struct{}{}:
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Start loads the certificates and puts them in place (jarld's HTTPS, the
|
||||||
|
// files for named). Call it before serving.
|
||||||
|
func (m *Manager) Start(ctx context.Context) {
|
||||||
|
all, err := m.store.Certificates(ctx)
|
||||||
|
if err != nil {
|
||||||
|
m.log.Error("loading certificates failed", "err", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
for _, c := range all {
|
||||||
|
switch {
|
||||||
|
case c.Source == model.CertSourceFile:
|
||||||
|
m.refreshFile(ctx, c, true)
|
||||||
|
case c.CertPEM != "":
|
||||||
|
if err := m.deploy(ctx, c, []byte(c.CertPEM), []byte(c.KeyPEM)); err != nil {
|
||||||
|
m.log.Warn("putting certificate in place failed", "certificate", c.Name, "err", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
m.followDir(ctx, all)
|
||||||
|
}
|
||||||
|
|
||||||
|
// followDir points the tls statements encrypted DNS wrote (jarl-NAME) at
|
||||||
|
// certificates.dir when it has changed: Start has just written the
|
||||||
|
// certificates there, and named would otherwise keep serving the old
|
||||||
|
// copies, which renewals no longer update.
|
||||||
|
func (m *Manager) followDir(ctx context.Context, all []*model.Certificate) {
|
||||||
|
st, err := m.store.LoadState(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
var reqs []engine.Request
|
||||||
|
for _, b := range encdns.TLSBlocks(st) {
|
||||||
|
name, ok := strings.CutPrefix(b.Name, encdns.Prefix)
|
||||||
|
if !ok || filepath.Dir(b.CertFile) == m.FilesDir(name) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
i := slices.IndexFunc(all, func(c *model.Certificate) bool { return c.Name == name })
|
||||||
|
if i < 0 || !all[i].HasUse(model.CertUseDNS) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(filepath.Join(m.FilesDir(name), ChainFile)); err != nil {
|
||||||
|
continue // not written there (yet)
|
||||||
|
}
|
||||||
|
reqs = append(reqs, engine.NewRequest(engine.OpOptionUpdate, b.OptionID, engine.OptionInput{Value: model.Ptr(encdns.TLSValue(name, m.cfg.Dir))}))
|
||||||
|
m.log.Info("certificates.dir changed: pointing named at the new files", "tls", b.Name, "was", filepath.Dir(b.CertFile), "now", m.FilesDir(name))
|
||||||
|
}
|
||||||
|
if len(reqs) == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if _, err := m.eng.Submit(ctx, reqs, auth.System, "jarld", "certificates.dir changed: tls statements follow it", engine.ApplyOptions{}); err != nil {
|
||||||
|
m.log.Error("pointing named at the moved certificate files failed; run 'jarl encrypted-dns setup' again", "err", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run renews certificates when they are due and rereads file-source ones
|
||||||
|
// when their files change, until ctx ends.
|
||||||
|
func (m *Manager) Run(ctx context.Context) {
|
||||||
|
m.base = ctx
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-time.After(20 * time.Second): // let jarld finish starting
|
||||||
|
}
|
||||||
|
for {
|
||||||
|
m.Tick(ctx)
|
||||||
|
t := time.NewTimer(10 * time.Minute)
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
t.Stop()
|
||||||
|
return
|
||||||
|
case <-t.C:
|
||||||
|
case <-m.kick:
|
||||||
|
t.Stop()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Tick does one round of the loop.
|
||||||
|
func (m *Manager) Tick(ctx context.Context) {
|
||||||
|
all, err := m.store.Certificates(ctx)
|
||||||
|
if err != nil {
|
||||||
|
m.log.Error("loading certificates failed", "err", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
now := m.now()
|
||||||
|
for _, c := range all {
|
||||||
|
if ctx.Err() != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if c.Source == model.CertSourceFile {
|
||||||
|
m.refreshFile(ctx, c, false)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if at := m.Due(c); !at.After(now) {
|
||||||
|
if _, busy := m.issuing.LoadOrStore(c.Name, now); !busy {
|
||||||
|
m.issue(ctx, c, auth.System)
|
||||||
|
m.issuing.Delete(c.Name)
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// Ask the CA about the renewal window twice a day (it moves it
|
||||||
|
// earlier when a certificate must be replaced, e.g. revoked).
|
||||||
|
if c.CertPEM != "" && (c.ARICheckedAt == nil || now.Sub(*c.ARICheckedAt) > 12*time.Hour) {
|
||||||
|
in, _, err := Inspect([]byte(c.CertPEM), []byte(c.KeyPEM))
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
t, err := m.renewalInfo(ctx, c, in.Leaf)
|
||||||
|
checked := now.UTC()
|
||||||
|
c.ARICheckedAt = &checked
|
||||||
|
if err == nil && t != nil && (c.RenewAt == nil || !t.Equal(*c.RenewAt)) {
|
||||||
|
m.log.Info("renewal time from the CA", "certificate", c.Name, "renew_at", t.Format(time.RFC3339))
|
||||||
|
c.RenewAt = t
|
||||||
|
}
|
||||||
|
m.store.UpdateCertificate(ctx, c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Due is when c should be obtained (again): at once when it has no
|
||||||
|
// certificate yet or its names changed; else at its renewal time. After
|
||||||
|
// failures it waits 1, 2, 4 ... hours (at most a day) between attempts.
|
||||||
|
func (m *Manager) Due(c *model.Certificate) time.Time {
|
||||||
|
var at time.Time
|
||||||
|
switch {
|
||||||
|
case c.CertPEM == "":
|
||||||
|
at = c.CreatedAt
|
||||||
|
case c.RenewAt != nil:
|
||||||
|
at = *c.RenewAt
|
||||||
|
case c.NotBefore != nil && c.NotAfter != nil:
|
||||||
|
at = twoThirds(*c.NotBefore, *c.NotAfter)
|
||||||
|
}
|
||||||
|
if c.Failures > 0 && c.LastAttempt != nil {
|
||||||
|
wait := time.Hour << min(c.Failures-1, 5)
|
||||||
|
at = maxTime(at, c.LastAttempt.Add(min(wait, 24*time.Hour)))
|
||||||
|
}
|
||||||
|
return at
|
||||||
|
}
|
||||||
|
|
||||||
|
func maxTime(a, b time.Time) time.Time {
|
||||||
|
if a.After(b) {
|
||||||
|
return a
|
||||||
|
}
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
// Status is a certificate's health.
|
||||||
|
type Status struct {
|
||||||
|
State string `json:"state"` // ok, pending, failing, expiring, expired
|
||||||
|
Message string `json:"message,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// StatusOf says how c is doing.
|
||||||
|
func (m *Manager) StatusOf(c *model.Certificate) Status {
|
||||||
|
now := m.now()
|
||||||
|
if c.NotAfter == nil {
|
||||||
|
if c.Failures > 0 {
|
||||||
|
return Status{"failing", "not obtained yet: " + c.LastError}
|
||||||
|
}
|
||||||
|
return Status{"pending", "not obtained yet"}
|
||||||
|
}
|
||||||
|
left := c.NotAfter.Sub(now)
|
||||||
|
life := c.NotAfter.Sub(*c.NotBefore)
|
||||||
|
switch {
|
||||||
|
case left <= 0:
|
||||||
|
return Status{"expired", "expired on " + c.NotAfter.Format(time.DateOnly)}
|
||||||
|
case c.Failures > 0 && c.Source == model.CertSourceACME:
|
||||||
|
return Status{"failing", fmt.Sprintf("renewing failed %d times (next try %s): %s", c.Failures, m.Due(c).Local().Format("2 Jan 15:04"), c.LastError)}
|
||||||
|
case c.Failures > 0:
|
||||||
|
return Status{"failing", c.LastError}
|
||||||
|
case left < life/6 || (c.Source == model.CertSourceFile && left < 14*24*time.Hour):
|
||||||
|
return Status{"expiring", fmt.Sprintf("expires in %s (%s)", days(left), c.NotAfter.Format(time.DateOnly))}
|
||||||
|
}
|
||||||
|
return Status{"ok", ""}
|
||||||
|
}
|
||||||
|
|
||||||
|
func days(d time.Duration) string {
|
||||||
|
n := int(d.Hours() / 24)
|
||||||
|
if n == 1 {
|
||||||
|
return "1 day"
|
||||||
|
}
|
||||||
|
if n < 1 {
|
||||||
|
return fmt.Sprintf("%d hours", int(d.Hours()))
|
||||||
|
}
|
||||||
|
return fmt.Sprintf("%d days", n)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AccountInfo is the ACME account as the API shows it.
|
||||||
|
type AccountInfo struct {
|
||||||
|
Directory string `json:"directory"`
|
||||||
|
Email string `json:"email,omitempty"`
|
||||||
|
AgreeTOS bool `json:"agree_tos"`
|
||||||
|
EAB bool `json:"eab"`
|
||||||
|
Registered bool `json:"registered"`
|
||||||
|
URI string `json:"uri,omitempty"`
|
||||||
|
RegisteredAt *time.Time `json:"registered_at,omitempty"`
|
||||||
|
Porkbun bool `json:"porkbun"`
|
||||||
|
Resolvers []string `json:"resolvers"`
|
||||||
|
Dir string `json:"dir"`
|
||||||
|
ActiveWebCert string `json:"active_web_certificate,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AccountInfo describes the ACME account and settings.
|
||||||
|
func (m *Manager) AccountInfo(ctx context.Context) AccountInfo {
|
||||||
|
ai := AccountInfo{Directory: m.cfg.Directory, Email: m.cfg.Email, AgreeTOS: m.cfg.AgreeTOS, EAB: m.cfg.EABKeyID != "",
|
||||||
|
Porkbun: m.cfg.Porkbun != nil, Resolvers: m.cfg.Resolvers, Dir: m.cfg.Dir, ActiveWebCert: m.WebName()}
|
||||||
|
if a := m.account(ctx); a != nil && a.Directory == m.cfg.Directory && a.URI != "" {
|
||||||
|
ai.Registered, ai.URI = true, a.URI
|
||||||
|
t := a.RegisteredAt
|
||||||
|
ai.RegisteredAt = &t
|
||||||
|
}
|
||||||
|
return ai
|
||||||
|
}
|
||||||
@@ -0,0 +1,146 @@
|
|||||||
|
package certs
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"jarl/internal/acme"
|
||||||
|
"jarl/internal/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Route says where the DNS-01 challenge for one certificate name goes,
|
||||||
|
// and why.
|
||||||
|
type Route struct {
|
||||||
|
Domain string `json:"domain"` // the name on the certificate
|
||||||
|
Record string `json:"record"` // _acme-challenge.<domain>
|
||||||
|
// Target is where the TXT record is written: Record, or where its
|
||||||
|
// CNAME points.
|
||||||
|
Target string `json:"target"`
|
||||||
|
Route string `json:"route,omitempty"` // jarl or porkbun; "" when there is none
|
||||||
|
Zone string `json:"zone,omitempty"` // the zone on the internet that holds Target
|
||||||
|
PublicNS []string `json:"public_ns,omitempty"`
|
||||||
|
Why string `json:"why"`
|
||||||
|
Error string `json:"error,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r Route) String() string {
|
||||||
|
s := r.Domain + ": " + r.Route
|
||||||
|
if r.Target != r.Record {
|
||||||
|
s += " via CNAME " + strings.TrimSuffix(r.Target, ".")
|
||||||
|
}
|
||||||
|
return s + " (zone " + strings.TrimSuffix(r.Zone, ".") + ")"
|
||||||
|
}
|
||||||
|
|
||||||
|
func isPorkbunNS(ns []string) bool {
|
||||||
|
for _, n := range ns {
|
||||||
|
if strings.HasSuffix(n, ".porkbun.com") {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// route decides where the challenge for domain goes. challenge is the
|
||||||
|
// certificate's setting: auto picks from the zone's public name servers.
|
||||||
|
// target is the record name after CNAMEs ("" to look it up).
|
||||||
|
func (m *Manager) route(ctx context.Context, st *model.State, challenge, domain, target string) Route {
|
||||||
|
r := Route{Domain: domain, Record: challengeName(domain)}
|
||||||
|
fail := func(format string, a ...any) Route {
|
||||||
|
r.Error = fmt.Sprintf(format, a...)
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
if target == "" {
|
||||||
|
t, err := m.res.follow(ctx, r.Record)
|
||||||
|
if err != nil {
|
||||||
|
return fail("%v", err)
|
||||||
|
}
|
||||||
|
target = t
|
||||||
|
}
|
||||||
|
r.Target = target
|
||||||
|
zone, err := m.res.zoneOf(ctx, target)
|
||||||
|
if err != nil {
|
||||||
|
return fail("%v", err)
|
||||||
|
}
|
||||||
|
r.Zone = zone
|
||||||
|
ns, err := m.res.nameServers(ctx, zone)
|
||||||
|
if err != nil {
|
||||||
|
return fail("%v", err)
|
||||||
|
}
|
||||||
|
r.PublicNS = ns
|
||||||
|
zoneName, nsList := strings.TrimSuffix(zone, "."), strings.Join(ns, ", ")
|
||||||
|
|
||||||
|
// Jarl can answer when it has the zone and the internet asks the name
|
||||||
|
// servers listed in it.
|
||||||
|
var jarlNS []string
|
||||||
|
jarlHas := false
|
||||||
|
for _, z := range st.SortedZones() {
|
||||||
|
if z.Type != model.ZonePrimary || z.Disabled || normName(z.Name) != normName(zone) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
jarlHas = true
|
||||||
|
for _, rec := range st.ZoneRecords(z.ID) {
|
||||||
|
if rec.Type == "NS" && !rec.Disabled && normName(rec.Name) == normName(zone) {
|
||||||
|
jarlNS = append(jarlNS, normName(rec.Data))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
slices.Sort(jarlNS)
|
||||||
|
jarlNS = slices.Compact(jarlNS)
|
||||||
|
servedByJarl := jarlHas && slices.ContainsFunc(ns, func(n string) bool { return slices.Contains(jarlNS, n) })
|
||||||
|
porkbunOK := m.cfg.Porkbun != nil && (m.cfg.PorkbunAllows == nil || m.cfg.PorkbunAllows(zoneName))
|
||||||
|
|
||||||
|
porkbun := func() Route {
|
||||||
|
r.Route, r.Why = model.ChallengePorkbun, fmt.Sprintf("%s is served by Porkbun (%s), so the record goes in through Porkbun's API", zoneName, nsList)
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
jarl := func() Route {
|
||||||
|
r.Route, r.Why = model.ChallengeJarl, fmt.Sprintf("%s is served by this server's name servers (%s), so Jarl writes the record itself", zoneName, nsList)
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
switch challenge {
|
||||||
|
case model.ChallengePorkbun:
|
||||||
|
switch {
|
||||||
|
case m.cfg.Porkbun == nil:
|
||||||
|
return fail("the challenge is set to porkbun, but jarl.yaml has no porkbun.api_key")
|
||||||
|
case !porkbunOK:
|
||||||
|
return fail("the challenge is set to porkbun, but %s isn't in porkbun.domains in jarl.yaml", zoneName)
|
||||||
|
case !isPorkbunNS(ns):
|
||||||
|
return fail("the challenge is set to porkbun, but on the internet %s is served by %s, not Porkbun: the CA would never see the record (set the challenge to auto)", zoneName, nsList)
|
||||||
|
}
|
||||||
|
return porkbun()
|
||||||
|
case model.ChallengeJarl:
|
||||||
|
switch {
|
||||||
|
case !jarlHas:
|
||||||
|
return fail("the challenge is set to jarl, but no primary zone in Jarl is %s (where %s is on the internet)", zoneName, strings.TrimSuffix(target, "."))
|
||||||
|
case !servedByJarl:
|
||||||
|
return fail("the challenge is set to jarl, but on the internet %s is served by %s, not by the name servers in Jarl's zone (%s): the CA would never see the record (set the challenge to auto)", zoneName, nsList, strings.Join(jarlNS, ", "))
|
||||||
|
}
|
||||||
|
return jarl()
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case isPorkbunNS(ns) && porkbunOK:
|
||||||
|
return porkbun()
|
||||||
|
case servedByJarl:
|
||||||
|
return jarl()
|
||||||
|
case isPorkbunNS(ns) && m.cfg.Porkbun == nil:
|
||||||
|
return fail("%s is served by Porkbun (%s) and jarl.yaml has no porkbun.api_key. Add the key, or point %s with a CNAME at a name in a zone this server serves on the internet", zoneName, nsList, strings.TrimSuffix(r.Record, "."))
|
||||||
|
case isPorkbunNS(ns):
|
||||||
|
return fail("%s is served by Porkbun (%s) but isn't in porkbun.domains in jarl.yaml", zoneName, nsList)
|
||||||
|
case jarlHas:
|
||||||
|
return fail("on the internet %s is served by %s, not by the name servers in Jarl's zone (%s), so the CA would never see a record Jarl writes. Delegate the zone to this server, or point %s with a CNAME at a name in a zone it serves", zoneName, nsList, strings.Join(jarlNS, ", "), strings.TrimSuffix(r.Record, "."))
|
||||||
|
}
|
||||||
|
return fail("%s is served by %s, which Jarl can't write to. Point %s with a CNAME at a name in a zone this server serves on the internet (for example %s.acme.<your domain>, in a zone acme.<your domain> delegated here): Jarl follows the CNAME and answers there", zoneName, nsList, strings.TrimSuffix(r.Record, "."), strings.ReplaceAll(strings.TrimSuffix(strings.TrimPrefix(r.Record, "_acme-challenge."), "."), ".", "-"))
|
||||||
|
}
|
||||||
|
|
||||||
|
// primaryZones lists the zones Jarl can write challenge records into.
|
||||||
|
func primaryZones(st *model.State) []acme.Zone {
|
||||||
|
var out []acme.Zone
|
||||||
|
for _, z := range st.SortedZones() {
|
||||||
|
if z.Type == model.ZonePrimary && !z.Disabled {
|
||||||
|
out = append(out, acme.Zone{Name: z.Name, View: st.ViewName(z), Link: z.LinkGroup})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
@@ -38,6 +38,9 @@ type Client struct {
|
|||||||
csErr error
|
csErr error
|
||||||
DryRun bool
|
DryRun bool
|
||||||
Force bool
|
Force bool
|
||||||
|
// AcceptRisk confirms changes that open the server up
|
||||||
|
// (docs/exposure.md).
|
||||||
|
AcceptRisk bool
|
||||||
// Preflight lets only requests through that can't change anything:
|
// Preflight lets only requests through that can't change anything:
|
||||||
// reads and dry runs. Running a command on several servers uses it to
|
// reads and dry runs. Running a command on several servers uses it to
|
||||||
// check the command everywhere before running it anywhere.
|
// check the command everywhere before running it anywhere.
|
||||||
@@ -282,6 +285,9 @@ func (c *Client) Mutate(ctx context.Context, method, path string, query url.Valu
|
|||||||
if c.Force {
|
if c.Force {
|
||||||
q.Set("force", "1")
|
q.Set("force", "1")
|
||||||
}
|
}
|
||||||
|
if c.AcceptRisk {
|
||||||
|
q.Set("accept_risk", "1")
|
||||||
|
}
|
||||||
var out api.MutationResponse
|
var out api.MutationResponse
|
||||||
err = c.Do(ctx, method, path, q, body, &out)
|
err = c.Do(ctx, method, path, q, body, &out)
|
||||||
return &out, err
|
return &out, err
|
||||||
|
|||||||
+155
-14
@@ -40,6 +40,17 @@ type Config struct {
|
|||||||
Porkbun Porkbun `yaml:"porkbun"`
|
Porkbun Porkbun `yaml:"porkbun"`
|
||||||
Blocking Blocking `yaml:"blocking"`
|
Blocking Blocking `yaml:"blocking"`
|
||||||
Metrics Metrics `yaml:"metrics"`
|
Metrics Metrics `yaml:"metrics"`
|
||||||
|
// Certificates configures TLS certificates Jarl manages
|
||||||
|
// (docs/certificates.md); the ACME account is under acme.
|
||||||
|
Certificates Certificates `yaml:"certificates"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Certificates configures the certificates Jarl manages.
|
||||||
|
type Certificates struct {
|
||||||
|
// Dir is where certificates are written for named (DNS over TLS and
|
||||||
|
// HTTPS): one directory per certificate, readable by bind.file_group.
|
||||||
|
// "" is <bind.config_dir>/tls.
|
||||||
|
Dir string `yaml:"dir"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Metrics configures the Prometheus endpoint /metrics (docs/metrics.md).
|
// Metrics configures the Prometheus endpoint /metrics (docs/metrics.md).
|
||||||
@@ -183,9 +194,85 @@ type Backup struct {
|
|||||||
WarnAfter Duration `yaml:"warn_after"`
|
WarnAfter Duration `yaml:"warn_after"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ACME configures the ACME helpers.
|
// ACME configures the ACME helpers and the account Jarl uses to obtain
|
||||||
|
// certificates itself.
|
||||||
type ACME struct {
|
type ACME struct {
|
||||||
HTTPReq HTTPReq `yaml:"httpreq"`
|
HTTPReq HTTPReq `yaml:"httpreq"`
|
||||||
|
Account ACMEAccount `yaml:"account"`
|
||||||
|
// Resolvers are the recursive resolvers used to see a domain as the
|
||||||
|
// CA does: its zone, its public name servers and any CNAME on
|
||||||
|
// _acme-challenge. Public resolvers by default, because this server's
|
||||||
|
// own answers may come from an internal view.
|
||||||
|
Resolvers []string `yaml:"resolvers"`
|
||||||
|
// CABundle is a PEM file of extra CA certificates to trust when
|
||||||
|
// talking to the ACME server (a private CA such as step-ca).
|
||||||
|
CABundle string `yaml:"ca_bundle"`
|
||||||
|
// CheckPropagation waits until every name server of the zone serves
|
||||||
|
// a challenge before telling the CA to look.
|
||||||
|
CheckPropagation bool `yaml:"check_propagation"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ACMEAccount is the ACME account certificates are obtained with.
|
||||||
|
type ACMEAccount struct {
|
||||||
|
// Directory is letsencrypt, letsencrypt-staging or an ACME directory URL.
|
||||||
|
Directory string `yaml:"directory"`
|
||||||
|
Email string `yaml:"email"`
|
||||||
|
// AgreeTOS says you accept the CA's terms of service. Jarl doesn't
|
||||||
|
// register an account without it.
|
||||||
|
AgreeTOS bool `yaml:"agree_tos"`
|
||||||
|
// EABKeyID and EABHMAC are External Account Binding credentials, for
|
||||||
|
// CAs that need them (ZeroSSL, Google).
|
||||||
|
EABKeyID string `yaml:"eab_kid"`
|
||||||
|
EABHMAC string `yaml:"eab_hmac"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Directory URLs for the names acme.account.directory accepts.
|
||||||
|
const (
|
||||||
|
LetsEncrypt = "https://acme-v02.api.letsencrypt.org/directory"
|
||||||
|
LetsEncryptStaging = "https://acme-staging-v02.api.letsencrypt.org/directory"
|
||||||
|
)
|
||||||
|
|
||||||
|
// DirectoryURL is the account's ACME directory URL.
|
||||||
|
func (a ACMEAccount) DirectoryURL() string {
|
||||||
|
switch a.Directory {
|
||||||
|
case "", "letsencrypt":
|
||||||
|
return LetsEncrypt
|
||||||
|
case "letsencrypt-staging":
|
||||||
|
return LetsEncryptStaging
|
||||||
|
}
|
||||||
|
return a.Directory
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *ACME) check() error {
|
||||||
|
if d := a.Account.Directory; d != "" && d != "letsencrypt" && d != "letsencrypt-staging" {
|
||||||
|
u, err := url.Parse(d)
|
||||||
|
if err != nil || u.Scheme != "https" || u.Host == "" {
|
||||||
|
return fmt.Errorf("account.directory must be letsencrypt, letsencrypt-staging or an https:// URL")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if a.Account.Email != "" && !strings.Contains(a.Account.Email, "@") {
|
||||||
|
return fmt.Errorf("account.email %q isn't an email address", a.Account.Email)
|
||||||
|
}
|
||||||
|
if (a.Account.EABKeyID == "") != (a.Account.EABHMAC == "") {
|
||||||
|
return fmt.Errorf("account: set both eab_kid and eab_hmac, or neither")
|
||||||
|
}
|
||||||
|
for _, r := range a.Resolvers {
|
||||||
|
if _, _, err := net.SplitHostPort(r); err != nil {
|
||||||
|
return fmt.Errorf("resolvers: %q must be address:port, e.g. 1.1.1.1:53 or [2606:4700:4700::1111]:53", r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if a.CABundle != "" && !filepath.IsAbs(a.CABundle) {
|
||||||
|
return fmt.Errorf("ca_bundle must be an absolute path")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CertDir is certificates.dir, or <bind.config_dir>/tls.
|
||||||
|
func (c *Config) CertDir() string {
|
||||||
|
if c.Certificates.Dir != "" {
|
||||||
|
return c.Certificates.Dir
|
||||||
|
}
|
||||||
|
return filepath.Join(c.BIND.ConfigDir, "tls")
|
||||||
}
|
}
|
||||||
|
|
||||||
// HTTPReq configures the endpoint for lego's httpreq DNS provider
|
// HTTPReq configures the endpoint for lego's httpreq DNS provider
|
||||||
@@ -277,6 +364,10 @@ type Stats struct {
|
|||||||
// per-zone counts) from named's response log. Without it only named's
|
// per-zone counts) from named's response log. Without it only named's
|
||||||
// own counters are collected.
|
// own counters are collected.
|
||||||
QueryLog bool `yaml:"query_log"`
|
QueryLog bool `yaml:"query_log"`
|
||||||
|
// RateLimitLog sends rate limiting's log lines (named's query-errors
|
||||||
|
// category) to the response log too, so the Exposure page and the
|
||||||
|
// statistics can show what was, or would be, limited.
|
||||||
|
RateLimitLog bool `yaml:"rate_limit_log"`
|
||||||
// Database is the statistics database, kept apart from Jarl's
|
// Database is the statistics database, kept apart from Jarl's
|
||||||
// configuration database.
|
// configuration database.
|
||||||
Database string `yaml:"database"`
|
Database string `yaml:"database"`
|
||||||
@@ -304,6 +395,9 @@ type StatsRetention struct {
|
|||||||
Minute Duration `yaml:"minute"`
|
Minute Duration `yaml:"minute"`
|
||||||
Hour Duration `yaml:"hour"`
|
Hour Duration `yaml:"hour"`
|
||||||
Day Duration `yaml:"day"`
|
Day Duration `yaml:"day"`
|
||||||
|
// Queries is how long the query log keeps every answer, for exploring
|
||||||
|
// (docs/stats.md#exploring); 0 keeps none.
|
||||||
|
Queries Duration `yaml:"queries"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Duration is a time.Duration written as "15s" or "12h" in YAML. Days
|
// Duration is a time.Duration written as "15s" or "12h" in YAML. Days
|
||||||
@@ -364,15 +458,17 @@ func Default() *Config {
|
|||||||
},
|
},
|
||||||
Stats: Stats{
|
Stats: Stats{
|
||||||
QueryLog: true,
|
QueryLog: true,
|
||||||
|
RateLimitLog: true,
|
||||||
Database: "/var/lib/jarl/stats.db",
|
Database: "/var/lib/jarl/stats.db",
|
||||||
StatisticsChannel: "127.0.0.1:8058",
|
StatisticsChannel: "127.0.0.1:8058",
|
||||||
LogFile: "/var/log/named/jarl-responses.log",
|
LogFile: "/var/log/named/jarl-responses.log",
|
||||||
LogSize: "20m",
|
LogSize: "20m",
|
||||||
LogVersions: 2,
|
LogVersions: 2,
|
||||||
Retention: StatsRetention{Minute: Duration(7 * 24 * time.Hour), Hour: Duration(90 * 24 * time.Hour), Day: Duration(730 * 24 * time.Hour)},
|
Retention: StatsRetention{Minute: Duration(7 * 24 * time.Hour), Hour: Duration(90 * 24 * time.Hour), Day: Duration(730 * 24 * time.Hour), Queries: Duration(7 * 24 * time.Hour)},
|
||||||
TopN: 100,
|
TopN: 100,
|
||||||
},
|
},
|
||||||
ACME: ACME{HTTPReq: HTTPReq{RequireHTTPS: true}},
|
ACME: ACME{HTTPReq: HTTPReq{RequireHTTPS: true}, Account: ACMEAccount{Directory: "letsencrypt"},
|
||||||
|
Resolvers: []string{"1.1.1.1:53", "9.9.9.9:53", "8.8.8.8:53"}, CheckPropagation: true},
|
||||||
Blocking: Blocking{Refresh: Duration(24 * time.Hour), MaxDownloadMB: 64, MaxEntries: 1_000_000},
|
Blocking: Blocking{Refresh: Duration(24 * time.Hour), MaxDownloadMB: 64, MaxEntries: 1_000_000},
|
||||||
Metrics: Metrics{Allow: []string{"127.0.0.1", "::1"}},
|
Metrics: Metrics{Allow: []string{"127.0.0.1", "::1"}},
|
||||||
Backup: Backup{Dir: "/var/backups/jarl", Retention: Duration(30 * 24 * time.Hour), KeepAtLeast: 7, WarnAfter: Duration(2 * 24 * time.Hour)},
|
Backup: Backup{Dir: "/var/backups/jarl", Retention: Duration(30 * 24 * time.Hour), KeepAtLeast: 7, WarnAfter: Duration(2 * 24 * time.Hour)},
|
||||||
@@ -449,6 +545,12 @@ func (c *Config) check() error {
|
|||||||
if err := c.Metrics.check(); err != nil {
|
if err := c.Metrics.check(); err != nil {
|
||||||
return fmt.Errorf("metrics: %w", err)
|
return fmt.Errorf("metrics: %w", err)
|
||||||
}
|
}
|
||||||
|
if err := c.ACME.check(); err != nil {
|
||||||
|
return fmt.Errorf("acme: %w", err)
|
||||||
|
}
|
||||||
|
if d := c.Certificates.Dir; d != "" && !filepath.IsAbs(d) {
|
||||||
|
return fmt.Errorf("certificates.dir must be an absolute path")
|
||||||
|
}
|
||||||
switch c.Log.Format {
|
switch c.Log.Format {
|
||||||
case "text", "json":
|
case "text", "json":
|
||||||
default:
|
default:
|
||||||
@@ -505,6 +607,9 @@ func (s *Stats) check() error {
|
|||||||
if r.Minute < Duration(time.Hour) || r.Hour < Duration(24*time.Hour) || r.Day < Duration(24*time.Hour) {
|
if r.Minute < Duration(time.Hour) || r.Hour < Duration(24*time.Hour) || r.Day < Duration(24*time.Hour) {
|
||||||
return fmt.Errorf("retention must keep minutes for at least 1h, hours and days for at least 1d")
|
return fmt.Errorf("retention must keep minutes for at least 1h, hours and days for at least 1d")
|
||||||
}
|
}
|
||||||
|
if r.Queries < 0 || (r.Queries > 0 && r.Queries < Duration(time.Hour)) {
|
||||||
|
return fmt.Errorf("retention.queries must be at least 1h, or 0 for no query log")
|
||||||
|
}
|
||||||
if s.TopN < 10 || s.TopN > 10000 {
|
if s.TopN < 10 || s.TopN > 10000 {
|
||||||
return fmt.Errorf("top_n must be between 10 and 10000")
|
return fmt.Errorf("top_n must be between 10 and 10000")
|
||||||
}
|
}
|
||||||
@@ -552,8 +657,10 @@ const Example = `# Jarl daemon configuration (/etc/jarl/jarl.yaml).
|
|||||||
listen:
|
listen:
|
||||||
- "127.0.0.1:8053"
|
- "127.0.0.1:8053"
|
||||||
|
|
||||||
# HTTPS. The certificate is reread when the file changes (or on SIGHUP),
|
# HTTPS from a certificate file you renew yourself. The certificate is
|
||||||
# so renewed Let's Encrypt certificates are picked up automatically.
|
# reread when the file changes (or on SIGHUP). Easier: let Jarl obtain one
|
||||||
|
# ('jarl cert create ... --use web', docs/certificates.md), which then
|
||||||
|
# takes over from this.
|
||||||
tls:
|
tls:
|
||||||
cert_file: ""
|
cert_file: ""
|
||||||
key_file: ""
|
key_file: ""
|
||||||
@@ -640,6 +747,10 @@ stats:
|
|||||||
# Per-query data (top names and clients, per view and zone). false
|
# Per-query data (top names and clients, per view and zone). false
|
||||||
# collects only named's own counters, with no logging overhead.
|
# collects only named's own counters, with no logging overhead.
|
||||||
query_log: true
|
query_log: true
|
||||||
|
# With a rate-limit set, also log what rate limiting limits (or would,
|
||||||
|
# in log-only mode): named's query-errors category, which Jarl then adds
|
||||||
|
# to its log channel (and keeps in syslog). The Exposure page shows it.
|
||||||
|
rate_limit_log: true
|
||||||
database: /var/lib/jarl/stats.db
|
database: /var/lib/jarl/stats.db
|
||||||
statistics_channel: 127.0.0.1:8058
|
statistics_channel: 127.0.0.1:8058
|
||||||
log_file: /var/log/named/jarl-responses.log
|
log_file: /var/log/named/jarl-responses.log
|
||||||
@@ -649,6 +760,7 @@ stats:
|
|||||||
minute: 7d # per-minute counters
|
minute: 7d # per-minute counters
|
||||||
hour: 90d # hourly counters and top lists
|
hour: 90d # hourly counters and top lists
|
||||||
day: 730d # daily counters and top lists
|
day: 730d # daily counters and top lists
|
||||||
|
queries: 7d # every answer, to explore (who asked what); 0: none
|
||||||
top_n: 100 # names and clients kept per hour and per day
|
top_n: 100 # names and clients kept per hour and per day
|
||||||
anonymize_clients: false # store 10.10.0.0/24 instead of 10.10.0.37
|
anonymize_clients: false # store 10.10.0.0/24 instead of 10.10.0.37
|
||||||
exclude_clients: [] # e.g. [127.0.0.1] to ignore local monitoring
|
exclude_clients: [] # e.g. [127.0.0.1] to ignore local monitoring
|
||||||
@@ -667,15 +779,44 @@ acme:
|
|||||||
# this server. Leave false if a reverse proxy runs on this server but
|
# this server. Leave false if a reverse proxy runs on this server but
|
||||||
# isn't in trusted_proxies: its requests would look local.
|
# isn't in trusted_proxies: its requests would look local.
|
||||||
allow_loopback_http: false
|
allow_loopback_http: false
|
||||||
|
# The account Jarl obtains certificates with (docs/certificates.md).
|
||||||
|
# Nothing is registered until you create a certificate. Read the CA's
|
||||||
|
# terms (https://letsencrypt.org/repository/) and set agree_tos: true.
|
||||||
|
# Try letsencrypt-staging first: its certificates aren't trusted, but
|
||||||
|
# its rate limits are generous.
|
||||||
|
account:
|
||||||
|
directory: letsencrypt # letsencrypt, letsencrypt-staging or a directory URL
|
||||||
|
email: "" # optional
|
||||||
|
agree_tos: false
|
||||||
|
eab_kid: "" # External Account Binding, only for CAs that need it
|
||||||
|
eab_hmac: ""
|
||||||
|
# Resolvers to see your domains as the CA does (their public name
|
||||||
|
# servers, a CNAME on _acme-challenge). Not this server: it may answer
|
||||||
|
# from an internal view.
|
||||||
|
resolvers: ["1.1.1.1:53", "9.9.9.9:53", "8.8.8.8:53"]
|
||||||
|
ca_bundle: "" # extra CA certificates for a private ACME server
|
||||||
|
# Wait until every name server of the zone serves a challenge before
|
||||||
|
# telling the CA to look (they are asked directly, on port 53).
|
||||||
|
check_propagation: true
|
||||||
|
|
||||||
# The registrar Porkbun (docs/dnssec.md#porkbun): with an API key, Jarl can
|
# Where certificates with the "dns" use are written for named, one
|
||||||
# show and set a domain's name servers, glue records and DNSSEC DS records
|
# directory per certificate (fullchain.pem, privkey.pem), readable by
|
||||||
# there, after checking that the change won't break the domain. Off without
|
# bind.file_group. Default: <bind.config_dir>/tls.
|
||||||
# a key. Create the key at porkbun.com (Account -> API Access), switch on
|
certificates:
|
||||||
# "API Access" for the domain, and limit the key to that domain if you can.
|
dir: ""
|
||||||
# The key can move your domain elsewhere: it lives only in this file (keep
|
|
||||||
# it readable by root and jarld only: chown root:jarl, chmod 640), never in
|
# Porkbun, as registrar and as DNS host. With an API key, Jarl can:
|
||||||
# Jarl's database or backups.
|
# - show and set a domain's name servers, glue records and DNSSEC DS
|
||||||
|
# records there, after checking that the change won't break the domain
|
||||||
|
# (docs/dnssec.md#porkbun);
|
||||||
|
# - publish the DNS-01 challenges of certificates Jarl obtains while
|
||||||
|
# Porkbun still serves the domain's DNS (docs/certificates.md): it adds
|
||||||
|
# and removes TXT records at _acme-challenge names only.
|
||||||
|
# Off without a key. Create the key at porkbun.com (Account -> API Access),
|
||||||
|
# switch on "API Access" for the domain, and limit the key to that domain
|
||||||
|
# if you can. The key can move your domain elsewhere: it lives only in this
|
||||||
|
# file (keep it readable by root and jarld only: chown root:jarl, chmod
|
||||||
|
# 640), never in Jarl's database or backups.
|
||||||
porkbun:
|
porkbun:
|
||||||
api_key: "" # pk1_...
|
api_key: "" # pk1_...
|
||||||
secret_api_key: "" # sk1_...
|
secret_api_key: "" # sk1_...
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ package config
|
|||||||
import (
|
import (
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"reflect"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
@@ -18,7 +19,7 @@ func TestExampleParses(t *testing.T) {
|
|||||||
if c.BIND.ZoneDir != d.BIND.ZoneDir || time.Duration(c.Session.IdleTimeout) != 2*time.Hour || c.Listen[0] != "127.0.0.1:8053" {
|
if c.BIND.ZoneDir != d.BIND.ZoneDir || time.Duration(c.Session.IdleTimeout) != 2*time.Hour || c.Listen[0] != "127.0.0.1:8053" {
|
||||||
t.Errorf("example differs from defaults: %+v", c)
|
t.Errorf("example differs from defaults: %+v", c)
|
||||||
}
|
}
|
||||||
if c.ACME != d.ACME || c.ACME.HTTPReq.Enabled || !c.ACME.HTTPReq.RequireHTTPS {
|
if !reflect.DeepEqual(c.ACME, d.ACME) || !reflect.DeepEqual(c.Certificates, d.Certificates) || c.ACME.HTTPReq.Enabled || !c.ACME.HTTPReq.RequireHTTPS {
|
||||||
t.Errorf("acme = %+v, want the defaults %+v", c.ACME, d.ACME)
|
t.Errorf("acme = %+v, want the defaults %+v", c.ACME, d.ACME)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -469,3 +469,47 @@ func BestZone(name string, zones []string) string {
|
|||||||
}
|
}
|
||||||
return best
|
return best
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// PrefixFromReverse returns the network a reverse zone answers for:
|
||||||
|
// 10.0.10.in-addr.arpa. is 10.0.10.0/24, a /32 zone a single address, and
|
||||||
|
// an ip6.arpa zone of 12 nibbles a /48. False for names that aren't whole
|
||||||
|
// octets or nibbles (classless delegations such as 0-63.1.0.10.in-addr.arpa.).
|
||||||
|
func PrefixFromReverse(zone string) (netip.Prefix, bool) {
|
||||||
|
zone = strings.ToLower(Fqdn(zone))
|
||||||
|
switch {
|
||||||
|
case strings.HasSuffix(zone, ".in-addr.arpa."):
|
||||||
|
labels := strings.Split(strings.TrimSuffix(zone, ".in-addr.arpa."), ".")
|
||||||
|
if len(labels) > 4 {
|
||||||
|
return netip.Prefix{}, false
|
||||||
|
}
|
||||||
|
var b [4]byte
|
||||||
|
for i, l := range labels {
|
||||||
|
v, err := strconv.Atoi(l)
|
||||||
|
if err != nil || v < 0 || v > 255 || strconv.Itoa(v) != l {
|
||||||
|
return netip.Prefix{}, false
|
||||||
|
}
|
||||||
|
b[len(labels)-1-i] = byte(v)
|
||||||
|
}
|
||||||
|
return netip.PrefixFrom(netip.AddrFrom4(b), 8*len(labels)), true
|
||||||
|
case strings.HasSuffix(zone, ".ip6.arpa."):
|
||||||
|
labels := strings.Split(strings.TrimSuffix(zone, ".ip6.arpa."), ".")
|
||||||
|
if len(labels) > 32 {
|
||||||
|
return netip.Prefix{}, false
|
||||||
|
}
|
||||||
|
var b [16]byte
|
||||||
|
for i, l := range labels {
|
||||||
|
v := strings.IndexByte("0123456789abcdef", l[0])
|
||||||
|
if len(l) != 1 || v < 0 {
|
||||||
|
return netip.Prefix{}, false
|
||||||
|
}
|
||||||
|
n := len(labels) - 1 - i // nibble position from the left
|
||||||
|
if n%2 == 0 {
|
||||||
|
b[n/2] |= byte(v) << 4
|
||||||
|
} else {
|
||||||
|
b[n/2] |= byte(v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return netip.PrefixFrom(netip.AddrFrom16(b), 4*len(labels)), true
|
||||||
|
}
|
||||||
|
return netip.Prefix{}, false
|
||||||
|
}
|
||||||
@@ -217,3 +217,35 @@ func TestReverseZones(t *testing.T) {
|
|||||||
t.Errorf("ReverseZone /22: %v", err)
|
t.Errorf("ReverseZone /22: %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestPrefixFromReverse(t *testing.T) {
|
||||||
|
for zone, want := range map[string]string{
|
||||||
|
"10.0.10.in-addr.arpa.": "10.0.10.0/24",
|
||||||
|
"10.in-addr.arpa": "10.0.0.0/8",
|
||||||
|
"154.144.144.139.in-addr.arpa.": "139.144.144.154/32",
|
||||||
|
"d.3.f.7.3.1.0.8.2.0.a.2.ip6.arpa.": "2a02:8013:7f3d::/48",
|
||||||
|
"b.a.b.a.b.a.b.a.b.a.d.f.ip6.arpa.": "fdab:abab:abab::/48",
|
||||||
|
"0-63.1.0.10.in-addr.arpa.": "",
|
||||||
|
"example.com.": "",
|
||||||
|
"256.10.in-addr.arpa.": "",
|
||||||
|
} {
|
||||||
|
p, ok := PrefixFromReverse(zone)
|
||||||
|
got := ""
|
||||||
|
if ok {
|
||||||
|
got = p.String()
|
||||||
|
}
|
||||||
|
if got != want {
|
||||||
|
t.Errorf("PrefixFromReverse(%q) = %q, want %q", zone, got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Round trip with ReverseZone.
|
||||||
|
for _, s := range []string{"192.168.1.0/24", "2a02:8013:7f3d::/48", "fd00::/8", "10.0.0.5/32"} {
|
||||||
|
z, err := ReverseZone(netip.MustParsePrefix(s))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if p, ok := PrefixFromReverse(z); !ok || p.String() != s {
|
||||||
|
t.Errorf("%s -> %s -> %v", s, z, p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,559 @@
|
|||||||
|
// Package encdns sets up DNS over TLS (DoT) and DNS over HTTPS (DoH) in
|
||||||
|
// named (docs/encrypted-dns.md): a tls statement naming a certificate Jarl
|
||||||
|
// manages, and listen-on statements for port 853 (DoT) and the DoH port.
|
||||||
|
// Its state is read from named's configuration, so what the setup stages
|
||||||
|
// stays ordinary, visible configuration.
|
||||||
|
package encdns
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net/netip"
|
||||||
|
"path/filepath"
|
||||||
|
"slices"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"jarl/internal/engine"
|
||||||
|
"jarl/internal/model"
|
||||||
|
"jarl/internal/namedconf"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Prefix starts the names of the tls statements the setup writes.
|
||||||
|
const Prefix = "jarl-"
|
||||||
|
|
||||||
|
// DoTPort is the port for DNS over TLS (RFC 7858).
|
||||||
|
const DoTPort = 853
|
||||||
|
|
||||||
|
// Listener is a listen-on or listen-on-v6 statement.
|
||||||
|
type Listener struct {
|
||||||
|
OptionID int64 `json:"option_id"`
|
||||||
|
V6 bool `json:"v6"`
|
||||||
|
Port int `json:"port"` // as written; 0 when it isn't
|
||||||
|
TLS string `json:"tls,omitempty"` // tls statement ("" for plain DNS)
|
||||||
|
HTTP string `json:"http,omitempty"` // http endpoints: DNS over HTTPS
|
||||||
|
Addrs []string `json:"addresses"` // the address match list
|
||||||
|
}
|
||||||
|
|
||||||
|
// EffectivePort is the port named listens on: as written, or its
|
||||||
|
// default for the kind of listener.
|
||||||
|
func (l Listener) EffectivePort() int {
|
||||||
|
switch {
|
||||||
|
case l.Port != 0:
|
||||||
|
return l.Port
|
||||||
|
case l.HTTP != "" && l.TLS != "" && l.TLS != "none":
|
||||||
|
return 443
|
||||||
|
case l.HTTP != "":
|
||||||
|
return 80
|
||||||
|
case l.TLS != "":
|
||||||
|
return DoTPort
|
||||||
|
}
|
||||||
|
return 53
|
||||||
|
}
|
||||||
|
|
||||||
|
// Kind is plain, dot or doh.
|
||||||
|
func (l Listener) Kind() string {
|
||||||
|
switch {
|
||||||
|
case l.HTTP != "":
|
||||||
|
return "doh"
|
||||||
|
case l.TLS != "" && l.TLS != "none":
|
||||||
|
return "dot"
|
||||||
|
}
|
||||||
|
return "plain"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Managed reports whether the setup wrote the listener.
|
||||||
|
func (l Listener) Managed() bool { return strings.HasPrefix(l.TLS, Prefix) }
|
||||||
|
|
||||||
|
// Listeners returns the server's listen-on and listen-on-v6 statements.
|
||||||
|
func Listeners(st *model.State) []Listener {
|
||||||
|
var out []Listener
|
||||||
|
for _, o := range st.ScopedOptions(model.ScopeOptions, 0) {
|
||||||
|
if o.Name != "listen-on" && o.Name != "listen-on-v6" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
l, err := parseListener(o.Name, o.Value)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
l.OptionID, l.V6 = o.ID, o.Name == "listen-on-v6"
|
||||||
|
out = append(out, l)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseListener(name, value string) (Listener, error) {
|
||||||
|
var l Listener
|
||||||
|
stmt, err := namedconf.ParseOptionValue(name, value)
|
||||||
|
if err != nil {
|
||||||
|
return l, err
|
||||||
|
}
|
||||||
|
items := stmt.Items[1:]
|
||||||
|
for i := 0; i < len(items); i++ {
|
||||||
|
it := items[i]
|
||||||
|
if it.Block != nil {
|
||||||
|
for _, s := range it.Block.Stmts {
|
||||||
|
l.Addrs = append(l.Addrs, namedconf.Compact(s.Items))
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if it.Value == nil || i+1 >= len(items) || items[i+1].Value == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
arg := items[i+1].Value.Text
|
||||||
|
switch strings.ToLower(it.Value.Text) {
|
||||||
|
case "port":
|
||||||
|
l.Port, _ = strconv.Atoi(arg)
|
||||||
|
case "tls":
|
||||||
|
l.TLS = arg
|
||||||
|
case "http":
|
||||||
|
l.HTTP = arg
|
||||||
|
}
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
return l, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// TLSBlock is a top-level tls statement.
|
||||||
|
type TLSBlock struct {
|
||||||
|
OptionID int64 `json:"option_id"`
|
||||||
|
Name string `json:"name"`
|
||||||
|
CertFile string `json:"cert_file"`
|
||||||
|
KeyFile string `json:"key_file"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// TLSBlocks returns the top-level tls statements.
|
||||||
|
func TLSBlocks(st *model.State) []TLSBlock {
|
||||||
|
var out []TLSBlock
|
||||||
|
for _, o := range st.ScopedOptions(model.ScopeTopLevel, 0) {
|
||||||
|
if o.Name != "tls" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
stmt, err := namedconf.ParseOptionValue("tls", o.Value)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
b := TLSBlock{OptionID: o.ID, Name: stmt.Arg(0)}
|
||||||
|
if blk := stmt.FirstBlock(); blk != nil {
|
||||||
|
for _, s := range blk.Stmts {
|
||||||
|
switch s.Keyword() {
|
||||||
|
case "cert-file":
|
||||||
|
b.CertFile = s.Arg(0)
|
||||||
|
case "key-file":
|
||||||
|
b.KeyFile = s.Arg(0)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out = append(out, b)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// Endpoint is an address and port named serves DoT or DoH on.
|
||||||
|
type Endpoint struct {
|
||||||
|
Address string `json:"address"`
|
||||||
|
Port int `json:"port"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Status is what is set up.
|
||||||
|
type Status struct {
|
||||||
|
Enabled bool `json:"enabled"`
|
||||||
|
// TLS is the tls statement the setup wrote, and Certificate the
|
||||||
|
// certificate it names (a Jarl certificate's name, when it is one).
|
||||||
|
TLS *TLSBlock `json:"tls,omitempty"`
|
||||||
|
Certificate string `json:"certificate,omitempty"`
|
||||||
|
DoT []Endpoint `json:"dot"`
|
||||||
|
DoH []Endpoint `json:"doh"`
|
||||||
|
// Listeners are all listen-on statements, the setup's and others.
|
||||||
|
Listeners []Listener `json:"listeners"`
|
||||||
|
// Other are DoT or DoH listeners written by hand.
|
||||||
|
Other bool `json:"other,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetStatus reads the setup from the configuration. certDir is where Jarl
|
||||||
|
// writes certificates for named (certificates.dir).
|
||||||
|
func GetStatus(st *model.State, certDir string) Status {
|
||||||
|
s := Status{Listeners: Listeners(st), DoT: []Endpoint{}, DoH: []Endpoint{}}
|
||||||
|
if s.Listeners == nil {
|
||||||
|
s.Listeners = []Listener{}
|
||||||
|
}
|
||||||
|
for _, b := range TLSBlocks(st) {
|
||||||
|
if strings.HasPrefix(b.Name, Prefix) {
|
||||||
|
b := b
|
||||||
|
s.TLS = &b
|
||||||
|
if dir := filepath.Dir(b.CertFile); filepath.Dir(dir) == filepath.Clean(certDir) {
|
||||||
|
s.Certificate = filepath.Base(dir)
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, l := range s.Listeners {
|
||||||
|
if l.Kind() == "plain" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !l.Managed() {
|
||||||
|
s.Other = true
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, a := range l.Addrs {
|
||||||
|
e := Endpoint{Address: a, Port: l.EffectivePort()}
|
||||||
|
if l.Kind() == "doh" {
|
||||||
|
s.DoH = append(s.DoH, e)
|
||||||
|
} else {
|
||||||
|
s.DoT = append(s.DoT, e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
s.Enabled = len(s.DoT)+len(s.DoH) > 0
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// Setup is what to set up.
|
||||||
|
type Setup struct {
|
||||||
|
// Hostnames are the names clients connect to; the certificate must be
|
||||||
|
// for all of them. Hostname (one) works too.
|
||||||
|
Hostnames []string `json:"hostnames,omitempty"`
|
||||||
|
Hostname string `json:"hostname,omitempty"`
|
||||||
|
// Certificate is the Jarl certificate (with the dns use) to serve.
|
||||||
|
Certificate string `json:"certificate"`
|
||||||
|
// Addresses are the addresses of this server to listen on.
|
||||||
|
Addresses []string `json:"addresses"`
|
||||||
|
DoT bool `json:"dot"`
|
||||||
|
DoH bool `json:"doh"`
|
||||||
|
DoHPort int `json:"doh_port"` // default 443
|
||||||
|
DoTPort int `json:"dot_port"` // default 853 (clients expect it)
|
||||||
|
// AddressViews says, per listen address, the views where the host
|
||||||
|
// names get it (A or AAAA): a private address shouldn't reach a public
|
||||||
|
// view. Views (every address in each) works too. The records are local
|
||||||
|
// to their view in a linked zone.
|
||||||
|
AddressViews map[string][]string `json:"address_views,omitempty"`
|
||||||
|
Views []string `json:"views,omitempty"`
|
||||||
|
// PublicViews are the views the internet reaches (filled in by jarld,
|
||||||
|
// for a warning).
|
||||||
|
PublicViews map[string]bool `json:"-"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Hosts returns the setup's host names, normalized, the first first.
|
||||||
|
func (s Setup) Hosts() []string {
|
||||||
|
var out []string
|
||||||
|
for _, h := range append(append([]string{}, s.Hostnames...), s.Hostname) {
|
||||||
|
h = strings.ToLower(strings.TrimSuffix(strings.TrimSpace(h), "."))
|
||||||
|
if h != "" && !slices.Contains(out, h) {
|
||||||
|
out = append(out, h)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// Plan returns the requests that set up encrypted DNS as s says,
|
||||||
|
// replacing an earlier setup, and notes for the user. certDir is where
|
||||||
|
// the certificate's files are.
|
||||||
|
func Plan(st *model.State, s Setup, certDir string) ([]engine.Request, []string, error) {
|
||||||
|
var notes []string
|
||||||
|
if !s.DoT && !s.DoH {
|
||||||
|
return nil, nil, fmt.Errorf("choose DNS over TLS, DNS over HTTPS or both")
|
||||||
|
}
|
||||||
|
if s.DoHPort == 0 {
|
||||||
|
s.DoHPort = 443
|
||||||
|
}
|
||||||
|
if s.DoTPort == 0 {
|
||||||
|
s.DoTPort = DoTPort
|
||||||
|
}
|
||||||
|
for _, p := range []int{s.DoHPort, s.DoTPort} {
|
||||||
|
if p < 1 || p > 65535 || p == 53 {
|
||||||
|
return nil, nil, fmt.Errorf("port %d: use a free port other than 53", p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if s.DoT && s.DoH && s.DoHPort == s.DoTPort {
|
||||||
|
return nil, nil, fmt.Errorf("DoT and DoH need different ports (both are %d)", s.DoHPort)
|
||||||
|
}
|
||||||
|
if s.Certificate == "" {
|
||||||
|
return nil, nil, fmt.Errorf("choose the certificate to serve")
|
||||||
|
}
|
||||||
|
hosts := s.Hosts()
|
||||||
|
if len(hosts) == 0 {
|
||||||
|
return nil, nil, fmt.Errorf("give the host name clients connect to, e.g. dns.example.com")
|
||||||
|
}
|
||||||
|
for _, host := range hosts {
|
||||||
|
if !strings.Contains(host, ".") || strings.HasPrefix(host, "*") {
|
||||||
|
return nil, nil, fmt.Errorf("%q isn't a host name clients can connect to, e.g. dns.example.com", host)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var v4, v6 []string
|
||||||
|
for _, a := range s.Addresses {
|
||||||
|
ip, err := netip.ParseAddr(strings.TrimSpace(a))
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, fmt.Errorf("%q isn't an address of this server", a)
|
||||||
|
}
|
||||||
|
ip = ip.Unmap()
|
||||||
|
if ip.IsUnspecified() {
|
||||||
|
return nil, nil, fmt.Errorf("listen on this server's addresses, not on %s (that would include public ones)", ip)
|
||||||
|
}
|
||||||
|
if ip.Is4() {
|
||||||
|
v4 = append(v4, ip.String())
|
||||||
|
} else {
|
||||||
|
v6 = append(v6, ip.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(v4)+len(v6) == 0 {
|
||||||
|
return nil, nil, fmt.Errorf("choose at least one address to listen on")
|
||||||
|
}
|
||||||
|
tlsName := Prefix + s.Certificate
|
||||||
|
tlsValue := TLSValue(s.Certificate, certDir)
|
||||||
|
|
||||||
|
var reqs []engine.Request
|
||||||
|
// Take out the earlier setup's listeners and tls statements.
|
||||||
|
current := Listeners(st)
|
||||||
|
for _, l := range current {
|
||||||
|
if l.Managed() {
|
||||||
|
reqs = append(reqs, engine.NewRequest(engine.OpOptionDelete, l.OptionID, nil))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
haveTLS := false
|
||||||
|
for _, b := range TLSBlocks(st) {
|
||||||
|
switch {
|
||||||
|
case b.Name == tlsName:
|
||||||
|
haveTLS = true
|
||||||
|
reqs = append(reqs, engine.NewRequest(engine.OpOptionUpdate, b.OptionID, engine.OptionInput{Value: model.Ptr(tlsValue)}))
|
||||||
|
case strings.HasPrefix(b.Name, Prefix):
|
||||||
|
reqs = append(reqs, engine.NewRequest(engine.OpOptionDelete, b.OptionID, nil))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !haveTLS {
|
||||||
|
reqs = append(reqs, option(model.ScopeTopLevel, "tls", tlsValue))
|
||||||
|
}
|
||||||
|
// named listens on port 53 everywhere only while there is no
|
||||||
|
// listen-on statement at all: adding the first one for DoT would end
|
||||||
|
// that, so keep it explicitly.
|
||||||
|
plain := func(v6 bool) bool {
|
||||||
|
for _, l := range current {
|
||||||
|
if l.V6 == v6 && !l.Managed() && l.Kind() == "plain" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
add := func(name string, addrs []string) {
|
||||||
|
if len(addrs) == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
list := "{ " + strings.Join(addrs, "; ") + "; }"
|
||||||
|
if !plain(name == "listen-on-v6") {
|
||||||
|
reqs = append(reqs, option(model.ScopeOptions, name, "{ any; }"))
|
||||||
|
notes = append(notes, fmt.Sprintf("named listened on port 53 on every address by default; %s { any; } keeps that, as the first %s statement would otherwise end it", name, name))
|
||||||
|
}
|
||||||
|
if s.DoT {
|
||||||
|
reqs = append(reqs, option(model.ScopeOptions, name, fmt.Sprintf("port %d tls %s %s", s.DoTPort, tlsName, list)))
|
||||||
|
}
|
||||||
|
if s.DoH {
|
||||||
|
reqs = append(reqs, option(model.ScopeOptions, name, fmt.Sprintf("port %d tls %s http default %s", s.DoHPort, tlsName, list)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
add("listen-on", v4)
|
||||||
|
add("listen-on-v6", v6)
|
||||||
|
|
||||||
|
// The host names' addresses, in the views asked for, per address.
|
||||||
|
want := map[string][]string{} // view -> addresses
|
||||||
|
all := append(append([]string{}, v4...), v6...)
|
||||||
|
if s.AddressViews != nil {
|
||||||
|
for a, vs := range s.AddressViews {
|
||||||
|
ip, err := netip.ParseAddr(strings.TrimSpace(a))
|
||||||
|
if err != nil || !slices.Contains(all, ip.Unmap().String()) {
|
||||||
|
return nil, nil, fmt.Errorf("address_views: %s isn't one of the addresses to listen on", a)
|
||||||
|
}
|
||||||
|
for _, vn := range vs {
|
||||||
|
want[vn] = append(want[vn], ip.Unmap().String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
for _, vn := range s.Views {
|
||||||
|
want[vn] = all
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for vn, addrs := range want {
|
||||||
|
if st.ViewByName(vn) == nil {
|
||||||
|
return nil, nil, fmt.Errorf("view %q does not exist", vn)
|
||||||
|
}
|
||||||
|
if s.PublicViews[vn] {
|
||||||
|
for _, a := range addrs {
|
||||||
|
if ip, err := netip.ParseAddr(a); err == nil && Private(ip) {
|
||||||
|
notes = append(notes, fmt.Sprintf("view %s is reachable from the internet, but gets the private address %s for %s: its clients can't reach that", vn, a, strings.Join(hosts, ", ")))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Ours are the addresses this setup (or the one before) gives the host
|
||||||
|
// names: a view that no longer gets one loses it; other records of the
|
||||||
|
// names stay.
|
||||||
|
ours := map[string]bool{}
|
||||||
|
for _, a := range all {
|
||||||
|
ours[a] = true
|
||||||
|
}
|
||||||
|
for _, l := range current {
|
||||||
|
if l.Managed() {
|
||||||
|
for _, a := range l.Addrs {
|
||||||
|
ours[a] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
names := slices.Clone(hosts)
|
||||||
|
for _, h := range st.Settings.EncryptedDNSHosts {
|
||||||
|
if !slices.Contains(names, h) {
|
||||||
|
names = append(names, h)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, v := range st.OrderedViews() {
|
||||||
|
for _, host := range names {
|
||||||
|
fqdn := host + "."
|
||||||
|
z := zoneFor(st, fqdn, v.ID)
|
||||||
|
wanted := want[v.Name]
|
||||||
|
if !slices.Contains(hosts, host) {
|
||||||
|
wanted = nil // a host name no longer used
|
||||||
|
}
|
||||||
|
if z == nil {
|
||||||
|
if len(wanted) > 0 {
|
||||||
|
notes = append(notes, fmt.Sprintf("view %s has no zone for %s, so no address records were added there; clients must find it some other way", v.Name, host))
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, typ := range []string{"A", "AAAA"} {
|
||||||
|
var have, next []string
|
||||||
|
for _, r := range st.RRset(z.ID, fqdn, typ) {
|
||||||
|
have = append(have, r.Data)
|
||||||
|
if !ours[r.Data] {
|
||||||
|
next = append(next, r.Data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, a := range wanted {
|
||||||
|
if strings.Contains(a, ":") == (typ == "AAAA") && !slices.Contains(next, a) {
|
||||||
|
next = append(next, a)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
slices.Sort(have)
|
||||||
|
slices.Sort(next)
|
||||||
|
if slices.Equal(have, next) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if next == nil {
|
||||||
|
next = []string{}
|
||||||
|
}
|
||||||
|
reqs = append(reqs, engine.NewRequest(engine.OpRRSetReplace, 0, engine.RRSetInput{ZoneID: z.ID, Name: fqdn, Type: typ, Data: next, Local: model.Ptr(true)}))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !slices.Equal(st.Settings.EncryptedDNSHosts, hosts) {
|
||||||
|
reqs = append(reqs, engine.NewRequest(engine.OpSettingsUpdate, 0, engine.SettingsInput{EncryptedDNSHosts: &hosts}))
|
||||||
|
}
|
||||||
|
return reqs, notes, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func option(scope, name, value string) engine.Request {
|
||||||
|
return engine.NewRequest(engine.OpOptionCreate, 0, engine.OptionInput{Scope: model.Ptr(scope), Name: model.Ptr(name), Value: model.Ptr(value)})
|
||||||
|
}
|
||||||
|
|
||||||
|
// zoneFor returns the primary zone in a view that holds name.
|
||||||
|
func zoneFor(st *model.State, name string, viewID int64) *model.Zone {
|
||||||
|
var best *model.Zone
|
||||||
|
for _, z := range st.ZonesInView(viewID) {
|
||||||
|
if z.Type == model.ZonePrimary && (name == z.Name || strings.HasSuffix(name, "."+z.Name)) && (best == nil || len(z.Name) > len(best.Name)) {
|
||||||
|
best = z
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return best
|
||||||
|
}
|
||||||
|
|
||||||
|
// CurrentAddressViews returns, per address, the views whose records give
|
||||||
|
// one of the host names that address (what the setup form starts from).
|
||||||
|
func CurrentAddressViews(st *model.State, hosts []string) map[string][]string {
|
||||||
|
out := map[string][]string{}
|
||||||
|
for _, v := range st.OrderedViews() {
|
||||||
|
for _, host := range hosts {
|
||||||
|
fqdn := strings.TrimSuffix(host, ".") + "."
|
||||||
|
z := zoneFor(st, fqdn, v.ID)
|
||||||
|
if z == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, typ := range []string{"A", "AAAA"} {
|
||||||
|
for _, r := range st.RRset(z.ID, fqdn, typ) {
|
||||||
|
if !r.Disabled && !slices.Contains(out[r.Data], v.Name) {
|
||||||
|
out[r.Data] = append(out[r.Data], v.Name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// CertUses says what of named's configuration uses the certificate whose
|
||||||
|
// files are in dir: "DNS over TLS on 10.0.10.5, fd00::5 port 853", or the
|
||||||
|
// tls statement alone when no listener uses it.
|
||||||
|
func CertUses(st *model.State, dir string) []string {
|
||||||
|
var out []string
|
||||||
|
for _, b := range TLSBlocks(st) {
|
||||||
|
if filepath.Dir(b.CertFile) != filepath.Clean(dir) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
used := false
|
||||||
|
byKind := map[string]map[int][]string{}
|
||||||
|
for _, l := range Listeners(st) {
|
||||||
|
if l.TLS != b.Name {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
used = true
|
||||||
|
k := l.Kind()
|
||||||
|
if byKind[k] == nil {
|
||||||
|
byKind[k] = map[int][]string{}
|
||||||
|
}
|
||||||
|
byKind[k][l.EffectivePort()] = append(byKind[k][l.EffectivePort()], l.Addrs...)
|
||||||
|
}
|
||||||
|
for _, k := range []string{"dot", "doh"} {
|
||||||
|
label := map[string]string{"dot": "DNS over TLS", "doh": "DNS over HTTPS"}[k]
|
||||||
|
ports := make([]int, 0, len(byKind[k]))
|
||||||
|
for p := range byKind[k] {
|
||||||
|
ports = append(ports, p)
|
||||||
|
}
|
||||||
|
slices.Sort(ports)
|
||||||
|
for _, p := range ports {
|
||||||
|
out = append(out, fmt.Sprintf("%s on %s port %d", label, strings.Join(byKind[k][p], ", "), p))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !used {
|
||||||
|
out = append(out, "tls statement "+b.Name+" (no listener uses it)")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// Disable returns the requests that take the setup out: its listeners and
|
||||||
|
// tls statement. Plain listeners and the host name's records stay.
|
||||||
|
func Disable(st *model.State) []engine.Request {
|
||||||
|
var reqs []engine.Request
|
||||||
|
for _, l := range Listeners(st) {
|
||||||
|
if l.Managed() {
|
||||||
|
reqs = append(reqs, engine.NewRequest(engine.OpOptionDelete, l.OptionID, nil))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, b := range TLSBlocks(st) {
|
||||||
|
if strings.HasPrefix(b.Name, Prefix) {
|
||||||
|
reqs = append(reqs, engine.NewRequest(engine.OpOptionDelete, b.OptionID, nil))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(reqs) > 0 && len(st.Settings.EncryptedDNSHosts) > 0 {
|
||||||
|
reqs = append(reqs, engine.NewRequest(engine.OpSettingsUpdate, 0, engine.SettingsInput{EncryptedDNSHosts: &[]string{}}))
|
||||||
|
}
|
||||||
|
return reqs
|
||||||
|
}
|
||||||
|
|
||||||
|
// Private reports whether an address is private (RFC 1918, ULA, ...).
|
||||||
|
func Private(a netip.Addr) bool {
|
||||||
|
a = a.Unmap()
|
||||||
|
return a.IsPrivate() || a.IsLoopback() || a.IsLinkLocalUnicast() || netip.MustParsePrefix("100.64.0.0/10").Contains(a)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TLSValue is the tls statement the setup writes for a certificate whose
|
||||||
|
// files are in certDir/NAME.
|
||||||
|
func TLSValue(cert, certDir string) string {
|
||||||
|
dir := filepath.Join(certDir, cert)
|
||||||
|
return fmt.Sprintf(`%s { cert-file "%s"; key-file "%s"; protocols { TLSv1.2; TLSv1.3; }; }`,
|
||||||
|
Prefix+cert, filepath.Join(dir, "fullchain.pem"), filepath.Join(dir, "privkey.pem"))
|
||||||
|
}
|
||||||
@@ -0,0 +1,255 @@
|
|||||||
|
package encdns
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"io"
|
||||||
|
"log/slog"
|
||||||
|
"net/netip"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"jarl/internal/auth"
|
||||||
|
"jarl/internal/engine"
|
||||||
|
"jarl/internal/model"
|
||||||
|
"jarl/internal/render"
|
||||||
|
"jarl/internal/store"
|
||||||
|
)
|
||||||
|
|
||||||
|
type env struct {
|
||||||
|
t *testing.T
|
||||||
|
eng *engine.Engine
|
||||||
|
st *store.Store
|
||||||
|
certDir string
|
||||||
|
}
|
||||||
|
|
||||||
|
func newEnv(t *testing.T) *env {
|
||||||
|
dir := t.TempDir()
|
||||||
|
st, err := store.Open(filepath.Join(dir, "jarl.db"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
t.Cleanup(func() { st.Close() })
|
||||||
|
eng := engine.New(st, nil, engine.Config{
|
||||||
|
Paths: render.Paths{ConfigDir: filepath.Join(dir, "etc"), ZoneDir: filepath.Join(dir, "zones"), CacheDir: filepath.Join(dir, "cache")},
|
||||||
|
StagingDir: filepath.Join(dir, "staging"), NoReload: true, SkipCheck: true,
|
||||||
|
}, slog.New(slog.NewTextHandler(io.Discard, nil)))
|
||||||
|
e := &env{t: t, eng: eng, st: st, certDir: filepath.Join(dir, "tls")}
|
||||||
|
os.MkdirAll(filepath.Join(e.certDir, "dns"), 0o755)
|
||||||
|
os.WriteFile(filepath.Join(e.certDir, "dns", "fullchain.pem"), []byte("x"), 0o644)
|
||||||
|
os.WriteFile(filepath.Join(e.certDir, "dns", "privkey.pem"), []byte("x"), 0o600)
|
||||||
|
e.submit(engine.NewRequest(engine.OpSettingsUpdate, 0, engine.SettingsInput{Nameservers: &[]string{"ns1.example.net."}}),
|
||||||
|
engine.NewRequest(engine.OpViewCreate, 0, engine.ViewInput{Name: model.Ptr("internal"), MatchClients: &[]string{"10.0.0.0/8"}}),
|
||||||
|
engine.NewRequest(engine.OpViewCreate, 0, engine.ViewInput{Name: model.Ptr("external"), MatchClients: &[]string{"any"}}))
|
||||||
|
e.submit(engine.NewRequest(engine.OpZoneCreate, 0, engine.ZoneInput{Name: model.Ptr("example.com"), View: model.Ptr("internal")}))
|
||||||
|
return e
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *env) submit(reqs ...engine.Request) *engine.Result {
|
||||||
|
e.t.Helper()
|
||||||
|
res, err := e.eng.Submit(context.Background(), reqs, auth.System, "test", "", engine.ApplyOptions{})
|
||||||
|
if err != nil {
|
||||||
|
e.t.Fatalf("%v (%+v)", err, res)
|
||||||
|
}
|
||||||
|
return res
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *env) state() *model.State {
|
||||||
|
st, err := e.st.LoadState(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
e.t.Fatal(err)
|
||||||
|
}
|
||||||
|
return st
|
||||||
|
}
|
||||||
|
|
||||||
|
func values(st *model.State, scope, name string) []string {
|
||||||
|
var out []string
|
||||||
|
for _, o := range st.ScopedOptions(scope, 0) {
|
||||||
|
if o.Name == name {
|
||||||
|
out = append(out, o.Value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetup(t *testing.T) {
|
||||||
|
e := newEnv(t)
|
||||||
|
setup := Setup{Hostname: "dns.example.com", Certificate: "dns", Addresses: []string{"10.0.10.5", "2001:db8::5"}, DoT: true, DoH: true, Views: []string{"internal", "external"}}
|
||||||
|
reqs, notes, err := Plan(e.state(), setup, e.certDir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
e.submit(reqs...)
|
||||||
|
st := e.state()
|
||||||
|
tls := values(st, model.ScopeTopLevel, "tls")
|
||||||
|
if len(tls) != 1 || !strings.HasPrefix(tls[0], "jarl-dns {") || !strings.Contains(tls[0], filepath.Join(e.certDir, "dns", "fullchain.pem")) {
|
||||||
|
t.Errorf("tls = %q", tls)
|
||||||
|
}
|
||||||
|
// The plain listeners named had by default are kept explicitly.
|
||||||
|
want4 := []string{"{ any; }", "port 853 tls jarl-dns { 10.0.10.5; }", "port 443 tls jarl-dns http default { 10.0.10.5; }"}
|
||||||
|
if got := values(st, model.ScopeOptions, "listen-on"); !slices.Equal(got, want4) {
|
||||||
|
t.Errorf("listen-on = %q, want %q", got, want4)
|
||||||
|
}
|
||||||
|
if got := values(st, model.ScopeOptions, "listen-on-v6"); len(got) != 3 || got[0] != "{ any; }" {
|
||||||
|
t.Errorf("listen-on-v6 = %q", got)
|
||||||
|
}
|
||||||
|
if len(notes) != 3 || !strings.Contains(strings.Join(notes, " "), "external has no zone") {
|
||||||
|
t.Errorf("notes = %q", notes)
|
||||||
|
}
|
||||||
|
// The host name's addresses in the internal view.
|
||||||
|
z := st.FindZone("example.com.", st.ViewByName("internal").ID)
|
||||||
|
var addrs []string
|
||||||
|
for _, r := range st.ZoneRecords(z.ID) {
|
||||||
|
if r.Name == "dns.example.com." {
|
||||||
|
addrs = append(addrs, r.Type+" "+r.Data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !slices.Equal(addrs, []string{"A 10.0.10.5", "AAAA 2001:db8::5"}) {
|
||||||
|
t.Errorf("records = %q", addrs)
|
||||||
|
}
|
||||||
|
s := GetStatus(st, e.certDir)
|
||||||
|
if !s.Enabled || s.Certificate != "dns" || len(s.DoT) != 2 || len(s.DoH) != 2 || s.DoH[0].Port != 443 || s.Other {
|
||||||
|
t.Errorf("status = %+v", s)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Setting up again replaces the setup: DoT only, one address, and the
|
||||||
|
// plain listeners aren't doubled.
|
||||||
|
reqs, _, err = Plan(st, Setup{Hostname: "dns.example.com", Certificate: "dns", Addresses: []string{"10.0.10.5"}, DoT: true}, e.certDir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
e.submit(reqs...)
|
||||||
|
st = e.state()
|
||||||
|
if got := values(st, model.ScopeOptions, "listen-on"); !slices.Equal(got, []string{"{ any; }", "port 853 tls jarl-dns { 10.0.10.5; }"}) {
|
||||||
|
t.Errorf("after the second setup: %q", got)
|
||||||
|
}
|
||||||
|
if got := values(st, model.ScopeOptions, "listen-on-v6"); !slices.Equal(got, []string{"{ any; }"}) {
|
||||||
|
t.Errorf("listen-on-v6 after the second setup: %q", got)
|
||||||
|
}
|
||||||
|
if got := values(st, model.ScopeTopLevel, "tls"); len(got) != 1 {
|
||||||
|
t.Errorf("tls statements: %q", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Off: the setup's listeners and tls statement go, the rest stays.
|
||||||
|
e.submit(Disable(st)...)
|
||||||
|
st = e.state()
|
||||||
|
if got := values(st, model.ScopeOptions, "listen-on"); !slices.Equal(got, []string{"{ any; }"}) || len(values(st, model.ScopeTopLevel, "tls")) != 0 || GetStatus(st, e.certDir).Enabled {
|
||||||
|
t.Errorf("after disabling: listen-on %q tls %q", got, values(st, model.ScopeTopLevel, "tls"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetupRefuses(t *testing.T) {
|
||||||
|
e := newEnv(t)
|
||||||
|
st := e.state()
|
||||||
|
for _, s := range []Setup{
|
||||||
|
{Hostname: "dns.example.com", Certificate: "dns", Addresses: []string{"10.0.10.5"}}, // neither DoT nor DoH
|
||||||
|
{Hostname: "dns.example.com", Certificate: "dns", Addresses: []string{"0.0.0.0"}, DoT: true}, // every address
|
||||||
|
{Hostname: "dns.example.com", Certificate: "dns", DoT: true}, // no address
|
||||||
|
{Hostname: "dns.example.com", Certificate: "dns", Addresses: []string{"10.0.10.5"}, DoH: true, DoHPort: 53}, // port 53
|
||||||
|
{Hostname: "dns", Certificate: "dns", Addresses: []string{"10.0.10.5"}, DoT: true}, // not a host name
|
||||||
|
} {
|
||||||
|
if _, _, err := Plan(st, s, e.certDir); err == nil {
|
||||||
|
t.Errorf("accepted %+v", s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// A tls statement whose files are missing is refused by validation.
|
||||||
|
_, err := e.eng.Submit(context.Background(), []engine.Request{engine.NewRequest(engine.OpOptionCreate, 0, engine.OptionInput{
|
||||||
|
Scope: model.Ptr(model.ScopeTopLevel), Name: model.Ptr("tls"), Value: model.Ptr(`x { cert-file "/nonexistent/c.pem"; key-file "/nonexistent/k.pem"; }`)})},
|
||||||
|
auth.System, "test", "", engine.ApplyOptions{})
|
||||||
|
if err == nil || !strings.Contains(err.Error(), "doesn't exist") {
|
||||||
|
t.Errorf("missing files: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPorts(t *testing.T) {
|
||||||
|
s, err := parseProcAddr("0100007F:0035")
|
||||||
|
if err != nil || s.Addr != netip.MustParseAddr("127.0.0.1") || s.Port != 53 {
|
||||||
|
t.Errorf("v4: %+v %v", s, err)
|
||||||
|
}
|
||||||
|
s, err = parseProcAddr("00000000000000000000000001000000:01BB")
|
||||||
|
if err != nil || s.Addr != netip.MustParseAddr("::1") || s.Port != 443 {
|
||||||
|
t.Errorf("v6: %+v %v", s, err)
|
||||||
|
}
|
||||||
|
e := newEnv(t)
|
||||||
|
old := ListeningSockets
|
||||||
|
t.Cleanup(func() { ListeningSockets = old })
|
||||||
|
ListeningSockets = func() ([]Socket, error) {
|
||||||
|
return []Socket{{netip.MustParseAddr("0.0.0.0"), 443}, {netip.MustParseAddr("10.0.10.5"), 8443}, {netip.MustParseAddr("::"), 853}}, nil
|
||||||
|
}
|
||||||
|
c, err := PortCheck(e.state(), []string{"10.0.10.5"}, []int{853, 443, 8443}, []string{"0.0.0.0:443"})
|
||||||
|
if err != nil || len(c) != 3 || c[1].What != "jarld (Jarl's web UI and API)" || c[2].What != "another program" {
|
||||||
|
t.Errorf("conflicts = %+v %v", c, err)
|
||||||
|
}
|
||||||
|
if p := FreeDoHPort(e.state(), []string{"10.0.10.5"}, nil); p != 4443 {
|
||||||
|
t.Errorf("free DoH port = %d, want 4443", p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Each address gets its own views; a view no longer given loses it, and
|
||||||
|
// records of the host names that aren't the setup's stay.
|
||||||
|
func TestSetupAddressViews(t *testing.T) {
|
||||||
|
e := newEnv(t)
|
||||||
|
e.submit(engine.NewRequest(engine.OpZoneCreate, 0, engine.ZoneInput{Name: model.Ptr("example.com"), View: model.Ptr("external"), LinkWith: "internal"}))
|
||||||
|
e.submit(engine.NewRequest(engine.OpRRSetReplace, 0, engine.RRSetInput{Zone: "example.com", View: "external", Name: "doh.example.com.", Type: "A", Data: []string{"198.51.100.9"}, Local: model.Ptr(true)}))
|
||||||
|
hosts := func(st *model.State, view string) []string {
|
||||||
|
z := st.FindZone("example.com.", st.ViewByName(view).ID)
|
||||||
|
var out []string
|
||||||
|
for _, r := range st.ZoneRecords(z.ID) {
|
||||||
|
if strings.HasPrefix(r.Name, "dns.") || strings.HasPrefix(r.Name, "doh.") {
|
||||||
|
out = append(out, strings.SplitN(r.Name, ".", 2)[0]+" "+r.Type+" "+r.Data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
setup := Setup{Hostnames: []string{"dns.example.com", "doh.example.com"}, Certificate: "dns", DoT: true, DoH: true,
|
||||||
|
Addresses: []string{"10.0.10.5", "203.0.113.5", "10.0.10.6"},
|
||||||
|
AddressViews: map[string][]string{"10.0.10.5": {"internal"}, "203.0.113.5": {"external"}, "10.0.10.6": {"external"}},
|
||||||
|
PublicViews: map[string]bool{"external": true}}
|
||||||
|
reqs, notes, err := Plan(e.state(), setup, e.certDir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !slices.ContainsFunc(notes, func(n string) bool {
|
||||||
|
return strings.Contains(n, "view external is reachable from the internet, but gets the private address 10.0.10.6")
|
||||||
|
}) {
|
||||||
|
t.Errorf("notes %q", notes)
|
||||||
|
}
|
||||||
|
e.submit(reqs...)
|
||||||
|
st := e.state()
|
||||||
|
if got, want := hosts(st, "internal"), []string{"dns A 10.0.10.5", "doh A 10.0.10.5"}; !slices.Equal(got, want) {
|
||||||
|
t.Errorf("internal %q, want %q", got, want)
|
||||||
|
}
|
||||||
|
// The external doh record that isn't the setup's stays.
|
||||||
|
if got, want := hosts(st, "external"), []string{"dns A 10.0.10.6", "dns A 203.0.113.5", "doh A 10.0.10.6", "doh A 198.51.100.9", "doh A 203.0.113.5"}; !slices.Equal(got, want) {
|
||||||
|
t.Errorf("external %q, want %q", got, want)
|
||||||
|
}
|
||||||
|
if !slices.Equal(st.Settings.EncryptedDNSHosts, []string{"dns.example.com", "doh.example.com"}) {
|
||||||
|
t.Errorf("hosts %q", st.Settings.EncryptedDNSHosts)
|
||||||
|
}
|
||||||
|
av := CurrentAddressViews(st, st.Settings.EncryptedDNSHosts)
|
||||||
|
if !slices.Equal(av["10.0.10.5"], []string{"internal"}) || !slices.Equal(av["10.0.10.6"], []string{"external"}) {
|
||||||
|
t.Errorf("address views %v", av)
|
||||||
|
}
|
||||||
|
uses := CertUses(st, filepath.Join(e.certDir, "dns"))
|
||||||
|
if len(uses) != 2 || !strings.HasPrefix(uses[0], "DNS over TLS on 10.0.10.5, 203.0.113.5, 10.0.10.6 port 853") || !strings.HasPrefix(uses[1], "DNS over HTTPS on") {
|
||||||
|
t.Errorf("cert uses %q", uses)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 10.0.10.6 no longer in external, doh.example.com no longer a host name.
|
||||||
|
setup = Setup{Hostname: "dns.example.com", Certificate: "dns", DoT: true, Addresses: []string{"10.0.10.5", "203.0.113.5", "10.0.10.6"},
|
||||||
|
AddressViews: map[string][]string{"10.0.10.5": {"internal"}, "203.0.113.5": {"external"}}}
|
||||||
|
reqs, _, err = Plan(st, setup, e.certDir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
e.submit(reqs...)
|
||||||
|
st = e.state()
|
||||||
|
if got, want := hosts(st, "external"), []string{"dns A 203.0.113.5", "doh A 198.51.100.9"}; !slices.Equal(got, want) {
|
||||||
|
t.Errorf("external after %q, want %q", got, want)
|
||||||
|
}
|
||||||
|
if got, want := hosts(st, "internal"), []string{"dns A 10.0.10.5"}; !slices.Equal(got, want) {
|
||||||
|
t.Errorf("internal after %q, want %q", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,245 @@
|
|||||||
|
package encdns
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"crypto/tls"
|
||||||
|
"crypto/x509"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"syscall"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/miekg/dns"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Probe is the outcome of checking one DoT or DoH listener the way a
|
||||||
|
// client would: connect, check the certificate, ask a question.
|
||||||
|
type Probe struct {
|
||||||
|
Kind string `json:"kind"` // dot or doh
|
||||||
|
Address string `json:"address"`
|
||||||
|
Port int `json:"port"`
|
||||||
|
// OK: it answered over TLS with a certificate for the host name that
|
||||||
|
// is current. Problem says what is wrong when not; Warning notes
|
||||||
|
// something that doesn't stop clients from working everywhere.
|
||||||
|
OK bool `json:"ok"`
|
||||||
|
Problem string `json:"problem,omitempty"`
|
||||||
|
Warning string `json:"warning,omitempty"`
|
||||||
|
// What the certificate named served says.
|
||||||
|
CertNames []string `json:"cert_names,omitempty"`
|
||||||
|
CertNotAfter *time.Time `json:"cert_not_after,omitempty"`
|
||||||
|
CertSerial string `json:"cert_serial,omitempty"`
|
||||||
|
// Trusted: it chains to a CA this server trusts (not so for a
|
||||||
|
// staging or test CA).
|
||||||
|
Trusted bool `json:"trusted"`
|
||||||
|
RCode string `json:"rcode,omitempty"`
|
||||||
|
Millis int64 `json:"ms"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Health is the last check of every listener.
|
||||||
|
type Health struct {
|
||||||
|
Checked time.Time `json:"checked"`
|
||||||
|
Probes []Probe `json:"probes"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// OK reports whether every listener works.
|
||||||
|
func (h *Health) OK() bool {
|
||||||
|
for _, p := range h.Probes {
|
||||||
|
if !p.OK {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check probes every DoT and DoH listener of the setup. hostname is what
|
||||||
|
// clients ask for, serial the certificate Jarl last wrote for named ("" if
|
||||||
|
// unknown), roots the CAs to trust (nil: the system's).
|
||||||
|
func Check(ctx context.Context, s Status, hostname, serial string, roots *x509.CertPool) *Health {
|
||||||
|
h := &Health{Checked: time.Now(), Probes: []Probe{}}
|
||||||
|
for _, e := range s.DoT {
|
||||||
|
h.Probes = append(h.Probes, probe(ctx, "dot", e, hostname, serial, roots))
|
||||||
|
}
|
||||||
|
for _, e := range s.DoH {
|
||||||
|
h.Probes = append(h.Probes, probe(ctx, "doh", e, hostname, serial, roots))
|
||||||
|
}
|
||||||
|
return h
|
||||||
|
}
|
||||||
|
|
||||||
|
const probeTimeout = 5 * time.Second
|
||||||
|
|
||||||
|
func probe(ctx context.Context, kind string, e Endpoint, hostname, serial string, roots *x509.CertPool) Probe {
|
||||||
|
p := Probe{Kind: kind, Address: e.Address, Port: e.Port}
|
||||||
|
addr := net.JoinHostPort(e.Address, strconv.Itoa(e.Port))
|
||||||
|
ctx, cancel := context.WithTimeout(ctx, probeTimeout)
|
||||||
|
defer cancel()
|
||||||
|
start := time.Now()
|
||||||
|
q := new(dns.Msg)
|
||||||
|
q.SetQuestion(dns.Fqdn(hostname), dns.TypeA)
|
||||||
|
q.RecursionDesired = true
|
||||||
|
var state tls.ConnectionState
|
||||||
|
var answer *dns.Msg
|
||||||
|
var err error
|
||||||
|
cfg := &tls.Config{ServerName: hostname, InsecureSkipVerify: true, MinVersion: tls.VersionTLS12} // checked below, to say what is wrong
|
||||||
|
if kind == "dot" {
|
||||||
|
cfg.NextProtos = []string{"dot"}
|
||||||
|
state, answer, err = askDoT(ctx, addr, cfg, q)
|
||||||
|
} else {
|
||||||
|
state, answer, err = askDoH(ctx, addr, hostname, e.Port, cfg, q)
|
||||||
|
}
|
||||||
|
p.Millis = time.Since(start).Milliseconds()
|
||||||
|
if len(state.PeerCertificates) > 0 {
|
||||||
|
leaf := state.PeerCertificates[0]
|
||||||
|
p.CertNames, p.CertSerial = leaf.DNSNames, fmt.Sprintf("%x", leaf.SerialNumber)
|
||||||
|
na := leaf.NotAfter
|
||||||
|
p.CertNotAfter = &na
|
||||||
|
inter := x509.NewCertPool()
|
||||||
|
for _, c := range state.PeerCertificates[1:] {
|
||||||
|
inter.AddCert(c)
|
||||||
|
}
|
||||||
|
_, verr := leaf.Verify(x509.VerifyOptions{Roots: roots, Intermediates: inter, DNSName: hostname})
|
||||||
|
p.Trusted = verr == nil
|
||||||
|
switch {
|
||||||
|
case leaf.VerifyHostname(hostname) != nil:
|
||||||
|
p.Problem = fmt.Sprintf("named serves a certificate for %s, not %s: clients reject it", strings.Join(leaf.DNSNames, ", "), hostname)
|
||||||
|
case time.Now().After(leaf.NotAfter):
|
||||||
|
p.Problem = "named serves an expired certificate (until " + leaf.NotAfter.Format(time.DateOnly) + ")"
|
||||||
|
case serial != "" && p.CertSerial != serial:
|
||||||
|
p.Problem = "named still serves an older certificate (serial " + p.CertSerial + ", Jarl has " + serial + "): it hasn't reread the files (rndc reconfig)"
|
||||||
|
case !p.Trusted:
|
||||||
|
p.Warning = "the certificate isn't from a CA this server trusts (a staging or test CA?): clients reject it unless they trust that CA"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case err != nil:
|
||||||
|
p.Problem = describe(err, e)
|
||||||
|
case p.Problem != "":
|
||||||
|
case answer == nil:
|
||||||
|
p.Problem = "no DNS answer"
|
||||||
|
default:
|
||||||
|
p.RCode = dns.RcodeToString[answer.Rcode]
|
||||||
|
p.OK = true
|
||||||
|
if answer.Rcode == dns.RcodeRefused {
|
||||||
|
p.Warning = strings.TrimPrefix(p.Warning+"; ", "; ") + "it answers, but REFUSED: this server's own address gets a view that doesn't answer for " + hostname
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
func askDoT(ctx context.Context, addr string, cfg *tls.Config, q *dns.Msg) (tls.ConnectionState, *dns.Msg, error) {
|
||||||
|
d := &tls.Dialer{NetDialer: &net.Dialer{Timeout: probeTimeout}, Config: cfg}
|
||||||
|
conn, err := d.DialContext(ctx, "tcp", addr)
|
||||||
|
if err != nil {
|
||||||
|
return tls.ConnectionState{}, nil, err
|
||||||
|
}
|
||||||
|
defer conn.Close()
|
||||||
|
tc := conn.(*tls.Conn)
|
||||||
|
state := tc.ConnectionState()
|
||||||
|
conn.SetDeadline(time.Now().Add(probeTimeout))
|
||||||
|
co := &dns.Conn{Conn: conn}
|
||||||
|
if err := co.WriteMsg(q); err != nil {
|
||||||
|
return state, nil, err
|
||||||
|
}
|
||||||
|
r, err := co.ReadMsg()
|
||||||
|
return state, r, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func askDoH(ctx context.Context, addr, hostname string, port int, cfg *tls.Config, q *dns.Msg) (tls.ConnectionState, *dns.Msg, error) {
|
||||||
|
cfg = cfg.Clone()
|
||||||
|
cfg.NextProtos = []string{"h2", "http/1.1"}
|
||||||
|
tr := &http.Transport{
|
||||||
|
TLSClientConfig: cfg,
|
||||||
|
ForceAttemptHTTP2: true,
|
||||||
|
// Whatever the host name resolves to here: the listener's address.
|
||||||
|
DialContext: func(ctx context.Context, network, _ string) (net.Conn, error) {
|
||||||
|
return (&net.Dialer{Timeout: probeTimeout}).DialContext(ctx, network, addr)
|
||||||
|
},
|
||||||
|
}
|
||||||
|
defer tr.CloseIdleConnections()
|
||||||
|
wire, err := q.Pack()
|
||||||
|
if err != nil {
|
||||||
|
return tls.ConnectionState{}, nil, err
|
||||||
|
}
|
||||||
|
url := "https://" + net.JoinHostPort(hostname, strconv.Itoa(port)) + "/dns-query"
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, url, bytes.NewReader(wire))
|
||||||
|
if err != nil {
|
||||||
|
return tls.ConnectionState{}, nil, err
|
||||||
|
}
|
||||||
|
req.Header.Set("Content-Type", "application/dns-message")
|
||||||
|
req.Header.Set("Accept", "application/dns-message")
|
||||||
|
resp, err := (&http.Client{Transport: tr, Timeout: probeTimeout}).Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return tls.ConnectionState{}, nil, err
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
var state tls.ConnectionState
|
||||||
|
if resp.TLS != nil {
|
||||||
|
state = *resp.TLS
|
||||||
|
}
|
||||||
|
body, err := io.ReadAll(io.LimitReader(resp.Body, 64<<10))
|
||||||
|
if err != nil {
|
||||||
|
return state, nil, err
|
||||||
|
}
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
return state, nil, fmt.Errorf("HTTP %d at /dns-query", resp.StatusCode)
|
||||||
|
}
|
||||||
|
r := new(dns.Msg)
|
||||||
|
if err := r.Unpack(body); err != nil {
|
||||||
|
return state, nil, fmt.Errorf("not a DNS answer: %w", err)
|
||||||
|
}
|
||||||
|
return state, r, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// describe says what a failed probe means.
|
||||||
|
func describe(err error, e Endpoint) string {
|
||||||
|
var ne net.Error
|
||||||
|
switch {
|
||||||
|
case errors.Is(err, syscall.ECONNREFUSED):
|
||||||
|
return fmt.Sprintf("nothing listens on %s port %d: named may not have been able to bind it (look in named's log; ports below 1024 need named to start as root)", e.Address, e.Port)
|
||||||
|
case errors.As(err, &ne) && ne.Timeout(), errors.Is(err, context.DeadlineExceeded):
|
||||||
|
return fmt.Sprintf("no answer from %s port %d within %s (a firewall on the server?)", e.Address, e.Port, probeTimeout)
|
||||||
|
}
|
||||||
|
return err.Error()
|
||||||
|
}
|
||||||
|
|
||||||
|
// RequireNames marks the probes whose certificate doesn't cover every host
|
||||||
|
// name clients may use (the first is what the probe asked for).
|
||||||
|
func (h *Health) RequireNames(hosts []string) {
|
||||||
|
for i := range h.Probes {
|
||||||
|
p := &h.Probes[i]
|
||||||
|
if p.Problem != "" || len(p.CertNames) == 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
var missing []string
|
||||||
|
for _, host := range hosts {
|
||||||
|
if !nameCovered(p.CertNames, host) {
|
||||||
|
missing = append(missing, host)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(missing) > 0 {
|
||||||
|
p.OK = false
|
||||||
|
p.Problem = fmt.Sprintf("named serves a certificate for %s, which doesn't cover %s: clients using that name reject it", strings.Join(p.CertNames, ", "), strings.Join(missing, ", "))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func nameCovered(names []string, host string) bool {
|
||||||
|
host = strings.ToLower(strings.TrimSuffix(host, "."))
|
||||||
|
for _, n := range names {
|
||||||
|
n = strings.ToLower(strings.TrimSuffix(n, "."))
|
||||||
|
if n == host {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if rest, ok := strings.CutPrefix(n, "*."); ok {
|
||||||
|
if _, parent, ok := strings.Cut(host, "."); ok && parent == rest {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
@@ -0,0 +1,133 @@
|
|||||||
|
package encdns
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/ecdsa"
|
||||||
|
"crypto/elliptic"
|
||||||
|
"crypto/rand"
|
||||||
|
"crypto/tls"
|
||||||
|
"crypto/x509"
|
||||||
|
"crypto/x509/pkix"
|
||||||
|
"io"
|
||||||
|
"math/big"
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/miekg/dns"
|
||||||
|
)
|
||||||
|
|
||||||
|
func testCert(t *testing.T, names ...string) (tls.Certificate, *x509.Certificate) {
|
||||||
|
key, _ := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
|
||||||
|
tmpl := &x509.Certificate{SerialNumber: big.NewInt(0xabc123), Subject: pkix.Name{CommonName: names[0]}, DNSNames: names,
|
||||||
|
NotBefore: time.Now().Add(-time.Hour), NotAfter: time.Now().Add(24 * time.Hour), ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth}}
|
||||||
|
der, err := x509.CreateCertificate(rand.Reader, tmpl, tmpl, &key.PublicKey, key)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
leaf, _ := x509.ParseCertificate(der)
|
||||||
|
return tls.Certificate{Certificate: [][]byte{der}, PrivateKey: key, Leaf: leaf}, leaf
|
||||||
|
}
|
||||||
|
|
||||||
|
// answer answers every question with 192.0.2.53.
|
||||||
|
var answer = dns.HandlerFunc(func(w dns.ResponseWriter, r *dns.Msg) {
|
||||||
|
m := new(dns.Msg)
|
||||||
|
m.SetReply(r)
|
||||||
|
m.Answer = append(m.Answer, &dns.A{Hdr: dns.RR_Header{Name: r.Question[0].Name, Rrtype: dns.TypeA, Class: dns.ClassINET, Ttl: 60}, A: net.ParseIP("192.0.2.53")})
|
||||||
|
w.WriteMsg(m)
|
||||||
|
})
|
||||||
|
|
||||||
|
func listeners(t *testing.T, cert tls.Certificate) (dot, doh Endpoint) {
|
||||||
|
cfg := &tls.Config{Certificates: []tls.Certificate{cert}}
|
||||||
|
ln, err := tls.Listen("tcp", "127.0.0.1:0", cfg)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
srv := &dns.Server{Listener: ln, Net: "tcp-tls", Handler: answer}
|
||||||
|
go srv.ActivateAndServe()
|
||||||
|
t.Cleanup(func() { srv.Shutdown() })
|
||||||
|
hl, err := tls.Listen("tcp", "127.0.0.1:0", cfg)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
hs := &http.Server{Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.URL.Path != "/dns-query" {
|
||||||
|
http.NotFound(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
b, _ := io.ReadAll(r.Body)
|
||||||
|
q := new(dns.Msg)
|
||||||
|
if q.Unpack(b) != nil {
|
||||||
|
http.Error(w, "bad", 400)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
m := new(dns.Msg)
|
||||||
|
m.SetReply(q)
|
||||||
|
m.Rcode = dns.RcodeSuccess
|
||||||
|
out, _ := m.Pack()
|
||||||
|
w.Header().Set("Content-Type", "application/dns-message")
|
||||||
|
w.Write(out)
|
||||||
|
})}
|
||||||
|
go hs.Serve(hl)
|
||||||
|
t.Cleanup(func() { hs.Close() })
|
||||||
|
port := func(l net.Listener) int { return l.Addr().(*net.TCPAddr).Port }
|
||||||
|
return Endpoint{"127.0.0.1", port(ln)}, Endpoint{"127.0.0.1", port(hl)}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHealth(t *testing.T) {
|
||||||
|
ctx := context.Background()
|
||||||
|
cert, leaf := testCert(t, "dns.example.com")
|
||||||
|
dot, doh := listeners(t, cert)
|
||||||
|
roots := x509.NewCertPool()
|
||||||
|
roots.AddCert(leaf)
|
||||||
|
st := Status{Enabled: true, DoT: []Endpoint{dot}, DoH: []Endpoint{doh}}
|
||||||
|
|
||||||
|
h := Check(ctx, st, "dns.example.com", "abc123", roots)
|
||||||
|
if !h.OK() || len(h.Probes) != 2 {
|
||||||
|
t.Fatalf("working setup: %+v", h.Probes)
|
||||||
|
}
|
||||||
|
for _, p := range h.Probes {
|
||||||
|
if !p.Trusted || p.RCode != "NOERROR" || p.Warning != "" || p.CertSerial != "abc123" {
|
||||||
|
t.Errorf("%s: %+v", p.Kind, p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// named hasn't reread a renewed certificate.
|
||||||
|
if h := Check(ctx, st, "dns.example.com", "def456", roots); h.OK() || !strings.Contains(h.Probes[0].Problem, "older certificate") {
|
||||||
|
t.Errorf("stale: %+v", h.Probes[0])
|
||||||
|
}
|
||||||
|
// The wrong name.
|
||||||
|
if h := Check(ctx, st, "other.example.com", "", roots); h.OK() || !strings.Contains(h.Probes[0].Problem, "not other.example.com") {
|
||||||
|
t.Errorf("wrong name: %+v", h.Probes[0])
|
||||||
|
}
|
||||||
|
// A CA this server doesn't trust: works, with a warning.
|
||||||
|
if h := Check(ctx, st, "dns.example.com", "abc123", x509.NewCertPool()); !h.OK() || !strings.Contains(h.Probes[1].Warning, "staging") {
|
||||||
|
t.Errorf("untrusted: %+v", h.Probes[1])
|
||||||
|
}
|
||||||
|
// Nothing listening.
|
||||||
|
l, _ := net.Listen("tcp", "127.0.0.1:0")
|
||||||
|
gone := l.Addr().(*net.TCPAddr).Port
|
||||||
|
l.Close()
|
||||||
|
if h := Check(ctx, Status{Enabled: true, DoT: []Endpoint{{"127.0.0.1", gone}}}, "dns.example.com", "", roots); h.OK() || !strings.Contains(h.Probes[0].Problem, "nothing listens") {
|
||||||
|
t.Errorf("nothing listening: %+v", h.Probes[0])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRequireNames(t *testing.T) {
|
||||||
|
h := &Health{Probes: []Probe{
|
||||||
|
{Kind: "dot", OK: true, CertNames: []string{"dns.example.com", "*.example.net"}},
|
||||||
|
{Kind: "doh", OK: false, Problem: "nothing listens", CertNames: nil},
|
||||||
|
}}
|
||||||
|
h.RequireNames([]string{"dns.example.com", "doh.example.net"})
|
||||||
|
if !h.Probes[0].OK {
|
||||||
|
t.Errorf("covered names: %+v", h.Probes[0])
|
||||||
|
}
|
||||||
|
h.RequireNames([]string{"dns.example.com", "doh.example.com"})
|
||||||
|
if p := h.Probes[0]; p.OK || !strings.Contains(p.Problem, "doesn't cover doh.example.com") {
|
||||||
|
t.Errorf("missing name: %+v", p)
|
||||||
|
}
|
||||||
|
if h.Probes[1].Problem != "nothing listens" {
|
||||||
|
t.Errorf("other problem replaced: %+v", h.Probes[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,149 @@
|
|||||||
|
package encdns
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"encoding/hex"
|
||||||
|
"fmt"
|
||||||
|
"net/netip"
|
||||||
|
"os"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"jarl/internal/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Socket is a listening TCP socket on this host.
|
||||||
|
type Socket struct {
|
||||||
|
Addr netip.Addr
|
||||||
|
Port int
|
||||||
|
}
|
||||||
|
|
||||||
|
// ListeningSockets reads the host's listening TCP sockets from
|
||||||
|
// /proc/net/tcp and tcp6 (Linux; nil elsewhere). It needs no privileges
|
||||||
|
// and binds nothing. Tests replace it.
|
||||||
|
var ListeningSockets = func() ([]Socket, error) {
|
||||||
|
var out []Socket
|
||||||
|
for _, f := range []string{"/proc/net/tcp", "/proc/net/tcp6"} {
|
||||||
|
socks, err := parseProcNet(f)
|
||||||
|
if err != nil {
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out = append(out, socks...)
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseProcNet(path string) ([]Socket, error) {
|
||||||
|
f, err := os.Open(path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer f.Close()
|
||||||
|
var out []Socket
|
||||||
|
sc := bufio.NewScanner(f)
|
||||||
|
sc.Scan() // header
|
||||||
|
for sc.Scan() {
|
||||||
|
fields := strings.Fields(sc.Text())
|
||||||
|
if len(fields) < 4 || fields[3] != "0A" { // 0A: LISTEN
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
s, err := parseProcAddr(fields[1])
|
||||||
|
if err == nil {
|
||||||
|
out = append(out, s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out, sc.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseProcAddr parses "0100007F:0035": the address in 32-bit words of
|
||||||
|
// host byte order (little-endian here), then the port.
|
||||||
|
func parseProcAddr(s string) (Socket, error) {
|
||||||
|
ha, hp, ok := strings.Cut(s, ":")
|
||||||
|
if !ok {
|
||||||
|
return Socket{}, fmt.Errorf("bad address %q", s)
|
||||||
|
}
|
||||||
|
b, err := hex.DecodeString(ha)
|
||||||
|
if err != nil || (len(b) != 4 && len(b) != 16) {
|
||||||
|
return Socket{}, fmt.Errorf("bad address %q", s)
|
||||||
|
}
|
||||||
|
for i := 0; i+4 <= len(b); i += 4 {
|
||||||
|
b[i], b[i+1], b[i+2], b[i+3] = b[i+3], b[i+2], b[i+1], b[i]
|
||||||
|
}
|
||||||
|
addr, _ := netip.AddrFromSlice(b)
|
||||||
|
port, err := strconv.ParseUint(hp, 16, 16)
|
||||||
|
if err != nil {
|
||||||
|
return Socket{}, err
|
||||||
|
}
|
||||||
|
return Socket{Addr: addr.Unmap(), Port: int(port)}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Conflict is something else listening where a listener would go.
|
||||||
|
type Conflict struct {
|
||||||
|
Address string `json:"address"`
|
||||||
|
Port int `json:"port"`
|
||||||
|
What string `json:"what"` // who it is, when Jarl knows
|
||||||
|
}
|
||||||
|
|
||||||
|
// PortCheck says which of addresses × ports something else listens on
|
||||||
|
// already. named's own listeners (the setup's, now) and jarld's (known
|
||||||
|
// listen addresses) are told apart.
|
||||||
|
func PortCheck(st *model.State, addresses []string, ports []int, jarld []string) ([]Conflict, error) {
|
||||||
|
socks, err := ListeningSockets()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
// What named listens on now with DoT or DoH (it will again).
|
||||||
|
ours := map[string]bool{}
|
||||||
|
for _, l := range Listeners(st) {
|
||||||
|
if l.Kind() != "plain" {
|
||||||
|
for _, a := range l.Addrs {
|
||||||
|
ours[a+"#"+strconv.Itoa(l.EffectivePort())] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
jarldOn := map[string]bool{}
|
||||||
|
for _, l := range jarld {
|
||||||
|
jarldOn[l] = true
|
||||||
|
}
|
||||||
|
var out []Conflict
|
||||||
|
for _, as := range addresses {
|
||||||
|
a, err := netip.ParseAddr(as)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
a = a.Unmap()
|
||||||
|
for _, p := range ports {
|
||||||
|
if ours[a.String()+"#"+strconv.Itoa(p)] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, s := range socks {
|
||||||
|
if s.Port != p || !(s.Addr == a || s.Addr.IsUnspecified() && s.Addr.Is4() == a.Is4() || s.Addr.IsUnspecified() && s.Addr.Is6()) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
what := "another program"
|
||||||
|
for l := range jarldOn {
|
||||||
|
if strings.HasSuffix(l, ":"+strconv.Itoa(p)) {
|
||||||
|
what = "jarld (Jarl's web UI and API)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out = append(out, Conflict{Address: a.String(), Port: p, What: what})
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// FreeDoHPort returns the first of the usual DoH ports nothing listens on
|
||||||
|
// at the addresses (0 when none is free).
|
||||||
|
func FreeDoHPort(st *model.State, addresses []string, jarld []string) int {
|
||||||
|
for _, p := range []int{443, 8443, 4443, 9443} {
|
||||||
|
if c, err := PortCheck(st, addresses, []int{p}, jarld); err == nil && len(c) == 0 {
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
}
|
||||||
@@ -0,0 +1,236 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"jarl/internal/dnsname"
|
||||||
|
"jarl/internal/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ViewSet is what one view has for a name and type.
|
||||||
|
type ViewSet struct {
|
||||||
|
View string `json:"view"`
|
||||||
|
ZoneID int64 `json:"zone_id"`
|
||||||
|
Records []string `json:"records"` // data (with TTL and "(disabled)" when set), sorted
|
||||||
|
IDs []int64 `json:"ids"` // the records, in the same order
|
||||||
|
Data []string `json:"data"` // their data alone, in the same order
|
||||||
|
TTL *uint32 `json:"ttl,omitempty"` // the first record's own TTL
|
||||||
|
Linked string `json:"linked,omitempty"` // shared or local, in a linked zone
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompareRow is one name and type across views.
|
||||||
|
type CompareRow struct {
|
||||||
|
Name string `json:"name"` // relative to the zone
|
||||||
|
FQDN string `json:"fqdn"`
|
||||||
|
Type string `json:"type"`
|
||||||
|
Same bool `json:"same"`
|
||||||
|
Views []ViewSet `json:"views"` // in the order of the zones given
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompareZones lines up the records of zones of the same name in
|
||||||
|
// different views (docs/views.md#linked-zones), one row per name and type,
|
||||||
|
// sorted like a zone file.
|
||||||
|
func CompareZones(st *model.State, zones []*model.Zone) []CompareRow {
|
||||||
|
type key struct{ name, typ string }
|
||||||
|
sets := make([]map[key][]*model.Record, len(zones))
|
||||||
|
var keys []key
|
||||||
|
seen := map[key]bool{}
|
||||||
|
var all []*model.Record
|
||||||
|
for i, z := range zones {
|
||||||
|
sets[i] = map[key][]*model.Record{}
|
||||||
|
for _, r := range st.ZoneRecords(z.ID) {
|
||||||
|
k := key{r.Name, r.Type}
|
||||||
|
sets[i][k] = append(sets[i][k], r)
|
||||||
|
if !seen[k] {
|
||||||
|
seen[k] = true
|
||||||
|
keys = append(keys, k)
|
||||||
|
all = append(all, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(zones) > 0 {
|
||||||
|
// Zone file order: the apex first, then by name and type.
|
||||||
|
model.SortRecords(all, zones[0])
|
||||||
|
keys = keys[:0]
|
||||||
|
for _, r := range all {
|
||||||
|
keys = append(keys, key{r.Name, r.Type})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var out []CompareRow
|
||||||
|
for _, k := range keys {
|
||||||
|
row := CompareRow{FQDN: k.name, Type: k.typ, Same: true}
|
||||||
|
if len(zones) > 0 {
|
||||||
|
row.Name = relName(k.name, zones[0].Name)
|
||||||
|
}
|
||||||
|
var first string
|
||||||
|
for i, z := range zones {
|
||||||
|
vs := ViewSet{View: st.ViewName(z), ZoneID: z.ID, Records: []string{}, IDs: []int64{}, Data: []string{}}
|
||||||
|
rs := slices.Clone(sets[i][k])
|
||||||
|
slices.SortFunc(rs, func(a, b *model.Record) int { return strings.Compare(strings.ToLower(a.Data), strings.ToLower(b.Data)) })
|
||||||
|
for _, r := range rs {
|
||||||
|
d := r.Data
|
||||||
|
if r.TTL != nil {
|
||||||
|
d = fmt.Sprintf("%s (TTL %d)", d, *r.TTL)
|
||||||
|
}
|
||||||
|
if r.Disabled {
|
||||||
|
d += " (disabled)"
|
||||||
|
}
|
||||||
|
vs.Records = append(vs.Records, d)
|
||||||
|
vs.IDs = append(vs.IDs, r.ID)
|
||||||
|
vs.Data = append(vs.Data, r.Data)
|
||||||
|
if vs.TTL == nil && r.TTL != nil {
|
||||||
|
vs.TTL = model.Ptr(*r.TTL)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if z.LinkGroup != 0 && len(rs) > 0 {
|
||||||
|
vs.Linked = "shared"
|
||||||
|
if rs[0].SharedID == 0 {
|
||||||
|
vs.Linked = "local"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sig := strings.Join(vs.Records, "\n")
|
||||||
|
if i == 0 {
|
||||||
|
first = sig
|
||||||
|
} else if sig != first {
|
||||||
|
row.Same = false
|
||||||
|
}
|
||||||
|
row.Views = append(row.Views, vs)
|
||||||
|
}
|
||||||
|
out = append(out, row)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func relName(name, zone string) string {
|
||||||
|
if name == zone {
|
||||||
|
return "@"
|
||||||
|
}
|
||||||
|
return strings.TrimSuffix(name, "."+zone)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompareReport is a zone in one view (the base) next to the same zone in
|
||||||
|
// other views (docs/views.md#comparing-views): what the other views answer
|
||||||
|
// differently, the names only some views have, and how much is the same.
|
||||||
|
type CompareReport struct {
|
||||||
|
Zone string `json:"zone"`
|
||||||
|
Base string `json:"base"` // the view compared from
|
||||||
|
Views []string `json:"views"` // the base first
|
||||||
|
Linked bool `json:"linked"` // all in one link
|
||||||
|
// Summary is, per other view, how it differs from the base.
|
||||||
|
Summary []CompareSummary `json:"summary"`
|
||||||
|
// Different are names and types more than one view has, with
|
||||||
|
// different records.
|
||||||
|
Different []CompareRow `json:"different"`
|
||||||
|
// Only are the names and types only some views have, by the views
|
||||||
|
// that have them.
|
||||||
|
Only []CompareOnly `json:"only"`
|
||||||
|
Same int `json:"same"`
|
||||||
|
// SameRows are the ones that are the same (when asked for).
|
||||||
|
SameRows []CompareRow `json:"same_rows,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompareSummary counts how a view differs from the base view.
|
||||||
|
type CompareSummary struct {
|
||||||
|
View string `json:"view"`
|
||||||
|
Different int `json:"different"` // both have it, with different records
|
||||||
|
OnlyBase int `json:"only_base"` // the base has it, this view doesn't
|
||||||
|
OnlyOther int `json:"only_other"` // this view has it, the base doesn't
|
||||||
|
Same int `json:"same"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompareOnly are names and types that only some views have.
|
||||||
|
type CompareOnly struct {
|
||||||
|
Views []string `json:"views"`
|
||||||
|
Rows []CompareRow `json:"rows"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompareFilter narrows a comparison to a name, and optionally a type.
|
||||||
|
type CompareFilter struct {
|
||||||
|
Name string // relative ("www", "@") or absolute
|
||||||
|
Type string
|
||||||
|
All bool // include what is the same
|
||||||
|
}
|
||||||
|
|
||||||
|
// Compare builds the report for zones (the base first). Apex NS records are
|
||||||
|
// left out: they name the servers, which views often list differently on
|
||||||
|
// purpose.
|
||||||
|
func Compare(st *model.State, zones []*model.Zone, f CompareFilter) *CompareReport {
|
||||||
|
rep := &CompareReport{Zone: dnsname.Display(zones[0].Name), Base: st.ViewName(zones[0]), Different: []CompareRow{}, Only: []CompareOnly{}, Linked: true}
|
||||||
|
for _, z := range zones {
|
||||||
|
rep.Views = append(rep.Views, st.ViewName(z))
|
||||||
|
rep.Linked = rep.Linked && z.LinkGroup != 0 && z.LinkGroup == zones[0].LinkGroup
|
||||||
|
}
|
||||||
|
for _, v := range rep.Views[1:] {
|
||||||
|
rep.Summary = append(rep.Summary, CompareSummary{View: v})
|
||||||
|
}
|
||||||
|
want := ""
|
||||||
|
if f.Name != "" {
|
||||||
|
if o, err := dnsname.Owner(f.Name, zones[0].Name); err == nil {
|
||||||
|
want = o
|
||||||
|
}
|
||||||
|
}
|
||||||
|
only := map[string]int{}
|
||||||
|
for _, row := range CompareZones(st, zones) {
|
||||||
|
if row.FQDN == zones[0].Name && row.Type == "NS" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if want != "" && (row.FQDN != want || f.Type != "" && !strings.EqualFold(row.Type, f.Type)) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
base := row.Views[0]
|
||||||
|
for i, vs := range row.Views[1:] {
|
||||||
|
s := &rep.Summary[i]
|
||||||
|
switch {
|
||||||
|
case len(base.Records) > 0 && len(vs.Records) > 0 && slices.Equal(base.Records, vs.Records):
|
||||||
|
s.Same++
|
||||||
|
case len(base.Records) > 0 && len(vs.Records) > 0:
|
||||||
|
s.Different++
|
||||||
|
case len(base.Records) > 0:
|
||||||
|
s.OnlyBase++
|
||||||
|
case len(vs.Records) > 0:
|
||||||
|
s.OnlyOther++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if row.Same {
|
||||||
|
rep.Same++
|
||||||
|
if f.All || want != "" {
|
||||||
|
rep.SameRows = append(rep.SameRows, row)
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
var having []string
|
||||||
|
versions := map[string]bool{}
|
||||||
|
for _, vs := range row.Views {
|
||||||
|
if len(vs.Records) > 0 {
|
||||||
|
having = append(having, vs.View)
|
||||||
|
versions[strings.Join(vs.Records, "\n")] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(versions) > 1 {
|
||||||
|
rep.Different = append(rep.Different, row)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
k := strings.Join(having, ",")
|
||||||
|
i, ok := only[k]
|
||||||
|
if !ok {
|
||||||
|
i = len(rep.Only)
|
||||||
|
only[k] = i
|
||||||
|
rep.Only = append(rep.Only, CompareOnly{Views: having})
|
||||||
|
}
|
||||||
|
rep.Only[i].Rows = append(rep.Only[i].Rows, row)
|
||||||
|
}
|
||||||
|
// The base's own names first, then by how many views have them.
|
||||||
|
slices.SortStableFunc(rep.Only, func(a, b CompareOnly) int {
|
||||||
|
ab, bb := slices.Contains(a.Views, rep.Base), slices.Contains(b.Views, rep.Base)
|
||||||
|
if ab != bb {
|
||||||
|
if ab {
|
||||||
|
return -1
|
||||||
|
}
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
return len(b.Views) - len(a.Views)
|
||||||
|
})
|
||||||
|
return rep
|
||||||
|
}
|
||||||
@@ -3,6 +3,7 @@ package engine
|
|||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"reflect"
|
"reflect"
|
||||||
|
"slices"
|
||||||
"sort"
|
"sort"
|
||||||
|
|
||||||
"jarl/internal/dnsname"
|
"jarl/internal/dnsname"
|
||||||
@@ -23,7 +24,9 @@ func DiffOps(from, to *model.State) []model.Op {
|
|||||||
if !reflect.DeepEqual(stripVersion(from.Settings), stripVersion(to.Settings)) {
|
if !reflect.DeepEqual(stripVersion(from.Settings), stripVersion(to.Settings)) {
|
||||||
s := to.Settings
|
s := to.Settings
|
||||||
add(OpSettingsUpdate, 0, 0, SettingsInput{DefaultTTL: &s.DefaultTTL, Nameservers: model.Ptr(append([]string{}, s.Nameservers...)), RName: &s.RName,
|
add(OpSettingsUpdate, 0, 0, SettingsInput{DefaultTTL: &s.DefaultTTL, Nameservers: model.Ptr(append([]string{}, s.Nameservers...)), RName: &s.RName,
|
||||||
Refresh: &s.Refresh, Retry: &s.Retry, Expire: &s.Expire, NegativeTTL: &s.NegativeTTL, SerialPolicy: &s.SerialPolicy}, "restore settings")
|
Refresh: &s.Refresh, Retry: &s.Retry, Expire: &s.Expire, NegativeTTL: &s.NegativeTTL, SerialPolicy: &s.SerialPolicy,
|
||||||
|
Exposure: &s.Exposure, Acknowledged: model.Ptr(slices.Clone(s.Acknowledged)), DismissedReverse: model.Ptr(slices.Clone(s.DismissedReverse)),
|
||||||
|
EncryptedDNSHosts: model.Ptr(slices.Clone(s.EncryptedDNSHosts))}, "restore settings")
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, k := range sortedKeys(to.Keys) {
|
for _, k := range sortedKeys(to.Keys) {
|
||||||
@@ -47,7 +50,9 @@ func DiffOps(from, to *model.State) []model.Op {
|
|||||||
for _, k := range sortedKeys(to.Views) {
|
for _, k := range sortedKeys(to.Views) {
|
||||||
n := to.Views[k]
|
n := to.Views[k]
|
||||||
in := ViewInput{Name: &n.Name, MatchClients: model.Ptr(append([]string{}, n.MatchClients...)),
|
in := ViewInput{Name: &n.Name, MatchClients: model.Ptr(append([]string{}, n.MatchClients...)),
|
||||||
MatchDestinations: model.Ptr(append([]string{}, n.MatchDestinations...)), Comment: &n.Comment, Position: model.Ptr(n.Position)}
|
MatchDestinations: model.Ptr(append([]string{}, n.MatchDestinations...)), Comment: &n.Comment, Position: model.Ptr(n.Position),
|
||||||
|
Exposure: model.Ptr(n.Exposure), Acknowledged: model.Ptr(slices.Clone(n.Acknowledged)),
|
||||||
|
ReverseSuggestions: model.Ptr(!n.ReverseSuggestionsOff), DismissedReverse: model.Ptr(slices.Clone(n.DismissedReverse))}
|
||||||
if n.MatchRecursiveOnly != nil {
|
if n.MatchRecursiveOnly != nil {
|
||||||
in.MatchRecursiveOnly = model.Some(*n.MatchRecursiveOnly)
|
in.MatchRecursiveOnly = model.Some(*n.MatchRecursiveOnly)
|
||||||
} else {
|
} else {
|
||||||
@@ -63,7 +68,7 @@ func DiffOps(from, to *model.State) []model.Op {
|
|||||||
n := to.Zones[k]
|
n := to.Zones[k]
|
||||||
s := n.SOA
|
s := n.SOA
|
||||||
in := ZoneInput{Name: &n.Name, ViewID: &n.ViewID, Type: &n.Type, InView: &n.InView, File: &n.File,
|
in := ZoneInput{Name: &n.Name, ViewID: &n.ViewID, Type: &n.Type, InView: &n.InView, File: &n.File,
|
||||||
DefaultTTL: &n.DefaultTTL, SerialPolicy: &n.SerialPolicy, DNSSECPolicy: &n.DNSSECPolicy, Comment: &n.Comment, Disabled: &n.Disabled}
|
DefaultTTL: &n.DefaultTTL, SerialPolicy: &n.SerialPolicy, DNSSECPolicy: &n.DNSSECPolicy, Comment: &n.Comment, Disabled: &n.Disabled, LinkGroup: model.Ptr(n.LinkGroup), AutoPTR: model.Ptr(n.AutoPTR)}
|
||||||
if n.Type == model.ZonePrimary {
|
if n.Type == model.ZonePrimary {
|
||||||
in.SOA = &SOAInput{MName: &s.MName, RName: &s.RName, Serial: &s.Serial, Refresh: &s.Refresh, Retry: &s.Retry, Expire: &s.Expire, Minimum: &s.Minimum}
|
in.SOA = &SOAInput{MName: &s.MName, RName: &s.RName, Serial: &s.Serial, Refresh: &s.Refresh, Retry: &s.Retry, Expire: &s.Expire, Minimum: &s.Minimum}
|
||||||
}
|
}
|
||||||
@@ -91,7 +96,7 @@ func DiffOps(from, to *model.State) []model.Op {
|
|||||||
}
|
}
|
||||||
for _, k := range sortedKeys(to.Records) {
|
for _, k := range sortedKeys(to.Records) {
|
||||||
n := to.Records[k]
|
n := to.Records[k]
|
||||||
in := RecordInput{ZoneID: n.ZoneID, Name: &n.Name, Type: &n.Type, Data: &n.Data, Comment: &n.Comment, Disabled: &n.Disabled}
|
in := RecordInput{ZoneID: n.ZoneID, Name: &n.Name, Type: &n.Type, Data: &n.Data, Comment: &n.Comment, Disabled: &n.Disabled, SharedID: model.Ptr(n.SharedID)}
|
||||||
if n.TTL != nil {
|
if n.TTL != nil {
|
||||||
in.TTL = model.Some(*n.TTL)
|
in.TTL = model.Some(*n.TTL)
|
||||||
} else {
|
} else {
|
||||||
|
|||||||
+80
-13
@@ -15,6 +15,7 @@ import (
|
|||||||
"io/fs"
|
"io/fs"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"net/netip"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"slices"
|
"slices"
|
||||||
@@ -56,6 +57,10 @@ type Config struct {
|
|||||||
NoReload bool
|
NoReload bool
|
||||||
// SkipCheck disables named-checkconf (only for tests without BIND).
|
// SkipCheck disables named-checkconf (only for tests without BIND).
|
||||||
SkipCheck bool
|
SkipCheck bool
|
||||||
|
// LocalAddrs returns this host's addresses, for working out whether a
|
||||||
|
// server without views is reachable from the internet
|
||||||
|
// (docs/exposure.md). nil: none known.
|
||||||
|
LocalAddrs func() []netip.Addr
|
||||||
}
|
}
|
||||||
|
|
||||||
// Engine applies changesets.
|
// Engine applies changesets.
|
||||||
@@ -110,17 +115,20 @@ type Result struct {
|
|||||||
DryRun bool `json:"dry_run,omitempty"`
|
DryRun bool `json:"dry_run,omitempty"`
|
||||||
Valid bool `json:"valid"`
|
Valid bool `json:"valid"`
|
||||||
Problems []validate.Problem `json:"problems"` // problems this change introduces
|
Problems []validate.Problem `json:"problems"` // problems this change introduces
|
||||||
Existing []validate.Problem `json:"existing_problems,omitempty"`
|
// Risks are the introduced problems that open the server up; applying
|
||||||
Check []CheckMessage `json:"check,omitempty"`
|
// needs AcceptRisk (docs/exposure.md).
|
||||||
CheckOK bool `json:"check_ok"`
|
Risks []validate.Problem `json:"risks,omitempty"`
|
||||||
Diff string `json:"diff"`
|
Existing []validate.Problem `json:"existing_problems,omitempty"`
|
||||||
Files []string `json:"files_changed"`
|
Check []CheckMessage `json:"check,omitempty"`
|
||||||
Serials []SerialChange `json:"serials,omitempty"`
|
CheckOK bool `json:"check_ok"`
|
||||||
Reloaded []string `json:"reloaded,omitempty"`
|
Diff string `json:"diff"`
|
||||||
Warnings []string `json:"warnings,omitempty"`
|
Files []string `json:"files_changed"`
|
||||||
Drift []DriftEntry `json:"drift,omitempty"`
|
Serials []SerialChange `json:"serials,omitempty"`
|
||||||
Ops []model.Op `json:"ops,omitempty"`
|
Reloaded []string `json:"reloaded,omitempty"`
|
||||||
Error *Error `json:"error,omitempty"`
|
Warnings []string `json:"warnings,omitempty"`
|
||||||
|
Drift []DriftEntry `json:"drift,omitempty"`
|
||||||
|
Ops []model.Op `json:"ops,omitempty"`
|
||||||
|
Error *Error `json:"error,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// stored is what is kept in a changeset's result column.
|
// stored is what is kept in a changeset's result column.
|
||||||
@@ -138,6 +146,9 @@ type ApplyOptions struct {
|
|||||||
Force bool
|
Force bool
|
||||||
// NoReload writes the files without reloading named.
|
// NoReload writes the files without reloading named.
|
||||||
NoReload bool
|
NoReload bool
|
||||||
|
// AcceptRisk confirms a change that opens the server up, such as an
|
||||||
|
// open resolver on a public view (validate.RiskCodes).
|
||||||
|
AcceptRisk bool
|
||||||
// wipeZone lets WipeDNSSEC switch signing off for this zone at once.
|
// wipeZone lets WipeDNSSEC switch signing off for this zone at once.
|
||||||
wipeZone int64
|
wipeZone int64
|
||||||
}
|
}
|
||||||
@@ -180,7 +191,46 @@ func ValidateOptions(st *model.State) validate.Options {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (e *Engine) validate(st *model.State) []validate.Problem {
|
func (e *Engine) validate(st *model.State) []validate.Problem {
|
||||||
return validate.State(st, ValidateOptions(st))
|
return validate.State(st, e.validateOptions(st))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *Engine) validateOptions(st *model.State) validate.Options {
|
||||||
|
opts := ValidateOptions(st)
|
||||||
|
if e.cfg.LocalAddrs != nil {
|
||||||
|
opts.LocalAddrs = e.cfg.LocalAddrs()
|
||||||
|
}
|
||||||
|
return opts
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate checks a state as applying it would.
|
||||||
|
func (e *Engine) Validate(st *model.State) []validate.Problem { return e.validate(st) }
|
||||||
|
|
||||||
|
// Exposures says which views (or the server, without views) are
|
||||||
|
// reachable from the internet, and why (docs/exposure.md).
|
||||||
|
func (e *Engine) Exposures(st *model.State) []validate.Exposure {
|
||||||
|
return validate.Exposures(st, e.validateOptions(st))
|
||||||
|
}
|
||||||
|
|
||||||
|
// risks returns the introduced problems that open a public view (or a
|
||||||
|
// public server) up: risky warnings that weren't there before at all. One
|
||||||
|
// that was there already, acknowledged (taking the acknowledgement back)
|
||||||
|
// or not, opens nothing new.
|
||||||
|
func risks(before, introduced []validate.Problem, public map[string]bool) []validate.Problem {
|
||||||
|
type key struct {
|
||||||
|
code, objType, view string
|
||||||
|
id int64
|
||||||
|
}
|
||||||
|
had := map[key]bool{}
|
||||||
|
for _, p := range before {
|
||||||
|
had[key{p.Code, p.ObjectType, p.View, p.ObjectID}] = true
|
||||||
|
}
|
||||||
|
var out []validate.Problem
|
||||||
|
for _, p := range introduced {
|
||||||
|
if p.Severity == validate.Warning && validate.RiskCodes[p.Code] && public[p.View] && !had[key{p.Code, p.ObjectType, p.View, p.ObjectID}] {
|
||||||
|
out = append(out, p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
// ---- changeset management
|
// ---- changeset management
|
||||||
@@ -235,7 +285,7 @@ func (e *Engine) expandAll(ctx context.Context, work *model.State, reqs []Reques
|
|||||||
var warnings []string
|
var warnings []string
|
||||||
c := &applyCtx{p: p, now: e.Now()}
|
c := &applyCtx{p: p, now: e.Now()}
|
||||||
for i, req := range reqs {
|
for i, req := range reqs {
|
||||||
x := &expander{ctx: ctx, st: work, alloc: e.store.AllocateIDs, p: p, now: e.Now()}
|
x := &expander{ctx: ctx, st: work, alloc: e.store.AllocateIDs, p: p, now: e.Now(), exposures: e.Exposures}
|
||||||
more, err := x.expand(req)
|
more, err := x.expand(req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if ee, ok := AsError(err); ok && len(reqs) > 1 {
|
if ee, ok := AsError(err); ok && len(reqs) > 1 {
|
||||||
@@ -389,6 +439,8 @@ type plan struct {
|
|||||||
base, work *model.State
|
base, work *model.State
|
||||||
introduced []validate.Problem
|
introduced []validate.Problem
|
||||||
existing []validate.Problem
|
existing []validate.Problem
|
||||||
|
before []validate.Problem // the problems before the change
|
||||||
|
public map[string]bool // public views by name ("": the server), after the change
|
||||||
serials []SerialChange
|
serials []SerialChange
|
||||||
out *render.Output
|
out *render.Output
|
||||||
changed []*render.File
|
changed []*render.File
|
||||||
@@ -419,6 +471,13 @@ func (pl *plan) files() []string {
|
|||||||
func (e *Engine) makePlan(ctx context.Context, base, work *model.State, user string, opts ApplyOptions) (*plan, error) {
|
func (e *Engine) makePlan(ctx context.Context, base, work *model.State, user string, opts ApplyOptions) (*plan, error) {
|
||||||
pl := &plan{base: base, work: work, verify: map[int64]uint32{}}
|
pl := &plan{base: base, work: work, verify: map[int64]uint32{}}
|
||||||
before := e.validate(base)
|
before := e.validate(base)
|
||||||
|
pl.before = before
|
||||||
|
pl.public = map[string]bool{}
|
||||||
|
for _, x := range e.Exposures(work) {
|
||||||
|
pl.public[x.View] = x.Public
|
||||||
|
// Server-wide findings (no view) count when anything is public.
|
||||||
|
pl.public[""] = pl.public[""] || x.Public
|
||||||
|
}
|
||||||
after := e.validate(work)
|
after := e.validate(work)
|
||||||
pl.introduced = append(validate.Introduced(before, after), e.dnssecChanges(base, work, opts)...)
|
pl.introduced = append(validate.Introduced(before, after), e.dnssecChanges(base, work, opts)...)
|
||||||
introducedKeys := map[string]bool{}
|
introducedKeys := map[string]bool{}
|
||||||
@@ -652,6 +711,7 @@ func (pl *plan) result() *Result {
|
|||||||
Files: pl.files(),
|
Files: pl.files(),
|
||||||
Serials: pl.serials,
|
Serials: pl.serials,
|
||||||
Drift: pl.drift,
|
Drift: pl.drift,
|
||||||
|
Risks: risks(pl.before, pl.introduced, pl.public),
|
||||||
}
|
}
|
||||||
r.Valid = r.Valid && r.CheckOK
|
r.Valid = r.Valid && r.CheckOK
|
||||||
if r.Files == nil {
|
if r.Files == nil {
|
||||||
@@ -781,6 +841,13 @@ func (e *Engine) applyOps(ctx context.Context, cs *model.Changeset, reqs []Reque
|
|||||||
if opts.DryRun {
|
if opts.DryRun {
|
||||||
return res, nil
|
return res, nil
|
||||||
}
|
}
|
||||||
|
if rs := risks(pl.before, pl.introduced, pl.public); len(rs) > 0 && !opts.AcceptRisk {
|
||||||
|
msg := rs[0].Message
|
||||||
|
if len(rs) > 1 {
|
||||||
|
msg += fmt.Sprintf(" (and %d more)", len(rs)-1)
|
||||||
|
}
|
||||||
|
return res, &Error{Kind: KindRisk, Message: "this change opens the server up: " + msg + "; apply it again with accept_risk to confirm (jarl: --accept-risk), or acknowledge the finding for good", Problems: rs}
|
||||||
|
}
|
||||||
if len(pl.drift) > 0 && !opts.Force {
|
if len(pl.drift) > 0 && !opts.Force {
|
||||||
var paths []string
|
var paths []string
|
||||||
for _, d := range pl.drift {
|
for _, d := range pl.drift {
|
||||||
|
|||||||
@@ -21,6 +21,7 @@ const (
|
|||||||
KindBIND ErrorKind = "bind_failed" // named-checkconf or rndc failed
|
KindBIND ErrorKind = "bind_failed" // named-checkconf or rndc failed
|
||||||
KindDrift ErrorKind = "drift" // files were changed outside Jarl
|
KindDrift ErrorKind = "drift" // files were changed outside Jarl
|
||||||
KindNotAdopted ErrorKind = "not_adopted" // named does not load Jarl's config yet
|
KindNotAdopted ErrorKind = "not_adopted" // named does not load Jarl's config yet
|
||||||
|
KindRisk ErrorKind = "confirm_risk" // the change opens the server up and needs confirming
|
||||||
)
|
)
|
||||||
|
|
||||||
// Error is an engine error with details for the caller.
|
// Error is an engine error with details for the caller.
|
||||||
|
|||||||
+501
-35
@@ -5,6 +5,7 @@ import (
|
|||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
|
"slices"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -27,6 +28,9 @@ type expander struct {
|
|||||||
p *auth.Principal
|
p *auth.Principal
|
||||||
now time.Time
|
now time.Time
|
||||||
warnings []string
|
warnings []string
|
||||||
|
// exposures classifies the views as public or private (nil in tests:
|
||||||
|
// every view private).
|
||||||
|
exposures func(*model.State) []validate.Exposure
|
||||||
}
|
}
|
||||||
|
|
||||||
func (x *expander) ids(n int) ([]int64, error) {
|
func (x *expander) ids(n int) ([]int64, error) {
|
||||||
@@ -131,9 +135,30 @@ func dateSerial(now time.Time) uint32 {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (x *expander) expand(req Request) ([]model.Op, error) {
|
func (x *expander) expand(req Request) ([]model.Op, error) {
|
||||||
|
ops, err := x.expandOne(req)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
switch req.Op {
|
switch req.Op {
|
||||||
|
case OpRecordCreate, OpRecordUpdate, OpRecordDelete, OpRRSetReplace, OpRecordDisable, OpRecordEnable, OpZoneFillPTR:
|
||||||
|
// Changes to linked zones reach the other zones of the link.
|
||||||
|
return x.linkSync(ops)
|
||||||
|
}
|
||||||
|
return ops, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (x *expander) expandOne(req Request) ([]model.Op, error) {
|
||||||
|
switch req.Op {
|
||||||
|
case OpZoneLink:
|
||||||
|
return x.zoneLink(req)
|
||||||
|
case OpZoneUnlink:
|
||||||
|
return x.zoneUnlink(req)
|
||||||
case OpZoneCreate:
|
case OpZoneCreate:
|
||||||
return x.zoneCreate(req)
|
return x.zoneCreate(req)
|
||||||
|
case OpZoneFillPTR:
|
||||||
|
return x.zoneFillPTR(req)
|
||||||
|
case OpReverseDismiss, OpReverseUndismiss:
|
||||||
|
return x.reverseDismiss(req, req.Op == OpReverseDismiss)
|
||||||
case OpZoneUpdate, OpZoneDelete:
|
case OpZoneUpdate, OpZoneDelete:
|
||||||
z := x.st.Zones[req.ID]
|
z := x.st.Zones[req.ID]
|
||||||
if z == nil {
|
if z == nil {
|
||||||
@@ -152,7 +177,24 @@ func (x *expander) expand(req Request) ([]model.Op, error) {
|
|||||||
}
|
}
|
||||||
return []model.Op{x.versioned(req, z.Version, "enable zone "+zoneDesc(x.st, z))}, nil
|
return []model.Op{x.versioned(req, z.Version, "enable zone "+zoneDesc(x.st, z))}, nil
|
||||||
}
|
}
|
||||||
return []model.Op{x.versioned(req, z.Version, "zone "+verb+" "+zoneDesc(x.st, z))}, nil
|
ops := []model.Op{x.versioned(req, z.Version, "zone "+verb+" "+zoneDesc(x.st, z))}
|
||||||
|
if req.Op == OpZoneDelete {
|
||||||
|
if rest := x.st.LinkedWith(z); len(rest) == 1 {
|
||||||
|
ops = append(ops, x.unlinkOps(rest[0], "unlink zone "+zoneDesc(x.st, rest[0])+": the zone it was linked with is deleted")...)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
var in ZoneInput
|
||||||
|
if err := decode(req.Data, &in); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if in.LinkGroup != nil && *in.LinkGroup != z.LinkGroup {
|
||||||
|
return nil, errf(KindBadRequest, "link zones with zone.link and zone.unlink (jarl zone link / unlink)")
|
||||||
|
}
|
||||||
|
if in.LinkWith != "" {
|
||||||
|
return nil, errf(KindBadRequest, "link_with is for new zones; link existing ones with zone.link (jarl zone link)")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ops, nil
|
||||||
case OpRecordCreate:
|
case OpRecordCreate:
|
||||||
return x.recordCreate(req)
|
return x.recordCreate(req)
|
||||||
case OpRecordUpdate:
|
case OpRecordUpdate:
|
||||||
@@ -228,6 +270,8 @@ func (x *expander) expand(req Request) ([]model.Op, error) {
|
|||||||
return []model.Op{x.versioned(req, o.Version, summary)}, nil
|
return []model.Op{x.versioned(req, o.Version, summary)}, nil
|
||||||
case OpSettingsUpdate:
|
case OpSettingsUpdate:
|
||||||
return []model.Op{newOpRaw(OpSettingsUpdate, 0, 0, req.Data, "update settings")}, nil
|
return []model.Op{newOpRaw(OpSettingsUpdate, 0, 0, req.Data, "update settings")}, nil
|
||||||
|
case OpExposureAck, OpExposureUnack:
|
||||||
|
return x.exposureAck(req, req.Op == OpExposureAck)
|
||||||
case OpBlocklistCreate:
|
case OpBlocklistCreate:
|
||||||
return x.blocklistCreate(req)
|
return x.blocklistCreate(req)
|
||||||
case OpBlocklistUpdate, OpBlocklistDelete:
|
case OpBlocklistUpdate, OpBlocklistDelete:
|
||||||
@@ -339,6 +383,7 @@ func (x *expander) zoneCreate(req Request) ([]model.Op, error) {
|
|||||||
return nil, errf(KindBadRequest, "%v", err)
|
return nil, errf(KindBadRequest, "%v", err)
|
||||||
}
|
}
|
||||||
in.Type = &zt
|
in.Type = &zt
|
||||||
|
viewGiven := in.View != nil || in.ViewID != nil
|
||||||
if in.View != nil {
|
if in.View != nil {
|
||||||
if *in.View != "" {
|
if *in.View != "" {
|
||||||
v := x.st.ViewByName(*in.View)
|
v := x.st.ViewByName(*in.View)
|
||||||
@@ -349,11 +394,97 @@ func (x *expander) zoneCreate(req Request) ([]model.Op, error) {
|
|||||||
}
|
}
|
||||||
in.View = nil
|
in.View = nil
|
||||||
}
|
}
|
||||||
|
if !viewGiven && in.LinkWith == "" && in.CloneFrom == 0 && dnsname.IsReverse(name) {
|
||||||
|
// A reverse zone belongs in the private view whose records use
|
||||||
|
// its addresses (docs/reverse.md).
|
||||||
|
v, err := reverseViewFor(x.st, x.publicViews(), name)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if v != nil {
|
||||||
|
in.ViewID = &v.ID
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var moveOps []model.Op
|
||||||
|
var moved []*model.Record
|
||||||
|
if zt == model.ZonePrimary {
|
||||||
|
// The records a parent zone in the view has under the new zone
|
||||||
|
// move into it: named answers those names from the new zone, so
|
||||||
|
// left behind they would never be served again.
|
||||||
|
vid := int64(0)
|
||||||
|
if in.ViewID != nil {
|
||||||
|
vid = *in.ViewID
|
||||||
|
}
|
||||||
|
if parent := x.parentZone(name, vid); parent != nil {
|
||||||
|
moved = x.recordsUnder(parent, name)
|
||||||
|
switch {
|
||||||
|
case len(moved) == 0:
|
||||||
|
case parent.LinkGroup != 0:
|
||||||
|
x.warnings = append(x.warnings, fmt.Sprintf("zone %s is linked, so its %d records under %s stay there (hidden by the new zone): move them by hand", zoneDesc(x.st, parent), len(moved), dnsname.Display(name)))
|
||||||
|
moved = nil
|
||||||
|
default:
|
||||||
|
for _, r := range moved {
|
||||||
|
ri := RecordInput{Name: model.Ptr(r.Name), Type: model.Ptr(r.Type), Data: model.Ptr(r.Data)}
|
||||||
|
if r.TTL != nil {
|
||||||
|
ri.TTL = model.Some(*r.TTL)
|
||||||
|
}
|
||||||
|
if r.Comment != "" {
|
||||||
|
ri.Comment = model.Ptr(r.Comment)
|
||||||
|
}
|
||||||
|
if r.Disabled {
|
||||||
|
ri.Disabled = model.Ptr(true)
|
||||||
|
}
|
||||||
|
in.Records = append(in.Records, ri)
|
||||||
|
moveOps = append(moveOps, newOp(OpRecordDelete, r.ID, r.Version, nil, fmt.Sprintf("move %s %s %s from zone %s into the new zone", r.Name, r.Type, r.Data, zoneDesc(x.st, parent))))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fill := in.Fill
|
||||||
|
in.Fill = false
|
||||||
|
if fill {
|
||||||
|
if zt != model.ZonePrimary {
|
||||||
|
return nil, errf(KindBadRequest, "fill only applies to primary zones")
|
||||||
|
}
|
||||||
|
if _, ok := dnsname.PrefixFromReverse(name); !ok {
|
||||||
|
return nil, errf(KindBadRequest, "fill only applies to reverse zones of whole octets or nibbles (like 10.0.10.0/24)")
|
||||||
|
}
|
||||||
|
vid := int64(0)
|
||||||
|
if in.ViewID != nil {
|
||||||
|
vid = *in.ViewID
|
||||||
|
}
|
||||||
|
fills := PTRFills(x.st, vid, name, moved)
|
||||||
|
if len(fills) == 0 {
|
||||||
|
x.warnings = append(x.warnings, fmt.Sprintf("no A or AAAA record of %s has an address in %s, so there was nothing to fill it with", viewOrServer(x.st, vid), dnsname.Display(name)))
|
||||||
|
}
|
||||||
|
x.warnings = append(x.warnings, fillWarnings(fills)...)
|
||||||
|
for _, f := range fills {
|
||||||
|
in.Records = append(in.Records, RecordInput{Name: model.Ptr(f.Name), Type: model.Ptr("PTR"), Data: model.Ptr(f.Target)})
|
||||||
|
}
|
||||||
|
}
|
||||||
nameservers := in.Nameservers
|
nameservers := in.Nameservers
|
||||||
records := in.Records
|
records := in.Records
|
||||||
cloneFrom := in.CloneFrom
|
cloneFrom := in.CloneFrom
|
||||||
zoneOpts := in.Options
|
zoneOpts := in.Options
|
||||||
in.Nameservers, in.Records, in.CloneFrom, in.Options = nil, nil, 0, nil
|
linkWith := in.LinkWith
|
||||||
|
in.Nameservers, in.Records, in.CloneFrom, in.Options, in.LinkWith, in.LinkGroup = nil, nil, 0, nil, "", nil
|
||||||
|
if linkWith != "" {
|
||||||
|
if cloneFrom != 0 {
|
||||||
|
return nil, errf(KindBadRequest, "give clone_from or link_with, not both")
|
||||||
|
}
|
||||||
|
v := x.st.ViewByName(linkWith)
|
||||||
|
if v == nil {
|
||||||
|
return nil, errf(KindNotFound, "view %q does not exist", linkWith)
|
||||||
|
}
|
||||||
|
o := x.st.FindZone(name, v.ID)
|
||||||
|
if o == nil {
|
||||||
|
return nil, errf(KindNotFound, "view %s has no zone %s to link with", v.Name, dnsname.Display(name))
|
||||||
|
}
|
||||||
|
if o.Type != model.ZonePrimary || zt != model.ZonePrimary {
|
||||||
|
return nil, errf(KindBadRequest, "only primary zones can be linked")
|
||||||
|
}
|
||||||
|
cloneFrom = o.ID
|
||||||
|
}
|
||||||
|
|
||||||
set := x.st.Settings
|
set := x.st.Settings
|
||||||
var src *model.Zone
|
var src *model.Zone
|
||||||
@@ -478,9 +609,30 @@ func (x *expander) zoneCreate(req Request) ([]model.Op, error) {
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
var linkOps []model.Op
|
||||||
|
if src != nil && linkWith != "" {
|
||||||
|
// The new zone joins src's link, or starts one with src: then
|
||||||
|
// all of src's records become shared.
|
||||||
|
group := src.LinkGroup
|
||||||
|
if group == 0 {
|
||||||
|
group = src.ID
|
||||||
|
linkOps = x.shareAllOps(src, group)
|
||||||
|
}
|
||||||
|
in.LinkGroup = &group
|
||||||
|
}
|
||||||
if src != nil {
|
if src != nil {
|
||||||
for _, r := range x.st.ZoneRecords(src.ID) {
|
for _, r := range x.st.ZoneRecords(src.ID) {
|
||||||
|
if linkWith != "" && src.LinkGroup != 0 && r.SharedID == 0 {
|
||||||
|
continue // local to src's view
|
||||||
|
}
|
||||||
ri := RecordInput{Name: model.Ptr(r.Name), Type: model.Ptr(r.Type), Data: model.Ptr(r.Data), Comment: model.Ptr(r.Comment)}
|
ri := RecordInput{Name: model.Ptr(r.Name), Type: model.Ptr(r.Type), Data: model.Ptr(r.Data), Comment: model.Ptr(r.Comment)}
|
||||||
|
if linkWith != "" {
|
||||||
|
id := r.SharedID
|
||||||
|
if id == 0 {
|
||||||
|
id = r.ID
|
||||||
|
}
|
||||||
|
ri.SharedID = &id
|
||||||
|
}
|
||||||
if r.Disabled {
|
if r.Disabled {
|
||||||
ri.Disabled = model.Ptr(true)
|
ri.Disabled = model.Ptr(true)
|
||||||
}
|
}
|
||||||
@@ -510,10 +662,12 @@ func (x *expander) zoneCreate(req Request) ([]model.Op, error) {
|
|||||||
summary += " in view " + v.Name
|
summary += " in view " + v.Name
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if src != nil {
|
if src != nil && linkWith != "" {
|
||||||
|
summary += " (linked with " + zoneDesc(x.st, src) + ")"
|
||||||
|
} else if src != nil {
|
||||||
summary += " (copy of " + zoneDesc(x.st, src) + ")"
|
summary += " (copy of " + zoneDesc(x.st, src) + ")"
|
||||||
}
|
}
|
||||||
ops := []model.Op{newOp(OpZoneCreate, ids[0], 0, in, summary)}
|
ops := append(linkOps, newOp(OpZoneCreate, ids[0], 0, in, summary))
|
||||||
for i, zo := range zoneOpts {
|
for i, zo := range zoneOpts {
|
||||||
oi := OptionInput{Scope: model.Ptr(model.ScopeZone), ScopeID: model.Ptr(ids[0]), Name: model.Ptr(zo.Name), Value: model.Ptr(zo.Value)}
|
oi := OptionInput{Scope: model.Ptr(model.ScopeZone), ScopeID: model.Ptr(ids[0]), Name: model.Ptr(zo.Name), Value: model.Ptr(zo.Value)}
|
||||||
if zo.Comment != "" {
|
if zo.Comment != "" {
|
||||||
@@ -525,7 +679,45 @@ func (x *expander) zoneCreate(req Request) ([]model.Op, error) {
|
|||||||
r.in.ZoneID = ids[0]
|
r.in.ZoneID = ids[0]
|
||||||
ops = append(ops, newOp(OpRecordCreate, ids[1+i], 0, r.in, r.summary))
|
ops = append(ops, newOp(OpRecordCreate, ids[1+i], 0, r.in, r.summary))
|
||||||
}
|
}
|
||||||
return ops, nil
|
return append(ops, moveOps...), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parentZone returns the most specific primary zone in a view that
|
||||||
|
// contains name (not name itself).
|
||||||
|
func (x *expander) parentZone(name string, viewID int64) *model.Zone {
|
||||||
|
var best *model.Zone
|
||||||
|
for _, z := range x.st.ZonesInView(viewID) {
|
||||||
|
if z.Type == model.ZonePrimary && dnsname.IsStrictSubdomain(name, z.Name) && (best == nil || len(z.Name) > len(best.Name)) {
|
||||||
|
best = z
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return best
|
||||||
|
}
|
||||||
|
|
||||||
|
// recordsUnder returns a zone's records at or below name, except a
|
||||||
|
// delegation's NS and DS records and its glue, which belong to the parent.
|
||||||
|
func (x *expander) recordsUnder(z *model.Zone, name string) []*model.Record {
|
||||||
|
all := x.st.ZoneRecords(z.ID)
|
||||||
|
var ns []string
|
||||||
|
for _, r := range all {
|
||||||
|
if r.Name == name && r.Type == "NS" {
|
||||||
|
ns = append(ns, strings.ToLower(r.Data))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var out []*model.Record
|
||||||
|
for _, r := range all {
|
||||||
|
if !dnsname.IsSubdomain(r.Name, name) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if r.Name == name && (r.Type == "NS" || r.Type == "DS") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if (r.Type == "A" || r.Type == "AAAA") && slices.Contains(ns, strings.ToLower(r.Name)) {
|
||||||
|
continue // glue
|
||||||
|
}
|
||||||
|
out = append(out, r)
|
||||||
|
}
|
||||||
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
func deref(s *string) string {
|
func deref(s *string) string {
|
||||||
@@ -560,16 +752,52 @@ func addrOf(p *rr.Parsed) (netip.Addr, bool) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// ptrOps returns operations creating the PTR record for an address record.
|
// ptrOps returns operations creating the PTR record for an address record.
|
||||||
func (x *expander) ptrCreate(z *model.Zone, owner string, p *rr.Parsed) ([]model.Op, error) {
|
//
|
||||||
|
// auto is set when the zone's auto_ptr asked rather than the request: a
|
||||||
|
// missing reverse zone isn't worth a warning then (most addresses have
|
||||||
|
// none), and an address whose PTR record names another host keeps it.
|
||||||
|
func (x *expander) ptrCreate(z *model.Zone, owner string, p *rr.Parsed, auto bool) ([]model.Op, error) {
|
||||||
addr, ok := addrOf(p)
|
addr, ok := addrOf(p)
|
||||||
if !ok {
|
if !ok {
|
||||||
return nil, errf(KindBadRequest, "ptr only applies to A and AAAA records")
|
return nil, errf(KindBadRequest, "ptr only applies to A and AAAA records")
|
||||||
}
|
}
|
||||||
rz, ptrName := reverseZoneFor(x.st, z.ViewID, addr)
|
var ops []model.Op
|
||||||
if rz == nil {
|
found := false
|
||||||
x.warnings = append(x.warnings, fmt.Sprintf("no reverse zone for %s in this view, so no PTR record was added", addr))
|
for _, vid := range ptrViews(x.st, z) {
|
||||||
return nil, nil
|
rz, ptrName := reverseZoneFor(x.st, vid, addr)
|
||||||
|
if rz == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
found = true
|
||||||
|
more, err := x.ptrCreateIn(rz, ptrName, owner, auto)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
ops = append(ops, more...)
|
||||||
}
|
}
|
||||||
|
if !found && !auto {
|
||||||
|
x.warnings = append(x.warnings, fmt.Sprintf("no reverse zone for %s in this view, so no PTR record was added (create one: jarl zone create %s/%d)", addr, addr, addr.BitLen()))
|
||||||
|
}
|
||||||
|
return ops, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ptrViews are the views whose reverse zones get the PTR records of zone
|
||||||
|
// z's address records: z's own, and, for a linked zone, the other views
|
||||||
|
// of the link (the record is in all of them).
|
||||||
|
func ptrViews(st *model.State, z *model.Zone) []int64 {
|
||||||
|
out := []int64{z.ViewID}
|
||||||
|
for _, o := range st.LinkedWith(z) {
|
||||||
|
if !slices.Contains(out, o.ViewID) {
|
||||||
|
out = append(out, o.ViewID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// ptrCreateIn returns operations creating the PTR record ptrName -> owner
|
||||||
|
// in reverse zone rz (none when it is there; enabling it when disabled).
|
||||||
|
func (x *expander) ptrCreateIn(rz *model.Zone, ptrName, owner string, auto bool) ([]model.Op, error) {
|
||||||
|
var other string
|
||||||
for _, r := range x.st.ZoneRecords(rz.ID) {
|
for _, r := range x.st.ZoneRecords(rz.ID) {
|
||||||
if r.Name == ptrName && r.Type == "PTR" {
|
if r.Name == ptrName && r.Type == "PTR" {
|
||||||
if strings.EqualFold(r.Data, owner) {
|
if strings.EqualFold(r.Data, owner) {
|
||||||
@@ -579,9 +807,18 @@ func (x *expander) ptrCreate(z *model.Zone, owner string, p *rr.Parsed) ([]model
|
|||||||
}
|
}
|
||||||
return nil, nil // already there
|
return nil, nil // already there
|
||||||
}
|
}
|
||||||
x.warnings = append(x.warnings, fmt.Sprintf("%s already has a PTR record (%s); adding another one", ptrName, r.Data))
|
if !r.Disabled {
|
||||||
|
other = r.Data
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if other != "" {
|
||||||
|
if auto {
|
||||||
|
// One name per address: the one it has stays.
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
x.warnings = append(x.warnings, fmt.Sprintf("%s already has a PTR record (%s); adding another one", ptrName, other))
|
||||||
|
}
|
||||||
ids, err := x.ids(1)
|
ids, err := x.ids(1)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -597,10 +834,18 @@ func (x *expander) ptrSetDisabled(z *model.Zone, owner string, p *rr.Parsed, dis
|
|||||||
if !ok {
|
if !ok {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
rz, ptrName := reverseZoneFor(x.st, z.ViewID, addr)
|
var ops []model.Op
|
||||||
if rz == nil {
|
for _, vid := range ptrViews(x.st, z) {
|
||||||
return nil
|
rz, ptrName := reverseZoneFor(x.st, vid, addr)
|
||||||
|
if rz == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
ops = append(ops, x.ptrSetDisabledIn(rz, ptrName, owner, disabled)...)
|
||||||
}
|
}
|
||||||
|
return ops
|
||||||
|
}
|
||||||
|
|
||||||
|
func (x *expander) ptrSetDisabledIn(rz *model.Zone, ptrName, owner string, disabled bool) []model.Op {
|
||||||
var ops []model.Op
|
var ops []model.Op
|
||||||
for _, r := range x.st.ZoneRecords(rz.ID) {
|
for _, r := range x.st.ZoneRecords(rz.ID) {
|
||||||
if r.Name == ptrName && r.Type == "PTR" && strings.EqualFold(r.Data, owner) && r.Disabled != disabled {
|
if r.Name == ptrName && r.Type == "PTR" && strings.EqualFold(r.Data, owner) && r.Disabled != disabled {
|
||||||
@@ -623,12 +868,16 @@ func (x *expander) ptrDelete(z *model.Zone, owner string, p *rr.Parsed) []model.
|
|||||||
if !ok {
|
if !ok {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
rz, ptrName := reverseZoneFor(x.st, z.ViewID, addr)
|
var ops []model.Op
|
||||||
if rz == nil {
|
for _, vid := range ptrViews(x.st, z) {
|
||||||
return nil
|
rz, ptrName := reverseZoneFor(x.st, vid, addr)
|
||||||
|
if rz == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
in := RecordInput{ZoneID: rz.ID, Name: model.Ptr(ptrName), Type: model.Ptr("PTR"), Data: model.Ptr(owner), MissingOK: true}
|
||||||
|
ops = append(ops, newOp(OpRecordDelete, 0, 0, in, fmt.Sprintf("delete %s IN PTR %s (if present)", ptrName, owner)))
|
||||||
}
|
}
|
||||||
in := RecordInput{ZoneID: rz.ID, Name: model.Ptr(ptrName), Type: model.Ptr("PTR"), Data: model.Ptr(owner), MissingOK: true}
|
return ops
|
||||||
return []model.Op{newOp(OpRecordDelete, 0, 0, in, fmt.Sprintf("delete %s IN PTR %s (if present)", ptrName, owner))}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// parseWarnings keeps what parsing noticed (e.g. a name read as absolute).
|
// parseWarnings keeps what parsing noticed (e.g. a name read as absolute).
|
||||||
@@ -657,16 +906,37 @@ func (x *expander) recordCreate(req Request) ([]model.Op, error) {
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
x.parseWarnings(owner, p)
|
x.parseWarnings(owner, p)
|
||||||
ptr := in.PTR
|
ptr, auto := in.PTR, !in.PTR && autoPTR(z, owner, p)
|
||||||
in.ZoneID, in.Zone, in.View, in.PTR = z.ID, "", "", false
|
in.ZoneID, in.Zone, in.View, in.PTR = z.ID, "", "", false
|
||||||
in.Name, in.Type, in.Data = &owner, &p.Type, &p.Data
|
in.Name, in.Type, in.Data = &owner, &p.Type, &p.Data
|
||||||
ids, err := x.ids(1)
|
ids, err := x.ids(1)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
ops := []model.Op{newOp(OpRecordCreate, ids[0], 0, in, fmt.Sprintf("add %s%s IN %s %s", owner, ttlText(in.TTL), p.Type, p.Data))}
|
summary := fmt.Sprintf("add %s%s IN %s %s", owner, ttlText(in.TTL), p.Type, p.Data)
|
||||||
if ptr {
|
in.SharedID = nil
|
||||||
more, err := x.ptrCreate(z, owner, p)
|
if z.LinkGroup != 0 {
|
||||||
|
local, err := x.localFor(z, owner, p.Type, in.Local)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if local {
|
||||||
|
in.SharedID = model.Ptr(int64(0))
|
||||||
|
summary += " (local to view " + x.st.ViewName(z) + ")"
|
||||||
|
} else {
|
||||||
|
if x.st.HasLocal(z.ID, owner, p.Type) {
|
||||||
|
return nil, errf(KindConflict, "%s %s is local in view %s; share the set first (jarl record update ID --shared) or add this one as local", dnsname.Display(owner), p.Type, x.st.ViewName(z))
|
||||||
|
}
|
||||||
|
in.SharedID = &ids[0]
|
||||||
|
}
|
||||||
|
} else if in.Local != nil && !*in.Local {
|
||||||
|
return nil, notLinked(x.st, z)
|
||||||
|
}
|
||||||
|
// local on a zone that isn't linked: its records are local anyway.
|
||||||
|
in.Local = nil
|
||||||
|
ops := []model.Op{newOp(OpRecordCreate, ids[0], 0, in, summary)}
|
||||||
|
if ptr || auto && (in.Disabled == nil || !*in.Disabled) {
|
||||||
|
more, err := x.ptrCreate(z, owner, p, auto)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -688,6 +958,36 @@ func (x *expander) recordUpdate(req Request) ([]model.Op, error) {
|
|||||||
ptr := in.PTR
|
ptr := in.PTR
|
||||||
in.PTR = false
|
in.PTR = false
|
||||||
in.Zone, in.View = "", ""
|
in.Zone, in.View = "", ""
|
||||||
|
if in.SharedID != nil {
|
||||||
|
return nil, errf(KindBadRequest, "shared_id is managed by Jarl; use local: true or false to make a record local to its view or shared")
|
||||||
|
}
|
||||||
|
var pre []model.Op
|
||||||
|
if in.Local != nil {
|
||||||
|
if z.LinkGroup == 0 && !*in.Local {
|
||||||
|
return nil, notLinked(x.st, z)
|
||||||
|
}
|
||||||
|
if want := *in.Local; z.LinkGroup != 0 && want != (r.SharedID == 0) {
|
||||||
|
// The whole set of this name and type changes sides.
|
||||||
|
for _, o := range x.st.RRset(z.ID, r.Name, r.Type) {
|
||||||
|
id := int64(0)
|
||||||
|
what := fmt.Sprintf("make %s %s local to view %s", o.Name, o.Type, x.st.ViewName(z))
|
||||||
|
if !want {
|
||||||
|
id = o.ID
|
||||||
|
what = fmt.Sprintf("share %s %s %s with the linked views", o.Name, o.Type, o.Data)
|
||||||
|
}
|
||||||
|
pre = append(pre, newOp(OpRecordUpdate, o.ID, o.Version, RecordInput{SharedID: model.Ptr(id)}, what))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if z.LinkGroup != 0 && !*in.Local {
|
||||||
|
// Sharing a version makes it every view's, also when it is
|
||||||
|
// shared already and another view overrides it.
|
||||||
|
pre = append(pre, x.dropOverrides(z, r.Name, r.Type)...)
|
||||||
|
}
|
||||||
|
in.Local = nil
|
||||||
|
if string(mustJSON(in)) == "{}" {
|
||||||
|
return pre, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
name, typ, data := r.Name, r.Type, r.Data
|
name, typ, data := r.Name, r.Type, r.Data
|
||||||
if in.Name != nil {
|
if in.Name != nil {
|
||||||
name = *in.Name
|
name = *in.Name
|
||||||
@@ -749,22 +1049,61 @@ func (x *expander) recordUpdate(req Request) ([]model.Op, error) {
|
|||||||
case len(changes) > 0:
|
case len(changes) > 0:
|
||||||
summary += ": " + strings.Join(changes, ", ")
|
summary += ": " + strings.Join(changes, ", ")
|
||||||
}
|
}
|
||||||
|
if z.LinkGroup != 0 && r.SharedID != 0 && len(pre) == 0 && (owner != r.Name || p.Type != r.Type) && x.st.HasLocal(z.ID, owner, p.Type) {
|
||||||
|
return nil, errf(KindConflict, "%s %s is local in view %s, so a shared record can't move there", dnsname.Display(owner), p.Type, x.st.ViewName(z))
|
||||||
|
}
|
||||||
base := req.BaseVersion
|
base := req.BaseVersion
|
||||||
if base == 0 {
|
if base == 0 {
|
||||||
base = r.Version
|
base = r.Version
|
||||||
}
|
}
|
||||||
ops := []model.Op{newOp(OpRecordUpdate, r.ID, base, in, summary)}
|
if len(pre) > 0 {
|
||||||
|
base = 0 // the record was just updated by pre
|
||||||
|
}
|
||||||
|
ops := pre
|
||||||
|
if string(mustJSON(in)) != "{}" || !ptr {
|
||||||
|
ops = append(ops, newOp(OpRecordUpdate, r.ID, base, in, summary))
|
||||||
|
}
|
||||||
disabled := r.Disabled
|
disabled := r.Disabled
|
||||||
if in.Disabled != nil {
|
if in.Disabled != nil {
|
||||||
disabled = *in.Disabled
|
disabled = *in.Disabled
|
||||||
}
|
}
|
||||||
moved := p.Data != r.Data || owner != r.Name
|
moved := p.Data != r.Data || owner != r.Name || p.Type != r.Type
|
||||||
|
if !ptr && z.AutoPTR {
|
||||||
|
// The zone keeps PTR records in step (docs/reverse.md): as if
|
||||||
|
// asked, for whichever of the old and new record is an address.
|
||||||
|
old, err := rr.Parse(z.Name, r.Name, r.Type, r.Data)
|
||||||
|
oldAuto := err == nil && autoPTR(z, r.Name, old)
|
||||||
|
newAuto := autoPTR(z, owner, p)
|
||||||
|
switch {
|
||||||
|
case moved:
|
||||||
|
if oldAuto {
|
||||||
|
ops = append(ops, x.ptrDelete(z, r.Name, old)...)
|
||||||
|
}
|
||||||
|
if newAuto && !disabled {
|
||||||
|
more, err := x.ptrCreate(z, owner, p, true)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
ops = append(ops, more...)
|
||||||
|
}
|
||||||
|
case toggled && newAuto && disabled:
|
||||||
|
ops = append(ops, x.ptrSetDisabled(z, owner, p, true)...)
|
||||||
|
case toggled && newAuto:
|
||||||
|
// Enables the PTR record, or adds it when it is missing.
|
||||||
|
more, err := x.ptrCreate(z, owner, p, true)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
ops = append(ops, more...)
|
||||||
|
}
|
||||||
|
return ops, nil
|
||||||
|
}
|
||||||
if ptr && moved {
|
if ptr && moved {
|
||||||
if old, err := rr.Parse(z.Name, r.Name, r.Type, r.Data); err == nil {
|
if old, err := rr.Parse(z.Name, r.Name, r.Type, r.Data); err == nil {
|
||||||
ops = append(ops, x.ptrDelete(z, r.Name, old)...)
|
ops = append(ops, x.ptrDelete(z, r.Name, old)...)
|
||||||
}
|
}
|
||||||
if !disabled {
|
if !disabled {
|
||||||
more, err := x.ptrCreate(z, owner, p)
|
more, err := x.ptrCreate(z, owner, p, false)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -777,6 +1116,15 @@ func (x *expander) recordUpdate(req Request) ([]model.Op, error) {
|
|||||||
}
|
}
|
||||||
ops = append(ops, x.ptrSetDisabled(z, owner, p, disabled)...)
|
ops = append(ops, x.ptrSetDisabled(z, owner, p, disabled)...)
|
||||||
}
|
}
|
||||||
|
if ptr && !moved && !toggled && !disabled {
|
||||||
|
// Nothing else changes: make sure the PTR record is there (the
|
||||||
|
// reverse zone may be newer than the record).
|
||||||
|
more, err := x.ptrCreate(z, owner, p, false)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
ops = append(ops, more...)
|
||||||
|
}
|
||||||
return ops, nil
|
return ops, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -798,11 +1146,9 @@ func (x *expander) recordDelete(req Request) ([]model.Op, error) {
|
|||||||
base = r.Version
|
base = r.Version
|
||||||
}
|
}
|
||||||
ops := []model.Op{newOp(OpRecordDelete, r.ID, base, nil, fmt.Sprintf("delete %s %s %s", r.Name, r.Type, r.Data))}
|
ops := []model.Op{newOp(OpRecordDelete, r.ID, base, nil, fmt.Sprintf("delete %s %s %s", r.Name, r.Type, r.Data))}
|
||||||
if in.PTR {
|
z := x.st.Zones[r.ZoneID]
|
||||||
z := x.st.Zones[r.ZoneID]
|
if p, err := rr.Parse(z.Name, r.Name, r.Type, r.Data); err == nil && (in.PTR || autoPTR(z, r.Name, p)) {
|
||||||
if p, err := rr.Parse(z.Name, r.Name, r.Type, r.Data); err == nil {
|
ops = append(ops, x.ptrDelete(z, r.Name, p)...)
|
||||||
ops = append(ops, x.ptrDelete(z, r.Name, p)...)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
return ops, nil
|
return ops, nil
|
||||||
}
|
}
|
||||||
@@ -842,8 +1188,19 @@ func (x *expander) recordDelete(req Request) ([]model.Op, error) {
|
|||||||
in.ZoneID, in.Zone, in.View, in.PTR = z.ID, "", "", false
|
in.ZoneID, in.Zone, in.View, in.PTR = z.ID, "", "", false
|
||||||
in.Name, in.Type = &owner, &typ
|
in.Name, in.Type = &owner, &typ
|
||||||
ops := []model.Op{newOp(OpRecordDelete, 0, 0, in, "delete "+what)}
|
ops := []model.Op{newOp(OpRecordDelete, 0, 0, in, "delete "+what)}
|
||||||
if ptr && parsed != nil {
|
switch {
|
||||||
|
case ptr && parsed != nil:
|
||||||
ops = append(ops, x.ptrDelete(z, owner, parsed)...)
|
ops = append(ops, x.ptrDelete(z, owner, parsed)...)
|
||||||
|
case z.AutoPTR:
|
||||||
|
// Every matching record's PTR record goes too.
|
||||||
|
for _, r := range x.st.RRset(z.ID, owner, typ) {
|
||||||
|
if parsed != nil && r.Data != parsed.Data {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if p, err := rr.Parse(z.Name, r.Name, r.Type, r.Data); err == nil && autoPTR(z, r.Name, p) {
|
||||||
|
ops = append(ops, x.ptrDelete(z, r.Name, p)...)
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return ops, nil
|
return ops, nil
|
||||||
}
|
}
|
||||||
@@ -951,17 +1308,60 @@ func (x *expander) rrsetReplace(req Request) ([]model.Op, error) {
|
|||||||
canon = append(canon, p.Data)
|
canon = append(canon, p.Data)
|
||||||
}
|
}
|
||||||
in.ZoneID, in.Zone, in.View, in.Name, in.Type, in.Data = z.ID, "", "", owner, typ, canon
|
in.ZoneID, in.Zone, in.View, in.Name, in.Type, in.Data = z.ID, "", "", owner, typ, canon
|
||||||
|
where := ""
|
||||||
|
var pre []model.Op
|
||||||
|
if z.LinkGroup != 0 {
|
||||||
|
local, err := x.localFor(z, owner, typ, in.Local)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
in.Shared = model.Ptr(!local)
|
||||||
|
if local {
|
||||||
|
where = " (local to view " + x.st.ViewName(z) + ")"
|
||||||
|
} else if in.Local != nil {
|
||||||
|
// Explicitly shared: this version becomes every view's.
|
||||||
|
pre = x.dropOverrides(z, owner, typ)
|
||||||
|
}
|
||||||
|
} else if in.Local != nil && !*in.Local {
|
||||||
|
return nil, notLinked(x.st, z)
|
||||||
|
}
|
||||||
|
in.Local = nil
|
||||||
if len(canon) > 0 {
|
if len(canon) > 0 {
|
||||||
in.NewIDs, err = x.ids(len(canon))
|
in.NewIDs, err = x.ids(len(canon))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
summary := fmt.Sprintf("set %s%s IN %s to [%s]", owner, ttlText(in.TTL), typ, strings.Join(canon, ", "))
|
summary := fmt.Sprintf("set %s%s IN %s to [%s]%s", owner, ttlText(in.TTL), typ, strings.Join(canon, ", "), where)
|
||||||
if len(canon) == 0 {
|
if len(canon) == 0 {
|
||||||
summary = fmt.Sprintf("delete all %s records of %s", typ, owner)
|
summary = fmt.Sprintf("delete all %s records of %s%s", typ, owner, where)
|
||||||
}
|
}
|
||||||
return []model.Op{newOp(OpRRSetReplace, 0, 0, in, summary)}, nil
|
ops := append(pre, newOp(OpRRSetReplace, 0, 0, in, summary))
|
||||||
|
if z.AutoPTR && (typ == "A" || typ == "AAAA") && !strings.HasPrefix(owner, "*.") {
|
||||||
|
// PTR records follow the addresses that go and come.
|
||||||
|
old := map[string]bool{}
|
||||||
|
for _, r := range x.st.RRset(z.ID, owner, typ) {
|
||||||
|
old[r.Data] = true
|
||||||
|
if !slices.Contains(canon, r.Data) {
|
||||||
|
if p, err := rr.Parse(z.Name, r.Name, r.Type, r.Data); err == nil {
|
||||||
|
ops = append(ops, x.ptrDelete(z, r.Name, p)...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, d := range canon {
|
||||||
|
if old[d] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if _, p, err := parseRecord(z, owner, typ, d); err == nil {
|
||||||
|
more, err := x.ptrCreate(z, owner, p, true)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
ops = append(ops, more...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ops, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (x *expander) viewCreate(req Request) ([]model.Op, error) {
|
func (x *expander) viewCreate(req Request) ([]model.Op, error) {
|
||||||
@@ -1089,3 +1489,69 @@ func disabledZoneEffect(st *model.State, z *model.Zone) string {
|
|||||||
}
|
}
|
||||||
return fmt.Sprintf("once zone %s is disabled, %s answers REFUSED for its names", dnsname.Display(z.Name), where)
|
return fmt.Sprintf("once zone %s is disabled, %s answers REFUSED for its names", dnsname.Display(z.Name), where)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// exposureAck acknowledges an exposure finding of a view or the server,
|
||||||
|
// or takes the acknowledgement back: the view's (or the settings')
|
||||||
|
// acknowledgements are updated as a whole.
|
||||||
|
func (x *expander) exposureAck(req Request, ack bool) ([]model.Op, error) {
|
||||||
|
var in AckInput
|
||||||
|
if err := decode(req.Data, &in); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
in.Code = strings.TrimSpace(in.Code)
|
||||||
|
if !validate.Ackable(in.Code) {
|
||||||
|
return nil, errf(KindBadRequest, "%q is not an exposure finding that can be acknowledged (exposure_... or security_open_...)", in.Code)
|
||||||
|
}
|
||||||
|
if ack && strings.TrimSpace(in.Reason) == "" {
|
||||||
|
return nil, errf(KindBadRequest, "say why %s is accepted (a reason is required)", in.Code)
|
||||||
|
}
|
||||||
|
var v *model.View
|
||||||
|
switch {
|
||||||
|
case in.ViewID != 0:
|
||||||
|
v = x.st.Views[in.ViewID]
|
||||||
|
case in.View != "":
|
||||||
|
v = x.st.ViewByName(in.View)
|
||||||
|
}
|
||||||
|
if (in.ViewID != 0 || in.View != "") && v == nil {
|
||||||
|
return nil, errf(KindNotFound, "no view %s", firstNonEmptyStr(in.View, fmt.Sprint(in.ViewID)))
|
||||||
|
}
|
||||||
|
acks := x.st.Settings.Acknowledged
|
||||||
|
where := "the server"
|
||||||
|
if v != nil {
|
||||||
|
acks, where = v.Acknowledged, "view "+v.Name
|
||||||
|
}
|
||||||
|
var out []model.Acknowledgement
|
||||||
|
for _, a := range acks {
|
||||||
|
if a.Code != in.Code {
|
||||||
|
out = append(out, a)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
summary := "acknowledge " + in.Code + " for " + where + ": " + strings.TrimSpace(in.Reason)
|
||||||
|
if ack {
|
||||||
|
out = append(out, model.Acknowledgement{Code: in.Code, Reason: strings.TrimSpace(in.Reason), By: x.p.Name(), At: x.now})
|
||||||
|
} else {
|
||||||
|
if len(out) == len(acks) {
|
||||||
|
return nil, errf(KindConflict, "%s isn't acknowledged for %s", in.Code, where)
|
||||||
|
}
|
||||||
|
summary = "take back the acknowledgement of " + in.Code + " for " + where
|
||||||
|
}
|
||||||
|
if out == nil {
|
||||||
|
out = []model.Acknowledgement{}
|
||||||
|
}
|
||||||
|
if v != nil {
|
||||||
|
return []model.Op{newOp(OpViewUpdate, v.ID, v.Version, ViewInput{Acknowledged: &out}, summary)}, nil
|
||||||
|
}
|
||||||
|
return []model.Op{newOp(OpSettingsUpdate, 0, 0, SettingsInput{Acknowledged: &out}, summary)}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func firstNonEmptyStr(a, b string) string {
|
||||||
|
if a != "" {
|
||||||
|
return a
|
||||||
|
}
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
// notLinked refuses sharing a record of a zone that isn't linked.
|
||||||
|
func notLinked(st *model.State, z *model.Zone) error {
|
||||||
|
return errf(KindBadRequest, "zone %s isn't linked with other views, so there is nothing to share its records with (link it first: jarl zone link)", zoneDesc(st, z))
|
||||||
|
}
|
||||||
@@ -0,0 +1,163 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/netip"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"jarl/internal/model"
|
||||||
|
"jarl/internal/namedconf"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ExposureFix returns the requests that fix an exposure finding of a view
|
||||||
|
// (viewID 0: the server), and what they do, or nil when there is no
|
||||||
|
// automatic fix: what to allow instead (your secondaries, your hosts)
|
||||||
|
// is for you to decide. The requests go through a changeset like any
|
||||||
|
// edit (docs/exposure.md).
|
||||||
|
func ExposureFix(st *model.State, viewID int64, code string) ([]Request, string) {
|
||||||
|
v := st.Views[viewID]
|
||||||
|
scope, scopeID := model.ScopeOptions, int64(0)
|
||||||
|
if v != nil {
|
||||||
|
scope, scopeID = model.ScopeView, v.ID
|
||||||
|
}
|
||||||
|
set := func(name, value string) Request {
|
||||||
|
if o := st.FindOption(scope, scopeID, name); o != nil {
|
||||||
|
return NewRequest(OpOptionUpdate, o.ID, OptionInput{Value: &value})
|
||||||
|
}
|
||||||
|
return NewRequest(OpOptionCreate, 0, OptionInput{Scope: &scope, ScopeID: &scopeID, Name: &name, Value: &value})
|
||||||
|
}
|
||||||
|
server := func(name, value string) Request {
|
||||||
|
if o := st.FindOption(model.ScopeOptions, 0, name); o != nil {
|
||||||
|
return NewRequest(OpOptionUpdate, o.ID, OptionInput{Value: &value})
|
||||||
|
}
|
||||||
|
return NewRequest(OpOptionCreate, 0, OptionInput{Scope: model.Ptr(model.ScopeOptions), Name: &name, Value: &value})
|
||||||
|
}
|
||||||
|
switch code {
|
||||||
|
case "exposure_rate_limit":
|
||||||
|
value := RecommendedRateLimit(st, v)
|
||||||
|
return []Request{set("rate-limit", value)}, "start rate limiting in log-only mode: rate-limit " + value
|
||||||
|
case "exposure_rate_limit_log_only":
|
||||||
|
o := st.FindOption(scope, scopeID, "rate-limit")
|
||||||
|
if o == nil {
|
||||||
|
o = st.FindOption(model.ScopeOptions, 0, "rate-limit")
|
||||||
|
}
|
||||||
|
if o == nil {
|
||||||
|
return nil, ""
|
||||||
|
}
|
||||||
|
value := withoutLogOnly(o.Value)
|
||||||
|
return []Request{NewRequest(OpOptionUpdate, o.ID, OptionInput{Value: &value})}, "start enforcing the rate limit: rate-limit " + value
|
||||||
|
case "exposure_minimal_any":
|
||||||
|
return []Request{set("minimal-any", "yes")}, "answer ANY queries minimally: minimal-any yes"
|
||||||
|
case "exposure_cache_snooping":
|
||||||
|
return []Request{set("allow-query-cache", "{ none; }")}, "close the cache to everyone: allow-query-cache { none; }"
|
||||||
|
case "exposure_version":
|
||||||
|
return []Request{server("version", "none")}, "hide BIND's version: version none"
|
||||||
|
case "exposure_hostname":
|
||||||
|
return []Request{server("hostname", "none")}, "hide the host name: hostname none"
|
||||||
|
case "security_open_resolver":
|
||||||
|
if v == nil {
|
||||||
|
return nil, "" // a server without views is also your own resolver
|
||||||
|
}
|
||||||
|
return []Request{set("recursion", "no")}, "turn recursion off in view " + v.Name + ": recursion no"
|
||||||
|
}
|
||||||
|
return nil, ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// RecommendedRateLimit is the rate-limit block Jarl suggests for a public
|
||||||
|
// view (v nil: the server): ISC's example of 10 identical responses per
|
||||||
|
// second per client network, in log-only mode until you have looked at
|
||||||
|
// what it would limit, with your secondaries exempt so zone transfers
|
||||||
|
// and their queries are never limited.
|
||||||
|
func RecommendedRateLimit(st *model.State, v *model.View) string {
|
||||||
|
parts := []string{"responses-per-second 10;", "log-only yes;"}
|
||||||
|
if ex := secondaries(st, v); len(ex) > 0 {
|
||||||
|
parts = append(parts, "exempt-clients { "+strings.Join(ex, "; ")+"; };")
|
||||||
|
}
|
||||||
|
return "{ " + strings.Join(parts, " ") + " }"
|
||||||
|
}
|
||||||
|
|
||||||
|
// secondaries returns the addresses the view's zones notify and allow
|
||||||
|
// transfers to (ACLs resolved), the servers that rate limiting must leave
|
||||||
|
// alone.
|
||||||
|
func secondaries(st *model.State, v *model.View) []string {
|
||||||
|
var opts []*model.Option
|
||||||
|
add := func(scope string, id int64) {
|
||||||
|
for _, name := range []string{"also-notify", "allow-transfer"} {
|
||||||
|
if o := st.FindOption(scope, id, name); o != nil {
|
||||||
|
opts = append(opts, o)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
add(model.ScopeOptions, 0)
|
||||||
|
vid := int64(0)
|
||||||
|
if v != nil {
|
||||||
|
vid = v.ID
|
||||||
|
add(model.ScopeView, v.ID)
|
||||||
|
}
|
||||||
|
for _, z := range st.SortedZones() {
|
||||||
|
if z.ViewID == vid {
|
||||||
|
add(model.ScopeZone, z.ID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
seen := map[string]bool{}
|
||||||
|
var out []string
|
||||||
|
var addElems func(list []string, depth int)
|
||||||
|
addElems = func(list []string, depth int) {
|
||||||
|
for _, s := range list {
|
||||||
|
e, err := namedconf.ParseAMElement(s)
|
||||||
|
if err != nil || e.Negated {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
switch e.Kind {
|
||||||
|
case namedconf.AMPrefix, namedconf.AMRange:
|
||||||
|
if t := e.String(); !seen[t] {
|
||||||
|
seen[t] = true
|
||||||
|
out = append(out, t)
|
||||||
|
}
|
||||||
|
case namedconf.AMName:
|
||||||
|
if a := st.ACLByName(e.Name); a != nil && depth < 10 {
|
||||||
|
addElems(a.Elements, depth+1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, o := range opts {
|
||||||
|
stmt, err := namedconf.ParseOptionValue(o.Name, o.Value)
|
||||||
|
if err != nil || stmt.FirstBlock() == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
var list []string
|
||||||
|
for _, s := range stmt.FirstBlock().Stmts {
|
||||||
|
if o.Name == "also-notify" {
|
||||||
|
// "ADDRESS [port N] [key K]": the address only.
|
||||||
|
if len(s.Items) > 0 && s.Items[0].Value != nil {
|
||||||
|
if _, err := netip.ParseAddr(s.Items[0].Value.Text); err == nil {
|
||||||
|
list = append(list, s.Items[0].Value.Text)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
list = append(list, namedconf.Compact(s.Items))
|
||||||
|
}
|
||||||
|
addElems(list, 0)
|
||||||
|
}
|
||||||
|
slices.Sort(out)
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// withoutLogOnly removes "log-only ...;" from a rate-limit block.
|
||||||
|
func withoutLogOnly(value string) string {
|
||||||
|
st, err := namedconf.ParseOptionValue("rate-limit", value)
|
||||||
|
if err != nil || st.FirstBlock() == nil {
|
||||||
|
return value
|
||||||
|
}
|
||||||
|
b := st.FirstBlock()
|
||||||
|
var keep []*namedconf.Stmt
|
||||||
|
for _, s := range b.Stmts {
|
||||||
|
if s.Keyword() != "log-only" {
|
||||||
|
keep = append(keep, s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
b.Stmts = keep
|
||||||
|
return namedconf.Compact(st.Items[1:])
|
||||||
|
}
|
||||||
@@ -0,0 +1,142 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/netip"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"jarl/internal/model"
|
||||||
|
"jarl/internal/validate"
|
||||||
|
)
|
||||||
|
|
||||||
|
func problemFor(ps []validate.Problem, code, view string) *validate.Problem {
|
||||||
|
for i, p := range ps {
|
||||||
|
if p.Code == code && (view == "" || p.View == view) {
|
||||||
|
return &ps[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestExposure(t *testing.T) {
|
||||||
|
env := newEnv(t)
|
||||||
|
setupZone(env)
|
||||||
|
env.submit(env.admin,
|
||||||
|
// An internal network with a global IPv6 prefix is still yours.
|
||||||
|
NewRequest(OpACLCreate, 0, ACLInput{Name: model.Ptr("internal-clients"), Elements: &[]string{"2a02:8013:7f3d:10::/64", "192.168.1.0/24"}}),
|
||||||
|
optionReq("allow-transfer", "{ 192.0.2.53; }"),
|
||||||
|
)
|
||||||
|
env.submit(env.admin,
|
||||||
|
NewRequest(OpViewCreate, 0, ViewInput{Name: model.Ptr("internal"), MatchClients: &[]string{"internal-clients", "localhost"}, AdoptZones: true}),
|
||||||
|
NewRequest(OpViewCreate, 0, ViewInput{Name: model.Ptr("external"), MatchClients: &[]string{"!internal-clients", "any"}}),
|
||||||
|
NewRequest(OpViewCreate, 0, ViewInput{Name: model.Ptr("dmz"), MatchClients: &[]string{"any"}, MatchDestinations: &[]string{"10.9.0.53"}}),
|
||||||
|
)
|
||||||
|
st := env.state()
|
||||||
|
exps := map[string]validate.Exposure{}
|
||||||
|
for _, x := range env.e.Exposures(st) {
|
||||||
|
exps[x.View] = x
|
||||||
|
}
|
||||||
|
if x := exps["internal"]; x.Public || !strings.Contains(x.Reason, "no catch-all") {
|
||||||
|
t.Errorf("internal = %+v", x)
|
||||||
|
}
|
||||||
|
if x := exps["external"]; !x.Public || x.Reason != "match-clients ends in any" {
|
||||||
|
t.Errorf("external = %+v", x)
|
||||||
|
}
|
||||||
|
if x := exps["dmz"]; x.Public || !strings.Contains(x.Reason, "match-destinations") {
|
||||||
|
t.Errorf("dmz = %+v", x)
|
||||||
|
}
|
||||||
|
|
||||||
|
ps := env.e.validate(st)
|
||||||
|
for _, code := range []string{"exposure_rate_limit", "exposure_minimal_any"} {
|
||||||
|
if problemFor(ps, code, "external") == nil {
|
||||||
|
t.Errorf("no %s for external", code)
|
||||||
|
}
|
||||||
|
if problemFor(ps, code, "internal") != nil || problemFor(ps, code, "dmz") != nil {
|
||||||
|
t.Errorf("%s for a private view", code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, code := range []string{"exposure_version", "exposure_hostname"} {
|
||||||
|
if problemFor(ps, code, "") == nil {
|
||||||
|
t.Errorf("no %s", code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The rate limit fix starts in log-only mode and exempts the
|
||||||
|
// secondaries.
|
||||||
|
ext := st.ViewByName("external")
|
||||||
|
reqs, desc := ExposureFix(st, ext.ID, "exposure_rate_limit")
|
||||||
|
if len(reqs) != 1 || !strings.Contains(desc, "{ responses-per-second 10; log-only yes; exempt-clients { 192.0.2.53; }; }") {
|
||||||
|
t.Fatalf("fix = %v %q", reqs, desc)
|
||||||
|
}
|
||||||
|
env.submit(env.admin, reqs...)
|
||||||
|
ps = env.e.validate(env.state())
|
||||||
|
if problemFor(ps, "exposure_rate_limit", "external") != nil {
|
||||||
|
t.Error("rate limit warning stays after the fix")
|
||||||
|
}
|
||||||
|
if p := problemFor(ps, "exposure_rate_limit_log_only", "external"); p == nil || p.Severity != validate.Info {
|
||||||
|
t.Errorf("log-only = %+v", p)
|
||||||
|
}
|
||||||
|
reqs, desc = ExposureFix(env.state(), ext.ID, "exposure_rate_limit_log_only")
|
||||||
|
if !strings.Contains(desc, "{ responses-per-second 10; exempt-clients { 192.0.2.53; }; }") {
|
||||||
|
t.Errorf("enforce = %q", desc)
|
||||||
|
}
|
||||||
|
env.submit(env.admin, reqs...)
|
||||||
|
if p := problemFor(env.e.validate(env.state()), "exposure_rate_limit_log_only", "external"); p != nil {
|
||||||
|
t.Errorf("still log-only: %+v", p)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Opening the server up needs confirming.
|
||||||
|
open := optionReqView("allow-recursion", "{ any; }", ext.ID)
|
||||||
|
if e := env.submitErr(env.admin, open); e.Kind != KindRisk || !strings.Contains(e.Message, "open resolver") {
|
||||||
|
t.Fatalf("open resolver without confirming: %+v", e)
|
||||||
|
}
|
||||||
|
if _, err := env.e.Submit(env.ctx, []Request{open}, env.admin, "test", "", ApplyOptions{AcceptRisk: true}); err != nil {
|
||||||
|
t.Fatalf("with accept risk: %v", err)
|
||||||
|
}
|
||||||
|
// Acknowledged, it stays as info, with who and why.
|
||||||
|
env.submit(env.admin, NewRequest(OpExposureAck, 0, AckInput{View: "external", Code: "security_open_resolver", Reason: "public resolver for the club"}))
|
||||||
|
p := problemFor(env.e.validate(env.state()), "security_open_resolver", "external")
|
||||||
|
if p == nil || p.Severity != validate.Info || p.Acknowledged == nil || !strings.Contains(p.Message, "acknowledged by admin on 7 Oct 2026: public resolver for the club") {
|
||||||
|
t.Errorf("acknowledged = %+v", p)
|
||||||
|
}
|
||||||
|
if e := env.submitErr(env.admin, NewRequest(OpExposureAck, 0, AckInput{View: "external", Code: "security_open_resolver"})); e.Kind != KindBadRequest {
|
||||||
|
t.Errorf("ack without a reason: %+v", e)
|
||||||
|
}
|
||||||
|
// Reverting the acknowledgement brings the warning back.
|
||||||
|
env.submit(env.admin, NewRequest(OpExposureUnack, 0, AckInput{View: "external", Code: "security_open_resolver"}))
|
||||||
|
if p := problemFor(env.e.validate(env.state()), "security_open_resolver", "external"); p == nil || p.Severity != validate.Warning {
|
||||||
|
t.Errorf("after unack = %+v", p)
|
||||||
|
}
|
||||||
|
// Marking a view private takes it out of the checks.
|
||||||
|
env.submit(env.admin, NewRequest(OpViewUpdate, ext.ID, ViewInput{Exposure: model.Ptr("private")}))
|
||||||
|
if p := problemFor(env.e.validate(env.state()), "security_open_resolver", "external"); p != nil {
|
||||||
|
t.Errorf("private view still checked: %+v", p)
|
||||||
|
}
|
||||||
|
if e := env.submitErr(env.admin, NewRequest(OpViewUpdate, ext.ID, ViewInput{Exposure: model.Ptr("internet")})); e.Kind != KindBadRequest {
|
||||||
|
t.Errorf("bad exposure: %+v", e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A server without views is public only when named listens on an
|
||||||
|
// address that isn't private.
|
||||||
|
func TestServerExposure(t *testing.T) {
|
||||||
|
env := newEnv(t)
|
||||||
|
setupZone(env)
|
||||||
|
if x := env.e.Exposures(env.state())[0]; x.Public {
|
||||||
|
t.Errorf("no addresses known = %+v", x)
|
||||||
|
}
|
||||||
|
env.e.cfg.LocalAddrs = func() []netip.Addr {
|
||||||
|
return []netip.Addr{netip.MustParseAddr("192.168.1.2"), netip.MustParseAddr("2a02:8013:7f3d:10::53")}
|
||||||
|
}
|
||||||
|
if x := env.e.Exposures(env.state())[0]; !x.Public || !strings.Contains(x.Reason, "2a02:8013:7f3d:10::53") {
|
||||||
|
t.Errorf("GUA address = %+v", x)
|
||||||
|
}
|
||||||
|
env.submit(env.admin, NewRequest(OpSettingsUpdate, 0, SettingsInput{Exposure: model.Ptr("private")}))
|
||||||
|
if x := env.e.Exposures(env.state())[0]; x.Public || x.Override != "private" {
|
||||||
|
t.Errorf("marked private = %+v", x)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func optionReqView(name, value string, viewID int64) Request {
|
||||||
|
return NewRequest(OpOptionCreate, 0, OptionInput{Scope: model.Ptr(model.ScopeView), ScopeID: &viewID, Name: &name, Value: &value})
|
||||||
|
}
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"io/fs"
|
||||||
|
)
|
||||||
|
|
||||||
|
// WriteFile writes a file outside the rendered configuration (a
|
||||||
|
// certificate for named, docs/certificates.md) the way deployed files are
|
||||||
|
// written: atomically, with bind.file_group, creating its directory.
|
||||||
|
func (e *Engine) WriteFile(path string, content []byte, mode fs.FileMode) error {
|
||||||
|
return e.deploy.writeAtomic(path, content, mode)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reconfig makes named reread its configuration, and with it the files
|
||||||
|
// its tls blocks name (nothing with bind.no_reload).
|
||||||
|
func (e *Engine) Reconfig(ctx context.Context) error {
|
||||||
|
if e.cfg.NoReload {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return e.tools.Reconfig(ctx)
|
||||||
|
}
|
||||||
@@ -51,8 +51,42 @@ const (
|
|||||||
// operations.
|
// operations.
|
||||||
OpRecordDisable = "record.disable"
|
OpRecordDisable = "record.disable"
|
||||||
OpRecordEnable = "record.enable"
|
OpRecordEnable = "record.enable"
|
||||||
|
// Acknowledging an exposure finding (docs/exposure.md), and taking it
|
||||||
|
// back, become view.update or settings.update operations.
|
||||||
|
OpExposureAck = "exposure.ack"
|
||||||
|
OpExposureUnack = "exposure.unack"
|
||||||
|
// Linked zones (docs/views.md#linked-zones): requests that expand
|
||||||
|
// into zone and record updates.
|
||||||
|
OpZoneLink = "zone.link"
|
||||||
|
OpZoneUnlink = "zone.unlink"
|
||||||
|
// Filling a reverse zone with the PTR records of its view's A and
|
||||||
|
// AAAA records (docs/reverse.md) becomes record.create operations.
|
||||||
|
OpZoneFillPTR = "zone.fill_ptr"
|
||||||
|
// Dismissing a reverse zone suggestion, and taking that back, become
|
||||||
|
// view.update or settings.update operations.
|
||||||
|
OpReverseDismiss = "reverse.dismiss"
|
||||||
|
OpReverseUndismiss = "reverse.undismiss"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// DismissInput dismisses a reverse zone suggestion: a network in a view
|
||||||
|
// (by ID or name), or the server's (neither given).
|
||||||
|
type DismissInput struct {
|
||||||
|
ViewID int64 `json:"view_id,omitempty"`
|
||||||
|
View string `json:"view,omitempty"`
|
||||||
|
Prefix string `json:"prefix,omitempty"`
|
||||||
|
// Prefixes dismisses (or brings back) several at once.
|
||||||
|
Prefixes []string `json:"prefixes,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AckInput acknowledges (or un-acknowledges) an exposure finding of a view
|
||||||
|
// (by ID or name), or of the server (neither given).
|
||||||
|
type AckInput struct {
|
||||||
|
ViewID int64 `json:"view_id,omitempty"`
|
||||||
|
View string `json:"view,omitempty"`
|
||||||
|
Code string `json:"code"`
|
||||||
|
Reason string `json:"reason,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
// OpKinds lists all operation kinds.
|
// OpKinds lists all operation kinds.
|
||||||
var OpKinds = []string{OpZoneCreate, OpZoneUpdate, OpZoneDelete, OpRecordCreate, OpRecordUpdate, OpRecordDelete, OpRRSetReplace,
|
var OpKinds = []string{OpZoneCreate, OpZoneUpdate, OpZoneDelete, OpRecordCreate, OpRecordUpdate, OpRecordDelete, OpRRSetReplace,
|
||||||
OpViewCreate, OpViewUpdate, OpViewDelete, OpViewReorder, OpACLCreate, OpACLUpdate, OpACLDelete,
|
OpViewCreate, OpViewUpdate, OpViewDelete, OpViewReorder, OpACLCreate, OpACLUpdate, OpACLDelete,
|
||||||
@@ -118,6 +152,19 @@ type ZoneInput struct {
|
|||||||
Comment *string `json:"comment,omitempty"`
|
Comment *string `json:"comment,omitempty"`
|
||||||
// Disabled keeps the zone in Jarl but out of named's configuration.
|
// Disabled keeps the zone in Jarl but out of named's configuration.
|
||||||
Disabled *bool `json:"disabled,omitempty"`
|
Disabled *bool `json:"disabled,omitempty"`
|
||||||
|
// LinkGroup is the zone's link group (0: not linked). Set by zone.link
|
||||||
|
// and zone.unlink; requests use those.
|
||||||
|
LinkGroup *int64 `json:"link_group,omitempty"`
|
||||||
|
// LinkWith (create only) links the new zone with the zone of the same
|
||||||
|
// name in this view, copying its shared records (or all of its
|
||||||
|
// records, when it isn't linked yet).
|
||||||
|
LinkWith string `json:"link_with,omitempty"`
|
||||||
|
// AutoPTR keeps the PTR records of the zone's A and AAAA records in
|
||||||
|
// step (docs/reverse.md).
|
||||||
|
AutoPTR *bool `json:"auto_ptr,omitempty"`
|
||||||
|
// Fill (create only, reverse zones) adds a PTR record for every
|
||||||
|
// address of the view's A and AAAA records in the zone's range.
|
||||||
|
Fill bool `json:"fill,omitempty"`
|
||||||
|
|
||||||
// Create only: name servers for the apex NS records (default: the
|
// Create only: name servers for the apex NS records (default: the
|
||||||
// configured default name servers), additional records, and a zone to
|
// configured default name servers), additional records, and a zone to
|
||||||
@@ -150,10 +197,31 @@ type RecordInput struct {
|
|||||||
// Disabled keeps the record in Jarl but out of the zone.
|
// Disabled keeps the record in Jarl but out of the zone.
|
||||||
Disabled *bool `json:"disabled,omitempty"`
|
Disabled *bool `json:"disabled,omitempty"`
|
||||||
// PTR also creates (or deletes, disables or enables) the matching PTR
|
// PTR also creates (or deletes, disables or enables) the matching PTR
|
||||||
// record in the reverse zone, for A and AAAA records.
|
// record in the reverse zone, for A and AAAA records. On an update that
|
||||||
|
// changes nothing else it adds the PTR record if it is missing. In a
|
||||||
|
// linked zone, every linked view's reverse zone counts.
|
||||||
PTR bool `json:"ptr,omitempty"`
|
PTR bool `json:"ptr,omitempty"`
|
||||||
// MissingOK makes a delete-by-match succeed when nothing matches.
|
// MissingOK makes a delete-by-match succeed when nothing matches.
|
||||||
MissingOK bool `json:"missing_ok,omitempty"`
|
MissingOK bool `json:"missing_ok,omitempty"`
|
||||||
|
// Local (requests, linked zones): true keeps the record in this view
|
||||||
|
// only (an override: the whole name and type becomes local here);
|
||||||
|
// false shares it with the linked zones. Unset: like the records of
|
||||||
|
// the same name and type, shared when there are none.
|
||||||
|
Local *bool `json:"local,omitempty"`
|
||||||
|
// SharedID (stored operations) ties the copies of a shared record
|
||||||
|
// together; 0 makes it local.
|
||||||
|
SharedID *int64 `json:"shared_id,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// LinkInput links zones of the same name in several views, or (unlink)
|
||||||
|
// takes one out of its link.
|
||||||
|
type LinkInput struct {
|
||||||
|
ZoneID int64 `json:"zone_id,omitempty"`
|
||||||
|
Zone string `json:"zone,omitempty"`
|
||||||
|
View string `json:"view,omitempty"`
|
||||||
|
// With are the views whose zone of the same name to link with (link
|
||||||
|
// only; default: every view that has one).
|
||||||
|
With []string `json:"with,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// RRSetInput replaces all records of one name and type.
|
// RRSetInput replaces all records of one name and type.
|
||||||
@@ -168,6 +236,11 @@ type RRSetInput struct {
|
|||||||
Comment *string `json:"comment,omitempty"`
|
Comment *string `json:"comment,omitempty"`
|
||||||
// NewIDs are allocated for records that need to be created.
|
// NewIDs are allocated for records that need to be created.
|
||||||
NewIDs []int64 `json:"new_ids,omitempty"`
|
NewIDs []int64 `json:"new_ids,omitempty"`
|
||||||
|
// Local (requests): like RecordInput.Local, for the whole set.
|
||||||
|
Local *bool `json:"local,omitempty"`
|
||||||
|
// Shared (stored operations, linked zones): the records are shared
|
||||||
|
// (true) or local (false).
|
||||||
|
Shared *bool `json:"shared,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ViewInput creates or updates a view.
|
// ViewInput creates or updates a view.
|
||||||
@@ -184,6 +257,14 @@ type ViewInput struct {
|
|||||||
AdoptZones bool `json:"adopt_zones,omitempty"`
|
AdoptZones bool `json:"adopt_zones,omitempty"`
|
||||||
// Cascade (delete) also deletes the view's zones.
|
// Cascade (delete) also deletes the view's zones.
|
||||||
Cascade bool `json:"cascade,omitempty"`
|
Cascade bool `json:"cascade,omitempty"`
|
||||||
|
// Exposure is "auto" (or ""), "public" or "private" (docs/exposure.md).
|
||||||
|
Exposure *string `json:"exposure,omitempty"`
|
||||||
|
Acknowledged *[]model.Acknowledgement `json:"acknowledged,omitempty"`
|
||||||
|
// ReverseSuggestions turns the reverse zone suggestions for the
|
||||||
|
// view's addresses on or off (docs/reverse.md).
|
||||||
|
ReverseSuggestions *bool `json:"reverse_suggestions,omitempty"`
|
||||||
|
// DismissedReverse are the networks whose suggestion was dismissed.
|
||||||
|
DismissedReverse *[]string `json:"dismissed_reverse,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ReorderInput sets the order of views.
|
// ReorderInput sets the order of views.
|
||||||
@@ -227,6 +308,14 @@ type SettingsInput struct {
|
|||||||
Expire *uint32 `json:"expire,omitempty"`
|
Expire *uint32 `json:"expire,omitempty"`
|
||||||
NegativeTTL *uint32 `json:"negative_ttl,omitempty"`
|
NegativeTTL *uint32 `json:"negative_ttl,omitempty"`
|
||||||
SerialPolicy *string `json:"serial_policy,omitempty"`
|
SerialPolicy *string `json:"serial_policy,omitempty"`
|
||||||
|
// Exposure and Acknowledged are the server's (docs/exposure.md).
|
||||||
|
Exposure *string `json:"exposure,omitempty"`
|
||||||
|
Acknowledged *[]model.Acknowledgement `json:"acknowledged,omitempty"`
|
||||||
|
// DismissedReverse are dismissed reverse zone suggestions (without
|
||||||
|
// views).
|
||||||
|
DismissedReverse *[]string `json:"dismissed_reverse,omitempty"`
|
||||||
|
// EncryptedDNSHosts are the encrypted DNS setup's host names.
|
||||||
|
EncryptedDNSHosts *[]string `json:"encrypted_dns_hosts,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// DeleteInput carries options for delete operations.
|
// DeleteInput carries options for delete operations.
|
||||||
|
|||||||
@@ -0,0 +1,476 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
// Linked zones (docs/views.md#linked-zones). Zones of the same name in
|
||||||
|
// different views can be linked: their shared records are kept in step,
|
||||||
|
// and each zone can override a name and type with records local to its
|
||||||
|
// view. Every zone keeps its own copy of each shared record (with the
|
||||||
|
// same SharedID), so the rest of Jarl sees ordinary zones.
|
||||||
|
//
|
||||||
|
// Keeping them in step happens when requests are expanded: the request's
|
||||||
|
// operations are applied to a scratch copy, and linkSync adds explicit
|
||||||
|
// operations for the other zones of the link. So a change to a shared
|
||||||
|
// record is one changeset with one operation per zone: the diff, the
|
||||||
|
// permission checks, history and undo all see every zone.
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"jarl/internal/dnsname"
|
||||||
|
"jarl/internal/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
type rrKey struct {
|
||||||
|
zone int64
|
||||||
|
name, typ string
|
||||||
|
}
|
||||||
|
|
||||||
|
// linkSync returns ops followed by the operations that bring the other
|
||||||
|
// zones of each affected link in step.
|
||||||
|
func (x *expander) linkSync(ops []model.Op) ([]model.Op, error) {
|
||||||
|
if !x.st.AnyLinked() {
|
||||||
|
return ops, nil
|
||||||
|
}
|
||||||
|
work := x.st.Clone()
|
||||||
|
c := &applyCtx{p: x.p, now: x.now}
|
||||||
|
for _, op := range ops {
|
||||||
|
if err := applyOp(work, op, c); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
keys := affectedKeys(x.st, work, ops)
|
||||||
|
var extra []model.Op
|
||||||
|
for _, k := range keys {
|
||||||
|
z := work.Zones[k.zone]
|
||||||
|
if z == nil || z.LinkGroup == 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
more, err := x.syncKey(work, z, k.name, k.typ)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
for _, op := range more {
|
||||||
|
if err := applyOp(work, op, c); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
extra = append(extra, more...)
|
||||||
|
}
|
||||||
|
return append(ops, extra...), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// affectedKeys lists the (zone, name, type) sets that ops touch, before
|
||||||
|
// and after.
|
||||||
|
func affectedKeys(pre, post *model.State, ops []model.Op) []rrKey {
|
||||||
|
var out []rrKey
|
||||||
|
seen := map[rrKey]bool{}
|
||||||
|
add := func(zone int64, name, typ string) {
|
||||||
|
k := rrKey{zone, name, typ}
|
||||||
|
if zone != 0 && name != "" && !seen[k] {
|
||||||
|
seen[k] = true
|
||||||
|
out = append(out, k)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fromRecord := func(id int64) {
|
||||||
|
for _, st := range []*model.State{pre, post} {
|
||||||
|
if r := st.Records[id]; r != nil {
|
||||||
|
add(r.ZoneID, r.Name, r.Type)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, op := range ops {
|
||||||
|
switch op.Kind {
|
||||||
|
case OpRecordCreate, OpRecordUpdate, OpRecordDelete:
|
||||||
|
if op.ID != 0 {
|
||||||
|
fromRecord(op.ID)
|
||||||
|
}
|
||||||
|
if op.Kind == OpRecordDelete && op.ID == 0 {
|
||||||
|
var in RecordInput
|
||||||
|
if decode(op.Data, &in) == nil && in.Name != nil && in.Type != nil {
|
||||||
|
add(in.ZoneID, *in.Name, *in.Type)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case OpRRSetReplace:
|
||||||
|
var in RRSetInput
|
||||||
|
if decode(op.Data, &in) == nil {
|
||||||
|
add(in.ZoneID, in.Name, in.Type)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// syncKey brings the other zones of z's link in step with z for one name
|
||||||
|
// and type, after z was changed:
|
||||||
|
//
|
||||||
|
// - z overrides it (local records): z's shared copies go; the others
|
||||||
|
// keep theirs.
|
||||||
|
// - z's override was just removed: z gets the shared records back from
|
||||||
|
// a zone that has them.
|
||||||
|
// - otherwise z's shared records are the truth: every zone that doesn't
|
||||||
|
// override the name and type gets the same (created, updated or
|
||||||
|
// deleted to match).
|
||||||
|
func (x *expander) syncKey(st *model.State, z *model.Zone, name, typ string) ([]model.Op, error) {
|
||||||
|
var ops []model.Op
|
||||||
|
where := func(o *model.Zone) string { return zoneDesc(st, o) }
|
||||||
|
if st.HasLocal(z.ID, name, typ) {
|
||||||
|
for _, r := range st.SharedRecords(z.ID, name, typ) {
|
||||||
|
ops = append(ops, newOp(OpRecordDelete, r.ID, r.Version, nil,
|
||||||
|
fmt.Sprintf("linked: %s %s is local in %s now, so its shared %s goes there", name, typ, where(z), r.Data)))
|
||||||
|
}
|
||||||
|
return ops, nil
|
||||||
|
}
|
||||||
|
truth := st.SharedRecords(z.ID, name, typ)
|
||||||
|
members := st.LinkedWith(z)
|
||||||
|
if len(truth) == 0 && x.st.HasLocal(z.ID, name, typ) {
|
||||||
|
// The override was removed: back to the shared records.
|
||||||
|
for _, o := range members {
|
||||||
|
if st.HasLocal(o.ID, name, typ) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
src := st.SharedRecords(o.ID, name, typ)
|
||||||
|
if len(src) == 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, r := range src {
|
||||||
|
op, err := x.copyRecord(st, z, r, "linked: "+name+" "+typ+" is shared again in "+where(z)+": add "+r.Data)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
ops = append(ops, op)
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
return ops, nil
|
||||||
|
}
|
||||||
|
for _, o := range members {
|
||||||
|
if st.HasLocal(o.ID, name, typ) {
|
||||||
|
continue // o overrides this name and type
|
||||||
|
}
|
||||||
|
copies := map[int64]*model.Record{}
|
||||||
|
for _, r := range st.SharedRecords(o.ID, name, typ) {
|
||||||
|
copies[r.SharedID] = r
|
||||||
|
}
|
||||||
|
var more []model.Op
|
||||||
|
for _, t := range truth {
|
||||||
|
cp := copies[t.SharedID]
|
||||||
|
delete(copies, t.SharedID)
|
||||||
|
if cp == nil {
|
||||||
|
op, err := x.copyRecord(st, o, t, fmt.Sprintf("linked: add %s %s %s in %s", name, typ, t.Data, where(o)))
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
more = append(more, op)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
in, changes := recordDiff(cp, t)
|
||||||
|
if len(changes) > 0 {
|
||||||
|
more = append(more, newOp(OpRecordUpdate, cp.ID, cp.Version, in,
|
||||||
|
fmt.Sprintf("linked: change %s %s %s in %s: %s", name, typ, cp.Data, where(o), strings.Join(changes, ", "))))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, id := range sortedKeys(copies) {
|
||||||
|
cp := copies[id]
|
||||||
|
more = append(more, newOp(OpRecordDelete, cp.ID, cp.Version, nil, fmt.Sprintf("linked: delete %s %s %s in %s", name, typ, cp.Data, where(o))))
|
||||||
|
}
|
||||||
|
if len(more) > 0 && !x.p.Can(recordAction(st, o, name, typ, true)) {
|
||||||
|
return nil, errf(KindForbidden, "%s %s is shared with %s, which you may not change; to change it in %s only, make it local to that view (local: true, or --local)",
|
||||||
|
dnsname.Display(name), typ, where(o), where(z))
|
||||||
|
}
|
||||||
|
ops = append(ops, more...)
|
||||||
|
}
|
||||||
|
return ops, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// copyRecord returns an operation that creates a copy of shared record r
|
||||||
|
// in zone z.
|
||||||
|
func (x *expander) copyRecord(st *model.State, z *model.Zone, r *model.Record, summary string) (model.Op, error) {
|
||||||
|
if !x.p.Can(recordAction(st, z, r.Name, r.Type, true)) {
|
||||||
|
return model.Op{}, errf(KindForbidden, "%s %s is shared with %s, which you may not change", dnsname.Display(r.Name), r.Type, zoneDesc(st, z))
|
||||||
|
}
|
||||||
|
ids, err := x.ids(1)
|
||||||
|
if err != nil {
|
||||||
|
return model.Op{}, err
|
||||||
|
}
|
||||||
|
return newOp(OpRecordCreate, ids[0], 0, recordCopyInput(z.ID, r), summary), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func recordCopyInput(zoneID int64, r *model.Record) RecordInput {
|
||||||
|
in := RecordInput{ZoneID: zoneID, Name: model.Ptr(r.Name), Type: model.Ptr(r.Type), Data: model.Ptr(r.Data),
|
||||||
|
Comment: model.Ptr(r.Comment), Disabled: model.Ptr(r.Disabled), SharedID: model.Ptr(r.SharedID)}
|
||||||
|
if r.TTL != nil {
|
||||||
|
in.TTL = model.Some(*r.TTL)
|
||||||
|
} else {
|
||||||
|
in.TTL = model.Opt[uint32]{Set: true, Null: true}
|
||||||
|
}
|
||||||
|
return in
|
||||||
|
}
|
||||||
|
|
||||||
|
// recordDiff returns the update that makes cp like t, and what changes.
|
||||||
|
func recordDiff(cp, t *model.Record) (RecordInput, []string) {
|
||||||
|
var in RecordInput
|
||||||
|
var changes []string
|
||||||
|
if cp.Data != t.Data {
|
||||||
|
in.Data = model.Ptr(t.Data)
|
||||||
|
changes = append(changes, "data "+t.Data)
|
||||||
|
}
|
||||||
|
if !sameTTL(cp.TTL, t.TTL) {
|
||||||
|
if t.TTL != nil {
|
||||||
|
in.TTL = model.Some(*t.TTL)
|
||||||
|
changes = append(changes, fmt.Sprintf("ttl %d", *t.TTL))
|
||||||
|
} else {
|
||||||
|
in.TTL = model.Opt[uint32]{Set: true, Null: true}
|
||||||
|
changes = append(changes, "ttl default")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if cp.Comment != t.Comment {
|
||||||
|
in.Comment = model.Ptr(t.Comment)
|
||||||
|
changes = append(changes, "comment")
|
||||||
|
}
|
||||||
|
if cp.Disabled != t.Disabled {
|
||||||
|
in.Disabled = model.Ptr(t.Disabled)
|
||||||
|
changes = append(changes, enableWord(t.Disabled)+"d")
|
||||||
|
}
|
||||||
|
return in, changes
|
||||||
|
}
|
||||||
|
|
||||||
|
// linkTarget resolves the zone a link request names.
|
||||||
|
func (x *expander) linkTarget(in LinkInput) (*model.Zone, error) {
|
||||||
|
z, err := x.resolveZone(in.ZoneID, in.Zone, in.View)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if z.Type != model.ZonePrimary {
|
||||||
|
return nil, errf(KindBadRequest, "only primary zones can be linked (%s is %s)", zoneDesc(x.st, z), z.Type)
|
||||||
|
}
|
||||||
|
return z, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// zoneLink links zones of the same name in several views. It never
|
||||||
|
// changes what named answers: a name and type with the same records in
|
||||||
|
// every zone becomes shared; anything that differs stays local to each
|
||||||
|
// view (and can be shared later, from the view whose version is right).
|
||||||
|
func (x *expander) zoneLink(req Request) ([]model.Op, error) {
|
||||||
|
var in LinkInput
|
||||||
|
if err := decode(req.Data, &in); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
z, err := x.linkTarget(in)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
members := []*model.Zone{z}
|
||||||
|
add := func(o *model.Zone) {
|
||||||
|
if !slices.ContainsFunc(members, func(m *model.Zone) bool { return m.ID == o.ID }) {
|
||||||
|
members = append(members, o)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(in.With) == 0 {
|
||||||
|
for _, o := range x.st.ZonesNamed(z.Name) {
|
||||||
|
if o.Type == model.ZonePrimary && o.ID != z.ID {
|
||||||
|
add(o)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, vn := range in.With {
|
||||||
|
v := x.st.ViewByName(vn)
|
||||||
|
if v == nil {
|
||||||
|
return nil, errf(KindNotFound, "view %q does not exist", vn)
|
||||||
|
}
|
||||||
|
o := x.st.FindZone(z.Name, v.ID)
|
||||||
|
if o == nil {
|
||||||
|
return nil, errf(KindNotFound, "view %s has no zone %s (create it linked: jarl zone create %s --view %s --link-with %s)", v.Name, dnsname.Display(z.Name), dnsname.Display(z.Name), v.Name, x.st.ViewName(z))
|
||||||
|
}
|
||||||
|
if o.Type != model.ZonePrimary {
|
||||||
|
return nil, errf(KindBadRequest, "only primary zones can be linked (%s is %s)", zoneDesc(x.st, o), o.Type)
|
||||||
|
}
|
||||||
|
add(o)
|
||||||
|
}
|
||||||
|
// Zones already linked with any of them join too.
|
||||||
|
for _, m := range slices.Clone(members) {
|
||||||
|
for _, o := range x.st.LinkMembers(m.LinkGroup) {
|
||||||
|
add(o)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(members) < 2 {
|
||||||
|
return nil, errf(KindBadRequest, "zone %s exists in no other view to link it with", dnsname.Display(z.Name))
|
||||||
|
}
|
||||||
|
x.st.SortByView(members)
|
||||||
|
group := members[0].ID
|
||||||
|
for _, m := range members {
|
||||||
|
if m.LinkGroup != 0 {
|
||||||
|
group = m.LinkGroup
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// What is the same everywhere?
|
||||||
|
type key struct{ name, typ string }
|
||||||
|
sig := func(rs []*model.Record) string {
|
||||||
|
var parts []string
|
||||||
|
for _, r := range rs {
|
||||||
|
ttl := "-"
|
||||||
|
if r.TTL != nil {
|
||||||
|
ttl = fmt.Sprint(*r.TTL)
|
||||||
|
}
|
||||||
|
parts = append(parts, fmt.Sprintf("%s|%s|%v", strings.ToLower(r.Data), ttl, r.Disabled))
|
||||||
|
}
|
||||||
|
slices.Sort(parts)
|
||||||
|
return strings.Join(parts, "\n")
|
||||||
|
}
|
||||||
|
keys := map[key]bool{}
|
||||||
|
var order []key
|
||||||
|
for _, m := range members {
|
||||||
|
for _, r := range x.st.ZoneRecords(m.ID) {
|
||||||
|
k := key{r.Name, r.Type}
|
||||||
|
if !keys[k] {
|
||||||
|
keys[k] = true
|
||||||
|
order = append(order, k)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var ops []model.Op
|
||||||
|
var local []string
|
||||||
|
shared := 0
|
||||||
|
for _, k := range order {
|
||||||
|
first := x.st.RRset(members[0].ID, k.name, k.typ)
|
||||||
|
same := len(first) > 0
|
||||||
|
for _, m := range members[1:] {
|
||||||
|
if rs := x.st.RRset(m.ID, k.name, k.typ); len(rs) == 0 || sig(rs) != sig(first) {
|
||||||
|
same = false
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if same {
|
||||||
|
shared++
|
||||||
|
} else {
|
||||||
|
var in []string
|
||||||
|
for _, m := range members {
|
||||||
|
if len(x.st.RRset(m.ID, k.name, k.typ)) > 0 {
|
||||||
|
in = append(in, x.st.ViewName(m))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
local = append(local, fmt.Sprintf("%s %s (%s)", dnsname.Display(k.name), k.typ, strings.Join(in, ", ")))
|
||||||
|
}
|
||||||
|
// Pair the copies: record i of the first zone's set (by data) with
|
||||||
|
// the same data in the others.
|
||||||
|
byData := func(rs []*model.Record) []*model.Record {
|
||||||
|
out := slices.Clone(rs)
|
||||||
|
slices.SortStableFunc(out, func(a, b *model.Record) int { return strings.Compare(strings.ToLower(a.Data), strings.ToLower(b.Data)) })
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
ref := byData(first)
|
||||||
|
for _, m := range members {
|
||||||
|
rs := byData(x.st.RRset(m.ID, k.name, k.typ))
|
||||||
|
for i, r := range rs {
|
||||||
|
want := int64(0)
|
||||||
|
var comment *string
|
||||||
|
if same {
|
||||||
|
want = ref[i].ID
|
||||||
|
if r.Comment != ref[i].Comment && ref[i].Comment != "" {
|
||||||
|
comment = model.Ptr(ref[i].Comment)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if r.SharedID == want && comment == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
in := RecordInput{SharedID: model.Ptr(want), Comment: comment}
|
||||||
|
what := "local to view " + x.st.ViewName(m)
|
||||||
|
if same {
|
||||||
|
what = "shared"
|
||||||
|
}
|
||||||
|
ops = append(ops, newOp(OpRecordUpdate, r.ID, r.Version, in, fmt.Sprintf("%s %s %s: %s", r.Name, r.Type, r.Data, what)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var views []string
|
||||||
|
for _, m := range members {
|
||||||
|
views = append(views, x.st.ViewName(m))
|
||||||
|
}
|
||||||
|
var zoneOps []model.Op
|
||||||
|
for _, m := range members {
|
||||||
|
if m.LinkGroup != group {
|
||||||
|
zoneOps = append(zoneOps, newOp(OpZoneUpdate, m.ID, m.Version, ZoneInput{LinkGroup: model.Ptr(group)},
|
||||||
|
fmt.Sprintf("link zone %s in views %s", zoneDesc(x.st, m), strings.Join(views, ", "))))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(local) > 0 {
|
||||||
|
x.warnings = append(x.warnings, fmt.Sprintf("%d names differ between the views and stay local to each: %s. Share one from the view whose version is right (jarl record update ID --shared, or Share in the web UI).", len(local), strings.Join(local, "; ")))
|
||||||
|
}
|
||||||
|
x.warnings = append(x.warnings, fmt.Sprintf("%d names and types are shared between views %s", shared, strings.Join(views, ", ")))
|
||||||
|
return append(zoneOps, ops...), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// zoneUnlink takes a zone out of its link: its records stay as they are,
|
||||||
|
// all local. A link left with one zone is dissolved.
|
||||||
|
func (x *expander) zoneUnlink(req Request) ([]model.Op, error) {
|
||||||
|
var in LinkInput
|
||||||
|
if err := decode(req.Data, &in); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
z, err := x.resolveZone(in.ZoneID, in.Zone, in.View)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if z.LinkGroup == 0 {
|
||||||
|
return nil, errf(KindConflict, "zone %s isn't linked", zoneDesc(x.st, z))
|
||||||
|
}
|
||||||
|
out := []*model.Zone{z}
|
||||||
|
if rest := x.st.LinkedWith(z); len(rest) == 1 {
|
||||||
|
out = append(out, rest[0])
|
||||||
|
}
|
||||||
|
var ops []model.Op
|
||||||
|
for _, m := range out {
|
||||||
|
ops = append(ops, x.unlinkOps(m, "unlink zone "+zoneDesc(x.st, m))...)
|
||||||
|
}
|
||||||
|
return ops, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// unlinkOps returns the operations that take zone m out of its link.
|
||||||
|
func (x *expander) unlinkOps(m *model.Zone, summary string) []model.Op {
|
||||||
|
ops := []model.Op{newOp(OpZoneUpdate, m.ID, m.Version, ZoneInput{LinkGroup: model.Ptr(int64(0))}, summary)}
|
||||||
|
for _, r := range x.st.ZoneRecords(m.ID) {
|
||||||
|
if r.SharedID != 0 {
|
||||||
|
ops = append(ops, newOp(OpRecordUpdate, r.ID, r.Version, RecordInput{SharedID: model.Ptr(int64(0))}, fmt.Sprintf("%s %s %s: no longer shared", r.Name, r.Type, r.Data)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ops
|
||||||
|
}
|
||||||
|
|
||||||
|
// localFor works out whether a new record (or set) in zone z is local:
|
||||||
|
// as asked, or like the records of the same name and type already there.
|
||||||
|
func (x *expander) localFor(z *model.Zone, name, typ string, want *bool) (bool, error) {
|
||||||
|
has := x.st.HasLocal(z.ID, name, typ)
|
||||||
|
if want == nil {
|
||||||
|
return has, nil
|
||||||
|
}
|
||||||
|
return *want, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// shareAllOps returns the operations that start a link with zone z: it
|
||||||
|
// joins group and all its records become shared.
|
||||||
|
func (x *expander) shareAllOps(z *model.Zone, group int64) []model.Op {
|
||||||
|
ops := []model.Op{newOp(OpZoneUpdate, z.ID, z.Version, ZoneInput{LinkGroup: model.Ptr(group)}, "link zone "+zoneDesc(x.st, z))}
|
||||||
|
for _, r := range x.st.ZoneRecords(z.ID) {
|
||||||
|
if r.SharedID == 0 {
|
||||||
|
ops = append(ops, newOp(OpRecordUpdate, r.ID, r.Version, RecordInput{SharedID: model.Ptr(r.ID)}, fmt.Sprintf("%s %s %s: shared", r.Name, r.Type, r.Data)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ops
|
||||||
|
}
|
||||||
|
|
||||||
|
// dropOverrides returns the operations that delete the other linked
|
||||||
|
// zones' local records of a name and type, so the shared version reaches
|
||||||
|
// them (sharing a version makes it every view's).
|
||||||
|
func (x *expander) dropOverrides(z *model.Zone, name, typ string) []model.Op {
|
||||||
|
var ops []model.Op
|
||||||
|
for _, o := range x.st.LinkedWith(z) {
|
||||||
|
for _, r := range x.st.RRset(o.ID, name, typ) {
|
||||||
|
if r.SharedID == 0 {
|
||||||
|
ops = append(ops, newOp(OpRecordDelete, r.ID, r.Version, nil, fmt.Sprintf("linked: %s %s %s in %s is replaced by the shared version", r.Name, r.Type, r.Data, zoneDesc(x.st, o))))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ops
|
||||||
|
}
|
||||||
@@ -0,0 +1,388 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"jarl/internal/auth"
|
||||||
|
"jarl/internal/model"
|
||||||
|
"jarl/internal/validate"
|
||||||
|
)
|
||||||
|
|
||||||
|
// linkedEnv has views internal and external and zone example.com in
|
||||||
|
// internal with a few records.
|
||||||
|
func linkedEnv(t *testing.T) *testEnv {
|
||||||
|
env := newEnv(t)
|
||||||
|
env.submit(env.admin, NewRequest(OpSettingsUpdate, 0, SettingsInput{Nameservers: &[]string{"ns1.example.net."}}))
|
||||||
|
env.submit(env.admin,
|
||||||
|
NewRequest(OpViewCreate, 0, ViewInput{Name: model.Ptr("internal"), MatchClients: &[]string{"10.0.0.0/8"}}),
|
||||||
|
NewRequest(OpViewCreate, 0, ViewInput{Name: model.Ptr("external"), MatchClients: &[]string{"any"}}))
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("example.com"), View: model.Ptr("internal")}))
|
||||||
|
env.submit(env.admin,
|
||||||
|
recIn("internal", "www", "A", "192.0.2.10"),
|
||||||
|
recIn("internal", "mail", "A", "192.0.2.25"),
|
||||||
|
recIn("internal", "@", "MX", "10 mail"))
|
||||||
|
return env
|
||||||
|
}
|
||||||
|
|
||||||
|
func recIn(view, name, typ, data string) Request {
|
||||||
|
return NewRequest(OpRecordCreate, 0, RecordInput{Zone: "example.com", View: view, Name: &name, Type: &typ, Data: &data})
|
||||||
|
}
|
||||||
|
|
||||||
|
// view returns a view's records of example.com as "name type data S|L",
|
||||||
|
// S for shared, L for local.
|
||||||
|
func (env *testEnv) view(name string) []string {
|
||||||
|
env.t.Helper()
|
||||||
|
s := env.state()
|
||||||
|
v := s.ViewByName(name)
|
||||||
|
z := s.FindZone("example.com.", v.ID)
|
||||||
|
var out []string
|
||||||
|
for _, r := range s.ZoneRecords(z.ID) {
|
||||||
|
if r.Type == "NS" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
mark := "L"
|
||||||
|
if r.SharedID != 0 {
|
||||||
|
mark = "S"
|
||||||
|
}
|
||||||
|
if r.Disabled {
|
||||||
|
mark += " disabled"
|
||||||
|
}
|
||||||
|
out = append(out, strings.TrimSuffix(r.Name, ".example.com.")+" "+r.Type+" "+r.Data+" "+mark)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func (env *testEnv) recordID(view, name, typ string) int64 {
|
||||||
|
env.t.Helper()
|
||||||
|
s := env.state()
|
||||||
|
z := s.FindZone("example.com.", s.ViewByName(view).ID)
|
||||||
|
for _, r := range s.ZoneRecords(z.ID) {
|
||||||
|
if r.Name == name+".example.com." && r.Type == typ {
|
||||||
|
return r.ID
|
||||||
|
}
|
||||||
|
}
|
||||||
|
env.t.Fatalf("no %s %s in %s", name, typ, view)
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
func want(t *testing.T, what string, got []string, w ...string) {
|
||||||
|
t.Helper()
|
||||||
|
if !slices.Equal(got, w) {
|
||||||
|
t.Errorf("%s:\n got %q\n want %q", what, got, w)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLinkedZones(t *testing.T) {
|
||||||
|
env := linkedEnv(t)
|
||||||
|
// A zone created linked copies everything; both are linked and shared.
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("example.com"), View: model.Ptr("external"), LinkWith: "internal"}))
|
||||||
|
all := []string{"mail A 192.0.2.25 S", "www A 192.0.2.10 S", "example.com. MX 10 mail.example.com. S"}
|
||||||
|
slices.Sort(all)
|
||||||
|
got := env.view("external")
|
||||||
|
slices.Sort(got)
|
||||||
|
want(t, "linked copy", got, all...)
|
||||||
|
s := env.state()
|
||||||
|
if zs := s.ZonesNamed("example.com."); zs[0].LinkGroup == 0 || zs[0].LinkGroup != zs[1].LinkGroup {
|
||||||
|
t.Fatalf("not linked: %+v %+v", zs[0], zs[1])
|
||||||
|
}
|
||||||
|
|
||||||
|
// Adding, changing, disabling and deleting a shared record reaches the other view.
|
||||||
|
env.submit(env.admin, recIn("external", "ftp", "CNAME", "www"))
|
||||||
|
if !slices.Contains(env.view("internal"), "ftp CNAME www.example.com. S") {
|
||||||
|
t.Errorf("shared add didn't reach internal: %q", env.view("internal"))
|
||||||
|
}
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordUpdate, env.recordID("internal", "mail", "A"), RecordInput{Data: model.Ptr("192.0.2.26")}))
|
||||||
|
if !slices.Contains(env.view("external"), "mail A 192.0.2.26 S") {
|
||||||
|
t.Errorf("shared change didn't reach external: %q", env.view("external"))
|
||||||
|
}
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordDisable, 0, RecordInput{Zone: "example.com", View: "external", Name: model.Ptr("ftp"), Type: model.Ptr("CNAME")}))
|
||||||
|
if !slices.Contains(env.view("internal"), "ftp CNAME www.example.com. S disabled") {
|
||||||
|
t.Errorf("disable didn't reach internal: %q", env.view("internal"))
|
||||||
|
}
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordDelete, 0, RecordInput{Zone: "example.com", View: "internal", Name: model.Ptr("ftp"), Type: model.Ptr("CNAME")}))
|
||||||
|
for _, v := range []string{"internal", "external"} {
|
||||||
|
for _, r := range env.view(v) {
|
||||||
|
if strings.HasPrefix(r, "ftp ") {
|
||||||
|
t.Errorf("delete by match left %s in %s", r, v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A local override: www in internal points elsewhere; external keeps
|
||||||
|
// the shared one.
|
||||||
|
res := env.submit(env.admin, NewRequest(OpRecordCreate, 0, RecordInput{Zone: "example.com", View: "internal", Name: model.Ptr("www"), Type: model.Ptr("A"), Data: model.Ptr("10.0.0.10"), Local: model.Ptr(true)}))
|
||||||
|
if !slices.Contains(env.view("internal"), "www A 10.0.0.10 L") || slices.Contains(env.view("internal"), "www A 192.0.2.10 S") {
|
||||||
|
t.Errorf("override: internal %q", env.view("internal"))
|
||||||
|
}
|
||||||
|
if !slices.Contains(env.view("external"), "www A 192.0.2.10 S") {
|
||||||
|
t.Errorf("override changed external: %q", env.view("external"))
|
||||||
|
}
|
||||||
|
_ = res
|
||||||
|
// A new record of an overridden set joins it as local.
|
||||||
|
env.submit(env.admin, recIn("internal", "www", "A", "10.0.0.11"))
|
||||||
|
if !slices.Contains(env.view("internal"), "www A 10.0.0.11 L") || len(env.view("external")) != 3 {
|
||||||
|
t.Errorf("join override: internal %q external %q", env.view("internal"), env.view("external"))
|
||||||
|
}
|
||||||
|
// Changing the shared www in external doesn't touch internal's override.
|
||||||
|
env.submit(env.admin, NewRequest(OpRRSetReplace, 0, RRSetInput{Zone: "example.com", View: "external", Name: "www", Type: "A", Data: []string{"192.0.2.11"}}))
|
||||||
|
if !slices.Contains(env.view("external"), "www A 192.0.2.11 S") || slices.Contains(env.view("internal"), "www A 192.0.2.11 S") {
|
||||||
|
t.Errorf("shared set with an override elsewhere: internal %q external %q", env.view("internal"), env.view("external"))
|
||||||
|
}
|
||||||
|
// Removing the override brings the shared records back.
|
||||||
|
env.submit(env.admin, NewRequest(OpRRSetReplace, 0, RRSetInput{Zone: "example.com", View: "internal", Name: "www", Type: "A", Data: []string{}}))
|
||||||
|
if !slices.Contains(env.view("internal"), "www A 192.0.2.11 S") {
|
||||||
|
t.Errorf("override removed: internal %q", env.view("internal"))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Make a shared set local, then share another view's version.
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordUpdate, env.recordID("external", "mail", "A"), RecordInput{Local: model.Ptr(true)}))
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordUpdate, env.recordID("external", "mail", "A"), RecordInput{Data: model.Ptr("198.51.100.25")}))
|
||||||
|
if !slices.Contains(env.view("external"), "mail A 198.51.100.25 L") || !slices.Contains(env.view("internal"), "mail A 192.0.2.26 S") {
|
||||||
|
t.Errorf("local edit: internal %q external %q", env.view("internal"), env.view("external"))
|
||||||
|
}
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordUpdate, env.recordID("external", "mail", "A"), RecordInput{Local: model.Ptr(false)}))
|
||||||
|
if !slices.Contains(env.view("internal"), "mail A 198.51.100.25 S") || slices.Contains(env.view("internal"), "mail A 192.0.2.26 S") {
|
||||||
|
t.Errorf("share external's version: internal %q", env.view("internal"))
|
||||||
|
}
|
||||||
|
if probs := env.e.Validate(env.state()); hasCode(probs, "linked_out_of_sync") || hasCode(probs, "linked_mixed") {
|
||||||
|
t.Errorf("validation: %+v", probs)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Undoing a changeset undoes it in both views.
|
||||||
|
r := env.submit(env.admin, NewRequest(OpRecordUpdate, env.recordID("internal", "mail", "A"), RecordInput{Data: model.Ptr("198.51.100.99")}))
|
||||||
|
cs, err := env.e.Revert(env.ctx, r.ChangesetID, env.admin)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := env.e.Apply(env.ctx, cs.ID, env.admin, ApplyOptions{}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, v := range []string{"internal", "external"} {
|
||||||
|
if !slices.Contains(env.view(v), "mail A 198.51.100.25 S") {
|
||||||
|
t.Errorf("revert in %s: %q", v, env.view(v))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Unlinking keeps every record, all local.
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneUnlink, 0, LinkInput{Zone: "example.com", View: "external"}))
|
||||||
|
for _, z := range env.state().ZonesNamed("example.com.") {
|
||||||
|
if z.LinkGroup != 0 {
|
||||||
|
t.Errorf("still linked: %s", zoneDesc(env.state(), z))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, v := range []string{"internal", "external"} {
|
||||||
|
for _, r := range env.view(v) {
|
||||||
|
if strings.HasSuffix(r, " S") {
|
||||||
|
t.Errorf("still shared after unlink in %s: %s", v, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
env.submit(env.admin, recIn("internal", "solo", "A", "10.0.0.5"))
|
||||||
|
if slices.Contains(env.view("external"), "solo A 10.0.0.5 L") {
|
||||||
|
t.Error("an unlinked zone was changed")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Linking again works out what is shared: same in both, or not.
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneLink, 0, LinkInput{Zone: "example.com", View: "internal"}))
|
||||||
|
in, ex := env.view("internal"), env.view("external")
|
||||||
|
if !slices.Contains(in, "mail A 198.51.100.25 S") || !slices.Contains(ex, "mail A 198.51.100.25 S") {
|
||||||
|
t.Errorf("relink: same records not shared: internal %q external %q", in, ex)
|
||||||
|
}
|
||||||
|
if !slices.Contains(in, "solo A 10.0.0.5 L") {
|
||||||
|
t.Errorf("relink: internal-only record should be local: %q", in)
|
||||||
|
}
|
||||||
|
if probs := env.e.Validate(env.state()); hasCode(probs, "linked_out_of_sync") || hasCode(probs, "linked_mixed") {
|
||||||
|
t.Errorf("validation after relink: %+v", probs)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Deleting one zone of two dissolves the link.
|
||||||
|
z := env.state().FindZone("example.com.", env.state().ViewByName("external").ID)
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneDelete, z.ID, nil))
|
||||||
|
if zs := env.state().ZonesNamed("example.com."); len(zs) != 1 || zs[0].LinkGroup != 0 {
|
||||||
|
t.Errorf("after deleting external: %+v", zs)
|
||||||
|
}
|
||||||
|
for _, r := range env.view("internal") {
|
||||||
|
if strings.HasSuffix(r, " S") {
|
||||||
|
t.Errorf("shared record left in an unlinked zone: %s", r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func hasCode(probs []validate.Problem, code string) bool {
|
||||||
|
for _, p := range probs {
|
||||||
|
if p.Code == code {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLinkedPermissions(t *testing.T) {
|
||||||
|
env := linkedEnv(t)
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("example.com"), View: model.Ptr("external"), LinkWith: "internal"}))
|
||||||
|
u := &model.User{Username: "lan", Grants: []model.Grant{{Resource: auth.ResRecords, Access: "write", Views: []string{"internal"}}, {Resource: auth.ResZones, Access: "read"}}}
|
||||||
|
if err := env.st.CreateUser(env.ctx, u); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
lan := &auth.Principal{User: u, Method: "token"}
|
||||||
|
// A shared change would reach external, which this user may not change.
|
||||||
|
e := env.submitErr(lan, NewRequest(OpRecordUpdate, env.recordID("internal", "www", "A"), RecordInput{Data: model.Ptr("10.9.9.9")}))
|
||||||
|
if e.Kind != KindForbidden || !strings.Contains(e.Message, "shared with example.com [external]") || !strings.Contains(e.Message, "local") {
|
||||||
|
t.Errorf("shared change: %v", e)
|
||||||
|
}
|
||||||
|
// A local override is theirs to make.
|
||||||
|
env.submit(lan, NewRequest(OpRecordCreate, 0, RecordInput{Zone: "example.com", View: "internal", Name: model.Ptr("www"), Type: model.Ptr("A"), Data: model.Ptr("10.9.9.9"), Local: model.Ptr(true)}))
|
||||||
|
if !slices.Contains(env.view("internal"), "www A 10.9.9.9 L") || !slices.Contains(env.view("external"), "www A 192.0.2.10 S") {
|
||||||
|
t.Errorf("override by a view-restricted user: internal %q external %q", env.view("internal"), env.view("external"))
|
||||||
|
}
|
||||||
|
// Records of a zone that isn't linked can't be "local".
|
||||||
|
e = env.submitErr(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("example.org"), View: model.Ptr("internal"), LinkWith: "external"}))
|
||||||
|
if e.Kind != KindNotFound {
|
||||||
|
t.Errorf("link_with a view without the zone: %v", e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLinkExisting(t *testing.T) {
|
||||||
|
env := linkedEnv(t)
|
||||||
|
// external was made by hand: the same apart from www.
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("example.com"), View: model.Ptr("external")}))
|
||||||
|
env.submit(env.admin,
|
||||||
|
recIn("external", "www", "A", "203.0.113.10"),
|
||||||
|
recIn("external", "mail", "A", "192.0.2.25"),
|
||||||
|
recIn("external", "@", "MX", "10 mail"))
|
||||||
|
before := []string{}
|
||||||
|
for _, v := range []string{"internal", "external"} {
|
||||||
|
before = append(before, strings.Join(env.view(v), ";"))
|
||||||
|
}
|
||||||
|
res := env.submit(env.admin, NewRequest(OpZoneLink, 0, LinkInput{Zone: "example.com", View: "external", With: []string{"internal"}}))
|
||||||
|
in, ex := env.view("internal"), env.view("external")
|
||||||
|
if !slices.Contains(in, "www A 192.0.2.10 L") || !slices.Contains(ex, "www A 203.0.113.10 L") {
|
||||||
|
t.Errorf("different www should stay local: internal %q external %q", in, ex)
|
||||||
|
}
|
||||||
|
if !slices.Contains(in, "mail A 192.0.2.25 S") || !slices.Contains(ex, "mail A 192.0.2.25 S") {
|
||||||
|
t.Errorf("same mail should be shared: internal %q external %q", in, ex)
|
||||||
|
}
|
||||||
|
if !strings.Contains(strings.Join(res.Warnings, " "), "www.example.com A (internal, external)") {
|
||||||
|
t.Errorf("warnings: %q", res.Warnings)
|
||||||
|
}
|
||||||
|
// Linking never changes what named answers: the same data as before.
|
||||||
|
for i, v := range []string{"internal", "external"} {
|
||||||
|
var data []string
|
||||||
|
for _, r := range env.view(v) {
|
||||||
|
data = append(data, strings.TrimSuffix(strings.TrimSuffix(r, " S"), " L"))
|
||||||
|
}
|
||||||
|
var was []string
|
||||||
|
for _, r := range strings.Split(before[i], ";") {
|
||||||
|
was = append(was, strings.TrimSuffix(strings.TrimSuffix(r, " S"), " L"))
|
||||||
|
}
|
||||||
|
want(t, "answers in "+v, data, was...)
|
||||||
|
}
|
||||||
|
// Sharing internal's www replaces external's.
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordUpdate, env.recordID("internal", "www", "A"), RecordInput{Local: model.Ptr(false)}))
|
||||||
|
if !slices.Contains(env.view("external"), "www A 192.0.2.10 S") {
|
||||||
|
t.Errorf("shared from internal: external %q", env.view("external"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --local on a zone that isn't linked is fine (its records are local
|
||||||
|
// anyway); --shared there is refused.
|
||||||
|
func TestLocalOnUnlinkedZone(t *testing.T) {
|
||||||
|
env := linkedEnv(t)
|
||||||
|
local, shared := true, false
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordCreate, 0, RecordInput{Zone: "example.com", View: "internal", Name: model.Ptr("a"), Type: model.Ptr("A"), Data: model.Ptr("10.0.0.1"), Local: &local}))
|
||||||
|
env.submit(env.admin, NewRequest(OpRRSetReplace, 0, RRSetInput{Zone: "example.com", View: "internal", Name: "b", Type: "A", Data: []string{"10.0.0.2"}, Local: &local}))
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordUpdate, env.recordID("internal", "a", "A"), RecordInput{Data: model.Ptr("10.0.0.3"), Local: &local}))
|
||||||
|
if v := env.view("internal"); !slices.Contains(v, "a A 10.0.0.3 L") || !slices.Contains(v, "b A 10.0.0.2 L") {
|
||||||
|
t.Errorf("records: %q", v)
|
||||||
|
}
|
||||||
|
if e := env.submitErr(env.admin, NewRequest(OpRecordCreate, 0, RecordInput{Zone: "example.com", View: "internal", Name: model.Ptr("c"), Type: model.Ptr("A"), Data: model.Ptr("10.0.0.4"), Local: &shared})); !strings.Contains(e.Message, "nothing to share") {
|
||||||
|
t.Errorf("--shared on an unlinked zone: %v", e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCompareZones(t *testing.T) {
|
||||||
|
env := linkedEnv(t)
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("example.com"), View: model.Ptr("external"), LinkWith: "internal"}))
|
||||||
|
env.submit(env.admin, NewRequest(OpRRSetReplace, 0, RRSetInput{Zone: "example.com", View: "external", Name: "www", Type: "A", Data: []string{"203.0.113.10"}, Local: model.Ptr(true)}))
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordCreate, 0, RecordInput{Zone: "example.com", View: "internal", Name: model.Ptr("nas"), Type: model.Ptr("A"), Data: model.Ptr("10.0.0.20"), Local: model.Ptr(true)}))
|
||||||
|
st := env.state()
|
||||||
|
zones := st.ZonesNamed("example.com.")
|
||||||
|
st.SortByView(zones)
|
||||||
|
diff := map[string][]string{}
|
||||||
|
same := 0
|
||||||
|
for _, row := range CompareZones(st, zones) {
|
||||||
|
if row.Same {
|
||||||
|
same++
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
var cells []string
|
||||||
|
for _, vs := range row.Views {
|
||||||
|
cells = append(cells, vs.View+"="+strings.Join(vs.Records, ",")+"/"+vs.Linked)
|
||||||
|
}
|
||||||
|
diff[row.Name+" "+row.Type] = cells
|
||||||
|
}
|
||||||
|
want := map[string][]string{
|
||||||
|
"www A": {"internal=192.0.2.10/shared", "external=203.0.113.10/local"},
|
||||||
|
"nas A": {"internal=10.0.0.20/local", "external=/"},
|
||||||
|
}
|
||||||
|
for k, v := range want {
|
||||||
|
if !slices.Equal(diff[k], v) {
|
||||||
|
t.Errorf("%s: %q, want %q", k, diff[k], v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(diff) != 2 || same < 3 {
|
||||||
|
t.Errorf("differ %v, same %d", diff, same)
|
||||||
|
}
|
||||||
|
// "Use this version" on the shared one replaces external's override.
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordUpdate, env.recordID("internal", "www", "A"), RecordInput{Local: model.Ptr(false)}))
|
||||||
|
if v := env.view("external"); !slices.Contains(v, "www A 192.0.2.10 S") || slices.Contains(v, "www A 203.0.113.10 L") {
|
||||||
|
t.Errorf("sharing the shared version: external %q", v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCompareReport(t *testing.T) {
|
||||||
|
env := linkedEnv(t)
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("example.com"), View: model.Ptr("external"), LinkWith: "internal"}))
|
||||||
|
env.submit(env.admin,
|
||||||
|
NewRequest(OpRRSetReplace, 0, RRSetInput{Zone: "example.com", View: "external", Name: "www", Type: "A", Data: []string{"203.0.113.10"}, Local: model.Ptr(true)}),
|
||||||
|
NewRequest(OpRecordCreate, 0, RecordInput{Zone: "example.com", View: "internal", Name: model.Ptr("nas"), Type: model.Ptr("A"), Data: model.Ptr("10.0.0.20"), Local: model.Ptr(true)}),
|
||||||
|
NewRequest(OpRecordCreate, 0, RecordInput{Zone: "example.com", View: "internal", Name: model.Ptr("printer"), Type: model.Ptr("A"), Data: model.Ptr("10.0.0.30"), Local: model.Ptr(true)}),
|
||||||
|
NewRequest(OpRecordCreate, 0, RecordInput{Zone: "example.com", View: "external", Name: model.Ptr("shop"), Type: model.Ptr("CNAME"), Data: model.Ptr("shops.example.net."), Local: model.Ptr(true)}))
|
||||||
|
st := env.state()
|
||||||
|
zones := []*model.Zone{st.FindZone("example.com.", st.ViewByName("internal").ID), st.FindZone("example.com.", st.ViewByName("external").ID)}
|
||||||
|
|
||||||
|
rep := Compare(st, zones, CompareFilter{})
|
||||||
|
if rep.Base != "internal" || !rep.Linked || !slices.Equal(rep.Views, []string{"internal", "external"}) {
|
||||||
|
t.Errorf("report %+v", rep)
|
||||||
|
}
|
||||||
|
if s := rep.Summary[0]; s.View != "external" || s.Different != 1 || s.OnlyBase != 2 || s.OnlyOther != 1 || s.Same != 2 {
|
||||||
|
t.Errorf("summary %+v", s)
|
||||||
|
}
|
||||||
|
if len(rep.Different) != 1 || rep.Different[0].Name != "www" {
|
||||||
|
t.Errorf("different %+v", rep.Different)
|
||||||
|
}
|
||||||
|
var only []string
|
||||||
|
for _, o := range rep.Only {
|
||||||
|
var names []string
|
||||||
|
for _, r := range o.Rows {
|
||||||
|
names = append(names, r.Name)
|
||||||
|
}
|
||||||
|
only = append(only, strings.Join(o.Views, "+")+": "+strings.Join(names, ","))
|
||||||
|
}
|
||||||
|
want(t, "only", only, "internal: nas,printer", "external: shop")
|
||||||
|
if rep.Same != 2 || rep.SameRows != nil {
|
||||||
|
t.Errorf("same %d, rows %v", rep.Same, rep.SameRows)
|
||||||
|
}
|
||||||
|
|
||||||
|
// One name: just its rows, the same ones included.
|
||||||
|
rep = Compare(st, zones, CompareFilter{Name: "www"})
|
||||||
|
if len(rep.Different) != 1 || len(rep.Only) != 0 || len(rep.SameRows) != 0 {
|
||||||
|
t.Errorf("www: %+v", rep)
|
||||||
|
}
|
||||||
|
rep = Compare(st, zones, CompareFilter{Name: "mail.example.com.", Type: "A"})
|
||||||
|
if len(rep.SameRows) != 1 || rep.SameRows[0].Name != "mail" || len(rep.Different)+len(rep.Only) != 0 {
|
||||||
|
t.Errorf("mail A: %+v", rep)
|
||||||
|
}
|
||||||
|
}
|
||||||
+90
-2
@@ -5,6 +5,7 @@ import (
|
|||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
|
"slices"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -265,6 +266,12 @@ func setZoneFields(st *model.State, z *model.Zone, in *ZoneInput, creating bool)
|
|||||||
if in.Comment != nil {
|
if in.Comment != nil {
|
||||||
z.Comment = *in.Comment
|
z.Comment = *in.Comment
|
||||||
}
|
}
|
||||||
|
if in.LinkGroup != nil {
|
||||||
|
z.LinkGroup = *in.LinkGroup
|
||||||
|
}
|
||||||
|
if in.AutoPTR != nil {
|
||||||
|
z.AutoPTR = *in.AutoPTR
|
||||||
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -447,6 +454,9 @@ func applyRecordCreate(st *model.State, op model.Op, c *applyCtx) error {
|
|||||||
if in.Disabled != nil {
|
if in.Disabled != nil {
|
||||||
r.Disabled = *in.Disabled
|
r.Disabled = *in.Disabled
|
||||||
}
|
}
|
||||||
|
if in.SharedID != nil {
|
||||||
|
r.SharedID = *in.SharedID
|
||||||
|
}
|
||||||
for _, w := range p.Warnings {
|
for _, w := range p.Warnings {
|
||||||
c.warn("%s %s: %s", dnsname.Display(owner), p.Type, w)
|
c.warn("%s %s: %s", dnsname.Display(owner), p.Type, w)
|
||||||
}
|
}
|
||||||
@@ -526,6 +536,9 @@ func applyRecordUpdate(st *model.State, op model.Op, c *applyCtx) error {
|
|||||||
if in.Disabled != nil {
|
if in.Disabled != nil {
|
||||||
r.Disabled = *in.Disabled
|
r.Disabled = *in.Disabled
|
||||||
}
|
}
|
||||||
|
if in.SharedID != nil {
|
||||||
|
r.SharedID = *in.SharedID
|
||||||
|
}
|
||||||
r.Touch(c.user(), c.now)
|
r.Touch(c.user(), c.now)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -662,16 +675,34 @@ func applyRRSetReplace(st *model.State, op model.Op, c *applyCtx) error {
|
|||||||
k := strings.ToLower(r.Data)
|
k := strings.ToLower(r.Data)
|
||||||
if seen[k] && !keep[k] {
|
if seen[k] && !keep[k] {
|
||||||
keep[k] = true
|
keep[k] = true
|
||||||
if (ttlKnown && !sameTTL(r.TTL, ttl)) || r.Disabled {
|
shared := r.SharedID
|
||||||
|
if in.Shared != nil {
|
||||||
|
shared = 0
|
||||||
|
if *in.Shared {
|
||||||
|
shared = r.SharedID
|
||||||
|
if shared == 0 {
|
||||||
|
shared = r.ID
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (ttlKnown && !sameTTL(r.TTL, ttl)) || r.Disabled || shared != r.SharedID {
|
||||||
if ttlKnown {
|
if ttlKnown {
|
||||||
r.TTL = copyTTL(ttl)
|
r.TTL = copyTTL(ttl)
|
||||||
}
|
}
|
||||||
r.Disabled = false
|
r.Disabled, r.SharedID = false, shared
|
||||||
r.Touch(c.user(), c.now)
|
r.Touch(c.user(), c.now)
|
||||||
}
|
}
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
if r.Disabled {
|
if r.Disabled {
|
||||||
|
// Kept, but shared or local like the rest of the set.
|
||||||
|
if in.Shared != nil && (*in.Shared) != (r.SharedID != 0) {
|
||||||
|
r.SharedID = 0
|
||||||
|
if *in.Shared {
|
||||||
|
r.SharedID = r.ID
|
||||||
|
}
|
||||||
|
r.Touch(c.user(), c.now)
|
||||||
|
}
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
delete(st.Records, id)
|
delete(st.Records, id)
|
||||||
@@ -692,6 +723,9 @@ func applyRRSetReplace(st *model.State, op model.Op, c *applyCtx) error {
|
|||||||
if in.Comment != nil {
|
if in.Comment != nil {
|
||||||
r.Comment = *in.Comment
|
r.Comment = *in.Comment
|
||||||
}
|
}
|
||||||
|
if in.Shared != nil && *in.Shared {
|
||||||
|
r.SharedID = r.ID
|
||||||
|
}
|
||||||
r.Touch(c.user(), c.now)
|
r.Touch(c.user(), c.now)
|
||||||
st.Records[r.ID] = r
|
st.Records[r.ID] = r
|
||||||
}
|
}
|
||||||
@@ -765,9 +799,47 @@ func setViewFields(v *model.View, in *ViewInput) error {
|
|||||||
if in.Position != nil {
|
if in.Position != nil {
|
||||||
v.Position = *in.Position
|
v.Position = *in.Position
|
||||||
}
|
}
|
||||||
|
if in.Exposure != nil {
|
||||||
|
e, err := normalizeExposure(*in.Exposure)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
v.Exposure = e
|
||||||
|
}
|
||||||
|
if in.Acknowledged != nil {
|
||||||
|
v.Acknowledged = cleanAcks(*in.Acknowledged)
|
||||||
|
}
|
||||||
|
if in.ReverseSuggestions != nil {
|
||||||
|
v.ReverseSuggestionsOff = !*in.ReverseSuggestions
|
||||||
|
}
|
||||||
|
if in.DismissedReverse != nil {
|
||||||
|
v.DismissedReverse = slices.Clone(*in.DismissedReverse)
|
||||||
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// normalizeExposure checks an exposure override.
|
||||||
|
func normalizeExposure(s string) (string, error) {
|
||||||
|
switch e := strings.ToLower(strings.TrimSpace(s)); e {
|
||||||
|
case "", "auto":
|
||||||
|
return model.ExposureAuto, nil
|
||||||
|
case model.ExposurePublic, model.ExposurePrivate:
|
||||||
|
return e, nil
|
||||||
|
}
|
||||||
|
return "", errf(KindBadRequest, "exposure must be auto, public or private, not %q", s)
|
||||||
|
}
|
||||||
|
|
||||||
|
// cleanAcks drops empty acknowledgements (nil for none).
|
||||||
|
func cleanAcks(acks []model.Acknowledgement) []model.Acknowledgement {
|
||||||
|
var out []model.Acknowledgement
|
||||||
|
for _, a := range acks {
|
||||||
|
if a.Code != "" {
|
||||||
|
out = append(out, a)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
func applyViewCreate(st *model.State, op model.Op, c *applyCtx) error {
|
func applyViewCreate(st *model.State, op model.Op, c *applyCtx) error {
|
||||||
var in ViewInput
|
var in ViewInput
|
||||||
if err := decode(op.Data, &in); err != nil {
|
if err := decode(op.Data, &in); err != nil {
|
||||||
@@ -1329,6 +1401,22 @@ func applySettings(st *model.State, op model.Op, c *applyCtx) error {
|
|||||||
if in.SerialPolicy != nil {
|
if in.SerialPolicy != nil {
|
||||||
s.SerialPolicy = strings.ToLower(*in.SerialPolicy)
|
s.SerialPolicy = strings.ToLower(*in.SerialPolicy)
|
||||||
}
|
}
|
||||||
|
if in.Exposure != nil {
|
||||||
|
e, err := normalizeExposure(*in.Exposure)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
s.Exposure = e
|
||||||
|
}
|
||||||
|
if in.Acknowledged != nil {
|
||||||
|
s.Acknowledged = cleanAcks(*in.Acknowledged)
|
||||||
|
}
|
||||||
|
if in.DismissedReverse != nil {
|
||||||
|
s.DismissedReverse = slices.Clone(*in.DismissedReverse)
|
||||||
|
}
|
||||||
|
if in.EncryptedDNSHosts != nil {
|
||||||
|
s.EncryptedDNSHosts = slices.Clone(*in.EncryptedDNSHosts)
|
||||||
|
}
|
||||||
s.Version++
|
s.Version++
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"jarl/internal/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Ticking "update PTR" on an unchanged address record adds its PTR when
|
||||||
|
// the reverse zone is there (it was created after the record).
|
||||||
|
func TestUpdatePTRAddsMissing(t *testing.T) {
|
||||||
|
env := newEnv(t)
|
||||||
|
env.submit(env.admin, NewRequest(OpSettingsUpdate, 0, SettingsInput{Nameservers: &[]string{"ns1.example.net."}}))
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("example.com")}))
|
||||||
|
env.submit(env.admin, rec("example.com", "ldn", "A", "139.144.144.154"))
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("139.144.144.154/32")}))
|
||||||
|
var id int64
|
||||||
|
for _, r := range env.state().Records {
|
||||||
|
if r.Name == "ldn.example.com." {
|
||||||
|
id = r.ID
|
||||||
|
}
|
||||||
|
}
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordUpdate, id, RecordInput{PTR: true}))
|
||||||
|
got := env.records("154.144.144.139.in-addr.arpa.")
|
||||||
|
if !slices.ContainsFunc(got, func(s string) bool { return strings.Contains(s, "PTR ldn.example.com.") }) {
|
||||||
|
t.Errorf("reverse zone = %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// In linked zones the PTR goes to the reverse zone of whichever linked
|
||||||
|
// view has one.
|
||||||
|
func TestUpdatePTRLinked(t *testing.T) {
|
||||||
|
env := linkedEnv(t)
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("example.com"), View: model.Ptr("external"), LinkWith: "internal"}))
|
||||||
|
env.submit(env.admin, recIn("internal", "ldn", "A", "139.144.144.154"))
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("139.144.144.154/32"), View: model.Ptr("external")}))
|
||||||
|
res := env.submit(env.admin, NewRequest(OpRecordUpdate, env.recordID("internal", "ldn", "A"), RecordInput{PTR: true}))
|
||||||
|
st := env.state()
|
||||||
|
z := st.FindZone("154.144.144.139.in-addr.arpa.", st.ViewByName("external").ID)
|
||||||
|
ok := false
|
||||||
|
for _, r := range st.ZoneRecords(z.ID) {
|
||||||
|
ok = ok || r.Type == "PTR" && r.Data == "ldn.example.com."
|
||||||
|
}
|
||||||
|
if !ok {
|
||||||
|
t.Errorf("no PTR in external's reverse zone (warnings %q)", res.Warnings)
|
||||||
|
}
|
||||||
|
// Again: already there, nothing to do.
|
||||||
|
if e := env.submitErr(env.admin, NewRequest(OpRecordUpdate, env.recordID("internal", "ldn", "A"), RecordInput{PTR: true})); !strings.Contains(e.Message, "nothing to do") {
|
||||||
|
t.Errorf("second time: %v", e)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,549 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net/netip"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"jarl/internal/dnsname"
|
||||||
|
"jarl/internal/model"
|
||||||
|
"jarl/internal/rr"
|
||||||
|
"jarl/internal/validate"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Reverse zones made easy (docs/reverse.md): filling a reverse zone from
|
||||||
|
// the A and AAAA records of its view, choosing its view, and suggesting
|
||||||
|
// the reverse zones a view lacks.
|
||||||
|
|
||||||
|
// addrUse is an address a forward record gives a name.
|
||||||
|
type addrUse struct {
|
||||||
|
addr netip.Addr
|
||||||
|
name string // the owner name, absolute
|
||||||
|
apex bool
|
||||||
|
view string // another view's record (fillAddresses), else ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// forwardAddresses returns the addresses of the enabled A and AAAA
|
||||||
|
// records of a view's primary forward zones (wildcards aside: a PTR record
|
||||||
|
// can't name them).
|
||||||
|
func forwardAddresses(st *model.State, viewID int64) []addrUse {
|
||||||
|
var out []addrUse
|
||||||
|
for _, z := range st.ZonesInView(viewID) {
|
||||||
|
if z.Type != model.ZonePrimary || z.Disabled || dnsname.IsReverse(z.Name) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, r := range st.ZoneRecords(z.ID) {
|
||||||
|
if r.Disabled || (r.Type != "A" && r.Type != "AAAA") || strings.HasPrefix(r.Name, "*.") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
a, err := netip.ParseAddr(r.Data)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
out = append(out, addrUse{addr: a.Unmap(), name: r.Name, apex: r.Name == z.Name})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// fillAddresses returns a view's addresses (forwardAddresses), then those
|
||||||
|
// of the other views' records that none of its own records use, marked
|
||||||
|
// with their view: a reverse zone in the internal view can name a host
|
||||||
|
// only the external view has a record for.
|
||||||
|
func fillAddresses(st *model.State, viewID int64) []addrUse {
|
||||||
|
out := forwardAddresses(st, viewID)
|
||||||
|
if len(st.Views) == 0 {
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
own := map[netip.Addr]bool{}
|
||||||
|
for _, u := range out {
|
||||||
|
own[u.addr] = true
|
||||||
|
}
|
||||||
|
for _, v := range st.OrderedViews() {
|
||||||
|
if v.ID == viewID {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, u := range forwardAddresses(st, v.ID) {
|
||||||
|
if !own[u.addr] {
|
||||||
|
u.view = v.Name
|
||||||
|
out = append(out, u)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// PTRFill is a PTR record filling a reverse zone would add.
|
||||||
|
type PTRFill struct {
|
||||||
|
Address string `json:"address"`
|
||||||
|
Name string `json:"name"` // the PTR owner name
|
||||||
|
Target string `json:"target"` // the host name it gives
|
||||||
|
Others []string `json:"others,omitempty"` // other names with this address
|
||||||
|
// From is the view whose record names the host, when the zone's own
|
||||||
|
// view has none for the address.
|
||||||
|
From string `json:"from,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PTRFills returns the PTR records a reverse zone named zoneName in a view
|
||||||
|
// lacks for the addresses of the view's A and AAAA records: one per
|
||||||
|
// address, naming its mail or name server host when it is one, otherwise
|
||||||
|
// a host rather than the domain itself, then the shortest name. An
|
||||||
|
// address no record of the view uses is named from another view's
|
||||||
|
// records (fillAddresses), marked From. existing are the zone's records
|
||||||
|
// (none for a new zone).
|
||||||
|
func PTRFills(st *model.State, viewID int64, zoneName string, existing []*model.Record) []PTRFill {
|
||||||
|
prefix, ok := dnsname.PrefixFromReverse(zoneName)
|
||||||
|
if !ok {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
has := map[string]bool{}
|
||||||
|
for _, r := range existing {
|
||||||
|
if r.Type == "PTR" {
|
||||||
|
has[r.Name] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
servers := serverNames(st, viewID)
|
||||||
|
byAddr := map[netip.Addr][]addrUse{}
|
||||||
|
var order []netip.Addr
|
||||||
|
for _, u := range fillAddresses(st, viewID) {
|
||||||
|
if !prefix.Contains(u.addr) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if _, seen := byAddr[u.addr]; !seen {
|
||||||
|
order = append(order, u.addr)
|
||||||
|
}
|
||||||
|
if !slices.ContainsFunc(byAddr[u.addr], func(o addrUse) bool { return o.name == u.name }) {
|
||||||
|
byAddr[u.addr] = append(byAddr[u.addr], u)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
slices.SortFunc(order, func(a, b netip.Addr) int { return a.Compare(b) })
|
||||||
|
var out []PTRFill
|
||||||
|
for _, a := range order {
|
||||||
|
owner := dnsname.ReverseName(a)
|
||||||
|
if has[owner] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
uses := byAddr[a]
|
||||||
|
slices.SortStableFunc(uses, func(x, y addrUse) int {
|
||||||
|
rank := func(u addrUse) int {
|
||||||
|
switch {
|
||||||
|
case servers[u.name]:
|
||||||
|
return 0
|
||||||
|
case !u.apex:
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
return 2
|
||||||
|
}
|
||||||
|
if d := rank(x) - rank(y); d != 0 {
|
||||||
|
return d
|
||||||
|
}
|
||||||
|
if d := strings.Count(x.name, ".") - strings.Count(y.name, "."); d != 0 {
|
||||||
|
return d
|
||||||
|
}
|
||||||
|
return strings.Compare(x.name, y.name)
|
||||||
|
})
|
||||||
|
f := PTRFill{Address: a.String(), Name: owner, Target: uses[0].name, From: uses[0].view}
|
||||||
|
for _, u := range uses[1:] {
|
||||||
|
if u.name != f.Target {
|
||||||
|
f.Others = append(f.Others, u.name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out = append(out, f)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// serverNames are the hosts the view's MX and NS records name.
|
||||||
|
func serverNames(st *model.State, viewID int64) map[string]bool {
|
||||||
|
out := map[string]bool{}
|
||||||
|
for _, z := range st.ZonesInView(viewID) {
|
||||||
|
if z.Type != model.ZonePrimary {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, r := range st.ZoneRecords(z.ID) {
|
||||||
|
switch r.Type {
|
||||||
|
case "MX":
|
||||||
|
if f := strings.Fields(r.Data); len(f) == 2 {
|
||||||
|
out[strings.ToLower(f[1])] = true
|
||||||
|
}
|
||||||
|
case "NS":
|
||||||
|
out[strings.ToLower(r.Data)] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func fillWarnings(fills []PTRFill) []string {
|
||||||
|
var out []string
|
||||||
|
for _, f := range fills {
|
||||||
|
if f.From != "" {
|
||||||
|
out = append(out, fmt.Sprintf("%s: only view %s has a record for it, so its PTR record gives %s from there", f.Address, f.From, dnsname.Display(f.Target)))
|
||||||
|
}
|
||||||
|
if len(f.Others) > 0 {
|
||||||
|
out = append(out, fmt.Sprintf("%s has several names: its PTR record gives %s (not %s); change it if you prefer another", f.Address, dnsname.Display(f.Target), strings.Join(displayAll(f.Others), ", ")))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func displayAll(names []string) []string {
|
||||||
|
out := make([]string, len(names))
|
||||||
|
for i, n := range names {
|
||||||
|
out[i] = dnsname.Display(n)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// zoneFillPTR expands zone.fill_ptr: the PTR records a reverse zone lacks.
|
||||||
|
func (x *expander) zoneFillPTR(req Request) ([]model.Op, error) {
|
||||||
|
var in LinkInput
|
||||||
|
if err := decode(req.Data, &in); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
id := in.ZoneID
|
||||||
|
if id == 0 {
|
||||||
|
id = req.ID
|
||||||
|
}
|
||||||
|
z := x.st.Zones[id]
|
||||||
|
if z == nil {
|
||||||
|
return nil, errf(KindNotFound, "zone %d does not exist", id)
|
||||||
|
}
|
||||||
|
if z.Type != model.ZonePrimary {
|
||||||
|
return nil, errf(KindBadRequest, "zone %s isn't a primary zone", zoneDesc(x.st, z))
|
||||||
|
}
|
||||||
|
if _, ok := dnsname.PrefixFromReverse(z.Name); !ok {
|
||||||
|
return nil, errf(KindBadRequest, "zone %s isn't a reverse zone of whole octets or nibbles (like 10.0.10.in-addr.arpa)", zoneDesc(x.st, z))
|
||||||
|
}
|
||||||
|
fills := PTRFills(x.st, z.ViewID, z.Name, x.st.ZoneRecords(z.ID))
|
||||||
|
if len(fills) == 0 {
|
||||||
|
return nil, errf(KindBadRequest, "nothing to add: every address of %s's A and AAAA records in %s has a PTR record", viewOrServer(x.st, z.ViewID), zoneDesc(x.st, z))
|
||||||
|
}
|
||||||
|
x.warnings = append(x.warnings, fillWarnings(fills)...)
|
||||||
|
ids, err := x.ids(len(fills))
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
var ops []model.Op
|
||||||
|
for i, f := range fills {
|
||||||
|
ri := RecordInput{ZoneID: z.ID, Name: model.Ptr(f.Name), Type: model.Ptr("PTR"), Data: model.Ptr(f.Target)}
|
||||||
|
if z.LinkGroup != 0 {
|
||||||
|
ri.SharedID = model.Ptr(ids[i])
|
||||||
|
}
|
||||||
|
ops = append(ops, newOp(OpRecordCreate, ids[i], 0, ri, fmt.Sprintf("add %s IN PTR %s", f.Name, f.Target)))
|
||||||
|
}
|
||||||
|
return ops, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func viewOrServer(st *model.State, viewID int64) string {
|
||||||
|
if v := st.Views[viewID]; v != nil {
|
||||||
|
return "view " + v.Name
|
||||||
|
}
|
||||||
|
return "the server"
|
||||||
|
}
|
||||||
|
|
||||||
|
// publicViews returns which views the internet reaches.
|
||||||
|
func (x *expander) publicViews() map[int64]bool {
|
||||||
|
out := map[int64]bool{}
|
||||||
|
if x.exposures == nil {
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
for _, e := range x.exposures(x.st) {
|
||||||
|
out[e.ViewID] = e.Public
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// reverseViewFor chooses the view of a new reverse zone given without one:
|
||||||
|
// the private view whose records use addresses in its range, or the only
|
||||||
|
// private view; views with reverse suggestions off don't count. nil with
|
||||||
|
// no error leaves the choice to the usual rules.
|
||||||
|
func reverseViewFor(st *model.State, public map[int64]bool, zoneName string) (*model.View, error) {
|
||||||
|
prefix, ok := dnsname.PrefixFromReverse(zoneName)
|
||||||
|
if !ok || len(st.Views) == 0 {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
var private, using []*model.View
|
||||||
|
for _, v := range st.OrderedViews() {
|
||||||
|
if public[v.ID] || v.ReverseSuggestionsOff {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
private = append(private, v)
|
||||||
|
if slices.ContainsFunc(forwardAddresses(st, v.ID), func(u addrUse) bool { return prefix.Contains(u.addr) }) {
|
||||||
|
using = append(using, v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case len(using) == 1:
|
||||||
|
return using[0], nil
|
||||||
|
case len(using) > 1:
|
||||||
|
var names []string
|
||||||
|
for _, v := range using {
|
||||||
|
names = append(names, v.Name)
|
||||||
|
}
|
||||||
|
return nil, errf(KindBadRequest, "views %s all have addresses in %s: give the view (or create the zone in each)", strings.Join(names, " and "), prefix)
|
||||||
|
case len(private) == 1:
|
||||||
|
return private[0], nil
|
||||||
|
}
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReverseSuggestion is a reverse zone a view lacks for addresses its
|
||||||
|
// records use.
|
||||||
|
type ReverseSuggestion struct {
|
||||||
|
ViewID int64 `json:"view_id"`
|
||||||
|
View string `json:"view,omitempty"`
|
||||||
|
Prefix string `json:"prefix"`
|
||||||
|
Zone string `json:"zone"`
|
||||||
|
// Group is "yours" for networks that are yours for sure (private
|
||||||
|
// ranges, IPv6 prefixes this server has an address in), "public" for
|
||||||
|
// a public address that may be someone else's (a web host's).
|
||||||
|
Group string `json:"group"`
|
||||||
|
// Hidden says why the suggestion isn't made unasked (with All only):
|
||||||
|
// "public view", "suggestions off" or "dismissed".
|
||||||
|
Hidden string `json:"hidden,omitempty"`
|
||||||
|
Why string `json:"why"`
|
||||||
|
Fill int `json:"fill"` // PTR records creating it with fill adds
|
||||||
|
Samples []string `json:"samples"` // a few of them, "address name"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Suggestion groups.
|
||||||
|
const (
|
||||||
|
SuggestYours = "yours"
|
||||||
|
SuggestPublic = "public"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ReverseSuggestions returns the reverse zones the private views (or the
|
||||||
|
// server, without views) lack for their A and AAAA records' addresses:
|
||||||
|
//
|
||||||
|
// - yours: the /24 of a private IPv4 address, the /48 of a ULA or of a
|
||||||
|
// public IPv6 prefix this server has an address in (local);
|
||||||
|
// - public: a /32 (or /128) for any other public address. It may be a
|
||||||
|
// web host's; the rest of its /24 surely belongs to others, and a
|
||||||
|
// zone for it here would hide their names from your clients.
|
||||||
|
//
|
||||||
|
// Public views, views with suggestions turned off and dismissed networks
|
||||||
|
// get none: the internet asks the addresses' owners.
|
||||||
|
func ReverseSuggestions(st *model.State, exposures []validate.Exposure, local []netip.Addr) []ReverseSuggestion {
|
||||||
|
return ReverseCandidates(st, exposures, local, ReverseOptions{})
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReverseOptions widen or narrow ReverseCandidates.
|
||||||
|
type ReverseOptions struct {
|
||||||
|
// All includes what isn't suggested unasked, marked Hidden: public
|
||||||
|
// views, views with suggestions off, dismissed networks.
|
||||||
|
All bool
|
||||||
|
// View narrows it to one view (by name; "" all). With All, the view
|
||||||
|
// also gets the addresses only other views' records use, marked
|
||||||
|
// Hidden "records in VIEW": a reverse zone there can name them.
|
||||||
|
View string
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReverseCandidates is ReverseSuggestions with options: with All, every
|
||||||
|
// network the views' records use that no reverse zone in their view
|
||||||
|
// covers, for creating one by hand where suggestions are off.
|
||||||
|
func ReverseCandidates(st *model.State, exposures []validate.Exposure, local []netip.Addr, opt ReverseOptions) []ReverseSuggestion {
|
||||||
|
public := map[int64]bool{}
|
||||||
|
for _, e := range exposures {
|
||||||
|
public[e.ViewID] = e.Public
|
||||||
|
}
|
||||||
|
type scope struct {
|
||||||
|
id int64
|
||||||
|
dismissed []string
|
||||||
|
hidden string
|
||||||
|
}
|
||||||
|
var scopes []scope
|
||||||
|
if len(st.Views) > 0 {
|
||||||
|
for _, v := range st.OrderedViews() {
|
||||||
|
if opt.View != "" && !strings.EqualFold(v.Name, opt.View) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
hidden := ""
|
||||||
|
switch {
|
||||||
|
case public[v.ID]:
|
||||||
|
hidden = "public view"
|
||||||
|
case v.ReverseSuggestionsOff:
|
||||||
|
hidden = "suggestions off"
|
||||||
|
}
|
||||||
|
if hidden == "" || opt.All {
|
||||||
|
scopes = append(scopes, scope{v.ID, v.DismissedReverse, hidden})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else if !public[0] || opt.All {
|
||||||
|
hidden := ""
|
||||||
|
if public[0] {
|
||||||
|
hidden = "public server"
|
||||||
|
}
|
||||||
|
scopes = append(scopes, scope{0, st.Settings.DismissedReverse, hidden})
|
||||||
|
}
|
||||||
|
out := []ReverseSuggestion{}
|
||||||
|
for _, sc := range scopes {
|
||||||
|
seen := map[netip.Prefix]bool{}
|
||||||
|
addrs := forwardAddresses(st, sc.id)
|
||||||
|
if opt.All && opt.View != "" {
|
||||||
|
addrs = fillAddresses(st, sc.id)
|
||||||
|
}
|
||||||
|
for _, u := range addrs {
|
||||||
|
a := u.addr
|
||||||
|
if a.IsLoopback() || a.IsLinkLocalUnicast() || a.IsUnspecified() || a.IsMulticast() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if rz, _ := reverseZoneFor(st, sc.id, a); rz != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
p, group, why := suggestedPrefix(a, local)
|
||||||
|
hidden := sc.hidden
|
||||||
|
if hidden == "" && u.view != "" {
|
||||||
|
hidden = "records in " + u.view
|
||||||
|
}
|
||||||
|
if seen[p] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if slices.Contains(sc.dismissed, p.String()) {
|
||||||
|
if !opt.All {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if hidden == "" {
|
||||||
|
hidden = "dismissed"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
seen[p] = true
|
||||||
|
name, err := dnsname.ReverseZone(p)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
s := ReverseSuggestion{ViewID: sc.id, View: viewName(st, sc.id), Prefix: p.String(), Zone: strings.TrimSuffix(name, "."), Group: group, Hidden: hidden, Why: why, Samples: []string{}}
|
||||||
|
fills := PTRFills(st, sc.id, name, nil)
|
||||||
|
s.Fill = len(fills)
|
||||||
|
for i, f := range fills {
|
||||||
|
if i == 3 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
s.Samples = append(s.Samples, f.Address+" "+dnsname.Display(f.Target))
|
||||||
|
}
|
||||||
|
out = append(out, s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
slices.SortStableFunc(out, func(a, b ReverseSuggestion) int {
|
||||||
|
if a.Group != b.Group {
|
||||||
|
return strings.Compare(b.Group, a.Group) // yours first
|
||||||
|
}
|
||||||
|
if a.View != b.View {
|
||||||
|
return strings.Compare(a.View, b.View)
|
||||||
|
}
|
||||||
|
return netip.MustParsePrefix(a.Prefix).Addr().Compare(netip.MustParsePrefix(b.Prefix).Addr())
|
||||||
|
})
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// suggestedPrefix returns the reverse zone network for an address, its
|
||||||
|
// group and why.
|
||||||
|
func suggestedPrefix(a netip.Addr, local []netip.Addr) (netip.Prefix, string, string) {
|
||||||
|
switch {
|
||||||
|
case a.Is4() && (a.IsPrivate() || cgnat.Contains(a)):
|
||||||
|
return netip.PrefixFrom(a, 24).Masked(), SuggestYours, "private network"
|
||||||
|
case a.Is4():
|
||||||
|
return netip.PrefixFrom(a, 32), SuggestPublic, "a public address: create it only if it is yours (not a web host's); the rest of its /24 belongs to others"
|
||||||
|
case a.IsPrivate():
|
||||||
|
return netip.PrefixFrom(a, 48).Masked(), SuggestYours, "your ULA /48 (one zone for all its subnets)"
|
||||||
|
}
|
||||||
|
p := netip.PrefixFrom(a, 48).Masked()
|
||||||
|
if slices.ContainsFunc(local, func(l netip.Addr) bool { return p.Contains(l.Unmap()) }) {
|
||||||
|
return p, SuggestYours, "your IPv6 /48 (this server has an address in it): one zone for all its subnets"
|
||||||
|
}
|
||||||
|
return netip.PrefixFrom(a, 128), SuggestPublic, "a public address outside this server's networks: create it only if it is yours"
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReverseSuggestions lists the reverse zones the views lack (opt.All:
|
||||||
|
// also where suggestions aren't made unasked).
|
||||||
|
func (e *Engine) ReverseSuggestions(st *model.State, opt ReverseOptions) []ReverseSuggestion {
|
||||||
|
var local []netip.Addr
|
||||||
|
if e.cfg.LocalAddrs != nil {
|
||||||
|
local = e.cfg.LocalAddrs()
|
||||||
|
}
|
||||||
|
return ReverseCandidates(st, e.Exposures(st), local, opt)
|
||||||
|
}
|
||||||
|
|
||||||
|
// reverseDismiss expands reverse.dismiss and reverse.undismiss.
|
||||||
|
func (x *expander) reverseDismiss(req Request, dismiss bool) ([]model.Op, error) {
|
||||||
|
var in DismissInput
|
||||||
|
if err := decode(req.Data, &in); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
raw := in.Prefixes
|
||||||
|
if in.Prefix != "" {
|
||||||
|
raw = append(raw, in.Prefix)
|
||||||
|
}
|
||||||
|
if len(raw) == 0 {
|
||||||
|
return nil, errf(KindBadRequest, "give the network (prefix) of the suggestion")
|
||||||
|
}
|
||||||
|
var prefixes []string
|
||||||
|
for _, r := range raw {
|
||||||
|
p, err := netip.ParsePrefix(strings.TrimSpace(r))
|
||||||
|
if err != nil {
|
||||||
|
return nil, errf(KindBadRequest, "prefix: %v", err)
|
||||||
|
}
|
||||||
|
if s := p.Masked().String(); !slices.Contains(prefixes, s) {
|
||||||
|
prefixes = append(prefixes, s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var v *model.View
|
||||||
|
switch {
|
||||||
|
case in.ViewID != 0:
|
||||||
|
v = x.st.Views[in.ViewID]
|
||||||
|
case in.View != "":
|
||||||
|
v = x.st.ViewByName(in.View)
|
||||||
|
}
|
||||||
|
if (in.ViewID != 0 || in.View != "") && v == nil {
|
||||||
|
return nil, errf(KindNotFound, "no view %s", firstNonEmptyStr(in.View, fmt.Sprint(in.ViewID)))
|
||||||
|
}
|
||||||
|
if v == nil && len(x.st.Views) > 0 {
|
||||||
|
return nil, errf(KindBadRequest, "give the view of the suggestion")
|
||||||
|
}
|
||||||
|
list, where := x.st.Settings.DismissedReverse, "the server"
|
||||||
|
if v != nil {
|
||||||
|
list, where = v.DismissedReverse, "view "+v.Name
|
||||||
|
}
|
||||||
|
out := slices.DeleteFunc(slices.Clone(list), func(s string) bool { return slices.Contains(prefixes, s) })
|
||||||
|
what := prefixes[0]
|
||||||
|
if len(prefixes) > 1 {
|
||||||
|
what = fmt.Sprintf("%d networks (%s, …)", len(prefixes), prefixes[0])
|
||||||
|
}
|
||||||
|
summary := "dismiss the reverse zone suggestion for " + what + " in " + where
|
||||||
|
if dismiss {
|
||||||
|
out = append(out, prefixes...)
|
||||||
|
slices.Sort(out)
|
||||||
|
} else {
|
||||||
|
if len(out) == len(list) {
|
||||||
|
return nil, errf(KindConflict, "%s isn't dismissed in %s", what, where)
|
||||||
|
}
|
||||||
|
summary = "suggest a reverse zone for " + what + " in " + where + " again"
|
||||||
|
}
|
||||||
|
if out == nil {
|
||||||
|
out = []string{}
|
||||||
|
}
|
||||||
|
if v != nil {
|
||||||
|
return []model.Op{newOp(OpViewUpdate, v.ID, v.Version, ViewInput{DismissedReverse: &out}, summary)}, nil
|
||||||
|
}
|
||||||
|
return []model.Op{newOp(OpSettingsUpdate, 0, 0, SettingsInput{DismissedReverse: &out}, summary)}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var cgnat = netip.MustParsePrefix("100.64.0.0/10")
|
||||||
|
|
||||||
|
// autoPTR reports whether a record's PTR is kept in step by its zone's
|
||||||
|
// auto_ptr setting.
|
||||||
|
func autoPTR(z *model.Zone, owner string, p *rr.Parsed) bool {
|
||||||
|
if z == nil || !z.AutoPTR || strings.HasPrefix(owner, "*.") {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
_, ok := addrOf(p)
|
||||||
|
return ok
|
||||||
|
}
|
||||||
|
|
||||||
|
func viewName(st *model.State, id int64) string {
|
||||||
|
if v := st.Views[id]; v != nil {
|
||||||
|
return v.Name
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
@@ -0,0 +1,305 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/netip"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"jarl/internal/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ptrs returns a reverse zone's PTR records in a view as "owner target",
|
||||||
|
// with " disabled" when so.
|
||||||
|
func (env *testEnv) ptrs(view, zone string) []string {
|
||||||
|
env.t.Helper()
|
||||||
|
s := env.state()
|
||||||
|
z := s.FindZone(zone, s.ViewByName(view).ID)
|
||||||
|
if z == nil {
|
||||||
|
env.t.Fatalf("no zone %s in %s", zone, view)
|
||||||
|
}
|
||||||
|
var out []string
|
||||||
|
for _, r := range s.ZoneRecords(z.ID) {
|
||||||
|
if r.Type == "PTR" {
|
||||||
|
d := r.Name + " " + r.Data
|
||||||
|
if r.Disabled {
|
||||||
|
d += " disabled"
|
||||||
|
}
|
||||||
|
out = append(out, d)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReverseFillAndSuggest(t *testing.T) {
|
||||||
|
env := linkedEnv(t)
|
||||||
|
env.submit(env.admin,
|
||||||
|
recIn("internal", "@", "A", "192.0.2.25"),
|
||||||
|
recIn("internal", "nas", "A", "10.0.10.20"),
|
||||||
|
recIn("internal", "files", "A", "10.0.10.20"),
|
||||||
|
recIn("internal", "nas", "AAAA", "fdab:abab:abab:10::20"),
|
||||||
|
recIn("internal", "*.dev", "A", "10.0.10.99"),
|
||||||
|
recIn("internal", "lo", "A", "127.0.0.1"))
|
||||||
|
|
||||||
|
sugg := ReverseSuggestions(env.state(), env.e.Exposures(env.state()), nil)
|
||||||
|
var got []string
|
||||||
|
for _, s := range sugg {
|
||||||
|
got = append(got, s.Group+" "+s.View+" "+s.Prefix+" "+s.Zone)
|
||||||
|
}
|
||||||
|
want(t, "suggestions", got,
|
||||||
|
"yours internal 10.0.10.0/24 10.0.10.in-addr.arpa",
|
||||||
|
"yours internal fdab:abab:abab::/48 b.a.b.a.b.a.b.a.b.a.d.f.ip6.arpa",
|
||||||
|
"public internal 192.0.2.10/32 10.2.0.192.in-addr.arpa",
|
||||||
|
"public internal 192.0.2.25/32 25.2.0.192.in-addr.arpa")
|
||||||
|
if sugg[0].Fill != 1 || sugg[0].Samples[0] != "10.0.10.20 files.example.com" {
|
||||||
|
t.Errorf("10.0.10.0/24: %+v", sugg[0])
|
||||||
|
}
|
||||||
|
|
||||||
|
// No view given: the private view whose records use the addresses.
|
||||||
|
res := env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("10.0.10.0/24"), Fill: true}))
|
||||||
|
want(t, "10.0.10/24", env.ptrs("internal", "10.0.10.in-addr.arpa."), "20.10.0.10.in-addr.arpa. files.example.com.")
|
||||||
|
if !slices.ContainsFunc(res.Warnings, func(w string) bool { return strings.Contains(w, "10.0.10.20 has several names") }) {
|
||||||
|
t.Errorf("warnings %q", res.Warnings)
|
||||||
|
}
|
||||||
|
// The mail server's name beats the domain's own.
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("192.0.2.25/32"), Fill: true}))
|
||||||
|
want(t, "192.0.2.25", env.ptrs("internal", "25.2.0.192.in-addr.arpa."), "25.2.0.192.in-addr.arpa. mail.example.com.")
|
||||||
|
|
||||||
|
// Filling an existing zone; then there is nothing left to add.
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("fdab:abab:abab::/48")}))
|
||||||
|
st := env.state()
|
||||||
|
z6 := st.FindZone("b.a.b.a.b.a.b.a.b.a.d.f.ip6.arpa.", st.ViewByName("internal").ID)
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneFillPTR, z6.ID, LinkInput{}))
|
||||||
|
if p := env.ptrs("internal", z6.Name); len(p) != 1 || !strings.HasSuffix(p[0], " nas.example.com.") {
|
||||||
|
t.Errorf("ip6 fill: %q", p)
|
||||||
|
}
|
||||||
|
if e := env.submitErr(env.admin, NewRequest(OpZoneFillPTR, z6.ID, LinkInput{})); !strings.Contains(e.Message, "nothing to add") {
|
||||||
|
t.Errorf("second fill: %v", e)
|
||||||
|
}
|
||||||
|
|
||||||
|
got = got[:0]
|
||||||
|
for _, s := range ReverseSuggestions(env.state(), env.e.Exposures(env.state()), nil) {
|
||||||
|
got = append(got, s.Prefix)
|
||||||
|
}
|
||||||
|
want(t, "suggestions left", got, "192.0.2.10/32")
|
||||||
|
|
||||||
|
// Addresses that two private views use: the view must be given.
|
||||||
|
env.submit(env.admin, NewRequest(OpViewCreate, 0, ViewInput{Name: model.Ptr("lab"), MatchClients: &[]string{"172.16.0.0/12"}}))
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("lab.test"), View: model.Ptr("lab")}),
|
||||||
|
NewRequest(OpRecordCreate, 0, RecordInput{Zone: "lab.test", View: "lab", Name: model.Ptr("x"), Type: model.Ptr("A"), Data: model.Ptr("192.0.2.10")}))
|
||||||
|
if e := env.submitErr(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("192.0.2.10/32")})); !strings.Contains(e.Message, "views internal and lab all have addresses") {
|
||||||
|
t.Errorf("two views: %v", e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAutoPTR(t *testing.T) {
|
||||||
|
env := linkedEnv(t)
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("10.0.10.0/24"), View: model.Ptr("internal")}))
|
||||||
|
st := env.state()
|
||||||
|
zid := st.FindZone("example.com.", st.ViewByName("internal").ID).ID
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneUpdate, zid, ZoneInput{AutoPTR: model.Ptr(true)}))
|
||||||
|
rz := "10.0.10.in-addr.arpa."
|
||||||
|
|
||||||
|
res := env.submit(env.admin, recIn("internal", "host", "A", "10.0.10.30"), recIn("internal", "pub", "A", "203.0.113.5"))
|
||||||
|
want(t, "added", env.ptrs("internal", rz), "30.10.0.10.in-addr.arpa. host.example.com.")
|
||||||
|
if len(res.Warnings) > 0 {
|
||||||
|
t.Errorf("no reverse zone for 203.0.113.5 isn't worth a warning: %q", res.Warnings)
|
||||||
|
}
|
||||||
|
// A second name for the address: its PTR stays.
|
||||||
|
res = env.submit(env.admin, recIn("internal", "alias", "A", "10.0.10.30"))
|
||||||
|
want(t, "second name", env.ptrs("internal", rz), "30.10.0.10.in-addr.arpa. host.example.com.")
|
||||||
|
if len(res.Warnings) > 0 {
|
||||||
|
t.Errorf("warnings %q", res.Warnings)
|
||||||
|
}
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordDelete, env.recordID("internal", "alias", "A"), nil))
|
||||||
|
|
||||||
|
// Moved, disabled, enabled, deleted.
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordUpdate, env.recordID("internal", "host", "A"), RecordInput{Data: model.Ptr("10.0.10.31")}))
|
||||||
|
want(t, "moved", env.ptrs("internal", rz), "31.10.0.10.in-addr.arpa. host.example.com.")
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordUpdate, env.recordID("internal", "host", "A"), RecordInput{Disabled: model.Ptr(true)}))
|
||||||
|
want(t, "disabled", env.ptrs("internal", rz), "31.10.0.10.in-addr.arpa. host.example.com. disabled")
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordUpdate, env.recordID("internal", "host", "A"), RecordInput{Disabled: model.Ptr(false)}))
|
||||||
|
want(t, "enabled", env.ptrs("internal", rz), "31.10.0.10.in-addr.arpa. host.example.com.")
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordDelete, env.recordID("internal", "host", "A"), nil))
|
||||||
|
want(t, "deleted", env.ptrs("internal", rz))
|
||||||
|
|
||||||
|
// A whole set replaced.
|
||||||
|
env.submit(env.admin, NewRequest(OpRRSetReplace, 0, RRSetInput{Zone: "example.com", View: "internal", Name: "multi", Type: "A", Data: []string{"10.0.10.40", "10.0.10.41"}}))
|
||||||
|
want(t, "set", env.ptrs("internal", rz), "40.10.0.10.in-addr.arpa. multi.example.com.", "41.10.0.10.in-addr.arpa. multi.example.com.")
|
||||||
|
env.submit(env.admin, NewRequest(OpRRSetReplace, 0, RRSetInput{Zone: "example.com", View: "internal", Name: "multi", Type: "A", Data: []string{"10.0.10.41"}}))
|
||||||
|
want(t, "set shrunk", env.ptrs("internal", rz), "41.10.0.10.in-addr.arpa. multi.example.com.")
|
||||||
|
// Deleting by name and type.
|
||||||
|
env.submit(env.admin, NewRequest(OpRecordDelete, 0, RecordInput{Zone: "example.com", View: "internal", Name: model.Ptr("multi"), Type: model.Ptr("A")}))
|
||||||
|
want(t, "deleted by match", env.ptrs("internal", rz))
|
||||||
|
|
||||||
|
// Off again: records come and go alone.
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneUpdate, zid, ZoneInput{AutoPTR: model.Ptr(false)}))
|
||||||
|
env.submit(env.admin, recIn("internal", "quiet", "A", "10.0.10.50"))
|
||||||
|
want(t, "off", env.ptrs("internal", rz))
|
||||||
|
}
|
||||||
|
|
||||||
|
func suggested(env *testEnv, local ...netip.Addr) []string {
|
||||||
|
var out []string
|
||||||
|
for _, s := range ReverseSuggestions(env.state(), env.e.Exposures(env.state()), local) {
|
||||||
|
out = append(out, s.Group+" "+s.View+" "+s.Prefix)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// Public IPv6: the /48 only when this server has an address in it, else
|
||||||
|
// the address alone, as a public suggestion. Dismissed networks and views
|
||||||
|
// with suggestions off get none.
|
||||||
|
func TestReverseSuggestionGroups(t *testing.T) {
|
||||||
|
env := linkedEnv(t)
|
||||||
|
env.submit(env.admin,
|
||||||
|
recIn("internal", "home", "AAAA", "2a02:8013:7f3d:10::5"),
|
||||||
|
recIn("internal", "gh", "AAAA", "2606:50c0:8000::153"))
|
||||||
|
want(t, "no local addresses", suggested(env),
|
||||||
|
"public internal 192.0.2.10/32", "public internal 192.0.2.25/32",
|
||||||
|
"public internal 2606:50c0:8000::153/128", "public internal 2a02:8013:7f3d:10::5/128")
|
||||||
|
want(t, "this server is in 2a02:8013:7f3d::/48", suggested(env, netip.MustParseAddr("2a02:8013:7f3d:10:1266:6aff:fef9:f5b1")),
|
||||||
|
"yours internal 2a02:8013:7f3d::/48",
|
||||||
|
"public internal 192.0.2.10/32", "public internal 192.0.2.25/32", "public internal 2606:50c0:8000::153/128")
|
||||||
|
|
||||||
|
env.submit(env.admin, NewRequest(OpReverseDismiss, 0, DismissInput{View: "internal", Prefix: "2606:50c0:8000::153/128"}))
|
||||||
|
if got := suggested(env); slices.Contains(got, "public internal 2606:50c0:8000::153/128") {
|
||||||
|
t.Errorf("dismissed still suggested: %q", got)
|
||||||
|
}
|
||||||
|
if e := env.submitErr(env.admin, NewRequest(OpReverseUndismiss, 0, DismissInput{View: "internal", Prefix: "192.0.2.10/32"})); e.Kind != KindConflict {
|
||||||
|
t.Errorf("undismiss of one not dismissed: %v", e)
|
||||||
|
}
|
||||||
|
env.submit(env.admin, NewRequest(OpReverseUndismiss, 0, DismissInput{View: "internal", Prefix: "2606:50c0:8000::153/128"}))
|
||||||
|
// Several at once.
|
||||||
|
env.submit(env.admin, NewRequest(OpReverseDismiss, 0, DismissInput{View: "internal", Prefixes: []string{"192.0.2.10/32", "192.0.2.25/32"}}))
|
||||||
|
if got := suggested(env); slices.ContainsFunc(got, func(s string) bool { return strings.Contains(s, "192.0.2.") }) {
|
||||||
|
t.Errorf("dismissed together, still suggested: %q", got)
|
||||||
|
}
|
||||||
|
env.submit(env.admin, NewRequest(OpReverseUndismiss, 0, DismissInput{View: "internal", Prefixes: []string{"192.0.2.10/32", "192.0.2.25/32"}}))
|
||||||
|
if got := suggested(env); !slices.Contains(got, "public internal 2606:50c0:8000::153/128") {
|
||||||
|
t.Errorf("undismissed not suggested: %q", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A second private view using the same address (a VPS's view): with
|
||||||
|
// its suggestions off it gets none, and doesn't count when choosing
|
||||||
|
// the view of a new reverse zone.
|
||||||
|
env.submit(env.admin, NewRequest(OpViewCreate, 0, ViewInput{Name: model.Ptr("vps"), MatchClients: &[]string{"198.51.100.7"}}))
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("example.com"), View: model.Ptr("vps"), LinkWith: "internal"}))
|
||||||
|
if got := suggested(env); !slices.Contains(got, "public vps 192.0.2.25/32") {
|
||||||
|
t.Errorf("vps view: %q", got)
|
||||||
|
}
|
||||||
|
if e := env.submitErr(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("192.0.2.25/32")})); !strings.Contains(e.Message, "views internal and vps") {
|
||||||
|
t.Errorf("two views: %v", e)
|
||||||
|
}
|
||||||
|
vps := env.state().ViewByName("vps")
|
||||||
|
env.submit(env.admin, NewRequest(OpViewUpdate, vps.ID, ViewInput{ReverseSuggestions: model.Ptr(false)}))
|
||||||
|
if got := suggested(env); slices.ContainsFunc(got, func(s string) bool { return strings.Contains(s, " vps ") }) {
|
||||||
|
t.Errorf("vps view with suggestions off: %q", got)
|
||||||
|
}
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("192.0.2.25/32"), Fill: true}))
|
||||||
|
want(t, "went to internal", env.ptrs("internal", "25.2.0.192.in-addr.arpa."), "25.2.0.192.in-addr.arpa. mail.example.com.")
|
||||||
|
}
|
||||||
|
|
||||||
|
// A zone created inside another takes the parent's records under it.
|
||||||
|
func TestChildZoneTakesRecords(t *testing.T) {
|
||||||
|
env := linkedEnv(t)
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("10.0.0.0/8"), View: model.Ptr("internal")}))
|
||||||
|
ptr := func(name, data string) Request {
|
||||||
|
return NewRequest(OpRecordCreate, 0, RecordInput{Zone: "10.in-addr.arpa", View: "internal", Name: &name, Type: model.Ptr("PTR"), Data: &data})
|
||||||
|
}
|
||||||
|
env.submit(env.admin, ptr("20.10.0.10.in-addr.arpa.", "printer.example.com."), ptr("5.20.0.10.in-addr.arpa.", "other.example.com."))
|
||||||
|
env.submit(env.admin, recIn("internal", "nas", "A", "10.0.10.30"))
|
||||||
|
res := env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("10.0.10.0/24"), View: model.Ptr("internal"), Fill: true}))
|
||||||
|
want(t, "/24", env.ptrs("internal", "10.0.10.in-addr.arpa."),
|
||||||
|
"20.10.0.10.in-addr.arpa. printer.example.com.", "30.10.0.10.in-addr.arpa. nas.example.com.")
|
||||||
|
want(t, "/8 keeps the rest", env.ptrs("internal", "10.in-addr.arpa."), "5.20.0.10.in-addr.arpa. other.example.com.")
|
||||||
|
for _, p := range res.Problems {
|
||||||
|
if p.Code == "shadowed_by_zone" {
|
||||||
|
t.Errorf("still hidden records: %v", p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A forward child: its delegation and glue stay in the parent.
|
||||||
|
env.submit(env.admin,
|
||||||
|
recIn("internal", "lab", "NS", "ns.lab.example.com."),
|
||||||
|
recIn("internal", "ns.lab", "A", "10.0.30.1"),
|
||||||
|
recIn("internal", "www.lab", "A", "10.0.30.2"))
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("lab.example.com"), View: model.Ptr("internal")}))
|
||||||
|
st := env.state()
|
||||||
|
lab := st.FindZone("lab.example.com.", st.ViewByName("internal").ID)
|
||||||
|
var labRecs []string
|
||||||
|
for _, r := range st.ZoneRecords(lab.ID) {
|
||||||
|
if r.Type != "NS" {
|
||||||
|
labRecs = append(labRecs, r.Name+" "+r.Type)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
want(t, "lab", labRecs, "www.lab.example.com. A")
|
||||||
|
v := env.view("internal") // without NS records
|
||||||
|
if !slices.Contains(v, "ns.lab A 10.0.30.1 L") || slices.ContainsFunc(v, func(s string) bool { return strings.HasPrefix(s, "www.lab ") }) {
|
||||||
|
t.Errorf("parent after: %q", v)
|
||||||
|
}
|
||||||
|
if env.recordID("internal", "lab", "NS") == 0 {
|
||||||
|
t.Error("the delegation left the parent")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// With All, the networks no suggestion is made for unasked are listed too,
|
||||||
|
// marked: views with suggestions off, dismissed ones, public views.
|
||||||
|
func TestReverseCandidatesAll(t *testing.T) {
|
||||||
|
env := linkedEnv(t)
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("example.com"), View: model.Ptr("external"), LinkWith: "internal"}))
|
||||||
|
env.submit(env.admin, NewRequest(OpRRSetReplace, 0, RRSetInput{Zone: "example.com", View: "internal", Name: "nas", Type: "AAAA", Data: []string{"2a02:8013:7f3d:10::5"}, Local: model.Ptr(true)}))
|
||||||
|
env.submit(env.admin, NewRequest(OpReverseDismiss, 0, DismissInput{View: "internal", Prefix: "192.0.2.10/32"}))
|
||||||
|
internal := env.state().ViewByName("internal")
|
||||||
|
env.submit(env.admin, NewRequest(OpViewUpdate, internal.ID, ViewInput{ReverseSuggestions: model.Ptr(false)}))
|
||||||
|
list := func(opt ReverseOptions) []string {
|
||||||
|
var out []string
|
||||||
|
for _, s := range ReverseCandidates(env.state(), env.e.Exposures(env.state()), nil, opt) {
|
||||||
|
out = append(out, s.View+" "+s.Prefix+" "+s.Hidden)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
want(t, "unasked", list(ReverseOptions{}))
|
||||||
|
want(t, "internal, all", list(ReverseOptions{All: true, View: "internal"}),
|
||||||
|
"internal 192.0.2.10/32 suggestions off", "internal 192.0.2.25/32 suggestions off", "internal 2a02:8013:7f3d:10::5/128 suggestions off")
|
||||||
|
got := list(ReverseOptions{All: true, View: "external"})
|
||||||
|
want(t, "external, all", got, "external 192.0.2.10/32 public view", "external 192.0.2.25/32 public view", "external 2a02:8013:7f3d:10::5/128 public view")
|
||||||
|
|
||||||
|
env.submit(env.admin, NewRequest(OpViewUpdate, internal.ID, ViewInput{ReverseSuggestions: model.Ptr(true)}))
|
||||||
|
want(t, "dismissed", list(ReverseOptions{All: true, View: "internal"}),
|
||||||
|
"internal 192.0.2.10/32 dismissed", "internal 192.0.2.25/32 ", "internal 2a02:8013:7f3d:10::5/128 ")
|
||||||
|
}
|
||||||
|
|
||||||
|
// An address only another view has a record for: a reverse zone in the
|
||||||
|
// internal view is offered for it, and filled from that view's record.
|
||||||
|
func TestReverseFromOtherView(t *testing.T) {
|
||||||
|
env := linkedEnv(t)
|
||||||
|
env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("example.com"), View: model.Ptr("external"), LinkWith: "internal"}))
|
||||||
|
env.submit(env.admin, NewRequest(OpRRSetReplace, 0, RRSetInput{Zone: "example.com", View: "external", Name: "vps", Type: "AAAA", Data: []string{"2600:3c01::f03c:93ff:fe2b:1"}, Local: model.Ptr(true)}))
|
||||||
|
var got []string
|
||||||
|
for _, s := range ReverseCandidates(env.state(), env.e.Exposures(env.state()), nil, ReverseOptions{All: true, View: "internal"}) {
|
||||||
|
got = append(got, s.Prefix+" "+s.Hidden)
|
||||||
|
}
|
||||||
|
if !slices.Contains(got, "2600:3c01::f03c:93ff:fe2b:1/128 records in external") {
|
||||||
|
t.Errorf("internal candidates %q", got)
|
||||||
|
}
|
||||||
|
// Not suggested unasked: the internal view's own records don't use it.
|
||||||
|
for _, s := range ReverseSuggestions(env.state(), env.e.Exposures(env.state()), nil) {
|
||||||
|
if strings.HasPrefix(s.Prefix, "2600:") {
|
||||||
|
t.Errorf("suggested unasked: %+v", s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
res := env.submit(env.admin, NewRequest(OpZoneCreate, 0, ZoneInput{Name: model.Ptr("2600:3c01::f03c:93ff:fe2b:1/128"), View: model.Ptr("internal"), Fill: true}))
|
||||||
|
st := env.state()
|
||||||
|
var zone string
|
||||||
|
for _, z := range st.ZonesInView(st.ViewByName("internal").ID) {
|
||||||
|
if strings.HasSuffix(z.Name, ".ip6.arpa.") {
|
||||||
|
zone = z.Name
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if p := env.ptrs("internal", zone); len(p) != 1 || !strings.HasSuffix(p[0], " vps.example.com.") {
|
||||||
|
t.Errorf("filled %q", p)
|
||||||
|
}
|
||||||
|
if !slices.ContainsFunc(res.Warnings, func(w string) bool { return strings.Contains(w, "only view external has a record for it") }) {
|
||||||
|
t.Errorf("warnings %q", res.Warnings)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -66,3 +66,9 @@ func (e *Engine) ViewKey(ctx context.Context, st *model.State, z *model.Zone) *n
|
|||||||
}
|
}
|
||||||
return &nscheck.Key{Name: render.ViewKeyName(v.Name), Algorithm: render.ViewKeyAlgorithm, Secret: render.ViewKeySecret(x.ViewKeySeed, v.ID)}
|
return &nscheck.Key{Name: render.ViewKeyName(v.Name), Algorithm: render.ViewKeyAlgorithm, Secret: render.ViewKeySecret(x.ViewKeySeed, v.ID)}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GeneratedStatements lists what Jarl adds to named.conf by itself
|
||||||
|
// (render.GeneratedStatements).
|
||||||
|
func (e *Engine) GeneratedStatements(ctx context.Context, st *model.State) []render.Generated {
|
||||||
|
return render.GeneratedStatements(st, e.cfg.Paths, e.extras(ctx))
|
||||||
|
}
|
||||||
@@ -0,0 +1,339 @@
|
|||||||
|
// Package mailcheck checks the reverse DNS of the addresses that send and
|
||||||
|
// receive mail for your public zones (docs/exposure.md#mail): receivers
|
||||||
|
// such as Gmail and Outlook reject or mark mail from an address without a
|
||||||
|
// PTR record, or whose PTR name doesn't resolve back to it. Those records
|
||||||
|
// belong to whoever owns the address (your hosting provider or ISP), not
|
||||||
|
// to Jarl, so the check asks the internet and says who to ask.
|
||||||
|
package mailcheck
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"net/netip"
|
||||||
|
"slices"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/miekg/dns"
|
||||||
|
"golang.org/x/net/publicsuffix"
|
||||||
|
|
||||||
|
"jarl/internal/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Target is an address mail comes from or goes to, and why it is checked.
|
||||||
|
type Target struct {
|
||||||
|
Zone string `json:"zone"`
|
||||||
|
Address string `json:"address"`
|
||||||
|
Roles []string `json:"roles"` // e.g. "MX mail.adbraun.lol", "SPF ip4"
|
||||||
|
Host string `json:"host,omitempty"` // the MX host name, when it is one
|
||||||
|
}
|
||||||
|
|
||||||
|
// Result is the check of one address.
|
||||||
|
type Result struct {
|
||||||
|
Target
|
||||||
|
PTR []string `json:"ptr"` // the names its PTR records give
|
||||||
|
// OK: a PTR name resolves back to the address (forward-confirmed).
|
||||||
|
OK bool `json:"ok"`
|
||||||
|
// Level is ok, info or warning; Message says what to do.
|
||||||
|
Level string `json:"level"`
|
||||||
|
Message string `json:"message"`
|
||||||
|
// ReverseZone and ManagedBy say where the PTR record lives.
|
||||||
|
ReverseZone string `json:"reverse_zone,omitempty"`
|
||||||
|
ManagedBy string `json:"managed_by,omitempty"`
|
||||||
|
// LocalZone is a reverse zone for the address in Jarl ("view/zone"),
|
||||||
|
// which the internet doesn't ask unless the address's owner delegated
|
||||||
|
// it to this server.
|
||||||
|
LocalZone string `json:"local_zone,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Report is a whole check.
|
||||||
|
type Report struct {
|
||||||
|
Checked time.Time `json:"checked"`
|
||||||
|
Results []Result `json:"results"`
|
||||||
|
// Errors are lookups that failed (no internet, say).
|
||||||
|
Errors []string `json:"errors,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Targets finds the addresses to check in the public zones: the MX hosts
|
||||||
|
// (receiving) and the SPF record's addresses (sending). Names are looked
|
||||||
|
// up later, through the resolver.
|
||||||
|
func Targets(st *model.State, public func(viewID int64) bool) (addrs []Target, names []Target) {
|
||||||
|
for _, z := range st.SortedZones() {
|
||||||
|
if z.Type != model.ZonePrimary || z.Disabled || !public(z.ViewID) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
zone := strings.TrimSuffix(z.Name, ".")
|
||||||
|
for _, r := range st.ZoneRecords(z.ID) {
|
||||||
|
if r.Name != z.Name || r.Disabled {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
switch r.Type {
|
||||||
|
case "MX":
|
||||||
|
f := strings.Fields(r.Data)
|
||||||
|
if len(f) == 2 && f[1] != "." {
|
||||||
|
names = append(names, Target{Zone: zone, Host: strings.TrimSuffix(strings.ToLower(f[1]), "."), Roles: []string{"MX " + strings.TrimSuffix(f[1], ".")}})
|
||||||
|
}
|
||||||
|
case "TXT":
|
||||||
|
text := strings.ReplaceAll(strings.ReplaceAll(r.Data, `" "`, ""), `"`, "")
|
||||||
|
if !strings.HasPrefix(strings.ToLower(text), "v=spf1") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, mech := range strings.Fields(text)[1:] {
|
||||||
|
m := strings.ToLower(strings.TrimLeft(mech, "+?~"))
|
||||||
|
switch {
|
||||||
|
case strings.HasPrefix(m, "ip4:"), strings.HasPrefix(m, "ip6:"):
|
||||||
|
v := m[4:]
|
||||||
|
p, err := netip.ParsePrefix(v)
|
||||||
|
if err != nil {
|
||||||
|
if a, err := netip.ParseAddr(v); err == nil {
|
||||||
|
p = netip.PrefixFrom(a, a.BitLen())
|
||||||
|
} else {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if p.IsSingleIP() {
|
||||||
|
addrs = append(addrs, Target{Zone: zone, Address: p.Addr().String(), Roles: []string{"SPF " + m[:3]}})
|
||||||
|
}
|
||||||
|
case m == "a":
|
||||||
|
names = append(names, Target{Zone: zone, Host: zone, Roles: []string{"SPF a"}})
|
||||||
|
case strings.HasPrefix(m, "a:"):
|
||||||
|
names = append(names, Target{Zone: zone, Host: strings.TrimSuffix(m[2:], "."), Roles: []string{"SPF " + m}})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return addrs, names
|
||||||
|
}
|
||||||
|
|
||||||
|
// Resolver asks recursive resolvers (the public ones of acme.resolvers).
|
||||||
|
type Resolver struct {
|
||||||
|
Servers []string
|
||||||
|
Timeout time.Duration
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r Resolver) query(ctx context.Context, name string, qtype uint16) (*dns.Msg, error) {
|
||||||
|
if len(r.Servers) == 0 {
|
||||||
|
return nil, errors.New("no resolvers configured (acme.resolvers)")
|
||||||
|
}
|
||||||
|
m := new(dns.Msg)
|
||||||
|
m.SetQuestion(dns.Fqdn(name), qtype)
|
||||||
|
m.RecursionDesired = true
|
||||||
|
m.SetEdns0(1232, false)
|
||||||
|
t := r.Timeout
|
||||||
|
if t == 0 {
|
||||||
|
t = 5 * time.Second
|
||||||
|
}
|
||||||
|
var last error
|
||||||
|
for _, s := range r.Servers {
|
||||||
|
in, _, err := (&dns.Client{Timeout: t}).ExchangeContext(ctx, m, s)
|
||||||
|
if err == nil && in.Truncated {
|
||||||
|
in, _, err = (&dns.Client{Timeout: t, Net: "tcp"}).ExchangeContext(ctx, m, s)
|
||||||
|
}
|
||||||
|
if err == nil && in.Rcode != dns.RcodeServerFailure && in.Rcode != dns.RcodeRefused {
|
||||||
|
return in, nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
last = fmt.Errorf("%s: %w", s, err)
|
||||||
|
} else {
|
||||||
|
last = fmt.Errorf("%s answered %s", s, dns.RcodeToString[in.Rcode])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("looking up %s %s: %w", strings.TrimSuffix(name, "."), dns.TypeToString[qtype], last)
|
||||||
|
}
|
||||||
|
|
||||||
|
// addresses returns a name's A and AAAA addresses (after CNAMEs).
|
||||||
|
func (r Resolver) addresses(ctx context.Context, name string) ([]netip.Addr, bool, error) {
|
||||||
|
var out []netip.Addr
|
||||||
|
alias := false
|
||||||
|
for _, t := range []uint16{dns.TypeA, dns.TypeAAAA} {
|
||||||
|
in, err := r.query(ctx, name, t)
|
||||||
|
if err != nil {
|
||||||
|
return nil, false, err
|
||||||
|
}
|
||||||
|
for _, rr := range in.Answer {
|
||||||
|
switch v := rr.(type) {
|
||||||
|
case *dns.A:
|
||||||
|
a, _ := netip.AddrFromSlice(v.A.To4())
|
||||||
|
out = append(out, a)
|
||||||
|
case *dns.AAAA:
|
||||||
|
a, _ := netip.AddrFromSlice(v.AAAA)
|
||||||
|
out = append(out, a)
|
||||||
|
case *dns.CNAME:
|
||||||
|
alias = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out, alias, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check looks up every target's reverse DNS.
|
||||||
|
func Check(ctx context.Context, st *model.State, public func(int64) bool, res Resolver) *Report {
|
||||||
|
rep := &Report{Checked: time.Now(), Results: []Result{}}
|
||||||
|
addrs, names := Targets(st, public)
|
||||||
|
// Names to addresses, as the internet sees them.
|
||||||
|
for _, n := range names {
|
||||||
|
as, _, err := res.addresses(ctx, n.Host)
|
||||||
|
if err != nil {
|
||||||
|
rep.Errors = append(rep.Errors, err.Error())
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if len(as) == 0 {
|
||||||
|
rep.Errors = append(rep.Errors, fmt.Sprintf("%s (%s, %s) has no address as the internet sees it: not published yet, or a typo?", n.Host, n.Zone, strings.Join(n.Roles, ", ")))
|
||||||
|
}
|
||||||
|
for _, a := range as {
|
||||||
|
t := n
|
||||||
|
t.Address = a.String()
|
||||||
|
addrs = append(addrs, t)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// One result per address, with every reason it is checked.
|
||||||
|
merged := map[string]*Target{}
|
||||||
|
var order []string
|
||||||
|
for _, t := range addrs {
|
||||||
|
k := t.Zone + "|" + t.Address
|
||||||
|
if m := merged[k]; m != nil {
|
||||||
|
for _, role := range t.Roles {
|
||||||
|
if !slices.Contains(m.Roles, role) {
|
||||||
|
m.Roles = append(m.Roles, role)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if m.Host == "" {
|
||||||
|
m.Host = t.Host
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
t := t
|
||||||
|
merged[k] = &t
|
||||||
|
order = append(order, k)
|
||||||
|
}
|
||||||
|
for _, k := range order {
|
||||||
|
r := checkOne(ctx, *merged[k], res)
|
||||||
|
r.LocalZone = localReverse(st, r.Address, r.ReverseZone)
|
||||||
|
rep.Results = append(rep.Results, r)
|
||||||
|
}
|
||||||
|
return rep
|
||||||
|
}
|
||||||
|
|
||||||
|
// localReverse returns a reverse zone in Jarl that covers the address,
|
||||||
|
// unless it is the zone the internet asks (delegated to this server).
|
||||||
|
func localReverse(st *model.State, addr, internetZone string) string {
|
||||||
|
rev, err := dns.ReverseAddr(addr)
|
||||||
|
if err != nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
rev = strings.ToLower(rev)
|
||||||
|
best := ""
|
||||||
|
var bz *model.Zone
|
||||||
|
for _, z := range st.SortedZones() {
|
||||||
|
n := strings.ToLower(dns.Fqdn(z.Name))
|
||||||
|
if z.Type == model.ZonePrimary && dns.IsSubDomain(n, rev) && len(n) > len(best) {
|
||||||
|
best, bz = n, z
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if bz == nil || strings.EqualFold(strings.TrimSuffix(best, "."), internetZone) {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
if v := st.ViewName(bz); v != "" {
|
||||||
|
return v + "/" + strings.TrimSuffix(bz.Name, ".")
|
||||||
|
}
|
||||||
|
return strings.TrimSuffix(bz.Name, ".")
|
||||||
|
}
|
||||||
|
|
||||||
|
func checkOne(ctx context.Context, t Target, res Resolver) Result {
|
||||||
|
r := Result{Target: t, PTR: []string{}}
|
||||||
|
a, err := netip.ParseAddr(t.Address)
|
||||||
|
if err != nil {
|
||||||
|
r.Level, r.Message = "warning", err.Error()
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
rev, _ := dns.ReverseAddr(a.String())
|
||||||
|
in, err := res.query(ctx, rev, dns.TypePTR)
|
||||||
|
if err != nil {
|
||||||
|
r.Level, r.Message = "warning", err.Error()
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
// Who manages the reverse zone: the SOA in the answer.
|
||||||
|
for _, sec := range [][]dns.RR{in.Ns, in.Answer} {
|
||||||
|
for _, rr := range sec {
|
||||||
|
if soa, ok := rr.(*dns.SOA); ok {
|
||||||
|
r.ReverseZone, r.ManagedBy = strings.TrimSuffix(soa.Hdr.Name, "."), managedBy(soa.Ns)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if r.ReverseZone == "" {
|
||||||
|
if s, err := res.query(ctx, rev, dns.TypeSOA); err == nil {
|
||||||
|
for _, sec := range [][]dns.RR{s.Answer, s.Ns} {
|
||||||
|
for _, rr := range sec {
|
||||||
|
if soa, ok := rr.(*dns.SOA); ok {
|
||||||
|
r.ReverseZone, r.ManagedBy = strings.TrimSuffix(soa.Hdr.Name, "."), managedBy(soa.Ns)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, rr := range in.Answer {
|
||||||
|
if p, ok := rr.(*dns.PTR); ok {
|
||||||
|
r.PTR = append(r.PTR, strings.TrimSuffix(strings.ToLower(p.Ptr), "."))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
where := "whoever runs the address's reverse zone (your hosting provider or ISP)"
|
||||||
|
if r.ManagedBy != "" {
|
||||||
|
where = "the reverse zone's owner (" + r.ManagedBy + ": your hosting provider's or ISP's panel)"
|
||||||
|
}
|
||||||
|
if len(r.PTR) == 0 {
|
||||||
|
r.Level = "warning"
|
||||||
|
r.Message = fmt.Sprintf("%s has no PTR record: many receivers reject or mark mail from it. Set its reverse DNS to %s at %s", t.Address, suggestName(t), where)
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
var notes []string
|
||||||
|
for _, name := range r.PTR {
|
||||||
|
as, alias, err := res.addresses(ctx, name)
|
||||||
|
if err != nil {
|
||||||
|
notes = append(notes, err.Error())
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if slices.Contains(as, a) {
|
||||||
|
r.OK = true
|
||||||
|
if alias {
|
||||||
|
notes = append(notes, name+" is an alias (CNAME): receivers expect the PTR to name a host with its own A/AAAA record")
|
||||||
|
}
|
||||||
|
if t.Host != "" && name != t.Host && strings.HasPrefix(strings.Join(t.Roles, " "), "MX") {
|
||||||
|
notes = append(notes, fmt.Sprintf("the PTR name is %s, not the MX name %s: fine if the mail server says %s in HELO", name, t.Host, name))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case !r.OK:
|
||||||
|
r.Level = "warning"
|
||||||
|
r.Message = fmt.Sprintf("the PTR record of %s names %s, which doesn't resolve back to %s: receivers check that it does. Point the PTR at a name with an A/AAAA record for %s (set at %s), or add that record", t.Address, strings.Join(r.PTR, ", "), t.Address, t.Address, where)
|
||||||
|
case len(notes) > 0:
|
||||||
|
r.Level, r.Message = "info", strings.Join(notes, "; ")
|
||||||
|
default:
|
||||||
|
r.Level, r.Message = "ok", fmt.Sprintf("%s → %s → %s", t.Address, strings.Join(r.PTR, ", "), t.Address)
|
||||||
|
}
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
func suggestName(t Target) string {
|
||||||
|
if t.Host != "" {
|
||||||
|
return t.Host
|
||||||
|
}
|
||||||
|
return "the host's name (with an A/AAAA record for it)"
|
||||||
|
}
|
||||||
|
|
||||||
|
// managedBy turns the reverse zone's primary name server into its owner's
|
||||||
|
// domain: ns1.linode.com -> linode.com, dns0.zen.co.uk -> zen.co.uk.
|
||||||
|
func managedBy(ns string) string {
|
||||||
|
ns = strings.TrimSuffix(strings.ToLower(ns), ".")
|
||||||
|
labels := strings.Split(ns, ".")
|
||||||
|
// The registered domain under the ICANN suffix: the list's private
|
||||||
|
// part (members.linode.com) names customers, not the provider.
|
||||||
|
for i := 1; i < len(labels); i++ {
|
||||||
|
if suffix, icann := publicsuffix.PublicSuffix(strings.Join(labels[i:], ".")); icann && suffix == strings.Join(labels[i:], ".") {
|
||||||
|
return strings.Join(labels[i-1:], ".")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ns
|
||||||
|
}
|
||||||
@@ -0,0 +1,108 @@
|
|||||||
|
package mailcheck
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/miekg/dns"
|
||||||
|
|
||||||
|
"jarl/internal/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fakeResolver answers from a fixed set of records, as a recursive
|
||||||
|
// resolver would, with the reverse zone's SOA in negative answers.
|
||||||
|
func fakeResolver(t *testing.T, records ...string) string {
|
||||||
|
t.Helper()
|
||||||
|
var rrs []dns.RR
|
||||||
|
for _, s := range records {
|
||||||
|
rr, err := dns.NewRR(s)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
rrs = append(rrs, rr)
|
||||||
|
}
|
||||||
|
soa, _ := dns.NewRR("2.0.192.in-addr.arpa. 3600 IN SOA ns1.linode.com. hostmaster.linode.com. 1 3600 900 1209600 300")
|
||||||
|
pc, err := net.ListenPacket("udp", "127.0.0.1:0")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
srv := &dns.Server{PacketConn: pc, Handler: dns.HandlerFunc(func(w dns.ResponseWriter, q *dns.Msg) {
|
||||||
|
m := new(dns.Msg)
|
||||||
|
m.SetReply(q)
|
||||||
|
qn := strings.ToLower(q.Question[0].Name)
|
||||||
|
for _, rr := range rrs {
|
||||||
|
if strings.ToLower(rr.Header().Name) == qn && (rr.Header().Rrtype == q.Question[0].Qtype || rr.Header().Rrtype == dns.TypeCNAME) {
|
||||||
|
m.Answer = append(m.Answer, rr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(m.Answer) == 0 && dns.IsSubDomain(soa.Header().Name, qn) {
|
||||||
|
if q.Question[0].Qtype == dns.TypeSOA && qn == soa.Header().Name {
|
||||||
|
m.Answer = append(m.Answer, soa)
|
||||||
|
} else {
|
||||||
|
m.Ns = append(m.Ns, soa)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
w.WriteMsg(m)
|
||||||
|
})}
|
||||||
|
go srv.ActivateAndServe()
|
||||||
|
t.Cleanup(func() { srv.Shutdown() })
|
||||||
|
return pc.LocalAddr().String()
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheck(t *testing.T) {
|
||||||
|
st := model.NewState()
|
||||||
|
ext := &model.View{ID: 1, Name: "external", MatchClients: []string{"any"}}
|
||||||
|
in := &model.View{ID: 2, Name: "internal", MatchClients: []string{"lan"}}
|
||||||
|
st.Views[1], st.Views[2] = ext, in
|
||||||
|
z := &model.Zone{ID: 10, Name: "example.com.", ViewID: 1, Type: model.ZonePrimary}
|
||||||
|
zi := &model.Zone{ID: 11, Name: "example.com.", ViewID: 2, Type: model.ZonePrimary}
|
||||||
|
rev := &model.Zone{ID: 12, Name: "27.2.0.192.in-addr.arpa.", ViewID: 2, Type: model.ZonePrimary}
|
||||||
|
st.Zones[10], st.Zones[11], st.Zones[12] = z, zi, rev
|
||||||
|
rec := func(id, zone int64, name, typ, data string) {
|
||||||
|
st.Records[id] = &model.Record{ID: id, ZoneID: zone, Name: name, Type: typ, Data: data}
|
||||||
|
}
|
||||||
|
rec(1, 10, "example.com.", "MX", "10 mail.example.com.")
|
||||||
|
rec(2, 10, "example.com.", "TXT", `"v=spf1 mx ip4:192.0.2.26 ip4:192.0.2.27" " ip4:198.51.100.0/24 -all"`)
|
||||||
|
rec(3, 10, "www.example.com.", "MX", "10 ignored.example.com.") // not the apex
|
||||||
|
rec(4, 11, "example.com.", "MX", "10 internal.example.com.") // private view
|
||||||
|
rec(5, 10, "example.com.", "TXT", `"google-site-verification=x"`)
|
||||||
|
rec(6, 10, "example.com.", "MX", "20 backup.example.com.") // not on the internet
|
||||||
|
|
||||||
|
res := Resolver{Servers: []string{fakeResolver(t,
|
||||||
|
"mail.example.com. 300 IN A 192.0.2.25",
|
||||||
|
"25.2.0.192.in-addr.arpa. 300 IN PTR mail.example.com.",
|
||||||
|
"27.2.0.192.in-addr.arpa. 300 IN PTR li-27.members.linode.com.",
|
||||||
|
"li-27.members.linode.com. 300 IN A 192.0.2.99",
|
||||||
|
)}}
|
||||||
|
public := func(id int64) bool { return id == 1 }
|
||||||
|
rep := Check(context.Background(), st, public, res)
|
||||||
|
if len(rep.Errors) != 1 || !strings.Contains(rep.Errors[0], "backup.example.com (example.com, MX backup.example.com) has no address") {
|
||||||
|
t.Fatalf("errors %v", rep.Errors)
|
||||||
|
}
|
||||||
|
got := map[string]Result{}
|
||||||
|
for _, r := range rep.Results {
|
||||||
|
got[r.Address] = r
|
||||||
|
}
|
||||||
|
if len(got) != 3 {
|
||||||
|
t.Fatalf("results %+v", rep.Results)
|
||||||
|
}
|
||||||
|
if r := got["192.0.2.25"]; !r.OK || r.Level != "ok" || r.Roles[0] != "MX mail.example.com" || r.ManagedBy != "" && r.ManagedBy != "linode.com" {
|
||||||
|
t.Errorf("mail: %+v", r)
|
||||||
|
}
|
||||||
|
if r := got["192.0.2.26"]; r.OK || r.Level != "warning" || !strings.Contains(r.Message, "no PTR record") || r.ManagedBy != "linode.com" || r.ReverseZone != "2.0.192.in-addr.arpa" {
|
||||||
|
t.Errorf("no PTR: %+v", r)
|
||||||
|
}
|
||||||
|
if r := got["192.0.2.27"]; r.OK || !strings.Contains(r.Message, "doesn't resolve back") || r.LocalZone != "internal/27.2.0.192.in-addr.arpa" {
|
||||||
|
t.Errorf("not forward-confirmed: %+v", r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestManagedBy(t *testing.T) {
|
||||||
|
for in, want := range map[string]string{"ns1.linode.com.": "linode.com", "dns0.zen.co.uk.": "zen.co.uk", "ns1.members.linode.com.": "linode.com", "localhost.": "localhost"} {
|
||||||
|
if got := managedBy(in); got != want {
|
||||||
|
t.Errorf("managedBy(%q) = %q, want %q", in, got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
package model
|
||||||
|
|
||||||
|
import (
|
||||||
|
"slices"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Certificate sources.
|
||||||
|
const (
|
||||||
|
CertSourceACME = "acme" // Jarl obtains and renews it (docs/certificates.md)
|
||||||
|
CertSourceFile = "file" // you renew it; Jarl reads it from cert_file and key_file
|
||||||
|
)
|
||||||
|
|
||||||
|
// Certificate uses.
|
||||||
|
const (
|
||||||
|
CertUseWeb = "web" // jarld's own HTTPS
|
||||||
|
CertUseDNS = "dns" // written where named can read it, for DNS over TLS/HTTPS
|
||||||
|
)
|
||||||
|
|
||||||
|
// Challenge routes: where Jarl publishes the DNS-01 challenge.
|
||||||
|
const (
|
||||||
|
ChallengeAuto = "auto" // decided at every issue from the domain's public name servers
|
||||||
|
ChallengeJarl = "jarl" // in a zone Jarl serves (following a CNAME on _acme-challenge)
|
||||||
|
ChallengePorkbun = "porkbun" // through Porkbun's DNS API
|
||||||
|
)
|
||||||
|
|
||||||
|
// Certificate is a TLS certificate Jarl manages. Certificates are not
|
||||||
|
// named configuration: they are kept outside changesets, like users.
|
||||||
|
type Certificate struct {
|
||||||
|
ID int64 `json:"id"`
|
||||||
|
Name string `json:"name"`
|
||||||
|
Source string `json:"source"`
|
||||||
|
Domains []string `json:"domains"` // acme: the names to ask for; file: the names in the certificate
|
||||||
|
CertFile string `json:"cert_file,omitempty"` // file source
|
||||||
|
KeyFile string `json:"key_file,omitempty"` // file source
|
||||||
|
Uses []string `json:"uses"`
|
||||||
|
Challenge string `json:"challenge,omitempty"` // acme source
|
||||||
|
KeyType string `json:"key_type,omitempty"` // acme source: ec256, ec384, rsa2048, rsa3072, rsa4096
|
||||||
|
Comment string `json:"comment"`
|
||||||
|
|
||||||
|
// The current certificate: acme source only (a file source's is read
|
||||||
|
// from its files). The key never leaves the server through the API.
|
||||||
|
CertPEM string `json:"-"`
|
||||||
|
KeyPEM string `json:"-"`
|
||||||
|
|
||||||
|
// What the current certificate says (both sources).
|
||||||
|
Names []string `json:"names,omitempty"` // the names in it
|
||||||
|
NotBefore *time.Time `json:"not_before,omitempty"`
|
||||||
|
NotAfter *time.Time `json:"not_after,omitempty"`
|
||||||
|
Issuer string `json:"issuer,omitempty"`
|
||||||
|
Serial string `json:"serial,omitempty"`
|
||||||
|
|
||||||
|
// Renewal (acme source). RenewAt is the CA's suggested time (ARI) or,
|
||||||
|
// without one, two thirds into the certificate's lifetime.
|
||||||
|
RenewAt *time.Time `json:"renew_at,omitempty"`
|
||||||
|
ARICheckedAt *time.Time `json:"-"`
|
||||||
|
LastAttempt *time.Time `json:"last_attempt,omitempty"`
|
||||||
|
LastSuccess *time.Time `json:"last_success,omitempty"`
|
||||||
|
LastError string `json:"last_error,omitempty"`
|
||||||
|
Failures int `json:"failures,omitempty"`
|
||||||
|
// LastRoutes says where the challenges went the last time ("adbraun.lol: porkbun").
|
||||||
|
LastRoutes []string `json:"last_routes,omitempty"`
|
||||||
|
|
||||||
|
CreatedAt time.Time `json:"created_at"`
|
||||||
|
UpdatedAt time.Time `json:"updated_at"`
|
||||||
|
CreatedBy string `json:"created_by"`
|
||||||
|
UpdatedBy string `json:"updated_by"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// HasUse reports whether c is used for use.
|
||||||
|
func (c *Certificate) HasUse(use string) bool { return slices.Contains(c.Uses, use) }
|
||||||
@@ -0,0 +1,101 @@
|
|||||||
|
package model
|
||||||
|
|
||||||
|
import (
|
||||||
|
"slices"
|
||||||
|
"sort"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Linked zones (docs/views.md#linked-zones): zones of the same name in
|
||||||
|
// different views whose shared records Jarl keeps in step. Each zone
|
||||||
|
// keeps its own copy of every shared record (with the same SharedID), so
|
||||||
|
// named, validation and rendering see ordinary zones. A record with
|
||||||
|
// SharedID 0 in a linked zone is local to its view: an override of the
|
||||||
|
// shared records of the same name and type there.
|
||||||
|
|
||||||
|
// LinkMembers returns the zones of a link group in view order.
|
||||||
|
func (s *State) LinkMembers(group int64) []*Zone {
|
||||||
|
if group == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
var out []*Zone
|
||||||
|
for _, z := range s.Zones {
|
||||||
|
if z.LinkGroup == group {
|
||||||
|
out = append(out, z)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
s.SortByView(out)
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// LinkedWith returns the other zones z is linked with, in view order.
|
||||||
|
func (s *State) LinkedWith(z *Zone) []*Zone {
|
||||||
|
var out []*Zone
|
||||||
|
for _, o := range s.LinkMembers(z.LinkGroup) {
|
||||||
|
if o.ID != z.ID {
|
||||||
|
out = append(out, o)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// AnyLinked reports whether any zone is linked.
|
||||||
|
func (s *State) AnyLinked() bool {
|
||||||
|
for _, z := range s.Zones {
|
||||||
|
if z.LinkGroup != 0 {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// SortByView sorts zones in view order.
|
||||||
|
func (s *State) SortByView(zs []*Zone) {
|
||||||
|
pos := func(z *Zone) int {
|
||||||
|
if v := s.Views[z.ViewID]; v != nil {
|
||||||
|
return v.Position
|
||||||
|
}
|
||||||
|
return -1
|
||||||
|
}
|
||||||
|
sort.Slice(zs, func(i, j int) bool {
|
||||||
|
if a, b := pos(zs[i]), pos(zs[j]); a != b {
|
||||||
|
return a < b
|
||||||
|
}
|
||||||
|
return zs[i].ID < zs[j].ID
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// RRset returns the records of one name and type in a zone, by ID.
|
||||||
|
func (s *State) RRset(zoneID int64, name, typ string) []*Record {
|
||||||
|
var out []*Record
|
||||||
|
for _, r := range s.Records {
|
||||||
|
if r.ZoneID == zoneID && r.Name == name && r.Type == typ {
|
||||||
|
out = append(out, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
slices.SortFunc(out, func(a, b *Record) int { return int(a.ID - b.ID) })
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// HasLocal reports whether a linked zone overrides the shared records of
|
||||||
|
// one name and type with records of its own.
|
||||||
|
func (s *State) HasLocal(zoneID int64, name, typ string) bool {
|
||||||
|
for _, r := range s.Records {
|
||||||
|
if r.ZoneID == zoneID && r.Name == name && r.Type == typ && r.SharedID == 0 {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// SharedRecords returns a zone's shared records of one name and type,
|
||||||
|
// by SharedID.
|
||||||
|
func (s *State) SharedRecords(zoneID int64, name, typ string) []*Record {
|
||||||
|
var out []*Record
|
||||||
|
for _, r := range s.Records {
|
||||||
|
if r.ZoneID == zoneID && r.Name == name && r.Type == typ && r.SharedID != 0 {
|
||||||
|
out = append(out, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
slices.SortFunc(out, func(a, b *Record) int { return int(a.SharedID - b.SharedID) })
|
||||||
|
return out
|
||||||
|
}
|
||||||
+64
-1
@@ -50,9 +50,48 @@ type View struct {
|
|||||||
MatchDestinations []string `json:"match_destinations"`
|
MatchDestinations []string `json:"match_destinations"`
|
||||||
MatchRecursiveOnly *bool `json:"match_recursive_only,omitempty"`
|
MatchRecursiveOnly *bool `json:"match_recursive_only,omitempty"`
|
||||||
Comment string `json:"comment"`
|
Comment string `json:"comment"`
|
||||||
|
// Exposure overrides whether the view counts as reachable from the
|
||||||
|
// internet (docs/exposure.md): "" works it out, ExposurePublic or
|
||||||
|
// ExposurePrivate say so.
|
||||||
|
Exposure string `json:"exposure,omitempty"`
|
||||||
|
// ReverseSuggestionsOff stops suggesting reverse zones for the view's
|
||||||
|
// addresses (docs/reverse.md), e.g. for a view only a few servers use;
|
||||||
|
// DismissedReverse are the networks whose suggestion was dismissed.
|
||||||
|
ReverseSuggestionsOff bool `json:"reverse_suggestions_off,omitempty"`
|
||||||
|
DismissedReverse []string `json:"dismissed_reverse,omitempty"`
|
||||||
|
// Acknowledged are exposure findings accepted on purpose; they are
|
||||||
|
// shown as info instead of warnings.
|
||||||
|
Acknowledged []Acknowledgement `json:"acknowledged,omitempty"`
|
||||||
Meta
|
Meta
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Exposure overrides.
|
||||||
|
const (
|
||||||
|
ExposureAuto = ""
|
||||||
|
ExposurePublic = "public"
|
||||||
|
ExposurePrivate = "private"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Acknowledgement accepts one exposure finding (by its code) for a view,
|
||||||
|
// or for the server: the finding stays, as info, with who accepted it,
|
||||||
|
// when and why.
|
||||||
|
type Acknowledgement struct {
|
||||||
|
Code string `json:"code"`
|
||||||
|
Reason string `json:"reason"`
|
||||||
|
By string `json:"by"`
|
||||||
|
At time.Time `json:"at"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// FindAck returns the acknowledgement of code in acks, if any.
|
||||||
|
func FindAck(acks []Acknowledgement, code string) *Acknowledgement {
|
||||||
|
for i := range acks {
|
||||||
|
if acks[i].Code == code {
|
||||||
|
return &acks[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// ACL is a named address match list.
|
// ACL is a named address match list.
|
||||||
type ACL struct {
|
type ACL struct {
|
||||||
ID int64 `json:"id"`
|
ID int64 `json:"id"`
|
||||||
@@ -132,6 +171,14 @@ type Zone struct {
|
|||||||
// Disabled zones stay in Jarl, records and all, but named doesn't
|
// Disabled zones stay in Jarl, records and all, but named doesn't
|
||||||
// load them: their zone statement is left out of named.conf.
|
// load them: their zone statement is left out of named.conf.
|
||||||
Disabled bool `json:"disabled,omitempty"`
|
Disabled bool `json:"disabled,omitempty"`
|
||||||
|
// LinkGroup links zones of the same name in different views: Jarl
|
||||||
|
// keeps their shared records in step (docs/views.md#linked-zones). 0
|
||||||
|
// for a zone that isn't linked; linked zones share the ID.
|
||||||
|
LinkGroup int64 `json:"link_group,omitempty"`
|
||||||
|
// AutoPTR keeps the PTR records of the zone's A and AAAA records in
|
||||||
|
// step with them, in the reverse zones of the zone's views, as if every
|
||||||
|
// change asked for it (docs/reverse.md).
|
||||||
|
AutoPTR bool `json:"auto_ptr,omitempty"`
|
||||||
Meta
|
Meta
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -161,6 +208,10 @@ type Record struct {
|
|||||||
// Disabled records stay in Jarl but are left out of the zone (the
|
// Disabled records stay in Jarl but are left out of the zone (the
|
||||||
// zone file lists them as comments).
|
// zone file lists them as comments).
|
||||||
Disabled bool `json:"disabled,omitempty"`
|
Disabled bool `json:"disabled,omitempty"`
|
||||||
|
// SharedID ties the copies of a shared record in linked zones
|
||||||
|
// together (the same in every copy). 0 for a record of a zone that
|
||||||
|
// isn't linked, and for a record local to its view in one that is.
|
||||||
|
SharedID int64 `json:"shared_id,omitempty"`
|
||||||
Meta
|
Meta
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -217,7 +268,17 @@ type Settings struct {
|
|||||||
BlockingPausedUntil *time.Time `json:"blocking_paused_until,omitempty"`
|
BlockingPausedUntil *time.Time `json:"blocking_paused_until,omitempty"`
|
||||||
// BlockingPausedIndefinitely pauses blocking until someone resumes it.
|
// BlockingPausedIndefinitely pauses blocking until someone resumes it.
|
||||||
BlockingPausedIndefinitely bool `json:"blocking_paused_indefinitely,omitempty"`
|
BlockingPausedIndefinitely bool `json:"blocking_paused_indefinitely,omitempty"`
|
||||||
Version int `json:"version"`
|
// Exposure and Acknowledged are the server's own (without views, and
|
||||||
|
// for server-wide findings such as a visible version): see View.
|
||||||
|
Exposure string `json:"exposure,omitempty"`
|
||||||
|
Acknowledged []Acknowledgement `json:"acknowledged,omitempty"`
|
||||||
|
// DismissedReverse are dismissed reverse zone suggestions (without
|
||||||
|
// views; see View).
|
||||||
|
DismissedReverse []string `json:"dismissed_reverse,omitempty"`
|
||||||
|
// EncryptedDNSHosts are the host names clients use for DNS over TLS
|
||||||
|
// and HTTPS (docs/encrypted-dns.md); the first is checked first.
|
||||||
|
EncryptedDNSHosts []string `json:"encrypted_dns_hosts,omitempty"`
|
||||||
|
Version int `json:"version"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// BlockingPaused reports whether blocking is paused, for a time or until
|
// BlockingPaused reports whether blocking is paused, for a time or until
|
||||||
@@ -289,10 +350,12 @@ func (s *State) Clone() *State {
|
|||||||
ClientGroups: make(map[int64]*ClientGroup, len(s.ClientGroups)),
|
ClientGroups: make(map[int64]*ClientGroup, len(s.ClientGroups)),
|
||||||
}
|
}
|
||||||
c.Settings.Nameservers = slices.Clone(s.Settings.Nameservers)
|
c.Settings.Nameservers = slices.Clone(s.Settings.Nameservers)
|
||||||
|
c.Settings.Acknowledged = slices.Clone(s.Settings.Acknowledged)
|
||||||
for id, v := range s.Views {
|
for id, v := range s.Views {
|
||||||
n := *v
|
n := *v
|
||||||
n.MatchClients = slices.Clone(v.MatchClients)
|
n.MatchClients = slices.Clone(v.MatchClients)
|
||||||
n.MatchDestinations = slices.Clone(v.MatchDestinations)
|
n.MatchDestinations = slices.Clone(v.MatchDestinations)
|
||||||
|
n.Acknowledged = slices.Clone(v.Acknowledged)
|
||||||
if v.MatchRecursiveOnly != nil {
|
if v.MatchRecursiveOnly != nil {
|
||||||
b := *v.MatchRecursiveOnly
|
b := *v.MatchRecursiveOnly
|
||||||
n.MatchRecursiveOnly = &b
|
n.MatchRecursiveOnly = &b
|
||||||
|
|||||||
@@ -182,3 +182,38 @@ func writeItemsInline(sb *strings.Builder, items []Item) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// FormatValueList is FormatValue, except that a value whose block is a
|
||||||
|
// plain list (no nested blocks) of at least min elements is laid out one
|
||||||
|
// element per line, for reading: allow-query, exempt-clients, forwarders.
|
||||||
|
func FormatValueList(name, value string, min int) string {
|
||||||
|
st, err := ParseOptionValue(name, value)
|
||||||
|
if err != nil {
|
||||||
|
return FormatValue(name, value)
|
||||||
|
}
|
||||||
|
items := st.Items[1:]
|
||||||
|
blocks := 0
|
||||||
|
var list *Block
|
||||||
|
for _, it := range items {
|
||||||
|
if it.Block != nil {
|
||||||
|
blocks++
|
||||||
|
list = it.Block
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if blocks != 1 || len(list.Stmts) < min || blockHasBlocks(list) {
|
||||||
|
return FormatValue(name, value)
|
||||||
|
}
|
||||||
|
var sb strings.Builder
|
||||||
|
for _, it := range items {
|
||||||
|
if it.Block == nil {
|
||||||
|
sb.WriteString(Compact([]Item{it}) + " ")
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
sb.WriteString("{\n")
|
||||||
|
for _, s := range list.Stmts {
|
||||||
|
sb.WriteString("\t" + Compact(s.Items) + ";\n")
|
||||||
|
}
|
||||||
|
sb.WriteString("} ")
|
||||||
|
}
|
||||||
|
return strings.TrimSpace(sb.String())
|
||||||
|
}
|
||||||
@@ -16,3 +16,23 @@ func TestFormatValue(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestFormatValueList(t *testing.T) {
|
||||||
|
cases := []struct{ name, value, want string }{
|
||||||
|
{"allow-query", "{ homelab; localhost; 10.0.0.0/8; }", "{\n\thomelab;\n\tlocalhost;\n\t10.0.0.0/8;\n}"},
|
||||||
|
{"allow-query", "{ homelab; localhost; }", "{ homelab; localhost; }"}, // short: as it was
|
||||||
|
{"listen-on", "port 853 tls dot { 10.0.0.1; 10.0.0.2; 10.0.0.3; }", "port 853 tls dot {\n\t10.0.0.1;\n\t10.0.0.2;\n\t10.0.0.3;\n}"},
|
||||||
|
{"allow-transfer", "{ !10.0.0.9; key xfer; 10.0.0.0/8; }", "{\n\t!10.0.0.9;\n\tkey xfer;\n\t10.0.0.0/8;\n}"},
|
||||||
|
{"recursion", "yes", "yes"},
|
||||||
|
}
|
||||||
|
for _, c := range cases {
|
||||||
|
if got := FormatValueList(c.name, c.value, 3); got != c.want {
|
||||||
|
t.Errorf("%s %q:\n got %q\nwant %q", c.name, c.value, got, c.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// A nested block (rate-limit with exempt-clients) keeps FormatValue's layout.
|
||||||
|
v := "{ responses-per-second 10; log-only yes; exempt-clients { 192.0.2.1; 192.0.2.2; 192.0.2.3; }; }"
|
||||||
|
if got := FormatValueList("rate-limit", v, 3); got != FormatValue("rate-limit", v) {
|
||||||
|
t.Errorf("nested: %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,6 +2,7 @@ package porkbun
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -15,7 +16,8 @@ type Fake struct {
|
|||||||
mu sync.Mutex
|
mu sync.Mutex
|
||||||
Domains map[string]*FakeDomain
|
Domains map[string]*FakeDomain
|
||||||
// Calls lists the paths called, in order.
|
// Calls lists the paths called, in order.
|
||||||
Calls []string
|
Calls []string
|
||||||
|
nextID int
|
||||||
}
|
}
|
||||||
|
|
||||||
// FakeDomain is a domain in a Fake.
|
// FakeDomain is a domain in a Fake.
|
||||||
@@ -24,6 +26,14 @@ type FakeDomain struct {
|
|||||||
Glue map[string][]string // host -> addresses
|
Glue map[string][]string // host -> addresses
|
||||||
DS map[uint16]DS
|
DS map[uint16]DS
|
||||||
APIAccess bool
|
APIAccess bool
|
||||||
|
// Records are the DNS records created through the API, by ID.
|
||||||
|
Records map[string]FakeRecord
|
||||||
|
}
|
||||||
|
|
||||||
|
// FakeRecord is a DNS record in a Fake.
|
||||||
|
type FakeRecord struct {
|
||||||
|
Name, Type, Content string // Name is the full name, without a trailing dot
|
||||||
|
TTL int
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewFake returns a Fake with the given domains (API access on, Porkbun's
|
// NewFake returns a Fake with the given domains (API access on, Porkbun's
|
||||||
@@ -31,7 +41,7 @@ type FakeDomain struct {
|
|||||||
func NewFake(key, secret string, domains ...string) *Fake {
|
func NewFake(key, secret string, domains ...string) *Fake {
|
||||||
f := &Fake{APIKey: key, Secret: secret, Domains: map[string]*FakeDomain{}}
|
f := &Fake{APIKey: key, Secret: secret, Domains: map[string]*FakeDomain{}}
|
||||||
for _, d := range domains {
|
for _, d := range domains {
|
||||||
f.Domains[d] = &FakeDomain{NS: []string{"curitiba.ns.porkbun.com", "fortaleza.ns.porkbun.com"}, Glue: map[string][]string{}, DS: map[uint16]DS{}, APIAccess: true}
|
f.Domains[d] = &FakeDomain{NS: []string{"curitiba.ns.porkbun.com", "fortaleza.ns.porkbun.com"}, Glue: map[string][]string{}, DS: map[uint16]DS{}, APIAccess: true, Records: map[string]FakeRecord{}}
|
||||||
}
|
}
|
||||||
return f
|
return f
|
||||||
}
|
}
|
||||||
@@ -158,7 +168,48 @@ func (f *Fake) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|||||||
tag, _ := strconv.Atoi(parts[3])
|
tag, _ := strconv.Atoi(parts[3])
|
||||||
delete(d.DS, uint16(tag))
|
delete(d.DS, uint16(tag))
|
||||||
reply(200, map[string]any{"status": "SUCCESS", "message": "Deleted."})
|
reply(200, map[string]any{"status": "SUCCESS", "message": "Deleted."})
|
||||||
|
case "dns/create":
|
||||||
|
name, _ := body["name"].(string)
|
||||||
|
full := domain
|
||||||
|
if name != "" {
|
||||||
|
full = name + "." + domain
|
||||||
|
}
|
||||||
|
ttl, _ := strconv.Atoi(fmt.Sprint(body["ttl"]))
|
||||||
|
if ttl < MinTTL {
|
||||||
|
ttl = MinTTL
|
||||||
|
}
|
||||||
|
f.nextID++
|
||||||
|
id := strconv.Itoa(f.nextID)
|
||||||
|
d.Records[id] = FakeRecord{Name: full, Type: fmt.Sprint(body["type"]), Content: fmt.Sprint(body["content"]), TTL: ttl}
|
||||||
|
reply(200, map[string]any{"status": "SUCCESS", "id": f.nextID})
|
||||||
|
case "dns/delete":
|
||||||
|
if len(parts) < 4 || d.Records == nil {
|
||||||
|
fail(400, "INVALID_RECORD_ID", "Invalid record ID.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if _, ok := d.Records[parts[3]]; !ok {
|
||||||
|
fail(400, "INVALID_RECORD_ID", "Invalid record ID.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
delete(d.Records, parts[3])
|
||||||
|
reply(200, map[string]any{"status": "SUCCESS"})
|
||||||
default:
|
default:
|
||||||
fail(404, "NOT_FOUND", "Unknown endpoint.")
|
fail(404, "NOT_FOUND", "Unknown endpoint.")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TXT returns the values of the TXT records at name (without a trailing
|
||||||
|
// dot) in the fake's domains.
|
||||||
|
func (f *Fake) TXT(name string) []string {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
var out []string
|
||||||
|
for _, d := range f.Domains {
|
||||||
|
for _, r := range d.Records {
|
||||||
|
if r.Type == "TXT" && strings.EqualFold(r.Name, strings.TrimSuffix(name, ".")) {
|
||||||
|
out = append(out, r.Content)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
@@ -1,7 +1,8 @@
|
|||||||
// Package porkbun is a small client for the parts of Porkbun's API v3
|
// Package porkbun is a small client for the parts of Porkbun's API v3
|
||||||
// (https://porkbun.com/api/json/v3/documentation) that Jarl uses to manage
|
// (https://porkbun.com/api/json/v3/documentation) that Jarl uses to manage
|
||||||
// a domain's delegation: its name servers, glue records (host objects at
|
// a domain's delegation: its name servers, glue records (host objects at
|
||||||
// the registry) and DNSSEC DS records.
|
// the registry) and DNSSEC DS records, and the TXT records of DNS-01
|
||||||
|
// challenges while Porkbun still serves a domain (docs/certificates.md).
|
||||||
//
|
//
|
||||||
// Every call is a POST with the API key and secret in the JSON body. API
|
// Every call is a POST with the API key and secret in the JSON body. API
|
||||||
// access must be switched on for each domain in Porkbun's web interface,
|
// access must be switched on for each domain in Porkbun's web interface,
|
||||||
@@ -79,6 +80,7 @@ type response struct {
|
|||||||
Valid bool `json:"credentialsValid"`
|
Valid bool `json:"credentialsValid"`
|
||||||
Account string `json:"account"`
|
Account string `json:"account"`
|
||||||
Scopes []string `json:"scopes"`
|
Scopes []string `json:"scopes"`
|
||||||
|
ID json.Number `json:"id"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *Client) call(ctx context.Context, path string, body map[string]any) (*response, error) {
|
func (c *Client) call(ctx context.Context, path string, body map[string]any) (*response, error) {
|
||||||
@@ -282,6 +284,37 @@ func (c *Client) DeleteDS(ctx context.Context, domain string, keyTag uint16) err
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// MinTTL is the lowest TTL Porkbun accepts for a DNS record.
|
||||||
|
const MinTTL = 600
|
||||||
|
|
||||||
|
// CreateTXT adds a TXT record at name (a name inside domain, or the
|
||||||
|
// domain itself) in Porkbun's DNS and returns its ID.
|
||||||
|
func (c *Client) CreateTXT(ctx context.Context, domain, name, value string) (string, error) {
|
||||||
|
sub := ""
|
||||||
|
if normName(name) != normName(domain) {
|
||||||
|
var err error
|
||||||
|
if sub, err = subdomain(domain, name); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
r, err := c.call(ctx, domainPath("/dns/create", domain), map[string]any{
|
||||||
|
"name": sub, "type": "TXT", "content": value, "ttl": strconv.Itoa(MinTTL),
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if r.ID == "" {
|
||||||
|
return "", &Error{Message: "the record was created but Porkbun didn't say its ID"}
|
||||||
|
}
|
||||||
|
return r.ID.String(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeleteRecord deletes the DNS record with id.
|
||||||
|
func (c *Client) DeleteRecord(ctx context.Context, domain, id string) error {
|
||||||
|
_, err := c.call(ctx, domainPath("/dns/delete", domain, id), nil)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
// subdomain returns host's label(s) below domain ("ns1" for
|
// subdomain returns host's label(s) below domain ("ns1" for
|
||||||
// ns1.example.com in example.com).
|
// ns1.example.com in example.com).
|
||||||
func subdomain(domain, host string) (string, error) {
|
func subdomain(domain, host string) (string, error) {
|
||||||
|
|||||||
@@ -0,0 +1,142 @@
|
|||||||
|
package render
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"jarl/internal/model"
|
||||||
|
"jarl/internal/namedconf"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Generated is a statement Jarl adds to named's configuration by itself,
|
||||||
|
// not from an option you set: why, and what controls it.
|
||||||
|
type Generated struct {
|
||||||
|
Where string `json:"where"` // top level, options, or "view NAME"
|
||||||
|
Text string `json:"text"` // as written in named.conf
|
||||||
|
Why string `json:"why"` // what it is for
|
||||||
|
Setting string `json:"setting"` // what turns it on or off
|
||||||
|
}
|
||||||
|
|
||||||
|
// GeneratedStatements lists what Render adds to named.conf beyond the
|
||||||
|
// options in the database, so nothing there comes as a surprise.
|
||||||
|
func GeneratedStatements(s *model.State, p Paths, x Extras) []Generated {
|
||||||
|
var out []Generated
|
||||||
|
add := func(where, text, why, setting string) {
|
||||||
|
out = append(out, Generated{Where: where, Text: strings.TrimRight(text, "\n"), Why: why, Setting: setting})
|
||||||
|
}
|
||||||
|
add("top level", "include "+namedconf.QuoteString(p.KeysConfig())+";",
|
||||||
|
"TSIG keys (and the view keys) live in their own file, which only named and jarld can read", "always")
|
||||||
|
st := x.Stats
|
||||||
|
logResponses := st != nil && st.LogFile != ""
|
||||||
|
pzs := PolicyZones(s, p)
|
||||||
|
if st != nil {
|
||||||
|
_, user := findTop(s, "statistics-channels")
|
||||||
|
why := "named publishes its counters for jarld's query statistics, on a loopback address only"
|
||||||
|
if user {
|
||||||
|
why += " (added to your statistics-channels statement)"
|
||||||
|
}
|
||||||
|
add("top level", formatStmt(namedconf.NewStmt("statistics-channels", namedconf.NewBlock(st.statsInet())), 0), why, "stats.enabled in jarl.yaml")
|
||||||
|
}
|
||||||
|
if logResponses {
|
||||||
|
b := namedconf.NewBlock(st.logChannel())
|
||||||
|
cat := func(name string, extra ...string) {
|
||||||
|
ch := namedconf.NewBlock(namedconf.NewStmt(StatsChannelName))
|
||||||
|
for _, e := range extra {
|
||||||
|
ch.Stmts = append(ch.Stmts, namedconf.NewStmt(e))
|
||||||
|
}
|
||||||
|
b.Stmts = append(b.Stmts, namedconf.NewStmt("category", name, ch))
|
||||||
|
}
|
||||||
|
why := []string{"responses: every answer, for the statistics' names, clients and views"}
|
||||||
|
cat("responses")
|
||||||
|
if len(pzs) > 0 {
|
||||||
|
cat("rpz")
|
||||||
|
why = append(why, "rpz: what blocking blocked")
|
||||||
|
}
|
||||||
|
if logRateLimit(s, st) {
|
||||||
|
cat("query-errors", "default_syslog")
|
||||||
|
why = append(why, "query-errors: what rate limiting limited, or would in log-only mode, for the Exposure page (also to syslog, as before)")
|
||||||
|
}
|
||||||
|
w := "named logs to a file jarld reads (" + strings.Join(why, "; ") + ")"
|
||||||
|
if _, user := findTop(s, "logging"); user {
|
||||||
|
w += "; merged into your logging statement"
|
||||||
|
}
|
||||||
|
setting := "stats.query_log in jarl.yaml"
|
||||||
|
if logRateLimit(s, st) || hasRateLimit(s) {
|
||||||
|
setting += "; query-errors: stats.rate_limit_log"
|
||||||
|
}
|
||||||
|
add("top level", formatStmt(namedconf.NewStmt("logging", b), 0), w, setting)
|
||||||
|
if s.FindOption(model.ScopeOptions, 0, "responselog") == nil {
|
||||||
|
add("options", "responselog yes;", "named logs answers from the start, for the statistics", "stats.query_log in jarl.yaml")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
views := s.OrderedViews()
|
||||||
|
scopes := []struct {
|
||||||
|
id int64
|
||||||
|
name string
|
||||||
|
}{{0, "options"}}
|
||||||
|
if len(views) > 0 {
|
||||||
|
scopes = scopes[:0]
|
||||||
|
for _, v := range views {
|
||||||
|
scopes = append(scopes, struct {
|
||||||
|
id int64
|
||||||
|
name string
|
||||||
|
}{v.ID, "view " + v.Name})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, sc := range scopes {
|
||||||
|
zs := scopeZones(pzs, sc.id)
|
||||||
|
if len(zs) == 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
w := newConfWriter()
|
||||||
|
writeResponsePolicy(w, zs, logResponses)
|
||||||
|
writePolicyZones(w, s, zs, &Output{}, 0)
|
||||||
|
add(sc.name, dedent(w.sb.String()), "blocking: your rules and blocklists, as response policy zones named loads", "the Blocking page (jarl block, jarl blocklist)")
|
||||||
|
}
|
||||||
|
if viewKeysOn(s, Extras{ViewKeySeed: x.ViewKeySeed}) {
|
||||||
|
for _, v := range views {
|
||||||
|
mc := viewMatchClients(s, x, v)
|
||||||
|
var keys []string
|
||||||
|
for _, e := range mc {
|
||||||
|
if strings.Contains(e, "key ") {
|
||||||
|
keys = append(keys, e+";")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
add("view "+v.Name, "match-clients { "+strings.Join(keys, " ")+" ... };",
|
||||||
|
"view keys: a query signed with a view's key gets that view, from any address, and never another view (jarl view key)", "always, when there are views")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func findTop(s *model.State, name string) (*model.Option, bool) {
|
||||||
|
for _, o := range s.ScopedOptions(model.ScopeTopLevel, 0) {
|
||||||
|
if o.Name == name {
|
||||||
|
return o, true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
|
||||||
|
func hasRateLimit(s *model.State) bool {
|
||||||
|
for _, o := range s.Options {
|
||||||
|
if o.Name == "rate-limit" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// logRateLimit reports whether rate limiting's log lines go to the
|
||||||
|
// response log (docs/exposure.md).
|
||||||
|
func logRateLimit(s *model.State, st *StatsHooks) bool {
|
||||||
|
return st != nil && st.LogFile != "" && !st.NoRateLimitLog && hasRateLimit(s)
|
||||||
|
}
|
||||||
|
|
||||||
|
// dedent removes one leading tab from every line.
|
||||||
|
func dedent(s string) string {
|
||||||
|
lines := strings.Split(s, "\n")
|
||||||
|
for i, l := range lines {
|
||||||
|
lines[i] = strings.TrimPrefix(l, "\t")
|
||||||
|
}
|
||||||
|
return strings.Join(lines, "\n")
|
||||||
|
}
|
||||||
@@ -272,6 +272,9 @@ func renderConfig(s *model.State, p Paths, x Extras, out *Output) (string, []Spa
|
|||||||
pzs := PolicyZones(s, p)
|
pzs := PolicyZones(s, p)
|
||||||
out.Policy = pzs
|
out.Policy = pzs
|
||||||
logRewrites := logResponses && len(pzs) > 0
|
logRewrites := logResponses && len(pzs) > 0
|
||||||
|
// Rate limiting logs what it limits (or would, in log-only mode) as
|
||||||
|
// query-errors; the statistics count it (docs/exposure.md).
|
||||||
|
logRRL := logRateLimit(s, st)
|
||||||
sawStats, sawLogging := false, false
|
sawStats, sawLogging := false, false
|
||||||
if top := s.ScopedOptions(model.ScopeTopLevel, 0); len(top) > 0 {
|
if top := s.ScopedOptions(model.ScopeTopLevel, 0); len(top) > 0 {
|
||||||
w.write("\n")
|
w.write("\n")
|
||||||
@@ -282,7 +285,7 @@ func renderConfig(s *model.State, p Paths, x Extras, out *Output) (string, []Spa
|
|||||||
w.write(st.statsStatement(o))
|
w.write(st.statsStatement(o))
|
||||||
sawStats = true
|
sawStats = true
|
||||||
case logResponses && o.Name == "logging" && !sawLogging:
|
case logResponses && o.Name == "logging" && !sawLogging:
|
||||||
w.write(st.loggingStatement(o, logRewrites))
|
w.write(st.loggingStatement(o, logRewrites, logRRL))
|
||||||
sawLogging = true
|
sawLogging = true
|
||||||
default:
|
default:
|
||||||
w.write(optionText(o, 0))
|
w.write(optionText(o, 0))
|
||||||
@@ -297,7 +300,7 @@ func renderConfig(s *model.State, p Paths, x Extras, out *Output) (string, []Spa
|
|||||||
w.write(st.statsStatement(nil))
|
w.write(st.statsStatement(nil))
|
||||||
}
|
}
|
||||||
if logResponses && !sawLogging {
|
if logResponses && !sawLogging {
|
||||||
w.write(st.loggingStatement(nil, logRewrites))
|
w.write(st.loggingStatement(nil, logRewrites, logRRL))
|
||||||
}
|
}
|
||||||
w.end()
|
w.end()
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -26,6 +26,9 @@ type StatsHooks struct {
|
|||||||
LogFile string // response log; "" disables response logging
|
LogFile string // response log; "" disables response logging
|
||||||
LogVersions int
|
LogVersions int
|
||||||
LogSize string
|
LogSize string
|
||||||
|
// NoRateLimitLog keeps rate limiting's log lines (category
|
||||||
|
// query-errors) out of the response log (stats.rate_limit_log: false).
|
||||||
|
NoRateLimitLog bool
|
||||||
}
|
}
|
||||||
|
|
||||||
// StatsChannelName is the logging channel Jarl adds for responses.
|
// StatsChannelName is the logging channel Jarl adds for responses.
|
||||||
@@ -72,9 +75,10 @@ func (h *StatsHooks) statsStatement(user *model.Option) string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// loggingStatement returns the logging statement with Jarl's channel and
|
// loggingStatement returns the logging statement with Jarl's channel and
|
||||||
// the responses category (and rpz, for blocking's rewrites), merged into
|
// the responses category (rpz too, for blocking's rewrites, and
|
||||||
// the user's own if there is one.
|
// query-errors for rate limiting), merged into the user's own if there is
|
||||||
func (h *StatsHooks) loggingStatement(user *model.Option, rpz bool) string {
|
// one.
|
||||||
|
func (h *StatsHooks) loggingStatement(user *model.Option, rpz, rrl bool) string {
|
||||||
var st *namedconf.Stmt
|
var st *namedconf.Stmt
|
||||||
if user != nil {
|
if user != nil {
|
||||||
var err error
|
var err error
|
||||||
@@ -92,6 +96,9 @@ func (h *StatsHooks) loggingStatement(user *model.Option, rpz bool) string {
|
|||||||
if rpz {
|
if rpz {
|
||||||
categories = append(categories, "rpz")
|
categories = append(categories, "rpz")
|
||||||
}
|
}
|
||||||
|
if rrl {
|
||||||
|
categories = append(categories, "query-errors")
|
||||||
|
}
|
||||||
for _, cat := range categories {
|
for _, cat := range categories {
|
||||||
merged := false
|
merged := false
|
||||||
for _, s := range b.Stmts {
|
for _, s := range b.Stmts {
|
||||||
@@ -101,7 +108,13 @@ func (h *StatsHooks) loggingStatement(user *model.Option, rpz bool) string {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
if !merged {
|
if !merged {
|
||||||
b.Stmts = append(b.Stmts, namedconf.NewStmt("category", cat, namedconf.NewBlock(namedconf.NewStmt(StatsChannelName))))
|
channels := namedconf.NewBlock(namedconf.NewStmt(StatsChannelName))
|
||||||
|
if cat == "query-errors" {
|
||||||
|
// Naming the category takes it away from named's
|
||||||
|
// default destination: keep that too.
|
||||||
|
channels.Stmts = append(channels.Stmts, namedconf.NewStmt("default_syslog"))
|
||||||
|
}
|
||||||
|
b.Stmts = append(b.Stmts, namedconf.NewStmt("category", cat, channels))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
prefix := ""
|
prefix := ""
|
||||||
|
|||||||
@@ -82,3 +82,45 @@ func TestStatsHooksMerged(t *testing.T) {
|
|||||||
func TestStatsHooksWithNamed(t *testing.T) {
|
func TestStatsHooksWithNamed(t *testing.T) {
|
||||||
checkWithNamed(t, sampleState(t), Extras{Stats: statsHooks()})
|
checkWithNamed(t, sampleState(t), Extras{Stats: statsHooks()})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Rate limiting's log lines go to the response log unless
|
||||||
|
// stats.rate_limit_log is off; the list of what Jarl adds says so.
|
||||||
|
func TestRateLimitLogAndGenerated(t *testing.T) {
|
||||||
|
s := sampleState(t)
|
||||||
|
for id, o := range s.Options {
|
||||||
|
if o.Name == "logging" {
|
||||||
|
delete(s.Options, id)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
s.Options[20000] = &model.Option{ID: 20000, Scope: model.ScopeOptions, Name: "rate-limit", Value: "{ responses-per-second 10; log-only yes; }", Position: 20000}
|
||||||
|
p := Paths{ConfigDir: "/etc/bind/jarl", ZoneDir: "/var/lib/bind/jarl", CacheDir: "/var/cache/bind/jarl"}
|
||||||
|
conf := string(Render(s, p, Extras{Stats: statsHooks()}).File(p.MainConfig()).Content)
|
||||||
|
if !strings.Contains(conf, "category query-errors { jarl_responses; default_syslog; };") {
|
||||||
|
t.Errorf("query-errors not logged:\n%s", conf)
|
||||||
|
}
|
||||||
|
gen := GeneratedStatements(s, p, Extras{Stats: statsHooks()})
|
||||||
|
var logging *Generated
|
||||||
|
for i := range gen {
|
||||||
|
if strings.HasPrefix(gen[i].Text, "logging") {
|
||||||
|
logging = &gen[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if logging == nil || !strings.Contains(logging.Text, "query-errors") || !strings.Contains(logging.Setting, "stats.rate_limit_log") {
|
||||||
|
t.Errorf("generated logging = %+v (all %+v)", logging, gen)
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(gen[0].Text, "include ") || gen[0].Where != "top level" {
|
||||||
|
t.Errorf("first generated = %+v", gen[0])
|
||||||
|
}
|
||||||
|
|
||||||
|
h := statsHooks()
|
||||||
|
h.NoRateLimitLog = true
|
||||||
|
conf = string(Render(s, p, Extras{Stats: h}).File(p.MainConfig()).Content)
|
||||||
|
if strings.Contains(conf, "query-errors") || !strings.Contains(conf, "category responses") {
|
||||||
|
t.Errorf("rate_limit_log off but query-errors logged:\n%s", conf)
|
||||||
|
}
|
||||||
|
for _, g := range GeneratedStatements(s, p, Extras{Stats: h}) {
|
||||||
|
if strings.Contains(g.Text, "query-errors") {
|
||||||
|
t.Errorf("listed while off: %+v", g)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,167 @@
|
|||||||
|
package server
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/ecdsa"
|
||||||
|
"crypto/elliptic"
|
||||||
|
"crypto/rand"
|
||||||
|
"crypto/tls"
|
||||||
|
"crypto/x509"
|
||||||
|
"crypto/x509/pkix"
|
||||||
|
"encoding/pem"
|
||||||
|
"io"
|
||||||
|
"log/slog"
|
||||||
|
"math/big"
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"jarl/internal/auth"
|
||||||
|
"jarl/internal/certs"
|
||||||
|
"jarl/internal/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
// selfSigned writes a self-signed certificate for names into dir.
|
||||||
|
func selfSigned(t *testing.T, dir string, names ...string) (certFile, keyFile string) {
|
||||||
|
t.Helper()
|
||||||
|
key, _ := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
|
||||||
|
tmpl := &x509.Certificate{SerialNumber: big.NewInt(time.Now().UnixNano()), Subject: pkix.Name{CommonName: names[0]}, DNSNames: names,
|
||||||
|
NotBefore: time.Now().Add(-time.Hour), NotAfter: time.Now().Add(30 * 24 * time.Hour), ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth}}
|
||||||
|
der, err := x509.CreateCertificate(rand.Reader, tmpl, tmpl, &key.PublicKey, key)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
kd, _ := x509.MarshalPKCS8PrivateKey(key)
|
||||||
|
certFile, keyFile = filepath.Join(dir, "cert.pem"), filepath.Join(dir, "key.pem")
|
||||||
|
os.WriteFile(certFile, pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: der}), 0o600)
|
||||||
|
os.WriteFile(keyFile, pem.EncodeToMemory(&pem.Block{Type: "PRIVATE KEY", Bytes: kd}), 0o600)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
func withCerts(env *apiEnv) *certs.Manager {
|
||||||
|
quiet := slog.New(slog.NewTextHandler(io.Discard, nil))
|
||||||
|
m := certs.New(certs.Config{Dir: filepath.Join(env.t.TempDir(), "tls"), Directory: "https://acme.invalid/dir"}, env.st, env.srv.eng, quiet)
|
||||||
|
env.srv.cfg.Certs = m
|
||||||
|
return m
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCertificatesAPI(t *testing.T) {
|
||||||
|
env := newAPIEnv(t)
|
||||||
|
m := withCerts(env)
|
||||||
|
certFile, keyFile := selfSigned(t, t.TempDir(), "jarl.example.com")
|
||||||
|
|
||||||
|
// A user who isn't an administrator sees nothing.
|
||||||
|
hash, _ := auth.HashPassword("pw-pw-pw-pw")
|
||||||
|
u := &model.User{Username: "ops", PasswordHash: hash, Grants: []model.Grant{{Resource: "*", Access: "write"}}}
|
||||||
|
env.st.CreateUser(context.Background(), u)
|
||||||
|
tok, pid, sh := auth.NewToken()
|
||||||
|
env.st.CreateToken(context.Background(), &model.Token{UserID: u.ID, Name: "t", PublicID: pid, SecretHash: sh})
|
||||||
|
env.do("GET", "/certificates", tok, nil, 403)
|
||||||
|
|
||||||
|
out := env.do("POST", "/certificates", env.token, map[string]any{"name": "own", "source": "file", "cert_file": certFile, "key_file": keyFile, "uses": []string{"web"}}, 201)
|
||||||
|
c := out["certificate"].(map[string]any)
|
||||||
|
if c["serving"] != true || c["status"].(map[string]any)["state"] != "ok" || c["domains"].([]any)[0] != "jarl.example.com" {
|
||||||
|
t.Errorf("created: %v", c)
|
||||||
|
}
|
||||||
|
if _, has := c["key_pem"]; has {
|
||||||
|
t.Error("the key left the server")
|
||||||
|
}
|
||||||
|
if m.WebCertificate() == nil {
|
||||||
|
t.Error("not serving")
|
||||||
|
}
|
||||||
|
env.do("POST", "/certificates", env.token, map[string]any{"name": "own", "domains": []string{"a.example.com"}}, 409)
|
||||||
|
env.do("POST", "/certificates", env.token, map[string]any{"name": "x", "domains": []string{"a.example.com"}, "uses": []string{"web"}}, 400)
|
||||||
|
env.do("POST", "/certificates", env.token, map[string]any{"name": "x", "source": "file", "cert_file": "/nonexistent.pem", "key_file": keyFile}, 400)
|
||||||
|
list := env.do("GET", "/certificates", env.token, nil, 200)
|
||||||
|
if n := len(list["certificates"].([]any)); n != 1 || list["account"].(map[string]any)["directory"] != "https://acme.invalid/dir" {
|
||||||
|
t.Errorf("list: %v", list)
|
||||||
|
}
|
||||||
|
env.do("PATCH", "/certificates/own", env.token, map[string]any{"uses": []string{"dns"}}, 200)
|
||||||
|
if m.WebCertificate() != nil {
|
||||||
|
t.Error("still serving after the web use was taken off")
|
||||||
|
}
|
||||||
|
got := env.do("GET", "/certificates/own", env.token, nil, 200)
|
||||||
|
if files, ok := got["files"].(map[string]any); !ok || !strings.HasSuffix(files["key"].(string), "/own/privkey.pem") {
|
||||||
|
t.Errorf("files: %v", got["files"])
|
||||||
|
}
|
||||||
|
env.do("POST", "/certificates/own/issue", env.token, map[string]any{}, 200)
|
||||||
|
env.do("DELETE", "/certificates/own", env.token, nil, 200)
|
||||||
|
env.do("GET", "/certificates/own", env.token, nil, 404)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHTTPSAndPlainOnOnePort(t *testing.T) {
|
||||||
|
env := newAPIEnv(t)
|
||||||
|
certFile, keyFile := selfSigned(t, t.TempDir(), "jarl.example.com")
|
||||||
|
s := env.srv
|
||||||
|
cr, err := newCertReloader(certFile, keyFile, s.log)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
s.certs = cr
|
||||||
|
ln, err := net.Listen("tcp", "127.0.0.1:0")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
cfg := &tls.Config{GetCertificate: s.webCertificate, NextProtos: []string{"h2", "http/1.1"}}
|
||||||
|
hs := &http.Server{Handler: s.requireHTTPS(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.TLS != nil {
|
||||||
|
io.WriteString(w, "tls "+r.Proto)
|
||||||
|
} else {
|
||||||
|
io.WriteString(w, "plain")
|
||||||
|
}
|
||||||
|
}))}
|
||||||
|
go hs.Serve(newSniffListener(ln, cfg))
|
||||||
|
t.Cleanup(func() { hs.Close() })
|
||||||
|
addr := ln.Addr().String()
|
||||||
|
|
||||||
|
get := func(c *http.Client, url string) string {
|
||||||
|
t.Helper()
|
||||||
|
resp, err := c.Get(url)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
b, _ := io.ReadAll(resp.Body)
|
||||||
|
return string(b)
|
||||||
|
}
|
||||||
|
tlsClient := &http.Client{Transport: &http.Transport{TLSClientConfig: &tls.Config{InsecureSkipVerify: true}, ForceAttemptHTTP2: true}}
|
||||||
|
if got := get(tlsClient, "https://"+addr+"/"); got != "tls HTTP/2.0" {
|
||||||
|
t.Errorf("HTTPS: %q", got)
|
||||||
|
}
|
||||||
|
// Loopback may still use plain HTTP (tools on the server itself).
|
||||||
|
if got := get(http.DefaultClient, "http://"+addr+"/"); got != "plain" {
|
||||||
|
t.Errorf("plain from loopback: %q", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// From elsewhere: browsers are redirected, API calls refused.
|
||||||
|
h := s.requireHTTPS(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { io.WriteString(w, "served") }))
|
||||||
|
req := httptest.NewRequest("GET", "http://dns.example.com:8053/zones?x=1", nil)
|
||||||
|
req.RemoteAddr = "192.0.2.10:5555"
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
h.ServeHTTP(rec, req)
|
||||||
|
if rec.Code != http.StatusPermanentRedirect || rec.Header().Get("Location") != "https://dns.example.com:8053/zones?x=1" {
|
||||||
|
t.Errorf("GET from elsewhere: %d %s", rec.Code, rec.Header().Get("Location"))
|
||||||
|
}
|
||||||
|
req = httptest.NewRequest("POST", "http://dns.example.com:8053/api/v1/records", strings.NewReader("{}"))
|
||||||
|
req.RemoteAddr = "192.0.2.10:5555"
|
||||||
|
req.Header.Set("Authorization", "Bearer x")
|
||||||
|
rec = httptest.NewRecorder()
|
||||||
|
h.ServeHTTP(rec, req)
|
||||||
|
if rec.Code != http.StatusBadRequest || !strings.Contains(rec.Body.String(), "https_required") || !strings.Contains(rec.Body.String(), "rotate the token") {
|
||||||
|
t.Errorf("POST from elsewhere: %d %s", rec.Code, rec.Body.String())
|
||||||
|
}
|
||||||
|
// Without any certificate, plain HTTP is served as before.
|
||||||
|
s.certs = nil
|
||||||
|
rec = httptest.NewRecorder()
|
||||||
|
req = httptest.NewRequest("GET", "http://dns.example.com:8053/", nil)
|
||||||
|
req.RemoteAddr = "192.0.2.10:5555"
|
||||||
|
h.ServeHTTP(rec, req)
|
||||||
|
if rec.Body.String() != "served" {
|
||||||
|
t.Errorf("no certificate: %d %s", rec.Code, rec.Body.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,68 @@
|
|||||||
|
package server
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestExposureAPI(t *testing.T) {
|
||||||
|
e := newAPIEnv(t)
|
||||||
|
e.do("POST", "/zones", e.token, map[string]any{"name": "example.com", "records": []map[string]any{{"name": "ns1", "type": "A", "data": "192.0.2.1"}}}, 201)
|
||||||
|
e.do("POST", "/views", e.token, map[string]any{"name": "internal", "match_clients": []string{"192.168.1.0/24", "localhost"}, "adopt_zones": true}, 201)
|
||||||
|
ext := e.do("POST", "/views", e.token, map[string]any{"name": "external", "match_clients": []string{"any"}}, 201)["object"].(map[string]any)["id"]
|
||||||
|
|
||||||
|
type report struct {
|
||||||
|
Scopes []struct {
|
||||||
|
View string `json:"view"`
|
||||||
|
Reason string `json:"reason"`
|
||||||
|
RateLimit string `json:"rate_limit"`
|
||||||
|
Public bool `json:"public"`
|
||||||
|
Findings []struct {
|
||||||
|
Code, Severity, Fix string
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Server []struct{ Code, Fix string }
|
||||||
|
}
|
||||||
|
get := func() report {
|
||||||
|
b, status := e.req("GET", "/exposure", e.token, nil)
|
||||||
|
if status != 200 {
|
||||||
|
t.Fatalf("exposure = %d %s", status, b)
|
||||||
|
}
|
||||||
|
var r report
|
||||||
|
json.Unmarshal(b, &r)
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
r := get()
|
||||||
|
if len(r.Scopes) != 2 || r.Scopes[0].View != "internal" || r.Scopes[0].Public || !r.Scopes[1].Public {
|
||||||
|
t.Fatalf("scopes = %+v", r.Scopes)
|
||||||
|
}
|
||||||
|
var codes []string
|
||||||
|
for _, f := range r.Scopes[1].Findings {
|
||||||
|
codes = append(codes, f.Code)
|
||||||
|
if f.Code == "exposure_rate_limit" && !strings.Contains(f.Fix, "log-only yes") {
|
||||||
|
t.Errorf("rate limit fix = %q", f.Fix)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !strings.Contains(strings.Join(codes, " "), "exposure_rate_limit") || len(r.Server) < 2 {
|
||||||
|
t.Errorf("findings = %v, server = %+v", codes, r.Server)
|
||||||
|
}
|
||||||
|
e.do("POST", "/exposure/fix", e.token, map[string]any{"view": "external", "code": "exposure_rate_limit"}, 201)
|
||||||
|
if r := get(); r.Scopes[1].RateLimit != "log-only" {
|
||||||
|
t.Errorf("rate limit = %q", r.Scopes[1].RateLimit)
|
||||||
|
}
|
||||||
|
if _, status := e.req("POST", "/exposure/fix", e.token, map[string]any{"view": "external", "code": "exposure_open_notify"}); status != 400 {
|
||||||
|
t.Errorf("fix without an automatic fix = %d", status)
|
||||||
|
}
|
||||||
|
// Opening a public view up needs confirming.
|
||||||
|
b, status := e.req("POST", "/options", e.token, map[string]any{"scope": "view", "scope_id": ext, "name": "allow-recursion", "value": "any"})
|
||||||
|
if status != 409 || !strings.Contains(string(b), "confirm_risk") {
|
||||||
|
t.Errorf("open resolver = %d %s", status, b)
|
||||||
|
}
|
||||||
|
e.do("POST", "/exposure/ack", e.token, map[string]any{"view": "external", "code": "exposure_minimal_any", "reason": "testing"}, 201)
|
||||||
|
for _, f := range get().Scopes[1].Findings {
|
||||||
|
if f.Code == "exposure_minimal_any" && f.Severity != "info" {
|
||||||
|
t.Errorf("acknowledged finding = %+v", f)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -158,7 +158,7 @@ func primaryZonesFor(st *model.State, p *auth.Principal) []acme.Zone {
|
|||||||
for _, z := range st.SortedZones() {
|
for _, z := range st.SortedZones() {
|
||||||
vn := st.ViewName(z)
|
vn := st.ViewName(z)
|
||||||
if z.Type == model.ZonePrimary && !z.Disabled && p.CanSeeZone(z.Name, vn) {
|
if z.Type == model.ZonePrimary && !z.Disabled && p.CanSeeZone(z.Name, vn) {
|
||||||
out = append(out, acme.Zone{Name: z.Name, View: vn})
|
out = append(out, acme.Zone{Name: z.Name, View: vn, Link: z.LinkGroup})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return out
|
return out
|
||||||
|
|||||||
@@ -0,0 +1,259 @@
|
|||||||
|
package server
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"net/http"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"jarl/internal/api"
|
||||||
|
"jarl/internal/auth"
|
||||||
|
"jarl/internal/certs"
|
||||||
|
"jarl/internal/encdns"
|
||||||
|
"jarl/internal/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TLS certificates (docs/certificates.md). Administrators only: a
|
||||||
|
// certificate's key can impersonate the server.
|
||||||
|
|
||||||
|
type certView struct {
|
||||||
|
*model.Certificate
|
||||||
|
Status certs.Status `json:"status"`
|
||||||
|
NextTry *time.Time `json:"next_attempt,omitempty"` // acme: when the loop obtains it next
|
||||||
|
Files *certFiles `json:"files,omitempty"` // dns use: where named reads it
|
||||||
|
Serving bool `json:"serving,omitempty"` // jarld serves it now (web use)
|
||||||
|
// NamedUse says what of named's configuration uses it: "DNS over TLS
|
||||||
|
// on 10.0.10.5 port 853" (list and get only).
|
||||||
|
NamedUse []string `json:"named_use,omitempty"`
|
||||||
|
// IssuingSince is set while Jarl is obtaining it.
|
||||||
|
IssuingSince *time.Time `json:"issuing_since,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type certFiles struct {
|
||||||
|
Chain string `json:"chain"`
|
||||||
|
Key string `json:"key"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Server) presentCert(c *model.Certificate) certView {
|
||||||
|
m := s.cfg.Certs
|
||||||
|
v := certView{Certificate: c, Status: m.StatusOf(c), Serving: m.WebName() == c.Name && c.HasUse(model.CertUseWeb)}
|
||||||
|
if c.Source == model.CertSourceACME {
|
||||||
|
t := m.Due(c)
|
||||||
|
v.NextTry = &t
|
||||||
|
}
|
||||||
|
if t := m.Issuing(c.Name); !t.IsZero() {
|
||||||
|
v.IssuingSince = &t
|
||||||
|
}
|
||||||
|
if c.HasUse(model.CertUseDNS) && c.NotAfter != nil {
|
||||||
|
dir := m.FilesDir(c.Name)
|
||||||
|
v.Files = &certFiles{Chain: dir + "/" + certs.ChainFile, Key: dir + "/" + certs.KeyFile}
|
||||||
|
}
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Server) certsReady(p *auth.Principal) error {
|
||||||
|
if err := requireAdmin(p); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if s.cfg.Certs == nil {
|
||||||
|
return &httpError{http.StatusNotFound, "disabled", "certificates aren't available in this jarld"}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func certErr(err error) error {
|
||||||
|
var ie *certs.InputError
|
||||||
|
switch {
|
||||||
|
case errors.As(err, &ie):
|
||||||
|
return badRequest("%s", ie.Msg)
|
||||||
|
case errors.Is(err, certs.ErrNotFound):
|
||||||
|
return notFound("no such certificate")
|
||||||
|
case errors.Is(err, certs.ErrConflict):
|
||||||
|
return conflict("a certificate with that name exists")
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// certList: GET /certificates.
|
||||||
|
func (s *Server) certList(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := s.certsReady(p); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
all, err := s.cfg.Certs.List(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
st, err := s.store.LoadState(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
out := []certView{}
|
||||||
|
for _, c := range all {
|
||||||
|
v := s.presentCert(c)
|
||||||
|
v.NamedUse = encdns.CertUses(st, s.cfg.Certs.FilesDir(c.Name))
|
||||||
|
out = append(out, v)
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{"certificates": out, "account": s.cfg.Certs.AccountInfo(r.Context())})
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// certGet: GET /certificates/{name}.
|
||||||
|
func (s *Server) certGet(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := s.certsReady(p); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
c, err := s.cfg.Certs.Get(r.Context(), r.PathValue("name"))
|
||||||
|
if err != nil {
|
||||||
|
return certErr(err)
|
||||||
|
}
|
||||||
|
st, err := s.store.LoadState(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
v := s.presentCert(c)
|
||||||
|
v.NamedUse = encdns.CertUses(st, s.cfg.Certs.FilesDir(c.Name))
|
||||||
|
writeJSON(w, http.StatusOK, v)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// certCreate: POST /certificates. With "issue": true (the default for
|
||||||
|
// certificates Jarl obtains) it is obtained before the answer.
|
||||||
|
func (s *Server) certCreate(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := s.certsReady(p); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var in struct {
|
||||||
|
certs.Input
|
||||||
|
Issue *bool `json:"issue"`
|
||||||
|
}
|
||||||
|
if err := decodeJSON(r, &in); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
c, err := s.cfg.Certs.Create(r.Context(), in.Input, p)
|
||||||
|
if err != nil {
|
||||||
|
return certErr(err)
|
||||||
|
}
|
||||||
|
if c.Source == model.CertSourceACME && (in.Issue == nil || *in.Issue) {
|
||||||
|
return s.writeIssue(w, r, c.Name, p, http.StatusCreated)
|
||||||
|
}
|
||||||
|
if c.Source == model.CertSourceACME {
|
||||||
|
s.cfg.Certs.Kick()
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusCreated, map[string]any{"certificate": s.presentCert(c)})
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// certUpdate: PATCH /certificates/{name}.
|
||||||
|
func (s *Server) certUpdate(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := s.certsReady(p); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var in certs.Input
|
||||||
|
if err := decodeJSON(r, &in); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
c, err := s.cfg.Certs.Update(r.Context(), r.PathValue("name"), in, p)
|
||||||
|
if err != nil {
|
||||||
|
return certErr(err)
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{"certificate": s.presentCert(c)})
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// certDelete: DELETE /certificates/{name}.
|
||||||
|
func (s *Server) certDelete(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := s.certsReady(p); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := s.cfg.Certs.Delete(r.Context(), r.PathValue("name"), p); err != nil {
|
||||||
|
return certErr(err)
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{"ok": true})
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// certIssue: POST /certificates/{name}/issue starts obtaining it now
|
||||||
|
// (202), or rereads the files of a file-source certificate (200).
|
||||||
|
func (s *Server) certIssue(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := s.certsReady(p); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return s.writeIssue(w, r, r.PathValue("name"), p, http.StatusOK)
|
||||||
|
}
|
||||||
|
|
||||||
|
// writeIssue starts obtaining the certificate (it takes a while: poll
|
||||||
|
// GET /certificates/{name} until issuing_since is gone).
|
||||||
|
func (s *Server) writeIssue(w http.ResponseWriter, r *http.Request, name string, p *auth.Principal, status int) error {
|
||||||
|
c, err := s.cfg.Certs.IssueAsync(r.Context(), name, p)
|
||||||
|
if c == nil {
|
||||||
|
return certErr(err)
|
||||||
|
}
|
||||||
|
if c.Source == model.CertSourceACME && status == http.StatusOK {
|
||||||
|
status = http.StatusAccepted
|
||||||
|
}
|
||||||
|
out := map[string]any{"certificate": s.presentCert(c)}
|
||||||
|
if err != nil {
|
||||||
|
out["error"] = err.Error()
|
||||||
|
}
|
||||||
|
writeJSON(w, status, out)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// certCheck: POST /certificates/{name}/check (or POST /certificates/check
|
||||||
|
// with a certificate's fields) says where each challenge would go, without
|
||||||
|
// asking the CA for anything.
|
||||||
|
func (s *Server) certCheck(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := s.certsReady(p); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var c *model.Certificate
|
||||||
|
if name := r.PathValue("name"); name != "" {
|
||||||
|
var err error
|
||||||
|
if c, err = s.cfg.Certs.Get(r.Context(), name); err != nil {
|
||||||
|
return certErr(err)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
var in certs.Input
|
||||||
|
if err := decodeJSON(r, &in); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if in.Name == nil {
|
||||||
|
in.Name = model.Ptr("check")
|
||||||
|
}
|
||||||
|
var err error
|
||||||
|
if c, err = s.cfg.Certs.Preview(in); err != nil {
|
||||||
|
return certErr(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
routes, err := s.cfg.Certs.Check(r.Context(), c)
|
||||||
|
if err != nil {
|
||||||
|
return certErr(err)
|
||||||
|
}
|
||||||
|
ok := true
|
||||||
|
for _, rt := range routes {
|
||||||
|
ok = ok && rt.Error == ""
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, map[string]any{"ok": ok, "routes": routes, "account": s.cfg.Certs.AccountInfo(r.Context())})
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// certSummary sums up the certificates for the dashboard (nil without any).
|
||||||
|
func (s *Server) certSummary(ctx context.Context) *api.CertSummary {
|
||||||
|
if s.cfg.Certs == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
all, err := s.cfg.Certs.List(ctx)
|
||||||
|
if err != nil || len(all) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
out := &api.CertSummary{Total: len(all), Problems: []api.CertProblem{}, Serving: s.cfg.Certs.WebName()}
|
||||||
|
for _, c := range all {
|
||||||
|
if st := s.cfg.Certs.StatusOf(c); st.State != "ok" && st.State != "pending" {
|
||||||
|
out.Problems = append(out.Problems, api.CertProblem{Name: c.Name, State: st.State, Message: st.Message})
|
||||||
|
}
|
||||||
|
if c.NotAfter != nil && (out.NextAfter == nil || c.NotAfter.Before(*out.NextAfter)) {
|
||||||
|
out.Next, out.NextAfter = c.Name, c.NotAfter
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
@@ -4,6 +4,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strconv"
|
"strconv"
|
||||||
"time"
|
"time"
|
||||||
@@ -61,6 +62,9 @@ func (s *Server) applyBatch(w http.ResponseWriter, r *http.Request, p *auth.Prin
|
|||||||
if in.Force {
|
if in.Force {
|
||||||
q.Set("force", "1")
|
q.Set("force", "1")
|
||||||
}
|
}
|
||||||
|
if in.AcceptRisk {
|
||||||
|
q.Set("accept_risk", "1")
|
||||||
|
}
|
||||||
r.URL.RawQuery = q.Encode()
|
r.URL.RawQuery = q.Encode()
|
||||||
return s.mutate(w, r, p, in.Description, toRequests(in.Ops), nil)
|
return s.mutate(w, r, p, in.Description, toRequests(in.Ops), nil)
|
||||||
}
|
}
|
||||||
@@ -106,7 +110,7 @@ func (s *Server) createChangeset(w http.ResponseWriter, r *http.Request, p *auth
|
|||||||
}
|
}
|
||||||
cs = res.Changeset
|
cs = res.Changeset
|
||||||
if in.Apply {
|
if in.Apply {
|
||||||
out, err := s.eng.Apply(r.Context(), cs.ID, p, engine.ApplyOptions{DryRun: in.DryRun, Force: in.Force})
|
out, err := s.eng.Apply(r.Context(), cs.ID, p, engine.ApplyOptions{DryRun: in.DryRun, Force: in.Force, AcceptRisk: in.AcceptRisk})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
s.writeErr(w, r, err, out)
|
s.writeErr(w, r, err, out)
|
||||||
return nil
|
return nil
|
||||||
@@ -214,8 +218,9 @@ func (s *Server) applyChangeset(w http.ResponseWriter, r *http.Request, p *auth.
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
var in struct {
|
var in struct {
|
||||||
DryRun bool `json:"dry_run"`
|
DryRun bool `json:"dry_run"`
|
||||||
Force bool `json:"force"`
|
Force bool `json:"force"`
|
||||||
|
AcceptRisk bool `json:"accept_risk"`
|
||||||
}
|
}
|
||||||
if body, err := readBody(r); err != nil {
|
if body, err := readBody(r); err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -224,7 +229,8 @@ func (s *Server) applyChangeset(w http.ResponseWriter, r *http.Request, p *auth.
|
|||||||
return badRequest("invalid JSON: %v", err)
|
return badRequest("invalid JSON: %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
res, err := s.eng.Apply(r.Context(), id, p, engine.ApplyOptions{DryRun: in.DryRun || queryBool(r, "dry_run"), Force: in.Force || queryBool(r, "force")})
|
res, err := s.eng.Apply(r.Context(), id, p, engine.ApplyOptions{DryRun: in.DryRun || queryBool(r, "dry_run"), Force: in.Force || queryBool(r, "force"),
|
||||||
|
AcceptRisk: in.AcceptRisk || queryBool(r, "accept_risk")})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
s.writeErr(w, r, err, res)
|
s.writeErr(w, r, err, res)
|
||||||
return nil
|
return nil
|
||||||
@@ -278,6 +284,22 @@ func (s *Server) status(w http.ResponseWriter, r *http.Request, p *auth.Principa
|
|||||||
if p.IsAdmin() {
|
if p.IsAdmin() {
|
||||||
resp.Backup = s.backupStatus(r.Context(), now)
|
resp.Backup = s.backupStatus(r.Context(), now)
|
||||||
resp.TOTP = s.totpOverview(r.Context())
|
resp.TOTP = s.totpOverview(r.Context())
|
||||||
|
resp.Certificates = s.certSummary(r.Context())
|
||||||
|
resp.Storage = s.storage(r.Context())
|
||||||
|
}
|
||||||
|
if p.Can(auth.Action{Resource: auth.ResOptions}) {
|
||||||
|
if h := s.encryptedDNSHealth(); h != nil {
|
||||||
|
sum := &api.EncDNSSummary{Checked: h.Checked, OK: h.OK(), Problems: []string{}, Warnings: []string{}}
|
||||||
|
for _, pr := range h.Probes {
|
||||||
|
where := fmt.Sprintf("%s on %s port %d", map[string]string{"dot": "DNS over TLS", "doh": "DNS over HTTPS"}[pr.Kind], pr.Address, pr.Port)
|
||||||
|
if pr.Problem != "" {
|
||||||
|
sum.Problems = append(sum.Problems, where+": "+pr.Problem)
|
||||||
|
} else if pr.Warning != "" {
|
||||||
|
sum.Warnings = append(sum.Warnings, where+": "+pr.Warning)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
resp.EncryptedDNS = sum
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if p.Can(auth.Action{Resource: auth.ResBlocking}) {
|
if p.Can(auth.Action{Resource: auth.ResBlocking}) {
|
||||||
resp.BlocklistErrors = s.blocklistErrors(r.Context())
|
resp.BlocklistErrors = s.blocklistErrors(r.Context())
|
||||||
|
|||||||
@@ -0,0 +1,92 @@
|
|||||||
|
package server
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"jarl/internal/auth"
|
||||||
|
"jarl/internal/engine"
|
||||||
|
"jarl/internal/model"
|
||||||
|
)
|
||||||
|
|
||||||
|
// zoneCompare: GET /zones/{zone}/compare compares a zone with the same
|
||||||
|
// zone in other views (docs/views.md#comparing-views), from the zone's own
|
||||||
|
// view: ?with=a,b picks the other views (default: every view with a
|
||||||
|
// primary zone of that name), ?name=www[&type=A] narrows it to one name,
|
||||||
|
// ?all=1 includes what is the same. A zone named without its view is
|
||||||
|
// compared from the first view that has it. (?views=a,b, the views to
|
||||||
|
// compare with the first as the base, works too.)
|
||||||
|
func (s *Server) zoneCompare(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
st, err := s.state(r)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
q := r.URL.Query()
|
||||||
|
list := func(k string) []string {
|
||||||
|
var out []string
|
||||||
|
for _, v := range strings.Split(q.Get(k), ",") {
|
||||||
|
if v = strings.TrimSpace(v); v != "" {
|
||||||
|
out = append(out, v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
with, views := list("with"), list("views")
|
||||||
|
z, err := s.zoneByPath(r, st, p)
|
||||||
|
if err != nil {
|
||||||
|
// A name in several views is what there is to compare.
|
||||||
|
ref := r.PathValue("zone")
|
||||||
|
if ref == "root" {
|
||||||
|
ref = "."
|
||||||
|
}
|
||||||
|
name, perr := engine.ParseZoneName(ref)
|
||||||
|
zs := st.ZonesNamed(name)
|
||||||
|
if perr != nil || len(zs) < 2 {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
st.SortByView(zs)
|
||||||
|
z = zs[0]
|
||||||
|
if len(views) > 0 {
|
||||||
|
for _, o := range zs {
|
||||||
|
if strings.EqualFold(st.ViewName(o), views[0]) {
|
||||||
|
z = o
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
readable := func(o *model.Zone) bool {
|
||||||
|
vn := st.ViewName(o)
|
||||||
|
return o.Type == model.ZonePrimary && p.CanSeeZone(o.Name, vn) && p.Can(auth.Action{Resource: auth.ResRecords, Zone: o.Name, View: vn})
|
||||||
|
}
|
||||||
|
if !readable(z) {
|
||||||
|
return badRequest("zone %s isn't a primary zone whose records you may read", engine.Display(z.Name))
|
||||||
|
}
|
||||||
|
zones := []*model.Zone{z}
|
||||||
|
var others []*model.Zone
|
||||||
|
for _, o := range st.ZonesNamed(z.Name) {
|
||||||
|
vn := st.ViewName(o)
|
||||||
|
if o.ID == z.ID || !readable(o) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if len(with) > 0 && !containsFold(with, vn) || len(views) > 0 && !containsFold(views, vn) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
others = append(others, o)
|
||||||
|
}
|
||||||
|
st.SortByView(others)
|
||||||
|
zones = append(zones, others...)
|
||||||
|
if len(zones) < 2 {
|
||||||
|
return badRequest("zone %s is in only one view (that you may read): there is nothing to compare", engine.Display(z.Name))
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, engine.Compare(st, zones, engine.CompareFilter{Name: q.Get("name"), Type: q.Get("type"), All: queryBool(r, "all")}))
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func containsFold(list []string, s string) bool {
|
||||||
|
for _, x := range list {
|
||||||
|
if strings.EqualFold(x, s) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
@@ -659,3 +659,22 @@ func (s *Server) search(w http.ResponseWriter, r *http.Request, p *auth.Principa
|
|||||||
writeJSON(w, http.StatusOK, out)
|
writeJSON(w, http.StatusOK, out)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// generatedOptions: GET /options/generated lists what Jarl adds to
|
||||||
|
// named.conf by itself (the statistics channel, its logging, blocking's
|
||||||
|
// response-policy, view keys), with why and what controls it.
|
||||||
|
func (s *Server) generatedOptions(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := require(p, auth.Action{Resource: auth.ResOptions}); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
st, err := s.store.LoadState(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
out := s.eng.GeneratedStatements(r.Context(), st)
|
||||||
|
if out == nil {
|
||||||
|
out = []render.Generated{}
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, out)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,351 @@
|
|||||||
|
package server
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"net/netip"
|
||||||
|
"slices"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"jarl/internal/auth"
|
||||||
|
"jarl/internal/certs"
|
||||||
|
"jarl/internal/encdns"
|
||||||
|
"jarl/internal/model"
|
||||||
|
"jarl/internal/nscheck"
|
||||||
|
)
|
||||||
|
|
||||||
|
// DNS over TLS and HTTPS (docs/encrypted-dns.md).
|
||||||
|
|
||||||
|
type encAddress struct {
|
||||||
|
Address string `json:"address"`
|
||||||
|
Private bool `json:"private"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type encView struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Public bool `json:"public"`
|
||||||
|
HasZone bool `json:"has_zone,omitempty"` // has a zone for the host name
|
||||||
|
}
|
||||||
|
|
||||||
|
type encCert struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Names []string `json:"names"`
|
||||||
|
Domains []string `json:"domains"`
|
||||||
|
DNS bool `json:"dns"` // has the dns use
|
||||||
|
Status certs.Status `json:"status"`
|
||||||
|
Obtained bool `json:"obtained"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type encStatus struct {
|
||||||
|
encdns.Status
|
||||||
|
// Hostnames are the names clients connect to (the setup's, else the
|
||||||
|
// certificate's first); Hostname is the first.
|
||||||
|
Hostnames []string `json:"hostnames"`
|
||||||
|
Hostname string `json:"hostname,omitempty"`
|
||||||
|
// AddressViews are, per address, the views whose records give a host
|
||||||
|
// name that address.
|
||||||
|
AddressViews map[string][]string `json:"address_views"`
|
||||||
|
// DoTHost and DoHURL are what to give clients.
|
||||||
|
DoTHost string `json:"dot_host,omitempty"`
|
||||||
|
DoHURL string `json:"doh_url,omitempty"`
|
||||||
|
// Health is the last check of the listeners (every 10 minutes).
|
||||||
|
Health *encdns.Health `json:"health,omitempty"`
|
||||||
|
// For the setup form.
|
||||||
|
Addresses []encAddress `json:"addresses"`
|
||||||
|
Views []encView `json:"views"`
|
||||||
|
Certificates []encCert `json:"certificates"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Server) encReady(p *auth.Principal, write bool) error {
|
||||||
|
if err := require(p, auth.Action{Resource: auth.ResOptions, Write: write}); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if s.cfg.Certs == nil {
|
||||||
|
return &httpError{http.StatusNotFound, "disabled", "certificates aren't available in this jarld"}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// localAddrs returns this host's addresses (a test may replace it).
|
||||||
|
var localAddrs = nscheck.LocalAddrs
|
||||||
|
|
||||||
|
// encryptedDNS: GET /encrypted-dns.
|
||||||
|
func (s *Server) encryptedDNS(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := s.encReady(p, false); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
st, err := s.store.LoadState(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
m := s.cfg.Certs
|
||||||
|
out := encStatus{Status: encdns.GetStatus(st, m.FilesDir("")), Addresses: []encAddress{}, Views: []encView{}, Certificates: []encCert{}}
|
||||||
|
all, err := m.List(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
for _, c := range all {
|
||||||
|
out.Certificates = append(out.Certificates, encCert{Name: c.Name, Names: c.Names, Domains: c.Domains, DNS: c.HasUse(model.CertUseDNS),
|
||||||
|
Status: m.StatusOf(c), Obtained: c.NotAfter != nil})
|
||||||
|
if c.Name == out.Certificate {
|
||||||
|
for _, n := range append(c.Names, c.Domains...) {
|
||||||
|
if !strings.HasPrefix(n, "*.") {
|
||||||
|
out.Hostname = n
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if hs := st.Settings.EncryptedDNSHosts; len(hs) > 0 {
|
||||||
|
out.Hostname = hs[0]
|
||||||
|
out.Hostnames = hs
|
||||||
|
} else if out.Hostname != "" {
|
||||||
|
out.Hostnames = []string{out.Hostname}
|
||||||
|
}
|
||||||
|
if out.Hostnames == nil {
|
||||||
|
out.Hostnames = []string{}
|
||||||
|
}
|
||||||
|
if out.Hostname != "" {
|
||||||
|
if len(out.DoT) > 0 {
|
||||||
|
out.DoTHost = out.Hostname
|
||||||
|
if out.DoT[0].Port != encdns.DoTPort {
|
||||||
|
out.DoTHost += ":" + strconv.Itoa(out.DoT[0].Port)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(out.DoH) > 0 {
|
||||||
|
out.DoHURL = "https://" + out.Hostname
|
||||||
|
if out.DoH[0].Port != 443 {
|
||||||
|
out.DoHURL += ":" + strconv.Itoa(out.DoH[0].Port)
|
||||||
|
}
|
||||||
|
out.DoHURL += "/dns-query"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if out.Enabled {
|
||||||
|
out.Health = s.encryptedDNSHealth()
|
||||||
|
}
|
||||||
|
seen := map[netip.Addr]bool{}
|
||||||
|
for _, a := range localAddrs() {
|
||||||
|
a = a.Unmap()
|
||||||
|
if seen[a] || a.IsLinkLocalUnicast() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
seen[a] = true
|
||||||
|
out.Addresses = append(out.Addresses, encAddress{Address: a.String(), Private: encdns.Private(a)})
|
||||||
|
}
|
||||||
|
slices.SortFunc(out.Addresses, func(a, b encAddress) int { return strings.Compare(a.Address, b.Address) })
|
||||||
|
hosts := out.Hostnames
|
||||||
|
if q := r.URL.Query().Get("hostname"); q != "" {
|
||||||
|
hosts = nil
|
||||||
|
for _, h := range strings.Split(q, ",") {
|
||||||
|
if h = strings.TrimSuffix(strings.TrimSpace(h), "."); h != "" {
|
||||||
|
hosts = append(hosts, h)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Where the records of these host names give each address now, the
|
||||||
|
// setup's or not: what the form starts from.
|
||||||
|
out.AddressViews = encdns.CurrentAddressViews(st, hosts)
|
||||||
|
for _, x := range s.eng.Exposures(st) {
|
||||||
|
if x.View == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
v := encView{Name: x.View, Public: x.Public}
|
||||||
|
if vv := st.ViewByName(x.View); vv != nil {
|
||||||
|
for _, host := range hosts {
|
||||||
|
for _, z := range st.ZonesInView(vv.ID) {
|
||||||
|
if z.Type == model.ZonePrimary && (host+"." == z.Name || strings.HasSuffix(host+".", "."+z.Name)) {
|
||||||
|
v.HasZone = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out.Views = append(out.Views, v)
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, out)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// encryptedDNSCheck: POST /encrypted-dns/check {"addresses", "dot", "doh",
|
||||||
|
// "doh_port"} says what already listens where the listeners would go.
|
||||||
|
func (s *Server) encryptedDNSCheck(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := s.encReady(p, false); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var in encdns.Setup
|
||||||
|
if err := decodeJSON(r, &in); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
st, err := s.store.LoadState(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if in.DoHPort == 0 {
|
||||||
|
in.DoHPort = 443
|
||||||
|
}
|
||||||
|
if in.DoTPort == 0 {
|
||||||
|
in.DoTPort = encdns.DoTPort
|
||||||
|
}
|
||||||
|
var ports []int
|
||||||
|
if in.DoT {
|
||||||
|
ports = append(ports, in.DoTPort)
|
||||||
|
}
|
||||||
|
if in.DoH {
|
||||||
|
ports = append(ports, in.DoHPort)
|
||||||
|
}
|
||||||
|
conflicts, err := encdns.PortCheck(st, in.Addresses, ports, s.cfg.Listen)
|
||||||
|
out := map[string]any{"conflicts": conflicts}
|
||||||
|
if err != nil {
|
||||||
|
out["error"] = "can't see which ports are in use: " + err.Error()
|
||||||
|
}
|
||||||
|
if conflicts == nil {
|
||||||
|
out["conflicts"] = []encdns.Conflict{}
|
||||||
|
}
|
||||||
|
if in.DoH {
|
||||||
|
out["free_doh_port"] = encdns.FreeDoHPort(st, in.Addresses, s.cfg.Listen)
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, out)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// encryptedDNSSetup: POST /encrypted-dns stages (or applies) the setup.
|
||||||
|
func (s *Server) encryptedDNSSetup(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := s.encReady(p, true); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var in encdns.Setup
|
||||||
|
if err := decodeJSON(r, &in); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
c, err := s.cfg.Certs.Get(r.Context(), in.Certificate)
|
||||||
|
if err != nil {
|
||||||
|
return certErr(err)
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case !c.HasUse(model.CertUseDNS):
|
||||||
|
return badRequest("certificate %s doesn't have the dns use, so named can't read it: jarl cert update %s --use dns (and keep its other uses)", c.Name, c.Name)
|
||||||
|
case c.NotAfter == nil:
|
||||||
|
return conflict("certificate %s hasn't been obtained yet (%s); set up encrypted DNS once it has", c.Name, s.cfg.Certs.StatusOf(c).Message)
|
||||||
|
case len(in.Hosts()) > 0 && !certs.Covers(c.Names, in.Hosts()):
|
||||||
|
return badRequest("certificate %s is for %s, not all of %s: clients would reject it (add the names to it: jarl cert update %s --domain …)", c.Name, strings.Join(c.Names, ", "), strings.Join(in.Hosts(), ", "), c.Name)
|
||||||
|
}
|
||||||
|
st, err := s.store.LoadState(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
in.PublicViews = map[string]bool{}
|
||||||
|
for _, x := range s.eng.Exposures(st) {
|
||||||
|
in.PublicViews[x.View] = x.Public
|
||||||
|
}
|
||||||
|
reqs, notes, err := encdns.Plan(st, in, s.cfg.Certs.FilesDir(""))
|
||||||
|
if err != nil {
|
||||||
|
return badRequest("%v", err)
|
||||||
|
}
|
||||||
|
what := []string{}
|
||||||
|
if in.DoT {
|
||||||
|
what = append(what, "DNS over TLS")
|
||||||
|
}
|
||||||
|
if in.DoH {
|
||||||
|
what = append(what, "DNS over HTTPS")
|
||||||
|
}
|
||||||
|
return s.mutateNotes(w, r, p, "set up "+strings.Join(what, " and ")+" for "+strings.Join(in.Hosts(), ", "), reqs, nil, notes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// encryptedDNSDisable: DELETE /encrypted-dns.
|
||||||
|
func (s *Server) encryptedDNSDisable(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := s.encReady(p, true); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
st, err := s.store.LoadState(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
reqs := encdns.Disable(st)
|
||||||
|
if len(reqs) == 0 {
|
||||||
|
return conflict("encrypted DNS isn't set up")
|
||||||
|
}
|
||||||
|
return s.mutate(w, r, p, "turn DNS over TLS and HTTPS off", reqs, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
// encTarget returns the host name clients connect to and the serial of
|
||||||
|
// the certificate Jarl last wrote for named.
|
||||||
|
func (s *Server) encTarget(ctx context.Context, st encdns.Status) (host, serial string) {
|
||||||
|
if s.cfg.Certs == nil || st.Certificate == "" {
|
||||||
|
return "", ""
|
||||||
|
}
|
||||||
|
c, err := s.cfg.Certs.Get(ctx, st.Certificate)
|
||||||
|
if err != nil {
|
||||||
|
return "", ""
|
||||||
|
}
|
||||||
|
for _, n := range append(c.Names, c.Domains...) {
|
||||||
|
if !strings.HasPrefix(n, "*.") {
|
||||||
|
host = n
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return host, c.Serial
|
||||||
|
}
|
||||||
|
|
||||||
|
// checkEncryptedDNS checks the DoT and DoH listeners as a client would and
|
||||||
|
// keeps the result; a change for the worse is logged.
|
||||||
|
func (s *Server) checkEncryptedDNS(ctx context.Context) *encdns.Health {
|
||||||
|
if s.cfg.Certs == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
state, err := s.store.LoadState(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
st := encdns.GetStatus(state, s.cfg.Certs.FilesDir(""))
|
||||||
|
var h *encdns.Health
|
||||||
|
if st.Enabled {
|
||||||
|
if host, serial := s.encTarget(ctx, st); host != "" {
|
||||||
|
hosts := state.Settings.EncryptedDNSHosts
|
||||||
|
if len(hosts) > 0 {
|
||||||
|
host = hosts[0]
|
||||||
|
}
|
||||||
|
h = encdns.Check(ctx, st, host, serial, s.encRoots)
|
||||||
|
h.RequireNames(append([]string{host}, hosts...))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
s.encHealth.Lock()
|
||||||
|
prev := s.encHealth.h
|
||||||
|
s.encHealth.h = h
|
||||||
|
s.encHealth.Unlock()
|
||||||
|
if h != nil {
|
||||||
|
for _, p := range h.Probes {
|
||||||
|
if p.OK {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
was := false
|
||||||
|
if prev != nil {
|
||||||
|
for _, q := range prev.Probes {
|
||||||
|
was = was || q.Kind == p.Kind && q.Address == p.Address && q.Port == p.Port && !q.OK
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !was {
|
||||||
|
s.log.Warn("encrypted DNS isn't working", "kind", p.Kind, "address", p.Address, "port", p.Port, "problem", p.Problem)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return h
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Server) encryptedDNSHealth() *encdns.Health {
|
||||||
|
s.encHealth.Lock()
|
||||||
|
defer s.encHealth.Unlock()
|
||||||
|
return s.encHealth.h
|
||||||
|
}
|
||||||
|
|
||||||
|
// encryptedDNSCheckNow: POST /encrypted-dns/health checks the listeners now.
|
||||||
|
func (s *Server) encryptedDNSCheckNow(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := s.encReady(p, false); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
h := s.checkEncryptedDNS(r.Context())
|
||||||
|
if h == nil {
|
||||||
|
return conflict("encrypted DNS isn't set up")
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, h)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,153 @@
|
|||||||
|
package server
|
||||||
|
|
||||||
|
import (
|
||||||
|
"jarl/internal/mailcheck"
|
||||||
|
"net/http"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"jarl/internal/auth"
|
||||||
|
"jarl/internal/engine"
|
||||||
|
"jarl/internal/model"
|
||||||
|
"jarl/internal/stats"
|
||||||
|
"jarl/internal/validate"
|
||||||
|
)
|
||||||
|
|
||||||
|
// exposureFinding is an exposure problem with the fix Jarl can stage for
|
||||||
|
// it ("" when there is none).
|
||||||
|
type exposureFinding struct {
|
||||||
|
validate.Problem
|
||||||
|
Fix string `json:"fix,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type exposureScope struct {
|
||||||
|
validate.Exposure
|
||||||
|
RateLimit string `json:"rate_limit"` // off, log-only or enforcing
|
||||||
|
Findings []exposureFinding `json:"findings"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type exposureReport struct {
|
||||||
|
Scopes []exposureScope `json:"scopes"`
|
||||||
|
// Server holds server-wide findings (version, host name, management
|
||||||
|
// interfaces).
|
||||||
|
Server []exposureFinding `json:"server"`
|
||||||
|
// RateLimiting is what rate limiting limited, or would have, in the
|
||||||
|
// last 24 hours (with query statistics on).
|
||||||
|
RateLimiting *rateLimitActivity `json:"rate_limiting,omitempty"`
|
||||||
|
// RateLimitLog is false when stats.rate_limit_log is off: what rate
|
||||||
|
// limiting does isn't counted then.
|
||||||
|
RateLimitLog bool `json:"rate_limit_log"`
|
||||||
|
// Mail is the last check of the mail addresses' reverse DNS.
|
||||||
|
Mail *mailcheck.Report `json:"mail,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type rateLimitActivity struct {
|
||||||
|
Since string `json:"since"`
|
||||||
|
Counts []stats.Entry `json:"counts"` // drop, slip, would-drop, would-slip
|
||||||
|
Networks []stats.Entry `json:"networks"` // client networks, most limited first
|
||||||
|
Names []stats.Entry `json:"names"` // "name TYPE"
|
||||||
|
}
|
||||||
|
|
||||||
|
// exposure: GET /exposure reports which views are reachable from the
|
||||||
|
// internet and what the exposure checks found (docs/exposure.md).
|
||||||
|
func (s *Server) exposure(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := require(p, auth.Action{Resource: auth.ResOptions}); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
st, err := s.store.LoadState(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
problems := s.eng.Validate(st)
|
||||||
|
out := exposureReport{Scopes: []exposureScope{}, Server: []exposureFinding{}, RateLimitLog: s.cfg.RateLimitLog}
|
||||||
|
finding := func(pr validate.Problem, viewID int64) exposureFinding {
|
||||||
|
_, desc := engine.ExposureFix(st, viewID, pr.Code)
|
||||||
|
return exposureFinding{Problem: pr, Fix: desc}
|
||||||
|
}
|
||||||
|
scopes := map[string]int{}
|
||||||
|
for _, x := range s.eng.Exposures(st) {
|
||||||
|
sc := exposureScope{Exposure: x, RateLimit: "off", Findings: []exposureFinding{}}
|
||||||
|
v := st.Views[x.ViewID]
|
||||||
|
o := st.FindOption(model.ScopeOptions, 0, "rate-limit")
|
||||||
|
if v != nil {
|
||||||
|
if vo := st.FindOption(model.ScopeView, v.ID, "rate-limit"); vo != nil {
|
||||||
|
o = vo
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if o != nil {
|
||||||
|
sc.RateLimit = "enforcing"
|
||||||
|
if validate.LogOnly(o) {
|
||||||
|
sc.RateLimit = "log-only"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
scopes[x.View] = len(out.Scopes)
|
||||||
|
out.Scopes = append(out.Scopes, sc)
|
||||||
|
}
|
||||||
|
for _, pr := range problems {
|
||||||
|
if !validate.Ackable(pr.Code) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if pr.ObjectType == "view" || pr.ObjectType == "zone" {
|
||||||
|
if i, ok := scopes[pr.View]; ok {
|
||||||
|
out.Scopes[i].Findings = append(out.Scopes[i].Findings, finding(pr, out.Scopes[i].ViewID))
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out.Server = append(out.Server, finding(pr, 0))
|
||||||
|
}
|
||||||
|
if s.statsQ != nil && p.Can(auth.Action{Resource: auth.ResStats}) {
|
||||||
|
ctx, since := r.Context(), 24*time.Hour
|
||||||
|
a := &rateLimitActivity{Since: "24h"}
|
||||||
|
a.Counts, _ = s.statsQ.Breakdown(ctx, "rrl", since)
|
||||||
|
a.Networks, _ = s.statsQ.Top(ctx, stats.KindRateLimited, since, 10)
|
||||||
|
a.Names, _ = s.statsQ.Top(ctx, stats.KindRateLimitedName, since, 10)
|
||||||
|
out.RateLimiting = a
|
||||||
|
}
|
||||||
|
out.Mail = s.mailReport()
|
||||||
|
writeJSON(w, http.StatusOK, out)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// exposureFix: POST /exposure/fix {"view_id": 3, "code": "..."} stages (or
|
||||||
|
// applies) the fix for a finding, like any other change.
|
||||||
|
func (s *Server) exposureFix(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
var in struct {
|
||||||
|
ViewID int64 `json:"view_id"`
|
||||||
|
View string `json:"view"`
|
||||||
|
Code string `json:"code"`
|
||||||
|
}
|
||||||
|
if err := decodeJSON(r, &in); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
st, err := s.store.LoadState(r.Context())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if in.View != "" {
|
||||||
|
v := st.ViewByName(in.View)
|
||||||
|
if v == nil {
|
||||||
|
return notFound("no view %s", in.View)
|
||||||
|
}
|
||||||
|
in.ViewID = v.ID
|
||||||
|
}
|
||||||
|
reqs, desc := engine.ExposureFix(st, in.ViewID, in.Code)
|
||||||
|
if reqs == nil {
|
||||||
|
return badRequest("there is no automatic fix for %s: what to allow is yours to decide; change the option yourself, or acknowledge the finding", in.Code)
|
||||||
|
}
|
||||||
|
return s.mutate(w, r, p, desc, reqs, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
// exposureAck: POST /exposure/ack {"view": "external", "code": "...",
|
||||||
|
// "reason": "..."} accepts a finding (unack takes it back).
|
||||||
|
func (s *Server) exposureAck(ack bool) handler {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
var in engine.AckInput
|
||||||
|
if err := decodeJSON(r, &in); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
op := engine.OpExposureUnack
|
||||||
|
if ack {
|
||||||
|
op = engine.OpExposureAck
|
||||||
|
}
|
||||||
|
return s.mutate(w, r, p, "", []engine.Request{engine.NewRequest(op, 0, in)}, nil)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,83 @@
|
|||||||
|
package server
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"jarl/internal/auth"
|
||||||
|
"jarl/internal/mailcheck"
|
||||||
|
)
|
||||||
|
|
||||||
|
// mailCheckEvery is how often jarld checks the reverse DNS of the
|
||||||
|
// addresses that send and receive mail (docs/exposure.md#mail).
|
||||||
|
const mailCheckEvery = 6 * time.Hour
|
||||||
|
|
||||||
|
// checkMail checks the reverse DNS of the public zones' mail addresses and
|
||||||
|
// keeps the report; it logs addresses that became wrong.
|
||||||
|
func (s *Server) checkMail(ctx context.Context) *mailcheck.Report {
|
||||||
|
st, err := s.store.LoadState(ctx)
|
||||||
|
if err != nil {
|
||||||
|
s.log.Warn("mail reverse DNS check: loading state", "err", err)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
public := map[int64]bool{}
|
||||||
|
for _, x := range s.eng.Exposures(st) {
|
||||||
|
public[x.ViewID] = x.Public
|
||||||
|
}
|
||||||
|
if len(st.Views) == 0 {
|
||||||
|
public[0] = true
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithTimeout(ctx, 2*time.Minute)
|
||||||
|
defer cancel()
|
||||||
|
rep := mailcheck.Check(ctx, st, func(id int64) bool { return public[id] }, mailcheck.Resolver{Servers: s.cfg.Resolvers})
|
||||||
|
s.mail.Lock()
|
||||||
|
prev := s.mail.r
|
||||||
|
s.mail.r = rep
|
||||||
|
s.mail.Unlock()
|
||||||
|
was := map[string]bool{}
|
||||||
|
if prev != nil {
|
||||||
|
for _, r := range prev.Results {
|
||||||
|
was[r.Zone+"|"+r.Address] = r.OK
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, r := range rep.Results {
|
||||||
|
if ok, seen := was[r.Zone+"|"+r.Address]; !r.OK && (ok || !seen) {
|
||||||
|
s.log.Warn("mail reverse DNS", "zone", r.Zone, "address", r.Address, "problem", r.Message)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return rep
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Server) mailReport() *mailcheck.Report {
|
||||||
|
s.mail.Lock()
|
||||||
|
defer s.mail.Unlock()
|
||||||
|
return s.mail.r
|
||||||
|
}
|
||||||
|
|
||||||
|
// mailCheckNow: POST /exposure/mail checks now and returns the report.
|
||||||
|
func (s *Server) mailCheckNow(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
if err := require(p, auth.Action{Resource: auth.ResOptions}); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
rep := s.checkMail(r.Context())
|
||||||
|
if rep == nil {
|
||||||
|
rep = &mailcheck.Report{Checked: time.Now(), Results: []mailcheck.Result{}}
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, rep)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// mailLoop checks a minute after the start, then every mailCheckEvery.
|
||||||
|
func (s *Server) mailLoop(ctx context.Context) {
|
||||||
|
wait := time.Minute
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case <-time.After(wait):
|
||||||
|
s.checkMail(ctx)
|
||||||
|
wait = mailCheckEvery
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
package server
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"jarl/internal/auth"
|
||||||
|
"jarl/internal/engine"
|
||||||
|
)
|
||||||
|
|
||||||
|
// zoneFillPTR: POST /zones/{zone}/fill-ptr adds the PTR records a reverse
|
||||||
|
// zone lacks for its view's A and AAAA records (docs/reverse.md).
|
||||||
|
func (s *Server) zoneFillPTR(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
st, err := s.state(r)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
z, err := s.zoneByPath(r, st, p)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return s.mutate(w, r, p, "", []engine.Request{engine.NewRequest(engine.OpZoneFillPTR, z.ID, engine.LinkInput{ZoneID: z.ID})}, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
// reverseSuggestions: GET /reverse-zones/suggestions lists the reverse
|
||||||
|
// zones the private views lack for their records' addresses. ?all=1 adds
|
||||||
|
// the ones not suggested unasked (public views, views with suggestions
|
||||||
|
// off, dismissed), marked hidden; ?view= narrows it to one view.
|
||||||
|
func (s *Server) reverseSuggestions(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
st, err := s.state(r)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
out := []engine.ReverseSuggestion{}
|
||||||
|
for _, sg := range s.eng.ReverseSuggestions(st, engine.ReverseOptions{All: queryBool(r, "all"), View: r.URL.Query().Get("view")}) {
|
||||||
|
if p.CanSeeZone(sg.Zone+".", sg.View) {
|
||||||
|
out = append(out, sg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, out)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// reverseDismiss: POST /reverse-zones/dismiss {"view": "internal",
|
||||||
|
// "prefix": "185.199.108.153/32"} hides a suggestion; /undismiss shows it
|
||||||
|
// again.
|
||||||
|
func (s *Server) reverseDismiss(dismiss bool) handler {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
var in engine.DismissInput
|
||||||
|
if err := decodeJSON(r, &in); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
op := engine.OpReverseUndismiss
|
||||||
|
if dismiss {
|
||||||
|
op = engine.OpReverseDismiss
|
||||||
|
}
|
||||||
|
return s.mutate(w, r, p, "", []engine.Request{engine.NewRequest(op, 0, in)}, nil)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
package server
|
package server
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"errors"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
@@ -14,14 +15,24 @@ import (
|
|||||||
"jarl/internal/stats"
|
"jarl/internal/stats"
|
||||||
)
|
)
|
||||||
|
|
||||||
// statsQuerier checks permission and that statistics are enabled.
|
// statsQuerier checks permission and that statistics are enabled. With
|
||||||
func (s *Server) statsQuerier(p *auth.Principal) (*stats.Querier, error) {
|
// ?views=internal,vps the figures are for those views only.
|
||||||
|
func (s *Server) statsQuerier(r *http.Request, p *auth.Principal) (*stats.Querier, error) {
|
||||||
if err := require(p, auth.Action{Resource: auth.ResStats}); err != nil {
|
if err := require(p, auth.Action{Resource: auth.ResStats}); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
if s.statsQ == nil {
|
if s.statsQ == nil {
|
||||||
return nil, &httpError{http.StatusNotFound, "stats_disabled", "query statistics are disabled; set stats.enabled: true in /etc/jarl/jarl.yaml and restart jarl (see docs/stats.md)"}
|
return nil, &httpError{http.StatusNotFound, "stats_disabled", "query statistics are disabled; set stats.enabled: true in /etc/jarl/jarl.yaml and restart jarl (see docs/stats.md)"}
|
||||||
}
|
}
|
||||||
|
var views []string
|
||||||
|
for _, v := range strings.Split(r.URL.Query().Get("views"), ",") {
|
||||||
|
if v = strings.TrimSpace(v); v != "" {
|
||||||
|
views = append(views, v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(views) > 0 {
|
||||||
|
return s.statsQ.ForViews(views), nil
|
||||||
|
}
|
||||||
return s.statsQ, nil
|
return s.statsQ, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -46,7 +57,7 @@ func (s *Server) statsStatus(w http.ResponseWriter, r *http.Request, p *auth.Pri
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s *Server) statsSummary(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
func (s *Server) statsSummary(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
q, err := s.statsQuerier(p)
|
q, err := s.statsQuerier(r, p)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -66,7 +77,7 @@ func (s *Server) statsSummary(w http.ResponseWriter, r *http.Request, p *auth.Pr
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s *Server) statsTop(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
func (s *Server) statsTop(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
q, err := s.statsQuerier(p)
|
q, err := s.statsQuerier(r, p)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -93,7 +104,7 @@ func (s *Server) statsTop(w http.ResponseWriter, r *http.Request, p *auth.Princi
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s *Server) statsTimeline(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
func (s *Server) statsTimeline(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
q, err := s.statsQuerier(p)
|
q, err := s.statsQuerier(r, p)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -124,7 +135,7 @@ func (s *Server) statsTimeline(w http.ResponseWriter, r *http.Request, p *auth.P
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s *Server) statsHeatmap(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
func (s *Server) statsHeatmap(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
q, err := s.statsQuerier(p)
|
q, err := s.statsQuerier(r, p)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -143,7 +154,7 @@ func (s *Server) statsHeatmap(w http.ResponseWriter, r *http.Request, p *auth.Pr
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s *Server) statsBreakdown(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
func (s *Server) statsBreakdown(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
q, err := s.statsQuerier(p)
|
q, err := s.statsQuerier(r, p)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -152,6 +163,9 @@ func (s *Server) statsBreakdown(w http.ResponseWriter, r *http.Request, p *auth.
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
es, err := q.Breakdown(r.Context(), r.URL.Query().Get("group"), since)
|
es, err := q.Breakdown(r.Context(), r.URL.Query().Get("group"), since)
|
||||||
|
if errors.Is(err, stats.ErrNotPerView) {
|
||||||
|
return &httpError{http.StatusBadRequest, "not_per_view", r.URL.Query().Get("group") + ": " + err.Error()}
|
||||||
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return badRequest("%v", err)
|
return badRequest("%v", err)
|
||||||
}
|
}
|
||||||
@@ -247,7 +261,7 @@ func clientNames(st *model.State, want map[netip.Addr]bool, readable func(*model
|
|||||||
// limits (rndc status), and the space left on the file systems Jarl and
|
// limits (rndc status), and the space left on the file systems Jarl and
|
||||||
// named write to.
|
// named write to.
|
||||||
func (s *Server) statsServer(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
func (s *Server) statsServer(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
if _, err := s.statsQuerier(p); err != nil {
|
if _, err := s.statsQuerier(r, p); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
out := map[string]any{"server": s.cfg.Stats.Server()}
|
out := map[string]any{"server": s.cfg.Stats.Server()}
|
||||||
@@ -269,6 +283,72 @@ func (s *Server) statsServer(w http.ResponseWriter, r *http.Request, p *auth.Pri
|
|||||||
labels = append(labels, "statistics database")
|
labels = append(labels, "statistics database")
|
||||||
}
|
}
|
||||||
out["disks"] = stats.DiskUsage(labels, dirs)
|
out["disks"] = stats.DiskUsage(labels, dirs)
|
||||||
|
// The statistics database: what the statistics cost on disk.
|
||||||
|
if db := s.cfg.Stats.Store().Path(); db != "" && db != ":memory:" {
|
||||||
|
info := map[string]any{"path": db, "bytes": dbBytes(db)}
|
||||||
|
if keep := s.cfg.Stats.Options().RetainQueries; keep > 0 && s.cfg.Stats.Options().QueryLog {
|
||||||
|
if n, err := s.cfg.Stats.Store().QueryLogSize(r.Context()); err == nil {
|
||||||
|
info["query_log_rows"] = n
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out["database"] = info
|
||||||
|
}
|
||||||
|
writeJSON(w, http.StatusOK, out)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// statsExplore: GET /stats/explore?client=&name=&domain=&view=&type=&rcode=
|
||||||
|
// &blocked=&since=24h explores the query log (docs/stats.md#exploring):
|
||||||
|
// totals, a series, the top values of each dimension left open, and the
|
||||||
|
// latest answers, with client host names.
|
||||||
|
func (s *Server) statsExplore(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
q, err := s.statsQuerier(r, p)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
since, err := statsSince(r)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
v := r.URL.Query()
|
||||||
|
f := stats.ExploreFilter{Client: v.Get("client"), Name: v.Get("name"), Domain: v.Get("domain"), View: v.Get("view"),
|
||||||
|
Type: v.Get("type"), RCode: v.Get("rcode"), Blocked: v.Get("blocked"), Since: since}
|
||||||
|
ex, err := q.Explore(r.Context(), f, 15, 100)
|
||||||
|
if errors.Is(err, stats.ErrNoQueryLog) {
|
||||||
|
return &httpError{http.StatusNotFound, "query_log_off", err.Error()}
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := s.nameClients(r, p, ex.By["client"]); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
// The recent answers' clients, named once each.
|
||||||
|
var es []stats.Entry
|
||||||
|
seen := map[string]int{}
|
||||||
|
for _, row := range ex.Recent {
|
||||||
|
if _, ok := seen[row.Client]; !ok {
|
||||||
|
seen[row.Client] = len(es)
|
||||||
|
es = append(es, stats.Entry{Key: row.Client})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := s.nameClients(r, p, es); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
for i := range ex.Recent {
|
||||||
|
ex.Recent[i].ClientName = es[seen[ex.Recent[i].Client]].Name
|
||||||
|
}
|
||||||
|
// The filter's client, named too.
|
||||||
|
out := struct {
|
||||||
|
*stats.Exploration
|
||||||
|
ClientName string `json:"client_name,omitempty"`
|
||||||
|
}{Exploration: ex}
|
||||||
|
if f.Client != "" {
|
||||||
|
one := []stats.Entry{{Key: f.Client}}
|
||||||
|
if err := s.nameClients(r, p, one); err == nil {
|
||||||
|
out.ClientName = one[0].Name
|
||||||
|
}
|
||||||
|
}
|
||||||
writeJSON(w, http.StatusOK, out)
|
writeJSON(w, http.StatusOK, out)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,79 @@
|
|||||||
|
package server
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"slices"
|
||||||
|
|
||||||
|
"jarl/internal/api"
|
||||||
|
"jarl/internal/stats"
|
||||||
|
)
|
||||||
|
|
||||||
|
// storage reports the size of Jarl's databases and how full the disks
|
||||||
|
// Jarl uses are (the dashboard's Storage card).
|
||||||
|
func (s *Server) storage(ctx context.Context) *api.Storage {
|
||||||
|
out := &api.Storage{Databases: []api.Database{}, Disks: []api.Disk{}}
|
||||||
|
dbFile := func(label, path string) *api.Database {
|
||||||
|
if path == "" || path == ":memory:" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
d := api.Database{Label: label, Path: path, Bytes: dbBytes(path)}
|
||||||
|
out.Databases = append(out.Databases, d)
|
||||||
|
out.Total += d.Bytes
|
||||||
|
return &out.Databases[len(out.Databases)-1]
|
||||||
|
}
|
||||||
|
labels := []string{}
|
||||||
|
dirs := map[string]string{}
|
||||||
|
add := func(label, dir string) {
|
||||||
|
if dir != "" {
|
||||||
|
labels = append(labels, label)
|
||||||
|
dirs[label] = dir
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const jarlDB, statsDB = "Jarl's database", "statistics database"
|
||||||
|
if p := s.store.Path(); p != "" {
|
||||||
|
dbFile(jarlDB, p)
|
||||||
|
add(jarlDB, filepath.Dir(p))
|
||||||
|
}
|
||||||
|
if s.cfg.Stats != nil {
|
||||||
|
if p := s.cfg.Stats.Store().Path(); p != "" && p != ":memory:" {
|
||||||
|
if d := dbFile(statsDB, p); d != nil && s.cfg.Stats.Options().RetainQueries > 0 {
|
||||||
|
if n, err := s.cfg.Stats.Store().QueryLogSize(ctx); err == nil {
|
||||||
|
d.QueryLogRows = &n
|
||||||
|
d.QueryLogRetention = s.cfg.Stats.Status().Retention.Queries
|
||||||
|
}
|
||||||
|
}
|
||||||
|
add(statsDB, filepath.Dir(p))
|
||||||
|
}
|
||||||
|
if lf := s.cfg.Stats.Options().LogFile; lf != "" {
|
||||||
|
add("named's logs", filepath.Dir(lf))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
paths := s.eng.Config().Paths
|
||||||
|
add("zone files", paths.ZoneDir)
|
||||||
|
add("named.conf", paths.ConfigDir)
|
||||||
|
add("Jarl's cache and blocklists", paths.CacheDir)
|
||||||
|
add("backups", s.cfg.BackupDir)
|
||||||
|
for _, d := range stats.DiskUsage(labels, dirs) {
|
||||||
|
disk := api.Disk{Path: d.Path, Holds: d.Holds, Total: d.Total, Free: d.Free}
|
||||||
|
for _, db := range out.Databases {
|
||||||
|
if slices.Contains(d.Holds, db.Label) {
|
||||||
|
disk.Databases += db.Bytes
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out.Disks = append(out.Disks, disk)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// dbBytes is the size of a SQLite database: its file, -wal and -shm.
|
||||||
|
func dbBytes(path string) int64 {
|
||||||
|
var n int64
|
||||||
|
for _, suffix := range []string{"", "-wal", "-shm"} {
|
||||||
|
if fi, err := os.Stat(path + suffix); err == nil {
|
||||||
|
n += fi.Size()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return n
|
||||||
|
}
|
||||||
@@ -157,6 +157,37 @@ func (s *Server) deleteZone(w http.ResponseWriter, r *http.Request, p *auth.Prin
|
|||||||
return s.mutate(w, r, p, "", []engine.Request{request(engine.OpZoneDelete, z.ID, nil)}, nil)
|
return s.mutate(w, r, p, "", []engine.Request{request(engine.OpZoneDelete, z.ID, nil)}, nil)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// zoneLink: POST /zones/{zone}/link {"with": ["external"]} links the zone
|
||||||
|
// with the zones of the same name in those views (default: every view
|
||||||
|
// that has one). zoneUnlink: POST /zones/{zone}/unlink.
|
||||||
|
func (s *Server) zoneLink(link bool) handler {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
|
st, err := s.state(r)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
z, err := s.zoneByPath(r, st, p)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
in := engine.LinkInput{ZoneID: z.ID}
|
||||||
|
op := engine.OpZoneUnlink
|
||||||
|
if link {
|
||||||
|
op = engine.OpZoneLink
|
||||||
|
var body struct {
|
||||||
|
With []string `json:"with"`
|
||||||
|
}
|
||||||
|
if r.ContentLength != 0 {
|
||||||
|
if err := decodeJSON(r, &body); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
in.With = body.With
|
||||||
|
}
|
||||||
|
return s.mutate(w, r, p, "", []engine.Request{engine.NewRequest(op, 0, in)}, nil)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func (s *Server) zoneFile(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
func (s *Server) zoneFile(w http.ResponseWriter, r *http.Request, p *auth.Principal) error {
|
||||||
st, err := s.state(r)
|
st, err := s.state(r)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -462,11 +493,12 @@ func (s *Server) putRRSet(w http.ResponseWriter, r *http.Request, p *auth.Princi
|
|||||||
TTL model.Opt[uint32] `json:"ttl,omitzero"`
|
TTL model.Opt[uint32] `json:"ttl,omitzero"`
|
||||||
Data []string `json:"data"`
|
Data []string `json:"data"`
|
||||||
Comment *string `json:"comment,omitempty"`
|
Comment *string `json:"comment,omitempty"`
|
||||||
|
Local *bool `json:"local,omitempty"`
|
||||||
}
|
}
|
||||||
if err := decodeJSON(r, &in); err != nil {
|
if err := decodeJSON(r, &in); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
req := engine.NewRequest(engine.OpRRSetReplace, 0, engine.RRSetInput{ZoneID: z.ID, Name: r.PathValue("name"), Type: r.PathValue("type"), TTL: in.TTL, Data: in.Data, Comment: in.Comment})
|
req := engine.NewRequest(engine.OpRRSetReplace, 0, engine.RRSetInput{ZoneID: z.ID, Name: r.PathValue("name"), Type: r.PathValue("type"), TTL: in.TTL, Data: in.Data, Comment: in.Comment, Local: in.Local})
|
||||||
zid, name, typ := z.ID, r.PathValue("name"), strings.ToUpper(r.PathValue("type"))
|
zid, name, typ := z.ID, r.PathValue("name"), strings.ToUpper(r.PathValue("type"))
|
||||||
return s.mutate(w, r, p, "", []engine.Request{req}, func(st *model.State, _ int64) any {
|
return s.mutate(w, r, p, "", []engine.Request{req}, func(st *model.State, _ int64) any {
|
||||||
z := st.Zones[zid]
|
z := st.Zones[zid]
|
||||||
|
|||||||
@@ -274,6 +274,35 @@ func (s *Server) collectState(ctx context.Context, pw *promWriter, now time.Time
|
|||||||
"zone", engine.Display(z.Name), "view", state.ViewName(z), "phase", ph.Code)
|
"zone", engine.Display(z.Name), "view", state.ViewName(z), "phase", ph.Code)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if s.cfg.Certs != nil {
|
||||||
|
if list, err := s.cfg.Certs.List(ctx); err == nil {
|
||||||
|
for _, c := range list {
|
||||||
|
if c.NotAfter != nil {
|
||||||
|
pw.gauge("jarl_certificate_expiry_timestamp_seconds", "When each certificate Jarl manages expires (Unix time; docs/certificates.md).", unix(*c.NotAfter), "certificate", c.Name, "source", c.Source)
|
||||||
|
}
|
||||||
|
st := s.cfg.Certs.StatusOf(c)
|
||||||
|
pw.gauge("jarl_certificate_failing", "1 when obtaining or reading a certificate failed the last time.", b2f(st.State == "failing" || st.State == "expired"), "certificate", c.Name, "source", c.Source)
|
||||||
|
if c.Source == model.CertSourceACME {
|
||||||
|
pw.gauge("jarl_certificate_renewal_failures", "Failed attempts to obtain the certificate since the last success.", float64(c.Failures), "certificate", c.Name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if h := s.encryptedDNSHealth(); h != nil {
|
||||||
|
for _, pr := range h.Probes {
|
||||||
|
pw.gauge("jarl_encrypted_dns_up", "1 when the DNS over TLS or HTTPS listener answered with the right, current certificate at the last check (every 10 minutes).", b2f(pr.OK),
|
||||||
|
"kind", pr.Kind, "address", pr.Address, "port", strconv.Itoa(pr.Port))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if m := s.mailReport(); m != nil {
|
||||||
|
for _, r := range m.Results {
|
||||||
|
pw.gauge("jarl_mail_reverse_dns_ok", "1 when an address that sends or receives a public zone's mail has a PTR record that resolves back to it, at the last check (every 6 hours).", b2f(r.OK),
|
||||||
|
"zone", r.Zone, "address", r.Address)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if tokens, err := s.store.ListTokens(ctx, 0); err == nil {
|
if tokens, err := s.store.ListTokens(ctx, 0); err == nil {
|
||||||
for _, t := range tokens {
|
for _, t := range tokens {
|
||||||
if t.ExpiresAt != nil && t.RevokedAt == nil {
|
if t.ExpiresAt != nil && t.RevokedAt == nil {
|
||||||
@@ -297,6 +326,7 @@ var counterMetrics = map[string]struct{ name, label, help string }{
|
|||||||
"answer": {"jarl_answers_total", "source", "Answers that were authoritative or not (recursive)."},
|
"answer": {"jarl_answers_total", "source", "Answers that were authoritative or not (recursive)."},
|
||||||
"transport": {"jarl_queries_by_transport_total", "transport", "Queries over UDP and TCP."},
|
"transport": {"jarl_queries_by_transport_total", "transport", "Queries over UDP and TCP."},
|
||||||
"ratelimit": {"jarl_ratelimit_responses_total", "action", "Responses rate limiting dropped or slipped (truncated)."},
|
"ratelimit": {"jarl_ratelimit_responses_total", "action", "Responses rate limiting dropped or slipped (truncated)."},
|
||||||
|
"rrl": {"jarl_ratelimit_logged_total", "action", "Rate limited responses from named's log: drop and slip, or would-drop and would-slip in log-only mode."},
|
||||||
"rtt": {"jarl_upstream_responses_by_rtt_total", "rtt", "Responses from other servers during recursion, by round-trip time."},
|
"rtt": {"jarl_upstream_responses_by_rtt_total", "rtt", "Responses from other servers during recursion, by round-trip time."},
|
||||||
"dnssec": {"jarl_dnssec_validations_total", "result", "DNSSEC validations of recursive answers by result."},
|
"dnssec": {"jarl_dnssec_validations_total", "result", "DNSSEC validations of recursive answers by result."},
|
||||||
"cache": {"jarl_cache_lookups_total", "result", "Cache lookups that hit or missed."},
|
"cache": {"jarl_cache_lookups_total", "result", "Cache lookups that hit or missed."},
|
||||||
|
|||||||
@@ -22,6 +22,23 @@ func (s *Server) presentZone(st *model.State, z *model.Zone, counts map[int64]re
|
|||||||
out.RName = dnsname.EmailFromMailbox(z.SOA.RName)
|
out.RName = dnsname.EmailFromMailbox(z.SOA.RName)
|
||||||
}
|
}
|
||||||
out.Registrar = s.registrarFor(z)
|
out.Registrar = s.registrarFor(z)
|
||||||
|
if z.Type == model.ZonePrimary && z.ViewID != 0 {
|
||||||
|
for _, o := range st.ZonesNamed(z.Name) {
|
||||||
|
if o.ID != z.ID && o.Type == model.ZonePrimary {
|
||||||
|
out.OtherViews = append(out.OtherViews, st.ViewName(o))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if pf, ok := dnsname.PrefixFromReverse(z.Name); ok {
|
||||||
|
out.Prefix = pf.String()
|
||||||
|
if z.Type == model.ZonePrimary {
|
||||||
|
out.PTRMissing = len(engine.PTRFills(st, z.ViewID, z.Name, st.ZoneRecords(z.ID)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, o := range st.LinkedWith(z) {
|
||||||
|
out.LinkedWith = append(out.LinkedWith, st.ViewName(o))
|
||||||
|
out.Links = append(out.Links, api.ZoneLink{ID: o.ID, View: st.ViewName(o)})
|
||||||
|
}
|
||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -30,6 +47,12 @@ func presentRecord(st *model.State, r *model.Record) api.Record {
|
|||||||
out := api.Record{Record: *r}
|
out := api.Record{Record: *r}
|
||||||
if z != nil {
|
if z != nil {
|
||||||
out.Zone, out.View, out.RelativeName, out.EffectiveTTL = z.Name, st.ViewName(z), dnsname.Relative(r.Name, z.Name), r.EffectiveTTL(z)
|
out.Zone, out.View, out.RelativeName, out.EffectiveTTL = z.Name, st.ViewName(z), dnsname.Relative(r.Name, z.Name), r.EffectiveTTL(z)
|
||||||
|
if z.LinkGroup != 0 {
|
||||||
|
out.Linked = "local"
|
||||||
|
if r.SharedID != 0 {
|
||||||
|
out.Linked = "shared"
|
||||||
|
}
|
||||||
|
}
|
||||||
if rr.IsTextType(r.Type) {
|
if rr.IsTextType(r.Type) {
|
||||||
if p, err := rr.Parse(z.Name, r.Name, r.Type, r.Data); err == nil {
|
if p, err := rr.Parse(z.Name, r.Name, r.Type, r.Data); err == nil {
|
||||||
if t, ok := rr.TextValue(p.RR); ok {
|
if t, ok := rr.TextValue(p.RR); ok {
|
||||||
@@ -101,7 +124,7 @@ func presentOption(st *model.State, o *model.Option) api.Option {
|
|||||||
if c, ok := catalog.Default().Lookup(scope, o.Name); ok {
|
if c, ok := catalog.Default().Lookup(scope, o.Name); ok {
|
||||||
out.Description, out.Status = c.Description, c.Status
|
out.Description, out.Status = c.Description, c.Status
|
||||||
}
|
}
|
||||||
if f := namedconf.FormatValue(o.Name, o.Value); f != o.Value {
|
if f := namedconf.FormatValueList(o.Name, o.Value, 3); f != o.Value {
|
||||||
out.Formatted = f
|
out.Formatted = f
|
||||||
}
|
}
|
||||||
return out
|
return out
|
||||||
|
|||||||
@@ -62,7 +62,7 @@ func engineStatus(k engine.ErrorKind) int {
|
|||||||
return http.StatusForbidden
|
return http.StatusForbidden
|
||||||
case engine.KindNotFound:
|
case engine.KindNotFound:
|
||||||
return http.StatusNotFound
|
return http.StatusNotFound
|
||||||
case engine.KindConflict, engine.KindDrift, engine.KindNotAdopted:
|
case engine.KindConflict, engine.KindDrift, engine.KindNotAdopted, engine.KindRisk:
|
||||||
return http.StatusConflict
|
return http.StatusConflict
|
||||||
case engine.KindValidation:
|
case engine.KindValidation:
|
||||||
return http.StatusUnprocessableEntity
|
return http.StatusUnprocessableEntity
|
||||||
|
|||||||
@@ -111,6 +111,13 @@ func (s *Server) routes() {
|
|||||||
m.HandleFunc("DELETE "+p+"/zones/{zone}/registrar/ds/{keytag}", s.authed(s.registrarRemoveDS))
|
m.HandleFunc("DELETE "+p+"/zones/{zone}/registrar/ds/{keytag}", s.authed(s.registrarRemoveDS))
|
||||||
m.HandleFunc("PUT "+p+"/zones/{zone}/registrar/ns", s.authed(s.registrarSetNS))
|
m.HandleFunc("PUT "+p+"/zones/{zone}/registrar/ns", s.authed(s.registrarSetNS))
|
||||||
m.HandleFunc("GET "+p+"/zones/{zone}/file", s.authed(s.zoneFile))
|
m.HandleFunc("GET "+p+"/zones/{zone}/file", s.authed(s.zoneFile))
|
||||||
|
m.HandleFunc("GET "+p+"/zones/{zone}/compare", s.authed(s.zoneCompare))
|
||||||
|
m.HandleFunc("POST "+p+"/zones/{zone}/link", s.authed(s.zoneLink(true)))
|
||||||
|
m.HandleFunc("POST "+p+"/zones/{zone}/unlink", s.authed(s.zoneLink(false)))
|
||||||
|
m.HandleFunc("POST "+p+"/zones/{zone}/fill-ptr", s.authed(s.zoneFillPTR))
|
||||||
|
m.HandleFunc("GET "+p+"/reverse-zones/suggestions", s.authed(s.reverseSuggestions))
|
||||||
|
m.HandleFunc("POST "+p+"/reverse-zones/dismiss", s.authed(s.reverseDismiss(true)))
|
||||||
|
m.HandleFunc("POST "+p+"/reverse-zones/undismiss", s.authed(s.reverseDismiss(false)))
|
||||||
m.HandleFunc("POST "+p+"/zones/{zone}/import", s.authed(s.importZoneFile))
|
m.HandleFunc("POST "+p+"/zones/{zone}/import", s.authed(s.importZoneFile))
|
||||||
m.HandleFunc("GET "+p+"/zones/{zone}/records", s.authed(s.listRecords))
|
m.HandleFunc("GET "+p+"/zones/{zone}/records", s.authed(s.listRecords))
|
||||||
m.HandleFunc("POST "+p+"/zones/{zone}/records", s.authed(s.createRecord))
|
m.HandleFunc("POST "+p+"/zones/{zone}/records", s.authed(s.createRecord))
|
||||||
@@ -126,6 +133,7 @@ func (s *Server) routes() {
|
|||||||
m.HandleFunc("POST "+p+"/records/{id}/enable", s.authed(s.setRecordDisabled(false)))
|
m.HandleFunc("POST "+p+"/records/{id}/enable", s.authed(s.setRecordDisabled(false)))
|
||||||
// Options and settings
|
// Options and settings
|
||||||
m.HandleFunc("GET "+p+"/options", s.authed(s.listOptions))
|
m.HandleFunc("GET "+p+"/options", s.authed(s.listOptions))
|
||||||
|
m.HandleFunc("GET "+p+"/options/generated", s.authed(s.generatedOptions))
|
||||||
m.HandleFunc("POST "+p+"/options", s.authed(s.createOption))
|
m.HandleFunc("POST "+p+"/options", s.authed(s.createOption))
|
||||||
m.HandleFunc("GET "+p+"/options/{id}", s.authed(s.getOption))
|
m.HandleFunc("GET "+p+"/options/{id}", s.authed(s.getOption))
|
||||||
m.HandleFunc("PATCH "+p+"/options/{id}", s.authed(s.updateOption))
|
m.HandleFunc("PATCH "+p+"/options/{id}", s.authed(s.updateOption))
|
||||||
@@ -162,6 +170,24 @@ func (s *Server) routes() {
|
|||||||
m.HandleFunc("POST "+p+"/acme/httpreq/view/{view}/present", s.httpreq(true))
|
m.HandleFunc("POST "+p+"/acme/httpreq/view/{view}/present", s.httpreq(true))
|
||||||
m.HandleFunc("POST "+p+"/acme/httpreq/view/{view}/cleanup", s.httpreq(false))
|
m.HandleFunc("POST "+p+"/acme/httpreq/view/{view}/cleanup", s.httpreq(false))
|
||||||
// Query statistics
|
// Query statistics
|
||||||
|
m.HandleFunc("GET "+p+"/certificates", s.authed(s.certList))
|
||||||
|
m.HandleFunc("POST "+p+"/certificates", s.authed(s.certCreate))
|
||||||
|
m.HandleFunc("POST "+p+"/certificates/check", s.authed(s.certCheck))
|
||||||
|
m.HandleFunc("GET "+p+"/certificates/{name}", s.authed(s.certGet))
|
||||||
|
m.HandleFunc("PATCH "+p+"/certificates/{name}", s.authed(s.certUpdate))
|
||||||
|
m.HandleFunc("DELETE "+p+"/certificates/{name}", s.authed(s.certDelete))
|
||||||
|
m.HandleFunc("POST "+p+"/certificates/{name}/issue", s.authed(s.certIssue))
|
||||||
|
m.HandleFunc("POST "+p+"/certificates/{name}/check", s.authed(s.certCheck))
|
||||||
|
m.HandleFunc("GET "+p+"/encrypted-dns", s.authed(s.encryptedDNS))
|
||||||
|
m.HandleFunc("POST "+p+"/encrypted-dns", s.authed(s.encryptedDNSSetup))
|
||||||
|
m.HandleFunc("DELETE "+p+"/encrypted-dns", s.authed(s.encryptedDNSDisable))
|
||||||
|
m.HandleFunc("POST "+p+"/encrypted-dns/check", s.authed(s.encryptedDNSCheck))
|
||||||
|
m.HandleFunc("POST "+p+"/encrypted-dns/health", s.authed(s.encryptedDNSCheckNow))
|
||||||
|
m.HandleFunc("GET "+p+"/exposure", s.authed(s.exposure))
|
||||||
|
m.HandleFunc("POST "+p+"/exposure/fix", s.authed(s.exposureFix))
|
||||||
|
m.HandleFunc("POST "+p+"/exposure/mail", s.authed(s.mailCheckNow))
|
||||||
|
m.HandleFunc("POST "+p+"/exposure/ack", s.authed(s.exposureAck(true)))
|
||||||
|
m.HandleFunc("POST "+p+"/exposure/unack", s.authed(s.exposureAck(false)))
|
||||||
m.HandleFunc("GET "+p+"/stats/status", s.authed(s.statsStatus))
|
m.HandleFunc("GET "+p+"/stats/status", s.authed(s.statsStatus))
|
||||||
m.HandleFunc("GET "+p+"/stats/summary", s.authed(s.statsSummary))
|
m.HandleFunc("GET "+p+"/stats/summary", s.authed(s.statsSummary))
|
||||||
m.HandleFunc("GET "+p+"/stats/top", s.authed(s.statsTop))
|
m.HandleFunc("GET "+p+"/stats/top", s.authed(s.statsTop))
|
||||||
@@ -169,6 +195,7 @@ func (s *Server) routes() {
|
|||||||
m.HandleFunc("GET "+p+"/stats/heatmap", s.authed(s.statsHeatmap))
|
m.HandleFunc("GET "+p+"/stats/heatmap", s.authed(s.statsHeatmap))
|
||||||
m.HandleFunc("GET "+p+"/stats/breakdown", s.authed(s.statsBreakdown))
|
m.HandleFunc("GET "+p+"/stats/breakdown", s.authed(s.statsBreakdown))
|
||||||
m.HandleFunc("GET "+p+"/stats/server", s.authed(s.statsServer))
|
m.HandleFunc("GET "+p+"/stats/server", s.authed(s.statsServer))
|
||||||
|
m.HandleFunc("GET "+p+"/stats/explore", s.authed(s.statsExplore))
|
||||||
m.HandleFunc(p+"/", func(w http.ResponseWriter, r *http.Request) {
|
m.HandleFunc(p+"/", func(w http.ResponseWriter, r *http.Request) {
|
||||||
writeError(w, http.StatusNotFound, "not_found", "no such API endpoint: "+r.Method+" "+r.URL.Path)
|
writeError(w, http.StatusNotFound, "not_found", "no such API endpoint: "+r.Method+" "+r.URL.Path)
|
||||||
})
|
})
|
||||||
@@ -239,6 +266,11 @@ func changesetTarget(r *http.Request) (int64, error) {
|
|||||||
// mutate applies (or stages, or previews) requests and writes the
|
// mutate applies (or stages, or previews) requests and writes the
|
||||||
// response. object, if set, returns the resulting object to include.
|
// response. object, if set, returns the resulting object to include.
|
||||||
func (s *Server) mutate(w http.ResponseWriter, r *http.Request, p *auth.Principal, description string, reqs []engine.Request, object func(st *model.State, created int64) any) error {
|
func (s *Server) mutate(w http.ResponseWriter, r *http.Request, p *auth.Principal, description string, reqs []engine.Request, object func(st *model.State, created int64) any) error {
|
||||||
|
return s.mutateNotes(w, r, p, description, reqs, object, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
// mutateNotes is mutate with notes for the user, shown as warnings.
|
||||||
|
func (s *Server) mutateNotes(w http.ResponseWriter, r *http.Request, p *auth.Principal, description string, reqs []engine.Request, object func(st *model.State, created int64) any, notes []string) error {
|
||||||
csID, err := changesetTarget(r)
|
csID, err := changesetTarget(r)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -249,16 +281,16 @@ func (s *Server) mutate(w http.ResponseWriter, r *http.Request, p *auth.Principa
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
res.Changeset.Ops = engine.RedactOps(res.Changeset.Ops)
|
res.Changeset.Ops = engine.RedactOps(res.Changeset.Ops)
|
||||||
writeJSON(w, http.StatusAccepted, api.MutationResponse{Staged: true, ChangesetID: csID, Changeset: raw(res.Changeset), Added: engine.RedactOps(res.Added), Warnings: res.Warnings, Problems: raw(res.Problems)})
|
writeJSON(w, http.StatusAccepted, api.MutationResponse{Staged: true, ChangesetID: csID, Changeset: raw(res.Changeset), Added: engine.RedactOps(res.Added), Warnings: append(notes, res.Warnings...), Problems: raw(res.Problems)})
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
opts := engine.ApplyOptions{DryRun: queryBool(r, "dry_run"), Force: queryBool(r, "force")}
|
opts := engine.ApplyOptions{DryRun: queryBool(r, "dry_run"), Force: queryBool(r, "force"), AcceptRisk: queryBool(r, "accept_risk")}
|
||||||
res, err := s.eng.Submit(r.Context(), reqs, p, via(r, p), description, opts)
|
res, err := s.eng.Submit(r.Context(), reqs, p, via(r, p), description, opts)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
s.writeErr(w, r, err, res)
|
s.writeErr(w, r, err, res)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
out := api.MutationResponse{Applied: res.Applied, DryRun: res.DryRun, ChangesetID: res.ChangesetID, Result: raw(res), Warnings: res.Warnings}
|
out := api.MutationResponse{Applied: res.Applied, DryRun: res.DryRun, ChangesetID: res.ChangesetID, Result: raw(res), Warnings: append(notes, res.Warnings...)}
|
||||||
if object != nil && res.Applied {
|
if object != nil && res.Applied {
|
||||||
st, err := s.store.LoadState(r.Context())
|
st, err := s.store.LoadState(r.Context())
|
||||||
if err == nil {
|
if err == nil {
|
||||||
|
|||||||
Loaded 100 of 135 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user