ossl_rsa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ea603bcf1f6ccd4ce66c1bac0791dc568953a38
+  data.tar.gz: a0904b70de93fb4397138a7bc746c481bba154a8
+SHA512:
+  metadata.gz: ad76ee44d12a44ba7a6df406042a7d2a7fc66da1ba57c8c9be7c3cc41416a0aadd2325a4cb4874f32cc11ef27793ad18ca0b03177df85294cc593243e8cd4e3e
+  data.tar.gz: 86e96223cbe904cff5bfa86f738dfd92a1cd3c454e748adf4e36d04742f57e060f51df64ab554d3c2488280a716d054c01000871daea50b19e8218fd54836d90

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,4 @@
+language: ruby
+rvm:
+  - 2.1.8
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 h.shigemoto
+
+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,52 @@
+# OsslRsa
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ossl_rsa`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+This gem provide RSA encryption and sign, verify by openssl lib.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ossl_rsa'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ossl_rsa
+
+## Usage
+
+Encrypt and decrypt sample.
+
+```ruby
+require 'ossl_rsa'
+
+rsa = OsslRsa::Rsa.new({size: 2048})
+enc_value = rsa.encrypt("encrypt value")
+puts enc_value
+
+dec_value = rsa.decrypt(enc_value)
+puts dec_value
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/h-shigemoto/ossl_rsa. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,207 @@
+require "openssl"
+require "base64"
+require "securerandom"
+
+# openssl rsa module.
+module OsslRsa
+
+  # rsa class
+  class Rsa
+
+    # constructor.
+    # generate rsa instance by options.
+    # options[:size] : key size
+    # options[:obj] : pem or der
+    # options[:pass] : password
+    # @param [Hash] options generate options.
+    def initialize(options={})
+
+      # if size and private exist, raise error.
+      if (!options[:size].nil? && !options[:obj].nil?)
+        raise OpenSSL::PKey::RSAError "size and obj is nil."
+      end
+
+      # if exist size, generate use size, cipher.
+      unless options[:size].nil?
+        @rsa = generate_rsa_by_size(options[:size])
+      end
+
+      # if exist obj, generate use obj, pass.
+      unless options[:obj].nil?
+        @rsa = generate_rsa_by_key(options[:obj], options[:pass])
+      end
+
+      # raise Error
+      if @rsa.nil?
+        raise OpenSSL::PKey::RSAError "fail create rsa instance."
+      end
+    end
+
+    # encrypt RSA. use public_key.
+    # @param [String] value encrypt target value.
+    # @param [integer] mode padding mode.
+    # @param [boolean] base64_encode base64 encode flag.
+    # @return [String] encrypt value.
+    def encrypt(value, mode=OpenSSL::PKey::RSA::PKCS1_PADDING, base64_encode=true)
+
+      # not public, return nil.
+      return nil unless @rsa.public?
+
+      encrypt_value = @rsa.public_encrypt(value, mode)
+      # base64 encode.
+      if base64_encode
+        encrypt_value = Base64.encode64(encrypt_value)
+      end
+      encrypt_value
+    end
+
+    # decrypt RSA. use private_key.
+    # @param [String] value decrypt target value.
+    # @param [integer] mode padding mode.
+    # @param [boolean] base64_decode base64 decode flag.
+    # @return [String] decrypt value.
+    def decrypt(value, mode=OpenSSL::PKey::RSA::PKCS1_PADDING, base64_decode=true)
+
+      # not private, return nil.
+      return nil unless @rsa.private?
+
+      # base64 decode
+      if base64_decode
+        value = Base64.decode64(value)
+      end
+
+      decrypt_value = @rsa.private_decrypt(value, mode)
+      decrypt_value
+    end
+
+    # sign data.
+    # @param [String] digest digest method.
+    # @param [String] value sign target value.
+    # @param [boolean] base64_encode base64 encode flag.
+    # @return [String] sign value.
+    def sign(digest, value, base64_encode=true)
+
+      # not private, return nil.
+      return nil unless @rsa.private?
+
+      sign_value = @rsa.sign(digest, value)
+      # base64 encode.
+      if base64_encode
+        sign_value = Base64.encode64(sign_value)
+      end
+      sign_value
+    end
+
+    # verify sign value.
+    # @param [String] digest digest method.
+    # @param [String] sign sign value.
+    # @param [String] value compare target value.
+    # @param [boolean] base64_decode base64 decode flag.
+    # @return [boolean] verify result.
+    def verify(digest, sign, value, base64_decode=true)
+
+      # not private, return false.
+      return false unless @rsa.private?
+
+      # base64 decode.
+      if base64_decode
+        sign = Base64.decode64(sign)
+      end
+      @rsa.verify(digest, sign, value)
+    end
+
+    # private check.
+    # @return [boolean] OpsnSSL::PKey::RSA.private?
+    def private?
+      @rsa.private?
+    end
+
+    # public check.
+    # @return [boolean] OpenSSL::PKey::RSA.public?
+    def public?
+      @rsa.public?
+    end
+
+    # get private and public key.
+    # private key set self OpenSSL::PKey::RSA instance.
+    # @return [Hash] key pair hash. xx[:private] = private_key, xx[:public] = public_key
+    def key_pair(mode, cipher=nil, pass=nil)
+
+      private_key = get_private_key(mode, cipher, pass)
+      public_key = get_public_key(mode, cipher, pass)
+
+      { private: private_key, public: public_key }
+    end
+
+    private
+
+    # generate rsa.
+    # @param [integer] size key size.
+    # @return [OpenSSL::PKey::RSA] rsa instance.
+    def generate_rsa_by_size(size)
+
+      # add seed.
+      OpenSSL::Random.seed(SecureRandom.hex(8))
+      # generate rsa instance.
+      rsa = OpenSSL::PKey::RSA.new(size)
+      rsa
+    end
+
+    # generate rsa.
+    # @param [String] pem / der.
+    # @param [String] pass password
+    # @return [OpenSSL::PKey::RSA] rsa instance.
+    def generate_rsa_by_key(obj, pass=nil)
+
+      rsa = OpenSSL::PKey::RSA.new(obj, pass)
+      rsa
+    end
+
+    # get private key.
+    # @param [integer] mode pem or der.
+    # @param [OpenSSL::Cipher] cipher cipher instance.
+    # @param [String] pass password
+    # @return [String] pem or der private key.
+    def get_private_key(mode, cipher, pass)
+
+      # if not have private_key, return nil
+      return nil unless @rsa.private?
+
+      cv_key = convert_key(mode, @rsa, cipher, pass)
+      cv_key
+    end
+
+    # get public key.
+    # @param [integer] mode pem or der.
+    # @param [OpenSSL::Cipher] cipher cipher instance.
+    # @param [String] pass password
+    # @return [String] pem or der public key.
+    def get_public_key(mode, cipher, pass)
+
+      # if not have public_key, return nil
+      return nil unless @rsa.public?
+
+      cv_key = convert_key(mode, @rsa.public_key, cipher, pass)
+      cv_key
+    end
+
+    # convert key to pem or der.
+    # @param [integer] mode pem or der.
+    # @param [OpsnSSL::PKey::RSA] key rsa key.
+    # @param [OpenSSL::Cipher] cipher cipher instance.
+    # @param [String] pass password
+    # @return [String] pem or der key.
+    def convert_key(mode, key, cipher, pass)
+      
+      cv_key = nil
+      # convert public key.
+      if mode == PEM
+        cv_key = key.to_pem(cipher, pass)
+      elsif mode == DER
+        cv_key = key.to_der
+      end
+
+      cv_key
+    end
+  end
+end

