easy_cipher 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a45c8a563832ddfceed97b0ec41ec6000955d2c8
+  data.tar.gz: 8a723173ad1aeccf7d65345f1e6d94b30b3376e4
+SHA512:
+  metadata.gz: f17be959ad6d87d67171cc04cf323cf20f71b3de55619ecfd8759163076d9e4bc083dee6d443227a2ada6f74f26fe7c4c1874def2227218da28e253f657aa2fb
+  data.tar.gz: 39eaf348a60ef22e1afda21ddd5c80ef15bbf61e930c79a8b0b0fc47c5899ebd04321f4a1abebaf0f147a8c26f219061ffffd8d409538590a23e10b66ee5af7e

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,61 @@
+# EasyCipher
+
+A simple gem that uses ruby's OpenSSL package to simplify normal cipher use.
+It does not rely on any external libraries.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy_cipher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_cipher
+
+## Usage
+
+### To create an entirely new cipher
+```ruby
+cipher = EasyCipher::Cipher.new
+encrypted_data = cipher.encrypt "my data"
+decrypted_data = cipher.decrypt encrypted_data
+=> "my data"
+
+cipher.key
+=> "ZE\xD9\xE2B\n2J1\xDF\x10$\x03A\xB95\xE9P\xDF\xD5\xF6\xAA<\x06C\x82~\x06]\xBB\xE1G"
+
+cipher.iv
+=> "QHB\xE6\xEDpE\xDCha\x80\x02\xDB\xA5A\xAB"
+```
+
+### To create a cipher from a known key, iv
+```ruby
+known_cipher = EasyCipher::Cipher.new(known_key, known_iv)
+
+# then use it as normal.
+```
+
+### You can also create from base64 encoded values
+```ruby
+key64 = my_first_cipher.key64
+iv64 = my_first_cipher.iv64
+new_cipher = EasyCipher::Cipher.new64(key64,iv64)
+
+# then use it as normal.
+# Base64 encodings work with SQL string fields.
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/malakai97/easy_cipher/fork )
+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 a new Pull Request

data/Rakefile

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

data/easy_cipher.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_cipher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_cipher"
+  spec.version       = EasyCipher::VERSION
+  spec.authors       = ["Bryan Hockey"]
+  spec.email         = ["bhock@umich.edu"]
+
+  spec.summary       = %q{Simple gem that uses ruby's OpenSSL package to simplify normal cipher use. }
+  spec.homepage      = "https://github.com/malakai97/easy_cipher"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/easy_cipher.rb

@@ -0,0 +1,6 @@
+require "easy_cipher/version"
+require "easy_cipher/cipher"
+
+module EasyCipher
+  # Your code goes here...
+end

data/lib/easy_cipher/cipher.rb

@@ -0,0 +1,93 @@
+require "openssl"
+require "base64"
+
+# The cipher class
+class EasyCipher::Cipher
+  attr_reader :key, :iv
+
+  # Create a new cipher instance.
+  # @param key [String] A 256bit random key, or nil.
+  # @param iv [String] An initialization vector, or nil.
+  def initialize(key = nil, iv = nil)
+    if (key && !iv) || (!key && iv)
+      raise ArgumentError, "Must supply key AND iv, or neither."
+    end
+
+    @key = key
+    @iv = iv
+
+    @encryptor = ::OpenSSL::Cipher::AES256.new(:CBC)
+    @encryptor.encrypt
+
+    if @key
+      @encryptor.key = @key
+    else
+      @key = @encryptor.random_key
+    end
+
+    if @iv
+      @encryptor.iv = @iv
+    else
+      @iv = @encryptor.random_iv
+    end
+
+    @decryptor = ::OpenSSL::Cipher::AES256.new(:CBC)
+    @decryptor.decrypt
+    @decryptor.key = @key
+    @decryptor.iv = @iv
+  end
+
+  # Create a new cipher instance.
+  # @param key [String] A 256bit random key, base64 encoded.
+  # @param iv [String] An initialization vector, base64 encoded.
+  def self.new64(key, iv)
+    return self.new(Base64.decode64(key), Base64.decode64(iv))
+  end
+
+  # Return the key in base64 (e.g. to store in string fields)
+  def key64
+    return Base64.encode64(@key)
+  end
+
+  # Return the iv in base64 (e.g. to store in string fields)
+  def iv64
+    return Base64.encode64(@iv)
+  end
+
+  # Encrypt the given data.
+  # @param data [String] The data to encrypt
+  # @return [String] Base64 representation of the encrypted data.
+  def encrypt(data)
+    return Base64.encode64(encrypt_line(data, true))
+  end
+
+
+  # Decrypt the given data.
+  # @param encrypted_data [String] Base64 representation of the encrypted data.
+  # @return [String] The decrypted data.
+  def decrypt(encrypted_data)
+    return decrypt_line(Base64.decode64(encrypted_data))
+  end
+
+
+
+  protected
+  def encrypt_line(line, final = true)
+    output = @encryptor.update(line)
+    if final
+      output << @encryptor.final
+    end
+    return output
+  end
+
+
+  def decrypt_line(line, final = true)
+    output = @decryptor.update(line)
+    if final
+      output << @decryptor.final
+    end
+    return output
+  end
+
+
+end

data/lib/easy_cipher/version.rb

@@ -0,0 +1,3 @@
+module EasyCipher
+  VERSION = "0.9.0"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: easy_cipher
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Bryan Hockey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: 
+email:
+- bhock@umich.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- easy_cipher.gemspec
+- lib/easy_cipher.rb
+- lib/easy_cipher/cipher.rb
+- lib/easy_cipher/version.rb
+homepage: https://github.com/malakai97/easy_cipher
+licenses: []
+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.5
+signing_key: 
+specification_version: 4
+summary: Simple gem that uses ruby's OpenSSL package to simplify normal cipher use.
+test_files: []