320 lines
8.4 KiB
Markdown
Raw Normal View History

2020-08-27 11:18:39 -04:00
<!--
Title: How to backup and encrypt data privately and securely using rsync and VeraCrypt on macOS
Description: Learn how to backup and encrypt data privately and securely using rsync and VeraCrypt on macOS.
Author: Sun Knudsen <https://github.com/sunknudsen>
Contributors: Sun Knudsen <https://github.com/sunknudsen>
Reviewers: Alex Anderson <https://github.com/Serpent27>
2020-08-27 11:18:39 -04:00
Publication date: 2020-08-26T14:07:36.767Z
-->
# How to backup and encrypt data privately and securely using rsync and VeraCrypt on macOS
2020-08-28 09:09:44 -04:00
[![How to backup and encrypt data privately and securely using rsync and VeraCrypt on macOS - YouTube](how-to-backup-and-encrypt-data-privately-and-securely-using-rsync-and-veracrypt-on-macos.png)](https://www.youtube.com/watch?v=1cz_ViFB6eE "How to backup and encrypt data privately and securely using rsync and VeraCrypt on macOS - YouTube")
2020-09-10 10:13:53 -04:00
> Heads up: when using storage devices with wear-leveling (most flash storage devices), it is not possible to securely change password once it has been set (see [Wear-Leveling](https://www.veracrypt.fr/en/Wear-Leveling.html)).
2020-08-27 11:18:39 -04:00
## Requirements
- Computer running macOS Mojave or Catalina
2020-09-10 10:13:53 -04:00
- USB flash drive or SD card formatted using FAT (4GiB file size limit) or exFAT filesystem (see [Journaling File Systems](https://www.veracrypt.fr/en/Journaling%20File%20Systems.html))
2020-08-27 11:18:39 -04:00
## Caveats
- When copy/pasting commands that start with `$`, strip out `$` as this character is not part of the command
- When copy/pasting commands that start with `cat << "EOF"`, select all lines at once (from `cat << "EOF"` to `EOF` inclusively) as they are part of the same (single) command
## Setup guide
2020-09-04 16:01:40 -04:00
### Step 1: download and install [FUSE for macOS](https://osxfuse.github.io/)
2020-08-27 11:18:39 -04:00
Go to https://osxfuse.github.io/, download and install latest release.
2020-09-10 10:13:53 -04:00
### Step 2: install [Homebrew](https://brew.sh/)
```shell
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
```
### Step 3: disable Homebrew analytics
2020-08-27 11:18:39 -04:00
2020-09-10 10:13:53 -04:00
```shell
brew analytics off
```
### Step 4: install [GnuPG](https://gnupg.org/)
```shell
brew install gnupg
```
2020-08-27 11:18:39 -04:00
2020-09-10 10:13:53 -04:00
### Step 5: import VeraCrypts public key
2020-08-27 11:18:39 -04:00
```console
$ gpg --keyserver hkps://keys.openpgp.org --recv-keys 0x821ACD02680D16DE
gpg: key 0x821ACD02680D16DE: public key "VeraCrypt Team (2018 - Supersedes Key ID=0x54DDD393) <veracrypt@idrix.fr>" imported
gpg: Total number processed: 1
gpg: imported: 1
```
2020-09-10 10:13:53 -04:00
### Step 6: download [VeraCrypt](https://www.veracrypt.fr/en/Home.html)
2020-08-27 11:18:39 -04:00
Go to https://www.veracrypt.fr/en/Downloads.html and download latest release and its associated PGP signature to `~/Downloads` folder.
2020-09-10 10:13:53 -04:00
### Step 7: verify VeraCrypt release signature using GnuPG
2020-08-27 11:18:39 -04:00
Replace `VeraCrypt_1.24-Update7` with current release.
```console
$ gpg --verify ~/Downloads/VeraCrypt_1.24-Update7.dmg.sig
gpg: assuming signed data in '/Users/sunknudsen/Downloads/VeraCrypt_1.24-Update7.dmg'
gpg: Signature made Sat 8 Aug 14:20:27 2020 EDT
gpg: using RSA key 5069A233D55A0EEB174A5FC3821ACD02680D16DE
gpg: Good signature from "VeraCrypt Team (2018 - Supersedes Key ID=0x54DDD393) <veracrypt@idrix.fr>" [unknown]
gpg: WARNING: This key is not certified with a trusted signature!
gpg: There is no indication that the signature belongs to the owner.
Primary key fingerprint: 5069 A233 D55A 0EEB 174A 5FC3 821A CD02 680D 16DE
```
Good signature
👍
2020-09-10 10:13:53 -04:00
### Step 8: install VeraCrypt
2020-08-27 11:18:39 -04:00
2020-09-10 10:13:53 -04:00
### Step 9: create and test VeraCrypt symlink
2020-08-27 11:18:39 -04:00
```console
$ ln -s /Applications/VeraCrypt.app/Contents/MacOS/VeraCrypt /usr/local/bin/veracrypt
$ veracrypt --text --version
VeraCrypt 1.24-Update7
```
VeraCrypt 1.24-Update7
👍
2020-09-10 10:13:53 -04:00
### Step 10: set temporary environment variable
2020-08-27 11:18:39 -04:00
2020-09-10 10:13:53 -04:00
> Heads up: using `b` as encrypted volume file name to make things inconspicuous.
2020-08-27 11:18:39 -04:00
`BACKUP_VOLUME_PATH` path to VeraCrypt volume
```shell
2020-09-10 10:13:53 -04:00
BACKUP_VOLUME_PATH="/Volumes/Samsung BAR/b"
2020-08-27 11:18:39 -04:00
```
2020-09-10 10:13:53 -04:00
### Step 11: create encrypted volume
2020-08-27 11:18:39 -04:00
> Heads up: volume size cannot be increased later.
> Heads up: Mac OS Extended filesystem required on macOS.
```console
$ veracrypt --text --create "$BACKUP_VOLUME_PATH"
Volume type:
1) Normal
2) Hidden
Select [1]:
Enter volume size (sizeK/size[M]/sizeG): 1G
Encryption Algorithm:
1) AES
2) Serpent
3) Twofish
4) Camellia
5) Kuznyechik
6) AES(Twofish)
7) AES(Twofish(Serpent))
8) Camellia(Kuznyechik)
9) Camellia(Serpent)
10) Kuznyechik(AES)
11) Kuznyechik(Serpent(Camellia))
12) Kuznyechik(Twofish)
13) Serpent(AES)
14) Serpent(Twofish(AES))
15) Twofish(Serpent)
2020-09-10 10:13:53 -04:00
Select [7]:
2020-08-27 11:18:39 -04:00
Hash algorithm:
1) SHA-512
2) Whirlpool
3) SHA-256
4) Streebog
Select [1]:
Filesystem:
1) None
2) FAT
3) Mac OS Extended
4) exFAT
5) APFS
Select [3]:
Enter password:
Re-enter password:
Enter PIM:
Enter keyfile path [none]:
Please type at least 320 randomly chosen characters and then press Enter:
2020-09-10 10:13:53 -04:00
Done: 100.000% Speed: 24 MiB/s Left: 0 s
2020-08-27 11:18:39 -04:00
The VeraCrypt volume has been successfully created.
```
2020-09-10 10:13:53 -04:00
### Step 12 (optional): mount, rename and dismount encrypted volume
2020-08-27 11:18:39 -04:00
By default, VeraCrypt encrypted volumes with Mac OS Extended filesystem are named "untitled".
2020-08-27 11:18:39 -04:00
#### Mount encrypted volume
```console
$ veracrypt --text --mount --pim 0 --keyfiles "" --protect-hidden no "$BACKUP_VOLUME_PATH" /Volumes/Backup
2020-09-10 10:13:53 -04:00
Enter password for /Volumes/Samsung BAR/b:
2020-08-27 11:18:39 -04:00
```
#### Rename encrypted volume
```console
$ diskutil rename "untitled" "Backup"
Volume on disk3 renamed to Backup
```
#### Dismount encrypted volume
```shell
veracrypt --text --dismount "$BACKUP_VOLUME_PATH"
```
2020-09-10 10:13:53 -04:00
### Step 13: create `/usr/local/bin/backup.sh` script
2020-08-27 11:18:39 -04:00
```shell
cat << EOF > /usr/local/bin/backup.sh
2020-08-27 11:18:39 -04:00
#! /bin/sh
2020-09-10 10:13:53 -04:00
set -e
function cleanup()
{
if [ -d "/Volumes/Backup" ]; then
veracrypt --text --dismount "$BACKUP_VOLUME_PATH"
fi
}
trap cleanup ERR INT
2020-08-27 11:18:39 -04:00
veracrypt --text --mount --pim 0 --keyfiles "" --protect-hidden no "$BACKUP_VOLUME_PATH" /Volumes/Backup
2020-09-10 10:13:53 -04:00
mkdir -p /Volumes/Backup/Versioning
2020-08-27 11:18:39 -04:00
declare -a files=(
"/Users/$(whoami)/.gnupg"
"/Users/$(whoami)/.ssh"
"/Users/$(whoami)/Library/Keychains"
)
for file in "\${files[@]}"; do
2020-09-10 10:13:53 -04:00
rsync -axRS --delete --backup --backup-dir /Volumes/Backup/Versioning --suffix=\$(date +'.%F_%H-%M') "\$file" /Volumes/Backup
2020-08-27 11:18:39 -04:00
done
2020-09-10 10:13:53 -04:00
if [ "\$(find /Volumes/Backup/Versioning -type f -ctime +90)" != "" ]; then
printf "Do you wish to prune versions older than 90 days (y or n)? "
read -r answer
if [ "\$answer" = "y" ]; then
find /Volumes/Backup/Versioning -type f -ctime +90 -delete
find /Volumes/Backup/Versioning -type d -empty -delete
fi
fi
open /Volumes/Backup
2020-09-10 10:13:53 -04:00
printf "Inspect backup and press enter"
2020-08-27 11:18:39 -04:00
read -r answer
veracrypt --text --dismount "$BACKUP_VOLUME_PATH"
2020-09-10 10:13:53 -04:00
printf "Generate hash (y or n)? "
read -r answer
if [ "\$answer" = "y" ]; then
openssl dgst -sha512 "$BACKUP_VOLUME_PATH"
fi
printf "%s\n" "Done"
2020-08-27 11:18:39 -04:00
EOF
chmod +x /usr/local/bin/backup.sh
2020-08-27 11:18:39 -04:00
```
2020-09-10 10:13:53 -04:00
### Step 14: edit backup script
2020-08-27 11:18:39 -04:00
```shell
vi /usr/local/bin/backup.sh
2020-08-27 11:18:39 -04:00
```
2020-08-28 09:09:44 -04:00
Press <kbd>i</kbd> to enter insert mode, edit backup script, press <kbd>esc</kbd> to exit insert mode and press <kbd>shift+z+z</kbd> to save and exit.
2020-08-27 11:18:39 -04:00
2020-09-10 10:13:53 -04:00
### Step 15: create `/usr/local/bin/check.sh` script
```shell
cat << EOF > /usr/local/bin/check.sh
#! /bin/sh
set -e
red=$'\e[1;31m'
nc=$'\e[0m'
printf "Backup hash: "
read -r previous
current=\$(openssl dgst -sha512 "$BACKUP_VOLUME_PATH")
if [ "\$current" != "\$previous" ]; then
printf "\${red}%s\${nc}\n" "Integrity check failed"
exit 1
fi
printf "%s\n" "OK"
EOF
chmod +x /usr/local/bin/check.sh
```
2020-08-27 11:18:39 -04:00
## Usage guide
2020-09-10 10:13:53 -04:00
### Backup
2020-08-27 11:18:39 -04:00
```console
$ backup.sh
2020-09-10 10:13:53 -04:00
Enter password for /Volumes/Samsung BAR/b:
2020-08-27 11:18:39 -04:00
Inspect backup and press enter
2020-09-10 10:13:53 -04:00
Generate hash (y or n)? y
SHA512(/Volumes/Samsung BAR/b)= 281a3b0afec6708eff9566effdfa67de357933527688dfa2dfabae5dda5b7681f0fb84f6cfec6c3f7ac20246517f18f40babbd4f337b254a55de30ff67d6dd2e
2020-08-27 11:18:39 -04:00
Done
```
Done
👍
2020-09-10 10:13:53 -04:00
### Check integrity of backup
```console
$ check.sh
Backup hash: SHA512(/Volumes/Samsung BAR/b)= 281a3b0afec6708eff9566effdfa67de357933527688dfa2dfabae5dda5b7681f0fb84f6cfec6c3f7ac20246517f18f40babbd4f337b254a55de30ff67d6dd2e
OK
```
OK
👍
You should be careful to ensure the hash is not modified by an attacker, since this would allow [tampering with the backup](https://crypto.stackexchange.com/questions/83776/should-i-be-worried-about-xts-tampering-when-encrypting-backups-using-veracrypt/83782#83782). One good way to do this is to use an [HMAC](https://en.wikipedia.org/wiki/HMAC) hash instead of just hashing the backup, or to simply store a copy of the hash securely.
Putting the hash in another VeraCrypt container would be enough, assuming you use the standard XTS mode.