Merge branch 'master' into beautification-of-backups-commands

.Jenkinsfile

@@ -1,33 +0,0 @@
-pipeline {
-    agent { label 'sbuild' }
-    stages {
-        stage('Build Debian package') {
-            when {
-                branch 'debian'
-            }
-            steps {
-                script {
-                    sh 'gbp buildpackage'
-                }
-                archiveArtifacts allowEmptyArchive: true, artifacts: 'build-area/*.gz,build-area/*.bz2,build-area/*.xz,build-area/*.deb,build-area/*.dsc,build-area/*.changes,build-area/*.buildinfo,build-area/*.build,build-area/lintian.txt'
-            }
-        }
-
-        stage('Upload Debian package') {
-            when {
-                branch 'debian'
-            }
-            steps {
-                script {
-                    sh 'rsync -avP build-area/bkctld*.deb build-area/bkctld*.changes build-area/bkctld*.buildinfo pub.evolix.org:/srv/upload/'
-                }
-            }
-        }
-    }
-    post {
-        // Clean after build
-        always {
-            cleanWs()
-        }
-    }
-}

.gitignore

@@ -1,2 +1,2 @@
 *.swp
-.vagrant
+.vagrant

README.md

@@ -1,20 +1,100 @@
-EvoBackup
+Bkctld (aka evobackup)
 =========
 
-EvoBackup is a combination of tools to manage backups on Evolix servers.
+Bkctld is a shell script that creates and manages a backup server
+which can handle the backups of many other servers (clients). It
+is licensed under the AGPLv3.
 
-## The client side
+It uses SSH chroots (called "jails" in the FreeBSD world) to sandbox
+every clients backups. Each client will upload it's data every day
+using rsync in it's chroot (using the root account).  Prior backups
+are stored incrementally outside of the chroot using hard links or
+BTRFS snapshots.  (So they can not be affected by the client). 
 
-_What you install on the servers you want to backup._
+Using this method, we can keep a large quantity of backups of each
+client securely and efficiently.
 
-There is a backup script (usually executed by cron or similar), a utility script and some libraries.
+~~~
+                                    Backup server
+                                    ************
+Server 1 ------ SSH/rsync ------->  * tcp/2222 *
+                                    *          *
+Server 2 ------ SSH/rsync ------->  * tcp/2223 *
+                                    ************
+~~~
 
-More information in the [client README](/evolix/evobackup/src/branch/master/client/README.md).
+This method uses standard tools (ssh, rsync, cp -al, btrfs subvolume)
+and has been used for many years by Evolix to backup hundreds of
+servers, totaling many terabytes of data, each day.  bkctld has
+been tested on Debian Jessie and should be compatible with other
+Debian versions or derived distributions like Ubuntu.
 
-## The server side
+A large enough volume must be mounted on `/backup`, we recommend
+the usage of **BTRFS** so you can use sub-volumes and snapshots.
+This volume can also be encrypted with **LUKS**.
 
-_What you install on the servers that store the backups._
+## Install
 
-This is also known as `bkctld` : a program to manage SSH servers in chroots to isolate backup destinations, daily copies and data retention.
+See the [installation guide](docs/install.md) for instructions.
 
-More information in the [server README](/evolix/evobackup/src/branch/master/server/README.md).
+## Testing
+
+You can deploy test environments with Vagrant :
+
+~~~
+vagrant up
+~~~
+
+### Deployment
+
+Launch rsync-auto in a terminal for automatic synchronization of
+your local code with Vagrant VM :
+
+~~~
+vagrant rsync-auto
+~~~
+
+### Bats
+
+You can run [bats](https://github.com/sstephenson/bats) tests with
+the *test* provision :
+
+~~~
+vagrant provision --provision-with test
+~~~
+
+## Usage
+
+See [docs/usage.md](docs/usage.md).
+
+The man(1) page, in troff(7) language, can be generated with pandoc:
+
+~~~
+pandoc -f markdown \
+	-t man usage.md \
+	--template default.man \
+	-V title=bkctld \
+	-V section=8 \
+	-V date="$(date '+%d %b %Y')" \
+	-V footer="$(git describe --tags)" \
+	-V header="bkctld man page"
+~~~
+
+#### Client configuration
+
+You can save various systems in the evobackup jails :  Linux, BSD,
+Windows, MacOSX. The only prerequisite is the rsync command.
+
+~~~
+rsync -av -e "ssh -p SSH_PORT" /home/ root@SERVER_NAME:/var/backup/home/
+~~~
+
+An example synchronization script is present in `zzz_evobackup`,
+clone the evobackup repository and read the **CLIENT CONFIGURATION**
+section of the manual.
+
+~~~
+git clone https://forge.evolix.org/evobackup.git
+cd evobackup
+man ./docs/bkctld.8
+~~~

Vagrantfile

@@ -1,12 +1,14 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
+Vagrant::DEFAULT_SERVER_URL.replace('https://vagrantcloud.com')
+
 # Load ~/.VagrantFile if exist, permit local config provider
 vagrantfile = File.join("#{Dir.home}", '.VagrantFile')
 load File.expand_path(vagrantfile) if File.exists?(vagrantfile)
 
 Vagrant.configure('2') do |config|
-  config.vm.synced_folder "./", "/vagrant", type: "rsync", rsync__exclude: [ '.vagrant', '.git', 'build' ]
+  config.vm.synced_folder "./", "/vagrant", type: "rsync", rsync__exclude: [ '.vagrant', '.git' ]
   config.ssh.shell="/bin/sh"
 
   config.vm.provider :libvirt do |libvirt|
@@ -24,16 +26,11 @@ mkdir -p /usr/lib/nagios/plugins/
 SCRIPT
 
   $deps = <<SCRIPT
-DEBIAN_FRONTEND=noninteractive apt-get -yq install openssh-server btrfs-progs rsync lsb-base coreutils sed dash mount openssh-sftp-server libc6 bash-completion duc-nox cryptsetup bats
+DEBIAN_FRONTEND=noninteractive apt-get -yq install openssh-server btrfs-tools rsync lsb-base coreutils sed dash mount openssh-sftp-server libc6 bash-completion duc-nox cryptsetup bats
 SCRIPT
 
   $pre_part = <<SCRIPT
-sed --follow-symlinks --in-place -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen && \
-    sed --follow-symlinks --in-place -e 's/# fr_FR.UTF-8 UTF-8/fr_FR.UTF-8 UTF-8/' /etc/locale.gen && \
-    echo 'LANG="fr_FR.UTF-8"'>/etc/default/locale && \
-    dpkg-reconfigure --frontend=noninteractive locales && \
-    update-locale LANG=fr_FR.UTF-8
-lsof | awk '/backup/ { print $2 }' | xargs --no-run-if-empty kill -9
+lsof|awk '/backup/ { print $2 }'| xargs --no-run-if-empty kill -9
 grep -q /backup /proc/mounts && umount -R /backup
 exit 0
 SCRIPT
@@ -45,11 +42,7 @@ SCRIPT
 
   nodes = [
     { :version => "stretch", :fs => "btrfs" },
-    { :version => "stretch", :fs => "ext4" },
-    { :version => "buster", :fs => "btrfs" },
-    { :version => "buster", :fs => "ext4" },
-    { :version => "bullseye", :fs => "btrfs" },
-    { :version => "bullseye", :fs => "ext4" }
+    { :version => "stretch", :fs => "ext4" }
   ]
 
   nodes.each do |i|

bash_completion

@@ -0,0 +1,28 @@
+# bkctld(8) completion
+#
+# Copyright (c) 2017 Victor Laborie <vlaborie@evolix.fr>
+#
+
+function _bkctld()
+{
+	local cur prev commands jails keys
+
+	cur=${COMP_WORDS[COMP_CWORD]};
+	prev=${COMP_WORDS[COMP_CWORD-1]};
+	commands=$(find /usr/lib/bkctld/ -name "bkctld-*" -exec basename {} \;|sed 's/^bkctld-//')
+
+	if [ $COMP_CWORD -eq 1 ]; then
+		COMPREPLY=($(compgen -W '${commands}' -- ${cur}))
+	elif [ $COMP_CWORD -eq 2 ]; then
+		[ -f /etc/default/bkctld ] && source /etc/default/bkctld
+		[ -z "${JAILDIR}" ] && JAILDIR='/backup/jails'
+		jails=$(ls "${JAILDIR}")
+  		COMPREPLY=($(compgen -W "${jails}" -- ${cur}))
+	elif [ $COMP_CWORD -eq 3 ]; then
+		keys=$(ls *.pub)
+		COMPREPLY=($(compgen -W "${keys}" -- ${cur}))
+	fi
+
+	return 0
+} &&
+complete -F _bkctld bkctld

bkctld

@@ -0,0 +1,51 @@
+#!/bin/sh
+#
+# bkctld is a shell script to create and manage a backup server which will
+# handle the backup of many servers (clients).
+#
+# Author: Victor Laborie <vlaborie@evolix.fr>
+# Contributor: Benoît Série <bserie@evolix.fr>, Gregory Colpart <reg@evolix.fr>, Romain Dessort <rdessort@evolix.fr>, Tristan Pilat <tpilat@evolix.fr>
+# Licence: AGPLv3
+#
+
+set -u
+
+[ "$(id -u)" -ne 0 ] && error "You need to be root to run ${0} !"
+
+[ -d './lib' ] && LIBDIR='lib'
+[ -d '/usr/lib/bkctld' ] && LIBDIR='/usr/lib/bkctld'
+. "${LIBDIR}/config"
+
+subcommand="${1:-}"
+jail="${2:-}"
+option="${3:-}"
+
+if [ ! -x "${LIBDIR}/bkctld-${subcommand}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+
+case "${subcommand}" in
+    "inc" | "rm" | "check" | "stats" | "help" | "list")
+        "${LIBDIR}/bkctld-${subcommand}"
+    ;;
+        "init" | "is-on")
+        "${LIBDIR}/bkctld-${subcommand}" "${jail}"
+    ;;
+    "key" | "port" | "ip")
+        "${LIBDIR}/bkctld-${subcommand}" "${jail}" "${option}"
+    ;;
+    "start" | "stop" | "reload" | "restart" | "sync" | "update" | "remove" | "firewall")
+    if [ "${jail}" = "all" ]; then
+        "${LIBDIR}/bkctld-list"|xargs --no-run-if-empty --max-args=1 --max-procs=0 "${LIBDIR}/bkctld-${subcommand}"
+    else
+        "${LIBDIR}/bkctld-${subcommand}" "${jail}"
+    fi
+    ;;
+    "status")
+    if [ -z "${jail}" ]; then
+        "${LIBDIR}/bkctld-list"|xargs --no-run-if-empty --max-args=1 "${LIBDIR}/bkctld-${subcommand}"
+    else
+        "${LIBDIR}/bkctld-${subcommand}" "${jail}"
+    fi
+    ;;
+esac

bkctld.conf

@@ -14,6 +14,3 @@
 #FIREWALL_RULES=''
 #LOGLEVEL=6
 #NODE=''
-#ARCHIVESDIR='/backup/archives'
-#WARNING=48
-#CRITICAL=72

check-incs.sh

@@ -0,0 +1,52 @@
+#!/bin/sh
+
+EVOBACKUP_CONFIGS="/etc/evobackup/*"
+
+relative_date() {
+    format=$(echo $1 | cut -d'.' -f1)
+    time_jump=$(echo $1 | cut -d'.' -f2)
+ 
+    reference_date=$(date "${format}")
+    past_date=$(date --date "${reference_date} ${time_jump}" +"%Y-%m-%d")
+    
+    echo ${past_date}
+}
+inc_exists() {
+    ls -d /backup/incs/$1 > /dev/null 2>&1 
+}
+jail_exists() {
+    ls -d /backup/jails/$1 > /dev/null 2>&1 
+}
+# default return value is 0 (succes)
+rc=0
+# loop for each configured jail
+for file in ${EVOBACKUP_CONFIGS}; do
+    jail_name=$(basename $file) 
+    # check if jail is present
+    if jail_exists ${jail_name}; then
+        # get jail last configuration date
+        jail_config_age=$(date --date "$(stat -c %y ${file})" +%s)
+        # loop for each line in jail configuration
+        for line in $(cat $file); do
+            # inc date in ISO format
+            inc_date=$(relative_date $line)
+            # inc date in seconds from epoch
+            inc_age=$(date --date "${inc_date}" +%s)
+            # check if the configuration changed after the inc date 
+            if [ $jail_config_age -lt $inc_age ]; then
+                # Error if inc is not found
+                if ! inc_exists ${jail_name}/${inc_date}*; then
+                    echo "ERROR: inc is missing \`${jail_name}/${inc_date}'" >&2
+                    rc=1
+                fi
+            else
+                echo "INFO: no inc expected for ${inc_date} \`${jail_name}'"
+            fi
+        done
+    else
+        echo "ERROR: jail is missing \`${jail_name}'" >&2
+        rc=1
+    fi
+done
+
+exit $rc

client/CHANGELOG.md

@@ -1,92 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
-
-This project does not follow semantic versioning.
-The **major** part of the version is the year
-The **minor** part changes is the month
-The **patch** part changes is incremented if multiple releases happen the same month
-
-## [Unreleased]
-
-### Added
-
-### Changed
-
-### Deprecated
-
-### Removed
-
-### Fixed
-
-### Security
-
-## [24.05] - 2022-05-02
-
-### Added
-
-* evobackupctl: update LIBDIR when copying the template
-
-### Changed
-
-* evobackupctl: simplify the program path retrieval
-
-## [24.04.1] - 2022-04-30
-
-### Fixed
-
-* evobackupctl: quote ARGS variable for options parsing.
-
-## [24.04] - 2022-04-29
-
-### Added
-
-* Vagrant definition for manual tests
-
-### Changed
-
-* split functions into libraries
-* add evobackupctl script
-* change the "zzz_evobackup" script to a template, easy to copy with evobackupctl
-* use env-based shebang for shell scripts
-* use $TMPDIR if available
-
-### Removed
-
-* update-evobackup-canary is managed by ansible-roles.git
-* deployment by Ansible is managed elsewhere (now in evolix-private.git, later in ansible-roles.git)
-
-### Fixed
-
-* don't exit the whole program if a sync task can't be done
-
-## [22.12] - 2022-12-27
-
-### Changed
-
-* Use --dump-dir instead of --backup-dir to suppress dump-server-state warning
-* Do not use rsync compression
-* Replace rsync option --verbose by --itemize-changes
-* Add canary to zzz_evobackup
-* update-evobackup-canary: do not use GNU date, for it to be compatible with OpenBSD
-* Add AGPL License and README
-* Script now depends on Bash
-* tolerate absence of mtr or traceroute
-* Only one loop for all Redis instances
-* remodel how we build the rsync command
-* use sub shells instead of moving around
-* Separate Rsync for the canary file if the main Rsync has finished without errors
-
-### Removed
-
-* No more fallback if dump-server-state is missing
-
-### Fixed
-
-* Make start_time and stop_time compatible with OpenBSD
-
-## [22.03] - 2022-04-03
-
-Split client and server parts of the project

client/LICENSE

@@ -1,661 +0,0 @@
-                    GNU AFFERO GENERAL PUBLIC LICENSE
-                       Version 3, 19 November 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU Affero General Public License is a free, copyleft license for
-software and other kinds of works, specifically designed to ensure
-cooperation with the community in the case of network server software.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-our General Public Licenses are intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  Developers that use our General Public Licenses protect your rights
-with two steps: (1) assert copyright on the software, and (2) offer
-you this License which gives you legal permission to copy, distribute
-and/or modify the software.
-
-  A secondary benefit of defending all users' freedom is that
-improvements made in alternate versions of the program, if they
-receive widespread use, become available for other developers to
-incorporate.  Many developers of free software are heartened and
-encouraged by the resulting cooperation.  However, in the case of
-software used on network servers, this result may fail to come about.
-The GNU General Public License permits making a modified version and
-letting the public access it on a server without ever releasing its
-source code to the public.
-
-  The GNU Affero General Public License is designed specifically to
-ensure that, in such cases, the modified source code becomes available
-to the community.  It requires the operator of a network server to
-provide the source code of the modified version running there to the
-users of that server.  Therefore, public use of a modified version, on
-a publicly accessible server, gives the public access to the source
-code of the modified version.
-
-  An older license, called the Affero General Public License and
-published by Affero, was designed to accomplish similar goals.  This is
-a different license, not a version of the Affero GPL, but Affero has
-released a new version of the Affero GPL which permits relicensing under
-this license.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU Affero General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Remote Network Interaction; Use with the GNU General Public License.
-
-  Notwithstanding any other provision of this License, if you modify the
-Program, your modified version must prominently offer all users
-interacting with it remotely through a computer network (if your version
-supports such interaction) an opportunity to receive the Corresponding
-Source of your version by providing access to the Corresponding Source
-from a network server at no charge, through some standard or customary
-means of facilitating copying of software.  This Corresponding Source
-shall include the Corresponding Source for any work covered by version 3
-of the GNU General Public License that is incorporated pursuant to the
-following paragraph.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the work with which it is combined will remain governed by version
-3 of the GNU General Public License.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU Affero General Public License from time to time.  Such new versions
-will be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU Affero General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU Affero General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU Affero General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU Affero General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU Affero General Public License for more details.
-
-    You should have received a copy of the GNU Affero General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If your software can interact with users remotely through a computer
-network, you should also make sure that it provides a way for users to
-get its source.  For example, if your program is a web application, its
-interface could display a "Source" link that leads users to an archive
-of the code.  There are many ways you could offer source, and different
-solutions will be better for different programs; see section 13 for the
-specific requirements.
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU AGPL, see
-<https://www.gnu.org/licenses/>.

client/README.md

@@ -1,166 +0,0 @@
-EvoBackup — the client side
-===========================
-
-_What you install on the servers you want to backup._
-
-## Design
-
-### backup script
-
-The tip of the iceberg is a script (often called `zzz_evobackup` because it is executed by cron at the very end of the _daily_ tasks list).
-
-This is where you setup **what**, **how** and **where** to backup on remote server(s).
-
-There are 2 main phases in the backup :
-
-1. **local tasks**: everything you want to do locally (save state information, dump databases…).
-2. **sync tasks**: which data (including what has been prepared in the local phase) you want to send to remote servers.
-
-### libraries
-
-The vast majority of the logic is in libraries, to help maintaining them without having to modify the backup script.
-
-They contain mostly _dump_ functions that are called from the backup script.
-
-Those functions contain a lot of code for logging, options parsing, error management, and some code specific to the dump task.
-
-### utility script
-
-A scripts named `evobackupctl` helps initializing a backup jail on remote servers or install the backup script where you want.
-
-## Install and update
-
-To install, copy these files :
-
-* `lib/*` → `/usr/local/lib/evobackup`
-* `bin/evobackupctl` → `/usr/local/bin/evobackupctl`
-
-To update, simply overwrite them, since their content should (must?) not be customized locally.
-
-There is also an [evobackup-client](https://gitea.evolix.org/evolix/ansible-roles/src/branch/unstable/evobackup-client) Ansible role to do this (and some other stuff) automatically.
-
-## Usage
-
-### backup script
-
-#### minimal configuration
-
-##### mail notifications
-
-The absolute minimum you must do is set the `MAIL` variable to the email address you want to be notified at.
-
-##### sync tasks
-
-If you want to sync files to a remote server, you have to set the `SERVERS` variable with at least one host and port.
-Beware that the default `evolix-system` _sync_ doesn't sync `/home`, `/srv`…
-
-If you want to sync files to multiple groups of servers, you can add as many _sync_ sections as you want.
-A _sync_ section must contain something like this :
-
-~~~bash
-# The name of the "sync" (visible in logs)
-SYNC_NAME="evolix-system"
-# List of servers
-SERVERS=(
-    host1:port1
-    host2:port2
-)
-# List of paths to include in the sync
-RSYNC_INCLUDES=(
-    "${rsync_default_includes[@]}"
-    /etc
-    /root
-    /var
-)
-# List of paths to exclude from the sync
-RSYNC_EXCLUDES=(
-    "${rsync_default_excludes[@]}"
-)
-# Actual sync command
-sync "${SYNC_NAME}" "SERVERS[@]" "RSYNC_INCLUDES[@]" "RSYNC_EXCLUDES[@]"
-~~~
-
-##### local tasks
-
-By default, the `local_tasks()` function only:
-
-* executes [dump-server-state](https://gitea.evolix.org/evolix/dump-server-state) to put have a saved copy of a lot of information about the server
-* saves a traceroute to some key network endpoints (using the `dump_traceroute()` function)
-
-You can enable (by uncommenting) as many _dump_ functions as you want.
-
-### advanced customization
-
-Since this is a shell script, you can add any bash-compatible code you want.
-If you do so you should read the libraries code to make sure that you don't overwrite existing functions.
-
-##### sync tasks
-
-If you don't want to sync files to any remote servers, you can simply replace the content of the `sync_tasks()` function by a no-op command (`:`).
-
-`RSYNC_INCLUDES` and `RSYNC_EXCLUDES` refer to `${rsync_default_includes[@]}` and `${rsync_default_excludes[@]}` (defined in the `main.sh` library) to simplify the configuration. If you want to precisely customize the lists you can remove them and add you own.
-
-##### local tasks
-
-Existing _dump_ functions (as defined in libraries) are usable as-is, but you can also create your own local custom functions.
-You have to define them in the backup script (or in a file that you source from the backup script).
-You should prefix their name with `dump_` base your customization on the `dump_custom()` (documented in the backup script) to keep the boilerplate code (for logging, error management…).
-
-You can customize some values inside the `setup_custom()`, like the server's hostname, the notification mail subject…
-
-If you want to source libraries from a different path, you can change the `LIBDIR` variable at the end of the backup script.
-
-### utility tool
-
-The command is `evobackupctl`.
-
-~~~
-# evobackupctl --help
-evobackupctl helps managing evobackup scripts
-
-Options
- -h, --help                  print this message and exit
- -V, --version               print version and exit
-     --jail-init-commands    print jail init commands
-     --copy-template=PATH    copy the backup template to PATH
-
-# evobackupctl --version
-evobackupctl version 24.04
-
-Copyright 2024 Evolix <info@evolix.fr>,
-               Jérémy Lecour <jlecour@evolix.fr>.
-
-evobackupctl comes with ABSOLUTELY NO WARRANTY.  This is free software,
-and you are welcome to redistribute it under certain conditions.
-See the GNU General Public License v3.0 for details.
-~~~
-
-#### jail init commands
-
-It prints a list of commands you can execute on remote backup servers to configure a backup "jail".
-
-~~~
-# evobackupctl --jail-init-commands
-Copy-paste those lines on backup server(s) :
-----------
-SERVER_NAME=example-hostname
-SERVER_IP=203.0.113.1
-echo 'ssh-ed25519 xxxxxx root@example-hostname' > /root/${SERVER_NAME}.pub
-bkctld init ${SERVER_NAME}
-bkctld key ${SERVER_NAME} /root/${SERVER_NAME}.pub
-bkctld ip ${SERVER_NAME} ${SERVER_IP}
-bkctld start ${SERVER_NAME}
-bkctld status ${SERVER_NAME}
-grep --quiet --extended-regexp "^\s?NODE=" /etc/default/bkctld && bkctld sync ${SERVER_NAME}
-----------
-~~~
-
-#### copy-template
-
-It copies the backups script template to the path of your choice, nothing more.
-
-~~~
-# evobackupctl --copy-template /etc/cron.daily/zzz_evobackup
-New evobackup script has been saved to '/etc/cron.daily/zzz_evobackup'.
-Remember to customize it (mail notifications, backup servers…).
-~~~

client/Vagrantfile

@@ -1,49 +0,0 @@
-# -*- mode: ruby -*-
-# vi: set ft=ruby :
-
-# Load ~/.VagrantFile if exist, permit local config provider
-vagrantfile = File.join(Dir.home, ".VagrantFile")
-load File.expand_path(vagrantfile) if File.exist?(vagrantfile)
-
-Vagrant.configure("2") do |config|
-  # Run "vagrant rsync-auto" to sync after each change
-  config.vm.synced_folder ".", "/vagrant", type: "rsync", disabled: true
-  config.vm.synced_folder "bin", "/usr/local/bin", type: "rsync"
-  config.vm.synced_folder "lib", "/usr/local/lib/evobackup", type: "rsync"
-
-  config.ssh.shell = "/bin/sh"
-
-  config.vm.provider :libvirt do |libvirt|
-    # libvirt.storage :file, :size => '10G', :device => 'vdb'
-    libvirt.memory = 1024
-    libvirt.cpus = 1
-  end
-
-  config_script = <<~SCRIPT
-    set -e
-    sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/; s/# fr_FR.UTF-8 UTF-8/fr_FR.UTF-8 UTF-8/' /etc/locale.gen && \
-        echo 'LANG="fr_FR.UTF-8"'>/etc/default/locale && \
-        dpkg-reconfigure --frontend=noninteractive locales && \
-        update-locale LANG=fr_FR.UTF-8
-    exit 0
-  SCRIPT
-
-  [
-    {version: "buster"},
-    {version: "bullseye"},
-    {version: "bookworm"}
-  ].each do |i|
-    config.vm.define(i[:version].to_s) do |node|
-      node.vm.hostname = "evobackup-#{i[:version]}"
-      node.vm.box = "debian/#{i[:version]}64"
-
-      node.vm.provision "config", type: "shell", inline: config_script
-
-      node.vm.provision :ansible do |ansible|
-        ansible.playbook = "vagrant.yml"
-      end
-
-    end
-  end
-
-end

client/bin/evobackupctl

@@ -1,156 +0,0 @@
-#!/usr/bin/env bash
-
-# shellcheck disable=SC2155
-readonly PROGPATH=$(readlink -m "${0}")
-readonly PROGNAME=$(basename "${PROGPATH}")
-# shellcheck disable=SC2124
-readonly ARGS=$@
-
-# Change this to wherever you install the libraries
-readonly LIBDIR="/usr/local/lib/evobackup"
-
-source "${LIBDIR}/main.sh"
-
-show_version() {
-    cat <<END
-${PROGNAME} version ${VERSION}
-
-Copyright 2024 Evolix <info@evolix.fr>,
-               Jérémy Lecour <jlecour@evolix.fr>.
-
-${PROGNAME} comes with ABSOLUTELY NO WARRANTY.  This is free software,
-and you are welcome to redistribute it under certain conditions.
-See the GNU General Public License v3.0 for details.
-END
-}
-show_help() {
-    cat <<END
-${PROGNAME} helps managing evobackup scripts
-
-Options
- -h, --help                  print this message and exit
- -V, --version               print version and exit
-     --jail-init-commands    print jail init commands
-     --copy-template=PATH    copy the backup template to PATH
-END
-}
-
-jail_init_commands() {
-    if [ ! -f /root/.ssh/id_ed25519.pub ]; then
-        ssh-keygen -t ed25519 -f /root/.ssh/id_ed25519 -N ''
-        echo ""
-    fi
-
-    SSH_KEY=$(cat /root/.ssh/id_ed25519.pub)
-    SERVER_NAME=$(hostname -s)
-    if [ "$(uname -s)" = "OpenBSD" ]; then
-        SERVER_IP=$(ifconfig egress | grep "inet " | head -1 | awk '{ print $2}')
-    else
-        SERVER_IP=$(curl -4 https://ifconfig.me 2> /dev/null || hostname -I | awk '{ print $1}')
-    fi
-
-    echo "Copy-paste those lines on backup server(s) :"
-    echo "----------"
-    echo "SERVER_NAME=${SERVER_NAME}"
-    echo "SERVER_IP=${SERVER_IP}"
-    echo "echo '${SSH_KEY}' > /root/\${SERVER_NAME}.pub"
-    echo "bkctld init \${SERVER_NAME}"
-    echo "bkctld key \${SERVER_NAME} /root/\${SERVER_NAME}.pub"
-    echo "bkctld ip \${SERVER_NAME} \${SERVER_IP}"
-    echo "bkctld start \${SERVER_NAME}"
-    echo "bkctld status \${SERVER_NAME}"
-    echo "grep --quiet --extended-regexp \"^\\s?NODE=\" /etc/default/bkctld && bkctld sync \${SERVER_NAME}"
-    echo "----------"
-}
-
-copy_template() {
-    dest_path=${1}
-    dest_dir="$(dirname "${dest_path}")"
-
-    if [ -e "${dest_path}" ]; then
-        printf "Path for new evobackup script '%s' already exists.\n" "${dest_path}" >&2
-        exit 1
-    elif [ ! -e "${dest_dir}" ]; then
-        printf "Parent directory '%s' doesn't exist. Create it first.\n" "${dest_dir}" >&2
-        exit 1
-    else
-        if cp "${LIBDIR}/zzz_evobackup.sh" "${dest_path}"; then
-            chmod 750 "${dest_path}"
-
-            # Insert metadata about the template
-            sed -i "s|@COMMAND@|${PROGPATH} ${ARGS}|" "${dest_path}"
-            sed -i "s|@DATE@|$(date --iso-8601=seconds)|" "${dest_path}"
-            sed -i "s|@VERSION@|${VERSION}|" "${dest_path}"
-
-            # Make sure that the library directory is correct
-            sed -i "s|^LIBDIR=.\+|LIBDIR=\"${LIBDIR}\"|" "${dest_path}"
-
-            printf "New evobackup script has been saved to '%s'.\n" "${dest_path}"
-            printf "Remember to customize it (mail notifications, backup servers…).\n"
-            exit 0
-        fi
-    fi
-}
-
-main() {
-    # If no argument is provided, print help and exit
-    # shellcheck disable=SC2086
-    if [ -z "${ARGS}" ]; then
-        show_help
-        exit 0
-    fi
-    # Parse options, based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
-    while :; do
-        case ${1:-''} in
-            -V|--version)
-                show_version
-                exit 0
-                ;;
-            -h|--help)
-                show_help
-                exit 0
-                ;;
-            --jail-init-commands)
-                jail_init_commands
-                exit 0
-                ;;
-            --copy-template)
-                # copy-template option, with value separated by space
-                if [ -n "$2" ]; then
-                    copy_template "${2}"
-                    shift
-                else
-                    printf "'%s' requires a non-empty option argument.\n" "--copy-template" >&2
-                    exit 1
-                fi
-                ;;
-            --copy-template=?*)
-                # copy-template option, with value separated by =
-                copy_template "${1#*=}"
-                ;;
-            --copy-template=)
-                # copy-template option, without value
-                printf "'%s' requires a non-empty option argument.\n" "--copy-template" >&2
-                exit 1
-                ;;
-            --)
-                # End of all options.
-                shift
-                break
-                ;;
-            -?*|[[:alnum:]]*)
-                # ignore unknown options
-                printf "unknown option '%s'.\n" "${1}" >&2
-                exit 1
-                ;;
-            *)
-                # Default case: If no more options then break out of the loop.
-                break
-                ;;
-        esac
-
-        shift
-    done
-}
-
-main ${ARGS}

client/lib/dump/elasticsearch.sh

@@ -1,301 +0,0 @@
-#!/usr/bin/env bash
-# shellcheck disable=SC2034,SC2317,SC2155
-
-#######################################################################
-# Snapshot Elasticsearch data
-# 
-# Arguments:
-# --protocol=<http|https> (default: http)
-# --cacert=[String] (default: <none>)
-#   path to the CA certificate to use when using https
-# --host=[String] (default: localhost)
-# --port=[Integer] (default: 9200)
-# --user=[String] (default: <none>)
-# --password=[String] (default: <none>)
-# --repository=[String] (default: snaprepo)
-# --snapshot=[String] (default: snapshot.daily)
-#######################################################################
-dump_elasticsearch() {
-    local option_protocol="http"
-    local option_cacert=""
-    local option_host="localhost"
-    local option_port="9200"
-    local option_user=""
-    local option_password=""
-    local option_repository="snaprepo"
-    local option_snapshot="snapshot.daily"
-    local option_others=""
-
-    # Parse options, based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
-    while :; do
-        case ${1:-''} in
-            --protocol)
-                # protocol options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_protocol="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--protocol' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --protocol=?*)
-                # protocol options, with value separated by =
-                option_protocol="${1#*=}"
-                ;;
-            --protocol=)
-                # protocol options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--protocol' requires a non-empty option argument."
-                exit 1
-                ;;
-            --cacert)
-                # cacert options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_cacert="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--cacert' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --cacert=?*)
-                # cacert options, with value separated by =
-                option_cacert="${1#*=}"
-                ;;
-            --cacert=)
-                # cacert options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--cacert' requires a non-empty option argument."
-                exit 1
-                ;;
-            --host)
-                # host options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_host="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--host' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --host=?*)
-                # host options, with value separated by =
-                option_host="${1#*=}"
-                ;;
-            --host=)
-                # host options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--host' requires a non-empty option argument."
-                exit 1
-                ;;
-            --port)
-                # port options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_port="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--port' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --port=?*)
-                # port options, with value separated by =
-                option_port="${1#*=}"
-                ;;
-            --port=)
-                # port options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--port' requires a non-empty option argument."
-                exit 1
-                ;;
-            --user)
-                # user options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_user="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--user' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --user=?*)
-                # user options, with value separated by =
-                option_user="${1#*=}"
-                ;;
-            --user=)
-                # user options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--user' requires a non-empty option argument."
-                exit 1
-                ;;
-            --password)
-                # password options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_password="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--password' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --password=?*)
-                # password options, with value separated by =
-                option_password="${1#*=}"
-                ;;
-            --password=)
-                # password options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--password' requires a non-empty option argument."
-                exit 1
-                ;;
-            --repository)
-                # repository options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_repository="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--repository' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --repository=?*)
-                # repository options, with value separated by =
-                option_repository="${1#*=}"
-                ;;
-            --repository=)
-                # repository options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--repository' requires a non-empty option argument."
-                exit 1
-                ;;
-            --snapshot)
-                # snapshot options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_snapshot="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--snapshot' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --snapshot=?*)
-                # snapshot options, with value separated by =
-                option_snapshot="${1#*=}"
-                ;;
-            --snapshot=)
-                # snapshot options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--snapshot' requires a non-empty option argument."
-                exit 1
-                ;;
-            --)
-                # End of all options.
-                shift
-                option_others=${*}
-                break
-                ;;
-            -?*|[[:alnum:]]*)
-                # ignore unknown options
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: unknown option '${1}' (ignored)"
-                ;;
-            *)
-                # Default case: If no more options then break out of the loop.
-                break
-                ;;
-        esac
-
-        shift
-    done
-
-    #  Use the default Elasticsearch CA certificate when using HTTPS, if not specified directly 
-    local default_cacert="/etc/elasticsearch/certs/http_ca.crt"
-    if [ "${option_protocol}" = "https" ] && [ -z "${option_cacert}" ] && [ -f "${default_cacert}" ]; then
-        option_cacert="${default_cacert}"
-    fi
-
-    local errors_dir="${ERRORS_DIR}/elasticsearch-${option_repository}-${option_snapshot}"
-    rm -rf "${errors_dir}"
-    mkdir -p "${errors_dir}"
-    # No need to change recursively, the top directory is enough
-    chmod 700 "${errors_dir}"
-
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${option_snapshot}"
-
-    ## Take a snapshot as a backup.
-    ## Warning: You need to have a path.repo configured.
-    ## See: https://wiki.evolix.org/HowtoElasticsearch#snapshots-et-sauvegardes
-
-    local base_url="${option_protocol}://${option_host}:${option_port}"
-    local repository_url="${base_url}/_snapshot/${option_repository}"
-    local snapshot_url="${repository_url}/${option_snapshot}"
-
-    # Verify snapshot repository
-
-    local error_file="${errors_dir}/verify.err"
-
-    declare -a connect_options
-    connect_options=()
-    if [ -n "${option_cacert}" ]; then
-        connect_options+=(--cacert "${option_cacert}")
-    fi
-    if [ -n "${option_user}" ] || [ -n "${option_password}" ]; then
-        local connect_options+=("--user ${option_user}:${option_password}")
-    fi
-    if [ -n "${option_others}" ]; then
-        # word splitting is deliberate here
-        # shellcheck disable=SC2206
-        connect_options+=(${option_others})
-    fi
-    # Add the http return code at the end of the output
-    connect_options+=(--write-out '%{http_code}\n')
-    connect_options+=(--silent)
-
-    declare -a dump_options
-    dump_options=()
-    dump_options+=(--request POST)
-
-    dump_cmd="curl ${connect_options[*]} ${dump_options[*]} ${repository_url}/_verify?pretty"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-    ${dump_cmd} > "${error_file}"
-
-    # test if the last line of the log file is "200"
-    tail -n 1 "${error_file}" | grep --quiet "^200$" "${error_file}"
-
-    local last_rc=$?
-    # shellcheck disable=SC2086
-    if [ ${last_rc} -ne 0 ]; then
-        log_error "LOCAL_TASKS - ${FUNCNAME[0]}: repository verification returned an error ${last_rc}" "${error_file}"
-        GLOBAL_RC=${E_DUMPFAILED}
-    else
-        rm -f "${error_file}"
-
-        # Delete snapshot
-        
-        declare -a dump_options
-        dump_options=()
-        dump_options+=(--request DELETE)
-
-        dump_cmd="curl ${connect_options[*]} ${dump_options[*]} ${snapshot_url}"
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-        ${dump_cmd} > /dev/null
-
-        # Create snapshot
-
-        local error_file="${errors_dir}/create.err"
-        
-        declare -a dump_options
-        dump_options=()
-        dump_options+=(--request PUT)
-
-        dump_cmd="curl ${connect_options[*]} ${dump_options[*]} ${snapshot_url}?wait_for_completion=true"
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-        ${dump_cmd} > "${error_file}"
-
-        # test if the last line of the log file is "200"
-        tail -n 1 "${error_file}" | grep --quiet "^200$" "${error_file}"
-
-        local last_rc=$?
-        # shellcheck disable=SC2086
-        if [ ${last_rc} -ne 0 ]; then
-            log_error "LOCAL_TASKS - ${FUNCNAME[0]}: curl returned an error ${last_rc}" "${error_file}"
-            GLOBAL_RC=${E_DUMPFAILED}
-        else
-            rm -f "${error_file}"
-        fi
-    fi
-
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${option_snapshot}"
-}

