edb 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e0630915b9cbcf27eb26aa9a0241385baaecb9b
-  data.tar.gz: 93d4d26e3b036f9e6f01d05a60da4bd10008369c
+  metadata.gz: 114baabf1be97194abcb44cd5378b818242be763
+  data.tar.gz: c4dd125d24d41450cb99f1ab771d5bcec94be42c
 SHA512:
-  metadata.gz: 7c041eb17661a237f83afaf7f8ccb281df3edace073932e7684cd1320d8e3d54f69443692cab2f9365b3d61604692f5a8e570bb41ba67cef23bf03b7d02fe1a3
-  data.tar.gz: 813b73f6ffd9ea1b1dd4cfb75ee82a75391b8ed928c8883fc65617cb312dc24719514af899c74917e92d41f1d5c62bcf5690a4965328786f989a7abcd34e0fc0
+  metadata.gz: 02bc9d1c1d8d974109f43b33295918bdbafafd0843954b264a2aaa949d95a3149c108437dbad3a7c0e80bb68e8c5a6a2ac1aa280c7936ee37e2366fe533e6139
+  data.tar.gz: 4391116b96b895acc789149fd42391618f96ef409cae31c38455a5d9ce3ad670d68f0fc35154092cc9093dc40ded9f90e40a5cfe38db574e576c1b8db4947799

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    edb (0.4)
+    edb (0.5)
       aws-sdk (= 1.59.1)
       ftp_sync (~> 0.4)
