toy-ore 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14c402bcf1c22a95a7b4d60495aedbe250cd3a3275fa6188b1e37bc27d9687ea
-  data.tar.gz: 48f52855952c1a3e99abb71f6ad83f150a9e34740d5975b7b9633b8513284bf4
+  metadata.gz: 81f6a8809de85037a1fa3cbe0b9cc87f1294fd16e20ce5d4013bf129cbf02269
+  data.tar.gz: 8d7c2e1dd6dd66aea8506675c99e84de98cc8d48e363c753afd9703f36499a27
 SHA512:
-  metadata.gz: 75ea2afab70dc8ea9c8f6f955afc39cd061e4cb2ad8a273e4cd642417c8d492d57951091810886d72b165c11bb8e5117aa8f8700b297e8eb6c2b35ee577609ca
-  data.tar.gz: 17c96f1c99be3bf54be7bbde61125f1d1ecffe342d65e7e47b36e58f103b4b6bab07246316d5e246124802abd874f9219eed93d90dfd2f53a84ef2a1c47b2ec9
+  metadata.gz: 185e32105b0624161dbe1fff23cd5a58872595d3a0db3a630f387dd164a2f3deec2e9f080059c333bf931b14f387c1db203ca60a09fae75178011585b5abd567
+  data.tar.gz: b26ca8b171b0d4cac8910570b2dc853250c3897dfa426930c0a35f561dc5d6af20d78f0187e3c7c0f646c207740565b6aa1354b66c1879a7026673e1375331ed

data/lib/toy_ore/scheme.rb

@@ -17,13 +17,12 @@ module ToyOre
     # @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
+    # If a < b = -1
+    # If a == b = 0
+    # if a > b = 1
     #
     # @param a [Integer] A plaintext integer value
     #
@@ -49,6 +48,7 @@ module ToyOre
     #
     #
     # @ 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
@@ -112,27 +112,28 @@ module ToyOre
     end
 
     class OreScheme
-      def initialize
-        # Highlight that these are secrets.
+      def initialize(domain_size = 0..255)
+        @domain_size = domain_size
+
         # PRF key
-        @keys = (0..255).to_a.shuffle()
+        @prf = (domain_size).to_a.shuffle()
         # PRP key
-        @prp = (0..255).to_a.shuffle()
+        @prp = (domain_size).to_a.shuffle()
       end
 
       def encrypt(plaintext)
-        iv = rand(0..255)
-        # This represents all the values in the domain.
+        iv = rand(@domain_size)
 
+        # 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
+        domain = (@domain_size).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.
+          # The offset is what ever index d (domain value) 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.
@@ -154,40 +155,26 @@ module ToyOre
           # random shuffled key array.
           #
           #
-          encryptions[offset] = ToyOre::Scheme.encrypt(iv, @keys[offset], cmp_result)
+          encryptions[offset] = ToyOre::Scheme.encrypt(iv, @prf[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.
+        # 2.  Stores the key that was used to encrypt the comparison result
+        #     at the offset in the right ciphertext.
         #
         # 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)
+        OreCiphertext.new(@prp[plaintext], @prf[@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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toy-ore
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Fiona McCawley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-02 00:00:00.000000000 Z
+date: 2023-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -66,13 +66,15 @@ dependencies:
     - - ">="
       - !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.
+description: A toy library to get an understanding of how order revealing 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: []
+extra_rdoc_files:
+- lib/toy_ore.rb
+- lib/toy_ore/scheme.rb
 files:
 - lib/toy_ore.rb
 - lib/toy_ore/scheme.rb
@@ -84,7 +86,11 @@ metadata:
   source_code_uri: https://github.com/fimac/toy_ore_rb
   documentation_uri: https://rubydoc.info/gems/toy-ore
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--main"
+- README.rdoc
+- "--title"
+- 'Ruby Toy ORE Library: Educational tool to learn about Order Revealing Encryption'
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement