OPNsense: Per API verschlüsseltes Backup der Konfiguration anlegen

Im OPNsense-Forum finden sich zwar zwei funktionierende Backup-Scripte für den Abruf der Backups per API (siehe unten), allerdings werden die Backups dabei nicht verschlüsselt. Also habe ich kurzerhand das Script überarbeitet und um diese Funktion erweitert.

Du findest es unter codeberg.org/SWEETGOOD/andersgood-opnsense-scripts/src/branch/main/backup-opnsense-via-api.sh

Voraussetzungen auf Seiten von OPNsense sind:

• Installation der Erweiterung os-api-backup (Seit Version 23.7 nicht mehr notwendig)
• OPNsense ab Version 23.7 (liefert den API-Endpoint /api/core/backup/download/this direkt mit)
• Anlegen eines Backup-Benutzers, z.B. backupuser
• Bearbeiten des gerade angelegten Benutzers
• Zuweisen der Effektiven Berechtigung für "Diagnostics: Configuration History"
  • Bis vor Version 23.7 hieß diese Berechtigung bei Verwendung des Plugins os-api-backup noch GUI Backup API
• Generieren eines API-Schlüssels
  • Nach dem Klick auf das "Plus" wird dir der API-Schlüssel als Datei zum Download angeboten. Er besteht aus key und secret und ist nicht über die Weboberfläche einsehbar
• Speichern des Benutzers

Passe nun die Variablen im Script an, die Beschreibungen und wichtige Hinweise stehen jeweils oberhalb der Variablen.

Auf einem beliebigen Linux-Server, welcher die API der Firewall erreichen kann, legst du nun den Ordner an, in welchen die Backups gespeichert werden sollen. Alternativ kannst du auch einen bereits bestehenden Pfad auf deinem System eintragen oder ggf. eine per NFS / SMB erreichbare Freigabe. Mache das Script anschließend noch mit chmod +x backup-opnsense-via-api.sh ausführbar.

Nun kannst du es mit ./backup-opnsense-via-api.sh auf seine Funktion testen.

Ich empfehle dir, das Script regelmäßig direkt über ein Monitoring-System wie monit auszuführen, so hast du eine direkte Rückmeldung, falls die Ausführung fehlschlägt.

Ich möchte ein Backup der OPNsense Konfiguration per API machen, habe dabei aber Schwierigkeiten

Ich unterstütze dich gerne beim Backup der OPNsense Konfiguration per API.
Schreib mir hierzu einfach über Kontakt, per Telegram oder unten in die Kommentare eine Nachricht.

Quellen und weiterführende Links

• Original source
• Alternative script source