Backup Script

I have multiple local servers and machines I want to backup to one central location. The criteria is that it has to be encrypted, both when transferring and storing, automatic and transparent, redundant and off-line backup. This method is based on Open Source projects.

Previous Routines

A few years ago I found a great way to backup my servers to one central backup server using rsync and ssh. The backup server was located 100 meters away from the location with the servers, connected via wireless lan.

Every server was set up to use keys to login to the backup server without a password, making the process transparent. The rsync process was done over encrypted ssh, making it secure when transferring.

This method worked great and every few problems cropped up, other than lack of free space on backup drives. Both ends (clients and server) had a simple bash script that initiated the mounting of the drives, setting up ssh, including/excludign files, and rsyncing them over. Crontab took care of the scheduling.

Backup Routine

The new routing will be based on the previous method but simplified and the disks will be encrypted using Truecrypt.

For redundancy I will be using two 250 GB external USB 2.0 bus-powered 2.5-inch hard drives, mine are from made by Western Digital. Both drives are identical and allows me to take one for backup at home (1) while leaving the other at work (2) to backup the servers/desktops.

When I see fit, I can swap the one at home (1) with the one at work (2) (and vice versa) and rsync will take care of the discrepancies by doing a incremental update. The incremental update will find all the new and modified files since the last time it saw that drive (1) and only copy over those files, while at the same time I have a redundant backup of all the files on the other drive (2). The 'freshness' of the redundant files depends on how often I swap out the drives (probably once a week).

Another issue I had was to find a filesystem that allowed for Linux permissions to be stored while still be accessibly by Mac OS X and Windows. After trying to get ext2/ext3 and NTFS to work, I found that, weirdly, HFS+ would be the most compatible filesystem. It was the only fs to have proper read and write, large file, and attribute/permission support. I didn't want to store backups in tar-balls.

Update: The HFS Plus Linux drives has problems with some Linux files or allocation and resulting in an Inode count incorrect error message when trying to fix the problem with Disk Utility. If the problem was not fixed it won't mount at all. The fix was to create to separate partitions, one HFS Plus formatted for the Mac mini files and one Ext3 formatted for the Linux server and Windows client files.

Tools

All the tools used are Open Source and distributed free.

• rsync
• Truecrypt
  • truecrypt-install
• OpenSSH
• ssh-keyinstall
  • netcat
• Debian Linux (etch)

Many of these tools have dependencies, but these are the majo components. Command-line/terminal will be heavily used to manage, and run this routine.

Encrypted Drive

For the backup server I choose the one that would be up and running the most, and the best secured (no Internet ssh logins allowed, etc).

The external hard drive was automatically recognized and the modules were loaded without a problem by the vanilla 2.6.18-4 Debian kernel. The drive came with one partition that was FAT32 formatted.

If the drive is not formatted, use fdisk to add a primary partition. It doesn't matter which filesystem the partition is formatted as it will be reformatted during the Truecrypt setup.

elitus kernel: usb 1-2: new full speed USB device using uhci_hcd and address 5
elitus kernel: usb 1-2: configuration #1 chosen from 1 choice
elitus kernel: scsi3 : SCSI emulation for USB Mass Storage devices
elitus kernel: usb-storage: device found at 5
elitus kernel: usb-storage: waiting for device to settle before scanning
~
elitus kernel:   Vendor: WD        Model: 2500BEV External  Rev: 1.04
elitus kernel:   Type:   Direct-Access                      ANSI SCSI revision: 04
elitus kernel: SCSI device sdb: 488397168 512-byte hdwr sectors (250059 MB)
elitus kernel: sdb: Write Protect is off
elitus kernel: sdb: Mode Sense: 21 00 00 00
elitus kernel: sdb: assuming drive cache: write through
elitus kernel: SCSI device sdb: 488397168 512-byte hdwr sectors (250059 MB)
elitus kernel: sdb: Write Protect is off
elitus kernel: sdb: Mode Sense: 21 00 00 00
elitus kernel: sdb: assuming drive cache: write through
elitus kernel:  sdb: sdb1
elitus kernel: sd 3:0:0:0: Attached scsi disk sdb
elitus kernel: usb-storage: device scan complete