data/lib/ossl_rsa/version.rb

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

data/lib/ossl_rsa.rb

@@ -0,0 +1,11 @@
+require "ossl_rsa/version"
+require "ossl_rsa/rsa"
+
+# openssl rsa module.
+module OsslRsa
+
+  # pem mode.
+  PEM = 0
+  # der mode.
+  DER = 1
+end

data/ossl_rsa.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ossl_rsa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ossl_rsa"
+  spec.version       = OsslRsa::VERSION
+  spec.authors       = ["h.shigemoto"]
+  spec.email         = ["corporation.ore@gmail.com"]
+
+  spec.summary       = %q{This gem provide RSA encryption and sign, verify.}
+  spec.description   = %q{This gem provide RSA encryption and sign, verify by openssl lib.}
+  spec.homepage      = "https://github.com/h-shigemoto/ossl_rsa"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem 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 { |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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ossl_rsa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- h.shigemoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem provide RSA encryption and sign, verify by openssl lib.
+email:
+- corporation.ore@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ossl_rsa.rb
+- lib/ossl_rsa/rsa.rb
+- lib/ossl_rsa/version.rb
+- ossl_rsa.gemspec
+homepage: https://github.com/h-shigemoto/ossl_rsa
+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.6.3
+signing_key: 
+specification_version: 4
+summary: This gem provide RSA encryption and sign, verify.
+test_files: []
+has_rdoc: