Merge a2098b1ace into 0293e04311

management/backup.py

@@ -10,20 +10,38 @@
 
 import os, os.path, shutil, glob, re, datetime
 import dateutil.parser, dateutil.relativedelta, dateutil.tz
+import rtyaml
+import logging
 
 from utils import exclusive_process, load_environment, shell, wait_for_service
 
-# Destroy backups when the most recent increment in the chain
+# Root folder
-# that depends on it is this many days old.
+backup_root = os.path.join(load_environment()["STORAGE_ROOT"], 'backup')
-keep_backups_for_days = 3
+
+# Setup logging
+log_path = os.path.join(backup_root, 'backup.log')
+logging.basicConfig(filename=log_path, format='%(levelname)s at %(asctime)s: %(message)s')
+
+# Default settings
+# min_age_in_days is the minimum amount of days a backup will be kept before
+# it is eligble to be removed. Backups might be kept much longer if there's no
+# new full backup yet.
+default_config = {
+	"min_age_in_days": 3,
+	"target": "file://" + os.path.join(backup_root, 'encrypted')
+}
 
 def backup_status(env):
 	# What is the current status of backups?
-	# Loop through all of the files in STORAGE_ROOT/backup/encrypted to
+	# Query duplicity to get a list of all backups.
-	# get a list of all of the backups taken and sum up file sizes to
+	# Use the number of volumes to estimate the size.
-	# see how large the storage is.
+	config = get_backup_config()
-
 	now = datetime.datetime.now(dateutil.tz.tzlocal())
+
+	backups = { }
+	backup_dir = os.path.join(backup_root, 'encrypted')
+	backup_cache_dir = os.path.join(backup_root, 'cache')
+
 	def reldate(date, ref, clip):
 		if ref < date: return clip
 		rd = dateutil.relativedelta.relativedelta(ref, date)
@@ -34,27 +52,37 @@ def backup_status(env):
 		if rd.days == 1: return "%d day, %d hours" % (rd.days, rd.hours)
 		return "%d hours, %d minutes" % (rd.hours, rd.minutes)
 
