darkofabijan-astrails-safe 0.2.8

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Astrails Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,237 @@
+astrails-safe
+=============
+
+Simple database and filesystem backups with S3 and Rackspace Cloud Files support (with optional encryption)
+
+* Home: [http://astrails.com/opensource/astrails-safe](http://astrails.com/opensource/astrails-safe)
+* Code: [http://github.com/astrails/safe](http://github.com/astrails/safe)
+* Blog: [http://blog.astrails.com/astrails-safe](http://blog.astrails.com/astrails-safe)
+
+
+Motivation
+----------
+
+We needed a backup solution that will satisfy the following requirements:
+
+* opensource
+* simple to install and configure
+* support for simple ‘tar’ backups of directories (with includes/excludes)
+* support for simple mysqldump of mysql databases
+* support for symmetric or public key encryption
+* support for local filesystem, Amazon S3, and Rackspace Cloud Files for storage
+* support for backup rotation. we don’t want backups filling all the diskspace or cost a fortune on S3 or Cloud Files
+
+And since we didn't find any, we wrote our own :)
+
+Contributions
+-------------
+
+The following functionality was contributed by astrails-safe users:
+
+* PostgreSQL dump using `pg_dump` (by Mark Mansour <mark@stateofflux.com>)
+* Subversion dump using svndump (by Richard Luther <richard.luther@gmail.com>)
+* SFTP remote storage (by Adam <adam@mediadrive.ca>)
+* benchmarking output (By Neer)
+* README fixes (by Bobby Wilson)
+* improved config file parsing (by Fedor Kocherga <fkocherga@gmail.com>)
+* mysql password file quoting (by Jonathan Sutherland <jonathan.sutherland@gmail.com>)
+* Rackspace Cloud Files support (by H. Wade Minter <minter@lunenburg.org>)
+
+Thanks to all :)
+
+Installation
+------------
+
+    sudo gem install astrails-safe --source http://gemcutter.org
+
+Reporting problems
+------------------
+
+Please report problems at the [Issues tracker](http://github.com/astrails/safe/issues)
+
+Usage
+-----
+
+    Usage:
+       astrails-safe [OPTIONS] CONFIG_FILE
+    Options:
+      -h, --help           This help screen
+      -v, --verbose        be verbose, duh!
+      -n, --dry-run        just pretend, don't do anything.
+      -L, --local          skip remote storage, only do local backups
+
+Note: CONFIG\_FILE will be created from template if missing
+
+Encryption
+----------
+
+If you want to encrypt your backups you have 2 options:
+* use simple password encryption
+* use GPG public key encryption
+
+> IMPORTANT: some gpg installations automatically set 'use-agent' option in the default
+> configuration file that is created when you run gpg for the first time. This will cause
+> gpg to fail on the 2nd run if you don't have the agent running. The result is that
+> 'astrails-safe' will work ONCE when you manually test it and then fail on any subsequent run.
+> The solution is to remove the 'use-agent' from the config file (usually /root/.gnupg/gpg.conf)
+> To mitigate this problem for the gpg 1.x series '--no-use-agent' option is added by defaults
+> to the autogenerated config file, but for gpg2 is doesn't work. as the manpage says it:
+> "This is dummy option. gpg2 always requires the agent." :(
+
+For simple password, just add password entry in gpg section.
+For public key encryption you will need to create a public/secret keypair.
+
+We recommend to create your GPG keys only on your local machine and then
+transfer your public key to the server that will do the backups.
+
+This way the server will only know how to encrypt the backups but only you
+will be able to decrypt them using the secret key you have locally. Of course
+you MUST backup your backup encryption key :)
+We recommend also pringing the hard paper copy of your GPG key 'just in case'.
+
+The procedure to create and transfer the key is as follows:
+
+1. run 'gpg --gen-key' on your local machine and follow onscreen instructions to create the key
+   (you can accept all the defaults).
+
+2. extract your public key into a file (assuming you used test@example.com as your key email):
+   `gpg -a --export test@example.com > test@example.com.pub`
+
+3. transfer public key to the server
+   `scp test@example.com.pub root@example.com:`
+
+4. import public key on the remote system:
+
+    $ gpg --import test@example.com.pub
+    gpg: key 45CA9403: public key "Test Backup <test@example.com>" imported
+    gpg: Total number processed: 1
+    gpg:               imported: 1
+
+5. since we don't keep the secret part of the key on the remote server, gpg has
+   no way to know its yours and can be trusted.
+   To fix that we can sign it with other trusted key, or just directly modify its
+   trust level in gpg (use level 5):
+
+     $ gpg --edit-key test@example.com
+     ...
+     Command> trust
+     ...
+     1 = I don't know or won't say
+     2 = I do NOT trust
+     3 = I trust marginally
+     4 = I trust fully
+     5 = I trust ultimately
+     m = back to the main menu
+
+     Your decision? 5
+     ...
+     Command> quit
+
+6. export your secret key for backup
+   (we recommend to print it on paper and burn to a CD/DVD and store in a safe place):
+
+    $ gpg -a --export-secret-key test@example.com > test@example.com.key
+
+
+
+Example configuration
+---------------------
+
+    safe do
+      local :path => "/backup/:kind/:id"
+
+      s3 do
+        key "...................."
+        secret "........................................"
+        bucket "backup.astrails.com"
+        path "servers/alpha/:kind/:id"
+      end
+
+      cloudfiles do
+        user "..........."
+        api_key "................................."
+        container "safe_backup"
+        path ":kind/" # this is default
+        service_net false
+      end
+
+      sftp do
+        host "sftp.astrails.com"
+        user "astrails"
+        # port 8023
+        password "ssh password for sftp"
+      end
+
+      gpg do
+        command "/usr/local/bin/gpg"
+        options  "--no-use-agent"
+        # symmetric encryption key
+        # password "qwe"
+
+        # public GPG key (must be known to GPG, i.e. be on the keyring)
+        key "backup@astrails.com"
+      end
+
+      keep do
+        local 20
+        s3 100
+        cloudfiles 100
+        sftp 100
+      end
+
+      mysqldump do
+        options "-ceKq --single-transaction --create-options"
+
+        user "root"
+        password "............"
+        socket "/var/run/mysqld/mysqld.sock"
+
+        database :blog
+        database :servershape
+        database :astrails_com
+        database :secret_project_com do
+          skip_tables "foo"
+          skip_tables ["bar", "baz"]
+        end
+
+      end
+
+      svndump do
+        repo :my_repo do
+          repo_path "/home/svn/my_repo"
+        end
+      end
+
+      pgdump do
+        options "-i -x -O"   # -i => ignore version, -x => do not dump privileges (grant/revoke), -O => skip restoration of object ownership in plain text format
+
+        user "username"
+        password "............"  # shouldn't be used, instead setup ident.  Current functionality exports a password env to the shell which pg_dump uses - untested!
+
+        database :blog
+        database :stateofflux_com
+      end
+
+      tar do
+        options "-h" # dereference symlinks
+        archive "git-repositories", :files => "/home/git/repositories"
+        archive "dot-configs",      :files => "/home/*/.[^.]*"
+        archive "etc",              :files => "/etc", :exclude => "/etc/puppet/other"
+
+        archive "blog-astrails-com" do
+          files "/var/www/blog.astrails.com/"
+          exclude "/var/www/blog.astrails.com/log"
+          exclude "/var/www/blog.astrails.com/tmp"
+        end
+
+        archive "astrails-com" do
+          files "/var/www/astrails.com/"
+          exclude ["/var/www/astrails.com/log", "/var/www/astrails.com/tmp"]
+        end
+      end
+    end
+
+Copyright
+---------
+
+Copyright (c) 2010 Astrails Ltd. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "astrails-safe"
+    gem.summary = %Q{Backup filesystem and databases (MySQL and PostgreSQL) locally or to a remote server/service (with encryption)}
+    gem.description = <<-DESC
+Astrails-Safe is a simple tool to backup databases (MySQL and PostgreSQL), Subversion repositories (with svndump) and just files.
+Backups can be stored locally or remotely and can be enctypted.
+Remote storage is supported on Amazon S3, Rackspace Cloud Files, or just plain SFTP.
+DESC
+    gem.email = "we@astrails.com"
+    gem.homepage = "http://blog.astrails.com/astrails-safe"
+    gem.authors  = ["Astrails Ltd."]
+    gem.files = FileList["[A-Z]*.*", "{bin,examples,generators,lib,rails,spec,test,templates}/**/*", 'Rakefile', 'LICENSE*']
+
+    gem.add_dependency("aws-s3")
+    gem.add_dependency("cloudfiles")
+    gem.add_dependency("net-sftp")
+
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_opts = ['--options', "\"spec/spec.opts\""]
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "safe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/bin/astrails-safe

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+require 'ruby-debug'
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require 'astrails/safe'
+include Astrails::Safe
+
+def die(msg)
+  puts "ERROR: #{msg}"
+  exit 1
+end
+
+def usage
+  puts <<-END
+Usage: astrails-safe [OPTIONS] CONFIG_FILE
+Options:
+  -h, --help           This help screen
+  -v, --verbose        be verbose, duh!
+  -n, --dry-run        just pretend, don't do anything.
+  -L, --local          skip S3 and Cloud Files
+
+Note: config file will be created from template if missing
+END
+  exit 1
+end
+
+def process_options
+  usage if ARGV.delete("-h") || ARGV.delete("--help")
+  $_VERBOSE = ARGV.delete("-v") || ARGV.delete("--verbose")
+  $DRY_RUN = ARGV.delete("-n") || ARGV.delete("--dry-run")
+  $LOCAL   = ARGV.delete("-L") || ARGV.delete("--local")
+  usage unless ARGV.first
+  $CONFIG_FILE_NAME = File.expand_path(ARGV.first)
+end
+
+def main
+  process_options
+
+  unless File.exists?($CONFIG_FILE_NAME)
+    die "Missing configuration file. NOT CREATED! Rerun w/o the -n argument to create a template configuration file." if $DRY_RUN
+
+    FileUtils.cp File.join(Astrails::Safe::ROOT, "templates", "script.rb"), $CONFIG_FILE_NAME
+
+    die "Created default #{$CONFIG_FILE_NAME}. Please edit and run again."
+  end
+
+  load($CONFIG_FILE_NAME)
+end
+
+main

data/examples/example_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'micronaut'
+require 'ruby-debug'
+
+SAFE_ROOT = File.dirname(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(SAFE_ROOT, 'lib'))
+
+require 'astrails/safe'
+
+def not_in_editor?
+  !(ENV.has_key?('TM_MODE') || ENV.has_key?('EMACS') || ENV.has_key?('VIM'))
+end
+
+Micronaut.configure do |c|
+  c.color_enabled = not_in_editor?
+  c.filter_run :focused => true
+  c.mock_with :rr
+end

data/lib/astrails/safe.rb

@@ -0,0 +1,61 @@
+require "aws/s3"
+require "cloudfiles"
+require 'net/sftp'
+require 'fileutils'
+require 'benchmark'
+
+require 'tempfile'
+require 'extensions/mktmpdir'
+
+require 'astrails/safe/tmp_file'
+
+require 'astrails/safe/config/node'
+require 'astrails/safe/config/builder'
+
+require 'astrails/safe/stream'
+
+require 'astrails/safe/backup'
+
+require 'astrails/safe/source'
+require 'astrails/safe/mysqldump'
+require 'astrails/safe/pgdump'
+require 'astrails/safe/archive'
+require 'astrails/safe/svndump'
+
+require 'astrails/safe/pipe'
+require 'astrails/safe/gpg'
+require 'astrails/safe/gzip'
+require 'astrails/safe/page'
+
+require 'astrails/safe/sink'
+require 'astrails/safe/local'
+require 'astrails/safe/s3'
+require 'astrails/safe/cloudfiles'
+require 'astrails/safe/sftp'
+
+module Astrails
+  module Safe
+    ROOT = File.join(File.dirname(__FILE__), "..", "..")
+
+    def safe(&block)
+      config = Config::Node.new(&block)
+      #config.dump
+
+
+      [[Mysqldump, [:mysqldump, :databases]],
+       [Pgdump,    [:pgdump,    :databases]],
+       [Archive,   [:tar,       :archives]],
+       [Svndump,   [:svndump,   :repos]]
+      ].each do |klass, path|
+        if collection = config[*path]
+          collection.each do |name, config|
+            klass.new(name, config).backup.run(config, :gpg, :page, :gzip, :local, :s3, :cloudfiles, :sftp)
+          end
+        end
+      end
+
+      Astrails::Safe::TmpFile.cleanup
+    end
+    module_function :safe
+  end
+end