eaesy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9642438541ffa350a9090a8fc5ac02c6143d70f
+  data.tar.gz: ebf7481c919171ea6a4f9f027b55523d81902a89
+SHA512:
+  metadata.gz: 3306f1b5d73ae7aa369fcfe5e3c470265acf2366c20e428e4f453d685ab1671d116a082e67a01970cc1be0333f3f22f594393432f593d93ed1c95b54356c5bb5
+  data.tar.gz: c97f4b6273cc5fefe5cfb253b4ef4ec79e73ee0a267ed890469ef91f1de3e52789f51d0cf3992b45d2aed6e7c2065a7729a1fbd9f3dbf81ecf81acb29be4f416

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in eaesy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 johnpwillman
+
+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,58 @@
+# Eaesy
+
+Eaesy is a gem for quickly encrypting and decrypting a string value using the AES 256 CBC algorithm. All encrypted values and initialization vectors are string-representations of binary values for ease of use.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eaesy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eaesy
+
+## Usage
+
+### Encrypt a string
+
+Without existing Initialization Vector
+
+```ruby
+eaesy = Eaesy::Cipher.new('YOUR_ENCRYPTION_KEY')
+enc_hash = eaesy.encrypt('SOME_STRING')
+encrypted_text = enc_hash[:encrypted_secret]
+initialization_vector = enc_hash[:iv]
+```
+
+With existing Initialization Vector
+
+```ruby
+eaesy = Eaesy::Cipher.new('YOUR_ENCRYPTION_KEY')
+enc_hash = eaesy.encrypt('SOME_STRING', initialization_vector)
+encrypted_text = enc_hash[:encrypted_secret]
+```
+
+>warn
+>Don't forget to store the initialization vector for later decrypting!
+
+### Decrypt a previously encrypted value
+
+```ruby
+eaesy = Eaesy::Cipher.new('YOUR_ENCRYPTION_KEY')
+decrypted_text = eaesy.decrypt(encrypted_text, initialization_vector)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/johnpwillman/eaesy.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "eaesy"
+
+# 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,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/eaesy.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "eaesy/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "eaesy"
+  spec.version       = Eaesy::VERSION
+  spec.authors       = ["johnatjawsdb"]
+  spec.email         = ["john@jawsdb.com"]
+
+  spec.summary       = %q{Simple string encryption/decryption using AES 256 CBC}
+  spec.description   = %q{Encrypts a string value using the AES 256 CBC algorithm and decrypts it back again.}
+  spec.homepage      = "https://github.com/johnpwillman/eaesy"
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/eaesy.rb

@@ -0,0 +1,56 @@
+require "eaesy/version"
+
+require 'openssl'
+require 'digest/sha2'
+require 'base64'
+
+module Eaesy
+  class Cipher
+    def initialize(key_plain)
+      @cipherAlg = "aes-256-cbc"
+      @key = sha256(key_plain)
+    end
+
+    def encrypt(secret, iv = nil)
+      cipher = OpenSSL::Cipher.new(@cipherAlg)
+      cipher.encrypt
+
+      # you will need to store this and key for later, in order to decrypt your data
+      iv = iv.unpack('m')[0] if iv
+      iv = cipher.random_iv unless iv
+
+      # load them into the cipher
+      cipher.key = @key
+      cipher.iv = iv
+
+      # encrypt the message
+      encrypted = cipher.update(secret)
+      encrypted << cipher.final
+
+      {
+        encrypted_secret: [encrypted].pack('m'),
+        iv: [iv].pack('m')
+      }
+    end
+
+    def decrypt(encrypted_secret, iv)
+      # now we create a cipher for decrypting
+      cipher = OpenSSL::Cipher::Cipher.new(@cipherAlg)
+      cipher.decrypt
+      cipher.key = @key
+      cipher.iv = iv.unpack('m')[0]
+
+      # and decrypt it
+      decrypted = cipher.update(encrypted_secret.unpack('m')[0])
+      decrypted << cipher.final
+
+      decrypted
+    end
+
+    private
+
+      def sha256(string_to_SHA)
+        sha256 = Digest::SHA256.new().digest(string_to_SHA)
+      end
+  end
+end

data/lib/eaesy/version.rb

@@ -0,0 +1,3 @@
+module Eaesy
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: eaesy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- johnatjawsdb
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: Encrypts a string value using the AES 256 CBC algorithm and decrypts
+  it back again.
+email:
+- john@jawsdb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- eaesy.gemspec
+- lib/eaesy.rb
+- lib/eaesy/version.rb
+homepage: https://github.com/johnpwillman/eaesy
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Simple string encryption/decryption using AES 256 CBC
+test_files: []