-	backups = { }
+	def parse_line(line):
-	backup_root = os.path.join(env["STORAGE_ROOT"], 'backup')
+		keys = line.strip().split()
-	backup_dir = os.path.join(backup_root, 'encrypted')
+		date = dateutil.parser.parse(keys[1])
-	os.makedirs(backup_dir, exist_ok=True) # os.listdir fails if directory does not exist
+		return {
-	for fn in os.listdir(backup_dir):
+			"date": keys[1],
-		m = re.match(r"duplicity-(full|full-signatures|(inc|new-signatures)\.(?P<incbase>\d+T\d+Z)\.to)\.(?P<date>\d+T\d+Z)\.", fn)
-		if not m: raise ValueError(fn)
-
-		key = m.group("date")
-		if key not in backups:
-			date = dateutil.parser.parse(m.group("date"))
-			backups[key] = {
-				"date": m.group("date"),
 			"date_str": date.strftime("%x %X"),
 			"date_delta": reldate(date, now, "the future?"),
-				"full": m.group("incbase") is None,
+			"full": keys[0] == "full",
-				"previous": m.group("incbase"),
+			"size": int(keys[2]) * 250 * 1000000,
-				"size": 0,
 		}
 
-		backups[key]["size"] += os.path.getsize(os.path.join(backup_dir, fn))
+	# Get duplicity collection status
+	collection_status = shell('check_output', [
+		"/usr/bin/duplicity",
+		"collection-status",
+		"--archive-dir", backup_cache_dir,
+		"--log-file", os.path.join(backup_root, "duplicity_status"),
+		"--gpg-options", "--cipher-algo=AES256",
+		"--log-fd", "1",
+		config["target"],
+		],
+		get_env())
+
+	# Split multi line string into list
+	collection_status = collection_status.split('\n')
+
+	# Parse backup data from status file
+	for line in collection_status:
+		if line.startswith(" full") or line.startswith(" inc"):
+			backup = parse_line(line)
+			backups[backup["date"]] = backup
 
 	# Ensure the rows are sorted reverse chronologically.
 	# This is relied on by should_force_full() and the next step.
@@ -79,11 +107,11 @@ def backup_status(env):
 	# when the threshold is met.
 	deleted_in = None
 	if incremental_count > 0 and first_full_size is not None:
-		deleted_in = "approx. %d days" % round(keep_backups_for_days + (.5 * first_full_size - incremental_size) / (incremental_size/incremental_count) + .5)
+		deleted_in = "approx. %d days" % round(config["min_age_in_days"] + (.5 * first_full_size - incremental_size) / (incremental_size/incremental_count) + .5)
 
 	# When will a backup be deleted?
 	saw_full = False
-	days_ago = now - datetime.timedelta(days=keep_backups_for_days)
+	days_ago = now - datetime.timedelta(days=config["min_age_in_days"])
 	for bak in backups:
 		if deleted_in:
 			# Subsequent backups are deleted when the most recent increment
@@ -124,12 +152,39 @@ def should_force_full(env):
 		# (I love for/else blocks. Here it's just to show off.)
 		return True
 
+def get_passphrase():
+	# Get the encryption passphrase. secret_key.txt is 2048 random
+	# bits base64-encoded and with line breaks every 65 characters.
+	# gpg will only take the first line of text, so sanity check that
+	# that line is long enough to be a reasonable passphrase. It
+	# only needs to be 43 base64-characters to match AES256's key
+	# length of 32 bytes.
+	with open(os.path.join(backup_root, 'secret_key.txt')) as f:
+		passphrase = f.readline().strip()
+	if len(passphrase) < 43: raise Exception("secret_key.txt's first line is too short!")
+	
+	return passphrase
+
+def get_env():
+	config = get_backup_config()
+	
+	env = { "PASSPHRASE" : get_passphrase() }
+	
+	if get_target_type(config) == 's3':
+		env["AWS_ACCESS_KEY_ID"] = config["target_user"]
+		env["AWS_SECRET_ACCESS_KEY"] = config["target_pass"]
+	
+	return env
+	
+def get_target_type(config):
+	protocol = config["target"].split(":")[0]
+	return protocol
+	
 def perform_backup(full_backup):
 	env = load_environment()
 
 	exclusive_process("backup")
-
+	config = get_backup_config()
-	backup_root = os.path.join(env["STORAGE_ROOT"], 'backup')
 	backup_cache_dir = os.path.join(backup_root, 'cache')
 	backup_dir = os.path.join(backup_root, 'encrypted')
 
@@ -169,17 +224,6 @@ def perform_backup(full_backup):
 	shell('check_call', ["/usr/sbin/service", "dovecot", "stop"])
 	shell('check_call', ["/usr/sbin/service", "postfix", "stop"])
 
-	# Get the encryption passphrase. secret_key.txt is 2048 random
-	# bits base64-encoded and with line breaks every 65 characters.
-	# gpg will only take the first line of text, so sanity check that
-	# that line is long enough to be a reasonable passphrase. It
-	# only needs to be 43 base64-characters to match AES256's key
-	# length of 32 bytes.
-	with open(os.path.join(backup_root, 'secret_key.txt')) as f:
-		passphrase = f.readline().strip()
-	if len(passphrase) < 43: raise Exception("secret_key.txt's first line is too short!")
-	env_with_passphrase = { "PASSPHRASE" : passphrase }
-
 	# Run a backup of STORAGE_ROOT (but excluding the backups themselves!).
 	# --allow-source-mismatch is needed in case the box's hostname is changed
 	# after the first backup. See #396.
@@ -188,14 +232,18 @@ def perform_backup(full_backup):
 			"/usr/bin/duplicity",
 			"full" if full_backup else "incr",
 			"--archive-dir", backup_cache_dir,
+			"--asynchronous-upload",
 			"--exclude", backup_root,
 			"--volsize", "250",
 			"--gpg-options", "--cipher-algo=AES256",
 			env["STORAGE_ROOT"],
-			"file://" + backup_dir,
+			config["target"],
 			"--allow-source-mismatch"
 			],
-			env_with_passphrase)
+			get_env())
+		logging.info("Backup successful")
+	except Exception as e:
+		logging.warn("Backup failed: {0}".format(e))
 	finally:
 		# Start services again.
 		shell('check_call', ["/usr/sbin/service", "dovecot", "start"])
@@ -207,32 +255,39 @@ def perform_backup(full_backup):
 
 	# Remove old backups. This deletes all backup data no longer needed
 	# from more than 3 days ago.