Unfortunately, this motherboard and chipset only support USB v1.1.

Truecrypt 4.3a

As of writing, there are no package maintainer for Truecrypt and it has to be compiled from source. Fortunately, some one has put together a handy truescript-installer script package that automates major parts of the process. Most of the ground work for this part was done by jaalto over at debian-administration.org.

Prepare Kernel

Prepare by installing the kernel sources, headers and kbuild.

uname -a
apt-cache search 'linux-source|linux-kbuild|linux-headers' # Find the matching ones

KVER=$(uname -r | sed 's/-.*//')
apt-get install linux-source-$KVER linux-kbuild-$KVER linux-headers-$KVER

Create the required kernel CPU architecture files by entering and exiting the kernel configuration menu.

cd /usr/src
tar -jxf linux-source-$KVER*.bz2
cd /usr/src/linux-source-$KVER
cp /boot/config-$KVER .config
make menuconfig
# Look at the bottom, select exit, and Yes when prompted to save the settings

Build Truecrypt

Now, to create the truecrypt binary, docs, and mobules, downloading and executing the truecrypt-installer package.

Go to http://debian.cante.net/truecrypt-installer and download the installer package compatible with the available Truecrypt version, as of writing truecrypt-installer_20071024-1_i386.deb for Truecrypt 4.3a.

wget http://cante.net/~jaalto/tmp/debian/truecrypt-installer/truecrypt-installer_20071024-1_i386.deb
dpkg -i truecrypt-installer_20071024-1_i386.deb
# Dependencies could be a problem, I had to install the following packages
apt-get install bzr debhelper dpatch html2text python-celementtree python-central python-elementtree python-support

Execute truecrypt-download and if it can't find the truecrypt source code, download it manually.

truecrypt-download
# Or
cd  /usr/src
wget http://tldp.etf.bg.ac.yu/gentoo/distfiles/truecrypt-4.3a-source-code.tar.gz

Now begin the build process. If it stops mid-way, try to delete all the truecrypt* files and directories in /usr/src and start from the beginning. The script relies on online trunk files to be available, which could pose a problem in the future.

truecrypt-build

If the process successfully finishes, install the resulting packages.

dpkg -i /usr/src/truecrypt-{cli,doc,modules-linux,modules-modprobe}*.deb

The install script will add the truecrypt module to /etc/modules so that it loads on boot.

Truecrypt 6.1a

Build

The 6.1 version is alot easier to build as it used wxWidgets (cross platform programming).

Download wxWidgets and extract the archive.

Build the truecrypt binary:

make NOGUI=1 WX_ROOT=/usr/home/ivc/bin/truecrypt-6.1a-source/wxWidgets-2.8.9 wxbuild
make NOGUI=1 WXSTATIC=1

My build halted on a warning: pkcs11.h: No such file or directory error, download the following files into the truecrypt-6.1 root.

wget ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-11/v2-20/pkcs11.h
wget ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-11/v2-20/pkcs11f.h
wget ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-11/v2-20/pkcs11t.h

The final binary should be in the Main directory. Copy it to /usr/bin or /usr/local/bin to make it globally available.

There might be some package dependency for fuse and device mapper. I had to install fuse-utils in addition to the already installed packages from the Truecrypt 4.3a setup.

Encrypting Drive

There is only one main binary called truecrypt. The easiest way to setup a new drive is to follow the simple guide.

truecrypt --quick --create /dev/sdb1

Volume type:
 1) Normal
 2) Hidden
Select [1]: 1

WARNING: Data on device will be lost. Continue? [y/N]: y
Filesystem:
 1) FAT
 2) None
Select [1]: 1

Hash algorithm:
 1) RIPEMD-160
 2) SHA-1
 3) Whirlpool
Select [1]: 1

Encryption algorithm:
 1) AES
 2) Blowfish
 3) CAST5
 4) Serpent
 5) Triple DES
 6) Twofish
 7) AES-Twofish
 8) AES-Twofish-Serpent
 9) Serpent-AES
10) Serpent-Twofish-AES
11) Twofish-Serpent
Select [1]: 1

