underlock 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efeef63eb2420dcfc642b0ee17b5cf03820ad6dd
+  data.tar.gz: 8b8817fe84302875634819cf9a5709bbe494e169
+SHA512:
+  metadata.gz: 521f822d0cfa8b6a3a5d7152e1edb280cece2af86cefcd7ca696f2085c290d3815da0987a74d8a99c7eead0c2e92e2525d3e9cdc4697a9931db962fa6be4ab68
+  data.tar.gz: 0538a17b60e37d57b0f2d87e009d280888159f404a80d2b975e1855e4efca2cd8b14b15df9b7340d213e769611a1a876734dcaf867327060b9f2fa1b5447a74e

data/.gitignore

@@ -0,0 +1,59 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jasdeep Singh
+
+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,135 @@
+# Underlock
+
+Underlock makes it dead simple to encrypt and decrypt your data and files. It comes with little to no dependencies and has a very small API surface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'underlock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install underlock
+
+## Initialization
+
+```ruby
+Underlock::Base.configure do |config|
+  config.public_key  = File.read('./key.pub')
+  config.private_key = File.read('./key.priv')
+  config.cipher      = OpenSSL::Cipher.new('aes-256-gcm')
+end
+```
+
+For the `config.cipher` value, all algorithms available in `OpenSSL::Cipher.ciphers` are supported.
+
+## Generating Public/Private keypair
+
+```ruby
+key = OpenSSL::PKey::RSA.new 4096
+puts key.to_pem
+puts key.public_key.to_pem
+```
+
+## Usage
+
+### Encrypting Strings/Text
+
+```ruby
+irb> Underlock::Base.encrypt("super secret message")
+=> #<Underlock::EncryptedEntity:0x007fef2e4b8320>
+```
+
+`Underlock::EncryptedEntity` has the following 3 methods
+
+```ruby
+encrypted_entity.value
+encrypted_entity.key
+encrypted_entity.iv # iv stands for initialization vector
+```
+
+You should persist or store the `key` and `iv` in order to be able to decrypt the encrypted `value`.
+
+### Decrypting Strings/Text
+
+- Create an instance of `Underlock::EncryptedEntity`, use the `key` and `iv` collected in the previous steps.
+
+```ruby
+irb> encrypted_entity = Underlock::EncryptedEntity.new(value: value, key: key, iv: iv)
+```
+
+- Decrypt using one of the following methods:
+
+```ruby
+irb> encrypted_entity.decrypt
+```
+
+```ruby
+irb> Underlock::Base.decrypt(encrypted_entity)
+```
+
+### Encrypting Files
+
+To encrypt files, instead of passing a `String` object, pass a `File` object to `Underlock::Base.encrypt`
+
+```ruby
+irb> file = File.open('/path/to/your/secret/file.txt')
+irb> Underlock::Base.encrypt(file)
+=> #<Underlock::EncryptedEntity:0x007fef2e4b8320>
+```
+
+The return value is an instance of `Underlock::EncryptedEntity` and has the following methods:
+
+```ruby
+encrypted_entity.encrypted_file
+encrypted_entity.key
+encrypted_entity.iv # iv stands for initialization vector here
+```
+
+`#encrypted_file` returns a `File` object. This file is saved in the same directory as your original file.
+
+### Decrypting Files
+
+- Create an instance of `Underlock::EncryptedEntity`, use the `key` and `iv` collected in the previous steps.
+
+```ruby
+irb> file = File.open('/path/to/your/secret/file.txt.enc')
+irb> encrypted_entity = Underlock::EncryptedEntity.new(encrypted_file: file, key: key, iv: iv)
+```
+
+- Decrypt using one of the following methods:
+
+```ruby
+irb> encrypted_entity.decrypt
+```
+
+```ruby
+irb> Underlock::Base.decrypt(encrypted_entity)
+```
+
+Following naming scheme is followed when encrypting/decrypting files:
+
+| original file name | encrypted file name | decrypted file name |
+|--------------------|---------------------|---------------------|
+| file.pdf           | file.pdf.enc        | file.decrypted.pdf  |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/metaware/underlock.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "underlock"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/underlock.rb

@@ -0,0 +1,10 @@
+require 'underlock/version'
+require 'dry-configurable'
+require 'openssl'
+require 'underlock/encryptor'
+require 'underlock/file_encryptor'
+require 'underlock/encrypted_entity'
+require 'underlock/base'
+
+module Underlock
+end

data/lib/underlock/base.rb

@@ -0,0 +1,28 @@
+module Underlock
+  class Base
+    extend Dry::Configurable
+
+    setting :private_key
+    setting :public_key
+    setting :passphrase
+    setting :cipher
+
+    class << self
+
+      def encrypt(unencrypted_value)
+        if Pathname.new(unencrypted_value).exist?
+          unencrypted_value = File.new(unencrypted_value)
+        end
+        case unencrypted_value
+          when File   then FileEncryptor.new.encrypt(unencrypted_value)
+          when String then Encryptor.new.encrypt(unencrypted_value)
+        end
+      end
+
+      def decrypt(encrypted_entity)
+        encrypted_entity.decrypt
+      end
+
+    end
+  end
+end

data/lib/underlock/encrypted_entity.rb

@@ -0,0 +1,22 @@
+module Underlock
+  class EncryptedEntity
+
+    attr_accessor :value, :encrypted_file, :key, :iv
+    def initialize(value: nil, encrypted_file: nil, key:, iv:)
+      @encrypted_file = encrypted_file
+      @value = value
+      @key = key
+      @iv = iv
+    end
+
+    def decrypt
+      return Encryptor.new.decrypt(self) if value
+      return FileEncryptor.new.decrypt(self) if encrypted_file
+    end
+
+    def inspect
+      self.to_s
+    end
+
+  end
+end