client/lib/dump/misc.sh

@@ -1,559 +0,0 @@
-#!/usr/bin/env bash
-# shellcheck disable=SC2034,SC2317,SC2155
-
-#######################################################################
-# Dump LDAP files (config, data, all)
-#
-# Arguments: <none>
-#######################################################################
-dump_ldap() {
-    ## OpenLDAP : example with slapcat
-    local dump_dir="${LOCAL_BACKUP_DIR}/ldap"
-    rm -rf "${dump_dir}"
-    mkdir -p "${dump_dir}"
-    chmod 700 "${dump_dir}"
-
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${FUNCNAME[0]} to ${dump_dir}"
-
-    dump_cmd="slapcat -n 0 -l ${dump_dir}/config.bak"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-    ${dump_cmd}
-
-    dump_cmd="slapcat -n 1 -l ${dump_dir}/data.bak"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-    ${dump_cmd}
-
-    dump_cmd="slapcat -l ${dump_dir}/all.bak"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-    ${dump_cmd}
-
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${FUNCNAME[0]}"
-}
-
-#######################################################################
-# Copy dump file of Redis instances
-#
-# Arguments:
-# --instances=[Integer] (default: all)
-#######################################################################
-dump_redis() {
-    all_instances=$(find /var/lib/ -mindepth 1 -maxdepth 1 '(' -type d -o -type l ')' -name 'redis*')
-
-    local option_instances=""
-    # Parse options, based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
-    while :; do
-        case ${1:-''} in
-            --instances)
-                # instances options, with key and value separated by space
-                if [ -n "$2" ]; then
-                    if [ "${2}" == "all" ]; then
-                        read -a option_instances <<< "${all_instances}"
-                    else
-                        IFS="," read -a option_instances <<< "${2}"
-                    fi
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--instances' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --instances=?*)
-                # instances options, with key and value separated by =
-                if [ "${1#*=}" == "all" ]; then
-                    read -a option_instances <<< "${all_instances}"
-                else
-                    IFS="," read -a option_instances <<< "${1#*=}"
-                fi
-                ;;
-            --instances=)
-                # instances options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--instances' requires a non-empty option argument."
-                exit 1
-                ;;
-            --)
-                # End of all options.
-                shift
-                break
-                ;;
-            -?*|[[:alnum:]]*)
-                # ignore unknown options
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: unknown option '${1}' (ignored)"
-                ;;
-            *)
-                # Default case: If no more options then break out of the loop.
-                break
-                ;;
-        esac
-
-        shift
-    done
-    
-    for instance in "${option_instances[@]}"; do
-        name=$(basename "${instance}")
-        local dump_dir="${LOCAL_BACKUP_DIR}/${name}"
-        local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-        rm -rf "${dump_dir}" "${errors_dir}"
-        mkdir -p "${dump_dir}" "${errors_dir}"
-        # No need to change recursively, the top directory is enough
-        chmod 700 "${dump_dir}" "${errors_dir}"
-
-        if [ -f "${instance}/dump.rdb" ]; then
-            local error_file="${errors_dir}/${name}.err"
-            log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_dir}"
-
-            # Copy the Redis database
-            dump_cmd="cp -a ${instance}/dump.rdb ${dump_dir}/dump.rdb"
-            log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-            ${dump_cmd} 2> "${error_file}"
-
-            local last_rc=$?
-            # shellcheck disable=SC2086
-            if [ ${last_rc} -ne 0 ]; then
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: cp ${instance}/dump.rdb to ${dump_dir} returned an error ${last_rc}" "${error_file}"
-                GLOBAL_RC=${E_DUMPFAILED}
-            else
-                rm -f "${error_file}"
-            fi
-
-            # Compress the Redis database
-            dump_cmd="gzip ${dump_dir}/dump.rdb"
-            log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-            ${dump_cmd}
-
-            local last_rc=$?
-            # shellcheck disable=SC2086
-            if [ ${last_rc} -ne 0 ]; then
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: gzip ${dump_dir}/dump.rdb returned an error ${last_rc}" "${error_file}"
-                GLOBAL_RC=${E_DUMPFAILED}
-            else
-                rm -f "${error_file}"
-            fi
-
-            log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_dir}"
-        else
-            log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '${instance}/dump.rdb' not found."
-        fi
-    done
-}
-
-#######################################################################
-# Dump all collections of a MongoDB database
-# using a custom authentication, instead of /etc/mysql/debian.cnf
-#
-# Arguments:
-# --port=[String] (default: <blank>)
-# --user=[String] (default: <blank>)
-# --password=[String] (default: <blank>)
-# --dump-label=[String] (default: "default")
-#   used as suffix of the dump dir to differenciate multiple instances
-# Other options after -- are passed as-is to mongodump
-#
-# don't forget to create use with read-only access
-# > use admin
-# > db.createUser( { user: "mongobackup", pwd: "PASS", roles: [ "backup", ] } )
-#######################################################################
-dump_mongodb() {
-    local option_port=""
-    local option_user=""
-    local option_password=""
-    local option_dump_label=""
-    local option_others=""
-
-    # Parse options, based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
-    while :; do
-        case ${1:-''} in
-            --port)
-                # port options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_port="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--port' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --port=?*)
-                # port options, with value separated by =
-                option_port="${1#*=}"
-                ;;
-            --port=)
-                # port options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--port' requires a non-empty option argument."
-                exit 1
-                ;;
-            --user)
-                # user options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_user="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--user' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --user=?*)
-                # user options, with value separated by =
-                option_user="${1#*=}"
-                ;;
-            --user=)
-                # user options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--user' requires a non-empty option argument."
-                exit 1
-                ;;
-            --password)
-                # password options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_password="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--password' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --password=?*)
-                # password options, with value separated by =
-                option_password="${1#*=}"
-                ;;
-            --password=)
-                # password options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--password' requires a non-empty option argument."
-                exit 1
-                ;;
-            --dump-label)
-                # dump-label options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_dump_label="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --dump-label=?*)
-                # dump-label options, with value separated by =
-                option_dump_label="${1#*=}"
-                ;;
-            --dump-label=)
-                # dump-label options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                exit 1
-                ;;
-            --)
-                # End of all options.
-                shift
-                option_others=${*}
-                break
-                ;;
-            -?*|[[:alnum:]]*)
-                # ignore unknown options
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: unknown option '${1}' (ignored)"
-                ;;
-            *)
-                # Default case: If no more options then break out of the loop.
-                break
-                ;;
-        esac
-
-        shift
-    done
-
-    if [ -z "${option_dump_label}" ]; then
-        if [ -n "${option_port}" ]; then
-            option_dump_label="${option_port}"
-        else
-            option_dump_label="default"
-        fi
-    fi
-
-    local dump_dir="${LOCAL_BACKUP_DIR}/mongodb-${option_dump_label}"
-    local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-    rm -rf "${dump_dir}" "${errors_dir}"
-    mkdir -p "${dump_dir}" "${errors_dir}"
-    # No need to change recursively, the top directory is enough
-    chmod 700 "${dump_dir}" "${errors_dir}"
-
-    local error_file="${errors_dir}.err"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_dir}"
-
-    declare -a dump_options
-    dump_options=()
-    if [ -n "${option_port}" ]; then
-        dump_options+=(--port="${option_port}")
-    fi
-    if [ -n "${option_user}" ]; then
-        dump_options+=(--username="${option_user}")
-    fi
-    if [ -n "${option_password}" ]; then
-        dump_options+=(--password="${option_password}")
-    fi
-    dump_options+=(--out="${dump_dir}/")
-    if [ -n "${option_others}" ]; then
-        # word splitting is deliberate here
-        # shellcheck disable=SC2206
-        dump_options+=(${option_others})
-    fi
-
-    dump_cmd="mongodump ${dump_options[*]}"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd} > /dev/null"
-    ${dump_cmd} 2> "${error_file}" > /dev/null
-
-    local last_rc=$?
-    # shellcheck disable=SC2086
-    if [ ${last_rc} -ne 0 ]; then
-        log_error "LOCAL_TASKS - ${FUNCNAME[0]}: mongodump to ${dump_dir} returned an error ${last_rc}" "${error_file}"
-        GLOBAL_RC=${E_DUMPFAILED}
-    else
-        rm -f "${error_file}"
-    fi
-    log "LOCAL_TASKS - stop  ${FUNCNAME[0]}: ${dump_dir}"
-}
-
-#######################################################################
-# Dump RAID configuration
-#
-# Arguments: <none>
-#######################################################################
-dump_raid_config() {
-    local dump_dir="${LOCAL_BACKUP_DIR}/raid"
-    local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-    rm -rf "${dump_dir}" "${errors_dir}"
-    mkdir -p "${dump_dir}" "${errors_dir}"
-    # No need to change recursively, the top directory is enough
-    chmod 700 "${dump_dir}" "${errors_dir}"
-
-    if command -v megacli > /dev/null; then
-        local error_file="${errors_dir}/megacli.cfg"
-        local dump_file="${dump_dir}/megacli.err"
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-
-        dump_cmd="megacli -CfgSave -f ${dump_file} -a0"
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-        ${dump_cmd} 2> "${error_file}"
-
-        local last_rc=$?
-        # shellcheck disable=SC2086
-        if [ ${last_rc} -ne 0 ]; then
-            log_error "LOCAL_TASKS - ${FUNCNAME[0]}: megacli to ${dump_file} returned an error ${last_rc}" "${error_file}"
-            GLOBAL_RC=${E_DUMPFAILED}
-        else
-            rm -f "${error_file}"
-        fi
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-    elif command -v perccli > /dev/null; then
-        local error_file="${errors_dir}/perccli.cfg"
-        local dump_file="${dump_dir}/perccli.err"
-        # log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-
-        # TODO: find out what the correct command is
-
-        # dump_cmd="perccli XXXX"
-        # log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-        # ${dump_cmd} 2> ${error_file}
-
-        # local last_rc=$?
-        # # shellcheck disable=SC2086
-        # if [ ${last_rc} -ne 0 ]; then
-        #     log_error "LOCAL_TASKS - ${FUNCNAME[0]}: perccli to ${dump_file} returned an error ${last_rc}" "${error_file}"
-        #     GLOBAL_RC=${E_DUMPFAILED}
-        # else
-        #     rm -f "${error_file}"
-        # fi
-        # log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-    else
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: 'megacli' and 'perccli' not found, unable to dump RAID configuration"
-    fi
-}
-
-#######################################################################
-# Save some traceroute/mtr results
-#
-# Arguments:
-# --targets=[IP,HOST] (default: <none>)
-#######################################################################
-dump_traceroute() {
-    local option_targets=""
-
-    # Parse options, based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
-    while :; do
-        case ${1:-''} in
-            --targets)
-                # targets options, with key and value separated by space
-                if [ -n "$2" ]; then
-                    IFS="," read -a option_targets <<< "${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--targets' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --targets=?*)
-                # targets options, with key and value separated by =
-                IFS="," read -a option_targets <<< "${1#*=}"
-                ;;
-            --targets=)
-                # targets options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--targets' requires a non-empty option argument."
-                exit 1
-                ;;
-            --)
-                # End of all options.
-                shift
-                break
-                ;;
-            -?*|[[:alnum:]]*)
-                # ignore unknown options
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: unknown option '${1}' (ignored)"
-                ;;
-            *)
-                # Default case: If no more options then break out of the loop.
-                break
-                ;;
-        esac
-
-        shift
-    done
-
-    local dump_dir="${LOCAL_BACKUP_DIR}/traceroute"
-    local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-    rm -rf "${dump_dir}" "${errors_dir}"
-    mkdir -p "${dump_dir}" "${errors_dir}"
-    # No need to change recursively, the top directory is enough
-    chmod 700 "${dump_dir}" "${errors_dir}"
-
-
-    mtr_bin=$(command -v mtr)
-    if [ -n "${mtr_bin}" ]; then
-        for target in "${option_targets[@]}"; do
-            local dump_file="${dump_dir}/mtr-${target}"
-            log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-
-            ${mtr_bin} -r "${target}" > "${dump_file}"
-
-            log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-        done
-    fi
-
-    traceroute_bin=$(command -v traceroute)
-    if [ -n "${traceroute_bin}" ]; then
-        for target in "${option_targets[@]}"; do
-            local dump_file="${dump_dir}/traceroute-${target}"
-            log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-
-            ${traceroute_bin} -n "${target}" > "${dump_file}" 2>&1
-
-            log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-        done
-    fi
-}
-
-#######################################################################
-# Save many system information, using dump_server_state
-#
-# Arguments:
-# any option for dump-server-state (except --dump-dir) is usable
-# (default: --all)
-#######################################################################
-dump_server_state() {
-    local dump_dir="${LOCAL_BACKUP_DIR}/server-state"
-    rm -rf "${dump_dir}"
-    # Do not create the directory
-    # mkdir -p -m 700 "${dump_dir}"
-
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_dir}"
-
-    # pass all options
-    read -a options <<< "${@}"
-    # if no option is given, use "--all" as fallback
-    if [ ${#options[@]} -le 0 ]; then
-        options=(--all)
-    fi
-    # add "--dump-dir" in case it is missing (as it should)
-    options+=(--dump-dir "${dump_dir}")
-
-    dump_server_state_bin=$(command -v dump-server-state)
-    if [ -z "${dump_server_state_bin}" ]; then
-        log_error "LOCAL_TASKS - ${FUNCNAME[0]}: dump-server-state is missing"
-        rc=1
-    else
-        dump_cmd="${dump_server_state_bin} ${options[*]}"
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-        ${dump_cmd}
-
-        local last_rc=$?
-        # shellcheck disable=SC2086
-        if [ ${last_rc} -ne 0 ]; then
-            log_error "LOCAL_TASKS - ${FUNCNAME[0]}: dump-server-state returned an error ${last_rc}, check ${dump_dir}"
-            GLOBAL_RC=${E_DUMPFAILED}
-        fi
-    fi
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_dir}"
-}
-
-#######################################################################
-# Save RabbitMQ data
-# 
-# Arguments: <none>
-# 
-# Warning: This has been poorly tested
-#######################################################################
-dump_rabbitmq() {
-    local dump_dir="${LOCAL_BACKUP_DIR}/rabbitmq"
-    local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-    rm -rf "${dump_dir}" "${errors_dir}"
-    mkdir -p "${dump_dir}" "${errors_dir}"
-    # No need to change recursively, the top directory is enough
-    chmod 700 "${dump_dir}" "${errors_dir}"
-
-    local error_file="${errors_dir}.err"
-    local dump_file="${dump_dir}/config"
-
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-
-    dump_cmd="rabbitmqadmin export ${dump_file}"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-    ${dump_cmd} 2> "${error_file}"
-
-    local last_rc=$?
-    # shellcheck disable=SC2086
-    if [ ${last_rc} -ne 0 ]; then
-        log_error "LOCAL_TASKS - ${FUNCNAME[0]}: pg_dump to ${dump_file} returned an error ${last_rc}" "${error_file}"
-        GLOBAL_RC=${E_DUMPFAILED}
-    else
-        rm -f "${error_file}"
-    fi
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-}
-
-#######################################################################
-# Save Files ACL on various partitions.
-# 
-# Arguments: <none>
-#######################################################################
-dump_facl() {
-    local dump_dir="${LOCAL_BACKUP_DIR}/facl"
-    local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-    rm -rf "${dump_dir}" "${errors_dir}"
-    mkdir -p "${dump_dir}" "${errors_dir}"
-    # No need to change recursively, the top directory is enough
-    chmod 700 "${dump_dir}" "${errors_dir}"
-
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_dir}"
-
-    dump_cmd="getfacl -R /etc  > ${dump_dir}/etc.txt"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-    ${dump_cmd}
-
-    dump_cmd="getfacl -R /home  > ${dump_dir}/home.txt"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-    ${dump_cmd}
-
-    dump_cmd="getfacl -R /usr  > ${dump_dir}/usr.txt"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-    ${dump_cmd}
-
-    dump_cmd="getfacl -R /var  > ${dump_dir}/var.txt"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-    ${dump_cmd}
-
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_dir}"
-}

client/lib/dump/mysql.sh

@@ -1,1551 +0,0 @@
-#!/usr/bin/env bash
-# shellcheck disable=SC2034,SC2317,SC2155
-
-#######################################################################
-# Dump complete summary of an instance (using pt-mysql-summary)
-#
-# Arguments:
-# --port=[Integer] (default: <blank>)
-# --socket=[String] (default: <blank>)
-# --user=[String] (default: <blank>)
-# --password=[String] (default: <blank>)
-# --defaults-file=[String] (default: <blank>)
-# --defaults-extra-file=[String] (default: <blank>)
-# --defaults-group-suffix=[String] (default: <blank>)
-# --dump-label=[String] (default: "default")
-#   used as suffix of the dump dir to differenciate multiple instances
-#######################################################################
-dump_mysql_summary() {
-    local option_port=""
-    local option_socket=""
-    local option_defaults_file=""
-    local option_defaults_extra_file=""
-    local option_defaults_group_suffix=""
-    local option_user=""
-    local option_password=""
-    local option_dump_label=""
-
-    # Parse options, based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
-    while :; do
-        case ${1:-''} in
-            --defaults-file)
-                # defaults-file options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_defaults_file="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-file' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --defaults-file=?*)
-                # defaults-file options, with value separated by =
-                option_defaults_file="${1#*=}"
-                ;;
-            --defaults-file=)
-                # defaults-file options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-file' requires a non-empty option argument."
-                exit 1
-                ;;
-            --defaults-extra-file)
-                # defaults-file options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_defaults_extra_file="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-file' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --defaults-extra-file=?*)
-                # defaults-extra-file options, with value separated by =
-                option_defaults_extra_file="${1#*=}"
-                ;;
-            --defaults-extra-file=)
-                # defaults-extra-file options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-extra-file' requires a non-empty option argument."
-                exit 1
-                ;;
-            --defaults-group-suffix)
-                # defaults-group-suffix options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_defaults_group_suffix="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-group-suffix' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --defaults-group-suffix=?*)
-                # defaults-group-suffix options, with value separated by =
-                option_defaults_group_suffix="${1#*=}"
-                ;;
-            --defaults-group-suffix=)
-                # defaults-group-suffix options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-group-suffix' requires a non-empty option argument."
-                exit 1
-                ;;
-            --port)
-                # port options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_port="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--port' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --port=?*)
-                # port options, with value separated by =
-                option_port="${1#*=}"
-                ;;
-            --port=)
-                # port options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--port' requires a non-empty option argument."
-                exit 1
-                ;;
-            --socket)
-                # socket options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_socket="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--socket' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --socket=?*)
-                # socket options, with value separated by =
-                option_socket="${1#*=}"
-                ;;
-            --socket=)
-                # socket options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--socket' requires a non-empty option argument."
-                exit 1
-                ;;
-            --user)
-                # user options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_user="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--user' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --user=?*)
-                # user options, with value separated by =
-                option_user="${1#*=}"
-                ;;
-            --user=)
-                # user options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--user' requires a non-empty option argument."
-                exit 1
-                ;;
-            --password)
-                # password options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_password="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--password' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --password=?*)
-                # password options, with value separated by =
-                option_password="${1#*=}"
-                ;;
-            --password=)
-                # password options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--password' requires a non-empty option argument."
-                exit 1
-                ;;
-            --dump-label)
-                # dump-label options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_dump_label="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --dump-label=?*)
-                # dump-label options, with value separated by =
-                option_dump_label="${1#*=}"
-                ;;
-            --dump-label=)
-                # dump-label options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                exit 1
-                ;;
-            --)
-                # End of all options.
-                shift
-                break
-                ;;
-            -?*|[[:alnum:]]*)
-                # ignore unknown options
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: unkwnown option (ignored): '${1}'"
-                ;;
-            *)
-                # Default case: If no more options then break out of the loop.
-                break
-                ;;
-        esac
-
-        shift
-    done
-
-    if [ -z "${option_dump_label}" ]; then
-        if [ -n "${option_defaults_group_suffix}" ]; then
-            option_dump_label="${option_defaults_group_suffix}"
-        elif [ -n "${option_port}" ]; then
-            option_dump_label="${option_port}"
-        elif [ -n "${option_socket}" ]; then
-            option_dump_label=$(path_to_str "${option_socket}")
-        else
-            option_dump_label="default"
-        fi
-    fi
-
-    local dump_dir="${LOCAL_BACKUP_DIR}/mysql-${option_dump_label}-summary"
-    local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-    rm -rf "${dump_dir}" "${errors_dir}"
-    mkdir -p "${dump_dir}" "${errors_dir}"
-    # No need to change recursively, the top directory is enough
-    chmod 700 "${dump_dir}" "${errors_dir}"
-
-    ## Dump all grants (requires 'percona-toolkit' package)
-    if command -v pt-mysql-summary > /dev/null; then
-        local error_file="${errors_dir}/mysql-summary.err"
-        local dump_file="${dump_dir}/mysql-summary.out"
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-
-        ## Connection options
-        declare -a connect_options
-        connect_options=()
-        if [ -n "${option_defaults_file}" ]; then
-            connect_options+=(--defaults-file="${option_defaults_file}")
-        fi
-        if [ -n "${option_defaults_extra_file}" ]; then
-            connect_options+=(--defaults-extra-file="${option_defaults_extra_file}")
-        fi
-        if [ -n "${option_defaults_group_suffix}" ]; then
-            connect_options+=(--defaults-group-suffix="${option_defaults_group_suffix}")
-        fi
-        if [ -n "${option_port}" ]; then
-            connect_options+=(--protocol=tcp)
-            connect_options+=(--port="${option_port}")
-        fi
-        if [ -n "${option_socket}" ]; then
-            connect_options+=(--protocol=socket)
-            connect_options+=(--socket="${option_socket}")
-        fi
-        if [ -n "${option_user}" ]; then
-            connect_options+=(--user="${option_user}")
-        fi
-        if [ -n "${option_password}" ]; then
-            connect_options+=(--password="${option_password}")
-        fi
-
-        declare -a options
-        options=()
-        options+=(--sleep=0)
-
-        dump_cmd="pt-mysql-summary ${options[*]} -- ${connect_options[*]}"
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-        ${dump_cmd} 2> "${error_file}" > "${dump_file}"
-
-        local last_rc=$?
-        # shellcheck disable=SC2086
-        if [ ${last_rc} -ne 0 ]; then
-            log_error "LOCAL_TASKS - ${FUNCNAME[0]}: pt-mysql-summary to ${dump_file} returned an error ${last_rc}" "${error_file}"
-            GLOBAL_RC=${E_DUMPFAILED}
-        else
-            rm -f "${error_file}"
-        fi
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-    else
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: 'pt-mysql-summary' not found, unable to dump summary"
-    fi
-}
-
-#######################################################################
-# Dump grants of an instance
-#
-# Arguments:
-# --port=[Integer] (default: <blank>)
-# --socket=[String] (default: <blank>)
-# --user=[String] (default: <blank>)
-# --password=[String] (default: <blank>)
-# --defaults-file=[String] (default: <blank>)
-# --dump-label=[String] (default: "default")
-#   used as suffix of the dump dir to differenciate multiple instances
-#######################################################################
-dump_mysql_grants() {
-    local option_port=""
-    local option_socket=""
-    local option_defaults_file=""
-    local option_user=""
-    local option_password=""
-    local option_dump_label=""
-
-    # Parse options, based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
-    while :; do
-        case ${1:-''} in
-            --defaults-file)
-                # defaults-file options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_defaults_file="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-file' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --defaults-file=?*)
-                # defaults-file options, with value separated by =
-                option_defaults_file="${1#*=}"
-                ;;
-            --defaults-file=)
-                # defaults-file options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-file' requires a non-empty option argument."
-                exit 1
-                ;;
-            --port)
-                # port options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_port="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--port' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --port=?*)
-                # port options, with value separated by =
-                option_port="${1#*=}"
-                ;;
-            --port=)
-                # port options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--port' requires a non-empty option argument."
-                exit 1
-                ;;
-            --socket)
-                # socket options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_socket="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--socket' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --socket=?*)
-                # socket options, with value separated by =
-                option_socket="${1#*=}"
-                ;;
-            --socket=)
-                # socket options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--socket' requires a non-empty option argument."
-                exit 1
-                ;;
-            --user)
-                # user options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_user="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--user' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --user=?*)
-                # user options, with value separated by =
-                option_user="${1#*=}"
-                ;;
-            --user=)
-                # user options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--user' requires a non-empty option argument."
-                exit 1
-                ;;
-            --password)
-                # password options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_password="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--password' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --password=?*)
-                # password options, with value separated by =
-                option_password="${1#*=}"
-                ;;
-            --password=)
-                # password options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--password' requires a non-empty option argument."
-                exit 1
-                ;;
-            --dump-label)
-                # dump-label options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_dump_label="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --dump-label=?*)
-                # dump-label options, with value separated by =
-                option_dump_label="${1#*=}"
-                ;;
-            --dump-label=)
-                # dump-label options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                exit 1
-                ;;
-            --)
-                # End of all options.
-                shift
-                break
-                ;;
-            -?*|[[:alnum:]]*)
-                # ignore unknown options
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: unknown option '${1}' (ignored)"
-                ;;
-            *)
-                # Default case: If no more options then break out of the loop.
-                break
-                ;;
-        esac
-
-        shift
-    done
-
-    if [ -z "${option_dump_label}" ]; then
-        if [ -n "${option_port}" ]; then
-            option_dump_label="${option_port}"
-        elif [ -n "${option_socket}" ]; then
-            option_dump_label=$(path_to_str "${option_socket}")
-        else
-            option_dump_label="default"
-        fi
-    fi
-
-    local dump_dir="${LOCAL_BACKUP_DIR}/mysql-${option_dump_label}-grants"
-    local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-    rm -rf "${dump_dir}" "${errors_dir}"
-    mkdir -p "${dump_dir}" "${errors_dir}"
-    # No need to change recursively, the top directory is enough
-    chmod 700 "${dump_dir}" "${errors_dir}"
-
-    ## Dump all grants (requires 'percona-toolkit' package)
-    if command -v pt-show-grants > /dev/null; then
-        local error_file="${errors_dir}/all_grants.err"
-        local dump_file="${dump_dir}/all_grants.sql"
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-
-        declare -a options
-        options=()
-        if [ -n "${option_defaults_file}" ]; then
-            options+=(--defaults-file="${option_defaults_file}")
-        fi
-        if [ -n "${option_port}" ]; then
-            options+=(--port="${option_port}")
-        fi
-        if [ -n "${option_socket}" ]; then
-            options+=(--socket="${option_socket}")
-        fi
-        if [ -n "${option_user}" ]; then
-            options+=(--user="${option_user}")
-        fi
-        if [ -n "${option_password}" ]; then
-            options+=(--password="${option_password}")
-        fi
-        options+=(--flush)
-        options+=(--no-header)
-
-        dump_cmd="pt-show-grants ${options[*]}"
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-        ${dump_cmd} 2> "${error_file}" > "${dump_file}"
-
-        local last_rc=$?
-        # shellcheck disable=SC2086
-        if [ ${last_rc} -ne 0 ]; then
-            log_error "LOCAL_TASKS - ${FUNCNAME[0]}: pt-show-grants to ${dump_file} returned an error ${last_rc}" "${error_file}"
-            GLOBAL_RC=${E_DUMPFAILED}
-        else
-            rm -f "${error_file}"
-        fi
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-    else
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: 'pt-show-grants' not found, unable to dump grants"
-    fi
-}
-
-#######################################################################
-# Dump a single compressed file of all databases of an instance
-# and a file containing only the schema.
-#
-# Arguments:
-# --masterdata (default: <absent>)
-# --port=[Integer] (default: <blank>)
-# --socket=[String] (default: <blank>)
-# --user=[String] (default: <blank>)
-# --password=[String] (default: <blank>)
-# --defaults-file=[String] (default: <blank>)
-# --defaults-extra-file=[String] (default: <blank>)
-# --defaults-group-suffix=[String] (default: <blank>)
-# --dump-label=[String] (default: "default")
-#   used as suffix of the dump dir to differenciate multiple instances
-# --compress=<gzip|pigz|bzip2|xz|none> (default: "gzip")
-# Other options after -- are passed as-is to mysqldump
-#######################################################################
-dump_mysql_global() {
-    local option_masterdata=""
-    local option_port=""
-    local option_socket=""
-    local option_defaults_file=""
-    local option_defaults_extra_file=""
-    local option_defaults_group_suffix=""
-    local option_user=""
-    local option_password=""
-    local option_dump_label=""
-    local option_compress=""
-    local option_others=""
-
-    # Parse options, based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
-    while :; do
-        case ${1:-''} in
-            --masterdata)
-                option_masterdata="--masterdata"
-                ;;
-            --defaults-file)
-                # defaults-file options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_defaults_file="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-file' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --defaults-file=?*)
-                # defaults-file options, with value separated by =
-                option_defaults_file="${1#*=}"
-                ;;
-            --defaults-file=)
-                # defaults-file options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-file' requires a non-empty option argument."
-                exit 1
-                ;;
-            --defaults-extra-file)
-                # defaults-file options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_defaults_extra_file="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-file' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --defaults-extra-file=?*)
-                # defaults-extra-file options, with value separated by =
-                option_defaults_extra_file="${1#*=}"
-                ;;
-            --defaults-extra-file=)
-                # defaults-extra-file options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-extra-file' requires a non-empty option argument."
-                exit 1
-                ;;
-            --defaults-group-suffix)
-                # defaults-group-suffix options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_defaults_group_suffix="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-group-suffix' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --defaults-group-suffix=?*)
-                # defaults-group-suffix options, with value separated by =
-                option_defaults_group_suffix="${1#*=}"
-                ;;
-            --defaults-group-suffix=)
-                # defaults-group-suffix options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-group-suffix' requires a non-empty option argument."
-                exit 1
-                ;;
-            --port)
-                # port options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_port="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--port' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --port=?*)
-                # port options, with value separated by =
-                option_port="${1#*=}"
-                ;;
-            --port=)
-                # port options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--port' requires a non-empty option argument."
-                exit 1
-                ;;
-            --socket)
-                # socket options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_socket="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--socket' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --socket=?*)
-                # socket options, with value separated by =
-                option_socket="${1#*=}"
-                ;;
-            --socket=)
-                # socket options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--socket' requires a non-empty option argument."
-                exit 1
-                ;;
-            --user)
-                # user options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_user="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--user' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --user=?*)
-                # user options, with value separated by =
-                option_user="${1#*=}"
-                ;;
-            --user=)
-                # user options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--user' requires a non-empty option argument."
-                exit 1
-                ;;
-            --password)
-                # password options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_password="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--password' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --password=?*)
-                # password options, with value separated by =
-                option_password="${1#*=}"
-                ;;
-            --password=)
-                # password options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--password' requires a non-empty option argument."
-                exit 1
-                ;;
-            --dump-label)
-                # dump-label options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_dump_label="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --dump-label=?*)
-                # dump-label options, with value separated by =
-                option_dump_label="${1#*=}"
-                ;;
-            --dump-label=)
-                # dump-label options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                exit 1
-                ;;
-            --compress)
-                # compress options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_compress="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--compress' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --compress=?*)
-                # compress options, with value separated by =
-                option_compress="${1#*=}"
-                ;;
-            --compress=)
-                # compress options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--compress' requires a non-empty option argument."
-                exit 1
-                ;;
-            --)
-                # End of all options.
-                shift
-                option_others=${*}
-                break
-                ;;
-            -?*|[[:alnum:]]*)
-                # ignore unknown options
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: unknown option '${1}' (ignored)"
-                ;;
-            *)
-                # Default case: If no more options then break out of the loop.
-                break
-                ;;
-        esac
-
-        shift
-    done
-
-    case "${option_compress}" in
-        none)
-            compress_cmd="cat"
-            dump_ext=""
-            ;;
-        bzip2|bz|bz2)
-            compress_cmd="bzip2 --best"
-            dump_ext=".bz"
-            ;;
-        xz)
-            compress_cmd="xz --best"
-            dump_ext=".xz"
-            ;;
-        pigz)
-            compress_cmd="pigz --best"
-            dump_ext=".gz"
-            ;;
-        gz|gzip|*)
-            compress_cmd="gzip --best"
-            dump_ext=".gz"
-            ;;
-    esac
-
-    if [ -z "${option_dump_label}" ]; then
-        if [ -n "${option_defaults_group_suffix}" ]; then
-            option_dump_label="${option_defaults_group_suffix}"
-        elif [ -n "${option_port}" ]; then
-            option_dump_label="${option_port}"
-        elif [ -n "${option_socket}" ]; then
-            option_dump_label=$(path_to_str "${option_socket}")
-        else
-            option_dump_label="default"
-        fi
-    fi
-
-    ## Connection options
-    declare -a connect_options
-    connect_options=()
-    if [ -n "${option_defaults_file}" ]; then
-        connect_options+=(--defaults-file="${option_defaults_file}")
-    fi
-    if [ -n "${option_defaults_extra_file}" ]; then
-        connect_options+=(--defaults-extra-file="${option_defaults_extra_file}")
-    fi
-    if [ -n "${option_defaults_group_suffix}" ]; then
-        connect_options+=(--defaults-group-suffix="${option_defaults_group_suffix}")
-    fi
-    if [ -n "${option_port}" ]; then
-        connect_options+=(--protocol=tcp)
-        connect_options+=(--port="${option_port}")
-    fi
-    if [ -n "${option_socket}" ]; then
-        connect_options+=(--protocol=socket)
-        connect_options+=(--socket="${option_socket}")
-    fi
-    if [ -n "${option_user}" ]; then
-        connect_options+=(--user="${option_user}")
-    fi
-    if [ -n "${option_password}" ]; then
-        connect_options+=(--password="${option_password}")
-    fi
-
-    ## Global all databases in one file
-
-    local dump_dir="${LOCAL_BACKUP_DIR}/mysql-${option_dump_label}"
-    local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-    rm -rf "${dump_dir}" "${errors_dir}"
-    mkdir -p "${dump_dir}" "${errors_dir}"
-    # No need to change recursively, the top directory is enough
-    chmod 700 "${dump_dir}" "${errors_dir}"
-
-    local error_file="${errors_dir}/mysqldump.err"
-    local dump_file="${dump_dir}/mysqldump.sql${dump_ext}"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-
-    declare -a dump_options
-    dump_options=()
-    dump_options+=(--opt)
-    dump_options+=(--force)
-    dump_options+=(--events)
-    dump_options+=(--hex-blob)
-    dump_options+=(--all-databases)
-    if [ -n "${option_masterdata}" ]; then
-        dump_options+=("${option_masterdata}")
-    fi
-    if [ -n "${option_others}" ]; then
-        # word splitting is deliberate here
-        # shellcheck disable=SC2206
-        dump_options+=(${option_others})
-    fi
-
-    ## WARNING : logging and executing the command must be separate
-    ## because otherwise Bash would interpret | and > as strings and not syntax.
-
-    dump_cmd="mysqldump ${connect_options[*]} ${dump_options[*]} 2> ${error_file} | ${compress_cmd} > ${dump_file}"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-    mysqldump "${connect_options[@]}" "${dump_options[@]}" 2> "${error_file}" | ${compress_cmd} > "${dump_file}"
-
-    local last_rc=$?
-    # shellcheck disable=SC2086
-    if [ ${last_rc} -ne 0 ]; then
-        log_error "LOCAL_TASKS - ${FUNCNAME[0]}: mysqldump returned an error ${last_rc}" "${error_file}"
-        GLOBAL_RC=${E_DUMPFAILED}
-    else
-        rm -f "${error_file}"
-    fi
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-
-
-    ## Schema only (no data) for each databases
-
-    local error_file="${errors_dir}/mysqldump.schema.err"
-    local dump_file="${dump_dir}/mysqldump.schema.sql"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-
-    declare -a dump_options
-    dump_options=()
-    dump_options+=(--force)
-    dump_options+=(--no-data)
-    dump_options+=(--all-databases)
-    if [ -n "${option_others}" ]; then
-        # word splitting is deliberate here
-        # shellcheck disable=SC2206
-        dump_options+=(${option_others})
-    fi
-
-    dump_cmd="mysqldump ${connect_options[*]} ${dump_options[*]}"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-    ${dump_cmd} 2> "${error_file}" > "${dump_file}"
-
-    local last_rc=$?
-    # shellcheck disable=SC2086
-    if [ ${last_rc} -ne 0 ]; then
-        log_error "LOCAL_TASKS - ${FUNCNAME[0]}: mysqldump returned an error ${last_rc}" "${error_file}"
-        GLOBAL_RC=${E_DUMPFAILED}
-    else
-        rm -f "${error_file}"
-    fi
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-}
-
-#######################################################################
-# Dump a file of each databases of an instance
-# and a file containing only the schema.
-#
-# Arguments:
-# --port=[Integer] (default: <blank>)
-# --socket=[String] (default: <blank>)
-# --user=[String] (default: <blank>)
-# --password=[String] (default: <blank>)
-# --defaults-file=[String] (default: <blank>)
-# --defaults-extra-file=[String] (default: <blank>)
-# --defaults-group-suffix=[String] (default: <blank>)
-# --dump-label=[String] (default: "default")
-#   used as suffix of the dump dir to differenciate multiple instances
-# --compress=<gzip|pigz|bzip2|xz|none> (default: "gzip")
-# Other options after -- are passed as-is to mysqldump
-#######################################################################
-dump_mysql_per_base() {
-    local option_port=""
-    local option_socket=""
-    local option_defaults_file=""
-    local option_defaults_extra_file=""
-    local option_defaults_group_suffix=""
-    local option_user=""
-    local option_password=""
-    local option_dump_label=""
-    local option_compress=""
-    local option_others=""
-
-    # Parse options, based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
-    while :; do
-        case ${1:-''} in
-            --defaults-file)
-                # defaults-file options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_defaults_file="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-file' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --defaults-file=?*)
-                # defaults-file options, with value separated by =
-                option_defaults_file="${1#*=}"
-                ;;
-            --defaults-file=)
-                # defaults-file options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-file' requires a non-empty option argument."
-                exit 1
-                ;;
-            --defaults-extra-file)
-                # defaults-file options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_defaults_extra_file="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-file' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --defaults-extra-file=?*)
-                # defaults-extra-file options, with value separated by =
-                option_defaults_extra_file="${1#*=}"
-                ;;
-            --defaults-extra-file=)
-                # defaults-extra-file options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-extra-file' requires a non-empty option argument."
-                exit 1
-                ;;
-            --defaults-group-suffix)
-                # defaults-group-suffix options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_defaults_group_suffix="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-group-suffix' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --defaults-group-suffix=?*)
-                # defaults-group-suffix options, with value separated by =
-                option_defaults_group_suffix="${1#*=}"
-                ;;
-            --defaults-group-suffix=)
-                # defaults-group-suffix options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-group-suffix' requires a non-empty option argument."
-                exit 1
-                ;;
-            --port)
-                # port options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_port="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--port' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --port=?*)
-                # port options, with value separated by =
-                option_port="${1#*=}"
-                ;;
-            --port=)
-                # port options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--port' requires a non-empty option argument."
-                exit 1
-                ;;
-            --socket)
-                # socket options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_socket="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--socket' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --socket=?*)
-                # socket options, with value separated by =
-                option_socket="${1#*=}"
-                ;;
-            --socket=)
-                # socket options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--socket' requires a non-empty option argument."
-                exit 1
-                ;;
-            --user)
-                # user options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_user="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--user' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --user=?*)
-                # user options, with value separated by =
-                option_user="${1#*=}"
-                ;;
-            --user=)
-                # user options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--user' requires a non-empty option argument."
-                exit 1
-                ;;
-            --password)
-                # password options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_password="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--password' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --password=?*)
-                # password options, with value separated by =
-                option_password="${1#*=}"
-                ;;
-            --password=)
-                # password options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--password' requires a non-empty option argument."
-                exit 1
-                ;;
-            --dump-label)
-                # dump-label options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_dump_label="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --dump-label=?*)
-                # dump-label options, with value separated by =
-                option_dump_label="${1#*=}"
-                ;;
-            --dump-label=)
-                # dump-label options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                exit 1
-                ;;
-            --compress)
-                # compress options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_compress="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--compress' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --compress=?*)
-                # compress options, with value separated by =
-                option_compress="${1#*=}"
-                ;;
-            --compress=)
-                # compress options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--compress' requires a non-empty option argument."
-                exit 1
-                ;;
-            --)
-                # End of all options.
-                shift
-                option_others=${*}
-                break
-                ;;
-            -?*|[[:alnum:]]*)
-                # ignore unknown options
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: unknown option '${1}' (ignored)"
-                ;;
-            *)
-                # Default case: If no more options then break out of the loop.
-                break
-                ;;
-        esac
-
-        shift
-    done
-
-    case "${option_compress}" in
-        none)
-            compress_cmd="cat"
-            dump_ext=""
-            ;;
-        bzip2|bz|bz2)
-            compress_cmd="bzip2 --best"
-            dump_ext=".bz"
-            ;;
-        xz)
-            compress_cmd="xz --best"
-            dump_ext=".xz"
-            ;;
-        pigz)
-            compress_cmd="pigz --best"
-            dump_ext=".gz"
-            ;;
-        gz|gzip|*)
-            compress_cmd="gzip --best"
-            dump_ext=".gz"
-            ;;
-    esac
-
-    if [ -z "${option_dump_label}" ]; then
-        if [ -n "${option_defaults_group_suffix}" ]; then
-            option_dump_label="${option_defaults_group_suffix}"
-        elif [ -n "${option_port}" ]; then
-            option_dump_label="${option_port}"
-        elif [ -n "${option_socket}" ]; then
-            option_dump_label=$(path_to_str "${option_socket}")
-        else
-            option_dump_label="default"
-        fi
-    fi
-
-    ## Connection options
-    declare -a connect_options
-    connect_options=()
-    if [ -n "${option_defaults_file}" ]; then
-        connect_options+=(--defaults-file="${option_defaults_file}")
-    fi
-    if [ -n "${option_defaults_extra_file}" ]; then
-        connect_options+=(--defaults-extra-file="${option_defaults_extra_file}")
-    fi
-    if [ -n "${option_defaults_group_suffix}" ]; then
-        connect_options+=(--defaults-group-suffix="${option_defaults_group_suffix}")
-    fi
-    if [ -n "${option_port}" ]; then
-        connect_options+=(--protocol=tcp)
-        connect_options+=(--port="${option_port}")
-    fi
-    if [ -n "${option_socket}" ]; then
-        connect_options+=(--protocol=socket)
-        connect_options+=(--socket="${option_socket}")
-    fi
-    if [ -n "${option_user}" ]; then
-        connect_options+=(--user="${option_user}")
-    fi
-    if [ -n "${option_password}" ]; then
-        connect_options+=(--password="${option_password}")
-    fi
-
-    local dump_dir="${LOCAL_BACKUP_DIR}/mysql-${option_dump_label}-per-base"
-    local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-    rm -rf "${dump_dir}" "${errors_dir}"
-    mkdir -p "${dump_dir}" "${errors_dir}"
-    # No need to change recursively, the top directory is enough
-    chmod 700 "${dump_dir}" "${errors_dir}"
-
-    databases=$(mysql "${connect_options[@]}" --execute="show databases" --silent --skip-column-names \
-        | grep --extended-regexp --invert-match "^(Database|information_schema|performance_schema|sys)")
-
-    for database in ${databases}; do
-        local error_file="${errors_dir}/${database}.err"
-        local dump_file="${dump_dir}/${database}.sql${dump_ext}"
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-
-        declare -a dump_options
-        dump_options=()
-        dump_options+=(--opt)
-        dump_options+=(--force)
-        dump_options+=(--events)
-        dump_options+=(--hex-blob)
-        dump_options+=(--databases "${database}")
-        if [ -n "${option_others}" ]; then
-            # word splitting is deliberate here
-            # shellcheck disable=SC2206
-            dump_options+=(${option_others})
-        fi
-
-        ## WARNING : logging and executing the command must be separate
-        ## because otherwise Bash would interpret | and > as strings and not syntax.
-
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: mysqldump ${connect_options[*]} ${dump_options[*]} | ${compress_cmd} > ${dump_file}"
-        mysqldump "${connect_options[@]}" "${dump_options[@]}" 2> "${error_file}" | ${compress_cmd} > "${dump_file}"
-
-        local last_rc=$?
-        # shellcheck disable=SC2086
-        if [ ${last_rc} -ne 0 ]; then
-            log_error "LOCAL_TASKS - ${FUNCNAME[0]}: mysqldump returned an error ${last_rc}" "${error_file}"
-            GLOBAL_RC=${E_DUMPFAILED}
-        else
-            rm -f "${error_file}"
-        fi
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-
-
-        ## Schema only (no data) for each databases
-
-        local error_file="${errors_dir}/${database}.schema.err"
-        local dump_file="${dump_dir}/${database}.schema.sql"
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-
-        declare -a dump_options
-        dump_options=()
-        dump_options+=(--force)
-        dump_options+=(--no-data)
-        dump_options+=(--databases "${database}")
-        if [ -n "${option_others}" ]; then
-            # word splitting is deliberate here
-            # shellcheck disable=SC2206
-            dump_options+=(${option_others})
-        fi
-
-        dump_cmd="mysqldump ${connect_options[*]} ${dump_options[*]}"
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-        ${dump_cmd} 2> "${error_file}" > "${dump_file}"
-
-        local last_rc=$?
-        # shellcheck disable=SC2086
-        if [ ${last_rc} -ne 0 ]; then
-            log_error "LOCAL_TASKS - ${FUNCNAME[0]}: mysqldump returned an error ${last_rc}" "${error_file}"
-            GLOBAL_RC=${E_DUMPFAILED}
-        else
-            rm -f "${error_file}"
-        fi
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-    done
-}
-
-#######################################################################
-# Dump "tabs style" separate schema/data for each database of an instance
-#
-# Arguments:
-# --port=[Integer] (default: <blank>)
-# --socket=[String] (default: <blank>)
-# --user=[String] (default: <blank>)
-# --password=[String] (default: <blank>)
-# --defaults-file=[String] (default: <blank>)
-# --defaults-extra-file=[String] (default: <blank>)
-# --defaults-group-suffix=[String] (default: <blank>)
-# --dump-label=[String] (default: "default")
-#   used as suffix of the dump dir to differenciate multiple instances
-# --compress=<gzip|pigz|bzip2|xz|none> (default: "gzip")
-# Other options after -- are passed as-is to mysqldump
-#######################################################################
-dump_mysql_tabs() {
-    local option_port=""
-    local option_socket=""
-    local option_defaults_file=""
-    local option_defaults_extra_file=""
-    local option_defaults_group_suffix=""
-    local option_user=""
-    local option_password=""
-    local option_dump_label=""
-    local option_compress=""
-    local option_others=""
-
-    # Parse options, based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
-    while :; do
-        case ${1:-''} in
-            --defaults-file)
-                # defaults-file options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_defaults_file="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-file' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --defaults-file=?*)
-                # defaults-file options, with value separated by =
-                option_defaults_file="${1#*=}"
-                ;;
-            --defaults-file=)
-                # defaults-file options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-file' requires a non-empty option argument."
-                exit 1
-                ;;
-            --defaults-extra-file)
-                # defaults-file options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_defaults_extra_file="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-file' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --defaults-extra-file=?*)
-                # defaults-extra-file options, with value separated by =
-                option_defaults_extra_file="${1#*=}"
-                ;;
-            --defaults-extra-file=)
-                # defaults-extra-file options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-extra-file' requires a non-empty option argument."
-                exit 1
-                ;;
-            --defaults-group-suffix)
-                # defaults-group-suffix options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_defaults_group_suffix="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-group-suffix' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --defaults-group-suffix=?*)
-                # defaults-group-suffix options, with value separated by =
-                option_defaults_group_suffix="${1#*=}"
-                ;;
-            --defaults-group-suffix=)
-                # defaults-group-suffix options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--defaults-group-suffix' requires a non-empty option argument."
-                exit 1
-                ;;
-            --port)
-                # port options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_port="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--port' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --port=?*)
-                # port options, with value separated by =
-                option_port="${1#*=}"
-                ;;
-            --port=)
-                # port options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--port' requires a non-empty option argument."
-                exit 1
-                ;;
-            --socket)
-                # socket options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_socket="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--socket' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --socket=?*)
-                # socket options, with value separated by =
-                option_socket="${1#*=}"
-                ;;
-            --socket=)
-                # socket options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--socket' requires a non-empty option argument."
-                exit 1
-                ;;
-            --user)
-                # user options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_user="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--user' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --user=?*)
-                # user options, with value separated by =
-                option_user="${1#*=}"
-                ;;
-            --user=)
-                # user options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--user' requires a non-empty option argument."
-                exit 1
-                ;;
-            --password)
-                # password options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_password="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--password' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --password=?*)
-                # password options, with value separated by =
-                option_password="${1#*=}"
-                ;;
-            --password=)
-                # password options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--password' requires a non-empty option argument."
-                exit 1
-                ;;
-            --dump-label)
-                # dump-label options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_dump_label="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --dump-label=?*)
-                # dump-label options, with value separated by =
-                option_dump_label="${1#*=}"
-                ;;
-            --dump-label=)
-                # dump-label options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                exit 1
-                ;;
-            --compress)
-                # compress options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_compress="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--compress' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --compress=?*)
-                # compress options, with value separated by =
-                option_compress="${1#*=}"
-                ;;
-            --compress=)
-                # compress options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--compress' requires a non-empty option argument."
-                exit 1
-                ;;
-            --)
-                # End of all options.
-                shift
-                option_others=${*}
-                break
-                ;;
-            -?*|[[:alnum:]]*)
-                # ignore unknown options
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: unknown option '${1}' (ignored)"
-                ;;
-            *)
-                # Default case: If no more options then break out of the loop.
-                break
-                ;;
-        esac
-
-        shift
-    done
-
-    case "${option_compress}" in
-        none)
-            compress_cmd="cat"
-            dump_ext=""
-            ;;
-        bzip2|bz|bz2)
-            compress_cmd="bzip2 --best"
-            dump_ext=".bz"
-            ;;
-        xz)
-            compress_cmd="xz --best"
-            dump_ext=".xz"
-            ;;
-        pigz)
-            compress_cmd="pigz --best"
-            dump_ext=".gz"
-            ;;
-        gz|gzip|*)
-            compress_cmd="gzip --best"
-            dump_ext=".gz"
-            ;;
-    esac
-
-    if [ -z "${option_dump_label}" ]; then
-        if [ -n "${option_defaults_group_suffix}" ]; then
-            option_dump_label="${option_defaults_group_suffix}"
-        elif [ -n "${option_port}" ]; then
-            option_dump_label="${option_port}"
-        elif [ -n "${option_socket}" ]; then
-            option_dump_label=$(path_to_str "${option_socket}")
-        else
-            option_dump_label="default"
-        fi
-    fi
-
-    ## Connection options
-    declare -a connect_options
-    connect_options=()
-    if [ -n "${option_defaults_file}" ]; then
-        connect_options+=(--defaults-file="${option_defaults_file}")
-    fi
-    if [ -n "${option_defaults_extra_file}" ]; then
-        connect_options+=(--defaults-extra-file="${option_defaults_extra_file}")
-    fi
-    if [ -n "${option_defaults_group_suffix}" ]; then
-        connect_options+=(--defaults-group-suffix="${option_defaults_group_suffix}")
-    fi
-    if [ -n "${option_port}" ]; then
-        connect_options+=(--protocol=tcp)
-        connect_options+=(--port="${option_port}")
-    fi
-    if [ -n "${option_socket}" ]; then
-        connect_options+=(--protocol=socket)
-        connect_options+=(--socket="${option_socket}")
-    fi
-    if [ -n "${option_user}" ]; then
-        connect_options+=(--user="${option_user}")
-    fi
-    if [ -n "${option_password}" ]; then
-        connect_options+=(--password="${option_password}")
-    fi
-
-    databases=$(mysql "${connect_options[@]}" --execute="show databases" --silent --skip-column-names \
-        | grep --extended-regexp --invert-match "^(Database|information_schema|performance_schema|sys)")
-
-    for database in ${databases}; do
-        local dump_dir="${LOCAL_BACKUP_DIR}/mysql-${option_dump_label}-tabs/${database}"
-        local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-        rm -rf "${dump_dir}" "${errors_dir}"
-        mkdir -p "${dump_dir}" "${errors_dir}"
-        # No need to change recursively, the top directory is enough
-        chmod 700 "${dump_dir}" "${errors_dir}"
-        chown -RL mysql "${dump_dir}"
-
-        local error_file="${errors_dir}.err"
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_dir}"
-
-        declare -a dump_options
-        dump_options=()
-        dump_options+=(--force)
-        dump_options+=(--quote-names)
-        dump_options+=(--opt)
-        dump_options+=(--events)
-        dump_options+=(--hex-blob)
-        dump_options+=(--skip-comments)
-        dump_options+=(--fields-enclosed-by='\"')
-        dump_options+=(--fields-terminated-by=',')
-        dump_options+=(--tab="${dump_dir}")
-        if [ -n "${option_others}" ]; then
-            # word splitting is deliberate here
-            # shellcheck disable=SC2206
-            dump_options+=(${option_others})
-        fi
-        dump_options+=("${database}")
-
-        dump_cmd="mysqldump ${connect_options[*]} ${dump_options[*]}"
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-        ${dump_cmd} 2> "${error_file}"
- 
-        local last_rc=$?
-        # shellcheck disable=SC2086
-        if [ ${last_rc} -ne 0 ]; then
-            log_error "LOCAL_TASKS - ${FUNCNAME[0]}: mysqldump to ${dump_dir} returned an error ${last_rc}" "${error_file}"
-            GLOBAL_RC=${E_DUMPFAILED}
-        else
-            rm -f "${error_file}"
-        fi
-        log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_dir}"
-    done
-}