+	try:
 		shell('check_call', [
 			"/usr/bin/duplicity",
 			"remove-older-than",
-		"%dD" % keep_backups_for_days,
+			"%dD" % config["min_age_in_days"],
 			"--archive-dir", backup_cache_dir,
 			"--force",
-		"file://" + backup_dir
+			config["target"]
 			],
-		env_with_passphrase)
+			get_env())
+	except Exception as e:
+		logging.warn("Removal of old backups failed: {0}".format(e))
 
 	# From duplicity's manual:
 	# "This should only be necessary after a duplicity session fails or is
 	# aborted prematurely."
 	# That may be unlikely here but we may as well ensure we tidy up if
 	# that does happen - it might just have been a poorly timed reboot.
+	try:
 		shell('check_call', [
 			"/usr/bin/duplicity",
 			"cleanup",
 			"--archive-dir", backup_cache_dir,
 			"--force",
-		"file://" + backup_dir
+			config["target"]
 			],
-		env_with_passphrase)
+			get_env())
+	except Exception as e:
+		logging.warn("Cleanup of backups failed: {0}".format(e))
 
 	# Change ownership of backups to the user-data user, so that the after-bcakup
 	# script can access them.
+	if get_target_type(config) == 'file':
 		shell('check_call', ["/bin/chown", "-R", env["STORAGE_USER"], backup_dir])
 
 	# Execute a post-backup script that does the copying to a remote server.
@@ -241,8 +296,8 @@ def perform_backup(full_backup):
 	post_script = os.path.join(backup_root, 'after-backup')
 	if os.path.exists(post_script):
 		shell('check_call',
-			['su', env['STORAGE_USER'], '-c', post_script],
+			['su', env['STORAGE_USER'], '-c', post_script, config["target"]],
-			env=env)
+			env=get_env())
 
 	# Our nightly cron job executes system status checks immediately after this
 	# backup. Since it checks that dovecot and postfix are running, block for a
@@ -253,10 +308,9 @@ def perform_backup(full_backup):
 
 def run_duplicity_verification():
 	env = load_environment()
-	backup_root = os.path.join(env["STORAGE_ROOT"], 'backup')
+	config = get_backup_config()
 	backup_cache_dir = os.path.join(backup_root, 'cache')
-	backup_dir = os.path.join(backup_root, 'encrypted')
+
-	env_with_passphrase = { "PASSPHRASE" : open(os.path.join(backup_root, 'secret_key.txt')).read() }
 	shell('check_call', [
 		"/usr/bin/duplicity",
 		"--verbosity", "info",
@@ -264,9 +318,52 @@ def run_duplicity_verification():
 		"--compare-data",
 		"--archive-dir", backup_cache_dir,
 		"--exclude", backup_root,
-		"file://" + backup_dir,
+		config["target"],
 		env["STORAGE_ROOT"],
-	], env_with_passphrase)
+	], get_env())
+
+
+def backup_set_custom(target, target_user, target_pass, min_age):
+	config = get_backup_config()
+	
+	# min_age must be an int
+	if isinstance(min_age, str):
+		min_age = int(min_age)
+
+	config["target"] = target
+	config["target_user"] = target_user
+	config["target_pass"] = target_pass
+	config["min_age_in_days"] = min_age
+	
+	write_backup_config(config)
+
+	return "Updated backup config"
+	
+def get_backup_config():
+	try:
+		config = rtyaml.load(open(os.path.join(backup_root, 'custom.yaml')))
+		if not isinstance(config, dict): raise ValueError() # caught below
+	except:
+		return default_config
+
+	merged_config = default_config.copy()
+	merged_config.update(config)
+
+	return config
+	
+def get_backup_log():
+	try:
+		fileHandle = open(log_path, 'r')
+		log = fileHandle.read()
+		fileHandle.close()
+	except:
+		log = ""
+
+	return log
+
+def write_backup_config(newconfig):
+	with open(os.path.join(backup_root, 'custom.yaml'), "w") as f:
+		f.write(rtyaml.dump(newconfig))
 
 if __name__ == "__main__":
 	import sys
@@ -274,6 +371,7 @@ if __name__ == "__main__":
 		# Run duplicity's verification command to check a) the backup files
 		# are readable, and b) report if they are up to date.
 		run_duplicity_verification()
+
 	else:
 		# Perform a backup. Add --full to force a full backup rather than
 		# possibly performing an incremental backup.

