Skip to content

Latest commit

 

History

History
309 lines (274 loc) · 17.5 KB

CHANGELOG.md

File metadata and controls

309 lines (274 loc) · 17.5 KB

Changelog

All notable changes are documented here. Backfort follows semantic versioning once a release is tagged.

Unreleased

Documentation

  • Published the Python 1.4.0 wheel and sdist from the unchanged release tag through Trusted Publishing; verified artifact hashes and a fresh PyPI installation with real recovery. Updated current installation examples and the publication runbook to keep distribution channels aligned.
  • Recorded published 1.4.0 GHCR/Docker Hub multiarch digests, successful release CI and complete scans of all four published variants. Added an exact Docker Hub pin example so deployments can use the verified registry index.

1.4.0

Security

  • Rebased the container runtime on digest-pinned Debian trixie-slim and replaced GNU awk with explicit POSIX mawk. Preserved GNU tar recovery fidelity, GnuPG, SMTP and every supported backup feature; build/image tests reject installed gawk. All external Dockerfile stages are pinned by digest.
  • Removed CVE-2026-40468, CVE-2026-40469, CVE-2025-7458, CVE-2026-58016 and CVE-2023-45853. Full Trivy 0.75 vulnerability/secret scans on both amd64 and arm64 report C/H/M/L/U 0/63/119/171/3 versus 8/107/215/192/6 in 1.2.0, with zero secret findings and no vulnerability exceptions.
  • Disclosed the newly introduced, unfixed HIGH CVE-2026-24882 in seven GnuPG packages and every remaining HIGH group in the complete verification report.

Changed

  • Synchronized application version 1.4.0, Compose image 1.4.0 and Helm chart 0.1.1 / appVersion 1.4.0. CLI, YAML schema and backup formats are unchanged. Python distribution metadata derives the same version; PyPI publication remains a separate operation.

Tests

  • Added real age/GPG encryption, Minisign signing and files backup/full verify/ staged restore with ACLs, xattrs and numeric ownership to image smoke tests. Both image architectures pass, including non-root CI callers.
  • Added a separate development layer for the full 29-driver shell suite on the new amd64 runtime, including real Compose PostgreSQL/MySQL recovery.
  • Corrected test-only temporary-directory permissions, Compose-timeout fixture cleanup and client startup allowance, caller-owned bind mountpoints, and SIGPIPE-prone version display pipelines under QEMU.

Documentation

  • Added the trixie/mawk runtime ADR and complete security verification report; refreshed Docker/Kubernetes guidance and current image examples.
  • Added a dynamic PyPI version badge linking to the published package and expanded direct CLI pipx/virtual-environment usage examples.

1.3.0

Added

  • Optional Python 3.11+ Linux distribution with backfort, python -m backfort and checkout-local run_backfort.py entry points. The package bundles the canonical Bash engine and example YAML; it has no Python runtime dependencies and does not replace or download system tools.
  • Standalone --print-example-config for emitting the bundled reference YAML, including on Windows/macOS. Backup execution remains Linux-only.
  • Hatchling wheel/sdist builds with one Bash-derived version, explicit source archive contents, canonical-resource integrity checks, isolated installation and sdist rebuild tests, plus a real installed-package Linux backup, full verification and staged recovery round trip.
  • Python CI for 3.11–3.14 on Linux and the native-Windows compatibility boundary, with complete launcher branch coverage, Ruff and strict Twine validation.
  • Separate manual TestPyPI/PyPI publishing using GitHub OIDC trusted publishers, matching release-tag/version/Changelog checks and index-specific environments. Ordinary CI never publishes packages; no permanent PyPI API token is required.
  • Python installation, dependency and privilege guidance in the README, dedicated PyPI project description, Wiki runbook and distribution ADR.

Changed

  • Synchronized the CLI, Python package metadata, Helm application version, Docker Compose image reference and current documentation examples to 1.3.0. The native CLI, YAML schema and backup/recovery format are unchanged.
  • Extended Dependabot to Python build/development dependencies and excluded local Python build environments and caches from Docker build contexts.
  • Included upstream maintenance updates since 1.2.0: rclone 1.75.2 and refreshed GitHub Actions supply-chain scanning dependencies.

Fixed

  • Removed a timing dependency from the unreadable-source recovery regression: it restores the exact leading-space fixture backup rather than an ambiguous latest when two versions share the same second-resolution creation time.

