data_encryptor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad6683e091c9d993542162c7513fbee14bdde98fd51835b3aa7879a6830e58e0
+  data.tar.gz: 192b078c1258259ae4bcb5c0f1783a9363341b004a719285e7624343ce2d603e
+SHA512:
+  metadata.gz: 8d18aea403e5e1d078464829b8cc4cf1487bd8984a10cae7c36b091023dd47e4de82f435fa65267bd18d14e6f1db2ba5a29cbd8c9f0727c2d51e22ae4dbdedc1
+  data.tar.gz: 242fb94efe276e5bf0d165b19a7a443d5e2dc0f29958807ae4ca0a356dc149632aa62d183af30d239854d0f624929d73bce12abe032a8783eabed9b073aff7c5

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in data_encryptor.gemspec
+gemspec
+
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    data_encryptor (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.0)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  data_encryptor!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 David Piegza
+
+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,60 @@
+# DataEncryptor
+
+DataEncryptor is a simple wrapper for OpenSSL::Cipher to encrypt and decrypt objects. It uses `JSON` to serialize objects
+which limits encryption for basic types like String, Integer, Array, Hash and so on. This gem uses the stdlib only.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'data_encryptor'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install data_encryptor
+
+## Usage
+
+You need to specify a key first. In Rails a key can be generated with `rake secret` and set in an initializer file, e.g. `data_encryptor.rb`:
+
+```ruby
+DataEncryptor.setup! key: '[key]'
+```
+
+The default algorithm is `AES-256-CBC`, this can be changed with:
+
+```ruby
+DataEncryptor.setup! key: '[key]', algorithm: 'AES-128-CBC'
+```
+
+To encrypt data:
+
+```ruby
+encrypted_data = DataEncryptor.encrypt('secret credit card information')
+```
+
+To decrypt data:
+
+```ruby
+DataEncryptor.decrypt(encrypted_data)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/davidpiegza/data_encryptor.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'data_encryptor'
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/data_encryptor.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'lib/data_encryptor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'data_encryptor'
+  spec.version       = DataEncryptor::VERSION
+  spec.authors       = ['David Piegza']
+
+  spec.summary       = %q{DataEncryptor is a simple wrapper for OpenSSL::Cipher to encrypt and decrypt objects.}
+  spec.homepage      = 'https://github.com/davidpiegza/data_encryptor'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/davidpiegza/data_encryptor'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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']
+end

data/lib/data_encryptor.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'json'
+require 'openssl'
+
+require 'data_encryptor/version'
+
+module DataEncryptor
+  def self.setup!(key:, algorithm: 'AES-256-CBC')
+    @options = { key: key, algorithm: algorithm }
+  end
+
+  def self.encrypt(data)
+    raise ArgumentError, 'must specify a key' if @options[:key].to_s.empty?
+
+    cipher = new_cipher
+    iv = cipher.random_iv
+
+    decrypted = cipher.update(JSON.dump(data))
+    decrypted << cipher.final
+    "#{::Base64.strict_encode64(decrypted)}--#{::Base64.strict_encode64(iv)}"
+  end
+
+  def self.decrypt(encrypted_data)
+    raise ArgumentError, 'must specify a key' if @options[:key].to_s.empty?
+
+    encrypted_data, iv = encrypted_data.split('--').map { |v| ::Base64.strict_decode64(v) }
+
+    raise ArgumentError, 'encrypted data has invalid format' unless encrypted_data && iv
+
+    cipher = new_cipher(method: :decrypt)
+    cipher.iv = iv
+
+    decrypted_data = cipher.update(encrypted_data)
+    decrypted_data << cipher.final
+
+    JSON.parse(decrypted_data)
+  end
+
+  private_class_method def self.new_cipher(method: :encrypt)
+    cipher = OpenSSL::Cipher.new(@options.fetch(:algorithm)).public_send(method)
+    cipher.key = Digest::SHA256.digest @options.fetch(:key)
+    cipher
+  end
+end

data/lib/data_encryptor/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DataEncryptor
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: data_encryptor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Piegza
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-14 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data_encryptor.gemspec
+- lib/data_encryptor.rb
+- lib/data_encryptor/version.rb
+homepage: https://github.com/davidpiegza/data_encryptor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/davidpiegza/data_encryptor
+  source_code_uri: https://github.com/davidpiegza/data_encryptor
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: DataEncryptor is a simple wrapper for OpenSSL::Cipher to encrypt and decrypt
+  objects.
+test_files: []