jarl/CHANGELOG.md

Changelog

All notable changes to Jarl are documented here. The format follows Keep a Changelog, and versions follow Semantic Versioning.

[Unreleased]

The first version, to be released as 0.1.0.

Added

• jarld daemon: REST API (/api/v1) and embedded web UI, with SQLite as the source of truth for the whole BIND configuration. Runs under systemd (Type=notify, sandboxed, unprivileged jarl user in group bind). SIGHUP and certificate file changes reload TLS.
• Configuration model: views (ordered, match-clients/destinations, recursive-only), ACLs (nested, negation, keys, reference tracking with rename and delete protection), TSIG keys (kept in a separate keys.conf, never in diffs), zones of every type (primary, secondary, stub, static-stub, forward, mirror, hint, redirect, in-view), reverse zones from a CIDR, records of every type, options at server, view, zone and top-level scope, and defaults for new zones.
• BIND 9.20 option catalog: all 353 statements with grammar, allowed scopes, value kinds, deprecation status and ARM descriptions, used for validation and by the UI's option editor.
• Changesets: immediate one-operation changes by default; staging into named changesets (?changeset=, X-Jarl-Changeset, --changeset), batches (POST /apply, jarl apply -f), dry runs, previews with diffs, and revert of applied changesets. Optimistic locking with object versions.
• Apply pipeline: whole-configuration validation, rendering, named-checkconf -z and named-checkzone in a staging directory, atomic install, rndc reconfig and per-zone reload, verification with rndc zonestatus, and automatic rollback when named doesn't load the change. Automatic serials (date, increment or unixtime policy, RFC 1982), bumped only when DNS data changes. Drift detection for files changed outside Jarl.
• Validation: CNAME/DNAME rules, NS/MX/SRV targets, glue and delegations, RRset TTL consistency, BIND 9.20 RRset/type limits, SPF/DMARC sanity, ACL/key references and cycles, option syntax and scope, and security lints (open resolver, open zone transfers, dynamic updates on managed zones).
• Records: TXT entered as plain text (automatic quoting and 255-byte splitting), relative and absolute names with detection of doubled origins, PTR records kept in step with A/AAAA (ptr), RRset replace, delete by match, zone file import (merge or replace).
• Import and adoption: jarld import reads an existing named.conf tree and zone files (comments, $INCLUDE, $GENERATE, legacy master/slave spellings); jarld adopt switches named to Jarl's configuration with a backup and automatic fallback.
• Authentication: web logins with argon2id passwords, sessions (HttpOnly, SameSite=Strict) and CSRF tokens, rate limiting per user and IP; hashed API tokens (jarl_...) with optional expiry.
• Permissions: granular grants (resource × read/write, filtered by zone, view, record name pattern and type), roles (readonly, dns-editor, operator, acme), tokens restricted to a subset of their user's rights, administrators.
• Audit log of logins, changes, users, tokens and secret reveals, with user, token, IP and outcome, searchable and written to the journal.
• Web UI: dashboard, zones and records with inline editing and pending markers, views, ACLs, TSIG keys, the option editor, review and apply, history with revert, audit log, users, account and tokens, search. Review mode by default, with an "apply immediately" switch.
• jarl CLI: zones, records, views, ACLs, TSIG keys, options, settings, changesets, batches, history, users, tokens, audit, search, status, check and resync. Table, JSON and YAML output, and documented exit codes.
• ACME DNS-01: jarl acme set|unset, certbot hooks (jarl acme certbot-auth|certbot-cleanup), an acme.sh DNS API hook (contrib/acme.sh/dns_jarl.sh), automatic zone and view discovery, idempotent retries, and --follow-cname / --resolver for a dedicated ACME zone.
• Operations: jarld backup (online), jarld resync, jarld check, jarld render, local user recovery commands, audit retention.
• Packaging: Makefile (build, test, e2e, install, dist), systemd unit, sysusers.d and tmpfiles.d files, example configuration (jarld config --example).
• Tests: unit tests for every package, integration tests against the real named 9.20 (checkers, reload and rollback, import and adopt), and an end-to-end script (scripts/e2e.sh) that drives every CLI command against a running named.
• Documentation: concepts, install and adoption, configuration, CLI, API, permissions, ACME, validation, operations and development guides.