data/lib/underlock/encryptor.rb

@@ -0,0 +1,46 @@
+module Underlock
+  class Encryptor
+
+    def encrypt(value)
+      cipher = Underlock::Base.config.cipher.dup
+      cipher.encrypt
+      key = cipher.random_key
+      iv  = cipher.random_iv
+
+      encrypted_value = base64_encode(cipher.update(value))
+      encrypted_key = public_encrypt(key)
+      encrypted_iv  = public_encrypt(iv)
+
+      EncryptedEntity.new(value: encrypted_value, key: encrypted_key, iv: encrypted_iv)
+    end
+
+    def decrypt(encrypted_entity)
+      decode_cipher = Underlock::Base.config.cipher.dup
+      decode_cipher.decrypt
+      decode_cipher.key = private_decrypt(encrypted_entity.key)
+      decode_cipher.iv = private_decrypt(encrypted_entity.iv)
+      decode_cipher.update(base64_decode(encrypted_entity.value)[0])
+    end
+
+    private
+
+    def public_encrypt(value)
+      key = OpenSSL::PKey::RSA.new(Underlock::Base.config.public_key)
+      base64_encode(key.public_encrypt(base64_encode(value)))
+    end
+
+    def private_decrypt(value)
+      key = OpenSSL::PKey::RSA.new(Underlock::Base.config.private_key)
+      base64_decode(key.private_decrypt(base64_decode(value)[0]))[0]
+    end
+
+    def base64_encode(value)
+      [value].pack('m')
+    end
+
+    def base64_decode(value)
+      value.unpack('m')
+    end
+
+  end
+end

data/lib/underlock/file_encryptor.rb

@@ -0,0 +1,82 @@
+module Underlock
+  class FileEncryptor
+
+    def encrypt(file)
+      file = File.realpath(file)
+      @base_dir, @filename = File.split(file)
+      cipher = Underlock::Base.config.cipher.dup
+      cipher.encrypt
+      key = cipher.random_key
+      iv  = cipher.random_iv
+
+      File.open(encrypted_filepath, "w") do |encrypted_file|
+        File.open(file) do |inf|
+          loop do
+            r = inf.read(4096)
+            break unless r
+            encrypted_file << cipher.update(r)
+          end
+        end
+        encrypted_file << cipher.final
+      end
+
+      encrypted_file = File.new(encrypted_filepath)
+      encrypted_key  = public_encrypt(key)
+      encrypted_iv   = public_encrypt(iv)
+
+      EncryptedEntity.new(encrypted_file: encrypted_file, key: encrypted_key, iv: encrypted_iv)
+    end
+
+    def decrypt(encrypted_entity)
+      decode_cipher = Underlock::Base.config.cipher.dup
+      decode_cipher.decrypt
+      decode_cipher.key = private_decrypt(encrypted_entity.key)
+      decode_cipher.iv = private_decrypt(encrypted_entity.iv)
+
+      @base_dir, @filename = File.split(encrypted_entity.encrypted_file)
+
+      File.open(decrypted_filepath, 'wb') do |decrypted_file|
+        File.open(encrypted_entity.encrypted_file) do |inf|
+          loop do
+            r = inf.read(4096)
+            break unless r
+            decrypted_file << decode_cipher.update(r)
+          end
+        end
+      end
+      File.new(decrypted_filepath)
+    end
+
+    private
+
+    def encrypted_filepath
+      "#{@base_dir}/#{@filename}.enc"
+    end
+
+    def decrypted_filepath
+      original_filename = @filename.gsub('.enc', '')
+      extension = File.extname(original_filename)
+      decrypted_filename = original_filename.gsub(extension, ".decrypted#{extension}")
+      "#{@base_dir}/#{decrypted_filename}"
+    end
+
+    def public_encrypt(value)
+      key = OpenSSL::PKey::RSA.new(Underlock::Base.config.public_key)
+      base64_encode(key.public_encrypt(base64_encode(value)))
+    end
+
+    def private_decrypt(value)
+      key = OpenSSL::PKey::RSA.new(Underlock::Base.config.private_key)
+      base64_decode(key.private_decrypt(base64_decode(value)[0]))[0]
+    end
+
+    def base64_encode(value)
+      [value].pack('m')
+    end
+
+    def base64_decode(value)
+      value.unpack('m')
+    end
+
+  end
+end

data/lib/underlock/version.rb

@@ -0,0 +1,3 @@
+module Underlock
+  VERSION = "0.0.3"
+end

data/underlock.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'underlock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "underlock"
+  spec.version       = Underlock::VERSION
+  spec.authors       = ["Jasdeep Singh"]
+  spec.email         = ["narang.jasdeep@gmail.com"]
+
+  spec.summary       = %q{Underlock makes it dead simple to encrypt and decrypt files using public/private keys.}
+  # spec.description   = %q{}
+  spec.homepage      = "https://github.com/metaware/underlock"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dry-configurable", "~> 0.5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yomu", "~> 0.2.4"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: underlock
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Jasdeep Singh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yomu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+description: 
+email:
+- narang.jasdeep@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/underlock.rb
+- lib/underlock/base.rb
+- lib/underlock/encrypted_entity.rb
+- lib/underlock/encryptor.rb
+- lib/underlock/file_encryptor.rb
+- lib/underlock/version.rb
+- underlock.gemspec
+homepage: https://github.com/metaware/underlock
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Underlock makes it dead simple to encrypt and decrypt files using public/private
+  keys.
+test_files: []