credify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2d00a170decb583685246f229dced080b4eb29399773680f0e8599ee8873af7
+  data.tar.gz: 12d6f970b75bd07c67cfa444e2c8ae7e7a2a5c70ed014cb52b375fb81a21cf20
+SHA512:
+  metadata.gz: 8a7b1682b30baffd0ef0c413ae6b26e9a24203323da32be9e59fc63f8a37c25c95b2dbc9ce4423ff9fb917429431693680d47a70275e9c12cb2cea41e70be470
+  data.tar.gz: '058461c70f4d213b42216407bd996237cfe207883e732bfb19d1cd1dd7b53bc35efc081c439312491c0e2780ea52277cace79e42a61e0c697546890baa77a0c5'

data/.gitignore

@@ -0,0 +1,14 @@
+.idea
+.vscode
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ngo38114@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in credify.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'ed25519'
+gem 'openssl-oaep'
+gem 'openssl_pkcs8_pure'

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    credify (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    ed25519 (1.2.4)
+    openssl-oaep (0.1.0)
+    openssl_pkcs8_pure (0.0.0.2)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  credify!
+  ed25519
+  openssl-oaep
+  openssl_pkcs8_pure
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 ngo275
+
+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,80 @@
+# Credify
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'credify'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install credify
+
+## Usage
+
+### Signing
+
+Signing is using EdDSA (curve: Ed25519). The key size is 32 bytes. This SDK uses 32 byte length seed data for importing an existing key.
+
+```ruby
+require 'credify'
+
+def new_key_is_generated
+  signing = Signing.new
+  signing.generate_key_pair
+  signature = signing.sign "message"
+  valid = signing.verify "message", signature
+  puts valid
+end
+
+def existing_key_is_used
+  signing = Signing.new
+  signing.import_seed "UseZb/HIOiqrYSLqVmMdbiILuLTdiGRA3hZ3QwiEiBU="
+  signature = signing.sign "message"
+  valid = signing.verify "message", signature
+  puts valid
+end
+```
+
+### Encryption
+
+Encryption is using RSA 4096 bit with OAEP padding. This SDK allows developers to use PKCS8 to deal with keys.
+
+```ruby
+require 'credify'
+
+def new_key_is_generated
+  encryption = Encryption.new
+  encryption.generate_key_pair
+  cipher_text = encryption.encrypt "secret message"
+  plain_text = encryption.decrypt cipher_text
+end
+
+def existing_key_is_used
+  encryption = Encryption.new
+  encryption.import_private_key "-----BEGIN PRIVATE KEY-----\nMI....."
+  cipher_text = encryption.encrypt "secret message"
+  plain_text = encryption.decrypt cipher_text 
+end
+```
+
+## 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).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Credify project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/credify/blob/master/CODE_OF_CONDUCT.md).

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 "credify"
+
+# 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/credify.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/credify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "credify"
+  spec.version       = Credify::VERSION
+  spec.authors       = ["credify-pte-ltd"]
+  spec.email         = ["dev@credify.one"]
+
+  spec.summary       = %q{Credify SDK for Ruby}
+  spec.description   = %q{This is a Ruby SDK to integrate with Credify system.}
+  spec.homepage      = "https://credify.one"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/credify-pte-ltd/CredifyRuby.git"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

data/lib/credify.rb

@@ -0,0 +1,6 @@
+require "credify/version"
+
+module Credify
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/credify/encryption.rb

@@ -0,0 +1,169 @@
+require 'openssl'
+require 'openssl/oaep'
+require "base64"
+require 'openssl_pkcs8_pure'
+
+class Encryption
+  attr_reader :private_key, :public_key
+
+  #
+  # generate_key_pair
+  # @return [Boolean]
+  def generate_key_pair
+    key = OpenSSL::PKey::RSA.generate(4096, 17)
+    @private_key = key
+    @public_key = key.public_key
+    @private_key.nil?
+  end
+
+  #
+  # import_private_key
+  # @param [String] pem
+  # @return [Boolean]
+  def import_private_key(pem)
+    key = OpenSSL::PKey::RSA.new pem
+    @private_key = key
+    @public_key = key.public_key
+    @private_key.nil?
+  end
+
+  #
+  # import_public_key
+  # @param [String] pem
+  # @return [Boolean]
+  def import_public_key(pem)
+    key = OpenSSL::PKey::RSA.new pem
+    # @private_key = key
+    @public_key = key.public_key
+    @public_key.nil?
+  end
+
+  #
+  # import_private_key_base64_url
+  # @param [String] payload - Base64 URL encoded string
+  # @return [Boolean]
+  def import_private_key_base64_url(payload)
+    bytes = short_urlsafe_decode64(payload)
+    base64 = Base64.encode64(bytes)
+    formatted = base64.scan(/.{1,64}/).join("\n")
+    pem = add_box('PRIVATE KEY', formatted)
+    import_private_key(pem)
+  end
+
+  #
+  # import_public_key_base64_url
+  # @param [String] payload - Base64 URL encoded string
+  # @return [Boolean]
+  def import_public_key_base64_url(payload)
+    bytes = short_urlsafe_decode64(payload)
+    base64 = Base64.encode64(bytes)
+    formatted = base64.scan(/.{1,64}/).join("\n")
+    pem = add_box('PUBLIC KEY', formatted)
+    import_public_key(pem)
+  end
+
+  #
+  # encrypt
+  # @param [String] message
+  # @return [String] Base64 URL encoded string after encryption
+  def encrypt(message)
+    if @public_key.nil?
+      raise Exception.new 'Please pass public key'
+    end
+    label = ''
+    md = OpenSSL::Digest::SHA256
+    cipher_text = @public_key.public_encrypt_oaep(message, label, md)
+    short_urlsafe_encode64(cipher_text)
+  end
+
+  #
+  # decrypt
+  # @param [String] cipher - Base64 URL encoded cipher text
+  # @return [String] Plain text
+  def decrypt(cipher)
+    if @private_key.nil?
+      raise Exception.new 'Please pass private key'
+    end
+    label = ''
+    md = OpenSSL::Digest::SHA256
+    raw_cipher = short_urlsafe_decode64(cipher)
+    raw_text = @private_key.private_decrypt_oaep(raw_cipher, label, md)
+    raw_text
+  end
+
+  #
+  # export_private_key
+  # @param [Boolean] in_base64_url
+  # @return [Signing] - PCKS8 PEM or Base64 URL encoded string
+  def export_private_key(in_base64_url = false)
+    if @private_key.nil?
+      raise Exception.new 'Please pass private key'
+    end
+    pem = @private_key.to_pem_pkcs8.gsub(/#{$/}$/, "")
+
+    if in_base64_url
+      formatted = remove_box('PRIVATE KEY', pem)
+      short_urlsafe_encode64(Base64.decode64(formatted))
+    else
+      pem
+    end
+  end
+
+  #
+  # export_public_key
+  # @param [Boolean] in_base64_url
+  # @return [Signing] - PCKS8 PEM or Base64 URL encoded string
+  def export_public_key(in_base64_url = false)
+    if @public_key.nil?
+      raise Exception.new 'Please pass public key'
+    end
+
+    pem = @public_key.to_pem_pkcs8.gsub(/#{$/}$/, "")
+
+    if in_base64_url
+      formatted = remove_box('PUBLIC KEY', pem)
+      short_urlsafe_encode64(Base64.decode64(formatted))
+    else
+      pem
+    end
+  end
+
+
+  protected
+
+
+  # remove_box
+  # @param [String] tag - Either 'PUBLIC KEY' or 'PRIVATE KEY'
+  # @param [String] pem - String value loaded from a PEM file
+  # @return [String] - Base64 encoded string in PEM file
+  def remove_box(tag, pem)
+    tmp = pem.gsub("-----BEGIN #{tag}-----", '')
+    tmp = tmp.gsub("-----END #{tag}-----", '')
+    tmp.gsub(/\n/, '')
+  end
+
+  #
+  # add_box
+  # @param [String] tag - Either 'PUBLIC KEY' or 'PRIVATE KEY'
+  # @param [String] base64 - Base64 encoded string
+  # @return [String] - PEM
+  def add_box(tag, base64)
+    payload = base64.scan(/.{1,64}/).join("\n")
+    "-----BEGIN #{tag}-----\n" << payload << "\n-----END #{tag}-----"
+  end
+
+  #
+  # short_urlsafe_encode64
+  # @param [Binary] - str
+  # @return [String] - Base64 URL encoded string without padding
+  def short_urlsafe_encode64(bytes)
+    Base64.urlsafe_encode64(bytes).delete('=')
+  end
+
+  #
+  # short_urlsafe_decode64
+  # @return [Binary]
+  def short_urlsafe_decode64(str)
+    Base64.urlsafe_decode64(str + '=' * (-1 * str.size & 3))
+  end
+end

data/lib/credify/signing.rb

@@ -0,0 +1,77 @@
+require "ed25519"
+require "base64"
+require 'openssl_pkcs8_pure'
+
+class Signing
+  attr_reader :signing_key
+
+  #
+  # generate_key_pair
+  # @return [Boolean]
+  def generate_key_pair
+    @signing_key = Ed25519::SigningKey.generate
+    @signing_key.nil?
+  end
+
+  #
+  # import_seed
+  # @param [String] seed - Base64 encoded 32 byte seed data
+  # @return [Boolean]
+  def import_seed(seed)
+    @signing_key = Ed25519::SigningKey.new(Base64.decode64(seed))
+    @signing_key.nil?
+  end
+
+  #
+  # sign
+  # @param [String] message - String value you want to sign
+  # @return [String] - Base64 URL encoded signature
+  def sign(message)
+    if @signing_key.nil?
+      raise Exception.new 'Please pass signing key'
+    end
+    signature = @signing_key.sign(message)
+    short_urlsafe_encode64(signature)
+  end
+
+  #
+  # verify
+  # @param [String] signature - Base64 URL encoded signature
+  # @param [String] message - Plain text to be signed
+  # @return [Boolean]
+  def verify(signature, message)
+    if @signing_key.nil?
+      raise Exception.new 'Please pass signing key'
+    end
+    raw_sign = short_urlsafe_decode64(signature)
+    @signing_key.verify_key.verify raw_sign, message
+  end
+
+  #
+  # export_seed
+  # @return [String] - Base64 encoded 32 bytes seed data
+  def export_seed
+    if @signing_key.nil?
+      raise Exception.new 'Please pass signing key'
+    end
+    Base64.encode64(@signing_key.seed)
+  end
+
+  protected
+
+  #
+  # short_urlsafe_encode64
+  # @param [Binary] - str
+  # @return [String] - Base64 URL encoded string without padding
+  def short_urlsafe_encode64(bytes)
+    Base64.urlsafe_encode64(bytes).delete('=')
+  end
+
+  #
+  # short_urlsafe_decode64
+  # @return [Binary]
+  def short_urlsafe_decode64(str)
+    Base64.urlsafe_decode64(str + '=' * (-1 * str.size & 3))
+  end
+
+end

data/lib/credify/version.rb

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

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: credify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- credify-pte-ltd
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-04-05 00:00:00.000000000 Z
+dependencies: []
+description: This is a Ruby SDK to integrate with Credify system.
+email:
+- dev@credify.one
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- credify.gemspec
+- lib/credify.rb
+- lib/credify/encryption.rb
+- lib/credify/signing.rb
+- lib/credify/version.rb
+homepage: https://credify.one
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://credify.one
+  source_code_uri: https://github.com/credify-pte-ltd/CredifyRuby.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Credify SDK for Ruby
+test_files: []