carrierwave_encrypter_decrypter 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzRiMGRjOWZkZjUyNzBiOTY2MTVlNjhkMDRlYWRmYjUzYmQ2M2ZmYQ==
+    ZDlkZGEyY2E0NTRhMjViMTIzMzRmODMzOGY3OWYyNDZjZmYzYmViNA==
   data.tar.gz: !binary |-
-    NDJjZWYzYzM4ZDE4MGRjZGQ4YmNhNjQ1ODM4MDYxMGJkMTEzZDFhZg==
+    MDUyYTY1MGY3NzQ5ZjIyNzk3OGVjODViNDg0YjdiZDM4Yjg4NmE3Ng==
 SHA512:
   metadata.gz: !binary |-
-    YzA0OTU4NGZiOWZlMzFjMGM2ZGE4NWQ2ODg1OWExNmRiODM1Mzg5M2M0YjI1
-    YTQ1YWE1NWQ2YmRiZjNjMWIwNjRjZDhmYzVlODFhMjI3YjI4OWEwMzJiZmFk
-    ZWE5MDUyNWQ3YjIwMDE2Y2U1NmIxNzNkMGNkMjA2YzFhNzNiN2I=
+    ODM0MmE3ODA3MWM2YjQyOGYyM2NjNGNhODc5NzkyMmJhZWI3YWIzMGU4ZDNj
+    NTZhYTE5YWQ1ZWI5MDdlMjQyNjc1NzU4NTE5ZGZjOWMzZDlkMzFlYTliNzZk
+    NzQxZTI3ZTQyZWVlOTJiZmIzYmQ1OTUzMGNiODk1MmMzYjcwNTI=
   data.tar.gz: !binary |-
-    ODVkMWQ1OWViZWFhNDRkZjRhNTQ0YjI0NDZmYzczNTQ5NTJlMDE3OWQzMTRj
-    M2IxMDNiMjM5NTYwZWUyMDZjNjA0NGExNjVlZmI4NDVhYjkzZDJhYzk3NzIw
-    NGVkODk4ZDM5NTY3ZGY1MzJkN2RhY2FiZWY5Y2QwMjdjOGE2NTc=
+    NzAwYjg2ZmRjNzk4Njg0M2EyNzcyMDA2ZjkyYjI1MzQ4OGJkZGVjMGI4YjMy
+    ZGJiZGQzNDhkZjkyMGU4OWQ2NDhkY2YzZDE3NDBhZTczMWQ0NjAwMzExN2M5
+    YzE5OTFmOTJlOTI3NTA5YTgyNWEyMjViNjAyNzU3YzFhNzYxNTU=

data/Readme.md

@@ -1,10 +1,15 @@
-**Note:** Gem Work in progress :pray: will be completed by 31st Dec 2013 
-
 # Carrierwave Encrypter Decrypter
 
-A Rubygem to secure the file uploaded by encrypting the data and decryption on the fly.  Completely secure and depends on Ruby 2.0.0 OpenSSL::Cipher and OpenSSL::PKCS5
+A Rubygem to secure the file uploaded by encrypting the file later on decrypting when needed.  Completely secure and depends on Ruby 2.0.0 OpenSSL::Cipher and OpenSSL::PKCS5
+
+
+OpenSSL::Cipher
+
+Provides symmetric algorithms for encryption and decryption. 
 
+OpenSSL::PKCS5
 
+Provides password-based encryption functionality based on PKCS#5. 
 
 ## Installation
 
@@ -25,6 +30,32 @@ This will create a initializer `carrierwave_encrypter_decrypter`
 
     create  config/initializers/carrierwave_encrypter_decrypter.rb
 