management/daemon.py

@@ -4,7 +4,7 @@ import os, os.path, re, json
 
 from functools import wraps
 
-from flask import Flask, request, render_template, abort, Response, send_from_directory
+from flask import Flask, request, render_template, abort, Response, send_from_directory, jsonify
 
 import auth, utils
 from mailconfig import get_mail_users, get_mail_users_ex, get_admins, add_mail_user, set_mail_password, remove_mail_user
@@ -399,8 +399,25 @@ def do_updates():
 @app.route('/system/backup/status')
 @authorized_personnel_only
 def backup_status():
-	from backup import backup_status
+	from backup import backup_status, get_backup_log
-	return json_response(backup_status(env))
+	return jsonify(backups=backup_status(env), log=get_backup_log())
+
+@app.route('/system/backup/config', methods=["GET"])
+@authorized_personnel_only
+def backup_get_custom():
+	from backup import get_backup_config
+	return jsonify(get_backup_config())
+
+@app.route('/system/backup/config', methods=["POST"])
+@authorized_personnel_only
+def backup_set_custom():
+	from backup import backup_set_custom
+	return json_response(backup_set_custom(
+		request.form.get('target', ''),
+		request.form.get('target_user', ''),
+		request.form.get('target_pass', ''),
+		request.form.get('min_age', '')
+	))
 
 # MUNIN
 
@@ -432,4 +449,3 @@ if __name__ == '__main__':
 
 	# Start the application server. Listens on 127.0.0.1 (IPv4 only).
 	app.run(port=10222)
-

management/templates/system-backup.html

@@ -7,12 +7,53 @@
 
 <h3>Copying Backup Files</h3>
 
-<p>The box makes an incremental backup each night. The backup is stored on the machine itself. You are responsible for copying the backup files off of the machine.</p>
+<p>The box makes an incremental backup each night. By default the backup is stored on the machine itself, but you can also have it stored on Amazon S3</p>
-
-<p>Many cloud providers make this easy by allowing you to take snapshots of the machine's disk.</p>
 
 <p>You can also use SFTP (FTP over SSH) to copy files from <tt id="backup-location"></tt>. These files are encrypted, so they are safe to store anywhere. Copy the encryption password from <tt id="backup-encpassword-file"></tt> also but keep it in a safe location.</p>
 
+<h3>Backup Configuration</h3>
+
+<form class="form-horizontal" role="form" onsubmit="set_custom_backup(); return false;">
+  <div class="form-group">
+    <label for="target" class="col-sm-2 control-label">Backup target</label>
+    <div class="col-sm-2">
+      <select class="form-control" rows="1" id="target-type" onchange="toggle_form()">
+        <option value="file">Store locally</option>
+        <option value="s3">Amazon S3</option>
+      </select>
+    </div>
+  </div>
+  <div class="form-group">
+    <label for="target" class="col-sm-2 control-label">How many days should backups be kept?</label>
+    <div class="col-sm-8">
+      <input type="number" class="form-control" rows="1" id="min-age"></input>
+    </div>
+  </div>
+  <div class="form-group form-advanced">
+    <label for="target" class="col-sm-2 control-label">S3 URL</label>
+    <div class="col-sm-8">
+      <input type="text" placeholder="s3://s3-eu-central-1.amazonaws.com/bucket-name" class="form-control" rows="1" id="target"></textarea>
+    </div>
+  </div>
+  <div class="form-group form-advanced">
+    <label for="target-user" class="col-sm-2 control-label">S3&nbsp;Key</label>
+    <div class="col-sm-8">
+      <input type="text" class="form-control" rows="1" id="target-user"></input>
+    </div>
+  </div>
+  <div class="form-group form-advanced">
+    <label for="target-pass" class="col-sm-2 control-label">S3&nbsp;Secret</label>
+    <div class="col-sm-8">
+      <input type="text" class="form-control" rows="1" id="target-pass"></input>
+    </div>
+  </div>
+  <div class="form-group">
+    <div class="col-sm-offset-2 col-sm-11">
+      <button id="set-s3-backup-button" type="submit" class="btn btn-primary">Save</button>
+    </div>
+  </div>
+</form>
+
 <h3>Current Backups</h3>
 
 <p>The backup directory currently contains the backups listed below. The total size on disk of the backups is currently <span id="backup-total-size"></span>.</p>