Enter password for new volume '/dev/sdb1':
Re-enter password:

Enter keyfile path [none]:

TrueCrypt will now collect random data.

Please type at least 320 randomly chosen characters and then press Enter:
4qGSW(&/CXU...

Done: 0.00 MB  Speed: 0.00 MB/s  Left: 45222:49:57

I choose not to use keyfiles as I'd experiences some problems with them earlier, might work later though. The quick option finishes the format at the end in under a minute. I don't want to hang around waiting for the drive to format when I'm going to reformat it later, but I still understand that truecrypt normally randomizes the sectors while formatting the drive making it less prone to obscurity attacks.

Formatting Drive

To make the drive cross-platform and compatible with as many file attributions as possible, I reformat the drive with HFS+ aka. the Mac OS filesystem.

I used my Mac Mini to format the drive but it's possible to format the drive using MacDrive for Windows too.

1. Download the latest Truecrypt for Mac OS X (starting v5.0) and install it the normal way.
2. Plug in the USB drive and click 'Ignore' when prompted with an unrecognized drive.
3. Open Truecrypt and click 'Select drive'
4. Find the USB drive and click Mount.
5. Enter the truecrypt password for parition and it will automatically mount on the desktop.
6. Open 'Disk Utility' from the Applications -> Utilities folder.
7. On the left, pick the mounted drive from the bottom of the list, and click Erase.
8. Select 'HFS Extended (Case-sensitive)' and not the journaled one, click 'Erase'.
9. The drive is now ready to be used as a cross-platform backup drive.

Linux already has a good hfsplus-module that allows read and write. For Windows, MacDrive seems to be a good choice.

Try to mount and dismount the new Truecrypt encrypted drive on Linux:

truecrypt -p <truecryptpassword> /dev/sda1 /mnt/backup
truecrypt -d

To do the same on Mac OS X:

echo -e "\n\n"|./TrueCrypt -t -p truecryptpassword -k '' /dev/disk1s1 /Volumes/Backup
echo -e "\n\n"|./TrueCrypt -t -d

It's also possible to manually use the Truecrypt GUI for all three platforms (since v5.0) to select and mount the encrypted drive.

Backup Server

Server Script

The server script:

#!/bin/bash
# Originally by William Stearns - http://www.stearns.org/rsync-backup/
# Edited/redesigned by ivc - http://beta.ivancover.com/wiki/
#
# To set up password-less login:
# ./ssh-keyinstall -s spinus -u root -c 'export SSH_CLIENT SSH2_CLIENT \; /usr/bin/nice /usr/home/ivc/bin/rsync-backup-server/rsync-backup-server server1'
#

unset PATH # suggestion from H. Milz: avoid accidental use of $PATH

# Settings
BACKUPDIR=/mnt/backup
BACKUPDEV=/dev/sda1

# File paths
RM=/bin/rm
MKDIR=/bin/mkdir
CP=/bin/cp
ECHO=/bin/echo
LOGGER=/usr/bin/logger
CHROOT=/usr/sbin/chroot
HOST=/usr/bin/host
AWK=/usr/bin/awk
TR=/usr/bin/tr
DATE=/bin/date
MOUNT=/bin/mount
UMOUNT=/bin/umount
TRUECRYPT=/usr/bin/truecrypt
SUDO=/usr/bin/sudo
RSYNC_STATIC=/usr/home/ivc/bin/rsync-backup-server/rsync-static

# DEBUG
debug () {
        #$ECHO -e "$*"
        $LOGGER -t rsync-backup-server "$*"
}

debug
debug ' '`$DATE +"%Y-%m-%d %H:%M:%S"`' Starting backup server script'

# GET CLIENTNAME
if [ -n "$1" ] && [ "$1" != "--server" ]; then
        CLIENTNAME="$1"
        debug "  Using passed clientname: ${CLIENTNAME} (from argument and ~/.ssh/authorized_keys2)"
elif [ -n "$SSH_CLIENT" ]; then
        CLIENTNAME=`$HOST ${SSH_CLIENT%% *} | $AWK '{print $5}' | $TR '.' ' ' | $AWK '{print $1}'`
        debug "  Using IP address from SSH1/OpenSSH shell environment - clientname: ${CLIENTNAME}"
elif [ -n "$SSH2_CLIENT" ]; then
        CLIENTNAME=`$HOST ${SSH2_CLIENT%% *} | $AWK '{print $5}' | $TR '.' ' ' | $AWK '{print $1}'`
        debug "  Using IP address from SSH2 shell environment - clientname: ${CLIENTNAME}"
else
        debug '  No passed clientname and null SSH_CLIENT and SSH2_CLIENT,'
        debug '  where do I store the backup?  Exiting'
        exit 1
fi

# GET COMMAND SENT FROM CLIENT
if [ -n "$SSH_ORIGINAL_COMMAND" ]; then
        debug "  Passed SSH command: $SSH_ORIGINAL_COMMAND"
elif [ -n "$SSH2_ORIGINAL_COMMAND" ]; then
        debug "  Passed SSH2 command: $SSH2_ORIGINAL_COMMAND"
else
        debug '  Not passed a command, script should only run over ssh. Exiting'
        exit 1;
fi

# MOUNT
if [ ! -f "$BACKUPDIR/checker-file" ]; then
        debug "  Mouting backup device $BACKUPDEV to $BACKUPDIR via truecrypt"
        $TRUECRYPT -p backup $BACKUPDEV $BACKUPDIR;
        #$MOUNT -t hfsplus $BACKUPDEV $BACKUPDIR;
        if (( $? )); then {
                debug '  Mounting device failed. Exiting'
                exit 1
        } fi;
fi

# SETTING UP FILES AND DIRECTORIES
if [ ! -f "$BACKUPDIR/checker-file" ]; then
        debug '  Making checker-file'
        $SUDO $ECHO "Yep, this is the backup drive" > $BACKUPDIR/checker-file;
fi

if [ ! -d "$BACKUPDIR/$CLIENTNAME/current/" ]; then
        debug "  Creating necessary $BACKUPDIR/$CLIENTNAME/current/ directories"
        $SUDO $MKDIR -p "$BACKUPDIR/$CLIENTNAME/current/"
fi

if [ ! -f "$BACKUPDIR/$CLIENTNAME/rsync-static" ]; then
        debug '  Copying rsync binary for chroot jail'
        $SUDO $CP -p "$RSYNC_STATIC" "$BACKUPDIR/$CLIENTNAME/rsync-static"
fi

debug '  Initilizing rsync-static server in chroot jail...'
# rsync parameters:
#        -l, --links                 copy symlinks as symlinks
#        -o, --owner                 preserve owner (root only)
#        -g, --group                 preserve group
#        -D, --devices               preserve devices (root only)
#        -t, --times                 preserve times
#        -p, --perms                 preserve permissions
#        -r, --recursive             recurse into directories
#        -R, --relative              use relative path names
#            --delete                delete files that don't exist on sender
#            --delete-after          receiver deletes after transfer, not before
#        -a is equivalent to -rlptgoD
$SUDO $CHROOT "$BACKUPDIR/$CLIENTNAME/" /rsync-static --server -logDtprR --delete --numeric-ids . /current/

debug "  Done doing backup from ${CLIENTNAME} to $BACKUPDIR/$CLIENTNAME/current"

# UNMOUNT
debug "  Unmounting backup device $BACKUPDEV via truecrypt"
#$UMOUNT $BACKUPDIR;
$TRUECRYPT -d

debug ' '`$DATE +"%Y-%m-%d %H:%M:%S"`' Finished backup server script'

Linux

The server script is made on and for Linux, and will work out-of-the box on most systems as long as the default tools (grep, echo, chroot, date, sudo, etc) are available.

Add a backup user that is responsible for the password-less login and execution of the server script.

adduser -d /usr/home/ivc/bin/rsync-backup-server backupuser

The script will change root (chroot) to the backup directory (e.g /mnt/backup/elitus/) right before the rsync procedure starts. This strengthens the security and prevents a rouge remote client to gain system access.

su root
apt-get install sudoers
pico /etc/sudoers
# Add this line to allow the backupuser to sudo without a password:
backupuser ALL=(ALL) NOPASSWD: ALL

Nothing has to be executed manually on the backup server, the server script will be executed once the backupuser logs in remotely.

Download Linux server package

In OpenSSH 4.3p2 and later I had to remove the command= string in authorized_keys2 to avoid that the connection to be closed immediately. Also run update-locale to generate an empty /etc/default/locale file.

Mac OS X

I use a Mac Mini at home as my desktop machine and the machine is set up as the backup server for another server and itself. Mac OS X is based on Unix and all the cool tools are available, including rsync.

Add a 'Standard' backup user via System Preferences, I called mine "Backup User", short "backupuser".

Add the backupuser to allow password-less sudo to root:

su (enable root access in 'Directory Utility')
pico /etc/sudoers
# Add this line:
backupuser ALL=(ALL) NOPASSWD: ALL

Only a few minor adjustment has to be done to make the backup server script compatible.

• Truecrypt mount and unmount commands are a bit different

sudo killall -9 hdiutil
sudo umount -f /private/tmp/.truecrypt_aux_mnt1	
$ECHO -e "\n\n\n"|/Applications/TrueCrypt.app/Contents/MacOS/TrueCrypt -t -d -f 
$ECHO -e "\n\n"|/Applications/TrueCrypt.app/Contents/MacOS/TrueCrypt -t -p backuppassword -k  $BACKUPDEV $BACKUPDIR

• Chroot does not seem to work, possibly because rsync is dynamic not static (requires libs)

Download Mac OS X server package

Backup Client

The backup client will run without much hassle on both Linux and Mac OS X. Windows is a bit more tricky but it works, see the mention on the end of this section.

Client Script

The client script:

#!/bin/bash
# Originally by William Stearns - http://www.stearns.org/rsync-backup/
# Edited/redesigned by ivc - http://beta.ivancover.com/wiki/
#
# Add a cron job like this:
#0 7 * * * root /usr/home/ivc/bin/rsync-backup/rsync-backup-client / backupuser@192.168.1.1:/
#
unset PATH # suggestion from H. Milz: avoid accidental use of $PATH

# Settings
BACKUPDIR=/usr/home/ivc/bin/rsync-backup-client

# File paths
RM=/bin/rm
ECHO=/bin/echo
GREP=/bin/grep
LOGGER=/usr/bin/logger
TAR=/bin/tar
RSYNC=/usr/bin/rsync
CAT=/bin/cat
HOSTNAME=/bin/hostname
DATE=/bin/date
CHMOD=/bin/chmod
SSH=/usr/bin/ssh

# USAGE
if [ "$1" == "" ]; then
        $ECHO -e '\n  Usage: ./rsync-backup-client <src> <src> ... <user@backuphost>:/\n'
        exit 1;
fi

# DEBUG
debug () {
        $ECHO -e "$*" >/dev/stderr
        #$LOGGER -t rsync-backup-client "$*"
}

# REMOTE BACKUP
debug
debug ' '`$DATE +"%Y-%m-%d %H:%M:%S"`' Starting backup routine'

# The --rsync-path is set up as a backup precaution of .authorized_keys2 isn't set up properly on the server
RSYNC_ARGS="-avvR -e $SSH --numeric-ids --delete --delete-after\
 --rsync-path=/usr/home/ivc/bin/rsync-backup-server/rsync-static\
 --exclude-from=$BACKUPDIR/exclude\
 --exclude /proc/ --exclude /sys/ --exclude /dev/ --exclude /mnt/\
 $@"

debug "   Running rsync $RSYNC_ARGS"
debug

cd $BACKUPDIR
$RSYNC $RSYNC_ARGS

debug
debug ' '`$DATE +"%Y-%m-%d %H:%M:%S"`' Finished backup routine'

Password-less Login

To automate the remote backup to a central server, login has to be password-less. A good way to do that is to set up ssh to login using keys.

I like to use the ssh-keyinstall tool.

1. Download the ssh-keyinstall script by William Stearns.
2. Make it executable, chmod +x ssh-keyinstall, and as root run ./ssh-keyinstall -s <192.168.1.1> -u <backupuser> -c 'export SSH_CLIENT SSH2_CLIENT \; /usr/bin/nice /usr/home/ivc/bin/rsync-backup-server/rsync-backup-server server1'
3. The script will ask you to provide the password for the specified user to transfer and execute commands on the remote server.
4. Once the public keys and settings are set up, you should be able to run the command at the end of the process without being prompted for a login password.
5. Next time client logs in to the <backupuser> on <192.168.1.1>, only the command specified in backupuser/.ssh/authorized_keys2 (on the server) will be executed. The rsync-backup-server script takes only one argument, that is the name of the backup directory where rsync will put the files, e.g argument 'server1' will put files in /mnt/backup/server1/current/.

Make sure the authorized_keys2 file has the proper permission so that the backupuser can read the file (it can happen it's owned by root/600). A password-less login can also be setup on the backup server itself, use the same procedure above to set it up.

Linux

The Linux client script should work with most default distro installs.

• Download Linux client package

Schedule

Automatic backup is essential for a good backup routine. On Linux, crontab can be used to execute commands on specific times. I like to run the backup scripts when there is little activity, usually that is in the middle of the night.

On the clients I put this line in /etc/crontab to run it at 5 am:

0 5 * * * root /usr/home/ivc/bin/rsync-backup-client/rsync-backup-client / backupuser@192.168.1.1:/

The script will backup the entire filesystem (/) to the password-less user (backupuser) on the backup server (192.168.1.1). For best performance the clients should be scattered on different time slots.

Windows

On Windows none of the required tools are installed by default. Fortunately, there is a Unix environment emulator called Cygwin. It works seamlessly with the Windows environment and can be used to run command-line binaries and scripts.

1. Download and run the Cygwin setup program.
2. Follow the sets to get to the package selection screen and click the 'View'-button once to change to full list view.
3. In addition to the default selection, enable netcat, openssh, rsync, and nano in the list.
4. Click next and follow through to the end, open the 'Cygwin Bash Shell'.
5. Put the ssh-keyinstall and rsync-backup-client scripts in the /home/<Administrator>/rsync-backup-client directory, make them executable, chmod +x ssh-keyinstall rsync-backup-client
6. Set up the password-less login, the steps are already mentioned above, ./ssh-keyinstall -u backupuser -s 192.168.1.1 -c 'export SSH_CLIENT SSH2_CLIENT \; /usr/bin/nice /usr/home/ivc/bin/rsync-backup-server/rsync-backup-server windows'
7. If asked to set a passphrase, leave it blank

Now, edit the client script settings (backupdir, etc) using the nano editor. To backup files on the Windows drives (c:, d:, etc), the prefered way is to exclude all by default and include only the files and folders you want to backup (opposite the Linux setup). Cygwin makes the Windows drives available under the /cygdrive/ directory.

To backup everything on e.g. the d: and e: drives, run this command:

/home/Administrator/rsync-backup-client /cygdrive/d /cygdrive/e backupuser@192.168.1.1:/

A useful batch script:

@echo off
c:
chdir C:\cygwin\bin
bash --login -i /home/Administrator/rsync-backup-client/rsync-backup-client "/cygdrive/c/" backupuser@192.168.1.100:/
pause

• Download Windows (Cygwin) client package

Mac OS X

The Mac OS X client script works mostly the same way as the Linux version.

• Download Mac OS X client package

File Inclusion/Exclusion

A normal run will include all files by default and excluded files can be listed in a 'exclude'-file located in the same directory as the rsync-backup-client script. Special files and system devices (dev, sys, proc) are already excluded in the rsync command-line string.

Files to include (normally only / is spesificed to include all files by default):

/usr/home/ivc/bin/rsync-backup-client/rsync-backup-client /usr/home /var/lib /var/log backupuser@192.168.1.1:/

Spaces in the directory name need to be triple escaped or double quoted or a variation, see the rsync FAQ.

Files to exclude (listed in the 'exclude'-file):

/usr/src/
/var/cache/apt/archives/
/usr/games/

References

• rsync 4.3a source code (backup)
• Using truecrypt-installer to help install Truecrypt for Debian
• Paranoides Debian - Verschlüsseln mit TrueCrypt
• Passwordless login (ssh-keygen, rsa keys, etc.)