+and a `carrierwave_encrypter_decrypter.yml`
+
+	create  config/carrierwave_encrypter_decrypter.yml
+
+the above will be used when you have the `encryption_type` as `pkcs5`.
+
+## Choosing encryption type?
+
+The Gem support 2 ways **[OpenSSL::Cipher](http://ruby-doc.org/stdlib-2.0/libdoc/openssl/rdoc/OpenSSL/Cipher.html)** and **[OpenSSL::PKCS5](http://ruby-doc.org/stdlib-2.0/libdoc/openssl/rdoc/OpenSSL/PKCS5.html)**
+
+if you want to go with standard encryption in your `config/initializers/carrierwave_encrypter_decrypter.rb` select
+
+	Carrierwave::EncrypterDecrypter.configure  do |config|
+      config.encryption_type = :aes
+      config.key_size = 256
+ 	end
+
+if you want to go with password based encrption (pkcs5) in your `config/initializers/carrierwave_encrypter_decrypter.rb` select
+	
+	Carrierwave::EncrypterDecrypter.configure  do |config|
+      config.encryption_type = :pkcs5
+      config.key_size = 256
+ 	end
+
+**Note:** Make sure you have the password set in `config/carrierwave_encrypter_decrypter.yml`
+
 
 Now in your Uploader for eg `app/uploaders/avatar_uploader.rb` add the after store callback
 

data/lib/carrierwave/encrypter_decrypter/decryption.rb

@@ -1,4 +1,5 @@
 require 'carrierwave/encrypter_decrypter/openssl/aes'
+require 'carrierwave/encrypter_decrypter/openssl/pkcs5'
 
 class Decryption
 	def self.start!(obj,opts)
@@ -7,6 +8,8 @@ class Decryption
 		case encryption_type
 		when :aes
 			Openssl::Aes.decrypt_for(obj,opts)
+		when :pkcs5
+			Openssl::Pkcs5.decrypt_for(obj,opts)
 		end
 	end
 end

data/lib/carrierwave/encrypter_decrypter/encryption.rb

@@ -1,4 +1,5 @@
 require 'carrierwave/encrypter_decrypter/openssl/aes'
+require 'carrierwave/encrypter_decrypter/openssl/pkcs5'
 
 class Encryption
 	def self.start!(obj)
@@ -7,6 +8,8 @@ class Encryption
 		case encryption_type
 		when :aes
 			Openssl::Aes.encrypt_for(obj)
+		when :pkcs5
+			Openssl::Pkcs5.encrypt_for(obj)
 		end
 	end
 end

data/lib/carrierwave/encrypter_decrypter/openssl/pkcs5.rb

@@ -0,0 +1,89 @@
+require 'yaml'
+module Openssl
+	module Pkcs5
+		def self.encrypt_for(obj)
+			begin
+				config = YAML.load_file("#{Rails.root}/config/carrierwave_encrypter_decrypter.yml")[Rails.env]
+				model = obj.model
+				mounted_as = obj.mounted_as
+				
+				cipher = OpenSSL::Cipher.new("AES-#{Carrierwave::EncrypterDecrypter.configuration.key_size}-CBC")
+				cipher.encrypt
+				iv = cipher.random_iv
+				model.iv = iv
+
+				pwd = config['pkcs5_password']
+
+				salt = OpenSSL::Random.random_bytes 16
+
+				model.key = salt
+
+				iter = 20000
+
+				key_len = cipher.key_len
+				digest = OpenSSL::Digest::SHA256.new
+
+				key = OpenSSL::PKCS5.pbkdf2_hmac(pwd, salt, iter, key_len, digest)
+				cipher.key = key
+
+				original_file_path = File.expand_path(obj.store_path, obj.root)
+				encrypted_file_path = File.expand_path(obj.store_path, obj.root) + ".enc"
+				model.save!
+
+
+				buf = ""
+				File.open(encrypted_file_path, "wb") do |outf|
+					File.open(model.send(mounted_as).path, "rb") do |inf|
+						while inf.read(4096, buf)
+							outf << cipher.update(buf)
+						end
+						outf << cipher.final
+					end
+				end
+				File.unlink(model.send(mounted_as).path)			
+			rescue Exception => e  
+				puts "****************************#{e.message}"
+				puts "****************************#{e.backtrace.inspect}"
+			end
+		end
+
+		def self.decrypt_for(obj,opts)
+			begin			
+				config = YAML.load_file("#{Rails.root}/config/carrierwave_encrypter_decrypter.yml")[Rails.env]
+				model = obj
+				mounted_as = opts[:mounted_as]
+
+				cipher = OpenSSL::Cipher.new("AES-#{Carrierwave::EncrypterDecrypter.configuration.key_size}-CBC")
+				cipher.decrypt
+				cipher.iv = model.iv 
+
+				pwd = config['pkcs5_password']
+
+				salt = model.key 
+				iter = 20000
+				key_len = cipher.key_len
+				digest = OpenSSL::Digest::SHA256.new
+
+				key = OpenSSL::PKCS5.pbkdf2_hmac(pwd, salt, iter, key_len, digest)
+				cipher.key = key
+
+				original_file_path =  obj.send(mounted_as).root + obj.send(mounted_as).url 
+				encrypted_file_path =  obj.send(mounted_as).root + obj.send(mounted_as).url  + ".enc"
+
+				buf = ""
+				
+				File.open(original_file_path, "wb") do |outf|
+					File.open(encrypted_file_path, "rb") do |inf|
+						while inf.read(4096, buf)
+							outf << cipher.update(buf)
+						end
+						outf << cipher.final
+					end
+				end
+			rescue Exception => e
+				puts "****************************#{e.message}"
+				puts "****************************#{e.backtrace.inspect}"
+			end
+		end
+	end
+end

data/lib/carrierwave/encrypter_decrypter/version.rb

@@ -1,3 +1,3 @@
 module CarrierwaveEncrypterDecrypter
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/generators/ced/install/install_generator.rb

@@ -1,6 +1,7 @@
 module Ced
 	module Generators
 		class InstallGenerator < ::Rails::Generators::Base
+			 source_root File.expand_path("../templates", __FILE__)
 			desc "This generator creates an initializer file at config/initializers"
 			def create_initializer_file
 				create_file "config/initializers/carrierwave_encrypter_decrypter.rb" do 
@@ -10,10 +11,18 @@ module Ced
     #Read more about it here http://ruby-doc.org/stdlib-2.0/libdoc/openssl/rdoc/OpenSSL.html#module-OpenSSL-label-Encryption
     config.encryption_type = :aes
     config.key_size = 256
+
+    #This strategy is applicable when you want to have the pkcs5 (Password based encryption)
+    config.encryption_type = :pkcs5
+    config.key_size = 256
  end
 "
 				end
 			end
+
+			def copy_pkcs5_yml
+				copy_file "carrierwave_encrypter_decrypter.yml","config/carrierwave_encrypter_decrypter.yml"
+			end
 		end
 	end
 end

data/lib/generators/ced/install/templates/carrierwave_encrypter_decrypter.yml

@@ -0,0 +1,9 @@
+#This file is required by carrierwave_encrypter_decrypter gem.
+#The password that is set will be used if you have the encryption_type as pkcs5.
+#This will enable the password based encryption.
+
+development:
+  pkcs5_password: "Secret"
+
+production:
+  pkcs5_password: "Secret"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave_encrypter_decrypter
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ankit gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-30 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -52,8 +52,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A library supporting Ruby OpenSSL::Cipher and OpenSSL::PKCS5 for the
-  file encryption and decryption
+description: A library for encrypting and decrypting uploaded files.  Supports Ruby
+  OpenSSL::Cipher and OpenSSL::PKCS5 Strategies.
 email: ankit.gupta8898@gmail.com
 executables: []
 extensions: []
@@ -64,11 +64,13 @@ files:
 - lib/carrierwave/encrypter_decrypter/downloader.rb
 - lib/carrierwave/encrypter_decrypter/encryption.rb
 - lib/carrierwave/encrypter_decrypter/openssl/aes.rb
+- lib/carrierwave/encrypter_decrypter/openssl/pkcs5.rb
 - lib/carrierwave/encrypter_decrypter/uploader.rb
 - lib/carrierwave/encrypter_decrypter/version.rb
 - lib/carrierwave_encrypter_decrypter.rb
 - lib/generators/ced.rb
 - lib/generators/ced/install/install_generator.rb
+- lib/generators/ced/install/templates/carrierwave_encrypter_decrypter.yml
 - Readme.md
 homepage: https://github.com/ankit8898/carrierwave_encrypter_decrypter
 licenses: