ccipher_box 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 588c5b4cfb98d61250968d893559547a833211609fd120002f57b65ee49c6a56
+  data.tar.gz: ca46003f1b54cea793e1784566685ba351e905498b0f05b4f7cfdf352ba18c2e
+SHA512:
+  metadata.gz: ab0df6ac4faabafc663bd9bc10acb8d28c8dea10995779c24996e8d9bf09db2d1e3f5034f7955b2e97d6ff19e48f2bfdf67cb19277907295ff92cdeb1fd1c3cc
+  data.tar.gz: de43f592c27a000d9a3a16a12acd0c3c1b4fac29f75531c5211a77605c1603c4f7605367368388860a558553293475883d1f9e106b11d52d4f20820aa28b05ef

data/.rspec

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

data/Gemfile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ccipher_box.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+#gem 'teLogger', git: 'teLogger', branch: "main"
+
+#gem 'ccrypto', git: 'ccrypto', branch: 'main'
+
+require 'toolrack'
+if TR::RTUtils.on_java?
+  #gem 'ccrypto-java', git: 'ccrypto-java', branch: 'main'
+  gem 'ccrypto-java'
+else
+  #gem 'ccrypto-ruby', git: 'ccrypto-ruby', branch: 'main'
+  gem 'ccrypto-ruby'
+end
+
+#gem 'ccipher_factory', git: 'ccipher_factory', branch: 'master'
+
+#gem 'binenc', git: 'binenc', branch: 'master'
+if TR::RTUtils.on_java?
+  #gem 'binenc-java', git: 'binenc-java', branch: 'master'
+  gem 'binenc-java'
+else
+  #gem 'binenc-ruby', git: 'binenc-ruby', branch: 'master'
+  gem 'binenc-ruby'
+end
+

data/Gemfile.lock-java