client/lib/dump/postgresql.sh

@@ -1,343 +0,0 @@
-#!/usr/bin/env bash
-# shellcheck disable=SC2034,SC2317,SC2155
-
-#######################################################################
-# Dump a single file of all PostgreSQL databases
-#
-# Arguments:
-# --dump-label=[String] (default: "default")
-#   used as suffix of the dump dir to differenciate multiple instances
-# --compress=<gzip|pigz|bzip2|xz|none> (default: "gzip")
-# Other options after -- are passed as-is to pg_dump
-#######################################################################
-dump_postgresql_global() {
-    local option_dump_label=""
-    local option_compress=""
-    local option_others=""
-
-    # Parse options, based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
-    while :; do
-        case ${1:-''} in
-            --dump-label)
-                # dump-label options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_dump_label="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --dump-label=?*)
-                # dump-label options, with value separated by =
-                option_dump_label="${1#*=}"
-                ;;
-            --dump-label=)
-                # dump-label options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                exit 1
-                ;;
-            --compress)
-                # compress options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_compress="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--compress' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --compress=?*)
-                # compress options, with value separated by =
-                option_compress="${1#*=}"
-                ;;
-            --compress=)
-                # compress options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--compress' requires a non-empty option argument."
-                exit 1
-                ;;
-            --)
-                # End of all options.
-                shift
-                option_others=${*}
-                break
-                ;;
-            -?*|[[:alnum:]]*)
-                # ignore unknown options
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: unknown option '${1}' (ignored)"
-                ;;
-            *)
-                # Default case: If no more options then break out of the loop.
-                break
-                ;;
-        esac
-
-        shift
-    done
-
-    case "${option_compress}" in
-        none)
-            compress_cmd="cat"
-            dump_ext=""
-            ;;
-        bzip2|bz|bz2)
-            compress_cmd="bzip2 --best"
-            dump_ext=".bz"
-            ;;
-        xz)
-            compress_cmd="xz --best"
-            dump_ext=".xz"
-            ;;
-        pigz)
-            compress_cmd="pigz --best"
-            dump_ext=".gz"
-            ;;
-        gz|gzip|*)
-            compress_cmd="gzip --best"
-            dump_ext=".gz"
-            ;;
-    esac
-
-    if [ -z "${option_dump_label}" ]; then
-        if [ -n "${option_defaults_group_suffix}" ]; then
-            option_dump_label="${option_defaults_group_suffix}"
-        elif [ -n "${option_port}" ]; then
-            option_dump_label="${option_port}"
-        elif [ -n "${option_socket}" ]; then
-            option_dump_label=$(path_to_str "${option_socket}")
-        else
-            option_dump_label="default"
-        fi
-    fi
-
-    local dump_dir="${LOCAL_BACKUP_DIR}/postgresql-${option_dump_label}-global"
-    local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-    rm -rf "${dump_dir}" "${errors_dir}"
-    mkdir -p "${dump_dir}" "${errors_dir}"
-    # No need to change recursively, the top directory is enough
-    chmod 700 "${dump_dir}" "${errors_dir}"
-
-    ## example with pg_dumpall and with compression
-    local error_file="${errors_dir}/pg_dumpall.err"
-    local dump_file="${dump_dir}/pg_dumpall.sql${dump_ext}"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-
-    declare -a dump_options
-    dump_options=()
-    if [ -n "${option_others}" ]; then
-        # word splitting is deliberate here
-        # shellcheck disable=SC2206
-        dump_options+=(${option_others})
-    fi
-    
-    dump_cmd="(sudo -u postgres pg_dumpall ${dump_options[*]}) 2> ${error_file} | ${compress_cmd} > ${dump_file}"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-    ${dump_cmd}
-
-    local last_rc=$?
-    # shellcheck disable=SC2086
-    if [ ${last_rc} -ne 0 ]; then
-        log_error "LOCAL_TASKS - ${FUNCNAME[0]}: pg_dumpall to ${dump_file} returned an error ${last_rc}" "${error_file}"
-        GLOBAL_RC=${E_DUMPFAILED}
-    else
-        rm -f "${error_file}"
-    fi
-
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-
-    ## example with pg_dumpall and without compression
-    ## WARNING: you need space in ~postgres
-    # local error_file="${errors_dir}/pg_dumpall.err"
-    # local dump_file="${dump_dir}/pg_dumpall.sql"
-    # log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-    # 
-    # (su - postgres -c "pg_dumpall > ~/pg.dump.bak") 2> "${error_file}"
-    # mv ~postgres/pg.dump.bak "${dump_file}"
-    # 
-    # log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-}
-
-#######################################################################
-# Dump a compressed file per database
-#
-# Arguments: <none>
-#######################################################################
-dump_postgresql_per_base() {
-    local option_dump_label=""
-    local option_compress=""
-    local option_others=""
-
-    # Parse options, based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
-    while :; do
-        case ${1:-''} in
-            --dump-label)
-                # dump-label options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_dump_label="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --dump-label=?*)
-                # dump-label options, with value separated by =
-                option_dump_label="${1#*=}"
-                ;;
-            --dump-label=)
-                # dump-label options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--dump-label' requires a non-empty option argument."
-                exit 1
-                ;;
-            --compress)
-                # compress options, with value separated by space
-                if [ -n "$2" ]; then
-                    option_compress="${2}"
-                    shift
-                else
-                    log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--compress' requires a non-empty option argument."
-                    exit 1
-                fi
-                ;;
-            --compress=?*)
-                # compress options, with value separated by =
-                option_compress="${1#*=}"
-                ;;
-            --compress=)
-                # compress options, without value
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: '--compress' requires a non-empty option argument."
-                exit 1
-                ;;
-            --)
-                # End of all options.
-                shift
-                option_others=${*}
-                break
-                ;;
-            -?*|[[:alnum:]]*)
-                # ignore unknown options
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: unknown option '${1}' (ignored)"
-                ;;
-            *)
-                # Default case: If no more options then break out of the loop.
-                break
-                ;;
-        esac
-
-        shift
-    done
-
-    case "${option_compress}" in
-        none)
-            compress_cmd="cat"
-            dump_ext=""
-            ;;
-        bzip2|bz|bz2)
-            compress_cmd="bzip2 --best"
-            dump_ext=".bz"
-            ;;
-        xz)
-            compress_cmd="xz --best"
-            dump_ext=".xz"
-            ;;
-        pigz)
-            compress_cmd="pigz --best"
-            dump_ext=".gz"
-            ;;
-        gz|gzip|*)
-            compress_cmd="gzip --best"
-            dump_ext=".gz"
-            ;;
-    esac
-
-    if [ -z "${option_dump_label}" ]; then
-        if [ -n "${option_defaults_group_suffix}" ]; then
-            option_dump_label="${option_defaults_group_suffix}"
-        elif [ -n "${option_port}" ]; then
-            option_dump_label="${option_port}"
-        elif [ -n "${option_socket}" ]; then
-            option_dump_label=$(path_to_str "${option_socket}")
-        else
-            option_dump_label="default"
-        fi
-    fi
-
-    local dump_dir="${LOCAL_BACKUP_DIR}/postgresql-${option_dump_label}-per-base"
-    local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-    rm -rf "${dump_dir}" "${errors_dir}"
-    mkdir -p "${dump_dir}" "${errors_dir}"
-    # No need to change recursively, the top directory is enough
-    chmod 700 "${dump_dir}" "${errors_dir}"
-
-    (
-        # shellcheck disable=SC2164
-        cd /var/lib/postgresql
-        databases=$(sudo -u postgres psql -U postgres -lt | awk -F \| '{print $1}' | grep -v "template.*")
-        for database in ${databases} ; do
-            local error_file="${errors_dir}/${database}.err"
-            local dump_file="${dump_dir}/${database}.sql${dump_ext}"
-            log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-
-            declare -a dump_options
-            dump_options=()
-            dump_options+=(--create)
-            dump_options+=(-U postgres)
-            dump_options+=(-d "${database}")
-            if [ -n "${option_others}" ]; then
-                # word splitting is deliberate here
-                # shellcheck disable=SC2206
-                dump_options+=(${option_others})
-            fi
-
-            dump_cmd="(sudo -u postgres /usr/bin/pg_dump ${dump_options[*]}) 2> ${error_file} | ${compress_cmd} > ${dump_file}"
-            log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-            ${dump_cmd}
-
-            local last_rc=$?
-            # shellcheck disable=SC2086
-            if [ ${last_rc} -ne 0 ]; then
-                log_error "LOCAL_TASKS - ${FUNCNAME[0]}: pg_dump to ${dump_file} returned an error ${last_rc}" "${error_file}"
-                GLOBAL_RC=${E_DUMPFAILED}
-            else
-                rm -f "${error_file}"
-            fi
-            log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-        done
-    )
-}
-
-#######################################################################
-# Dump a compressed file per database
-#
-# Arguments: <none>
-#
-# TODO: add arguments to include/exclude tables
-#######################################################################
-dump_postgresql_filtered() {
-    local dump_dir="${LOCAL_BACKUP_DIR}/postgresql-filtered"
-    local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-    rm -rf "${dump_dir}" "${errors_dir}"
-    mkdir -p "${dump_dir}" "${errors_dir}"
-    # No need to change recursively, the top directory is enough
-    chmod 700 "${dump_dir}" "${errors_dir}"
-
-    local error_file="${errors_dir}/pg-backup.err"
-    local dump_file="${dump_dir}/pg-backup.tar"
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-
-    ## example with all tables from MYBASE excepts TABLE1 and TABLE2
-    # pg_dump -p 5432 -h 127.0.0.1 -U USER --clean -F t --inserts -f "${dump_file}" -t 'TABLE1' -t 'TABLE2' MYBASE 2> "${error_file}"
-
-    ## example with only TABLE1 and TABLE2 from MYBASE
-    # pg_dump -p 5432 -h 127.0.0.1 -U USER --clean -F t --inserts -f "${dump_file}" -T 'TABLE1' -T 'TABLE2' MYBASE 2> "${error_file}"
-
-    local last_rc=$?
-    # shellcheck disable=SC2086
-    if [ ${last_rc} -ne 0 ]; then
-        log_error "LOCAL_TASKS - ${FUNCNAME[0]}: pg_dump to ${dump_file} returned an error ${last_rc}" "${error_file}"
-        GLOBAL_RC=${E_DUMPFAILED}
-    else
-        rm -f "${error_file}"
-    fi
-    log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-}

client/lib/main.sh

@@ -1,466 +0,0 @@
-#!/usr/bin/env bash
-# shellcheck disable=SC2034,SC2317
-
-readonly VERSION="24.05"
-
-# set all programs to C language (english)
-export LC_ALL=C
-
-# If expansion is attempted on an unset variable or parameter, the shell prints an
-# error message, and, if not interactive, exits with a non-zero status.
-set -o nounset
-# The pipeline's return status is the value of the last (rightmost) command
-# to exit with a non-zero status, or zero if all commands exit successfully.
-set -o pipefail
-# Enable trace mode if called with environment variable TRACE=1
-if [[ "${TRACE-0}" == "1" ]]; then
-    set -o xtrace
-fi
-
-source "${LIBDIR}/utilities.sh"
-source "${LIBDIR}/dump/elasticsearch.sh"
-source "${LIBDIR}/dump/mysql.sh"
-source "${LIBDIR}/dump/postgresql.sh"
-source "${LIBDIR}/dump/misc.sh"
-
-# Called from main, it is wrapping the local_tasks function defined in the real script
-local_tasks_wrapper() {
-    log "START LOCAL_TASKS"
-
-    # Remove old log directories (recursively)
-    find "${LOCAL_BACKUP_DIR}/" -type d -name "${PROGNAME}.errors-*" -ctime +30 -exec rm -rf \;
-
-    local_tasks_type="$(type -t local_tasks)"
-    if [ "${local_tasks_type}" = "function" ]; then
-        local_tasks
-    else
-        log_error "There is no 'local_tasks' function to execute"
-    fi
-
-    # TODO: check if this is still needed
-    # print_error_files_content
-
-    log "STOP LOCAL_TASKS"
-}
-
-# Called from main, it is wrapping the sync_tasks function defined in the real script
-sync_tasks_wrapper() {
-    declare -a SERVERS        # Indexed array for server/port values
-    declare -a RSYNC_INCLUDES # Indexed array for includes
-    declare -a RSYNC_EXCLUDES # Indexed array for excludes
-
-    case "${SYSTEM}" in
-        linux)
-            # NOTE: remember to single-quote paths if they contain globs (*)
-            #       and you want to defer expansion
-            declare -a rsync_default_includes=(
-                /bin
-                /boot
-                /lib
-                /opt
-                /sbin
-                /usr
-            )
-            ;;
-        *bsd)
-            # NOTE: remember to single-quote paths if they contain globs (*)
-            #       and you want to defer expansion
-            declare -a rsync_default_includes=(
-                /bin
-                /bsd
-                /sbin
-                /usr
-            )
-            ;;
-        *)
-            echo "Unknown system '${SYSTEM}'" >&2
-            exit 1
-            ;;
-    esac
-    if [ -f "${CANARY_FILE}" ]; then
-        rsync_default_includes+=("${CANARY_FILE}")
-    fi
-    readonly rsync_default_includes
-
-    # NOTE: remember to single-quote paths if they contain globs (*)
-    #       and you want to defer expansion
-    declare -a rsync_default_excludes=(
-        /dev
-        /proc
-        /run
-        /sys
-        /tmp
-        /usr/doc
-        /usr/obj
-        /usr/share/doc
-        /usr/src
-        /var/apt
-        /var/cache
-        '/var/db/munin/*.tmp'
-        /var/lib/amavis/amavisd.sock
-        /var/lib/amavis/tmp
-        /var/lib/amavis/virusmails
-        '/var/lib/clamav/*.tmp'
-        /var/lib/elasticsearch
-        /var/lib/metche
-        /var/lib/mongodb
-        '/var/lib/munin/*tmp*'
-        /var/lib/mysql
-        /var/lib/php/sessions
-        /var/lib/php5
-        /var/lib/postgres
-        /var/lib/postgresql
-        /var/lib/sympa
-        /var/lock
-        /var/run
-        /var/spool/postfix
-        /var/spool/smtpd
-        /var/spool/squid
-        /var/state
-        /var/tmp
-        lost+found
-        '.nfs.*'
-        'lxc/*/rootfs/tmp'
-        'lxc/*/rootfs/usr/doc'
-        'lxc/*/rootfs/usr/obj'
-        'lxc/*/rootfs/usr/share/doc'
-        'lxc/*/rootfs/usr/src'
-        'lxc/*/rootfs/var/apt'
-        'lxc/*/rootfs/var/cache'
-        'lxc/*/rootfs/var/lib/php5'
-        'lxc/*/rootfs/var/lib/php/sessions'
-        'lxc/*/rootfs/var/lock'
-        'lxc/*/rootfs/var/run'
-        'lxc/*/rootfs/var/state'
-        'lxc/*/rootfs/var/tmp'
-        /home/mysqltmp
-    )
-    readonly rsync_default_excludes
-
-    sync_tasks_type="$(type -t sync_tasks)"
-    if [ "${sync_tasks_type}" = "function" ]; then
-        sync_tasks
-    else
-        log_error "There is no 'sync_tasks' function to execute"
-    fi
-}
-
-sync() {
-    local sync_name=${1}
-    local -a rsync_servers=("${!2}")
-    local -a rsync_includes=("${!3}")
-    local -a rsync_excludes=("${!4}")
-
-    ## Initialize variable to store SSH connection errors
-    declare -a SSH_ERRORS=()
-
-    log "START SYNC_TASKS - sync=${sync_name}"
-
-    # echo "### sync ###"
-
-    # for server in "${rsync_servers[@]}"; do
-    #     echo "server: ${server}"
-    # done
-
-    # for include in "${rsync_includes[@]}"; do
-    #     echo "include: ${include}"
-    # done
-
-    # for exclude in "${rsync_excludes[@]}"; do
-    #     echo "exclude: ${exclude}"
-    # done
-
-    local -i n=0
-    local server=""
-    if [ "${SERVERS_FALLBACK}" = "1" ]; then
-        # We try to find a suitable server
-        while :; do
-            server=$(pick_server ${n} "${sync_name}")
-            rc=$?
-            if [ ${rc} != 0 ]; then
-                GLOBAL_RC=${E_NOSRVAVAIL}
-            log "STOP  SYNC_TASKS - sync=${sync_name}'"
-                return
-            fi
-
-            if test_server "${server}"; then
-                break
-            else
-                server=""
-                n=$(( n + 1 ))
-            fi
-        done
-    else
-        # we force the server
-        server=$(pick_server "${n}" "${sync_name}")
-    fi
-
-    rsync_server=$(echo "${server}" | cut -d':' -f1)
-    rsync_port=$(echo "${server}" | cut -d':' -f2)
-
-    log "SYNC_TASKS - sync=${sync_name}: use ${server}"
-    
-    # Rsync complete log file for the current run
-    RSYNC_LOGFILE="/var/log/${PROGNAME}.${sync_name}.rsync.log"
-    # Rsync stats for the current run
-    RSYNC_STATSFILE="/var/log/${PROGNAME}.${sync_name}.rsync-stats.log"
-
-    # reset Rsync log file
-    if [ -n "$(command -v truncate)" ]; then
-        truncate -s 0 "${RSYNC_LOGFILE}"
-        truncate -s 0 "${RSYNC_STATSFILE}"
-    else
-        printf "" > "${RSYNC_LOGFILE}"
-        printf "" > "${RSYNC_STATSFILE}"
-    fi
-    
-    # Initialize variable here, we need it later
-    local -a mtree_files=()
-
-    if [ "${MTREE_ENABLED}" = "1" ]; then
-        mtree_bin=$(command -v mtree)
-
-        if [ -n "${mtree_bin}" ]; then
-            # Dump filesystem stats with mtree
-            log "SYNC_TASKS - sync=${sync_name}: start mtree"
-
-            # Loop over Rsync includes
-            for i in "${!rsync_includes[@]}"; do
-                include="${rsync_includes[i]}"
-
-                if [ -d "${include}" ]; then
-                    # … but exclude for mtree what will be excluded by Rsync
-                    mtree_excludes_file="$(mktemp --tmpdir "${PROGNAME}.${sync_name}.mtree-excludes.XXXXXX")"
-                    add_to_temp_files "${mtree_excludes_file}"
-
-                    for j in "${!rsync_excludes[@]}"; do
-                        echo "${rsync_excludes[j]}" | grep -E "^([^/]|${include})" | sed -e "s|^${include}|.|" >> "${mtree_excludes_file}"
-                    done
-
-                    mtree_file="/var/log/evobackup.$(basename "${include}").mtree"
-                    add_to_temp_files "${mtree_file}"
-
-                    ${mtree_bin} -x -c -p "${include}" -X "${mtree_excludes_file}" > "${mtree_file}"
-                    mtree_files+=("${mtree_file}")
-                fi
-            done
-
-            if [ "${#mtree_files[@]}" -le 0 ]; then
-                log_error "SYNC_TASKS - ${sync_name}: ERROR: mtree didn't produce any file"
-            fi
-
-            log "SYNC_TASKS - sync=${sync_name}: stop  mtree (files: ${mtree_files[*]})"
-        else
-            log "SYNC_TASKS - sync=${sync_name}: skip mtree (missing)"
-        fi
-    else
-        log "SYNC_TASKS - sync=${sync_name}: skip mtree (disabled)"
-    fi
-
-    rsync_bin=$(command -v rsync)
-    # Build the final Rsync command
-
-    # Rsync main options
-    rsync_main_args=()
-    rsync_main_args+=(--archive)
-    rsync_main_args+=(--itemize-changes)
-    rsync_main_args+=(--quiet)
-    rsync_main_args+=(--stats)
-    rsync_main_args+=(--human-readable)
-    rsync_main_args+=(--relative)
-    rsync_main_args+=(--partial)
-    rsync_main_args+=(--delete)
-    rsync_main_args+=(--delete-excluded)
-    rsync_main_args+=(--force)
-    rsync_main_args+=(--ignore-errors)
-    rsync_main_args+=(--log-file "${RSYNC_LOGFILE}")
-    rsync_main_args+=(--rsh "ssh -p ${rsync_port} -o 'ConnectTimeout ${SSH_CONNECT_TIMEOUT}'")
-
-    # Rsync excludes
-    for i in "${!rsync_excludes[@]}"; do
-        rsync_main_args+=(--exclude "${rsync_excludes[i]}")
-    done
-
-    # Rsync local sources
-    rsync_main_args+=("${rsync_includes[@]}")
-
-    # Rsync remote destination
-    rsync_main_args+=("root@${rsync_server}:${REMOTE_BACKUP_DIR}/")
-
-    # … log it
-    log "SYNC_TASKS - sync=${sync_name}: Rsync main command : ${rsync_bin} ${rsync_main_args[*]}"
-
-    # … execute it
-    ${rsync_bin} "${rsync_main_args[@]}"
-
-    rsync_main_rc=$?
-
-    # Copy last lines of rsync log to the main log
-    tail -n 30 "${RSYNC_LOGFILE}" >> "${LOGFILE}"
-    # Copy Rsync stats to special file
-    tail -n 30 "${RSYNC_LOGFILE}" | grep --invert-match --extended-regexp " [\<\>ch\.\*]\S{10} " > "${RSYNC_STATSFILE}"
-
-    # We ignore rc=24 (vanished files)
-    if [ ${rsync_main_rc} -ne 0 ] && [ ${rsync_main_rc} -ne 24 ]; then
-        log_error "SYNC_TASKS - sync=${sync_name}: Rsync main command returned an error ${rsync_main_rc}" "${LOGFILE}"
-        GLOBAL_RC=${E_SYNCFAILED}
-    else
-        # Build the report Rsync command
-        local -a rsync_report_args
-
-        rsync_report_args=()
-
-        # Rsync options
-        rsync_report_args+=(--rsh "ssh -p ${rsync_port} -o 'ConnectTimeout ${SSH_CONNECT_TIMEOUT}'")
-
-        # Rsync local sources
-        if [ "${#mtree_files[@]}" -gt 0 ]; then
-            # send mtree files if there is any
-            rsync_report_args+=("${mtree_files[@]}")
-        fi
-        if [ -f "${RSYNC_LOGFILE}" ]; then
-            # send rsync full log file if it exists
-            rsync_report_args+=("${RSYNC_LOGFILE}")
-        fi
-        if [ -f "${RSYNC_STATSFILE}" ]; then
-            # send rsync stats log file if it exists
-            rsync_report_args+=("${RSYNC_STATSFILE}")
-        fi
-
-        # Rsync remote destination
-        rsync_report_args+=("root@${rsync_server}:${REMOTE_LOG_DIR}/")
-
-        # … log it
-        log "SYNC_TASKS - sync=${sync_name}: Rsync report command : ${rsync_bin} ${rsync_report_args[*]}"
-
-        # … execute it
-        ${rsync_bin} "${rsync_report_args[@]}"
-    fi
-
-    log "STOP  SYNC_TASKS - sync=${sync_name}"
-}
-
-setup() {
-    # Default return-code (0 == succes)
-    GLOBAL_RC=0
-
-    # Possible error codes
-    readonly E_NOSRVAVAIL=21 # No server is available
-    readonly E_SYNCFAILED=20 # Failed sync task
-    readonly E_DUMPFAILED=10 # Failed dump task
-
-    # explicit PATH
-    PATH=/sbin:/usr/sbin:/bin:/usr/bin:/usr/local/sbin:/usr/local/bin
-
-    # System name (linux, openbsd…)
-    : "${SYSTEM:=$(uname | tr '[:upper:]' '[:lower:]')}"
-
-    # Hostname (for logs and notifications)
-    : "${HOSTNAME:=$(hostname)}"
-
-    # Store pid in a file named after this program's name
-    : "${PROGNAME:=$(basename "$0")}"
-    : "${PIDFILE:="/var/run/${PROGNAME}.pid"}"
-
-    # Customize the log path if you want multiple scripts to have separate log files
-    : "${LOGFILE:="/var/log/evobackup.log"}"
-
-    # Canary file to update before executing tasks
-    : "${CANARY_FILE:="/zzz_evobackup_canary"}"
-
-    # Date format for log messages
-    : "${DATE_FORMAT:="%Y-%m-%d %H:%M:%S"}"
-
-    # Should we fallback on other servers when the first one is unreachable?
-    : "${SERVERS_FALLBACK:=1}"
-    # timeout (in seconds) for SSH connections
-    : "${SSH_CONNECT_TIMEOUT:=90}"
-
-    : "${LOCAL_BACKUP_DIR:="/home/backup"}"
-    # shellcheck disable=SC2174
-    mkdir -p -m 700 "${LOCAL_BACKUP_DIR}"
-
-    : "${ERRORS_DIR:="${LOCAL_BACKUP_DIR}/${PROGNAME}.errors-${START_TIME}"}"
-    # shellcheck disable=SC2174
-    mkdir -p -m 700 "${ERRORS_DIR}"
-
-    # Backup directory on remote server
-    : "${REMOTE_BACKUP_DIR:="/var/backup"}"
-    # Log directory in remote server
-    : "${REMOTE_LOG_DIR:="/var/log"}"
-
-    # Email address for notifications
-    : "${MAIL:="root"}"
-
-    # Email subject for notifications
-    : "${MAIL_SUBJECT:="[info] EvoBackup - Client ${HOSTNAME}"}"
-
-    # Enable/disable local tasks (default: enabled)
-    : "${LOCAL_TASKS:=1}"
-    # Enable/disable sync tasks (default: enabled)
-    : "${SYNC_TASKS:=1}"
-
-    # Enable/disable mtree (default: enabled)
-    : "${MTREE_ENABLED:=1}"
-
-    # If "setup_custom" exists and is a function, let's call it
-    setup_custom_type="$(type -t setup_custom)"
-    if [ "${setup_custom_type}" = "function" ]; then
-        setup_custom
-    fi
-
-    ## Force umask
-    umask 077
-
-    # Initialize a list of temporary files
-    declare -a TEMP_FILES=()
-    # Any file in this list will be deleted when the program exits
-    trap "cleanup" EXIT
-}
-
-
-run_evobackup() {
-    # Start timer
-    START_EPOCH=$(/bin/date +%s)
-    START_TIME=$(/bin/date +"%Y%m%d%H%M%S")
-
-    # Configure variables and environment
-    setup
-
-    log "START GLOBAL - VERSION=${VERSION} LOCAL_TASKS=${LOCAL_TASKS} SYNC_TASKS=${SYNC_TASKS}"
-
-    # /!\ Only one backup processus can run at the sametime /!\
-    # Based on PID file, kill any running process before continuing
-    enforce_single_process "${PIDFILE}"
-
-    # Update canary to keep track of each run
-    update-evobackup-canary --who "${PROGNAME}" --file "${CANARY_FILE}"
-
-    if [ "${LOCAL_TASKS}" = "1" ]; then
-        local_tasks_wrapper
-    fi
-
-    if [ "${SYNC_TASKS}" = "1" ]; then
-        sync_tasks_wrapper
-    fi
-
-    STOP_EPOCH=$(/bin/date +%s)
-
-    case "${SYSTEM}" in
-        *bsd)
-            start_time=$(/bin/date -f "%s" -j "${START_EPOCH}" +"${DATE_FORMAT}")
-            stop_time=$(/bin/date -f "%s" -j "${STOP_EPOCH}" +"${DATE_FORMAT}")
-            ;;
-        *)
-            start_time=$(/bin/date --date="@${START_EPOCH}" +"${DATE_FORMAT}")
-            stop_time=$(/bin/date --date="@${STOP_EPOCH}" +"${DATE_FORMAT}")
-            ;;
-    esac
-    duration=$(( STOP_EPOCH - START_EPOCH ))
-
-    log "STOP GLOBAL - start='${start_time}' stop='${stop_time}' duration=${duration}s"
-
-    send_mail
-
-    exit ${GLOBAL_RC}
-}

