toy-ore 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c57cc63d9ef567689c02c61ff7bc7b96116be43d6bc3dc439f799c6994fc7809
+  data.tar.gz: ebf214fa64fc581e8f66187360cd60ea34524d2482f176f3876db5580fbf1e6b
+SHA512:
+  metadata.gz: 14e619355df2d705b0a44babe95ddbb871add95a11a8b0bd693b2a59c8d7ba26f3e1007beb3432ff6e82a56e9faa691aa18846fddb383c48435b1adc854bf980
+  data.tar.gz: ff6badcdb167a2e76a666edf57350c2639c78b66db77e07c8bcb211636b2a65e8327ee1fbc563a5112fe9afe7484bb6438d6a2176810125b2ae2804ab8d9bd9a

data/lib/toy_ore/scheme.rb

@@ -0,0 +1,193 @@
+module ToyOre
+  module Scheme
+    # Encrypts a comparison result by XOR'ing the iv and key. Then XORing that result with the comparaison result.
+    #
+    # Uses an IV for non-determinism.
+    #
+    # A Boolean logic operation that compares two input bits and generates one output bit.
+    # If the bits are the same, the result is 0. If the bits are different, the result is 1.
+    # ^ represents the xor operator
+    #
+    # @param iv [Integer]
+    #
+    # @param key [Integer]
+    #
+    # @param cmp_result [Integer] -1, 0, 1
+    #
+    # @return [Integer]
+    def self.encrypt(iv, key, cmp_result)
+      (iv ^ key) ^ cmp_result
+      # binding.pry
+    end
+
+    # Compares 2 plaintexts and returns a cmp_result.
+    # If a < b -1
+    # If a == b 0
+    # if a > b 1
+    #
+    # @param a [Integer] A plaintext integer value
+    #
+    # @param b [Integer] A plaintext integer value
+    #
+    # @return cmp_result [Integer] The comparison result
+    def self.compare_plaintexts(a, b)
+      if a < b
+        return -1
+      elsif a == b
+        return 0
+      else
+        return 1
+      end
+    end
+
+    # Compares the left part of a ciphertext with the right part of a ciphertext,
+    # created by the same ore client. egToyOre::Scheme::OreScheme.new()
+    #
+    # @param left_ciphertext [Object]
+    #
+    # @param right_ciphertext [Object]
+    #
+    #
+    # @ return [Integer] The comparison result
+    # -1 if the left ciphertext is less than the right ciphertext
+    #
+    # 0 if the left ciphertext is equal to the right ciphertext
+    #
+    # 1 if the left ciphertext is greater than the right ciphertext
+    #
+    # To get the comparison result:
+    # We need the iv from the right ciphertext.
+    # The key from the left ciphertext.
+    # The value at the index of the offset from the left ciphertext, in the right ciphertext's encryption array.
+    # When we Xor the iv and key, with the encrypted value we get the comparison result
+
+    # eg
+    # [1] pry(ToyOre::Scheme)> iv
+    # => 416
+    # [2] pry(ToyOre::Scheme)> key
+    # => 208
+    # [3] pry(ToyOre::Scheme)> iv ^ key
+    # => 368
+    # [4] pry(ToyOre::Scheme)> (iv ^ key) ^ cmp_result
+    # => -369
+    # [5] pry(ToyOre::Scheme)> (iv ^ key) ^ -369
+    # => -1
+    def self.compare_ciphertexts(left_ciphertext, right_ciphertext)
+      (right_ciphertext.iv ^ left_ciphertext.key) ^ right_ciphertext.encryptions[left_ciphertext.offset]
+    end
+
+    class LeftCiphertext
+      attr_reader :offset, :key
+
+      def initialize(offset, key)
+        @offset = offset
+        @key = key
+      end
+
+      def <=>(right_ciphertext)
+        ToyOre::Scheme.compare_ciphertexts(self, right_ciphertext)
+      end
+    end
+
+    class RightCiphertext
+      attr_reader :iv, :encryptions
+
+      def initialize(iv, encryptions)
+        @iv = iv
+        @encryptions = encryptions
+      end
+
+      def <=>(left_ciphertext)
+        ToyOre::Scheme.compare_ciphertexts(left_ciphertext, self)
+      end
+    end
+
+    class OreCiphertext
+      attr_reader :left, :right
+
+      def initialize(offset, key, iv, encryptions)
+        @left = LeftCiphertext.new(offset, key)
+        @right = RightCiphertext.new(iv, encryptions)
+      end
+    end
+
+    class OreScheme
+      def initialize
+        # Highlight that these are secrets.
+        # PRF key
+        @keys = (0..255).to_a.shuffle()
+        # PRP key
+        @prp = (0..255).to_a.shuffle()
+      end
+
+      def encrypt(plaintext)
+        iv = rand(0..255)
+        # This represents all the values in the domain.
+
+        # This is a small domain example.
+        # This is 1 block, 1 byte, 8 bits, total value is 256.
+        domain = (0..255).to_a
+
+        # Array to hold the encrypted value of the cmp result for each value in the domain.
+        encryptions = []
+
+        domain.each do |d|
+          # The offset is what ever index d (the plaintext) is in the shuffled PRP array.
+          # If we used the plaintext value as the offset, this would give away the value of the plaintext.
+          # Using the PRP, swaps the plaintext value for a random number in the PRP to store the encrypted
+          # comparison result in the right ciphertext encryptions array.
+          offset = @prp[d]
+
+          # Compare the domain value to the plaintext value
+          # We get -1, 0 or 1 here.
+          cmp_result = ToyOre::Scheme.compare_plaintexts(d, plaintext)
+
+          # At index offset in the encryptions array
+          # set the xor'd value of (iv and value) xor'd with the cmp result
+          # to the index at the offset value.
+
+          # We store the encrypted value of the comparison result
+          # in the encryptions array
+          # at the index = to the offset.
+          #
+          # To encrypt we pass the random iv, the key is the value at the offset index in the
+          # random shuffled key array.
+          #
+          #
+          encryptions[offset] = ToyOre::Scheme.encrypt(iv, @keys[offset], cmp_result)
+        end
+
+        # The left ciphertext:
+        # Query ciphertext
+        # 1.  Stores the value of the offset.
+
+        #     The offset is the index of the encrypted comparison result,
+        #     in the encryptions array.
+        #
+        # 2.  Stores the key that was used to encrypt the comparison result.
+        #
+        # The right ciphertext:
+        # Persisted
+        #
+        # 1.  Stores the IV used in the encryption
+        # 2.  Stores an array of all encrypted comparison results.
+        #
+        #
+        OreCiphertext.new(@prp[plaintext], @keys[@prp[plaintext]], iv, encryptions)
+      end
+    end
+  end
+end
+
+
+# TODO make ciphertext a class.
+# make left a class and right a class
+# on the left ciphertext implement the comparison
+
+# class LeftCiphertext
+#   def <=>(right_ciphertext)
+#     ToyOre::Scheme.compare_ciphertexts(self, right_ciphertext
+
+#     )
+#   end
+# end

data/lib/toy_ore.rb

@@ -0,0 +1,2 @@
+require "toy_ore/scheme"
+

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: toy-ore
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Fiona McCawley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-02 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A toy library to get an understanding of how ore encryption works. This
+  is an unsafe implementation, only to be used for educational purposes. DO NOT USE
+  IN PRODUCTION.
+email: fimccawley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/toy_ore.rb
+- lib/toy_ore/scheme.rb
+homepage: https://rubygems.org/gems/toy-ore
+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: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: toy-ore
+test_files: []