cryptosystem 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f81553a727d6fa1eaa44385bdf8e2086b7c09f9
-  data.tar.gz: f1077b92847b5136fd53dd548041dc9e33b3f338
+  metadata.gz: 85f438691a896bf64fe02231dd5af6186823a5b6
+  data.tar.gz: 3699e93c8c639527d01d76316d09ddd36a792cde
 SHA512:
-  metadata.gz: 1630aab91d71c11266a1509230b59ce8e19e354e53b0374d09c1712ecf893ebf1b5d739e4300e178c9592671c19155efe0e0ce7dedf22c77321ed69a62f04db4
-  data.tar.gz: f677b47d6486ddd6ee6487101a0a3cd2fb8f39882a25b6ace6c8f25ef3d231d46b75616125765f319675993077b8ccae7c148c91a61c1ce67446b9ccba686f80
+  metadata.gz: 66f44adf68b69c9a90d4dac52aba7bed93fb7454ca772f8a15a8ffa8157fbf38bdc5b400b548f4515dea5f2de3c4740cd8070565cfdb21e7f84701ed88e9eb48
+  data.tar.gz: d504380686a8ebadd9761e2e93ea9464b980641e4aafa120c12531b270ccc78b645d8e1ff093a2c4e0da4df3d3161c2e05a1bfbee3ad510b363fec1a12f24547

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+#### 0.0.1
+* Encrypting a `nil` value returns `nil` instead of `EncryptError`.
+* Decrypting a `nil` value returns `nil` instead of `DecryptError`.

data/README.md

@@ -0,0 +1,56 @@
+[![Gem Version](https://badge.fury.io/rb/cryptosystem.svg)](https://badge.fury.io/rb/cryptosystem)
+[![Build Status](https://travis-ci.org/jdubswe/cryptosystem.svg?branch=master)](https://travis-ci.org/jdubswe/cryptosystem)
+
+# Cryptosystem
+Cryptosystem is a Ruby library facilitating simple encryption and decryption with asymmetric cryptography (or public-key
+cryptography). At this time, only RSA is supported.
+
+## Installation
+In your Gemfile, include the `cryptosystem` gem and then `bundle install`.
+
+```ruby
+gem 'cryptosystem'
+```
+
+## Getting Started
+In order to encrypt and decrypt, a public and private key must be generated.
+
+```bash
+$ openssl genrsa -out private.key
+$ openssl rsa -in private.key -pubout > public.pub
+```
+
+## Configuration
+Cryptosystem must know the path and password to your private key as well as the path to your public key.
+
+```ruby
+# config/initializers/cryptosystem.rb
+
+Cryptosystem::RSA.configure do |config|
+  config.password = ENV['secret-password']
+  config.private_key_path = 'path/to/private.key'
+  config.public_key_path = 'path/to/public.pub'
+end
+```
+
+## Encrypting
+After generating a key pair and properly configuring Cryptosystem, encryption is straightforward.
+
+```ruby
+rsa = Cryptosystem::RSA.new
+rsa.encrypt('secret') # => "JxpuhTpEqRtMLmaSfaq/X6XONkBnMe..."
+```
+
+The encrypted value is Base64 encoded, making it suitable for database storage.
+
+## Decrypting
+Decrypting is as simple as passing in an encrypted, Base64 encoded value.
+
+```ruby
+rsa = Cryptosystem::RSA.new
+encrypted_value = rsa.encrypt('secret') # => "Y8DWJc2/+7TIxdLEolV99XI2sclHuK..."
+rsa.decrypt(encrypted_value) # => "secret"
+```
+
+## Acknowledgments
+Special thanks to [@jedspurg](https://github.com/jedspurg) for the inspiration for this project.

data/cryptosystem.gemspec

@@ -1,8 +1,17 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cryptosystem/version'
+
 Gem::Specification.new do |s|
   s.name    = 'cryptosystem'
-  s.version = '0.0.0'
+  s.version = Cryptosystem::VERSION
   s.files   = `git ls-files`.split($/)
-  s.summary = 'Asymmetric encryption'
+  s.summary = 'Simple asymmetric (public-key) encryption.'
+  s.description = <<-DESC
+    Cryptosystem is a Ruby library facilitating simple encryption and
+    decryption with asymmetric cryptography (or public-key cryptography).
+  DESC
   s.author  = 'Josh Wetzel'
   s.license = 'MIT'
   s.required_ruby_version = '~> 2'

data/lib/cryptosystem.rb

@@ -4,3 +4,4 @@ require 'openssl'
 require 'cryptosystem/base'
 require 'cryptosystem/exceptions'
 require 'cryptosystem/rsa'
+require 'cryptosystem/version'

data/lib/cryptosystem/rsa.rb

@@ -19,12 +19,14 @@ module Cryptosystem
     end
 
     def encrypt(value)
+      return nil if value.nil?
       base64_encode(public_key.public_encrypt(value))
     rescue => error
       raise EncryptError, error.message
     end
 
     def decrypt(value)
+      return nil if value.nil?
       private_key.private_decrypt(base64_decode(value))
     rescue => error
       raise DecryptError, error.message

data/lib/cryptosystem/version.rb

@@ -0,0 +1,3 @@
+module Cryptosystem
+  VERSION = '0.0.1'.freeze
+end

data/test/cryptosystem/rsa_test.rb

@@ -29,15 +29,11 @@ class RSATest < Minitest::Test
     assert Base64.strict_encode64(@rsa.decrypt(@rsa.encrypt('test')))
   end
 
-  def test_bad_encrypt_raises_exception
-    assert_raises Cryptosystem::EncryptError do
-      @rsa.encrypt(nil)
-    end
+  def test_encrypting_nil_value_returns_nil
+    assert_nil @rsa.encrypt(nil)
   end
 
-  def test_bad_decrypt_raises_exception
-    assert_raises Cryptosystem::DecryptError do
-      @rsa.decrypt(nil)
-    end
+  def test_decrypting_nil_value_returns_nil
+    assert_nil @rsa.decrypt(nil)
   end
 end

data/test/test_helper.rb

@@ -1,5 +1,9 @@
-require 'minitest/autorun'
 require 'cryptosystem'
+require 'minitest/autorun'
+
+if !defined?(Minitest::Test)
+  Minitest::Test = MiniTest::Unit::TestCase
+end
 
 Cryptosystem::RSA.configure do |config|
   config.password = 'test'

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: cryptosystem
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Josh Wetzel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-14 00:00:00.000000000 Z
+date: 2016-05-18 00:00:00.000000000 Z
 dependencies: []
-description: 
+description: |2
+      Cryptosystem is a Ruby library facilitating simple encryption and
+      decryption with asymmetric cryptography (or public-key cryptography).
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - LICENSE
+- README.md
 - Rakefile
 - cryptosystem.gemspec
 - lib/cryptosystem.rb
 - lib/cryptosystem/base.rb
 - lib/cryptosystem/exceptions.rb
 - lib/cryptosystem/rsa.rb
+- lib/cryptosystem/version.rb
 - test/cryptosystem/rsa_test.rb
 - test/keys/rsa.key
 - test/keys/rsa.pub
@@ -51,5 +57,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Asymmetric encryption
+summary: Simple asymmetric (public-key) encryption.
 test_files: []