toy-ore 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f246208ecd7a6c54824330e8878c7b8fcb96e41a90a63b0b79ee9657f4b4fa11
-  data.tar.gz: 8da990dc6c98236de90c9153d50d5cc9e5d90f9ed1750f3a9c6519803c201892
+  metadata.gz: b52bfdbda823e03bbfbef5111caf2422988a52a2caaae198696c6bb3aafce99d
+  data.tar.gz: 445ffb7611ae5b3db64c2a35b3fbda44e591df45ac4b22b08f97b2d0d7aafc4c
 SHA512:
-  metadata.gz: bc99df59fdbb68ce2d8534295c7f0b9c399e072c9134aaaab33cf399ea6e325b4eb7b52d00a647c84308b1538fca72cece01b8a2f50c0d7c16d699d28d952132
-  data.tar.gz: 0e3d00ae71b2e48144c200a6e68b98fc9ff381a22ec4fc7c5ea4c0026cf60a48fd80c79348882623cfa5b604eb1997b6ad1fb9e0fd72d958eb2f0956f04231a6
+  metadata.gz: 2605cbacc5cf5088385173cb8b93c25e8133b6d119bf8f8d046c1f02991c65646458e4fa9951748aba24db2c3964c4a6653eb75b659525779b2bcafabeca83b2
+  data.tar.gz: a90e4baead02c90c9d3bfaab5a2b9f209fa33012c4762f9aabdcd2ca7e43f9fa7e9ef84815605f83a81935a4cf09f36d378b0541b0d7d06716270d4a12ef3e6b

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.3.0
+  version: 0.5.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
@@ -72,7 +72,9 @@ description: A toy library to get an understanding of how ore encryption works.
 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,14 +86,18 @@ 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
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="