+      hkdf (~> 0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -16,6 +17,7 @@ GEM
     diff-lcs (1.2.5)
     ftp_sync (0.4.3)
       net-ftp-list (>= 2.1.1)
+    hkdf (0.2.0)
     json (1.8.3)
     mini_portile (0.6.2)
     net-ftp-list (3.2.8)
@@ -43,3 +45,6 @@ DEPENDENCIES
   edb!
   rake (~> 10.4)
   rspec (~> 3.3)
+
+BUNDLED WITH
+   1.10.5

data/README.md

@@ -4,11 +4,14 @@
 It is composed by three macro areas that reflect themself inside `edb.yml` and are *DBMS*, *CRYPTOGRAPHY* and *STORAGE*.
 The first one deals with the actual backup process of your database. The second one will eventually encrypt the backup copies you made and the last one will copy them somewhere (S3 bucket, your local filesystem, etc.).
 
+
+**tl;dr** Make (optionally) ciphered backups of your database(s) and then upload them via FTP and Amazon S3 (or just keep them in your server).
+
 ## Install
 `$ gem install edb`
 
 ## Run
-Setup and customize `example/edb.yml` (remember also to change the `secret`) and then:
+Setup and customize `example/edb.yml` (remember also to change the `secret` by running `edb -k`) and then:
 
 `$ edb example/edb.yml`
 
@@ -17,7 +20,7 @@ Consider also to add *EDB* to your cronjobs.
 ## Available modules
 - *Cryptography*: `AES_256_CBC`
 - *DBMS*:         `PostgreSQL`, `MySQL`
-- *Storage*:      `S3`, `Filesystem`
+- *Storage*:      `S3`, `Filesystem`, `FTP`
 
 ## FAQ
 **Q:** What if I want to dump two or three MySQL databases?   
@@ -26,3 +29,7 @@ Consider also to add *EDB* to your cronjobs.
 
 **Q:** What if I want to save a database to S3 and another one into my local filesystem?   
 *A:* Well, you can't. By design, every macro-block (like, `:DBMS:`) is unaware of the other ones. So, for instance, I couldn't ask `:Filesystem:` to work only for the first `:MySQL:` block since it actually does not know what a `:MySQL:` block is. You need just to create two configuration files.
+
+
+**Q:** Is there something to run it automatically at every night? Let's say 2:30am   
+*A:* Cronjobs to the rescue. Append the following line to your `crontab -e`: ```30 2 * * * bash -l -c '`which edb` /home/deployer/edb.yml'```.

data/bin/edb

@@ -24,6 +24,19 @@
 #++
 require 'edb'
 require 'yaml'
+require 'optparse'
+
+OptionParser.new do |opts|
+  opts.version = EDB::VERSION
+  opts.banner  = "Usage: edb [-k] [file]"
+
+  opts.on('-k', '--generate-key', 'Generate a random key of 32 characters') do
+    require 'securerandom'
+
+    puts SecureRandom.hex(32)
+    exit
+  end
+end.parse!
 
 config_file = ARGV[0]
 if !config_file || !config_file.end_with?('.yml') || !File.exists?(config_file)

data/edb.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new { |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'aws-sdk', '1.59.1'
+  s.add_dependency 'aws-sdk',  '1.59.1'
   s.add_dependency 'ftp_sync', '~> 0.4'
+  s.add_dependency 'hkdf',     '~> 0.2'
 }

data/example/edb.yml

@@ -17,7 +17,7 @@
 
 :CRYPTOGRAPHY:
   :AES_256_CBC:
-    :secret: 0279x62O116Hn50016AGJE6D5De4gn4r
+    :secret: 2518f4361ef86fa307d02bfa9794d37e8dad5458af4e0424cf143b4b8f95e5e4
 
 :STORAGE:
   :S3:

data/lib/edb/cryptography/aes_256_cbc.rb

@@ -22,6 +22,7 @@
 # or implied, of Giovanni Capuano.
 #++
 require 'openssl'
+require 'hkdf'
 
 module EDB
   module Cryptography
@@ -32,13 +33,15 @@ module EDB
 
           cipher = OpenSSL::Cipher.new('AES-256-CBC')
           cipher.encrypt
-          cipher.key = ::EDB.opts[:CRYPTOGRAPHY][:AES_256_CBC][:secret]
+          cipher.key = hash_key(::EDB.opts[:CRYPTOGRAPHY][:AES_256_CBC][:secret])
+          cipher.iv  = iv = cipher.random_iv
 
           contents = File.read(source)
           raise "Cannot encrypt #{source}: It's empty" if contents.empty?
 
           File.open(source, 'wb') do |file|
             ciphered_content = cipher.update(contents) + cipher.final
+            ciphered_content << iv
             file.write(ciphered_content)
           end
         end
@@ -46,19 +49,27 @@ module EDB
         def decrypt(source, new_file = true)
           ::EDB::Logger.log(:info, "Decrypting #{source}...")
 
+          ciphered_content = File.read(source)
+          raise "Cannot decrypt #{source}: It's empty" if ciphered_content.empty?
+          ciphered_content_length = ciphered_content.length
+
           decipher = OpenSSL::Cipher.new('AES-256-CBC')
           decipher.decrypt
-          decipher.key = ::EDB.opts[:CRYPTOGRAPHY][:AES_256_CBC][:secret]
 
-          contents = File.read(source)
-          raise "Cannot decrypt #{source}: It's empty" if contents.empty?
+          decipher.key = hash_key(::EDB.opts[:CRYPTOGRAPHY][:AES_256_CBC][:secret])
+          decipher.iv  = iv = ciphered_content.slice!(ciphered_content_length - 16, ciphered_content_length)
 
           new_source = new_file ? "#{source}.dec" : source
           File.open(new_source, 'wb') do |file|
-            deciphered_content = decipher.update(contents) + decipher.final
+            deciphered_content = decipher.update(ciphered_content) + decipher.final
             file.write(deciphered_content)
           end
         end
+
+        private
+        def hash_key(s)
+          HKDF.new(s).next_bytes(32)
+        end
       end
     end
   end

data/lib/edb/dbms/mysql.rb

@@ -33,8 +33,17 @@ module EDB
           }
 
           ::EDB::Logger.log(:info, "Dumping #{db[:database]}...")
+
           mysqldump = db[:binpath] && !db[:binpath].empty? ? File.join(db[:binpath], 'mysqldump') : 'mysqldump'
-          system "#{mysqldump} -u #{db[:username]} --password=#{db[:password]} --default-character-set=utf8 #{db[:database]} > #{files[:dump]}"
+
+          args = %W{
+            --user=#{db[:username]}
+            --password=#{db[:password]}
+            --single-transaction
+            #{db[:database]} > #{files[:dump]}
+          }.join(' ')
+
+          system "#{mysqldump} #{args}"
 
           files.values
         end

data/lib/edb/version.rb

@@ -23,5 +23,5 @@
 #++
 
 module EDB
-  VERSION = '0.4'
+  VERSION = '0.5'
 end

data/lib/edb.rb

@@ -25,6 +25,7 @@ require 'edb/edb'
 require 'edb/logger'
 require 'edb/dumper'
 require 'edb/is_module_supported'
+require 'edb/version'
 
 require 'edb/dbms'
 require 'edb/cryptography'

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: edb
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Giovanni Capuano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-11 00:00:00.000000000 Z
+date: 2015-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.59.1
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.59.1
 - !ruby/object:Gem::Dependency
   name: ftp_sync
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: hkdf
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: EDB aims to be a framework to make and manage backups of your database.
 email: webmaster@giovannicapuano.net
 executables:
@@ -93,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A framework to make and manage backups of your database.