encryptedzip 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0aa40b41e695d1cef7386eaa39b51342440b4ec7
+  data.tar.gz: ee0de528ffdd5fbbf1910be3a13a6ce83dbced73
+SHA512:
+  metadata.gz: 9968c58692142c2502343173fdfcca70153686b887d727a040187771ff8bd4f5dad5129a6d10c99652d51ffa545813f016a6b47ba0db49e7a62c3f49f75e58c3
+  data.tar.gz: c74c9a7e84f156c61d60259c34600c6033013d2bc0f5f4db5c86ee31395af508ee2f3229783564bfb2233eeacf209d1f2e5591f6ba55a8de4709c142db581da5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in encryptedzip.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Nipper
+
+MIT License
+
+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.md

@@ -0,0 +1,61 @@
+# EncryptedZip
+
+Use EncryptedZip to create an archive of encrypted files.  Files are encrypted using AES-256 using a randomly generated base64 password of approximately 100 characteres.  The password is encrypted according to a provided public key.  The encrypted password is then stored as a txt file and zipped along with the encrypted zip.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'encryptedzip'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install encryptedzip
+
+## Usage
+
+You must specify a public key file to use for the password encryption:
+```
+EncryptedZip.public_key_file = 'public.pem'
+```
+
+You can then create an encrypted zip file by providing an output filepath and an array of filepaths to encrypt.
+```
+EncryptedZip.create_encrypted_zip(output_filepath: 'archive.zip', files: ['secret.txt'])
+```
+
+Optionally, you can provide a password_path and encrypted_filepath.
+```
+EncryptedZip.password_path = "p4$$w0rd.txt"
+EncryptedZip.encrypted_filepath = "BigSecret.zip"
+```
+
+To generate a 4096-bit private key:
+`$ openssl genrsa -des3 -out private.pem 4096`
+
+To generate a public key from a private key:
+`$ openssl rsa -in private.pem -out public.pem -outform PEM -pubout`
+
+Example script to decrypt a password file:
+
+```
+require 'openssl'
+
+private_key_file = 'private.pem'
+password = '' # password used during key genertation
+encrypted_string = File.read('password.txt') 
+private_key = OpenSSL::PKey::RSA.new(File.read(private_key_file),password)
+puts private_key.private_decrypt(encrypted_string)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/encryptedzip.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'encryptedzip/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "encryptedzip"
+  spec.version       = EncryptedZip::VERSION
+  spec.authors       = ["Michael Nipper"]
+  spec.email         = ["mjn4406@gmail.com"]
+  spec.description   = %q{Created an encrypted zip.}
+  spec.summary       = %q{Create an encrypted zip file.  The encrypted zip is then zipped with an encrypted password.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "zipruby", "~> 0.3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/encryptedzip.rb

@@ -0,0 +1,67 @@
+require_relative './encryptedzip/version'
+require 'openssl'
+require 'securerandom'
+require 'zipruby'
+
+module EncryptedZip
+
+  class << self
+    attr_accessor :public_key_file, :encrypted_filepath, :password_path
+  end
+
+  def self.create_encrypted_zip(options={})
+    check_errors(options)
+    password = generate_password
+    create_password_file(password)
+
+    create_zip(encrypted_filepath, options[:files])
+    Zip::Archive.encrypt(encrypted_filepath, password)
+
+    create_zip(options[:output_filepath], 
+      [password_path, encrypted_filepath])
+
+    clean_up
+    options[:output_filepath]
+  end
+
+  private
+  def self.encrypted_filepath
+    @encrypted_filepath || 'encrypted.zip'
+  end
+
+  def self.password_path
+    @password_path || 'password.txt'
+  end
+
+  def self.create_zip(filename, files)
+    Zip::Archive.open(filename, Zip::CREATE) do |archive|
+      files.each do |file|
+        archive.add_file(file) 
+      end
+    end
+  end
+
+  def self.clean_up
+    File.delete(encrypted_filepath, password_path)
+  end
+
+  def self.generate_password
+    SecureRandom.base64(85)
+  end
+
+  def self.encrypt_string(string)
+    public_key = OpenSSL::PKey::RSA.new(File.read(public_key_file))
+    cipher = public_key.public_encrypt(string)
+  end
+
+  def self.create_password_file(password)
+    File.open(password_path, "wb") {|f| f.write(encrypt_string password)}
+  end
+
+  def self.check_errors(options)
+    raise "You must set a public key file location" unless @public_key_file
+    raise "Place a public key at #{@public_key_file}" unless File.exists? @public_key_file
+    raise "You must supply an output filepath" unless options.has_key? :output_filepath
+    raise "You must supply a list of files to encrypt" unless options.has_key? :files
+  end
+end

data/lib/encryptedzip/version.rb

@@ -0,0 +1,3 @@
+module EncryptedZip
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: encryptedzip
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Nipper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zipruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Created an encrypted zip.
+email:
+- mjn4406@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- encryptedzip.gemspec
+- lib/encryptedzip.rb
+- lib/encryptedzip/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Create an encrypted zip file.  The encrypted zip is then zipped with an encrypted
+  password.
+test_files: []