cryptology 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be3f956af95f13d3a1c53155ab98651794402a38
+  data.tar.gz: 45481cf1204233fa83b4647b8ae9f7f233170af6
+SHA512:
+  metadata.gz: a894dff57ff6c129010e6be2922425bcf0fa91f8873150f902a17da524460cb488b364e3df589a55967f674d4514430f8b2b38d5940e35bcb8d4e18d5d602ad1
+  data.tar.gz: 79f2eae716e4011b28e842caea3f104e66f2341521e8fe9d514b739efc205debeb153143c6e0bcf8161fe346eaf7da45f8a8fc845a062cb977b860e06659f71f

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.1.7
+  - 2.2.3
+
+sudo: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0 (2015-12-07)
+
+- Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dmitriy Tarasov
+
+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,82 @@
+# Cryptology
+
+[![Gem Version](https://badge.fury.io/rb/cryptology.svg)](http://badge.fury.io/rb/cryptology)
+[![Build Status](https://travis-ci.org/rubysamurai/cryptology.svg?branch=master)](https://travis-ci.org/rubysamurai/cryptology)
+
+`Cryptology` is a wrapper for encryption and decryption in Ruby. Supports all algorithms, that are available in installed version of OpenSSL. By default `AES-256-CBC` is used.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cryptology'
+```
+
+Save `Gemfile` and execute `bundle` command to install the gem.
+
+Or to install it yourself run this command: 
+
+```
+$ gem install cryptology
+```
+
+## Usage
+
+```ruby
+# Encrypting
+Cryptology.encrypt(data, key, algorithm, iv)
+
+# Decrypting
+Cryptology.decrypt(data, key, algorithm, iv)
+```
+
+Argument  | Required? | Default       | Comment
+----------|-----------|---------------|-------------
+data      | **Yes**   | n/a           | Data to encrypt or decrypt
+key       | **Yes**   | n/a           | Secure key for encryption and decryption
+algorithm | *No*      | `AES-256-CBC` | Cipher algorithm
+iv        | *No*      | `nil`         | Initialization vector for CBC, CFB, CTR, OFB modes
+
+Example:
+
+```ruby
+# Data to encrypt (required)
+data = 'Very, very confidential data'
+# Secure key for encryption (required)
+key = 'veryLongAndSecurePassword_6154309'
+# Use Blowfish algorithm in CBC mode (optional)
+algorithm  = 'BF-CBC'
+# Initialization vector for BF-CBC (optional)
+iv = OpenSSL::Cipher::Cipher.new(algorithm).random_iv
+
+# Encrypt our data
+encrypted = Cryptology.encrypt(data, key, algorithm, iv)
+
+# Decrypt our data
+plain = Cryptology.decrypt(data, key, algorithm, iv)
+
+```
+
+### Cipher algorithms
+
+To get a list of available cipher algorithms in your environment run this command:
+
+```
+$ openssl list-cipher-algorithms
+```
+
+or this Ruby code:
+
+```ruby
+require 'openssl'
+puts OpenSSL::Cipher.ciphers
+```
+
+## Contributing
+
+Anyone is welcome to contribute to Cryptology. Please [raise an issue](https://github.com/rubysamurai/cryptology/issues), fork the project, make changes to your forked repository and submit a pull request.
+
+## License
+
+`Cryptology` © Dmitriy Tarasov, 2015. Released under the [MIT](https://github.com/rubysamurai/cryptology/blob/master/LICENSE.txt) license.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+task default: :spec
+RSpec::Core::RakeTask.new

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cryptology'
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cryptology.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cryptology/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cryptology'
+  spec.version       = Cryptology::VERSION
+  spec.authors       = ['Dmitriy Tarasov']
+  spec.email         = ['info@rubysamurai.com']
+
+  spec.summary       = 'Wrapper for symmetric encryption and decryption using any algorithm supported by OpenSSL'
+  spec.description   = 'Wrapper for symmetric encryption and decryption using any algorithm supported by OpenSSL'
+  spec.homepage      = 'https://github.com/rubysamurai/cryptology'
+  spec.license       = 'MIT'
+
+  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.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency 'rake',  '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+end

data/lib/cryptology.rb

@@ -0,0 +1,38 @@
+require 'cryptology/version'
+require 'openssl'
+require 'base64'
+
+module Cryptology
+  def self.encrypt(data, key, algorithm = 'AES-256-CBC', iv = nil)
+    encrypted = encrypt_data(data.to_s, digest(key), algorithm, iv)
+    ::Base64.encode64(encrypted)
+  end
+
+  def self.decrypt(data, key, algorithm = 'AES-256-CBC', iv = nil)
+    base64_decoded = ::Base64.decode64(data.to_s)
+    decrypt_data(base64_decoded, digest(key), algorithm, iv)
+      .force_encoding('UTF-8').encode
+  end
+
+  private
+
+    def self.encrypt_data(data, key, algorithm, iv)
+      cipher = ::OpenSSL::Cipher::Cipher.new(algorithm)
+      cipher.encrypt
+      cipher.key = key
+      cipher.iv = iv
+      cipher.update(data) + cipher.final
+    end
+
+    def self.decrypt_data(encrypted_data, key, algorithm, iv)
+      decipher = ::OpenSSL::Cipher::Cipher.new(algorithm)
+      decipher.decrypt
+      decipher.key = key
+      decipher.iv = iv
+      decipher.update(encrypted_data) + decipher.final
+    end
+
+    def self.digest(key)
+      ::OpenSSL::Digest::SHA256.digest(key)
+    end
+end

data/lib/cryptology/version.rb

@@ -0,0 +1,3 @@
+module Cryptology
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: cryptology
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dmitriy Tarasov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-07 00:00:00.000000000 Z
+dependencies:
+- !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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Wrapper for symmetric encryption and decryption using any algorithm supported
+  by OpenSSL
+email:
+- info@rubysamurai.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cryptology.gemspec
+- lib/cryptology.rb
+- lib/cryptology/version.rb
+homepage: https://github.com/rubysamurai/cryptology
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.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: Wrapper for symmetric encryption and decryption using any algorithm supported
+  by OpenSSL
+test_files: []