gibberish 1.2.2 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 615d0b35bad8161dd357fca6dbe11049f9efcbb4
+  data.tar.gz: d9ab3a19076095e505785df668c4ad78305724e6
+SHA512:
+  metadata.gz: 1ad21cb479d7d2252ee98dc1050a1f6d122a438aa9db60c4ed303980af1725f7687a938d22f0ee7aa790a42868a6dad5de000207f75c9a11988d9eff24d62d83
+  data.tar.gz: 11b78f9beae9d119ec36d26ad8dec82de4a6cb90bd22e7db7538946813cee1128de79cdb1e4c3787403703cd6fbc577d8978e4200ceb0d4fb1951243ac13d99a

data/CHANGELOG.mdown

@@ -1,3 +1,7 @@
+### v1.3.0
+* Add support for file encryption [PR #12](https://github.com/mdp/gibberish/pull/12)
+* Add support for streaming encryption [PR #11](https://github.com/mdp/gibberish/pull/11)
+
 ### v1.2.2
 * Added support for EBC mode on AES [PR #10](https://github.com/mdp/gibberish/pull/10)
 

data/README.markdown

@@ -14,7 +14,7 @@ interface in Ruby.
 line interface. Each function will include documentation on how to perform
 the same routine via the command line with OpenSSL
 
-- It should default to a reasonably secure setting, e.g. 256-bit AES, or SHA1 for HMAC  
+- It should default to a reasonably secure setting, e.g. 256-bit AES, or SHA1 for HMAC
 But it should allow the user to specify a stronger setting, within reason.
 
 - Procedures should be well tested and be compatible with Ruby 1.8.7 and 1.9
@@ -39,11 +39,19 @@ Defaults to 256 bit CBC encryption
     cipher.dec("U2FsdGVkX187oKRbgDkUcMKaFfB5RsXQj/X4mc8X3lsUVgwb4+S55LQo6f6N\nIDMX")
     #=> "Some top secret data"
 
+To encrypt / decrypt a file
+
+    cipher.encrypt_file("secret.txt", "secret.txt.enc")
+
+    cipher.decrypt_file("secret.txt.enc", "secret.txt")
+
 Gibberish AES is fully compatible with default OpenSSL on the command line
 
     echo "U2FsdGVkX187oKRbgDkUcMKaFfB5RsXQj/X4mc8X3lsUVgwb4+S55LQo6f6N\nIDMX\n" | \
     openssl enc -d -aes-256-cbc -a -k p4ssw0rd
 
+    openssl aes-256-cbc -d -in secret.txt.enc -out secret.txt -k p4ssw0rd
+
 [Find out more](http://mdp.github.com/gibberish/Gibberish/AES.html)
 
 ## RSA

data/lib/gibberish/aes.rb

@@ -12,19 +12,24 @@ module Gibberish
   #     cipher = Gibberish::AES.new('p4ssw0rd')
   #     cipher.encrypt("some secret text")
   #     #=> "U2FsdGVkX1/D7z2azGmmQELbMNJV/n9T/9j2iBPy2AM=\n"
+  #     cipher.encrypt_file("secret.txt", "secret.txt.enc")
   #
   # ### Decrypting
   #
   #     cipher = Gibberish::AES.new('p4ssw0rd')
   #     cipher.decrypt(""U2FsdGVkX1/D7z2azGmmQELbMNJV/n9T/9j2iBPy2AM=\n"")
   #     #=> "some secret text"
+  #     cipher.decrypt_file("secret.txt.enc", "secret.txt")
   #
   # ## OpenSSL Interop
   #
   #     echo "U2FsdGVkX1/D7z2azGmmQELbMNJV/n9T/9j2iBPy2AM=\n" | openssl enc -d -aes-256-cbc -a -k p4ssw0rd
+  #     openssl aes-256-cbc -d -in secret.txt.enc -out secret.txt -k p4ssw0rd
   #
   class AES
 
+    BUFFER_SIZE = 4096
+
     attr_reader :password, :size, :cipher
 
     # Initialize with the password
@@ -59,6 +64,55 @@ module Gibberish
     alias :dec :decrypt
     alias :d :decrypt
 
+    def encrypt_file(from_file, to_file, opts={})
+      salt = generate_salt(opts[:salt])
+      setup_cipher(:encrypt, salt)
+      buf = ""
+      File.open(to_file, "wb") do |outf|
+        outf << "Salted__#{salt}"
+        File.open(from_file, "rb") do |inf|
+          while inf.read(4096, buf)
+            outf << self.cipher.update(buf)
+          end
+          outf << self.cipher.final
+        end
+      end
+    end
+    alias :enc_file :encrypt_file
+    alias :ef :encrypt_file
+
+    def decrypt_file(from_file, to_file)
+      buf = ""
+      salt = ""
+      File.open(to_file, "wb") do |outf|
+        File.open(from_file, "rb") do |inf|
+          inf.seek(8, IO::SEEK_SET)
+          inf.read(8, salt)
+          setup_cipher(:decrypt, salt)
+          while inf.read(4096, buf)
+            outf << self.cipher.update(buf)
+          end
+          outf << self.cipher.final
+        end
+      end
+    end
+    alias :dec_file :decrypt_file
+    alias :df :decrypt_file
+
+    def encrypt_stream(in_stream, out_stream, opts={})
+      salt = generate_salt(opts[:salt])
+      setup_cipher(:encrypt, salt)
+      out_stream << "Salted__#{salt}"
+      copy_stream in_stream, out_stream
+    end
+
+    def decrypt_stream(in_stream, out_stream)
+      header = in_stream.read(16)
+      salt = header[8..15]
+      setup_cipher(:decrypt, salt)
+      copy_stream in_stream, out_stream
+    end
+
     private
 
     def generate_salt(supplied_salt)
@@ -74,5 +128,15 @@ module Gibberish
       cipher.send(method)
       cipher.pkcs5_keyivgen(password, salt, 1)
     end
+
+    def copy_stream(in_stream, out_stream)
+      buf = ''
+      while in_stream.read(BUFFER_SIZE, buf)
+        out_stream << cipher.update(buf)
+      end
+      out_stream << cipher.final
+      out_stream.flush
+    end
+
   end
 end

data/lib/gibberish/version.rb

@@ -1,3 +1,3 @@
 module Gibberish
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/spec/aes_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'tempfile'
 
 describe "the aes cipher" do
 
@@ -13,6 +14,15 @@ describe "the aes cipher" do
     from_openssl.must_equal(secret_text)
   end
 
+  it "should encrypt file and be compatible with OpenSSL CLI" do
+    source_file_path = "spec/fixtures/secret.txt"
+    encrypted_file = Tempfile.new('secret.txt.enc')
+    @cipher.ef(source_file_path, encrypted_file.path)
+    decrypted_file = Tempfile.new('secret.txt')
+    `openssl aes-256-cbc -d -in #{encrypted_file.path} -out #{decrypted_file.path} -k password`
+    FileUtils.cmp(source_file_path, decrypted_file.path).must_equal(true)
+  end
+
   it "when salt is not specified, encrypted text from repeated calls should not be the same" do
     secret_text = "Made with Gibberish"
     encrypted1 = @cipher.e(secret_text)
@@ -59,8 +69,39 @@ describe "the aes cipher" do
   it "should decrypt base64 encoded data from the OpenSSL CLI" do
     secret_text = "Made with Gibberish"
     from_openssl = `echo #{secret_text} | openssl enc -aes-256-cbc -a -k password`
-      decrypted_text = @cipher.d(from_openssl).chomp
+    decrypted_text = @cipher.d(from_openssl).chomp
     decrypted_text.must_equal(secret_text)
   end
 
+  it "should decrypt file encrypted with OpenSSL CLI" do
+    source_file_path = "spec/fixtures/secret.txt"
+    encrypted_file = Tempfile.new('secret.txt.enc')
+    `openssl aes-256-cbc -salt -in #{source_file_path} -out #{encrypted_file.path} -k password`
+    decrypted_file = Tempfile.new('secret.txt')
+    @cipher.df(encrypted_file.path, decrypted_file.path)
+    FileUtils.cmp(source_file_path, decrypted_file.path).must_equal(true)
+  end
+
+  describe 'stream encryption' do
+
+    it 'encrypts a file' do
+      File.open('spec/openssl/plaintext.txt', 'rb') do |in_file|
+        File.open(Tempfile.new('gib'), 'wb') do |enc_file|
+          @cipher.encrypt_stream in_file, enc_file, salt: 'SOMESALT'
+          File.read(enc_file.path).must_equal(File.read('spec/openssl/plaintext.aes'))
+        end
+      end
+    end
+
+    it 'decrypts a file' do
+      File.open('spec/openssl/plaintext.aes', 'rb') do |in_file|
+        File.open(Tempfile.new('gib'), 'wb') do |dec_file|
+          @cipher.decrypt_stream in_file, dec_file
+          File.read(dec_file.path).must_equal(File.read('spec/openssl/plaintext.txt'))
+        end
+      end
+    end
+
+  end
+
 end

data/spec/fixtures/secret.txt

@@ -0,0 +1,41 @@
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/spec/openssl/plaintext.aes

@@ -0,0 +1 @@
+Salted__SOMESALT!���,�CӇ����uz���_�_�i/

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gibberish
 version: !ruby/object:Gem::Version
-  version: 1.2.2
-  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors:
 - Mark Percival
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-08-24 00:00:00.000000000 Z
 dependencies: []
 description: Supports OpenSSL compatible AES, HMAC, and RSA encryption
 email:
@@ -39,7 +38,9 @@ files:
 - lib/gibberish/version.rb
 - spec/aes_spec.rb
 - spec/digest_spec.rb
+- spec/fixtures/secret.txt
 - spec/hmac_spec.rb
+- spec/openssl/plaintext.aes
 - spec/openssl/plaintext.crypted
 - spec/openssl/plaintext.txt
 - spec/openssl/private.pem
@@ -48,26 +49,25 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/mdp/gibberish
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: gibberish
-rubygems_version: 1.8.23
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An opinionated ruby encryption library
 test_files: []