1.2.0

  • Fixed file-source tar transforms rewriting symbolic-link targets with the internal data/ prefix. New backups preserve relative, absolute and dangling link text while still prefixing archive members and hard-link references. Added recovery coverage for those links and explicit dereferencing. Existing bundles are not rewritten; create a fresh backup and inspect link targets when rehearsing recovery of an older bundle.

  • Added a Helm 3 deployment for Kubernetes 1.31+: explicit readonly PVC-file sources, persistent state/shared lock and optional local backup PVC, existing Secret references, suspended backup/prune CronJobs and manual verification or isolated restore Jobs. The chart grants no API/RBAC, Docker socket or host privileges and guards against source/state/backup/recovery claim overlap.

  • Added Kubernetes values examples, an operational Wiki runbook, architecture decision, rendering/safety tests and real-image kind integration with full metadata recovery, lock refusal, error paths and non-root round trips. A dedicated GitHub workflow repeats the checks. Native cluster discovery, CSI snapshots and database-Pod dump adapters remain outside this scope.

  • Added a first-class production Docker distribution. The Debian-based image keeps the GNU tar fidelity required for ACLs, xattrs, sparse files and numeric ownership; includes Backfort's optional runtime tools, Docker Compose client and rclone; and defaults to the one-shot doctor command.

  • Added a hardened Compose deployment example, container-aware YAML example, Docker smoke test, configuration/troubleshooting guidance and a dedicated Docker deployment Wiki runbook. Docker is an additional distribution method and preserves the native CLI, YAML and recovery-bundle contract.

  • Extended tag releases with multi-architecture (linux/amd64, linux/arm64) build-and-smoke checks and GHCR publication. Exact release tags are immutable; stable releases also update minor, major and latest aliases, include OCI metadata, provenance and SBOM attestations. Docker Hub mirroring is optional and requires its two explicit release secrets.

1.1.0

  • Fixed a silent data-loss defect: a file the archive process could not read (permission denied, an I/O error) no longer disappears quietly from a backup that is still reported as backup-succeeded. tar --create no longer runs with --ignore-failed-read; its own exit status now distinguishes a real read failure (fails the job) from the tolerated race of a file changing while it was being archived (still a warning-only success). This applies to file-source jobs and to Compose named-volume and bind-mount snapshots alike.
  • Fixed the archive sanitizer silently dropping a file or directory whose name merely started with a space: every archive member is transform- prefixed with the literal string data, which never itself starts with whitespace, so a leading space was never actually a parsing hazard for Backfort's own manifest. A name that genuinely cannot be represented (a literal newline, carriage return, or tab, or bytes that are not valid UTF-8) is still removed from the archive, but that removal now fails the job with a clear kind=pack message=unsupported-entries-removed log line instead of silently publishing an incomplete backup with only a warning.
  • Fixed compose database dump, restore, and named-volume snapshot commands so a timed-out command_timeout_seconds actually stops the process inside the container. Killing the host-side docker/docker compose client (which is all a host-side timeout wrapper alone can do) does not stop a process it started in the container's own PID namespace; the actual command is now also wrapped with an in-container timeout, so a runaway pg_dump, restore import, or volume tar is reliably reaped instead of continuing to run, orphaned, after Backfort gives up on it. This requires a timeout binary inside the database service image and the Compose volume helper image (present in the common Debian- and Alpine-based database and helper images).
  • Fixed the Telegram channel's plain-text retry so it can actually fire: curl --fail discarded the response body on Telegram's own HTTP error status for a rejected HTML message (for example an unescaped tag in a custom template), so the {"ok":false,...} payload the retry logic needed to see never reached it. notification_curl_post now reads the HTTP status explicitly instead of relying on curl --fail, so a rejected HTML alert is retried once as plain text as designed instead of being silently lost.