client/lib/utilities.sh

@@ -1,143 +0,0 @@
-#!/usr/bin/env bash
-
-# Output a message to the log file
-log() {
-    local msg="${1:-$(cat /dev/stdin)}"
-    local pid=$$
-
-    printf "[%s] %s[%s]: %s\\n" \
-        "$(/bin/date +"${DATE_FORMAT}")" "${PROGNAME}" "${pid}" "${msg}" \
-        >> "${LOGFILE}"
-}
-log_error() {
-    local error_msg=${1}
-    local error_file=${2:-""}
-
-    if [ -n "${error_file}" ] && [ -f "${error_file}" ]; then
-        printf "\n### %s\n" "${error_msg}" >&2
-        # shellcheck disable=SC2046
-        if [ $(wc -l "${error_file}" | cut -d " " -f 1) -gt 30 ]; then
-            printf "~~~{%s (tail -30)}\n" "${error_file}" >&2
-            tail -n 30 "${error_file}" >&2
-        else
-            printf "~~~{%s}\n" "${error_file}" >&2
-            cat "${error_file}" >&2
-        fi
-        printf "~~~\n" >&2
-
-        log "${error_msg}, check ${error_file}"
-    else
-        printf "\n### %s\n" "${error_msg}" >&2
-
-        log "${error_msg}"
-    fi
-
-}
-add_to_temp_files() {
-    TEMP_FILES+=("${1}")
-}
-# Remove all temporary file created during the execution
-cleanup() {
-    # shellcheck disable=SC2086
-    rm -f "${TEMP_FILES[@]}"
-    find "${ERRORS_DIR}" -type d -empty -delete
-}
-enforce_single_process() {
-    local pidfile=$1
-
-    if [ -e "${pidfile}" ]; then
-        pid=$(cat "${pidfile}")
-        # Does process still exist?
-        if kill -0 "${pid}" 2> /dev/null; then
-            # Killing the childs of evobackup.
-            for ppid in $(pgrep -P "${pid}"); do
-                kill -9 "${ppid}";
-            done
-            # Then kill the main PID.
-            kill -9 "${pid}"
-            printf "%s is still running (PID %s). Process has been killed" "$0" "${pid}\\n" >&2
-        else
-            rm -f "${pidfile}"
-        fi
-    fi
-    add_to_temp_files "${pidfile}"
-
-    echo "$$" > "${pidfile}"
-}
-
-# Build the error directory (inside ERRORS_DIR) based on the dump directory path
-errors_dir_from_dump_dir() {
-    local dump_dir=$1
-    local relative_path=$(realpath --relative-to="${LOCAL_BACKUP_DIR}" "${dump_dir}")
-
-    # return absolute path
-    realpath --canonicalize-missing "${ERRORS_DIR}/${relative_path}"
-}
-
-# Call test_server with "HOST:PORT" string
-# It will return with 0 if the server is reachable.
-# It will return with 1 and a message on stderr if not.
-test_server() {
-    local item=$1
-    # split HOST and PORT from the input string
-    local host=$(echo "${item}" | cut -d':' -f1)
-    local port=$(echo "${item}" | cut -d':' -f2)
-
-    local new_error
-
-    # Test if the server is accepting connections
-    ssh -q -o "ConnectTimeout ${SSH_CONNECT_TIMEOUT}" "${host}" -p "${port}" -t "exit"
-    # shellcheck disable=SC2181
-    if [ $? = 0 ]; then
-        # SSH connection is OK
-        return 0
-    else
-        # SSH connection failed
-        new_error=$(printf "Failed to connect to \`%s' within %s seconds" "${item}" "${SSH_CONNECT_TIMEOUT}")
-        log "${new_error}"
-        SSH_ERRORS+=("${new_error}")
-
-        return 1
-    fi
-}
-
-# Call pick_server with an optional positive integer to get the nth server in the list.
-pick_server() {
-    local -i increment=${1:-0}
-    local -i list_length=${#SERVERS[@]}
-    local sync_name=${2:""}
-
-    if (( increment >= list_length )); then
-        # We've reached the end of the list
-        new_error="No more server available"
-        new_error="${new_error} for sync '${sync_name}'"
-        log "${new_error}"
-        SSH_ERRORS+=("${new_error}")
-
-        # Log errors to stderr
-        for i in "${!SSH_ERRORS[@]}"; do
-            printf "%s\n" "${SSH_ERRORS[i]}" >&2
-        done
-
-        return 1
-    fi
-
-    # Extract the day of month, without leading 0 (which would give an octal based number)
-    today=$(/bin/date +%e)
-    # A salt is useful to randomize the starting point in the list
-    # but stay identical each time it's called for a server (based on hostname).
-    salt=$(hostname | cksum | cut -d' ' -f1)
-    # Pick an integer between 0 and the length of the SERVERS list
-    # It changes each day
-    n=$(( (today + salt + increment) % list_length ))
-
-    echo "${SERVERS[n]}"
-}
-
-send_mail() {
-    tail -20 "${LOGFILE}" | mail -s "${MAIL_SUBJECT}" "${MAIL}"
-}
-
-path_to_str() {
-    echo "${1}" | sed -e 's|^/||; s|/$||; s|/|:|g'
-}

client/lib/zzz_evobackup.sh

@@ -1,326 +0,0 @@
-#!/usr/bin/env bash
-#
-# Evobackup client
-# See https://gitea.evolix.org/evolix/evobackup
-#
-# This is a generated backup script made by:
-#   command: @COMMAND@
-#   version: @VERSION@
-#   date:    @DATE@
-
-#######################################################################
-#
-# You must configure the MAIL variable to receive notifications.
-#
-# There is some optional configuration that you can do
-# at the end of this script.
-#
-#######################################################################
-
-# Email adress for notifications
-MAIL=__NOTIFICATION_MAIL__
-
-#######################################################################
-#
-# The "sync_tasks" function will be called by the "run_evobackup" function. 
-#
-# You can customize the variables:
-# * "SYNC_NAME"      (String)
-# * "SERVERS"        (Array of HOST:PORT)
-# * "RSYNC_INCLUDES" (Array of paths to include)
-# * "RSYNC_EXCLUDES" (Array of paths to exclude)
-#
-# WARNING: remember to single-quote paths if they contain globs (*)
-# and you want to pass them as-is to Rsync.
-#
-# The "sync" function can be called multiple times
-# with a different set of variables.
-# That way you can to sync to various destinations.
-#
-# Default includes/excludes are defined in the "main" library,
-# referenced at this end of this file.
-#
-#######################################################################
-
-# shellcheck disable=SC2034
-sync_tasks() {
-
-    ########## System-only backup (to Evolix servers) #################
-
-    SYNC_NAME="evolix-system"
-    SERVERS=(
-        __SRV0_HOST__:__SRV0_PORT__
-        __SRV1_HOST__:__SRV1_PORT__
-    )
-    RSYNC_INCLUDES=(
-        "${rsync_default_includes[@]}"
-        /etc
-        /root
-        /var
-    )
-    RSYNC_EXCLUDES=(
-        "${rsync_default_excludes[@]}"
-    )
-    sync "${SYNC_NAME}" "SERVERS[@]" "RSYNC_INCLUDES[@]" "RSYNC_EXCLUDES[@]"
-
-
-    ########## Full backup (to client servers) ########################
-
-    ### SYNC_NAME="client-full"
-    ### SERVERS=(
-    ###     client-backup00.evolix.net:2221
-    ###     client-backup01.evolix.net:2221
-    ### )
-    ### RSYNC_INCLUDES=(
-    ###     "${rsync_default_includes[@]}"
-    ###     /etc
-    ###     /root
-    ###     /var
-    ###     /home
-    ###     /srv
-    ### )
-    ### RSYNC_EXCLUDES=(
-    ###     "${rsync_default_excludes[@]}"
-    ### )
-    ### sync "${SYNC_NAME}" "SERVERS[@]" "RSYNC_INCLUDES[@]" "RSYNC_EXCLUDES[@]"
-
-}
-
-#######################################################################
-#
-# The "local_tasks" function will be called by the "run_evobackup" function. 
-#
-# You can call any available "dump_xxx" function
-# (usually installed at /usr/local/lib/evobackup/dump-*.sh)
-#
-# You can also write some custom functions and call them.
-# A "dump_custom" example is available further down.
-#
-#######################################################################
-
-local_tasks() {
-
-    ########## Server state ###########
-
-    # Run dump-server-state to extract system information
-    #
-    # Options : any dump-server-state supported option
-    # (except --dump-dir that will be overwritten)
-    # See 'dump-server-state -h' for details.
-    #
-    dump_server_state
-
-    ########## MySQL ##################
-
-    # Very common strategy for a single instance server with default configuration :
-    #
-    ### dump_mysql_global; dump_mysql_grants; dump_mysql_summary
-    #
-    # See below for details regarding dump functions for MySQL/MariaDB
- 
-    # Dump all databases in a single compressed file
-    #
-    # Options :
-    #   --masterdata (default: <absent>)
-    #   --port=[Integer] (default: <blank>)
-    #   --socket=[String] (default: <blank>)
-    #   --user=[String] (default: <blank>)
-    #   --password=[String] (default: <blank>)
-    #   --defaults-file=[String] (default: <blank>)
-    #   --defaults-extra-file=[String] (default: <blank>)
-    #   --defaults-group-suffix=[String] (default: <blank>)
-    #   --dump-label=[String] (default: "default")
-    #     used as suffix of the dump dir to differenciate multiple instances
-    #
-    ### dump_mysql_global
-    
-    # Dump each database separately, in a compressed file
-    #
-    # Options :
-    #   --port=[Integer] (default: <blank>)
-    #   --socket=[String] (default: <blank>)
-    #   --user=[String] (default: <blank>)
-    #   --password=[String] (default: <blank>)
-    #   --defaults-file=[String] (default: <blank>)
-    #   --defaults-extra-file=[String] (default: <blank>)
-    #   --defaults-group-suffix=[String] (default: <blank>)
-    #   --dump-label=[String] (default: "default")
-    #     used as suffix of the dump dir to differenciate multiple instances
-    #
-    ### dump_mysql_per_base
-
-    # Dump permissions of an instance (using pt-show-grants)
-    #
-    # Options :
-    #   --port=[Integer] (default: <blank>)
-    #   --socket=[String] (default: <blank>)
-    #   --user=[String] (default: <blank>)
-    #   --password=[String] (default: <blank>)
-    #   --defaults-file=[String] (default: <blank>)
-    #   --dump-label=[String] (default: "default")
-    #     used as suffix of the dump dir to differenciate multiple instances
-    #
-    # WARNING - unsupported options :
-    #   --defaults-extra-file
-    #   --defaults-group-suffix
-    # You have to provide credentials manually
-    #
-    ### dump_mysql_grants
-
-    # Dump complete summary of an instance (using pt-mysql-summary)
-    #
-    # Options :
-    #   --port=[Integer] (default: <blank>)
-    #   --socket=[String] (default: <blank>)
-    #   --user=[String] (default: <blank>)
-    #   --password=[String] (default: <blank>)
-    #   --defaults-file=[String] (default: <blank>)
-    #   --defaults-extra-file=[String] (default: <blank>)
-    #   --defaults-group-suffix=[String] (default: <blank>)
-    #   --dump-label=[String] (default: "default")
-    #     used as suffix of the dump dir to differenciate multiple instances
-    #
-    ### dump_mysql_summary
-
-    # Dump each table in separate schema/data files
-    #
-    # Options :
-    #   --port=[Integer] (default: <blank>)
-    #   --socket=[String] (default: <blank>)
-    #   --user=[String] (default: <blank>)
-    #   --password=[String] (default: <blank>)
-    #   --defaults-file=[String] (default: <blank>)
-    #   --defaults-extra-file=[String] (default: <blank>)
-    #   --defaults-group-suffix=[String] (default: <blank>)
-    #   --dump-label=[String] (default: "default")
-    #     used as suffix of the dump dir to differenciate multiple instances
-    #
-    ### dump_mysql_tabs
-
-    ########## PostgreSQL #############
-
-    # Dump all databases in a single file (compressed or not)
-    #
-    ### dump_postgresql_global
-
-    # Dump a specific databse with only some tables, or all but some tables (must be configured)
-    #
-    ### dump_postgresql_filtered
-
-    # Dump each database separately, in a compressed file
-    #
-    ### dump_postgresql_per_base
-
-    ########## MongoDB ################
-    
-    ### dump_mongodb [--user=foo] [--password=123456789]
-
-    ########## Redis ##################
-
-    # Copy data file for all instances
-    #
-    ### dump_redis [--instances=<all|instance1|instance2>]
-
-    ########## Elasticsearch ##########
-
-    # Snapshot data for a single-node cluster
-    #
-    ### dump_elasticsearch_snapshot_singlenode [--protocol=http] [--host=localhost] [--port=9200] [--user=foo] [--password=123456789] [--repository=snaprepo] [--snapshot=snapshot.daily]
-
-    # Snapshot data for a multi-node cluster
-    #
-    ### dump_elasticsearch_snapshot_multinode [--protocol=http] [--host=localhost] [--port=9200] [--user=foo] [--password=123456789] [--repository=snaprepo] [--snapshot=snapshot.daily] [--nfs-server=192.168.2.1]
-
-    ########## RabbitMQ ###############
-
-    ### dump_rabbitmq
-
-    ########## MegaCli ################
-
-    # Copy RAID config
-    #
-    ### dump_megacli_config
-
-    # Dump file access control lists
-    #
-    ### dump_facl
-
-    ########## OpenLDAP ###############
-
-    ### dump_ldap
-
-    ########## Network ################
-
-    # Dump network routes with mtr and traceroute (warning: could be long with aggressive firewalls)
-    #
-    ### dump_traceroute --targets=host_or_ip[,host_or_ip]
-    dump_traceroute --targets=8.8.8.8,www.evolix.fr,travaux.evolix.net
-
-    # No-op, in case nothing is enabled
-    :
-}
-
-# This is an example for a custom dump function
-# Uncomment, customize and call it from the "local_tasks" function
-### dump_custom() {
-###     # Set dump and errors directories and files
-###     local dump_dir="${LOCAL_BACKUP_DIR}/custom"
-###     local dump_file="${dump_dir}/dump.gz"
-###     local errors_dir=$(errors_dir_from_dump_dir "${dump_dir}") 
-###     local error_file="${errors_dir}/dump.err"
-### 
-###     # Reset dump and errors directories
-###     rm -rf "${dump_dir}" "${errors_dir}"
-###     # shellcheck disable=SC2174
-###     mkdir -p -m 700 "${dump_dir}" "${errors_dir}"
-###
-###     # Log the start of the function
-###     log "LOCAL_TASKS - ${FUNCNAME[0]}: start ${dump_file}"
-###
-###     # Prepare the dump command (errors go to the error file and the data to the dump file)
-###     dump_cmd="my-dump-command 2> ${error_file} > ${dump_file}"
-###     log "LOCAL_TASKS - ${FUNCNAME[0]}: ${dump_cmd}"
-### 
-###     # Execute the dump command
-###     ${dump_cmd}
-###
-###     # Check result and deal with potential errors
-###     local last_rc=$?
-###     # shellcheck disable=SC2086
-###     if [ ${last_rc} -ne 0 ]; then
-###         log_error "LOCAL_TASKS - ${FUNCNAME[0]}: my-dump-command to ${dump_file} returned an error ${last_rc}" "${error_file}"
-###         GLOBAL_RC=${E_DUMPFAILED}
-###     else
-###         rm -f "${error_file}"
-###     fi
-###
-###     # Log the end of the function
-###     log "LOCAL_TASKS - ${FUNCNAME[0]}: stop  ${dump_file}"
-### }
-
-########## Optional configuration #####################################
-
-setup_custom() {
-    # System name ("linux" and "openbsd" currently supported)
-    ### SYSTEM="$(uname)"
-
-    # Host name for logs and notifications
-    ### HOSTNAME="$(hostname)"
-
-    # Email subject for notifications
-    ### MAIL_SUBJECT="[info] EvoBackup - Client ${HOSTNAME}"
-
-    # No-op in case nothing is executed
-    :
-}
-
-########## Libraries ##################################################
-
-# Change this to wherever you install the libraries
-LIBDIR="/usr/local/lib/evobackup"
-
-source "${LIBDIR}/main.sh"
-
-########## Let's go! ##################################################
-
-run_evobackup

client/vagrant.yml

@@ -1,76 +0,0 @@
-# To be used through "vagrant up" or "vagrant provision".
----
-- hosts: bookworm,bullseye,buster
-  gather_facts: yes
-  become: yes
-
-  vars_files:
-    - '~/GIT/evolix-private/vars/evolinux-secrets.yml'
-
-  vars:
-    evolinux_hostname: "localhost"
-    evolinux_domain: "localdomain.tld"
-    evomaintenance_alert_email: "evomaintenance-{{ evolinux_hostname }}@evolix.fr"
-    evomaintenance_install_vendor: True
-    client_number: "XXX"
-    monitoring_mode: "everytime"
-    evocheck_force_install: "local"
-    evoadmin_host: "evoadmin.{{ evolinux_hostname }}.evolix.eu"
-    evoadmin_contact_email: root@localhost
-    postfix_slow_transport_include: True
-
-    evolinux_ssh_allow_current_user: True
-
-    minifirewall_additional_trusted_ips: ["192.168.0.0/16", "10.0.0.0/8"]
-    minifirewall_http_sites: ["0.0.0.0/0"]
-
-    packweb_enable_evoadmin_vhost: True
-    packweb_phpmyadmin_suffix: "uE34swx9"
-
-    evolinux_apt_include: True
-    evolinux_etcgit_include: True
-    evolinux_hostname_include: True
-    evolinux_kernel_include: True
-    evolinux_fstab_include: True
-    evolinux_packages_include: True
-    evolinux_system_include: True
-    evolinux_evomaintenance_include: True
-    evolinux_ssh_include: True
-    evolinux_users_include: False
-    evolinux_root_include: True
-    evolinux_postfix_include: True
-    evolinux_logs_include: True
-    evolinux_default_www_include: True
-    evolinux_hardware_include: True
-    evolinux_provider_online_include: False
-    evolinux_provider_orange_fce_include: False
-    evolinux_log2mail_include: True
-    evolinux_minifirewall_include: True
-    evolinux_munin_include: True
-    evolinux_nagios_nrpe_include: True
-    evolinux_fail2ban_include: False
-    mysql_custom_datadir: '/home/mysql'
-    mysql_custom_tmpdir: '/home/tmpmysql'
-    mysql_custom_logdir: '/home/mysql-logs'
-    # evolinux_apt_public_sources: False
-    apt_upgrade: True
-
-    # TODO Try to to make it work without the following line
-    # packweb_multiphp_versions:
-    #   - php74
-    #   - php82
-    
-    # autosysadmin_config:
-    #   repair_http: "on"
-    #   repair_mysql: off
-    #   repair_all: 'off'
-
-  roles:
-    - mysql
-    # - evolinux-base
-    # # - evolinux-users
-    # - ./ansible/roles/autosysadmin-agent
-    # - packweb-apache
-    # # - redis
-    # - { role: redis,     redis_instance_name:     foo,      redis_port: 6380 }
-    # - { role: redis,     redis_instance_name:     bar,      redis_port: 6381 }

docs/debian.md

@@ -49,6 +49,3 @@ Launch git-buildpackage :
 ~~~
 gbp buildpackage
 ~~~
-
-The generated build files (including the `.deb`) are located in the `/tmp/bkctld/` directory.
-

docs/install.md

@@ -0,0 +1,47 @@
+# Install
+
+A Debian package is available in the Evolix repository
+
+~~~
+echo "http://pub.evolix.net/jessie/" >> /etc/apt/sources.list
+apt update
+apt install bkctld
+~~~
+
+Then edit `/etc//bkctld`
+
+## Chroot dependencies
+
+The chroot jails depend on these packages
+
+~~~
+apt install \
+	bash \
+	coreutils \
+	sed \
+	dash \
+	mount \
+	rsync \
+	openssh-server \
+	openssh-sftp-server \
+	libc6-i386 \
+	libc6
+~~~
+
+## Client dependencies
+
+The clients only require OpenSSH and rsync.
+
+### Cron job for incremental backups
+
+Edit the root crontab
+
+~~~
+# crontab -e
++ 30 10 * * * /usr/sbin/bkctld inc && /usr/sbin/bkctld rm
+~~~
+
+## Notes
+If you want mutiples backups in a day (1 by hour maximum) you can
+run `bkctld inc` multiples times, if you want to keep incremental
+backups **for ever**, just don't run `bkctld rm`.

docs/usage.md

@@ -155,31 +155,31 @@ the backup server administrator will need:
 
 He can then create the jail:
 
-	# bkctld init <JAIL_NAME>
-	# bkctld key <JAIL_NAME> /root/<JAIL_NAME>.pub
-	# bkctld ip <JAIL_NAME> <IP_OR_CIDR>
-	# bkctld start <JAIL_NAME>
-	# bkctld status <JAIL_NAME>
+	# bkctld init CLIENT_HOST_NAME
+	# bkctld key CLIENT_HOST_NAME /root/CLIENT_HOST_NAME.pub
+	# bkctld ip CLIENT_HOST_NAME CLIENT_IP_ADDRESS
+	# bkctld start CLIENT_HOST_NAME
+	# bkctld status CLIENT_HOST_NAME
 
 And override the default
 evobackup-incl(5)
 rules
 
-	# $EDITOR /etc/evobackup/<JAIL_NAME>.d/incs_policy
+	# $EDITOR /etc/evobackup/CLIENT_HOST_NAME
 
 To sync itself,
 the client server will need to install
 rsync(1).
 It can then be run manually:
 
-	# rsync -av -e "ssh -p <JAIL_PORT>" /home/ root@<BACKUP_SERVER>:/var/backup/home/
+	# rsync -av -e "ssh -p JAIL_PORT" /home/ root@BACKUP_SERVER:/var/backup/home/
 
 If a more automated setup is required,
 a script can be written in any programming language.
 In this case,
 it may be useful to validate the backup server's identity before hand.
 
-	# ssh -p <JAIL_PORT> root@<BACKUP_SERVER> -t exit
+	# ssh -p JAIL_PORT BACKUP_SERVER
 
 A
 bash(1)

lib/bkctld-check

@@ -0,0 +1,70 @@
+#!/bin/sh
+#
+# Run check on jails (NRPE output)
+# Usage: check
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+cur_time=$(date "+%s")
+return=0
+nb_crit=0
+nb_warn=0
+nb_ok=0
+nb_unkn=0
+output=""
+
+if [ -b "${BACKUP_DISK}" ]; then
+    cryptsetup isLuks "${BACKUP_DISK}"
+    if [ "$?" -eq 0 ]; then
+        if [ ! -b '/dev/mapper/backup' ]; then
+            echo "Luks disk ${BACKUP_DISK} is not mounted !\n"
+            echo "cryptsetup luksOpen ${BACKUP_DISK} backup"
+            exit 2
+        fi
+        BACKUP_DISK='/dev/mapper/backup'
+    fi
+    grep -qE "^${BACKUP_DISK} " /etc/mtab
+    if [ "$?" -ne 0 ]; then
+         echo "Backup disk ${BACKUP_DISK} is not mounted !\n"
+         echo "mount ${BACKUP_DISK} /backup"
+         exit 2
+    fi
+fi
+
+for jail in $("${LIBDIR}/bkctld-list"); do
+    if [ -f "${JAILDIR}/${jail}/var/log/lastlog" ]; then
+        last_conn=$(stat --format=%Y "${JAILDIR}/${jail}/var/log/lastlog")
+        date_diff=$(( (cur_time - last_conn) / (60*60) ))
+        if [ "${date_diff}" -gt "${CRITICAL}" ]; then
+            nb_crit=$((nb_crit + 1))
+            output="${output}CRITICAL - ${jail} - ${date_diff} hours\n"
+            [ "${return}" -le 2 ] && return=2
+        elif [ "${date_diff}" -gt "${WARNING}" ]; then
+            nb_warn=$((nb_warn + 1))
+            output="${output}WARNING - ${jail} - ${date_diff} hours\n"
+            [ "${return}" -le 1 ] && return=1
+        else
+            nb_ok=$((nb_ok + 1))
+            output="${output}OK - ${jail} - ${date_diff} hours\n"
+        fi
+    else
+        nb_unkn=$((nb_unkn + 1))
+        output="${output}UNKNOWN - ${jail} doesn't have lastlog !\n"
+        [ "${return}" -le 3 ] && return=3
+    fi
+done
+
+[ "${return}" -ge 0 ] && header="OK"
+[ "${return}" -ge 1 ] && header="WARNING"
+[ "${return}" -ge 2 ] && header="CRITICAL"
+[ "${return}" -ge 3 ] && header="UNKNOW"
+
+printf "%s - %s UNK / %s CRIT / %s WARN / %s OK\n\n" "${header}" "${nb_unkn}" "${nb_crit}" "${nb_warn}" "${nb_ok}"
+
+printf "${output}" | grep -E "^UNKNOW"
+printf "${output}" | grep -E "^CRITICAL"
+printf "${output}" | grep -E "^WARNING"
+printf "${output}" | grep -E "^OK"
+
+exit "${return}"

lib/bkctld-firewall

@@ -0,0 +1,24 @@
+#!/bin/sh
+#
+# Update firewall rules of <jailname> or all
+# Usage: firewall <jailname>|all
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+jail="${1:-}"
+if [ ! -n "${jail}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+
+if [ -n "${FIREWALL_RULES}" ]; then
+    [ -f "${FIREWALL_RULES}" ] && sed -i "/#${jail}$/d" "${FIREWALL_RULES}"
+    if [ -d "${JAILDIR}/${jail}" ]; then
+        port=$("${LIBDIR}/bkctld-port" "${jail}")
+        for ip in $("${LIBDIR}/bkctld-ip" "${jail}"); do
+            echo "/sbin/iptables -A INPUT -p tcp --sport 1024: --dport ${port} -s ${ip} -j ACCEPT #${jail}" >> "${FIREWALL_RULES}"
+        done
+        [ -f /etc/init.d/minifirewall ] && /etc/init.d/minifirewall restart >/dev/null
+    fi
+    notice "${jail} : firewall rules updated"
+fi

lib/bkctld-help

@@ -0,0 +1,21 @@
+#!/bin/sh
+#
+# Print this help
+# Usage: help
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+cat <<EOF
+Usage: bkctld <subcommand> [options]
+Subcommands:
+EOF
+
+for subcommand in ${LIBDIR}/bkctld-*; do
+    name=$(basename "${subcommand}"|sed 's/^bkctld-//')
+    desc=$(grep -E "^#" "${subcommand}"|sed -n '3p'|sed "s/^# //")
+    usage=$(grep -E "^# Usage: ${name}" "${subcommand}"|sed "s/^# Usage: ${name}//")
+    printf "    %- 10s %- 30s %- 40s\n" "${name}" "${usage}" "${desc}"
+done
+
+printf "\n"

lib/bkctld-inc

@@ -0,0 +1,26 @@
+#!/bin/sh
+#
+# Make incremental inc of all jails
+# Usage: inc
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+date=$(date +"%Y-%m-%d-%H")
+for jail in $("${LIBDIR}/bkctld-list"); do
+    inc="${INCDIR}/${jail}/${date}"
+    mkdir -p "${INCDIR}/${jail}"
+    if [ ! -d "${inc}" ]; then
+        start=$(date +"%H:%M:%S")
+        jail_inode=$(stat --format=%i "${JAILDIR}/${jail}")
+        if [ "$jail_inode" -eq 256 ]; then
+            /bin/btrfs subvolume snapshot -r "${JAILDIR}/${jail}" "${inc}" | debug
+        else
+            cp -alx "${JAILDIR}/${jail}/" "${inc}" | debug
+        fi
+        end=$(date +"%H:%M:%S")
+        notice "${jail} : made ${date} inc [${start}/${end}]"
+    else
+        warning "${jail} : trying to made already existant inc"
+    fi
+done

lib/bkctld-init

@@ -0,0 +1,35 @@
+#!/bin/sh
+#
+# Init jail <jailname>
+# Usage: init <jailname>
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+jail="${1:-}"
+if [ ! -n "${jail}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+[ -d "${JAILDIR}/${jail}" ] && error "${jail} : trying to create existant jail"
+
+mkdir -p "${CONFDIR}" "${JAILDIR}"
+sshd_config="${TPLDIR}/sshd_config"
+inctpl="${TPLDIR}/inc.tpl"
+[ -f "${LOCALTPLDIR}/sshd_config" ] && sshd_config="${LOCALTPLDIR}/sshd_config"
+[ -f "${LOCALTPLDIR}/inc.tpl" ] && inctpl="${LOCALTPLDIR}/inc.tpl"
+
+rootdir=$(dirname "${JAILDIR}")
+rootdir_inode=$(stat --format=%i "${rootdir}")
+jaildir_inode=$(stat --format=%i "${JAILDIR}")
+if [ "${rootdir_inode}" -eq 256 ] || [ "${jaildir_inode}" -eq 256 ]; then
+    /bin/btrfs subvolume create "${JAILDIR}/${jail}"
+else
+    mkdir -p "${JAILDIR}/${jail}"
+fi
+. "${LIBDIR}/mkjail"
+info "4 - Copie default sshd_config"
+install -m 0640 "${sshd_config}" "${JAILDIR}/${jail}/${SSHD_CONFIG}"
+info "5 - Copie default inc configuration"
+install -m 0640 "${inctpl}" "${CONFDIR}/${jail}"
+"${LIBDIR}/bkctld-port" "${jail}" auto
+notice "${jail} : created jail"

lib/bkctld-ip

@@ -0,0 +1,35 @@
+#!/bin/sh
+#
+# Set or get allowed(s) ip(s) of <jailname>
+# Usage: ip <jailname> [<ip>|all]
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+jail="${1:-}"
+ip="${2:-}"
+if [ ! -n "${jail}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+[ -d "${JAILDIR}/${jail}" ] || error "${jail} : inexistant jail'"
+
+if [ -z "${ip}" ]; then
+    grep -E "^AllowUsers" "${JAILDIR}/$jail/${SSHD_CONFIG}"|grep -Eo "root@[^ ]+"| while read allow; do
+        echo "${allow}"|cut -d'@' -f2
+    done
+else
+    if [ "${ip}" = "all" ] || [ "${ip}" = "0.0.0.0/0" ]; then
+        ips="0.0.0.0/0"
+    else
+        ips=$("${LIBDIR}/bkctld-ip" "${jail}")
+        ips=$(echo "${ips}" "${ip}"|xargs -n1|grep -v "0.0.0.0/0"|sort|uniq)
+    fi
+    allow="AllowUsers"
+    for ip in $ips; do
+        allow="${allow} root@${ip}"
+    done
+    sed -i "s~^AllowUsers .*~${allow}~" "${JAILDIR}/$jail/${SSHD_CONFIG}"
+    notice "${jail} : update ip => ${ip}"
+    "${LIBDIR}/bkctld-is-on" "${jail}" && "${LIBDIR}/bkctld-reload" "${jail}"
+    "${LIBDIR}/bkctld-firewall" "${jail}"
+fi

lib/bkctld-is-on

@@ -0,0 +1,26 @@
+#!/bin/sh
+#
+# Check if a jail is on or not
+# Usage: is-on <jailname>
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+jail="${1:-}"
+if [ ! -n "${jail}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+[ -d "${JAILDIR}/${jail}" ] || error "${jail} : trying to check inexistant jail"
+
+jail="${1}"
+return=1
+if [ -f "${JAILDIR}/${jail}/${SSHD_PID}" ]; then
+    pid=$(cat "${JAILDIR}/${jail}/${SSHD_PID}")
+    ps -p "${pid}" > /dev/null && return=0
+fi
+if [ "${return}" -eq 1 ]; then
+    rm -f "${JAILDIR}/${jail}/${SSHD_PID}"
+    grep -q "${JAILDIR}/${jail}/proc" /proc/mounts && umount --lazy "${JAILDIR}/${jail}/proc/"
+    grep -q "${JAILDIR}/${jail}/dev" /proc/mounts && umount --lazy --recursive "${JAILDIR}/${jail}/dev"
+fi
+exit "${return}"

lib/bkctld-key

@@ -0,0 +1,27 @@
+#!/bin/sh
+#
+# Set or get ssh pubic key of <jailname>
+# Usage: key <jailname> [<keyfile>]
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+jail="${1:-}"
+keyfile="${2:-}"
+if [ ! -n "${jail}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+[ -d "${JAILDIR}/${jail}" ] || error "${jail} : inexistant jail'"
+
+if [ -z "${keyfile}" ]; then
+    if [ -f "${JAILDIR}/${jail}/${AUTHORIZED_KEYS}" ]; then
+        cat "${JAILDIR}/${jail}/${AUTHORIZED_KEYS}"
+    fi
+else
+    [ -e "${keyfile}" ] || error "Keyfile ${keyfile} dosen't exist !"
+    cat "${keyfile}" > "${JAILDIR}/${jail}/${AUTHORIZED_KEYS}"
+    chmod 600 "${JAILDIR}/${jail}/${AUTHORIZED_KEYS}"
+    notice "${jail} : update key => ${keyfile}"
+
+    "${LIBDIR}/bkctld-is-on" "${jail}" && "${LIBDIR}/bkctld-reload" "${jail}"
+fi

lib/bkctld-list

@@ -0,0 +1,12 @@
+#!/bin/sh
+#
+# List jails
+# Usage: list
+#
+
+set -eu
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+[ -d "${JAILDIR}" ] || exit 0
+find "${JAILDIR}" -mindepth 1 -maxdepth 1 -type d|sed 's!.*/!!'

lib/bkctld-port

@@ -0,0 +1,28 @@
+#!/bin/sh
+#
+# Set or get ssh port of <jailname>
+# Usage: port <jailname> [<port>|auto]
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+jail="${1:-}"
+port="${2:-}"
+if [ ! -n "${jail}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+[ -d "${JAILDIR}/${jail}" ] || error "${jail} : inexistant jail'"
+
+if [ -z "${port}" ]; then
+    grep -E "Port [0-9]+" "${JAILDIR}/${jail}/${SSHD_CONFIG}"|grep -oE "[0-9]+"
+else
+    if [ "${port}" = "auto" ]; then
+        port=$(grep -h Port "${JAILDIR}"/*/"${SSHD_CONFIG}" 2>/dev/null | grep -Eo "[0-9]+" | sort -n | tail -1)
+        port=$((port+1))
+        [ "${port}" -le 1 ] && port=2222
+    fi
+    sed -i "s/^Port .*/Port ${port}/" "${JAILDIR}/$jail/${SSHD_CONFIG}"
+    notice "${jail} : update port => ${port}"
+    "${LIBDIR}/bkctld-is-on" "${jail}" && "${LIBDIR}/bkctld-reload" "${jail}"
+    "${LIBDIR}/bkctld-firewall" "${jail}"
+fi

lib/bkctld-reload

@@ -0,0 +1,18 @@
+#!/bin/sh
+#
+# Reload jail <jailname> or all
+# Usage: reload <jailname>|all
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+jail="${1:-}"
+if [ ! -n "${jail}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+[ -d "${JAILDIR}/${jail}" ] || error "${jail} : trying to reload inexistant jail"
+"${LIBDIR}/bkctld-is-on" "${jail}" || exit 0
+
+pid=$(cat "${JAILDIR}/${jail}/${SSHD_PID}")
+
+kill -HUP "${pid}" && notice "${jail} was reloaded [${pid}]"

lib/bkctld-remove

@@ -0,0 +1,36 @@
+#!/bin/sh
+#
+# Remove jail <jailname> or all
+# Usage: remove <jailname>|all
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+jail="${1:-}"
+if [ ! -n "${jail}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+[ -d "${JAILDIR}/${jail}" ] || error "${jail} : trying to remove inexistant jail"
+"${LIBDIR}/bkctld-is-on" "${jail}" && "${LIBDIR}/bkctld-stop" "${jail}"
+
+rm -f "${CONFDIR}/${jail}"
+jail_inode=$(stat --format=%i "${JAILDIR}/${jail}")
+if [ "${jail_inode}" -eq 256 ]; then
+    /bin/btrfs subvolume delete "${JAILDIR}/${jail}" | debug
+else
+    rm -rf "${JAILDIR}/${jail}" | debug
+fi
+if [ -d  "${INCDIR}/${jail}" ]; then
+    incs=$(ls "${INCDIR}/${jail}")
+    for inc in ${incs}; do
+        inc_inode=$(stat --format=%i "${INCDIR}/${jail}/${inc}")
+        if [ "${inc_inode}" -eq 256 ]; then
+            /bin/btrfs subvolume delete "${INCDIR}/${jail}/${inc}" | debug
+        else
+            warning "You need to purge ${INCDIR}/${jail}/${inc} manually !"
+        fi
+    done
+    rmdir --ignore-fail-on-non-empty "${INCDIR}/${jail}" | debug
+fi
+"${LIBDIR}/bkctld-firewall" "${jail}"
+notice "${jail} : deleted jail"

lib/bkctld-restart

@@ -0,0 +1,17 @@
+#!/bin/sh
+#
+# Restart jail <jailname> or all
+# Usage: restart <jailname>|all
+#
+
+set -eu
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+jail="${1:-}"
+if [ ! -n "${jail}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+[ -d "${JAILDIR}/${jail}" ] || error "${jail} : trying to restart inexistant jail"
+"${LIBDIR}/bkctld-is-on" "${jail}" && "${LIBDIR}/bkctld-stop" "${jail}"
+"${LIBDIR}/bkctld-start" "${jail}"

lib/bkctld-rm

@@ -0,0 +1,48 @@
+#!/bin/sh
+#
+# Remove old incremtal inc of all jails
+# Usage: rm
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+empty="/tmp/bkctld-${$}-$(date +%N))"
+mkdir "${empty}"
+pidfile="/var/run/bkctld-rm.pid"
+if [ -f "${pidfile}" ]; then
+    pid=$(cat "${pidfile}")
+    ps -u "${pid}" >/dev/null
+    if [ "${?}" -eq 0 ]; then
+        kill -9 "${pid}"
+        warning "${0} rm always run (PID ${pid}), killed by ${$} !"
+    fi
+    rm "${pidfile}"
+    fi
+echo "${$}" > "${pidfile}"
+for jail in $("${LIBDIR}/bkctld-list"); do
+    incs=$(ls "${INCDIR}/${jail}")
+    if [ -f "${CONFDIR}/${jail}" ]; then
+        keepfile="$(mktemp)"
+        while read j; do
+            date=$( echo "${j}" | cut -d. -f1 )
+            before=$( echo "${j}" | cut -d. -f2 )
+            date -d "$(date "${date}") ${before}" "+%Y-%m-%d"
+        done < "${CONFDIR}/${jail}" > "${keepfile}"
+        for j in $(echo "${incs}" | grep -v -f "${keepfile}"); do
+            start=$(date +"%H:%M:%S")
+            inc_inode=$(stat --format=%i "${INCDIR}/${jail}/${j}")
+            if [ "${inc_inode}" -eq 256 ]; then
+                /bin/btrfs subvolume delete "${INCDIR}/${jail}/${j}" | debug
+            else
+                cd "${INCDIR}/${jail}"
+                rsync -a --delete "${empty}/" "${j}/"
+                rmdir "${j}"
+            fi
+            end=$(date +"%H:%M:%S")
+            notice "${jail} : deleted ${j} inc [${start}/${end}]"
+        done
+        rm "${keepfile}"
+    fi
+done
+rmdir "${empty}"
+rm "${pidfile}"

lib/bkctld-start

@@ -0,0 +1,42 @@
+#!/bin/sh
+#
+# Start jail <jailname> or all
+# Usage: start <jailname>|all
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+jail="${1:-}"
+if [ ! -n "${jail}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+[ -d "${JAILDIR}/${jail}" ] || error "${jail} : trying to start inexistant jail"
+"${LIBDIR}/bkctld-is-on" "${jail}" && exit 0
+
+cd "${JAILDIR}/${jail}"
+grep -q "${JAILDIR}/${jail}/proc" /proc/mounts || mount -t proc "proc-${jail}" proc
+grep -q "${JAILDIR}/${jail}/dev" /proc/mounts || mount -nt tmpfs "dev-${jail}" dev
+[ -e "dev/console" ] || mknod -m 622 dev/console c 5 1
+[ -e "dev/null" ] || mknod -m 666 dev/null c 1 3
+[ -e "dev/zero" ] || mknod -m 666 dev/zero c 1 5
+[ -e "dev/ptmx" ] || mknod -m 666 dev/ptmx c 5 2
+[ -e "dev/tty" ] || mknod -m 666 dev/tty c 5 0
+[ -e "dev/random" ] || mknod -m 444 dev/random c 1 8
+[ -e "dev/urandom" ] || mknod -m 444 dev/urandom c 1 9
+chown root:tty dev/console dev/ptmx dev/tty
+ln -fs proc/self/fd dev/fd
+ln -fs proc/self/fd/0 dev/stdin
+ln -fs proc/self/fd/1 dev/stdout
+ln -fs proc/self/fd/2 dev/stderr
+ln -fs proc/kcore dev/core
+mkdir -p dev/pts
+mkdir -p dev/shm
+grep -q "${JAILDIR}/${jail}/dev/pts" /proc/mounts || mount -t devpts -o gid=4,mode=620 none dev/pts
+grep -q "${JAILDIR}/${jail}/dev/shm" /proc/mounts || mount -t tmpfs none dev/shm
+chroot "${JAILDIR}/${jail}" /usr/sbin/sshd -E /var/log/authlog || error "${jail} : error on starting sshd"
+pidfile="${JAILDIR}/${jail}/${SSHD_PID}"
+for try in {1..10}; do
+    [ -f "${pidfile}" ] || sleep 0.3
+done
+pid=$(cat "${pidfile}")
+notice "${jail} was started [${pid}]"

lib/bkctld-stats

@@ -0,0 +1,34 @@
+#!/bin/sh
+#
+# Make and display stats on jails (size, lastconn)
+# Usage: stats
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+mkdir -p "${INDEX_DIR}"
+lsof "${IDX_FILE}" >/dev/null 2>&1 || nohup sh -s -- <<EOF >/dev/null 2>&1 &
+ionice -c3 "${DUC}" index -d "${IDX_FILE}" "${JAILDIR}"
+touch "${INDEX_DIR}/.lastrun.duc"
+EOF
+[ ! -f "${INDEX_DIR}/.lastrun.duc" ] && notice "First run of DUC always in progress ..." && exit 0
+[ ! -f ${IDX_FILE} ] && error "Index file do not exits !"
+printf "Last update of index file : "
+stat --format=%Y "${INDEX_DIR}/.lastrun.duc" | xargs -i -n1 date -R -d "@{}"
+echo "<jail> <size> <incs> <lastconn>" | awk '{ printf("%- 30s %- 10s %- 10s %- 15s\n", $1, $2, $3, $4); }'
+duc_output=$(mktemp)
+stat_output=$(mktemp)
+incs_output=$(mktemp)
+trap "rm ${duc_output} ${incs_output} ${stat_output}" 0
+"${DUC}" ls -d "${IDX_FILE}" "${JAILDIR}" > "${duc_output}"
+awk '{ print $2 }' "${duc_output}" | while read jail; do
+    stat --format=%Y "/backup/jails/${jail}/var/log/lastlog" | xargs -i -n1 date -d "@{}" "+%d-%m-%Y" >> "${stat_output}"
+    inc=0
+    if [ -f "${CONFDIR}/${jail}" ]; then
+        day=$(grep -c "day" "${CONFDIR}/${jail}")
+        month=$(grep -c "month" "${CONFDIR}/${jail}")
+        inc="${day}/${month}"
+    fi
+    echo "${inc}" >> "${incs_output}"
+done
+paste "${duc_output}" "${incs_output}" "${stat_output}" | awk '{ printf("%- 30s %- 10s %- 10s %- 15s\n", $2, $1, $3, $4); }'

lib/bkctld-status

@@ -0,0 +1,25 @@
+#!/bin/sh
+#
+# Print status of <jailname> (default all jail)
+# Usage: status [<jailname>]
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+jail="${1:-}"
+if [ ! -n "${jail}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+[ -d "${JAILDIR}/${jail}" ] || error "${jail} : inexistant jail ! Use '$0 status' for list all"
+
+inc="0"
+if [ -f "${CONFDIR}/${jail}" ]; then
+    day=$(grep -c "day" "${CONFDIR}/${jail}")
+    month=$(grep -c "month" "${CONFDIR}/${jail}")
+    inc="${day}/${month}"
+fi
+status="OFF"
+"${LIBDIR}/bkctld-is-on" "${jail}" && status="ON "
+port=$("${LIBDIR}/bkctld-port" "${jail}")
+ip=$("${LIBDIR}/bkctld-ip" "${jail}"|xargs|tr -s ' ' ',')
+echo "${jail} ${status} ${port} ${inc} ${ip}" | awk '{ printf("%- 30s %- 10s %- 10s %- 10s %- 40s\n", $1, $2, $3, $4, $5); }'

lib/bkctld-stop

@@ -0,0 +1,22 @@
+#!/bin/sh
+#
+# Stop jail <jailname> or all
+# Usage: stop <jailname>|all
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+jail="${1:-}"
+if [ ! -n "${jail}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+[ -d "${JAILDIR}/${jail}" ] || error "${jail} : trying to stop inexistant jail"
+"${LIBDIR}/bkctld-is-on" "${jail}" || exit 0
+
+pid=$(cat "${JAILDIR}/${jail}/${SSHD_PID}")
+for conn in $(ps --ppid "${pid}" -o pid=); do
+    kill "${conn}"
+done
+kill "${pid}" && notice "${jail} was stopped [${pid}]"
+umount --lazy --recursive "${JAILDIR}/${jail}/dev"
+umount --lazy "${JAILDIR}/${jail}/proc/"

lib/bkctld-sync

@@ -0,0 +1,25 @@
+#!/bin/sh
+#
+# Sync jail <jailname> or all to another node
+# Usage: sync <jailname>|all
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+jail="${1:-}"
+if [ ! -n "${jail}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+[ -d "${JAILDIR}/${jail}" ] || error "${jail} : trying to sync inexistant jail"
+
+[ -n "${NODE}" ] || error "Sync need config of \$NODE in /etc/default/bkctld !"
+
+jail="${1}"
+ssh "${NODE}" "${LIBDIR}/bkctld-init" "${jail}" | debug
+rsync -a "${JAILDIR}/${jail}/" "${NODE}:${JAILDIR}/${jail}/" --exclude proc/* --exclude sys/* --exclude dev/* --exclude run --exclude var/backup/*
+rsync -a "${CONFDIR}/${jail}" "${NODE}:${CONFDIR}/${jail}"
+"${LIBDIR}/bkctld-is-on" "${jail}" && ssh "${NODE}" "${LIBDIR}/bkctld-start" "${jail}" | debug
+if [ -n "${FIREWALL_RULES}" ]; then
+    rsync -a "${FIREWALL_RULES}" "${NODE}:${FIREWALL_RULES}"
+    ssh "${NODE}" /etc/init.d/minifirewall restart | debug
+fi

lib/bkctld-update

@@ -0,0 +1,17 @@
+#!/bin/sh
+#
+# Update jail <jailname> or all
+# Usage: update <jailname>|all
+#
+
+LIBDIR="$(dirname $0)" && . "${LIBDIR}/config"
+
+jail="${1:-}"
+if [ ! -n "${jail}" ]; then
+    "${LIBDIR}/bkctld-help" && exit 1
+fi
+[ -d "${JAILDIR}/${jail}" ] || error "${jail} : trying to update inexistant jail"
+"${LIBDIR}/bkctld-is-on" "${jail}" && "${LIBDIR}/bkctld-stop" "${jail}"
+
+. "${LIBDIR}/mkjail"
+notice "${jail} : updated jail"

lib/config

@@ -0,0 +1,64 @@
+#!/bin/sh
+#
+# Config for bkctld
+#
+
+[ -f /etc/default/bkctld ] && . /etc/default/bkctld
+LIBDIR=${LIBDIR:-/usr/lib/bkctld}
+CONFDIR="${CONFDIR:-/etc/evobackup}"
+BACKUP_DISK="${BACKUP_DISK:-}"
+JAILDIR="${JAILDIR:-/backup/jails}"
+INCDIR="${INCDIR:-/backup/incs}"
+TPLDIR="${TPLDIR:-/usr/share/bkctld}"
+INDEX_DIR="${INDEX_DIR:-/backup/index}"
+IDX_FILE="${IDX_FILE:-${INDEX_DIR}/bkctld-jails.idx}"
+LOCALTPLDIR="${LOCALTPLDIR:-/usr/local/share/bkctld}"
+SSHD_PID="${SSHD_PID:-/run/sshd.pid}"
+SSHD_CONFIG="${SSHD_CONFIG:-/etc/ssh/sshd_config}"
+AUTHORIZED_KEYS="${AUTHORIZED_KEYS:-/root/.ssh/authorized_keys}"
+FIREWALL_RULES="${FIREWALL_RULES:-}"
+LOGLEVEL="${LOGLEVEL:-6}"
+CRITICAL="${CRITICAL:-48}"
+WARNING="${WARNING:-24}"
+DUC=$(command -v duc-nox||command -v duc)
+
+debug() {
+    msg="${1:-$(cat /dev/stdin)}"
+    if [ "${LOGLEVEL}" -ge 7 ]; then
+        echo "${msg}"
+        logger -t bkctld -p daemon.debug "${msg}"
+    fi
+}
+
+info() {
+    msg="${1:-$(cat /dev/stdin)}"
+    if [ "${LOGLEVEL}" -ge 6 ]; then
+        tty -s && echo "${msg}"
+        logger -t bkctld -p daemon.info "${msg}"
+    fi
+}
+
+notice() {
+    msg="${1:-$(cat /dev/stdin)}"
+    tty -s && echo "${msg}"
+    [ "${LOGLEVEL}" -ge 5 ] && logger -t bkctld -p daemon.notice "${msg}"
+}
+
+warning() {
+    msg="${1:-$(cat /dev/stdin)}"
+    tty -s && echo "WARNING : ${msg}" >&2
+    if [ "${LOGLEVEL}" -ge 4 ]; then
+        tty -s || echo "WARNING : ${msg}" >&2
+        logger -t bkctld -p daemon.warning "${msg}"
+    fi
+}
+
+error() {
+    msg="${1:-$(cat /dev/stdin)}"
+    tty -s && echo "ERROR : ${msg}" >&2
+    if [ "${LOGLEVEL}" -ge 5 ]; then
+        tty -s || echo "ERROR : ${msg}" >&2
+        logger -t bkctld -p daemon.error "${msg}"
+    fi
+    exit 1
+}

lib/mkjail

@@ -0,0 +1,44 @@
+#!/bin/sh
+
+passwd="${TPLDIR}/passwd"
+shadow="${TPLDIR}/shadow"
+group="${TPLDIR}/group"
+sshrc="${TPLDIR}/sshrc"
+[ -f "${LOCALTPLDIR}/passwd" ] && passwd="${LOCALTPLDIR}/passwd"
+[ -f "${LOCALTPLDIR}/shadow" ] && shadow="${LOCALTPLDIR}/shadow"
+[ -f "${LOCALTPLDIR}/group" ] && group="${LOCALTPLDIR}/group"
+[ -f "${LOCALTPLDIR}/sshrc" ] && group="${LOCALTPLDIR}/sshrc"
+umask 077
+
+info "1 - Creating the chroot"
+cd "${JAILDIR}/${jail}"
+rm -rf bin lib lib64 run usr var/run etc/ssh/*key
+mkdir -p dev proc
+mkdir -p usr/bin usr/sbin usr/lib usr/lib/x86_64-linux-gnu usr/lib/openssh usr/lib64
+mkdir -p etc/ssh var/log run/sshd
+mkdir -p root/.ssh var/backup -m 0700
+ln -s usr/bin bin
+ln -s usr/lib lib
+ln -s usr/lib64 lib64
+ln -st var ../run
+touch var/log/lastlog var/log/wtmp run/utmp
+
+info "2 - Copying essential files"
+[ -f /etc/ssh/ssh_host_rsa_key ] && cp /etc/ssh/ssh_host_rsa_key etc/ssh
+[ -f /etc/ssh/ssh_host_ecdsa_key ] && cp /etc/ssh/ssh_host_ecdsa_key etc/ssh
+[ -f /etc/ssh/ssh_host_ed25519_key ] && cp /etc/ssh/ssh_host_ed25519_key etc/ssh
+cp "${passwd}" etc
+cp "${shadow}" etc
+cp "${group}" etc
+cp "${sshrc}" etc/ssh
+
+info "3 - Copying binaries"
+cp -f /lib/ld-linux.so.2 lib 2>/dev/null || cp -f /lib64/ld-linux-x86-64.so.2 lib64
+cp /lib/x86_64-linux-gnu/libnss* lib/x86_64-linux-gnu
+
+for dbin in /bin/sh /bin/ls /bin/mkdir /bin/cat /bin/rm /bin/sed /usr/bin/rsync /usr/bin/lastlog /usr/bin/touch /usr/sbin/sshd /usr/lib/openssh/sftp-server; do
+    cp -f "${dbin}" "${JAILDIR}/${jail}/${dbin}";
+    for lib in $(ldd "${dbin}" | grep -Eo "/.*so.[0-9\.]+"); do
+        cp -p "${lib}" "${JAILDIR}/${jail}/${lib}"
+    done
+done

server/.gitignore

@@ -1,3 +0,0 @@
-*.swp
-.vagrant
-build

server/CHANGELOG.md

@@ -1,265 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
-
-This project does not follow semantic versioning.
-The **major** part of the version is the year
-The **minor** part changes is the month
-The **patch** part changes is incremented if multiple releases happen the same month
-
-## [Unreleased]
-
-### Added
-
-### Changed
-
-### Deprecated
-
-### Removed
-
-### Fixed
-
-* Test presence of old config file before trying to delete it
-
-### Security
-
-## [22.11] - 2022-11-28
-
-### Added
-
-* check-canary: new subcommand to check canary files and content
-
-### Changed
-
-* stats: filter active jails and columnize the output
-
-## [22.07] - 2022-07-20
-
-### Changed
-
-* check-setup: check minifirewall version only if minifirewall is present
-* check-setup: get minifirewall version from internal variable (there is no other backward compatible way)
-* check-setup: use findmnt with mountpoint instead of target
-
-## [22.06] - 2022-06-28
-
-### Added
-
-* bkctld-init: create "incs/\<jail\>" directory for jails
-
-### Fixed
-
-* shell syntax error when ${btrfs_bin} variable is empty
-* read_variable + read_numerical_variable: keep the last found value only
-* Debian 8 findmnt(8) support
-
-### Security
-
-## [22.04] - 2022-04-20
-
-### Added
-
-* Run the test suite on Bullseye (ext4/btrfs) in addition of Stretch and Buster (ext4/btrfs)
-* Tell sed to follow symlinks
-* Add a header in `bkctld status` output and improved columns width.
-* bkctld-check-setup: compatibility with minifirewall 22.03+
-
-### Changed
-
-* change versioning pattern
-
-## [2.12.0] - 2021-11-02
-
-### Changed
-
-* btrfs depends on the btrfd-progs package instead of btrfs-tools
-
-## [2.11.1] - 2021-06-30
-
-### Changed
-
-* bkctld-rename: abort operation if incs exist with the new name
-
-## [2.11.0] - 2021-06-29
-
-### Changed
-
-* bkctld-remove: remove config directory
-
-### Fixed
-
-* force flag must be exported
-
-## [2.10.0] - 2021-06-29
-
-### Added
-
-* bkctld-archive: archive a jail
-* bkctld-rename: rename a jail and all its incs and configuration…
-
-### Removed
-
-* Do not print out date, log level and process name on stdout/stderr
-## [2.9.0] - 2021-02-22
-
-### Added
-
-* bkctld-init: install check_policy template
-* bkctld-upgrade-config: install check_policy template if missing
-* test: bkctld check-incs shouldn't fail without incs_policy file
-
-### Changed
-
-* Rename incs_policy template
-* bkctld-check-incs: Correct shellsheck warnings
-
-### Fixed
-
-* tests: clean jail configuration after each test
-* bkctld-check-incs: Protect `jail_config_epoch`
-
-## [2.8.0] - 2020-11-28
-
-### Added
-
-* bkctld: new inc-lock and inc-unlock command
-
-## [2.7.1] - 2020-11-28
-
-### Fixed
-
-* bkctld-upgrade-config is executable
-
-## [2.7.0] - 2020-11-13
-
-### Added
-
-* bkctld: add a [-f|--force] option to remove confirmation on some commands
-* bkctld-remove: confirmation before removal of jails if not in force mode
-* bkctld-rm: delete empty jails in incs directory
-
-### Changed
-
-* Better help message composition and formating
-* bkctld-rm: list jails from incs directory
-
-## [2.6.0] - 2020-10-07
-
-### Added
-
-* bkctld: add a [-V|--version] option to display release number
-* bkctld: add a [-h|--help|-?] option to display help message
-
-## [2.5.1] - 2020-10-07
-
-### Changed
-
-* bkctld: Replace xargs with a simple loop
-
-## [2.5.0] - 2020-09-25
-
-### Fixed
-
-* restore compatibility with Debian <10
-
-## [2.4.1] - 2020-08-28
-
-### Added
-
-* jails and incs lists are sorted alphanumerically
-
-### Fixed
-
-* bkctld-check-setup: forgot to increment the summary
-
-## [2.4.0] - 2020-08-19
-
-### Added
-
-* New command bkctld upgrade-config to move the legacy config file "/etc/evobackup/<jail>" to the new config structure "/etc/evobackup/<jail>.d/incs_policy"
-
-### Changed
-
-* bkctld-update: start jail after upgrade if it was started before
-* bkctld: don't replace SSH host keys when creating/updating a jail
-* Split check into check-jails and check-setup
-* bkctld-check-jails checks if jails
-* bkctld-check-setup checks if the partition is mounted and writable, if firewall is configured and if all jails are in their expected state
-* create new ssh keys for new jails instead of copying those from the host
-
-## [2.3.3] - 2020-05-28
-
-### Fixed
-
-* On sync, add trailing slash to rsync command
-
-## [2.3.2] - 2020-05-03
-
-### Changed
-
-* Display help message if mandatory arguments are missing.
-* Don't recreate jail on sync if it already exists
-* Don't sync the whole firewall file, just remake rules for the current jail
-* On sync, if local jail is running, reload remote jail if already running, start if not
-
-## [2.3.1] - 2020-04-22
-
-### Added
-
-* State the age of the current "rm" process when killing it
-* Give the new PID after killing the previous "rm" process
-
-### Fixed
-
-* typos
-* forgotten quotes
-
-## [2.3.0] - 2020-04-20
-
-### Changed
-
-* Rewrite log messages and format
-
-## [2.2.2] - 2020-04-19
-
-### Changed
-
-* Reorganize temp files and lock files
-
-### Fixed
-
-* Properly call subcommands in bkctld-check-incs and bkctld-check-last-incs
-* Log start time in bkctld-rm
-
-## [2.2.1] - 2020-04-18
-
-### Changed
-
-* check-incs.sh and check-last-incs.sh are embedded in bkctld
-
-## [2.2.0] - 2020-04-17
-
-### Added
-
-* Shellcheck directives to have 0 warnings and errors
-* Ability to override critical/warning thresholds per jail for bkctld-check
-* Support new location for jail configuration (/etc/evobackup/<jail_name>.d/)
-* Lock per jail and inc when creating incs
-* Global lock when removing incs (kill the currently running instance)
-* Create a blank SSH "authorized_keys" file on jail init
-* Many new tests with BATS
-* Check for firewall configuration in bkcld-check
-* Run the test suite on Buster (ext4/btrfs) in addition of Stretch (ext4/btrfs)
-
-### Changed
-
-* Extract variables and heper functions to reduce repetition of knowledge
-* Consistent naming of variables in scripts and functions
-* Consistent log messages between functions ad commands
-* Raise errors if required function arguments are missing
-* Configure locales in Vagrant VM
-* Split BATS tests file and use helper functions
-* Improve "lib" detection
-* Revamp the README

server/README.md

@@ -1,122 +0,0 @@
-Bkctld (aka server-side evobackup)
-=========
-
-bkctld helps you manage the receiving side of a backup infrastructure.
-It is licensed under the AGPLv3.
-
-With bkctld you create and manage "jails". They contain a chrooted and dedicated SSH server, with its own TCP port and optionally its own set of iptables rules.
-
-With bkctld you can have hundreds of jails, one for each client to push its data (using Rsync/SFTP). Each client can only see its own data.
-
-In addition to the traditional "ext4" filesystem, bkctld also supports the btrfs filesystem and manages subvolumes automatically.
-
-With bkctld you can create "timestamped" copies of the data, to keep different versions of the same data at different points in time. If the filesystem is btrfs, it creates subvolumes snapshots, otherwise it creates copies with hard-links (for file-level deduplication).
-
-With btrfs you can have a data retention policy to automatically destroy timestamped copies of your data. For example, keep a copy for the last 5 days and the first day of the last 3 months.
-
-~~~
-                                    Backup server
-                                    ************
-Client 1 ------ SSH/Rsync ------->  * tcp/2222 *
-                                    ************
-Client 2 ------ SSH/Rsync ------->  * tcp/2223 *
-                                    ************
-~~~
-
-This method uses standard tools (ssh, rsync, cp -al, btrfs subvolume) and has been used for many years by Evolix to backup hundreds of servers, totaling many terabytes of data, each day. bkctld has been tested on Debian Jessie (8), Stretch (9) and Buster (10) and should be compatible with other Debian versions or derived distributions like Ubuntu.
-
-A large enough volume must be mounted on `/backup`, we recommend the usage of **BTRFS** so you can use sub-volumes and snapshots.
-This volume can also be encrypted with **LUKS**.
-
-## Security considerations
-
-The client obviously has access to its uploaded data (in the chroot), but the timestamped copies are outside the chroot, to reduce the risk of complete backup erasure from a compromised client.
-
-It means that **if the client server is compromised**, an attacker can destroy the latest copy of the backed up data, but not the timestamped copies.
-And **if the backup server is compromised** an attacker has complete access to all the backup data (inside and outside the jails), but they don't have any access to the client.
-
-This architecture is as secure as SSH, Rsync, chroot and iptables are.
-
-## Install
-
-See the [installation guide](https://intra.evolix.net/OutilsInternes/bkctld) for instructions.
-
-## Testing
-
-You can deploy test environments with Vagrant :
-
-~~~
-vagrant up
-~~~
-
-To destroy Vagrant VMs :
-
-~~~
-vagrant destroy
-~~~
-
-### Deployment
-
-Run `vagrant rsync-auto` in a terminal for automatic synchronization of
-your local code with Vagrant VM :
-
-~~~
-vagrant rsync-auto
-~~~
-
-### Bats
-
-You can run [bats](https://github.com/sstephenson/bats) tests with
-the *test* provisioner :
-
-~~~
-vagrant provision --provision-with test
-~~~
-
-You can also run the tests from inside the VM
-
-~~~
-localhost $ vagrant ssh buster-btrfs
-vagrant@buster-btrfs $ sudo -i
-root@buster-btrfs # bats /vagrant/test/*.bats
-~~~
-
-[comment]: <> (* pour vim)
-
-You should shellcheck your bats files, but with shellcheck > 0.4.6, because the 0.4.0 version doesn't support bats syntax.
-
-## Usage
-
-See [docs/usage.md](docs/usage.md).
-
-The man(1) page, in troff(7) language, can be generated with pandoc:
-
-~~~
-pandoc -f markdown \
-	-t man usage.md \
-	--template default.man \
-	-V title=bkctld \
-	-V section=8 \
-	-V date="$(date '+%d %b %Y')" \
-	-V footer="$(git describe --tags)" \
-	-V header="bkctld man page"
-~~~
-
-#### Client configuration
-
-You can backup various systems in the evobackup jails : Linux, BSD,
-Windows, macOS. The only need is Rsync or an SFTP client.
-
-~~~
-rsync -av -e "ssh -p SSH_PORT" /home/ root@SERVER_NAME:/var/backup/home/
-~~~
-
-An example synchronization script is present in `zzz_evobackup`,
-clone the evobackup repository and read the **CLIENT CONFIGURATION**
-section of the manual.
-
-~~~
-git clone https://gitea.evolix.org/evolix/evobackup.git
-cd evobackup
-man ./docs/bkctld.8
-~~~

server/bash_completion

@@ -1,29 +0,0 @@
-# bkctld(8) completion
-#
-# Copyright (c) 2017 Victor Laborie <vlaborie@evolix.fr>
-#
-# shellcheck shell=bash
-
-function _bkctld()
-{
-    local cur prev commands jails keys
-
-    cur=${COMP_WORDS[COMP_CWORD]};
-    prev=${COMP_WORDS[COMP_CWORD-1]};
-    commands=$(find /usr/lib/bkctld/ -name "bkctld-*" -exec basename {} \; | sed 's/^bkctld-//')
-
-    if [ $COMP_CWORD -eq 1 ]; then
-        COMPREPLY=($(compgen -W '${commands}' -- ${cur}))
-    elif [ $COMP_CWORD -eq 2 ]; then
-        [ -f /etc/default/bkctld ] && source /etc/default/bkctld
-        [ -z "${JAILDIR}" ] && JAILDIR='/backup/jails'
-        jails=$(ls "${JAILDIR}")
-          COMPREPLY=($(compgen -W "${jails}" -- ${cur}))
-    elif [ $COMP_CWORD -eq 3 ]; then
-        keys=$(ls *.pub)
-        COMPREPLY=($(compgen -W "${keys}" -- ${cur}))
-    fi
-
-    return 0
-} &&
-complete -F _bkctld bkctld

server/bkctld

@@ -1,179 +0,0 @@
-#!/bin/sh
-#
-# bkctld is a shell script to create and manage a backup server which will
-# handle the backup of many servers (clients).
-#
-# Authors: Victor Laborie <vlaborie@evolix.fr>
-#          Jérémy Lecour <jlecour@evolix.fr>
-#          Benoît Série <bserie@evolix.fr>
-#          Gregory Colpart <reg@evolix.fr>
-#          Romain Dessort <rdessort@evolix.fr>
-#          Tristan Pilat <tpilat@evolix.fr>
-# Licence: AGPLv3
-#
-
-set -u
-
-if [ "$(id -u)" -ne 0 ]; then
-    echo "You need to be root to run ${0} !" >&2
-    exit 1
-fi
-
-basedir=$(dirname "$0")
-if [ "${basedir}" = "/usr/local/sbin" ] && [ -d "/usr/local/lib/bkctld" ]; then
-    LIBDIR='/usr/local/lib/bkctld'
-elif [ "${basedir}" = "/usr/sbin" ] && [ -d "/usr/lib/bkctld" ]; then
-    LIBDIR='/usr/lib/bkctld'
-elif [ -d './lib' ]; then
-    LIBDIR='lib'
-else
-    echo "Failed to find a suitable lib directory for bkctld." >&2
-    exit 1
-fi
-
-# shellcheck source=lib/includes
-. "${LIBDIR}/includes"
-
-# Parse options
-# based on https://gist.github.com/deshion/10d3cb5f88a21671e17a
-if [ "$#" = "0" ]; then
-    show_help
-    exit 1
-fi
-while :; do
-    case $1 in
-        -h|-\?|--help)
-            show_help
-            exit 0
-            ;;
-        -V|--version)
-            show_version
-            exit 0
-            ;;
-        -f|--force)
-            export FORCE=1
-            ;;
-        --no-header)
-            export HEADER=0
-            ;;
-        *)
-            # Default case: If no more options then break out of the loop.
-            break
-            ;;
-    esac
-
-    shift
-done
-
-subcommand="${1:-}"
-case "${subcommand}" in
-    "inc" | "rm" | "check-jails" | "check-setup" | "check-canary" | "stats" | "list")
-        "${LIBDIR}/bkctld-${subcommand}"
-    ;;
-    "check")
-        # backward compatibility
-        "${LIBDIR}/bkctld-check-jails"
-    ;;
-    "check-incs")
-        option="${2:-}"
-        if [ "${option}" = "all" ] || [ -z "${option}" ]; then
-            "${LIBDIR}/bkctld-check-incs"
-        elif [ "${option}" = "last" ]; then
-            "${LIBDIR}/bkctld-check-last-incs"
-        else
-            show_help
-            exit 1
-        fi
-    ;;
-    "init" | "is-on")
-        jail_name="${2:-}"
-        if [ -z "${jail_name}" ]; then
-            show_help
-            exit 1
-        else
-            "${LIBDIR}/bkctld-${subcommand}" "${jail_name}"
-        fi
-    ;;
-    "key" | "port" | "ip")
-        jail_name="${2:-}"
-        option="${3:-}"
-        if [ "${jail_name}" = "all" ] || [ -z "${jail_name}" ]; then
-            show_help
-            exit 1
-        else
-            "${LIBDIR}/bkctld-${subcommand}" "${jail_name}" "${option}"
-        fi
-    ;;
-    "start" | "stop" | "reload" | "restart" | "sync" | "update" | "remove" | "firewall" | "upgrade-config" | "archive")
-        jail_name="${2:-}"
-        if [ "${jail_name}" = "all" ]; then
-            for jail in $("${LIBDIR}/bkctld-list"); do
-                "${LIBDIR}/bkctld-${subcommand}" "${jail}"
-            done
-        elif [ -z "${jail_name}" ]; then
-            show_help
-            exit 1
-        else
-            "${LIBDIR}/bkctld-${subcommand}" "${jail_name}"
-        fi
-    ;;
-    "status")
-        jail_name="${2:-}"
-        if [ "${HEADER}" = "1" ]; then
-            printf '%-30s %-10s %-10s %-25s %-20s\n' 'JAIL NAME' 'STATUS' 'PORT' 'RETENTION (DAY/MONTH)' 'IP'
-        fi
-        if [ "${jail_name}" = "all" ] || [ -z "${jail_name}" ]; then
-            for jail in $("${LIBDIR}/bkctld-list"); do
-                "${LIBDIR}/bkctld-${subcommand}" "${jail}"
-            done
-        else
-            "${LIBDIR}/bkctld-${subcommand}" "${jail_name}"
-        fi
-    ;;
-    "inc-lock" | "inc-unlock")
-        if [ "${subcommand}" = "inc-lock" ]; then
-            lock_status=on
-        elif [ "${subcommand}" = "inc-unlock" ]; then
-            lock_status=off
-        else
-            show_help
-            exit 1
-        fi
-        pattern="${2:-}"
-        if [ "${pattern}" = "all" ]; then
-            target_path_pattern=$(incs_path "*/*")
-        elif [ -n "${pattern}" ]; then
-            # Check if pattern is a jail name
-            if jails_with_incs_list | grep --silent --fixed-strings --line-regexp "${pattern}"; then
-                debug "${pattern} is a jail, change pattern to ${pattern}/*"
-                # then change attern to all subdirectories
-                target_path_pattern=$(incs_path "${pattern}/*")
-            else
-                # or use it as is
-                target_path_pattern=$(incs_path "${pattern}")
-            fi
-        else
-            show_help
-            exit 1
-        fi
-
-        for target_path in ${target_path_pattern}; do
-            "${LIBDIR}/bkctld-inc-lock" "${lock_status}" "${target_path}"
-        done
-        echo "finish"
-    ;;
-    "rename")
-        jail_name="${2:-}"
-        new_jail_name="${3:-}"
-        if [ -z "${jail_name}" ] || [ -z "${new_jail_name}" ]; then
-            show_help
-            exit 1
-        else
-            "${LIBDIR}/bkctld-${subcommand}" "${jail_name}" "${new_jail_name}"
-        fi
-    ;;
-    *)
-        show_help
-        exit 1
-    ;;
-esac

server/docs/install.md

@@ -1,63 +0,0 @@
-# Install
-
-## Install from package
-
-The install documentation is [here](https://intra.evolix.net/OutilsInternes/bkctld)
-
-## Instal from sources
-
-Warning: `cp`-ing the files without `-n` or `-i` will replace existing files !
-
-~~~
-# git clone https://gitea.evolix.org/evolix/evobackup.git
-# cd evobackup
-# cp server/bkctld /usr/local/sbin/
-# mkdir -p /usr/local/lib/bkctld
-# cp server/lib/* /usr/local/lib/bkctld/
-# mkdir -p /usr/local/share/bkctld
-# cp server/tpl/* /usr/local/share/bkctld/
-# cp server/bkctld.service /lib/systemd/system/
-# mkdir -p /usr/local/share/doc/bkctld
-# cp client/zzz_evobackup /usr/local/share/doc/bkctld/
-# mkdir -p /usr/local/share/bash_completion/
-# cp server/bash_completion /usr/local/share/bash_completion/bkctld
-# cp server/bkctld.conf /etc/default/bkctld
-~~~
-
-## Chroot dependencies
-
-The chroot jails depend on these packages
-
-~~~
-apt install \
-    bash \
-    coreutils \
-    sed \
-    dash \
-    mount \
-    rsync \
-    openssh-server \
-    openssh-sftp-server \
-    libc6-i386 \
-    libc6
-~~~
-
-## Client dependencies
-
-The clients only require OpenSSH and Rsync.
-
-### Cron job for incremental backups
-
-Edit the root crontab
-
-~~~
-# $editor /etc/cron.d/bkctld
-+ MAILTO=alert4@evolix.net
-+ 30 11 * * * root /usr/sbin/bkctld inc && /usr/sbin/bkctld rm
-+ 30 23 * * * root /usr/share/scripts/check-incs.sh 1> /dev/null
-~~~
-
-## Notes
-If you want mutiples backups in a day (1 per hour maximum) you can
-run `bkctld inc` multiples times, if you want to keep incremental
-backups **for ever**, just don't run `bkctld rm`.

server/lib/bkctld-archive

@@ -1,51 +0,0 @@
-#!/bin/sh
-#
-# Description: Archive jail and all dated copies (incs)
-# Usage: archive <jailname>|all
-# Return codes:
-# * 101 : jail archival aborted
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-if [ -z "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-
-test -d "${jail_path}" || error "${jail_name}: jail not found" 2
-
-archive_jail_path=$(archive_path "${jail_name}")
-
-test -d "${archive_jail_path}" && error "${jail_name}: archive already exists" 2
-
-if [ "${FORCE}" != "1" ]; then
-    answer=""
-    while :; do
-        printf "> Are you sure you want to archive jail \`%s'? [Y,n,?] " "${jail_name}"
-        read -r answer
-        case $answer in
-            [Yy]|"" )
-                break
-                ;;
-            [Nn] )
-                tty -s && echo "Abort." >&2
-                exit 101
-                ;;
-            * )
-                printf "y - yes, execute actions and exit\n"
-                printf "n - no, don't execute actions and exit\n"
-                printf "? - print this help\n"
-                ;;
-        esac
-    done
-fi
-
-"${LIBDIR}/bkctld-is-on" "${jail_name}" && "${LIBDIR}/bkctld-stop" "${jail_name}"
-
-mkdir -p "$(dirname "${archive_jail_path}")"
-mv "${jail_path}" "${archive_jail_path}"
-
-notice "Archive jail \`${jail_name}' : OK"

server/lib/bkctld-check-canary

@@ -1,59 +0,0 @@
-#!/bin/sh
-#
-# Description: check canary file
-# Usage: check-canary [<jailname>|all]
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-return=0
-nb_crit=0
-nb_warn=0
-nb_ok=0
-nb_unkn=0
-output=""
-
-date=$(date +"%Y-%m-%d")
-
-# Check each jail status
-
-check_jail() {
-    jail_name=$1
-
-    jail_path=$(jail_path "${jail_name}")
-    canary_absolute_file="${jail_path}/var/backup/${CANARY_RELATIVE_FILE}"
-
-    if [ -f "${canary_absolute_file}" ]; then
-        if grep --quiet --fixed-string "${date}" "${canary_absolute_file}"; then
-            nb_ok=$((nb_ok + 1))
-            output="${output}OK - ${jail_name} - entries found for ${date} in ${CANARY_RELATIVE_FILE} file\n"
-        else
-            nb_crit=$((nb_crit + 1))
-            output="${output}CRITICAL - ${jail_name} - No entry for ${date} in ${CANARY_RELATIVE_FILE} file\n"
-            [ "${return}" -le 2 ] && return=2
-        fi
-    else
-        nb_crit=$((nb_crit + 1))
-        output="${output}CRITICAL - ${jail_name} - missing ${CANARY_RELATIVE_FILE} file\n"
-        [ "${return}" -le 2 ] && return=2
-    fi
-}
-
-for jail_name in $(jails_list); do
-    check_jail "${jail_name}"
-done
-
-[ "${return}" -ge 0 ] && header="OK"
-[ "${return}" -ge 1 ] && header="WARNING"
-[ "${return}" -ge 2 ] && header="CRITICAL"
-[ "${return}" -ge 3 ] && header="UNKNOWN"
-
-printf "%s - %s UNK / %s CRIT / %s WARN / %s OK\n\n" "${header}" "${nb_unkn}" "${nb_crit}" "${nb_warn}" "${nb_ok}"
-
-printf "${output}" | grep -E "^UNKNOWN"
-printf "${output}" | grep -E "^CRITICAL"
-printf "${output}" | grep -E "^WARNING"
-printf "${output}" | grep -E "^OK"
-
-exit "${return}"

server/lib/bkctld-check-incs

@@ -1,60 +0,0 @@
-#!/bin/sh
-#
-# Description: Run check on all expected incs of all jails
-# Usage: check-incs all
-#
-
-set -u
-
-# shellcheck source=./includes
-LIBDIR="$(dirname "$0")" && . "${LIBDIR}/includes"
-
-# default return value is 0 (succes)
-rc=0
-# loop for each configured jail
-for jail_name in $("${LIBDIR}/bkctld-list"); do
-    incs_policy_file=$(current_jail_incs_policy_file "${jail_name}")
-
-    # Today in seconds from epoch
-    today_epoch=$(date +"%s")
-    # Today in ISO format
-    today_iso=$(date +"%Y-%m-%d")
-
-    if [ -n "${incs_policy_file}" ]; then
-        # get jail last configuration date
-        jail_config_epoch=$(date --date "$(stat -c %y "${incs_policy_file}")" +"%s")
-
-        # read each line in jail configuration
-        while read line; do
-            ## TODO
-            # deal with empty lines
-
-            # inc date in ISO format
-            inc_iso=$(relative_date "${line}")
-            # inc date in seconds from epoch
-            inc_epoch=$(date --date "${inc_iso}" +"%s")
-
-            # skip line if date is in the future
-            if [ "${inc_epoch}" -gt "${today_epoch}" ]; then
-                echo "INFO: ${jail_name} : no inc expected for ${inc_iso}"
-            else
-                # check if the configuration changed after the inc date
-                # or if it's today's inc
-                if [ "${jail_config_epoch}" -lt "${inc_epoch}" ] \
-                || [ "${today_iso}" = "${inc_iso}" ]; then
-                    # Error if inc is not found
-                    if ! inc_exists "${jail_name}" "${inc_iso}*"; then
-                        echo "ERROR: ${jail_name} : missing inc for ${inc_iso}" >&2
-                        rc=1
-                    fi
-                else
-                    echo "INFO: ${jail_name} : no inc expected for ${inc_iso}"
-                fi
-            fi
-        done < "${incs_policy_file}"
-    else
-        echo "INFO: ${jail_name} : no inc expected at all"
-    fi
-done
-
-exit $rc

server/lib/bkctld-check-jails

@@ -1,78 +0,0 @@
-#!/bin/sh
-#
-# Description: Run check on jails (NRPE output)
-# Usage: check-jails
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-return=0
-nb_crit=0
-nb_warn=0
-nb_ok=0
-nb_unkn=0
-output=""
-
-# Check each jail status
-
-check_jail() {
-    jail_name=$1
-
-    jail_path=$(jail_path "${jail_name}")
-    cur_time=$(date "+%s")
-    last_conn=$(stat --format=%Y "${jail_path}/var/log/lastlog")
-    date_diff=$(( (cur_time - last_conn) / (60*60) ))
-
-    check_policy_file=$(current_jail_check_policy_file "${jail_name}")
-
-    if [ -f "${check_policy_file}" ]; then
-        local_critical=$(read_numerical_variable "${check_policy_file}" "CRITICAL")
-        local_warning=$(read_numerical_variable "${check_policy_file}" "WARNING")
-    else
-        unset local_critical
-        unset local_warning
-    fi
-    # reset to default values if missing local value
-    : ${local_critical:=${CRITICAL}}
-    : ${local_warning:=${WARNING}}
-
-    if [ "${local_critical}" -gt "0" ] && [ "${date_diff}" -gt "${local_critical}" ]; then
-        nb_crit=$((nb_crit + 1))
-        output="${output}CRITICAL - ${jail_name} - ${date_diff} hours (${local_warning}/${local_critical})\n"
-        [ "${return}" -le 2 ] && return=2
-    elif [ "${local_warning}" -gt "0" ] && [ "${date_diff}" -gt "${local_warning}" ]; then
-        nb_warn=$((nb_warn + 1))
-        output="${output}WARNING - ${jail_name} - ${date_diff} hours (${local_warning}/${local_critical})\n"
-        [ "${return}" -le 1 ] && return=1
-    else
-        nb_ok=$((nb_ok + 1))
-        output="${output}OK - ${jail_name} - ${date_diff} hours (${local_warning}/${local_critical})\n"
-    fi
-}
-
-for jail_name in $(jails_list); do
-    jail_path=$(jail_path "${jail_name}")
-
-    if [ -f "${jail_path}/var/log/lastlog" ]; then
-        check_jail "${jail_name}"
-    else
-        nb_unkn=$((nb_unkn + 1))
-        output="${output}UNKNOWN - ${jail_name} doesn't have lastlog !\n"
-        [ "${return}" -le 3 ] && return=3
-    fi
-done
-
-[ "${return}" -ge 0 ] && header="OK"
-[ "${return}" -ge 1 ] && header="WARNING"
-[ "${return}" -ge 2 ] && header="CRITICAL"
-[ "${return}" -ge 3 ] && header="UNKNOWN"
-
-printf "%s - %s UNK / %s CRIT / %s WARN / %s OK\n\n" "${header}" "${nb_unkn}" "${nb_crit}" "${nb_warn}" "${nb_ok}"
-
-printf "${output}" | grep -E "^UNKNOWN"
-printf "${output}" | grep -E "^CRITICAL"
-printf "${output}" | grep -E "^WARNING"
-printf "${output}" | grep -E "^OK"
-
-exit "${return}"

server/lib/bkctld-check-last-incs

@@ -1,31 +0,0 @@
-#!/bin/sh
-#
-# Description: Run check on the last inc of all jails
-# Usage: check-incs last
-#
-
-set -u
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-# default return value is 0 (succes)
-rc=0
-# loop for each found jail
-for jail_name in $("${LIBDIR}/bkctld-list"); do
-    incs_policy_file=$(current_jail_incs_policy_file "${jail_name}")
-
-    if [ -n "${incs_policy_file}" ]; then
-        # inc date in seconds from epoch
-        inc_date=$(date +"%Y-%m-%d")
-        # Error if inc is not found
-        if ! inc_exists "${jail_name}" "${inc_date}*"; then
-            echo "ERROR: ${jail_name} : missing inc for ${inc_date}" >&2
-            rc=1
-        fi
-    else
-        echo "INFO: ${jail_name} : no inc expected at all"
-    fi
-done
-
-exit $rc

server/lib/bkctld-check-setup

@@ -1,93 +0,0 @@
-#!/bin/sh
-#
-# Description: Run check on jails (NRPE output)
-# Usage: check setup
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-return=0
-nb_crit=0
-nb_warn=0
-nb_ok=0
-nb_unkn=0
-output=""
-
-# Verify backup partition is mounted and writable
-
-findmnt -O rw --mountpoint "${BACKUP_PARTITION}" > /dev/null
-if [ "$?" -ne 0 ]; then
-    nb_crit=$((nb_crit + 1))
-    output="${output}CRITICAL - Backup disk \`/backup' is not mounted (or read-only) !\n"
-    return=2
-else
-    nb_ok=$((nb_ok + 1))
-    output="${output}OK - Backup disk \`/backup' is mounted and writable.\n"
-fi
-
-# Check if the firewall file is sourced
-
-minifirewall_config=/etc/default/minifirewall
-
-if [ -n "${FIREWALL_RULES}" ] \
-&& [ -r "${FIREWALL_RULES}" ] \
-&& [ -f "${minifirewall_config}" ]; then
-    minifirewall_version=$(grep -E -o "^VERSION=(\S+)" /etc/init.d/minifirewall | head -1 | cut -d '=' -f 2 | tr -d "'" | tr -d '"')
-
-    if [ -n "${minifirewall_version}" ] && dpkg --compare-versions "${minifirewall_version}" ge "22.03"; then
-        # Minifirewall 22.03+ includes files automatically
-        nb_ok=$((nb_ok + 1))
-        output="${output}OK - Firewall file \`${FIREWALL_RULES}' is present.\n"
-    else
-        if grep -qE "^(\.|source) ${FIREWALL_RULES}" "${minifirewall_config}"; then
-            nb_ok=$((nb_ok + 1))
-            output="${output}OK - Firewall file \`${FIREWALL_RULES}' is sourced by \`${minifirewall_config}'.\n"
-        else
-            nb_warn=$((nb_warn + 1))
-            output="${output}WARNING - Firewall file \`${FIREWALL_RULES}' doesn't seem to be sourced by \`${minifirewall_config}'\n"
-            [ "${return}" -le 1 ] && return=1
-        fi
-    fi
-fi
-
-# Check if jails are started
-nb_on=0
-nb_off=0
-for jail_name in $(jails_list); do
-    if "${LIBDIR}/bkctld-is-on" "${jail_name}"; then
-        nb_on=$((nb_on + 1))
-    else
-        expected_state="ON"
-        check_policy_file=$(current_jail_check_policy_file "${jail_name}")
-
-        if [ -f "${check_policy_file}" ]; then
-            expected_state=$(read_variable "${check_policy_file}" "EXPECTED_STATE")
-        fi
-        if [ "${expected_state}" != "OFF" ]; then
-            nb_off=$((nb_off + 1))
-        fi
-    fi
-done
-if [ "${nb_off}" -eq 0 ]; then
-    output="${output}OK - all jails are in their expected state.\n"
-    nb_ok=$((nb_ok + 1))
-else
-    output="${output}CRITICAL - ${nb_off} jail(s) shouldn't be OFF !\n"
-    nb_crit=$((nb_crit + 1))
-    [ "${return}" -le 2 ] && return=2
-fi
-
-[ "${return}" -ge 0 ] && header="OK"
-[ "${return}" -ge 1 ] && header="WARNING"
-[ "${return}" -ge 2 ] && header="CRITICAL"
-[ "${return}" -ge 3 ] && header="UNKNOWN"
-
-printf "%s - %s UNK / %s CRIT / %s WARN / %s OK\n\n" "${header}" "${nb_unkn}" "${nb_crit}" "${nb_warn}" "${nb_ok}"
-
-printf "${output}" | grep -E "^UNKNOWN"
-printf "${output}" | grep -E "^CRITICAL"
-printf "${output}" | grep -E "^WARNING"
-printf "${output}" | grep -E "^OK"
-
-exit "${return}"

server/lib/bkctld-firewall

@@ -1,41 +0,0 @@
-#!/bin/sh
-#
-# Description: Update firewall rules
-# Usage: firewall [<jailname>|all]
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-
-if [ -z "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-
-iptables_input_accept() {
-    jail_name="${1}"
-    port="${2}"
-    ip="${3}"
-    debug "Accept \`${ip}:${port}' for jail \`${jail_name}'"
-
-    echo "/sbin/iptables -A INPUT -p tcp --sport 1024: --dport ${port} -s ${ip} -j ACCEPT #${jail_name}"
-}
-
-if [ -n "${FIREWALL_RULES}" ]; then
-    # remove existing rules for this jail
-    [ -f "${FIREWALL_RULES}" ] && sed --follow-symlinks --in-place "/#${jail_name}$/d" "${FIREWALL_RULES}"
-    if [ -d "${jail_path}" ]; then
-        port=$("${LIBDIR}/bkctld-port" "${jail_name}")
-        # Add a rule for each IP
-        for ip in $("${LIBDIR}/bkctld-ip" "${jail_name}"); do
-            iptables_input_accept "${jail_name}" "${port}" "${ip}" >> "${FIREWALL_RULES}"
-        done
-        # Restart the firewall
-        [ -f /etc/init.d/minifirewall ] && /etc/init.d/minifirewall restart >/dev/null
-    fi
-    notice "Firewall updated for jail \`${jail_name}'"
-else
-    notice "Skip jail \`${jail_name}' : FIREWALL_RULES variable is empty."
-fi

server/lib/bkctld-inc

@@ -1,78 +0,0 @@
-#!/bin/sh
-#
-# Description: Make dated copies (incs) of jails
-# Usage: inc
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-create_inc_btrfs() {
-    jail_name=${1:?}
-    inc_name=${2:?}
-
-    jail_path=$(jail_path "${jail_name}")
-    inc_path=$(inc_path "${jail_name}" "${inc_name}")
-
-    btrfs_bin=$(command -v btrfs)
-    if [ -z "${btrfs_bin}" ]; then
-        error "btrfs not found. Please install btrfs-progs."
-    fi
-
-    if dry_run; then
-        echo "[dry-run] btrfs subvolume snapshot of ${jail_path} to ${inc_path}"
-    else
-        mkdir --parents "$(dirname "${inc_path}")"
-        # create a btrfs readonly snapshot from the jail
-        ${btrfs_bin} subvolume snapshot -r "${jail_path}" "${inc_path}" | debug
-    fi
-}
-create_inc_ext4() {
-    jail_name=${1:?}
-    inc_name=${2:?}
-
-    jail_path=$(jail_path "${jail_name}")
-    inc_path=$(inc_path "${jail_name}" "${inc_name}")
-
-    if dry_run; then
-        echo "[dry-run] copy of ${jail_path} to ${inc_path}"
-    else
-        mkdir --parents "$(dirname "${inc_path}")"
-        # create a copy of the jail with hard links
-        cp --archive --link --one-file-system "${jail_path}/" "${inc_path}"
-    fi
-}
-
-inc_name=$(date +"%Y-%m-%d-%H")
-
-jails_list=$(jails_list)
-jails_total=$(echo $jails_list | wc -w)
-jails_count=0
-
-for jail_name in ${jails_list}; do
-    jails_count=$((jails_count+1))
-    jail_path=$(jail_path "${jail_name}")
-    inc_path=$(inc_path "${jail_name}" "${inc_name}")
-    incs_policy_file=$(current_jail_incs_policy_file ${jail_name})
-
-    # If no incs policy is found, we don't create incs
-    if [ -n "${incs_policy_file}" ]; then
-        # If inc directory is not present, we proceed with inc creation
-        if [ ! -d "${inc_path}" ]; then
-            info "Progress: jail ${jails_count} out of ${jails_total}"
-            notice "Create inc \`${inc_name}' for jail \`${jail_name}' : start"
-
-            if is_btrfs "${jail_path}"; then
-                create_inc_btrfs "${jail_name}" "${inc_name}"
-            else
-                create_inc_ext4 "${jail_name}" "${inc_name}"
-            fi
-
-            notice "Create inc \`${inc_name}' for jail \`${jail_name}' : finish"
-        else
-            warning "Skip inc \`${inc_name}' for jail \`${jail_name}' : it already exists."
-        fi
-    else
-        notice "Skip jail \`${jail_name}' : incs policy is missing"
-    fi
-done

server/lib/bkctld-inc-lock

@@ -1,53 +0,0 @@
-#!/bin/sh
-#
-# Description: Lock or unlock dated copies (incs) on BTRFS formatted volumes
-# Usage: inc-<lock|unlock> <all|jailname[/inc]>
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-lock_status="${1:?}"
-target_path="${2:?}"
-
-lock_target() {
-    target="${1:?}"
-    btrfs_bin=$(command -v btrfs)
-    if [ -z "${btrfs_bin}" ]; then
-        error "btrfs not found. Please install btrfs-progs."
-    fi
-    if is_btrfs "${target}"; then
-        ${btrfs_bin} property set -ts "${target}" ro true
-        info "Lock ${target}: done".
-    else
-        info "Lock ${target}: not BTRFS, nothing done".
-    fi
-}
-unlock_target() {
-    target="${1:?}"
-    btrfs_bin=$(command -v btrfs)
-    if [ -z "${btrfs_bin}" ]; then
-        error "btrfs not found. Please install brtfs-progs."
-    fi
-    if is_btrfs "${target}"; then
-        ${btrfs_bin} property set -ts "${target}" ro false
-        info "Unlock ${target}: done."
-    else
-        info "Unlock ${target}: not BTRFS, nothing done."
-    fi
-}
-
-# this directory test must be quoted,beacause of the probable globbing
-if [ -d ${target_path} ]; then
-    if [ "${lock_status}" = "on" ]; then
-        lock_target "${target_path}"
-    elif [ "${lock_status}" = "off" ]; then
-        unlock_target "${target_path}"
-    else
-        error "Unknown lock status \`${lock_status}'."
-        exit 1
-    fi
-else
-    error "\`${target_path}': no such file or directory."
-    exit 1
-fi

server/lib/bkctld-init

@@ -1,37 +0,0 @@
-#!/bin/sh
-#
-# Description: Initialize a new jail
-# Usage: init <jailname>
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-if [ -z "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-incs_path=$(incs_path "${jail_name}")
-
-test -d "${jail_path}" && error "Skip jail \`${jail_name}' : it already exists"
-
-# Create config, jails and incs directories
-mkdir --parents "${CONFDIR}" "${JAILDIR}" "${INCDIR}"
-
-if is_btrfs "$(dirname "${JAILDIR}")" || is_btrfs "${JAILDIR}"; then
-    btrfs_bin=$(command -v btrfs)
-    if [ -z "${btrfs_bin}" ]; then
-        error "btrfs not found. Please install btrfs-progs."
-    fi
-    ${btrfs_bin} subvolume create "${jail_path}"
-else
-    mkdir --parents "${jail_path}"
-fi
-
-mkdir --parents "${incs_path}"
-
-setup_jail_chroot "${jail_name}"
-setup_jail_config "${jail_name}"
-
-notice "Create jail \`${jail_name}' : OK"

server/lib/bkctld-ip

@@ -1,48 +0,0 @@
-#!/bin/sh
-#
-# Description: Set or get allowed(s) ip(s)
-# Usage: ip <jailname> [<ip>|all]
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-ip="${2:-}"
-
-if [ ! -n "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-
-test -d "${jail_path}" || error "${jail_name}: jail not found" 2
-
-jail_sshd_config="${jail_path}/${SSHD_CONFIG}"
-
-if [ -z "${ip}" ]; then
-    # parse IP addresses from AllowUsers directives in sshd config
-    grep -E "^AllowUsers" "${jail_sshd_config}" \
-    | grep -E -o "root@[^ ]+" \
-    | while read allow; do
-        echo "${allow}" | cut -d'@' -f2
-    done
-else
-    if [ "${ip}" = "all" ] || [ "${ip}" = "0.0.0.0/0" ]; then
-        new_ips="0.0.0.0/0"
-    else
-        existing_ips=$("${LIBDIR}/bkctld-ip" "${jail_name}")
-        new_ips=$(echo ${existing_ips} ${ip} | xargs -n1 | grep -v "0.0.0.0/0" | sort | uniq)
-    fi
-    allow_users="AllowUsers"
-    for new_ip in ${new_ips}; do
-        allow_users="${allow_users} root@${new_ip}"
-    done
-    if grep -q -E "^AllowUsers" "${jail_sshd_config}"; then
-        sed --follow-symlinks --in-place "s~^AllowUsers .*~${allow_users}~" "${jail_sshd_config}"
-    else
-        error "No \`AllowUsers' directive found in \`${jail_sshd_config}'"
-    fi
-    notice "Update IP whitelist with \`${ip}' for jail \`${jail_name}' : OK"
-    "${LIBDIR}/bkctld-reload" "${jail_name}"
-    "${LIBDIR}/bkctld-firewall" "${jail_name}"
-fi

server/lib/bkctld-is-on

@@ -1,32 +0,0 @@
-#!/bin/sh
-#
-# Description: Check if a SSH server is on (exit 0) or not (exit 100)
-# Usage: is-on <jailname>
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-
-if [ -z "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-
-test -d "${jail_path}" || error "${jail_name}: jail not found" 2
-
-jail_pid_file="${jail_path}/${SSHD_PID}"
-
-# Error codes are references in "includes" file
-return=100
-if [ -f "${jail_pid_file}" ]; then
-    pid=$(cat "${jail_pid_file}")
-    ps -p "${pid}" > /dev/null && return=0
-fi
-if [ "${return}" -gt 0 ]; then
-    rm -f "${jail_pid_file}"
-    grep -q "${jail_path}/proc" /proc/mounts && umount --lazy "${jail_path}/proc/"
-    grep -q "${jail_path}/dev" /proc/mounts && umount --lazy --recursive "${jail_path}/dev"
-fi
-exit "${return}"

server/lib/bkctld-key

@@ -1,29 +0,0 @@
-#!/bin/sh
-#
-# Description: Set or get ssh pubic key
-# Usage: key <jailname> [<keyfile>]
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-keyfile="${2:-}"
-
-if [ ! -n "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-
-test -d "${jail_path}" || error "${jail_name}: jail not found" 2
-
-if [ -z "${keyfile}" ]; then
-    if [ -f "${jail_path}/${AUTHORIZED_KEYS}" ]; then
-        cat "${jail_path}/${AUTHORIZED_KEYS}"
-    fi
-else
-    test -r "${keyfile}" || error "SSH key \`${keyfile}' for jail \`${jail_name}' is missing or is not readable."
-    cat "${keyfile}" > "${jail_path}/${AUTHORIZED_KEYS}"
-    chmod 600 "${jail_path}/${AUTHORIZED_KEYS}"
-    notice "Update SSH key \`${keyfile}' for jail \`${jail_name}' : OK"
-fi

server/lib/bkctld-list

@@ -1,13 +0,0 @@
-#!/bin/sh
-#
-# Description: List jails
-# Usage: list
-#
-
-set -eu
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-[ -d "${JAILDIR}" ] || exit 0
-jails_list

server/lib/bkctld-port

@@ -1,36 +0,0 @@
-#!/bin/sh
-#
-# Description: Set or get SSH port
-# Usage: port <jailname> [<port>|auto]
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-port="${2:-}"
-
-if [ ! -n "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-
-test -d "${jail_path}" || error "${jail_name}: jail not found" 2
-
-jail_sshd_config="${jail_path}/${SSHD_CONFIG}"
-
-if [ -z "${port}" ]; then
-    grep -E "Port [0-9]+" "${jail_sshd_config}"|grep -oE "[0-9]+"
-else
-    if [ "${port}" = "auto" ]; then
-        port=$(grep -h Port "${JAILDIR}"/*/"${SSHD_CONFIG}" 2>/dev/null | grep -Eo "[0-9]+" | sort -n | tail -1)
-        port=$((port+1))
-        [ "${port}" -le 1 ] && port=2222
-    fi
-    sed --follow-symlinks --in-place "s/^Port .*/Port ${port}/" "${jail_sshd_config}"
-
-    notice "Update SSH port \`${port}' for jail \`${jail_name}' : OK"
-
-    "${LIBDIR}/bkctld-reload" "${jail_name}"
-    "${LIBDIR}/bkctld-firewall" "${jail_name}"
-fi

server/lib/bkctld-reload

@@ -1,26 +0,0 @@
-#!/bin/sh
-#
-# Description: Reload SSH server
-# Usage: reload [<jailname>|all]
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-if [ -z "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-
-test -d "${jail_path}" || error "${jail_name}: jail not found" 2
-
-"${LIBDIR}/bkctld-is-on" "${jail_name}" || exit 0
-
-pid=$(cat "${jail_path}/${SSHD_PID}")
-
-if kill -HUP "${pid}"; then
-    notice "Reload jail \`${jail_name}' : OK [${pid}]"
-else
-    error "Reload jail \`${jail_name}' : failed [${pid}]"
-fi

server/lib/bkctld-remove

@@ -1,81 +0,0 @@
-#!/bin/sh
-#
-# Description: Remove jail and all dated copies (incs)
-# Usage: remove <jailname>|all
-# Return codes:
-# * 101 : jail removal aborted
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-if [ -z "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-incs_path=$(incs_path "${jail_name}")
-
-if ! test -d "${jail_path}"; then
-    if [ "${FORCE}" = "1" ]; then
-        warning "${jail_name}: jail not found (ignore in FORCE mode)"
-        exit 0
-    else
-        error "${jail_name}: jail not found" 2
-    fi
-fi
-
-if [ "${FORCE}" != "1" ]; then
-    answer=""
-    while :; do
-        printf "> Are you sure you want to delete jail \`%s'? [Y,n,?] " "${jail_name}"
-        read -r answer
-        case $answer in
-            [Yy]|"" )
-                break
-                ;;
-            [Nn] )
-                tty -s && echo "Abort." >&2
-                exit 101
-                ;;
-            * )
-                printf "y - yes, execute actions and exit\n"
-                printf "n - no, don't execute actions and exit\n"
-                printf "? - print this help\n"
-                ;;
-        esac
-    done
-fi
-
-"${LIBDIR}/bkctld-is-on" "${jail_name}" && "${LIBDIR}/bkctld-stop" "${jail_name}"
-
-test -f "${CONFDIR}/${jail_name}" && rm -f "${CONFDIR}/${jail_name}"
-rm -rf "$(jail_config_dir "${jail_name}")"
-
-btrfs_bin=$(command -v btrfs)
-if [ -z "${btrfs_bin}" ]; then
-    error "btrfs not found. Please install btrfs-progs."
-fi
-
-if is_btrfs "${jail_path}"; then
-    ${btrfs_bin} subvolume delete "${jail_path}" | debug
-else
-    rm -rf "${jail_path:?}" | debug
-fi
-
-# TODO: use functions here
-if [ -d "${incs_path}" ]; then
-    incs=$(ls "${incs_path}")
-    for inc in ${incs}; do
-        inc_inode=$(stat --format=%i "${incs_path}/${inc}")
-        if [ "${inc_inode}" -eq 256 ]; then
-            ${btrfs_bin} subvolume delete "${incs_path}/${inc}" | debug
-        else
-            warning "You need to purge \`${incs_path}/${inc}' manually"
-        fi
-    done
-    rmdir --ignore-fail-on-non-empty "${incs_path}" | debug
-fi
-
-"${LIBDIR}/bkctld-firewall" "${jail_name}"
-notice "Delete jail \`${jail_name}' : OK"

server/lib/bkctld-rename

@@ -1,83 +0,0 @@
-#!/bin/sh
-#
-# Description: Rename a jail
-# Usage: rename <jailname> <new-jailname> 
-# Return codes:
-# * 1: error
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-new_jail_name="${2:?}"
-if [ -z "${jail_name}" ] || [ -z "${new_jail_name}" ]; then
-    show_help && exit 1
-fi
-
-jail_path=$(jail_path "${jail_name}")
-incs_path=$(incs_path "${jail_name}")
-jail_config_dir=$(jail_config_dir "${jail_name}")
-legacy_config_file="${CONFDIR}/${jail_name}"
-
-test -d "${jail_path}" || error "${jail_name}: jail not found" 2
-
-new_jail_path=$(jail_path "${new_jail_name}")
-new_incs_path=$(incs_path "${new_jail_name}")
-new_jail_config_dir=$(jail_config_dir "${new_jail_name}")
-new_legacy_config_file="${CONFDIR}/${new_jail_name}"
-
-test -d "${new_jail_path}" && error "${new_jail_name}: jail already exists" 2
-test -d "${new_incs_path}" && error "${new_jail_name}: incs already exists" 2
-
-"${LIBDIR}/bkctld-is-on" "${jail_name}" 2>/dev/null
-case "$?" in
-    0)
-        jail_initial_status="on"
-    ;;
-    100)
-        jail_initial_status="off"
-    ;;
-    *)
-        unset jail_initial_status
-        error "Error evaluating jail \`${jail_name}' state. bkctld-is-on exited with \`$?'"
-    ;;
-esac
-
-test "${jail_initial_status}" = "on" && "${LIBDIR}/bkctld-stop" "${jail_name}"
-
-if dry_run; then
-    echo "[dry-run] rename ${jail_path} to ${new_jail_path}"
-else
-    mv "${jail_path}" "${new_jail_path}"
-fi
-
-if [ -d "${incs_path}" ]; then
-    if dry_run; then
-        echo "[dry-run] rename ${incs_path} to ${new_incs_path}"
-    else
-        mv "${incs_path}" "${new_incs_path}"
-    fi
-fi
-
-if [ -d "${jail_config_dir}" ]; then
-    if dry_run; then
-        echo "[dry-run] rename ${jail_config_dir} to ${new_jail_config_dir}"
-    else
-        mv "${jail_config_dir}" "${new_jail_config_dir}"
-    fi
-fi
-if [ -f "${legacy_config_file}" ]; then
-    if dry_run; then
-        mv "${legacy_config_file}" "${new_legacy_config_file}"
-    else
-        echo "[dry-run] rename ${legacy_config_file} to ${new_legacy_config_file}"
-    fi
-fi
-# Reset firewall for new jail name
-"${LIBDIR}/bkctld-firewall" "${jail_name}"
-"${LIBDIR}/bkctld-firewall" "${new_jail_name}"
-
-test "${jail_initial_status}" = "on" && "${LIBDIR}/bkctld-start" "${new_jail_name}"
-
-notice "Rename jail \`${jail_name}' to \`${new_jail_name}' : OK"

server/lib/bkctld-restart

@@ -1,21 +0,0 @@
-#!/bin/sh
-#
-# Description: Restart SSH server
-# Usage: restart [<jailname>|all]
-#
-
-set -eu
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-if [ -z "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-
-test -d "${jail_path}" || error "${jail_name}: jail not found" 2
-
-"${LIBDIR}/bkctld-is-on" "${jail_name}" && "${LIBDIR}/bkctld-stop" "${jail_name}"
-"${LIBDIR}/bkctld-start" "${jail_name}"

server/lib/bkctld-rm

@@ -1,160 +0,0 @@
-#!/bin/sh
-#
-# Description: Remove old dated copies (incs) according to policy
-# Usage: rm
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-kill_or_clean_lockfile() {
-    lock_file=${1:-}
-
-    if [ -f "${lock_file}" ]; then
-        # Get Process ID from the lock file
-        pid=$(cat "${lock_file}")
-        if [ -n "${pid}" ]; then
-            if kill -0 "${pid}" 2> /dev/null; then
-                # Kill the children
-                pkill -9 --parent "${pid}"
-                # Kill the parent
-                kill -9 "${pid}"
-                #  Only one bkctld-rm can run in parallel, the latest wins
-                lockfile_date=$(date --date "@$(stat -c %Y ${lock_file})" +"%Y-%m-%d %H:%M:%S")
-                warning "Process \`${pid}' (started at ${lockfile_date}) has been killed by \`$$'"
-            else
-                warning "Process not found at PID \`${pid}'. Ignoring lock file \`${lock_file}'."
-            fi
-        else
-            warning "Empty lockfile \`${lock_file}'. It should contain a PID."
-        fi
-        # Remove the lock file
-        rm -f ${lock_file}
-    fi
-}
-incs_to_delete() {
-    jail_name=${1:?}
-    incs_policy_file=${2:?}
-
-    incs_policy_keep_file=$(new_tmp_file "${jail_name}.incs_policy_keep")
-    incs_list_file=$(new_tmp_file "${jail_name}.incs_list")
-
-    # loop for each line in jail configuration
-    for incs_policy_line in $(grep "^\+" ${incs_policy_file}); do
-        # inc date in ISO format
-        incs_policy_date=$(relative_date ${incs_policy_line})
-        echo ${incs_policy_date} >> "${incs_policy_keep_file}"
-    done
-    for inc_name in $(incs_list "${jail_name}"); do
-        echo "${inc_name}" >> ${incs_list_file}
-    done
-
-    # shellcheck disable=SC2046
-    incs_to_delete=$(grep -v -f "${incs_policy_keep_file}" "${incs_list_file}")
-
-    rm -f "${incs_policy_keep_file}" "${incs_list_file}"
-
-    echo ${incs_to_delete}
-}
-delete_inc_btrfs() {
-    jail_name=$1
-    inc_name=$2
-
-    inc_path=$(inc_path "${jail_name}" "${inc_name}")
-    btrfs_bin=$(command -v btrfs)
-
-    if [ -z "${btrfs_bin}" ]; then
-        error "btrfs not found. Please install btrfs-progs."
-    fi
-
-    if dry_run; then
-        echo "[dry-run] delete btrfs subvolume ${inc_path}"
-    else
-        ${btrfs_bin} subvolume delete "${inc_path}" | debug
-    fi
-}
-delete_inc_ext4() {
-    jail_name=$1
-    inc_name=$2
-
-    inc_path=$(inc_path "${jail_name}" "${inc_name}")
-
-    if dry_run; then
-        echo "[dry-run] delete ${inc_path} with rsync from empty directory"
-    else
-        empty=$(new_tmp_dir "empty")
-        rsync --archive --delete "${empty}/" "${inc_path}/"
-        rmdir "${inc_path}/"
-        rmdir "${empty}"
-    fi
-
-}
-delete_empty_inc() {
-    jail_name=$1
-
-    incs_path=$(incs_path "${jail_name}")
-    empty_incs_list=$(find "${incs_path}" -mindepth 0 -maxdepth 0 -type d -empty)
-
-    for empty_inc in ${empty_incs_list}; do
-        if dry_run; then
-            echo "[dry-run] Delete empty \`${empty_inc}'"
-        else
-            rmdir "${empty_inc}"
-            notice "Delete empty \`${empty_inc}' : OK"
-        fi
-    done
-}
-
-lock_file="${LOCKDIR}/rm-global.lock"
-# shellcheck disable=SC2064
-trap "rm -f ${lock_file}; cleanup_tmp;" 0
-
-kill_or_clean_lockfile "${lock_file}"
-new_lock_file "${lock_file}"
-
-# We list jails in "incs" directory, not in "jails" directory
-# so we can clean old incs after a jail is archived
-jails_list=$(jails_with_incs_list)
-jails_total=$(echo $jails_list | wc -w)
-jails_count=0
-
-for jail_name in ${jails_list}; do
-    jails_count=$((jails_count+1))
-    incs_policy_file=$(current_jail_incs_policy_file ${jail_name})
-    # If no incs policy is found, we don't remove incs
-    if [ -n "${incs_policy_file}" ]; then
-        # shellcheck disable=SC2046
-        incs_to_delete=$(incs_to_delete "${jail_name}" "${incs_policy_file}")
-        incs_total=$(echo ${incs_to_delete} | wc -w)
-        incs_count=0
-
-        if [ -n "${incs_to_delete}" ]; then
-            debug "Incs to be deleted for \`${jail_name}' : $(echo "${incs_to_delete}" | tr '\n', ',' | sed 's/,$//')."
-            for inc_name in ${incs_to_delete}; do
-                incs_count=$((incs_count+1))
-                info "Progress: jail ${jails_count} out of ${jails_total} - inc ${incs_count} out of ${incs_total}"
-                notice "Delete inc \`${inc_name}' for jail \`${jail_name}' : start"
-
-                inc_path=$(inc_path "${jail_name}" "${inc_name}")
-
-                if is_btrfs "${inc_path}"; then
-                    delete_inc_btrfs "${jail_name}" "${inc_name}"
-                else
-                    delete_inc_ext4 "${jail_name}" "${inc_name}"
-                fi
-
-                notice "Delete inc \`${inc_name}' for jail \`${jail_name}' : finish"
-            done
-        else
-            notice "Skip jail \`${jail_name}' : no inc to delete"
-        fi
-    else
-        notice "Skip jail \`${jail_name}' : incs policy is missing"
-    fi
-    # Delete empty incs directory for jail
-    delete_empty_inc "${jail_name}"
-done
-
-# Remove the lock file and cleanup tmp files
-rm -f "${lock_file}"
-cleanup_tmp

server/lib/bkctld-start

@@ -1,43 +0,0 @@
-#!/bin/sh
-#
-# Description: Start SSH Server
-# Usage: start <jailname>|all
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-if [ -z "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-
-test -d "${jail_path}" || error "${jail_name}: jail not found" 2
-
-"${LIBDIR}/bkctld-is-on" "${jail_name}" && exit 0
-
-# Prepare the chroot
-mount_jail_fs "${jail_name}"
-
-# Start SSH in the chroot
-chroot "${jail_path}" /usr/sbin/sshd -E /var/log/authlog || error "Failed to start SSH for jail \`${jail_name}'"
-pidfile="${jail_path}/${SSHD_PID}"
-
-# Wait for SSH to be up
-# shellcheck disable=SC2034
-for try in $(seq 1 10); do
-    if [ -f "${pidfile}" ]; then
-        pid=$(cat "${pidfile}")
-        break
-    else
-        pid=""
-        sleep 0.3
-    fi
-done
-
-if [ -n "${pid}" ]; then
-    notice "Start jail \`${jail_name}' : OK [${pid}]"
-else
-    error "Failed to fetch SSH PID for jail \`${jail_name}' within 3 seconds"
-fi

server/lib/bkctld-stats

@@ -1,53 +0,0 @@
-#!/bin/sh
-#
-# Description: Display stats on jails (size, last connection…)
-# Usage: stats
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-mkdir -p "${INDEX_DIR}"
-
-lsof "${IDX_FILE}" >/dev/null 2>&1 || nohup sh -s -- <<EOF >/dev/null 2>&1 &
-
-ionice -c3 "${DUC}" index -d "${IDX_FILE}" "${JAILDIR}"
-touch "${INDEX_DIR}/.lastrun.duc"
-EOF
-
-[ ! -f "${INDEX_DIR}/.lastrun.duc" ] && notice "First run of DUC still in progress ..." && exit 0
-[ ! -f ${IDX_FILE} ] && error "Index file doesn't exits !"
-
-printf "Last update of index file : "
-stat --format=%Y "${INDEX_DIR}/.lastrun.duc" | xargs -i -n1 date -R -d "@{}"
-
-duc_output=$(mktemp)
-stat_output=$(mktemp)
-incs_output=$(mktemp)
-jail_patterns_list=$(mktemp)
-
-# shellcheck disable=SC2064
-trap "rm ${duc_output} ${incs_output} ${stat_output} ${jail_patterns_list}" 0
-
-"${DUC}" ls --database "${IDX_FILE}" "${JAILDIR}" > "${duc_output}"
-
-jails_list | sed -e "s/^\(.*\)$/\\\\b\1\\\\b/" > "${jail_patterns_list}"
-
-grep -f "${jail_patterns_list}" "${duc_output}" | awk '{ print $2 }' | while read jail_name; do
-    jail_path=$(jail_path "${jail_name}")
-    stat --format=%Y "${jail_path}/var/log/lastlog" | xargs -i -n1 date -d "@{}" "+%d-%m-%Y" >> "${stat_output}"
-
-    incs_policy_file=$(current_jail_incs_policy_file "${jail_name}")
-    incs_policy="0"
-    if [ -r "${incs_policy_file}" ]; then
-        days=$(grep "^\+" "${incs_policy_file}" | grep --count "day")
-        months=$(grep "^\+" "${incs_policy_file}" | grep --count "month")
-        incs_policy="${days}/${months}"
-    fi
-    echo "${incs_policy}" >> "${incs_output}"
-done
-
-(
-    echo "<jail> <size> <incs> <lastconn>"
-    paste "${duc_output}" "${incs_output}" "${stat_output}" | awk '{ printf("%s %s %s %s\n", $2, $1, $3, $4); }'
-) | column -t

server/lib/bkctld-status

@@ -1,30 +0,0 @@
-#!/bin/sh
-#
-# Description: Display status of SSH server
-# Usage: [--no-header] status [<jailname>|all]
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-if [ ! -n "${jail_name}" ]; then
-    show_help && exit 1
-fi
-[ -d "${JAILDIR}/${jail_name}" ] || error "${jail_name} : jail is missing.\nUse '$0 status [all]' to get the status of all jails."
-
-incs_policy_file=$(current_jail_incs_policy_file ${jail_name})
-incs_policy="0"
-if [ -r "${incs_policy_file}" ]; then
-    days=$(grep "^\+" "${incs_policy_file}" | grep --count "day")
-    months=$(grep "^\+" "${incs_policy_file}" | grep --count "month")
-    incs_policy="${days}/${months}"
-fi
-
-status="OFF"
-"${LIBDIR}/bkctld-is-on" "${jail_name}" && status="ON "
-
-port=$("${LIBDIR}/bkctld-port" "${jail_name}")
-ip=$("${LIBDIR}/bkctld-ip" "${jail_name}" | xargs | tr -s ' ' ',')
-
-echo "${jail_name} ${status} ${port} ${incs_policy} ${ip}" | awk '{ printf("%- 30s %- 10s %- 10s %- 25s %- 20s\n", $1, $2, $3, $4, $5); }'

server/lib/bkctld-stop

@@ -1,31 +0,0 @@
-#!/bin/sh
-#
-# Description: Stop SSH server
-# Usage: stop [<jailname>|all]
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-if [ -z "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-
-test -d "${jail_path}" || error "${jail_name}: jail not found" 2
-
-"${LIBDIR}/bkctld-is-on" "${jail_name}" || exit 0
-
-pid=$(cat "${jail_path}/${SSHD_PID}")
-
-pkill --parent "${pid}"
-
-if kill "${pid}"; then
-    notice "Stop jail \`${jail_name}' : OK [${pid}]"
-
-    umount --lazy --recursive "${jail_path}/dev"
-    umount --lazy "${jail_path}/proc/"
-else
-    error "Stop jail \`${jail_name}' : failed [${pid}]"
-fi

server/lib/bkctld-sync

@@ -1,67 +0,0 @@
-#!/bin/sh
-#
-# Description: Sync jail configuration and state on other node(s)
-# Usage: sync [<jailname>|all]
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-if [ -z "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-jail_config_dir=$(jail_config_dir "${jail_name}")
-
-test -d "${jail_path}" || error "${jail_name}: jail not found" 2
-
-[ -n "${NODE}" ] || error "Sync need config of \$NODE in /etc/default/bkctld !"
-
-ssh "${NODE}" "${LIBDIR}/bkctld-is-on ${jail_name} 2>/dev/null"
-# return code 2 is for "missing jail" error
-if [ "$?" -eq 2 ]; then
-    # Init jail on remote server
-    ssh "${NODE}" "${LIBDIR}/bkctld-init ${jail_name}" | debug
-fi
-
-# Sync jail structure and configuration on remote server
-rsync -a "${jail_path}/" "${NODE}:${jail_path}/" --exclude proc/* --exclude sys/* --exclude dev/* --exclude run --exclude var/backup/*
-# Sync config (new structure)
-if [ -d "${jail_config_dir}" ]; then
-    rsync -a --delete "${jail_config_dir}/" "${NODE}:${jail_config_dir}/"
-else
-    ssh "${NODE}" "rm -rf ${jail_config_dir}" | debug
-fi
-# Sync config (legacy structure)
-if [ -e "${CONFDIR}/${jail_name}" ]; then
-    rsync -a "${CONFDIR}/${jail_name}" "${NODE}:${CONFDIR}/${jail_name}"
-else
-    ssh "${NODE}" "rm -f ${CONFDIR}/${jail_name}" | debug
-fi
-
-if [ -n "${FIREWALL_RULES}" ]; then
-    ssh "${NODE}" "${LIBDIR}/bkctld-firewall ${jail_name}" | debug
-    ssh "${NODE}" "test -x /etc/init.d/minifirewall && /etc/init.d/minifirewall restart" | debug
-fi
-
-# Sync state on remote server
-if "${LIBDIR}/bkctld-is-on" "${jail_name}"; then
-    # fetch state of remote jail
-    ssh "${NODE}" "${LIBDIR}/bkctld-is-on ${jail_name} 2>/dev/null"
-    case "$?" in
-        0)
-            # jail is already running : reload it
-            ssh "${NODE}" "${LIBDIR}/bkctld-reload ${jail_name}" | debug
-        ;;
-        100)
-            # jail is stopped : start it
-            ssh "${NODE}" "${LIBDIR}/bkctld-start ${jail_name}" | debug
-        ;;
-        *)
-            error "Error evaluating jail \`${jail_name}' state. bkctld-is-on exited with \`$?'"
-        ;;
-    esac
-else
-    ssh "${NODE}" "${LIBDIR}/bkctld-stop ${jail_name}" | debug
-fi

server/lib/bkctld-update

@@ -1,38 +0,0 @@
-#!/bin/sh
-#
-# Description: Update binaries and libraries
-# Usage: update [<jailname>|all]
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-if [ ! -n "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-
-test -d "${jail_path}" || error "${jail_name}: jail not found" 2
-
-"${LIBDIR}/bkctld-is-on" "${jail_name}" 2>/dev/null
-case "$?" in
-    0)
-        jail_initial_status="on"
-    ;;
-    100)
-        jail_initial_status="off"
-    ;;
-    *)
-        unset jail_initial_status
-        error "Error evaluating jail \`${jail_name}' state. bkctld-is-on exited with \`$?'"
-    ;;
-esac
-
-test "${jail_initial_status}" = "on" && "${LIBDIR}/bkctld-stop" "${jail_name}"
-
-setup_jail_chroot "${jail_name}"
-
-test "${jail_initial_status}" = "on" && "${LIBDIR}/bkctld-start" "${jail_name}"
-
-notice "Update jail \`${jail_name}' : OK"

server/lib/bkctld-upgrade-config

@@ -1,68 +0,0 @@
-#!/bin/sh
-#
-# Description: Upgrade configuration to new convention
-# Usage: upgrade-config [<jailname>|all]
-#
-
-# shellcheck source=./includes
-LIBDIR="$(dirname $0)" && . "${LIBDIR}/includes"
-
-jail_name="${1:?}"
-if [ ! -n "${jail_name}" ]; then
-    show_help && exit 1
-fi
-jail_path=$(jail_path "${jail_name}")
-
-test -d "${jail_path}" || error "${jail_name}: jail not found" 2
-
-legacy_incs_policy_file="${CONFDIR}/${jail_name}"
-incs_policy_file=$(jail_incs_policy_file "${jail_name}")
-
-if [ -h "${legacy_incs_policy_file}" ]; then
-    if [ -f "${incs_policy_file}" ]; then
-        info "${jail_name}: config is already upgraded"
-    else
-        warning "${jail_name}: symlink present but inc policy file \`${incs_policy_file}' not found"
-    fi
-elif [ ! -e "${legacy_incs_policy_file}" ] ; then
-    if [ -f "${incs_policy_file}" ]; then
-        # create a symlink for backward compatibility
-        ln -s "${incs_policy_file}" "${legacy_incs_policy_file}"
-
-        info "${jail_name}: config has been symlinked"
-    else
-        warning "${jail_name}: inc policy file \`${incs_policy_file}' not found"
-    fi
-elif [ -f "${legacy_incs_policy_file}" ]; then
-    # Create directory if missing
-    mkdir -p "$(jail_config_dir "${jail_name}")"
-    # move the main config file
-    mv "${legacy_incs_policy_file}" "${incs_policy_file}"
-    # create a symlink for backward compatibility
-    ln -s "${incs_policy_file}" "${legacy_incs_policy_file}"
-    # create a check_policy file if missing
-    touch "$(jail_check_policy_file "${jail_name}")"
-
-    info "${jail_name}: config has been upgraded"
-fi
-
-check_policy_file=$(jail_check_policy_file "${jail_name}")
-if [ ! -f "${check_policy_file}" ]; then
-    check_policy_tpl="${TPLDIR}/check_policy.tpl"
-    test -f "${LOCALTPLDIR}/check_policy.tpl" && check_policy_tpl="${LOCALTPLDIR}/check_policy.tpl"
-    mkdir --parents "$(dirname "${check_policy_file}")"
-    install -m 0640 "${check_policy_tpl}" "${check_policy_file}"
-
-    info "${jail_name}: check_policy template ha been installed"
-fi
-
-legacy_incs_policy_tpl="${LOCALTPLDIR}/inc.tpl"
-incs_policy_tpl="${LOCALTPLDIR}/incs_policy.tpl"
-if [ -f "${legacy_incs_policy_tpl}" ]; then
-    # Create directory if missing
-    mkdir -p "$(jail_config_dir "${jail_name}")"
-    # move the main config file
-    mv -f "${legacy_incs_policy_tpl}" "${incs_policy_tpl}"
-
-    info "${jail_name}: incs_policy local template has been renamed"
-fi

server/lib/includes

@@ -1,467 +0,0 @@
-#!/bin/sh
-#
-# Config for bkctld
-#
-# shellcheck disable=SC2034
-
-[ -f /etc/default/bkctld ] && . /etc/default/bkctld
-
-VERSION="22.11"
-
-LIBDIR=${LIBDIR:-/usr/lib/bkctld}
-CONFDIR="${CONFDIR:-/etc/evobackup}"
-BACKUP_DISK="${BACKUP_DISK:-}"
-BACKUP_PARTITION="${BACKUP_PARTITION:-/backup}"
-JAILDIR="${JAILDIR:-${BACKUP_PARTITION}/jails}"
-INCDIR="${INCDIR:-${BACKUP_PARTITION}/incs}"
-TPLDIR="${TPLDIR:-/usr/share/bkctld}"
-LOCALTPLDIR="${LOCALTPLDIR:-/usr/local/share/bkctld}"
-LOCKDIR="${LOCKDIR:-/run/lock/bkctld}"
-ARCHIVESDIR="${ARCHIVESDIR:-${BACKUP_PARTITION}/archives}"
-INDEX_DIR="${INDEX_DIR:-${BACKUP_PARTITION}/index}"
-IDX_FILE="${IDX_FILE:-${INDEX_DIR}/bkctld-jails.idx}"
-CANARY_RELATIVE_FILE="${CANARY_RELATIVE_FILE:-/zzz_evobackup_canary}"
-SSHD_PID="${SSHD_PID:-/run/sshd.pid}"
-SSHD_CONFIG="${SSHD_CONFIG:-/etc/ssh/sshd_config}"
-AUTHORIZED_KEYS="${AUTHORIZED_KEYS:-/root/.ssh/authorized_keys}"
-FIREWALL_RULES="${FIREWALL_RULES:-}"
-LOGLEVEL="${LOGLEVEL:-6}"
-CRITICAL="${CRITICAL:-48}"
-WARNING="${WARNING:-24}"
-DUC=$(command -v duc-nox || command -v duc)
-FORCE="${FORCE:-0}"
-HEADER="${HEADER:-1}"
-
-show_version() {
-    cat <<END
-bkctld version ${VERSION}
-
-Copyright 2004-2022 Evolix <info@evolix.fr>,
-                    Victor Laborie <vlaborie@evolix.fr>,
-                    Jérémy Lecour <jlecour@evolix.fr>
-                    and others.
-
-bkctld comes with ABSOLUTELY NO WARRANTY.  This is free software,
-and you are welcome to redistribute it under certain conditions.
-See the GNU Affero General Public License v3.0 for details.
-END
-}
-show_help() {
-    cat <<EOF
-Usage: bkctld [options] <subcommand> [arguments]
-Options
-    -h|--help|-?     Display help
-    -V|--version     Display version, authors and license
-Subcommands:
-EOF
-
-    for filename in ${LIBDIR}/bkctld-*; do
-        desc=$(grep -E "^# Description:" "${filename}"|sed "s/^# Description: //")
-        usage=$(grep -E "^# Usage:" "${filename}"|sed "s/^# Usage: //")
-        printf "    %- 32s %s\n" "${usage}" "${desc}"
-    done
-
-    printf "\n"
-}
-
-is_quiet() {
-    test ${QUIET} -eq 1
-}
-is_verbose() {
-    test ${VERBOSE} -eq 1
-}
-
-log_date() {
-    echo "[$(date +"%Y-%m-%d %H:%M:%S")]"
-}
-process_name() {
-    basename $0
-}
-debug() {
-    msg="${1:-$(cat /dev/stdin)}"
-    if [ "${LOGLEVEL}" -ge 7 ]; then
-        echo "${msg}"
-        logger -t bkctld -p daemon.debug "$(process_name) ${msg}"
-    fi
-}
-
-info() {
-    msg="${1:-$(cat /dev/stdin)}"
-    if [ "${LOGLEVEL}" -ge 6 ]; then
-        tty -s && echo "${msg}"
-        logger -t bkctld -p daemon.info "$(process_name) ${msg}"
-    fi
-}
-
-notice() {
-    msg="${1:-$(cat /dev/stdin)}"
-    tty -s && echo "${msg}"
-    [ "${LOGLEVEL}" -ge 5 ] && logger -t bkctld -p daemon.notice "$(process_name) ${msg}"
-}
-
-warning() {
-    msg="${1:-$(cat /dev/stdin)}"
-    tty -s && echo "${msg}" >&2
-    if [ "${LOGLEVEL}" -ge 4 ]; then
-        tty -s || echo "${msg}" >&2
-        logger -t bkctld -p daemon.warning "$(process_name) ${msg}"
-    fi
-}
-# Return codes
-# 1 : generic error
-# 2 : jail not found
-# > 100 : subcommands specific errors
-error() {
-    msg="${1:-$(cat /dev/stdin)}"
-    rc="${2:-1}"
-    tty -s && echo "${msg}" >&2
-    if [ "${LOGLEVEL}" -ge 5 ]; then
-        tty -s || echo "${msg}" >&2
-        logger -t bkctld -p daemon.error "$(process_name) ${msg}"
-    fi
-    exit ${rc}
-}
-
-dry_run() {
-    test "$DRY_RUN" = "1"
-}
-
-current_time() {
-    date +"%H:%M:%S"
-}
-
-# Returns true if the given path is on a btrfs filesystem
-is_btrfs() {
-    path=$1
-
-    inode=$(stat --format=%i "${path}")
-
-    test "$inode" -eq 256
-}
-
-# Returns the list of jails found in the "jails" directory (default)
-jails_list() {
-    # TODO: try if this command works the same :
-    # find "${JAILDIR}" -mindepth 1 -maxdepth 1 -type d -printf '%f\n'
-    find "${JAILDIR}" -mindepth 1 -maxdepth 1 -type d | sed 's!.*/!!' | sort -h
-}
-# Returns the list of jails found in the "incs" directory
-jails_with_incs_list() {
-    find "${INCDIR}" -mindepth 1 -maxdepth 1 -type d | sed 's!.*/!!' | sort -h
-}
-# Returns the complete path of a jail
-jail_path() {
-    jail_name=${1:?}
-
-    echo "${JAILDIR}/${jail_name}"
-}
-jail_config_dir() {
-    jail_name=${1:?}
-
-    echo "${CONFDIR}/${jail_name}.d"
-}
-jail_incs_policy_file() {
-    jail_name=${1:?}
-
-    jail_config_dir=$(jail_config_dir "${jail_name}")
-
-    echo "${jail_config_dir}/incs_policy"
-}
-# Returns the complete path of an archived jail
-archive_path() {
-    jail_name=${1:?}
-
-    echo "${ARCHIVESDIR}/${jail_name}"
-}
-# Returns the path of incs for a jail
-incs_path() {
-    jail_name=${1:?}
-
-    echo "${INCDIR}/${jail_name}"
-}
-# Returns the path of a specific inc for a jail
-inc_path() {
-    jail_name=${1:?}
-    inc_name=${2:?}
-
-    echo "${INCDIR}/${jail_name}/${inc_name}"
-}
-# Test the existence of an inc pattern for a jail
-inc_exists() {
-    jail_name=${1-?}
-    inc_pattern=${2-?}
-    inc_path=$(inc_path "${jail_name}" "${inc_pattern}")
-
-    # inc_path must not be quoted because it can contain globs
-    ls -d ${inc_path} > /dev/null 2>&1
-}
-# Returns the list of all incs for a jail
-incs_list() {
-    jail_name=${1:?}
-    find "$(incs_path "${jail_name}")" -mindepth 1 -maxdepth 1 -type d | sed 's!.*/!!' | sort -h
-}
-# Return the list of empty incs directories
-empty_incs_list() {
-    find ${INCDIR} -mindepth 1 -maxdepth 1 -type d -empty
-}
-current_jail_incs_policy_file() {
-    jail_name=${1:?}
-
-    new_file="$(jail_incs_policy_file "${jail_name}")"
-    old_file="${CONFDIR}/${jail_name}"
-
-    if [ -f "${new_file}" ]; then
-        echo "${new_file}"
-    elif [ -f "${old_file}" ]; then
-        echo "${old_file}"
-    else
-        echo ""
-    fi
-}
-jail_check_policy_file() {
-    jail_name=${1:?}
-
-    jail_config_dir=$(jail_config_dir "${jail_name}")
-
-    echo "${jail_config_dir}/check_policy"
-}
-current_jail_check_policy_file() {
-    jail_name=${1:?}
-
-    new_file="$(jail_check_policy_file "${jail_name}")"
-    # old_file="${JAILDIR}/${jail_name}/etc/bkctld-check"
-
-    if [ -f "${new_file}" ]; then
-        echo "${new_file}"
-    # elif [ -f "${old_file}" ]; then
-    #     echo "${old_file}"
-    else
-        echo ""
-    fi
-}
-# relative_date "+%Y-%m-%d.-2day"
-relative_date() {
-    format=$(echo $1 | cut -d'.' -f1)
-    time_jump=$(echo $1 | cut -d'.' -f2)
-
-    reference_date=$(date "${format}")
-    past_date=$(date --date "${reference_date} ${time_jump}" +"%Y-%m-%d")
-
-    echo ${past_date}
-}
-new_tmp_file() {
-    name=${1:-}
-
-    mktemp --tmpdir "bkctld.${$}.${name}.XXXXX"
-}
-new_tmp_dir() {
-    name=${1:-}
-
-    mktemp --directory --tmpdir "bkctld.${$}.${name}.XXXXX"
-}
-cleanup_tmp() {
-    find "${TMPDIR:-/tmp}" -name "bkctld.${$}.*" -delete
-}
-new_lock_file() {
-    lock_file=${1:-}
-    lock_dir=$(dirname "${lock_file}")
-
-    mkdir --parents "${lock_dir}" && echo $$ > ${lock_file} || error "Failed to acquire lock file '${lock_file}'"
-}
-
-pkg_version() {
-    # $(command -v ssh) -V 2>&1 | grep -iEo 'OpenSSH_(\S+)' | cut -d '_' -f2
-    dpkg-query -W -f='${Version}\n' $1 \
-    | sed 's/[~+-].\+//' \
-    | sed 's/.\+://' \
-    | sed 's/p.*//' \
-    | cut -d. -f1,2
-}
-ssh_keygen_with_prefix() {
-    # openssh-client 7.9 provides ssh-keygen with "-f prefix_path" option
-    dpkg --compare-versions "$(pkg_version 'openssh-client')" ge "7.9"
-}
-
-setup_jail_chroot() {
-    jail_name=${1:?}
-
-    jail_path=$(jail_path "${jail_name}")
-
-    passwd="${TPLDIR}/passwd"
-    shadow="${TPLDIR}/shadow"
-    group="${TPLDIR}/group"
-    sshrc="${TPLDIR}/sshrc"
-    [ -f "${LOCALTPLDIR}/passwd" ] && passwd="${LOCALTPLDIR}/passwd"
-    [ -f "${LOCALTPLDIR}/shadow" ] && shadow="${LOCALTPLDIR}/shadow"
-    [ -f "${LOCALTPLDIR}/group" ] && group="${LOCALTPLDIR}/group"
-    [ -f "${LOCALTPLDIR}/sshrc" ] && group="${LOCALTPLDIR}/sshrc"
-
-    cd "${jail_path}" || error "${jail_name}: failed to change directory to ${jail_path}."
-    umask 077
-
-    info "1 - Creating the chroot"
-
-    rm -rf ./bin
-    rm -rf ./lib
-    rm -rf ./lib64
-    rm -rf ./run
-    rm -rf ./usr
-    rm -rf ./var/run
-    # Let's not delete the existing SSH host keys,
-    # otherwise the clients will have to accept the new keys
-
-    mkdir -p ./dev
-    mkdir -p ./proc
-    mkdir -p ./usr/bin
-    mkdir -p ./usr/sbin
-    mkdir -p ./usr/lib
-    mkdir -p ./usr/lib/x86_64-linux-gnu
-    mkdir -p ./usr/lib/openssh
-    mkdir -p ./usr/lib64
-    mkdir -p ./etc/ssh
-    mkdir -p ./var/log
-    mkdir -p ./run/sshd
-    # shellcheck disable=SC2174
-    mkdir -p ./root/.ssh --mode 0700
-    # shellcheck disable=SC2174
-    mkdir -p ./var/backup --mode 0700
-
-    ln -s ./usr/bin ./bin
-    ln -s ./usr/lib ./lib
-    ln -s ./usr/lib64 ./lib64
-    ln -s --target-directory=./var ../run
-
-    touch ./var/log/lastlog ./var/log/wtmp ./run/utmp
-
-    info "2 - Copying essential files"
-
-    #
-    if ssh_keygen_with_prefix; then
-        # Generate SSH host keys if missing in jail
-        ssh-keygen -A -f "${jail_path}"
-    else
-        # Copy SSH host keys from host if missing in jail
-        for key in /etc/ssh/*_key; do
-            cp --no-clobber ${key} ${jail_path}${key};
-        done
-    fi
-
-    touch "./${AUTHORIZED_KEYS}"
-    chmod 600 "./${AUTHORIZED_KEYS}"
-
-    cp "${passwd}" ./etc
-    cp "${shadow}" ./etc
-    cp "${group}" ./etc
-    cp "${sshrc}" ./etc/ssh
-
-    info "3 - Copying binaries"
-    cp -f /lib/ld-linux.so.2 ./lib 2>/dev/null || cp -f /lib64/ld-linux-x86-64.so.2 ./lib64
-    cp /lib/x86_64-linux-gnu/libnss* ./lib/x86_64-linux-gnu
-
-    for dbin in \
-        /bin/sh \
-        /bin/ls \
-        /bin/mkdir \
-        /bin/cat \
-        /bin/rm \
-        /bin/sed \
-        /usr/bin/rsync \
-        /usr/bin/lastlog \
-        /usr/bin/touch \
-        /usr/sbin/sshd \
-        /usr/lib/openssh/sftp-server\
-        ; do
-        cp -f "${dbin}" "./${dbin}";
-        for lib in $(ldd "${dbin}" | grep -Eo "/.*so.[0-9\.]+"); do
-            cp -p "${lib}" "./${lib}"
-        done
-    done
-}
-
-setup_jail_config() {
-    jail_name=${1:?}
-
-    jail_path=$(jail_path "${jail_name}")
-    jail_sshd_config="${jail_path}/${SSHD_CONFIG}"
-
-    sshd_config_tpl="${TPLDIR}/sshd_config"
-    test -f "${LOCALTPLDIR}/sshd_config" && sshd_config_tpl="${LOCALTPLDIR}/sshd_config"
-
-    info "4 - Copie default sshd_config"
-    install -m 0640 "${sshd_config_tpl}" "${jail_sshd_config}"
-
-
-    info "5 - Copie default inc configuration"
-    incs_policy_tpl="${TPLDIR}/incs_policy.tpl"
-    test -f "${LOCALTPLDIR}/incs_policy.tpl" && incs_policy_tpl="${LOCALTPLDIR}/incs_policy.tpl"
-    jail_incs_policy_file=$(jail_incs_policy_file "${jail_name}")
-    mkdir --parents "$(dirname "${jail_incs_policy_file}")"
-    install -m 0640 "${incs_policy_tpl}" "${jail_incs_policy_file}"
-
-    check_policy_tpl="${TPLDIR}/check_policy.tpl"
-    test -f "${LOCALTPLDIR}/check_policy.tpl" && check_policy_tpl="${LOCALTPLDIR}/check_policy.tpl"
-    jail_check_policy_file=$(jail_check_policy_file "${jail_name}")
-    mkdir --parents "$(dirname "${jail_check_policy_file}")"
-    install -m 0640 "${check_policy_tpl}" "${jail_check_policy_file}"
-
-    "${LIBDIR}/bkctld-port" "${jail_name}" auto
-}
-
-is_mounted_inside_jail() {
-    target=${1:?}
-
-    # TODO: try to find why it doesn't work with this findmnt(8) command
-    # findmnt --target "${target}" --tab-file /proc/mounts
-    grep -q "${target}" /proc/mounts
-}
-
-mount_jail_fs() {
-    jail_name=${1:?}
-
-    jail_path=$(jail_path "${jail_name}")
-
-    is_mounted_inside_jail "${jail_path}/dev" || mount -nt tmpfs "dev-${jail_name}" "${jail_path}/dev"
-
-    [ -e "dev/console" ] || mknod -m 622 "${jail_path}/dev/console" c 5 1
-    chown root:tty "${jail_path}/dev/console"
-    [ -e "dev/null" ] || mknod -m 666 "${jail_path}/dev/null" c 1 3
-    [ -e "dev/zero" ] || mknod -m 666 "${jail_path}/dev/zero" c 1 5
-    [ -e "dev/ptmx" ] || mknod -m 666 "${jail_path}/dev/ptmx" c 5 2
-    chown root:tty "${jail_path}/dev/ptmx"
-    [ -e "dev/tty" ] || mknod -m 666 "${jail_path}/dev/tty" c 5 0
-    chown root:tty "${jail_path}/dev/tty"
-    [ -e "dev/random" ] || mknod -m 444 "${jail_path}/dev/random" c 1 8
-    [ -e "dev/urandom" ] || mknod -m 444 "${jail_path}/dev/urandom" c 1 9
-
-    mkdir -p "${jail_path}/dev/pts"
-    is_mounted_inside_jail "${jail_path}/dev/pts" || mount -t devpts -o gid=4,mode=620 none "${jail_path}/dev/pts"
-
-    mkdir -p "${jail_path}/dev/shm"
-    is_mounted_inside_jail "${jail_path}/dev/shm" || mount -t tmpfs none "${jail_path}/dev/shm"
-
-    is_mounted_inside_jail "${jail_path}/proc" || mount -t proc "proc-${jail_name}" "${jail_path}/proc"
-
-    ln -fs "${jail_path}/proc/self/fd" "${jail_path}/dev/fd"
-    ln -fs "${jail_path}/proc/self/fd/0" "${jail_path}/dev/stdin"
-    ln -fs "${jail_path}/proc/self/fd/1" "${jail_path}/dev/stdout"
-    ln -fs "${jail_path}/proc/self/fd/2" "${jail_path}/dev/stderr"
-    ln -fs "${jail_path}/proc/kcore" "${jail_path}/dev/core"
-}
-
-read_variable() {
-    file=${1:?}
-    var_name=${2:?}
-
-    pattern="^\s*${var_name}=.+"
-
-    grep --extended-regexp --only-matching "${pattern}" "${file}" | tail -1 | cut -d= -f2
-}
-
-read_numerical_variable() {
-    file=${1:?}
-    var_name=${2:?}
-
-    pattern="^\s*${var_name}=-?[0-9]+"
-
-    grep --extended-regexp --only-matching "${pattern}" "${file}" | tail -1 | cut -d= -f2
-}

server/test/checks.bats

@@ -1,276 +0,0 @@
-#!/usr/bin/env bats
-# shellcheck disable=SC1089,SC1083,SC2154
-
-load test_helper
-
-@test "Check jails OK" {
-    run /usr/lib/bkctld/bkctld-check-jails
-    assert_equal "0" "$status"
-}
-
-@test "Check jails OK for default values" {
-    touch "${JAILPATH}/var/log/lastlog"
-    # With default values (2 days critical, 1 day warning),
-    # a freshly connected jail should be "ok"
-    run /usr/lib/bkctld/bkctld-check-jails
-    assert_equal "0" "$status"
-}
-
-@test "Check jails WARNING for default values" {
-    lastlog_date=$(date -d -2days --iso-8601=seconds)
-    touch --date="${lastlog_date}" "${JAILPATH}/var/log/lastlog"
-    # With default values (2 days critical, 1 day warning),
-    # a 2 days old jail should be "warning"
-    run /usr/lib/bkctld/bkctld-check-jails
-    assert_equal "1" "$status"
-}
-
-@test "Check jails CRITICAL for default values" {
-    lastlog_date=$(date -d -3days --iso-8601=seconds)
-    touch --date="${lastlog_date}" "${JAILPATH}/var/log/lastlog"
-    # With default values (2 days critical, 1 day warning),
-    # a 3 days old jail should be "critical"
-    run /usr/lib/bkctld/bkctld-check-jails
-    assert_equal "2" "$status"
-}
-
-@test "Check jails OK for custom values" {
-    lastlog_date=$(date -d -3days --iso-8601=seconds)
-    touch --date="${lastlog_date}" "${JAILPATH}/var/log/lastlog"
-
-    cat > "/etc/evobackup/${JAILNAME}.d/check_policy" <<OUT
-CRITICAL=120
-WARNING=96
-OUT
-    # With custom values (5 days critical, 4 days warning),
-    # a 3 days old jail should be "ok"
-    run /usr/lib/bkctld/bkctld-check-jails
-    assert_equal "0" "$status"
-}
-
-@test "Check jails WARNING for custom values" {
-    lastlog_date=$(date -d -3days --iso-8601=seconds)
-    touch --date="${lastlog_date}" "${JAILPATH}/var/log/lastlog"
-
-    cat > "/etc/evobackup/${JAILNAME}.d/check_policy" <<OUT
-CRITICAL=96
-WARNING=48
-OUT
-    # With custom values (4 days critical, 3 days warning),
-    # a 3 days old jail should be "warning"
-    run /usr/lib/bkctld/bkctld-check-jails
-    assert_equal "1" "$status"
-}
-
-@test "Check jails CRITICAL for custom values" {
-    lastlog_date=$(date -d -10days --iso-8601=seconds)
-    touch --date="${lastlog_date}" "${JAILPATH}/var/log/lastlog"
-
-    cat > "/etc/evobackup/${JAILNAME}.d/check_policy" <<OUT
-CRITICAL=96
-WARNING=48
-OUT
-    # With custom values (4 days critical, 3 days warning),
-    # a 10 days old jail should be "critical"
-    run /usr/lib/bkctld/bkctld-check-jails
-    assert_equal "2" "$status"
-}
-
-@test "Check jails OK for disabled WARNING" {
-    lastlog_date=$(date -d -2days --iso-8601=seconds)
-    touch --date="${lastlog_date}" "${JAILPATH}/var/log/lastlog"
-
-    cat > "/etc/evobackup/${JAILNAME}.d/check_policy" <<OUT
-WARNING=0
-OUT
-    # With custom values (warning disabled, default critical),
-    # a 2 days old jail should still be "ok"
-    run /usr/lib/bkctld/bkctld-check-jails
-    assert_equal "0" "$status"
-}
-
-@test "Check jails WARNING for disabled CRITICAL" {
-    lastlog_date=$(date -d -3days --iso-8601=seconds)
-    touch --date="${lastlog_date}" "${JAILPATH}/var/log/lastlog"
-
-    cat > "/etc/evobackup/${JAILNAME}.d/check_policy" <<OUT
-CRITICAL=0
-OUT
-    # With custom values (critical disabled, default warning),
-    # a 3 days old jail should only be "warning"
-    run /usr/lib/bkctld/bkctld-check-jails
-    assert_equal "1" "$status"
-}
-
-@test "Custom jails values are parsed with only integers after equal" {
-    lastlog_date=$(date -d -3days --iso-8601=seconds)
-    touch --date="${lastlog_date}" "${JAILPATH}/var/log/lastlog"
-
-    cat > "/etc/evobackup/${JAILNAME}.d/check_policy" <<OUT
-CRITICAL=0 # foo
-OUT
-    # With custom values (critical disabled, default warning),
-    # a 3 days old jail should only be "warning"
-    run /usr/lib/bkctld/bkctld-check-jails
-    assert_equal "1" "$status"
-}
-
-@test "Commented custom values are ignored" {
-    lastlog_date=$(date -d -3days --iso-8601=seconds)
-    touch --date="${lastlog_date}" "${JAILPATH}/var/log/lastlog"
-
-    cat > "/etc/evobackup/${JAILNAME}.d/check_policy" <<OUT
-# CRITICAL=0
-OUT
-    # With commented custom values (critical disabled),
-    # a 3 days old jail should still be "critical"
-    run /usr/lib/bkctld/bkctld-check-jails
-    assert_equal "2" "$status"
-}
-
-@test "Invalid custom values are ignored" {
-    lastlog_date=$(date -d -3days --iso-8601=seconds)
-    touch --date="${lastlog_date}" "${JAILPATH}/var/log/lastlog"
-
-    cat > "/etc/evobackup/${JAILNAME}.d/check_policy" <<OUT
-CRITICAL=foo
-OUT
-    # With commented custom values (critical disabled),
-    # a 3 days old jail should still be "critical"
-    run /usr/lib/bkctld/bkctld-check-jails
-    assert_equal "2" "$status"
-}
-
-@test "Check setup WARNING if firewall rules are not sourced" {
-    /usr/lib/bkctld/bkctld-start ${JAILNAME}
-
-    mkdir --parents /etc/minifirewall.d/
-    firewall_rules_file="/etc/minifirewall.d/bkctld"
-    set_variable "/etc/default/bkctld" "FIREWALL_RULES" "${firewall_rules_file}"
-    echo "" > "${firewall_rules_file}"
-
-    # Without sourcing
-    echo "" > "/etc/default/minifirewall"
-    # … the check should be "warning"
-    run /usr/lib/bkctld/bkctld-check-setup
-    assert_equal "1" "$status"
-}
-
-@test "Check setup OK if firewall rules are sourced" {
-    /usr/lib/bkctld/bkctld-start ${JAILNAME}
-
-    mkdir --parents /etc/minifirewall.d/
-    firewall_rules_file="/etc/minifirewall.d/bkctld"
-    set_variable "/etc/default/bkctld" "FIREWALL_RULES" "${firewall_rules_file}"
-    echo "" > "${firewall_rules_file}"
-
-    # Sourcing file with '.'
-    echo ". ${firewall_rules_file}" > "/etc/default/minifirewall"
-    # … the check should be "ok"
-    run /usr/lib/bkctld/bkctld-check-setup
-    assert_equal "0" "$status"
-
-    # Sourcing file with 'source'
-    echo "source ${firewall_rules_file}" > "/etc/default/minifirewall"
-    # … the check should be "ok"
-    run /usr/lib/bkctld/bkctld-check-setup
-    assert_equal "0" "$status"
-}
-
-@test "Check setup CRITICAL if jail is stopped" {
-    run /usr/lib/bkctld/bkctld-check-setup
-    assert_equal "2" "$status"
-}
-
-@test "Check setup OK if all jails are started" {
-    /usr/lib/bkctld/bkctld-start ${JAILNAME}
-
-    run /usr/lib/bkctld/bkctld-check-setup
-    assert_equal "0" "$status"
-}
-
-@test "Check setup OK if jail is supposed to be stopped" {
-    cat > "/etc/evobackup/${JAILNAME}.d/check_policy" <<OUT
-EXPECTED_STATE=OFF
-OUT
-
-    run /usr/lib/bkctld/bkctld-check-setup
-    assert_equal "0" "$status"
-}
-
-@test "Check setup CRITICAL if backup partition is not mounted" {
-    umount --force /backup
-
-    run /usr/lib/bkctld/bkctld-check-setup
-
-    mount /dev/vdb /backup
-
-    assert_equal "2" "$status"
-}
-
-@test "Check setup CRITICAL if backup partition is read-only" {
-    mount -o remount,ro /backup
-
-    run /usr/lib/bkctld/bkctld-check-setup
-
-    mount -o remount,rw /backup
-
-    assert_equal "2" "$status"
-}
-
-@test "Check-last-incs OK if jail is present" {
-    /usr/lib/bkctld/bkctld-inc
-
-    run /usr/lib/bkctld/bkctld-check-last-incs
-    assert_equal "0" "$status"
-}
-
-@test "Check-last-incs Error if jail is missing" {
-
-    run /usr/lib/bkctld/bkctld-check-last-incs
-    assert_equal "1" "$status"
-}
-
-@test "Check-incs OK" {
-    /usr/lib/bkctld/bkctld-inc
-
-    run /usr/lib/bkctld/bkctld-check-incs
-    assert_equal "0" "$status"
-}
-
-@test "Check-incs doesn't fail without incs_policy file" {
-    # Delete all possible incs polixy files
-    rm -f /etc/evobackup/${JAILNAME}
-    rm -rf /etc/evobackup/${JAILNAME}.d/incs_policy
-
-    # Run bkctld-check-incs and store stderr in a file
-    local stderrPath="${BATS_TMPDIR}/${BATS_TEST_NAME}.stderr"
-    /usr/lib/bkctld/bkctld-check-incs 2> ${stderrPath}
-
-    # Verify if 
-    run grep -E "^stat:" ${stderrPath}
-    assert_failure
-}
-# TODO: write many more tests for bkctld-check-incs
-
-@test "Check-canary fails if a canary file doesn't exist" {
-    run /usr/lib/bkctld/bkctld-check-canary "${JAILNAME}"
-    assert_equal "$status" "2"
-    assert_line "CRITICAL - ${JAILNAME} - missing /zzz_evobackup_canary file"
-}
-
-@test "Check-canary fails if a canary is missing today's entries" {
-    today="$(date +%Y-%m-%d)"
-    touch "${JAILPATH}/var/backup/zzz_evobackup_canary"
-
-    run /usr/lib/bkctld/bkctld-check-canary "${JAILNAME}"
-    assert_equal "$status" "2"
-    assert_line "CRITICAL - ${JAILNAME} - No entry for ${today} in /zzz_evobackup_canary file"
-}
-
-@test "Check-canary succeeds if a canary has today's entries" {
-    echo "$(date "+%FT%T%z") bats-test" >> "${JAILPATH}/var/backup/zzz_evobackup_canary"
-
-    run /usr/lib/bkctld/bkctld-check-canary "${JAILNAME}"
-    assert_success
-}

server/test/connectivity.bats

@@ -1,101 +0,0 @@
-#!/usr/bin/env bats
-# shellcheck disable=SC1089,SC1083,SC2154
-
-load test_helper
-
-@test "Without SSH key" {
-    run cat "${JAILPATH}/root/.ssh/authorized_keys"
-    assert_equal "$output" ""
-}
-
-@test "With SSH key" {
-    keyfile=/root/bkctld.key.pub
-    /usr/lib/bkctld/bkctld-key "${JAILNAME}" "${keyfile}"
-    # The key should be present in the SSH authorized_keys file
-    run cat "${JAILPATH}/root/.ssh/authorized_keys"
-    assert_equal "$output" "$(cat ${keyfile})"
-}
-
-@test "Custom port" {
-    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
-    /usr/lib/bkctld/bkctld-port "${JAILNAME}" "${PORT}"
-    # A jail should be accessible on the specified SSH port
-    run nc -vz 127.0.0.1 "${PORT}"
-    assert_success
-}
-
-@test "No IP restriction" {
-    # A jail has no IP restriction by default in SSH config
-    run grep "root@0.0.0.0/0" "${JAILPATH}/etc/ssh/sshd_config"
-    assert_success
-}
-
-@test "Single IP restriction" {
-    # When an IP is added for a jail
-    /usr/lib/bkctld/bkctld-ip "${JAILNAME}" "10.0.0.1"
-    # An IP restriction should be present in SSH config
-    run grep "root@10.0.0.1" "${JAILPATH}/etc/ssh/sshd_config"
-    assert_success
-}
-
-@test "Multiple IP restrictions" {
-    # When multiple IP are added for a jail
-    /usr/lib/bkctld/bkctld-ip "${JAILNAME}" "10.0.0.1"
-    /usr/lib/bkctld/bkctld-ip "${JAILNAME}" "10.0.0.2"
-    # The corresponding IP restrictions should be present in SSH config
-    run grep -E -o "root@10.0.0.[0-9]+" "${JAILPATH}/etc/ssh/sshd_config"
-
-    assert_line "root@10.0.0.1"
-    assert_line "root@10.0.0.2"
-}
-
-@test "Removing IP restriction" {
-    # Add an IP
-    /usr/lib/bkctld/bkctld-ip "${JAILNAME}" "10.0.0.1"
-    # Remove IP
-    /usr/lib/bkctld/bkctld-ip "${JAILNAME}" "0.0.0.0/0"
-    # All IP restrictions should be removed from SSH config
-    run grep "root@0.0.0.0/0" "${JAILPATH}/etc/ssh/sshd_config"
-    assert_success
-}
-
-@test "Missing AllowUsers" {
-    # Remove AllowUsers directive in SSH config
-    sed --follow-symlinks --in-place '/^AllowUsers/d' "${JAILPATH}/etc/ssh/sshd_config"
-    # An error should be raised when trying to add an IP restriction
-    run /usr/lib/bkctld/bkctld-ip "${JAILNAME}" "10.0.0.1"
-    assert_failure
-}
-
-@test "SSH connectivity" {
-    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
-    /usr/lib/bkctld/bkctld-port "${JAILNAME}" "${PORT}"
-    /usr/lib/bkctld/bkctld-key "${JAILNAME}" /root/bkctld.key.pub
-
-    ssh_options="-p ${PORT} -i /root/bkctld.key -oStrictHostKeyChecking=no"
-
-    # A started jail should be accessible via SSH
-    run ssh ${ssh_options} root@127.0.0.1 ls
-    assert_success
-
-    /usr/lib/bkctld/bkctld-stop "${JAILNAME}"
-    # A stopped jail should not be accessible via SSH
-    run ssh ${ssh_options} root@127.0.0.1 ls
-    assert_failure
-}
-
-@test "Rsync connectivity" {
-    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
-    /usr/lib/bkctld/bkctld-port "${JAILNAME}" "${PORT}"
-    /usr/lib/bkctld/bkctld-key "${JAILNAME}" /root/bkctld.key.pub
-
-    ssh_options="-p ${PORT} -i /root/bkctld.key -oStrictHostKeyChecking=no"
-    # A started jail should be accessible via Rsync
-    run rsync -a -e "ssh ${ssh_options}" /tmp/ root@127.0.0.1:/var/backup/
-    assert_success
-
-    /usr/lib/bkctld/bkctld-stop "${JAILNAME}"
-    # A stopped jail should not be accessible via Rsync
-    run rsync -a -e "${ssh_options}" /tmp/ root@127.0.0.1:/var/backup/
-    assert_failure
-}

server/test/incs.bats

@@ -1,235 +0,0 @@
-#!/usr/bin/env bats
-# shellcheck disable=SC1089,SC1083,SC2154
-
-load test_helper
-
-
-@test "Inc policy after jail init" {
-    # An incs_policy file should exist
-    run test -e "${CONFDIR}/${JAILNAME}.d/incs_policy"
-    [ "${status}" -eq 0 ]
-}
-@test "Inc directory after jail init" {
-    # An incs_policy file should exist
-    run test -d "${INCDIR}/${JAILNAME}"
-    [ "${status}" -eq 0 ]
-}
-
-@test "Normal inc creation" {
-    /usr/lib/bkctld/bkctld-inc
-
-    if is_btrfs "/backup"; then
-        # On a btrfs filesystem, the inc should be a btrfs volume
-        run is_btrfs "${INCSPATH}/${INC_NAME}"
-        assert_success
-    else
-        # On an ext4 filesystem, the inc should be a regular directory
-        run test -d "${INCSPATH}/${INC_NAME}"
-        assert_success
-    fi
-}
-
-@test "Normal inc creation (with old incs policy)" {
-    mv "${CONFDIR}/${JAILNAME}.d/incs_policy" "${CONFDIR}/${JAILNAME}"
-
-    /usr/lib/bkctld/bkctld-inc
-
-    if is_btrfs "/backup"; then
-        # On a btrfs filesystem, the inc should be a btrfs volume
-        run is_btrfs "${INCSPATH}/${INC_NAME}"
-        assert_success
-    else
-        # On an ext4 filesystem, the inc should be a regular directory
-        run test -d "${INCSPATH}/${INC_NAME}"
-        assert_success
-    fi
-}
-
-@test "No inc creation without inc policy" {
-    # Remove inc_policy
-    rm -f "${CONFDIR}/${JAILNAME}.d/incs_policy"
-    # … and old file
-    rm -f "${CONFDIR}/${JAILNAME}"
-
-    /usr/lib/bkctld/bkctld-inc
-
-    run test -d "${INCSPATH}/${INC_NAME}"
-    assert_failure
-}
-
-@test "Recent inc is kept after 'rm'" {
-    # Setup simple incs policy
-    echo "+%Y-%m-%d.-0day" > "${CONFDIR}/${JAILNAME}.d/incs_policy"
-
-    # Prepare an inc older than the policy
-    recent_inc_path="${INCSPATH}/${INC_NAME}"
-
-    # Create the inc, then run 'rm'
-    /usr/lib/bkctld/bkctld-inc
-    /usr/lib/bkctld/bkctld-rm
-
-    # Recent inc should be present
-    run test -d "${recent_inc_path}"
-    assert_success
-}
-
-@test "Older inc is removed by 'rm'" {
-    # Setup simple incs policy
-    echo "+%Y-%m-%d.-0day" > "${CONFDIR}/${JAILNAME}.d/incs_policy"
-
-    # Prepare an inc older than the policy
-    recent_inc_path="${INCSPATH}/${INC_NAME}"
-    older_inc_name=$(date -d -1days +"%Y-%m-%d-%H")
-    older_inc_path="${INCSPATH}/${older_inc_name}"
-
-    # Create the inc, rename it to make it older, then run 'rm'
-    /usr/lib/bkctld/bkctld-inc
-    mv "${recent_inc_path}" "${older_inc_path}"
-    /usr/lib/bkctld/bkctld-rm
-
-    # Older inc should be removed
-    run test -d "${older_inc_path}"
-    assert_failure
-}
-
-@test "All incs are removed by 'rm' with empty inc policy" {
-    # Setup empty incs policy
-    echo "" > "${CONFDIR}/${JAILNAME}.d/incs_policy"
-    inc_path="${INCSPATH}/${INC_NAME}"
-
-    # Create the inc
-    /usr/lib/bkctld/bkctld-inc
-    # Inc should be removed
-    run test -d "${inc_path}"
-    assert_success
-
-    # Remove incs
-    /usr/lib/bkctld/bkctld-rm
-    # Inc should be removed
-    run test -d "${inc_path}"
-    assert_failure
-}
-
-@test "empty inc directory are removed" {
-    # Create an inc
-    /usr/lib/bkctld/bkctld-inc
-    # no inc should be kept
-    echo '' > "${CONFDIR}/${JAILNAME}.d/incs_policy"
-
-    # The inc directory is present
-    run test -d "${INCSPATH}"
-    assert_success
-
-    /usr/lib/bkctld/bkctld-rm
-
-    # The inc directory is absent
-    run test -d "${INCSPATH}"
-    assert_failure
-}
-
-@test "BTRFS based inc can be unlock with complex pattern" {
-    if is_btrfs "/backup"; then
-        # Prepare an inc older than the policy
-        recent_inc_path="${INCSPATH}/${INC_NAME}"
-        older_inc_name=$(date -d -1month +"%Y-%m-%d-%H")
-        older_inc_path="${INCSPATH}/${older_inc_name}"
-
-        # Create the inc, rename it to make it older, then run 'rm'
-        /usr/lib/bkctld/bkctld-inc
-        mv "${recent_inc_path}" "${older_inc_path}"
-        # run 'inc' again to remake today's inc
-        /usr/lib/bkctld/bkctld-inc
-
-        # inc should be locked
-        run touch "${older_inc_path}/var/log/lastlog"
-        assert_failure
-
-        # unlock inc
-        pattern="${JAILNAME}/$(date -d -1month +"%Y-%m-*")"
-        bkctld inc-unlock "${pattern}"
-
-        # inc should be unlocked
-        run touch "${older_inc_path}/var/log/lastlog"
-        assert_success
-
-        # other inc should still be locked
-        run touch "${recent_inc_path}/var/log/lastlog"
-        assert_failure
-    else
-        # On an ext4 filesystem it's always true
-        run true
-        assert_success
-    fi
-}
-
-@test "BTRFS based inc can be unlock with jail name" {
-    if is_btrfs "/backup"; then
-        # Prepare an inc older than the policy
-        recent_inc_path="${INCSPATH}/${INC_NAME}"
-        older_inc_name=$(date -d -1month +"%Y-%m-%d-%H")
-        older_inc_path="${INCSPATH}/${older_inc_name}"
-
-        # Create the inc, rename it to make it older, then run 'rm'
-        /usr/lib/bkctld/bkctld-inc
-        mv "${recent_inc_path}" "${older_inc_path}"
-        # run 'inc' again to remake today's inc
-        /usr/lib/bkctld/bkctld-inc
-
-        # incs should be locked
-        run touch "${recent_inc_path}/var/log/lastlog"
-        assert_failure
-        run touch "${older_inc_path}/var/log/lastlog"
-        assert_failure
-
-        # unlock incs
-        pattern="${JAILNAME}"
-        bkctld inc-unlock "${pattern}"
-
-        # incs should be unlocked
-        run touch "${recent_inc_path}/var/log/lastlog"
-        assert_success
-        run touch "${older_inc_path}/var/log/lastlog"
-        assert_success
-    else
-        # On an ext4 filesystem it's always true
-        run true
-        assert_success
-    fi
-}
-
-@test "BTRFS based inc can be unlock with 'all' pattern" {
-    if is_btrfs "/backup"; then
-        # Prepare an inc older than the policy
-        recent_inc_path="${INCSPATH}/${INC_NAME}"
-        older_inc_name=$(date -d -1month +"%Y-%m-%d-%H")
-        older_inc_path="${INCSPATH}/${older_inc_name}"
-
-        # Create the inc, rename it to make it older, then run 'rm'
-        /usr/lib/bkctld/bkctld-inc
-        mv "${recent_inc_path}" "${older_inc_path}"
-        # run 'inc' again to remake today's inc
-        /usr/lib/bkctld/bkctld-inc
-
-        # incs should be locked
-        run touch "${recent_inc_path}/var/log/lastlog"
-        assert_failure
-        run touch "${older_inc_path}/var/log/lastlog"
-        assert_failure
-
-        # unlock incs
-        pattern="all"
-        bkctld inc-unlock "${pattern}"
-
-        # incs should be unlocked
-        run touch "${recent_inc_path}/var/log/lastlog"
-        assert_success
-        run touch "${older_inc_path}/var/log/lastlog"
-        assert_success
-    else
-        # On an ext4 filesystem it's always true
-        run true
-        assert_success
-    fi
-}
-
-# TODO: add many tests for incs (creation and removal)

server/test/main.bats

@@ -1,113 +0,0 @@
-#!/usr/bin/env bats
-# shellcheck disable=SC1089,SC1083,SC2154
-
-load test_helper
-
-@test "Filesystem type" {
-    if is_btrfs "/backup"; then
-        # On a btrfs filesystem, the jail should be a btrfs volume
-        run is_btrfs "${JAILPATH}"
-        assert_success
-    else
-        # On an ext4 filesystem, the jail should be a regular directory
-        run test -d "${JAILPATH}"
-        assert_success
-    fi
-}
-
-@test "New jail should have a incs_policy file" {
-    run test -f "/etc/evobackup/${JAILNAME}.d/incs_policy"
-    assert_success
-}
-
-@test "New jail should have a check_policy file" {
-    run test -f "/etc/evobackup/${JAILNAME}.d/check_policy"
-    assert_success
-}
-
-@test "A jail should be able to be started" {
-    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
-    pid=$(cat "${JAILPATH}/${SSHD_PID}")
-    # A started jail should have an SSH pid file
-    run ps --pid "${pid}"
-    assert_success
-}
-
-@test "A jail should be able to be stopped" {
-    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
-    pid=$(cat "${JAILPATH}/${SSHD_PID}")
-    /usr/lib/bkctld/bkctld-stop "${JAILNAME}"
-    # A stopped jail should not have an SSH pid file
-    run ps --pid "${pid}"
-    assert_failure
-}
-
-@test "A jail should be able to be reloaded" {
-    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
-    /usr/lib/bkctld/bkctld-reload "${JAILNAME}"
-    # A reloaded jail should mention the restart in the authlog
-    run grep "Received SIGHUP; restarting." "${JAILPATH}/var/log/authlog"
-    assert_success
-}
-
-@test "A jail should be able to be restarted" {
-    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
-    pid_before=$(cat "${JAILPATH}/${SSHD_PID}")
-
-    /usr/lib/bkctld/bkctld-restart "${JAILNAME}"
-    pid_after=$(cat "${JAILPATH}/${SSHD_PID}")
-
-    # A restarted jail should have a different pid
-    refute_equal "${pid_before}" "${pid_after}"
-}
-
-@test "A jail should be able to be renamed" {
-    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
-    new_name="${JAILNAME}-new"
-    # A started jail should report to be ON
-    run /usr/lib/bkctld/bkctld-rename "${JAILNAME}" "${new_name}"
-    assert_success
-
-    run /usr/lib/bkctld/bkctld-is-on "${new_name}"
-    assert_success
-
-    # change variable to new name,for teardown
-    JAILNAME="${new_name}"
-}
-
-@test "A jail should be able to be archived" {
-    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
-    # A started jail should report to be ON
-    run /usr/lib/bkctld/bkctld-is-on "${JAILNAME}"
-    assert_success
-
-    run /usr/lib/bkctld/bkctld-archive "${JAILNAME}"
-    assert_success
-
-    # A started jail should report to be OFF
-    run /usr/lib/bkctld/bkctld-is-on "${JAILNAME}"
-    assert_failure
-
-    run test -d "${JAILPATH}"
-    assert_failure
-
-    run test -d "/backup/archives/${JAILNAME}"
-    assert_success
-}
-
-@test "Status should return information" {
-    run /usr/lib/bkctld/bkctld-status "${JAILNAME}"
-    assert_success
-}
-
-@test "ON/OFF status can be retrived with 'is-on'" {
-    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
-    # A started jail should report to be ON
-    run /usr/lib/bkctld/bkctld-is-on "${JAILNAME}"
-    assert_success
-
-    /usr/lib/bkctld/bkctld-stop "${JAILNAME}"
-    # A stopped jail should not report to be ON
-    run /usr/lib/bkctld/bkctld-is-on "${JAILNAME}"
-    assert_failure
-}

server/test/test_helper.bash

@@ -1,142 +0,0 @@
-# shellcheck disable=SC2154 shell=bash
-
-# shellcheck disable=SC2034
-setup() {
-    . /usr/lib/bkctld/includes
-
-    rm -f /root/bkctld.key*
-    ssh-keygen -t rsa -N "" -f /root/bkctld.key -q
-
-    set_variable "/etc/default/bkctld" "BACKUP_DISK" "/dev/vdb"
-
-    JAILNAME=$(random_jail_name)
-    JAILPATH="/backup/jails/${JAILNAME}"
-    INCSPATH="/backup/incs/${JAILNAME}"
-    PORT=$(random_port)
-    INC_NAME=$(inc_name_today)
-
-    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
-}
-
-teardown() {
-    remove_variable "/etc/default/bkctld" "BACKUP_DISK"
-    FORCE=1 /usr/lib/bkctld/bkctld-remove "${JAILNAME}" \
-      && rm -rf "${INCSPATH}" "/etc/evobackup/${JAILNAME}" "/etc/evobackup/${JAILNAME}.d"
-}
-
-random_jail_name() {
-    tr -cd '[:alnum:]' < /dev/urandom | fold -w15 | head -n1
-}
-random_port() {
-    awk -v min=2222 -v max=2999 'BEGIN{srand(); print int(min+rand()*(max-min+1))}'
-}
-inc_name_today() {
-    date +"%Y-%m-%d-%H"
-}
-
-set_variable() {
-    file=${1:?}
-    var_name=${2:?}
-    var_value=${3:-}
-
-    if grep -qE "^\s*${var_name}=" "${file}"; then
-        sed --follow-symlinks --in-place "s|^\s*${var_name}=.*|${var_name}=${var_value}|" "${file}"
-    else
-        echo "${var_name}=${var_value}" >> "${file}"
-    fi
-}
-remove_variable() {
-    file=${1:?}
-    var_name=${2:?}
-
-    sed --follow-symlinks --in-place "s|^\s*${var_name}=.*|d" "${file}"
-}
-
-is_btrfs() {
-    path=$1
-
-    inode=$(stat --format=%i "${path}")
-
-    test ${inode} -eq 256
-}
-
-flunk() {
-  { if [ "$#" -eq 0 ]; then cat -
-    else echo "$@"
-    fi
-  } >&2
-  return 1
-}
-
-assert_success() {
-  if [ "$status" -ne 0 ]; then
-    flunk "command failed with exit status $status"
-  elif [ "$#" -gt 0 ]; then
-    assert_output "$1"
-  fi
-}
-
-assert_failure() {
-  if [ "$status" -eq 0 ]; then
-    flunk "expected failed exit status"
-  elif [ "$#" -gt 0 ]; then
-    assert_output "$1"
-  fi
-}
-
-assert_equal() {
-  if [ "$1" != "$2" ]; then
-    { echo "expected: $1"
-      echo "actual:   $2"
-    } | flunk
-  fi
-}
-
-refute_equal() {
-  if [ "$1" = "$2" ]; then
-    echo "expected $1 to not be equal to $2" | flunk
-  fi
-}
-
-assert_output() {
-  local expected
-  if [ $# -eq 0 ]; then expected="$(cat -)"
-  else expected="$1"
-  fi
-  assert_equal "$expected" "$output"
-}
-
-assert_line() {
-  if [ "$1" -ge 0 ] 2>/dev/null; then
-    assert_equal "$2" "${lines[$1]}"
-  else
-    local line
-    for line in "${lines[@]}"; do
-      if [ "$line" = "$1" ]; then return 0; fi
-    done
-    flunk "expected line \`$1'"
-  fi
-}
-
-refute_line() {
-  if [ "$1" -ge 0 ] 2>/dev/null; then
-    local num_lines="${#lines[@]}"
-    if [ "$1" -lt "$num_lines" ]; then
-      flunk "output has $num_lines lines"
-    fi
-  else
-    local line
-    for line in "${lines[@]}"; do
-      if [ "$line" = "$1" ]; then
-        flunk "expected to not find line \`$line'"
-      fi
-    done
-  fi
-}
-
-# shellcheck disable=SC2145
-assert() {
-  if ! "$@"; then
-    flunk "failed: $@"
-  fi
-}

server/tpl/check_policy.tpl

@@ -1,3 +0,0 @@
-## Uncomment and adapt thresholds (values are in hours)
-# WARNING=24
-# CRITICAL=48

test/main.bats

@@ -0,0 +1,133 @@
+#!/usr/bin/env bats
+
+setup() {
+    port=$(awk -v min=2222 -v max=2999 'BEGIN{srand(); print int(min+rand()*(max-min+1))}')
+    date=$(date +"%Y-%m-%d-%H")
+    inode=$(stat --format=%i /backup)
+    rm -f /root/bkctld.key* && ssh-keygen -t rsa -N "" -f /root/bkctld.key -q
+    . /usr/lib/bkctld/config
+    JAILNAME=$(tr -cd '[:alnum:]' < /dev/urandom | fold -w15 | head -n1)
+}
+
+teardown() {
+    /usr/lib/bkctld/bkctld-remove "${JAILNAME}" && rm -rf "${INCDIR}/*"
+}
+
+@test "init" {
+    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
+    inode=$(stat --format=%i /backup)
+    if [ "${inode}" -eq 256 ]; then
+        run stat --format=%i "${JAILDIR}/${JAILNAME}"
+        [ "${output}" -eq 256 ]
+    else
+        run test -d "${JAILDIR}/${JAILNAME}"
+        [ "${status}" -eq 0 ]
+    fi
+}
+
+@test "start" {
+    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
+    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
+    pid=$(cat "${JAILDIR}/${JAILNAME}/${SSHD_PID}")
+    run ps --pid "${pid}"
+    [ "${status}" -eq 0 ]
+}
+
+@test "stop" {
+    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
+    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
+    pid=$(cat "${JAILDIR}/${JAILNAME}/${SSHD_PID}")
+    /usr/lib/bkctld/bkctld-stop "${JAILNAME}"
+    run ps --pid "${pid}"
+    [ "${status}" -ne 0 ]
+}
+
+@test "reload" {
+    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
+    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
+    /usr/lib/bkctld/bkctld-reload "${JAILNAME}"
+    run grep "Received SIGHUP; restarting." "${JAILDIR}/${JAILNAME}/var/log/authlog"
+    [ "${status}" -eq 0 ]
+}
+
+@test "restart" {
+    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
+    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
+    bpid=$(cat "${JAILDIR}/${JAILNAME}/${SSHD_PID}")
+    /usr/lib/bkctld/bkctld-restart "${JAILNAME}"
+    apid=$(cat "${JAILDIR}/${JAILNAME}/${SSHD_PID}")
+    [ "${bpid}" -ne "${apid}" ]
+}
+
+@test "status" {
+    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
+    run /usr/lib/bkctld/bkctld-status "${JAILNAME}"
+    [ "${status}" -eq 0 ]
+}
+
+@test "key" {
+    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
+    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
+    /usr/lib/bkctld/bkctld-key "${JAILNAME}" /root/bkctld.key.pub
+    run cat "/backup/jails/${JAILNAME}/root/.ssh/authorized_keys"
+    [ "${status}" -eq 0 ]
+    [ "${output}" = $(cat /root/bkctld.key.pub) ]
+}
+
+@test "port" {
+    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
+    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
+    /usr/lib/bkctld/bkctld-port "${JAILNAME}" "${port}"
+    run nc -vz 127.0.0.1 "${port}"
+    [ "${status}" -eq 0 ]
+}
+
+@test "inc" {
+    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
+    /usr/lib/bkctld/bkctld-inc
+    if [ "${inode}" -eq 256 ]; then
+        run stat --format=%i "${INCDIR}/${JAILNAME}/${date}"
+        [ "${output}" -eq 256 ]
+    else
+        run test -d "${INCDIR}/${JAILNAME}/${date}"
+        [ "${status}" -eq 0 ]
+    fi
+}
+
+@test "ssh" {
+    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
+    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
+    /usr/lib/bkctld/bkctld-port "${JAILNAME}" "${port}"
+    /usr/lib/bkctld/bkctld-key "${JAILNAME}" /root/bkctld.key.pub
+    run ssh -p "${port}" -i /root/bkctld.key -oStrictHostKeyChecking=no root@127.0.0.1 ls
+    [ "$status" -eq 0 ]
+}
+
+@test "rsync" {
+    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
+    /usr/lib/bkctld/bkctld-start "${JAILNAME}"
+    /usr/lib/bkctld/bkctld-port "${JAILNAME}" "${port}"
+    /usr/lib/bkctld/bkctld-key "${JAILNAME}" /root/bkctld.key.pub
+    run rsync -a -e "ssh -p ${port} -i /root/bkctld.key -oStrictHostKeyChecking=no" /tmp/ root@127.0.0.1:/var/backup/
+    [ "$status" -eq 0 ]
+}
+
+@test "check-ok" {
+    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
+    run /usr/lib/bkctld/bkctld-check
+    [ "$status" -eq 0 ]
+}
+
+@test "check-warning" {
+    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
+    touch --date="$(date -d -2days)" "/backup/jails/${JAILNAME}/var/log/lastlog"
+    run /usr/lib/bkctld/bkctld-check
+    [ "$status" -eq 1 ]
+}
+
+@test "check-critical" {
+    /usr/lib/bkctld/bkctld-init "${JAILNAME}"
+    touch --date="$(date -d -3days)" "/backup/jails/${JAILNAME}/var/log/lastlog"
+    run /usr/lib/bkctld/bkctld-check
+    [ "$status" -eq 2 ]
+}