@@ -28,7 +69,21 @@
   </tbody>
 </table>
 
+<h3>Backup logs</h3>
+<pre id="backup-log"></pre>
+
+
 <script>
+
+function toggle_form() {
+  var target_type = $("#target-type").val();
+  if (target_type == 'file') {
+    $(".form-advanced").hide();
+  } else {
+    $(".form-advanced").show();
+  }
+}
+
 function nice_size(bytes) {
   var powers = ['bytes', 'KB', 'MB', 'GB', 'TB'];
   while (true) {
@@ -46,28 +101,32 @@ function nice_size(bytes) {
 }
 
 function show_system_backup() {
+  show_custom_backup()
+  
   $('#backup-status tbody').html("<tr><td colspan='2' class='text-muted'>Loading...</td></tr>")
   api(
     "/system/backup/status",
     "GET",
     { },
     function(r) {
-      $('#backup-location').text(r.directory);
+      var status = r.backups;
-      $('#backup-encpassword-file').text(r.encpwfile);
+      var log = r.log;
+      $('#backup-location').text(status.directory);
+      $('#backup-encpassword-file').text(status.encpwfile);
 
       $('#backup-status tbody').html("");
       var total_disk_size = 0;
 
-      if (r.backups.length == 0) {
+      if (status.backups.length == 0) {
         var tr = $('<tr><td colspan="3">No backups have been made yet.</td></tr>');
         $('#backup-status tbody').append(tr);
       }
 
-      for (var i = 0; i < r.backups.length; i++) {
+      for (var i = 0; i < status.backups.length; i++) {
-        var b = r.backups[i];
+        var b = status.backups[i];
         var tr = $('<tr/>');
         if (b.full) tr.addClass("full-backup");
-        tr.append( $('<td/>').text(b.date_str + " " + r.tz) );
+        tr.append( $('<td/>').text(b.date_str + " " + status.tz) );
         tr.append( $('<td/>').text(b.date_delta + " ago") );
         tr.append( $('<td/>').text(b.full ? "full" : "increment") );
         tr.append( $('<td style="text-align: right"/>').text( nice_size(b.size)) );
@@ -81,6 +140,49 @@ function show_system_backup() {
       }
 
       $('#backup-total-size').text(nice_size(total_disk_size));
+      
+      $('#backup-log').text(log || 'No backup logs yet');
     })
 }
+
+function show_custom_backup() {
+    api(
+      "/system/backup/config",
+      "GET",
+      { },
+      function(r) {
+        var target_type = r.target.split(':')[0]
+        $("#target").val(r.target);
+        $("#target-type").val(target_type);
+        $("#target-user").val(r.target_user);
+        $("#target-pass").val(r.target_pass);
+        $("#min-age").val(r.min_age_in_days);
+        toggle_form()
+      })
+}
+
+function set_custom_backup() {
+  var target = $("#target").val();
+  var target_type = $("#target-type").val();
+  var target_user = $("#target-user").val();
+  var target_pass = $("#target-pass").val();
+  var min_age = $("#min-age").val();
+  api(
+    "/system/backup/config",
+    "POST",
+    {
+      target: target,
+      target_user: target_user,
+      target_pass: target_pass,
+      min_age: min_age
+    },
+    function(r) {
+      // Responses are multiple lines of pre-formatted text.
+      show_modal_error("Backup configuration", $("<pre/>").text(r));
+    },
+    function(r) {
+      show_modal_error("Backup configuration (error)", r);
+    });
+  return false;
+}
 </script>

setup/management.sh

@@ -4,8 +4,12 @@ source setup/functions.sh
 
 # build-essential libssl-dev libffi-dev python3-dev: Required to pip install cryptography.
 apt_install python3-flask links duplicity libyaml-dev python3-dnspython python3-dateutil \
-	build-essential libssl-dev libffi-dev python3-dev
+	build-essential libssl-dev libffi-dev python3-dev python-pip
-hide_output pip3 install --upgrade rtyaml email_validator idna cryptography
+hide_output pip3 install --upgrade rtyaml email_validator idna cryptography boto
+
+# duplicity uses python 2 so we need to use the python 2 package of boto
+hide_output pip install --upgrade boto
+
 # email_validator is repeated in setup/questions.sh
 
 # Create a backup directory and a random key for encrypting backups.