1.0.0

  • Added retention.min_keep, a positive per-destination recovery floor that defaults to one newest ordinary completed copy. GFS rotation and max_age_days never remove that floor.

  • Hardened local bundle durability: Backfort synchronizes required artifacts before publishing .complete, then synchronizes the marker and destination directory. Local deletion now removes .complete before payload evidence.

  • Moved symmetric-GPG and recovery-key passphrases from Bash here-strings to a pipe-backed file descriptor so older Bash versions do not materialize them in a temporary file.

  • Added per-file SHA-256 values for regular archive files in new manifests. Full verification and normal restore recompute them from the tar stream, detecting changed archive content even when an outer payload checksum was replaced. Older manifests remain compatible with their existing archive-level validation.

  • Added asymmetric GPG encryption with one or more exact public-key fingerprints. A backup writer needs only public keys; recovery uses the matching private key on a separate host. Symmetric GPG remains supported, and an optional recovery-only private-key passphrase environment variable supports unattended full verification and restore.

  • Added hermetic GPG configuration coverage and an integration test that proves a public-key-only writer can create a backup restored by a separate private keyring.

  • Added restore-compose for verified, staged Docker Compose recovery. It prints recovery actions by default and can import PostgreSQL, MySQL, and MariaDB logical dumps into an existing running target project only with explicit --project-dir --apply --confirm safeguards. It never deploys files, restores volumes, starts services, applies PostgreSQL global roles, or guesses MS SQL/Oracle vendor recovery.

  • Added optional Prometheus node_exporter textfile metrics for each saved job, with atomically replaced per-job files, stable low-cardinality labels, run status/duration/size/copy gauges, strict readiness checks, and non-fatal runtime write warnings.

  • Added a GitHub Documentation workflow that checks local Markdown links across the README, Wiki sources, examples, and community files, plus whitespace in changed files. CI and CodeQL now support manual dispatch and concurrency control; Dependabot groups weekly GitHub Actions updates into reviewable pull requests.

  • Added GitHub Actions coverage for Bash 4.3 syntax compatibility, CodeQL, OpenSSF Scorecard, tag-to-version release metadata validation, and weekly GitHub Actions dependency updates through Dependabot.

  • Added safe per-job hooks.pre and hooks.post lifecycle scripts with literal argument arrays, strict ownership/mode checks, a scrubbed hook environment, dry-run planning, and best-effort cleanup after interrupted backup work.

  • Added quick PATH ... --to DESTINATION for immediate file and directory backups without a prewritten YAML job, including excludes, local/rclone copy policy, and a saved non-secret recovery configuration.

  • Added the explicit delete date-range purge for complete unpinned copies on local and rclone destinations. It requires UTC --since/--until dates and --confirm after a dry-run plan, and reuses atomic remote deletion rules.

  • Added quick-compose PROJECT_DIR --to DESTINATION for immediate explicit Compose project backups to local or rclone destinations. It supports selected volumes and bind mounts plus PostgreSQL, MySQL, and MariaDB logical SQL dumps; PostgreSQL quick dumps use the new optional format: sql adapter setting.

  • Added optional retention.max_age_days for automatic hard expiry of unpinned backups, independent of GFS counts.

  • Added a unified notification event layer for Telegram, ntfy, webhooks, and local SMTP transports, including recovery transitions, antiflood state, optional daily digests, redaction, and non-fatal delivery warnings.

  • Added strict per-channel notification templates with actionable restore hints, a fixed safe placeholder whitelist, Telegram value escaping, and bounded UTF-8-safe message rendering.

  • Added terminal-only restore --pick for selecting a completed backup version before running the existing safe restore path.

  • Added per-destination pin and unpin markers so migration recovery points stay outside GFS rotation without consuming retention slots.

  • Added diff ID1 ID2 for read-only comparison of two indexed backup manifests, including text and JSON output.

  • Added the read-only watchdog dead man's switch. It checks the newest valid completed backup copy across each selected job's destinations and returns a non-zero status when a backup is missing or too old.

  • Added the docker_compose source with explicit Compose files, named volumes and bind mounts.

  • Added PostgreSQL, MySQL and MariaDB logical dumps, plus native MS SQL and Oracle export artifact adapters.

  • Added a Compose smoke test with a hermetic fake Docker boundary.

  • Added a recovery guide for staged Compose restores; automatic in-place restores remain intentionally unsupported.

  • Added multi-recipient age encryption while retaining the legacy single recipient setting.

  • Added optional Minisign detached payload signatures, verified before the checksum during verification and restore.

  • Hardened symmetric GPG encryption with iterated SHA-512 S2K parameters.

Fixed

  • Made run turn per-job preflight errors into observable operational failures: it writes the failed Prometheus result when the collector is usable, emits the standard failure event with stage=preflight, and continues independent selected jobs. Compose database password environment variables are now checked before any dump command starts; doctor retains its strict code-2 validation behavior. A broken Prometheus collector cannot receive a metric, but now sends the same preflight alert without starting backup work.
  • Scoped automatic discovery in shared local and rclone destinations to the configured host_id. list, status, latest, interactive picking, watchdog, retention, and date-range deletion now ignore other hosts' IDs before validation, so a foreign malformed object cannot block maintenance or a foreign fresh copy cannot hide a stale host.
  • Made quick and quick-compose include the local hostname in their generated host IDs; BACKFORT_QUICK_HOST_ID provides a deliberate override for environments where hostnames are not unique.
  • Made temporary-workspace creation an explicit operational failure rather than allowing later paths to be formed from an empty directory. Added real Bash 4.3 runtime coverage for empty argument arrays, not only a syntax check.
  • Kept Compose volume helpers networkless and read-only while adding only DAC_READ_SEARCH, allowing snapshots of application-owned 0700 data without restoring broad container capabilities.
  • Made full verification and staged restore stream a materialized rclone payload from its verified local temporary file instead of incorrectly passing that local path back to rclone cat.
  • Restored successful preflight completion for ordinary file sources after all destination safety checks pass.
  • Made the executable mode of the CLI and test adapters a CI-enforced release invariant, so a fresh Linux checkout can invoke them directly.
  • Replaced unsupported if expressions in generated JSON with yq v4 compatible filters for Telegram topic IDs and list --json pin metadata.
  • Made the fake age adapter model streaming decryption, so the encryption smoke test exercises the real restore data path.
  • Made fixture metadata with a .json extension valid JSON, matching the production bundle format.

0.2.0

  • Added rclone destinations with atomic-by-marker publication, remote listing, verification, restore and conservative prune support.
  • Added success.min_copies so jobs can require multiple completed copies.
  • Fixed run so an unavailable local destination produces a partial result after other independent destinations have been attempted.
  • Kept doctor strict: it validates every configured destination before a scheduled backup is trusted.
  • Added Ubuntu CI for Bash syntax, ShellCheck and the integration smoke test.
  • Added the Docker Compose recovery contract that guides the upcoming remote storage and database adapters.

0.1.0

  • Initial public release: file sources, local destinations, atomic completed bundles, verification, safe restore and GFS-style retention.