@@ -0,0 +1,89 @@
+GIT
+  remote: binenc
+  revision: 632483d860fbd853915276043b42354ebd2d9aea
+  branch: master
+  specs:
+    binenc (0.1.0)
+      teLogger
+      toolrack
+
+GIT
+  remote: binenc-java
+  revision: 3bfd9d07b7e440bace27082731a5f4361eb36f32
+  branch: master
+  specs:
+    binenc-java (0.1.0)
+      teLogger
+      toolrack
+
+GIT
+  remote: ccipher_factory
+  revision: a7a6d8f59204ca028c60f02c1989c1020cae2ae6
+  branch: master
+  specs:
+    ccipher_factory (0.1.0)
+      tlogger
+
+GIT
+  remote: ccrypto
+  revision: 00f0b61a565e75d297c42dc20e01aac167df2a1a
+  branch: main
+  specs:
+    ccrypto (0.1.0)
+      teLogger
+      toolrack
+
+GIT
+  remote: ccrypto-java
+  revision: 36893ec953006080052ebe318ef7ae0551be30cd
+  branch: main
+  specs:
+    ccrypto-java (0.1.0)
+
+PATH
+  remote: .
+  specs:
+    ccipher_box (0.1.0)
+      teLogger
+      toolrack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base58 (0.2.3)
+    diff-lcs (1.5.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    teLogger (0.1.0)
+    tlogger (0.26.3)
+    toolrack (0.18.6)
+      base58
+      tlogger
+
+PLATFORMS
+  universal-java-11
+
+DEPENDENCIES
+  binenc!
+  binenc-java!
+  ccipher_box!
+  ccipher_factory!
+  ccrypto!
+  ccrypto-java!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.3.6

data/Gemfile.lock-ruby

@@ -0,0 +1,91 @@
+GIT
+  remote: binenc
+  revision: 632483d860fbd853915276043b42354ebd2d9aea
+  branch: master
+  specs:
+    binenc (0.1.0)
+      teLogger
+      toolrack
+
+GIT
+  remote: binenc-ruby
+  revision: 1c7ae0ec51c41d7258014f72dafbb9d8f5d90b89
+  branch: master
+  specs:
+    binenc-ruby (0.1.0)
+      teLogger
+      toolrack
+
+GIT
+  remote: ccipher_factory
+  revision: a7a6d8f59204ca028c60f02c1989c1020cae2ae6
+  branch: master
+  specs:
+    ccipher_factory (0.1.0)
+      tlogger
+
+GIT
+  remote: ccrypto
+  revision: 00f0b61a565e75d297c42dc20e01aac167df2a1a
+  branch: main
+  specs:
+    ccrypto (0.1.0)
+      teLogger
+      toolrack
+
+GIT
+  remote: ccrypto-ruby
+  revision: ddd3d62aef5d51c698f295486d4f69d686cf7d48
+  branch: main
+  specs:
+    ccrypto-ruby (0.1.0)
+      teLogger
+      toolrack
+
+PATH
+  remote: .
+  specs:
+    ccipher_box (0.1.0)
+      teLogger
+      toolrack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base58 (0.2.3)
+    diff-lcs (1.5.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    teLogger (0.1.0)
+    tlogger (0.26.3)
+    toolrack (0.18.6)
+      base58
+      tlogger
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  binenc!
+  binenc-ruby!
+  ccipher_box!
+  ccipher_factory!
+  ccrypto!
+  ccrypto-ruby!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.28

data/README.md

@@ -0,0 +1,35 @@
+# CcipherBox
+
+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/ccipher_box`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ccipher_box'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ccipher_box
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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/[USERNAME]/ccipher_box.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+require 'devops_assist'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ccipher_box"
+
+# 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/ccipher_box.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "lib/ccipher_box/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ccipher_box"
+  spec.version       = CcipherBox::VERSION
+  spec.authors       = ["Ian"]
+  spec.email         = ["cameronian0@protonmail.com"]
+
+  spec.summary       = ""
+  spec.description   = ""
+  spec.homepage      = ""
+  spec.required_ruby_version = ">= 2.4.0"
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  #spec.metadata["homepage_uri"] = spec.homepage
+  #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "toolrack"
+  spec.add_dependency "teLogger"
+
+  spec.add_dependency 'ccrypto'
+  spec.add_dependency 'binenc'
+  spec.add_dependency 'ccipher_factory'
+
+  spec.add_development_dependency 'devops_assist'
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/ccipher_box/bin_struct.rb

@@ -0,0 +1,167 @@
+
+require 'singleton'
+require_relative 'binenc_constant'
+
+module CcipherBox
+  class BinStruct
+    include Singleton
+
+    def struct(key, ver = "1.0")
+      st = structure(ver)[key] 
+      st.clone if not st.nil?
+    end
+
+    def struct_from_bin(bin)
+      type, ver = struct_fields_from_bin(bin, 0, 1)
+      c = CBTag.value_constant(type) 
+      st = struct(c, translate_version(ver))
+      st.from_bin(bin) if not st.nil?
+    end
+
+    def struct_fields_from_bin(bin, *args)
+      Binenc::EngineFactory.instance(:bin_struct).value_from_bin_struct(bin, *args)
+    end
+
+    def find_struct(buf, &block)
+
+      cpos = buf.pos
+
+      begin
+
+        #len = find_asn1_length(buf.string)
+        len = Ccrypto::ASN1.engine.asn1_length(buf.bytes)
+        #logger.debug "Found meta length : #{len}" if not logger.nil?
+        raise InsufficientData if len == 0
+
+        buf.rewind
+        meta = buf.read(len)
+
+        if block
+          block.call(meta, buf.read(cpos-len))
+        else
+          meta
+        end
+
+        #rescue OpenSSL::ASN1::ASN1Error => ex
+      rescue Ccrypto::ASN1EngineException => ex
+        logger.error ex
+        buf.seek(cpos)
+        raise InsufficientData
+      end
+      
+    end
+
+    private
+    def logger
+      if @logger.nil?
+        @logger = TeLogger::Tlogger.new
+        @logger.tag = :binstruct
+      end
+      @logger
+    end
+
+    def structure(ver = "1.0")
+      
+      if @struct.nil?
+        @struct = {  }
+
+        @struct["1.0"] = {
+
+          keybox: Binenc::EngineFactory.instance(:bin_struct).define do
+            oid :oid, CBTag.constant_value(:keybox)
+            int :version, 0x0100
+            bin :kdfConfig
+          end,
+
+
+          mem_key_layer: Binenc::EngineFactory.instance(:bin_struct).define do
+            oid :oid, CBTag.constant_value(:mem_key_layer)
+            int :version, 0x0100
+            bin :material
+            bin :payload
+          end,
+
+          mem_key_envp: Binenc::EngineFactory.instance(:bin_struct).define do
+            oid :oid, CBTag.constant_value(:mem_key_envp)
+            int :version, 0x0100
+            bin :kcv
+            bin :kcvconfig
+            bin :layer
+          end,
+
+          ccipherbox_keywrap: Binenc::EngineFactory.instance(:bin_struct).define do
+            oid :oid, CBTag.constant_value(:ccipherbox_keywrap)
+            int :version, 0x0100
+            bin :keyid
+            bin :keyConfig
+            bin :cipher
+          end,
+
+          keyConfig: Binenc::EngineFactory.instance(:bin_struct).define do
+            oid :oid, CBTag.constant_value(:keyConfig)
+            int :version, 0x0100
+            str :name
+            bin :keyConfig
+          end,
+
+          keyConfig_from_base: Binenc::EngineFactory.instance(:bin_struct).define do
+            oid :oid, CBTag.constant_value(:keyConfig_from_base)
+            int :version, 0x0100
+            str :name
+            str :baseName
+            bin :baseKeyConfig
+            bin :keyConfig
+          end,
+
+          secure_ring: Binenc::EngineFactory.instance(:bin_struct).define do
+            oid :oid, CBTag.constant_value(:secure_ring)
+            int :version, 0x0100
+            str :name
+            bin :cipherSeed
+            seq :keyConfigs
+          end,
+
+          secure_rings: Binenc::EngineFactory.instance(:bin_struct).define do
+            oid :oid, CBTag.constant_value(:secure_rings)
+            int :version, 0x0100
+            seq :secure_rings
+          end,
+
+
+
+          ccipherbox_cipher: Binenc::EngineFactory.instance(:bin_struct).define do
+            oid :oid, CBTag.constant_value(:ccipherbox_cipher)
+            int :version, 0x0100
+            bin :keyConfig
+            seq :baseMaterial
+            bin :cipherConfig
+          end,
+
+          securebox: Binenc::EngineFactory.instance(:bin_struct).define do
+            oid :oid, CBTag.constant_value(:securebox)
+            int :version, 0x0100
+            # ccipherboxes struct
+            bin :engines 
+            seq :keyConfigs
+          end,
+
+
+        }
+      end
+
+      @struct[ver]
+
+    end
+
+    def translate_version(ver)
+      case ver.to_i
+      when 0x0100
+        "1.0"
+      else
+        raise Exception, "Version #{ver} is unknown"
+      end
+    end
+
+
+  end
+end

data/lib/ccipher_box/binenc_constant.rb

@@ -0,0 +1,38 @@
+
+
+if not defined?(CBTag)
+
+  CBTag = Binenc::BinTag.new
+
+  CBTag.load do
+
+    # hierarchy
+    define_constant(:root, '2.8.8.0') do
+      define_constant(:mem_key_layer, "#.10")
+      define_constant(:mem_key_envp, "#.11")
+
+
+      define_constant(:keybox, "#.30") 
+
+      define_constant(:secure_ring, "#.50") 
+      define_constant(:secure_rings, "#.51") 
+
+      define_constant(:ccipherbox, "#.80") do
+        define_constant(:keyConfig, "#.1") 
+        define_constant(:keyConfig_from_base, "#.2") 
+
+        define_constant(:ccipherbox_cipher, "#.10") 
+        define_constant(:ccipherbox_keywrap, "#.20")
+        #define_constant(:ccipherboxes, "#.20") 
+      end
+
+      define_constant(:securebox, "#.90") 
+    end
+
+    # constant
+    #define_constant(:sha1,         0x0101)
+
+  end
+
+
+end

data/lib/ccipher_box/decryption_engine.rb

@@ -0,0 +1,74 @@
+
+
+module CcipherBox
+  class DecryptionEngine
+    include TR::CondUtils
+
+    def initialize(vault)
+      @vault = vault
+    end
+
+    def init(output)
+       
+      raise CcipherBox::Error, "Output is mandatory" if output.nil?
+
+      @output = output
+      @intOut = MemBuf.new
+
+    end
+
+    def update(data)
+     
+      if @dec.nil?
+        @intOut.write(data)
+
+        BinStruct.instance.find_struct(@intOut) do |meta, data|
+
+          st = BinStruct.instance.struct_from_bin(meta)
+
+          st.baseMaterial.each do |ebm|
+
+            begin
+              
+              baseMat = @vault.decrypt(ebm)
+
+              sk = CcipherFactory::SymKey.from_encoded(st.keyConfig) do |ops|
+                case ops
+                when :password
+                  baseMat
+                end
+              end
+
+              @dec = CcipherFactory::SymKeyCipher.decryptor
+              @dec.output(@output)
+              @dec.key = sk
+              @dec.decrypt_init
+
+              @dec.decrypt_update_meta(st.cipherConfig)
+
+              @dec.decrypt_update_cipher(data) if not_empty?(data)
+
+              break
+
+            rescue KeyNotRegistered
+              # retry with next key
+            end
+
+          end
+
+          raise KeyNotRegistered, "Cannot find any loaded key decrypt this data" if @dec.nil?
+
+        end
+
+      else
+        @dec.decrypt_update_cipher(data)
+      end
+
+    end
+
+    def final
+      @dec.decrypt_final if not @dec.nil? 
+    end
+
+  end
+end

data/lib/ccipher_box/enc_key_config.rb

@@ -0,0 +1,78 @@
+
+
+module CcipherBox
+
+  # link between data encryption key name with their
+  # respective key configs
+  # In a specific configurations, there might be many
+  # data encryption key and the key config to derive
+  # the data encryption key from a base key is kept
+  # here for later rebuild the same key again
+  # Only used inside SecureRing
+  class EncKeyConfig
+    include TR::CondUtils
+
+    def initialize
+      @keyConfigs = {  }
+    end
+
+    def register_config(name, keyConfig)
+      @keyConfigs[name] = { config: keyConfig }  
+    end
+
+    def register_derive_config(name, keyConfig, baseName, baseKeyConfig)
+      @keyConfigs[name] = { config: keyConfig, base: baseName, baseConfig: baseKeyConfig } 
+    end
+
+    def keyConfigs
+      @keyConfigs.freeze
+    end
+
+    def is_derived_key?(hash)
+      not_empty?(hash[:base])
+    end
+
+    def encoded
+
+      configs = []
+      @keyConfigs.each do |name, val|
+
+        if not_empty?(val[:base])
+          st = BinStruct.instance.struct(:keyConfig_from_base)
+          st.name = name
+          st.keyConfig = val[:config]
+          st.baseName = val[:base]
+          st.baseKeyConfig = val[:baseConfig]
+        else
+          st = BinStruct.instance.struct(:keyConfig)
+          st.name = name
+          st.keyConfig = val[:config]
+        end
+
+        configs << st.encoded
+
+      end
+
+      configs
+
+    end
+
+    def self.from_encoded(seq)
+     
+      ekc = EncKeyConfig.new
+      seq.each do |sst|
+        st = BinStruct.instance.struct_from_bin(sst)
+        case st.oid
+        when CBTag.constant_value(:keyConfig)
+          ekc.register_config(st.name, st.keyConfig)
+        when CBTag.constant_value(:keyConfig_from_base)
+          ekc.register_config(st.name, st.keyConfig, st.baseName, st.baseKeyConfig)
+        end
+      end
+
+      ekc
+
+    end
+
+  end
+end