hide-protocol 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2a953028799de42c33b2d4500308cdc35dd51f0ab3a421135869f9b7f22659f
-  data.tar.gz: b666943d4bed7075eb7899e3ac5a5b9c7475db0cd6cca222e7ed29cca8b158ee
+  metadata.gz: 488170733ac5d9ecacaaa15a84b6c069836d921851fb7efbcf9e13bb7e0483ee
+  data.tar.gz: c4c4398f9cb79ddd41c9abbc211de485ac9a1135c782c116818de60579dbb707
 SHA512:
-  metadata.gz: b4e375e687c8c6dbdfec9bc487fbf0b8aedc32cf1e72f7139d018e5922ed9bf11f4951dd9cef88893b9cdd4642f46ef82e4c796a4f365135ed354228d25665aa
-  data.tar.gz: 99059cec81d10c21228681a9ea36a2985f944e3e34379e03921cc35a3a3a6106733ed26899d7ec701280e48ab897356b2a0a9acf040b299cf1f6d307400a2a25
+  metadata.gz: ff80e1e2bdfddf7eac4de7c34746bf73b40f39d37fbd06c0ab85d41325df870622df44b631f9c563eb9f6a926defc441fb56ae8af929af12fe11edfe2d97b957
+  data.tar.gz: 0fb2bd25697dcfe863aec6b608e49c12349ea83f803c39359b8d4b72b29a1b244386909247f2df7c64f27b490e4c7b421eb8bd0a7e24b7e9e419036b8da328ac

data/lib/hide_protocol/binding.rb

@@ -107,7 +107,18 @@ module Hide
       hide_challenge_answer: [[VOIDP, VOIDP, SIZE_T, VOIDP], INT32],
       hide_spent_nonces_new: [[], VOIDP],
       hide_spent_nonces_free: [[VOIDP], VOID],
-      hide_challenge_accept: [[VOIDP, VOIDP, SIZE_T, VOIDP, SIZE_T, VOIDP, SIZE_T, UINT64], INT32]
+      hide_challenge_accept: [[VOIDP, VOIDP, SIZE_T, VOIDP, SIZE_T, VOIDP, SIZE_T, UINT64], INT32],
+      hide_identity_verify: [[VOIDP, SIZE_T, VOIDP, SIZE_T, VOIDP], INT32],
+      hide_identity_trusts_device: [[VOIDP, SIZE_T, VOIDP, SIZE_T, VOIDP, SIZE_T, VOIDP], INT32],
+      hide_identity_head: [[VOIDP, SIZE_T, VOIDP, SIZE_T, VOIDP], INT32],
+      hide_epoch_verify: [[VOIDP, SIZE_T, VOIDP], INT32],
+      hide_epoch_public_key: [[VOIDP, SIZE_T, UINT64, VOIDP], INT32],
+      hide_transparency_verify_inclusion: [
+        [VOIDP, SIZE_T, UINT64, UINT64, VOIDP, SIZE_T, VOIDP, SIZE_T], INT32
+      ],
+      hide_transparency_verify_consistency: [
+        [UINT64, UINT64, VOIDP, SIZE_T, VOIDP, SIZE_T, VOIDP, SIZE_T], INT32
+      ]
     }.freeze
 
     FUNCTIONS = SIGNATURES.each_with_object({}) do |(name, (args, ret)), acc|
@@ -163,6 +174,11 @@ module Hide
       raw.dup.force_encoding(Encoding::UTF_8).scrub
     end
 
+    # Reads a size_t out-parameter written into a pointer-sized slot.
+    def self.read_count(slot)
+      read_word(slot, 0)
+    end
+
     # A slot holding one pointer-sized out-parameter.
     def self.pointer_slot
       slot = Fiddle::Pointer.malloc(WORD, Fiddle::RUBY_FREE)

data/lib/hide_protocol.rb

@@ -29,6 +29,13 @@ module Hide
   # The data was altered, or is not a HIDE container.
   class AuthenticationError < Error; end
 
+  # The bytes did not decode at all.
+  #
+  # A subclass of AuthenticationError so that code which only cares that
+  # something failed is unaffected, while a caller that must tell corruption
+  # from forgery can rescue this specifically.
+  class MalformedError < AuthenticationError; end
+
   # The passphrase is wrong, or the key file was modified.
   class WrongPassphraseError < Error; end
 
@@ -56,7 +63,7 @@ module Hide
     Binding::ERR_NOT_A_KEY => NotAKeyError,
     Binding::ERR_AUTHENTICATION => AuthenticationError,
     Binding::ERR_NO_MATCHING_RECIPIENT => NoMatchingRecipientError,
-    Binding::ERR_MALFORMED => AuthenticationError,
+    Binding::ERR_MALFORMED => MalformedError,
     Binding::ERR_TOO_LARGE => TooLargeError,
     Binding::ERR_CHALLENGE_EXPIRED => ChallengeExpiredError,
     Binding::ERR_CHALLENGE_REPLAYED => ChallengeReplayedError
@@ -173,6 +180,118 @@ module Hide
       Binding.take(out)
     end
 
+    # Replays an identity log and returns how many devices it trusts now.
+    #
+    # Raises MalformedError for a log that does not decode and
+    # AuthenticationError for one that decodes but does not verify — the
+    # distinction that tells corruption from forgery. A count is returned
+    # rather than a boolean: a caller who forgot to test one would read every
+    # failure as a pass.
+    def verify_identity(log, recovery_key)
+      bytes = binary(log, "log")
+      recovery = binary(recovery_key, "recovery key")
+      slot = Binding.pointer_slot
+      check(Binding.call(
+              :hide_identity_verify,
+              buffer_arg(bytes), bytes.bytesize,
+              buffer_arg(recovery), recovery.bytesize,
+              slot
+            ))
+      Binding.read_count(slot)
+    end
+
+    # Whether the log trusts this device right now.
+    #
+    # A boolean is right here — this is a membership query, not a
+    # cryptographic check. The log is still verified first, so false means
+    # "not a member", never "did not verify": that raises.
+    def identity_trusts_device(log, recovery_key, device_public_key)
+      bytes = binary(log, "log")
+      recovery = binary(recovery_key, "recovery key")
+      device = binary(device_public_key, "device public key")
+      slot = Binding.pointer_slot
+      check(Binding.call(
+              :hide_identity_trusts_device,
+              buffer_arg(bytes), bytes.bytesize,
+              buffer_arg(recovery), recovery.bytesize,
+              buffer_arg(device), device.bytesize,
+              slot
+            ))
+      (Binding.read_count(slot) & 0xFFFFFFFF) != 0
+    end
+
+    # The head link: 32 bytes naming this exact history.
+    def identity_head(log, recovery_key)
+      bytes = binary(log, "log")
+      recovery = binary(recovery_key, "recovery key")
+      out = Binding.empty_buffer
+      check(Binding.call(
+              :hide_identity_head,
+              buffer_arg(bytes), bytes.bytesize,
+              buffer_arg(recovery), recovery.bytesize,
+              out
+            ))
+      Binding.take(out)
+    end
+
+    # Verifies a published epoch history and returns how many epochs it holds.
+    def verify_epoch_chain(chain)
+      bytes = binary(chain, "chain")
+      slot = Binding.pointer_slot
+      check(Binding.call(:hide_epoch_verify, buffer_arg(bytes), bytes.bytesize, slot))
+      Binding.read_count(slot)
+    end
+
+    # The public key a sender should encrypt to for this epoch.
+    #
+    # The chain is verified first, so a key is never returned from a history
+    # that does not hold together. An epoch beyond the chain raises
+    # InvalidArgumentError.
+    def epoch_public_key(chain, epoch)
+      bytes = binary(chain, "chain")
+      out = Binding.empty_buffer
+      check(Binding.call(
+              :hide_epoch_public_key,
+              buffer_arg(bytes), bytes.bytesize, Integer(epoch), out
+            ))
+      Binding.take(out)
+    end
+
+    # Checks that leaf is entry index of a log of size entries under root.
+    #
+    # path is the concatenated 32-byte hashes; any other length raises
+    # InvalidArgumentError. Nothing is returned, for the same reason verify
+    # returns nothing.
+    def verify_inclusion(leaf, index, size, path, root)
+      leaf_bytes = binary(leaf, "leaf")
+      path_bytes = binary(path, "path")
+      root_bytes = binary(root, "root")
+      check(Binding.call(
+              :hide_transparency_verify_inclusion,
+              buffer_arg(leaf_bytes), leaf_bytes.bytesize,
+              Integer(index), Integer(size),
+              buffer_arg(path_bytes), path_bytes.bytesize,
+              buffer_arg(root_bytes), root_bytes.bytesize
+            ))
+      nil
+    end
+
+    # Checks that old_root really is the root the log had before it grew to
+    # new_root. This is the check that catches a rewritten history.
+    def verify_consistency(old_size, new_size, path, old_root, new_root)
+      path_bytes = binary(path, "path")
+      old_bytes = binary(old_root, "old root")
+      new_bytes = binary(new_root, "new root")
+      check(Binding.call(
+              :hide_transparency_verify_consistency,
+              Integer(old_size), Integer(new_size),
+              buffer_arg(path_bytes), path_bytes.bytesize,
+              buffer_arg(old_bytes), old_bytes.bytesize,
+              buffer_arg(new_bytes), new_bytes.bytesize
+            ))
+      nil
+    end
+
     def check(code)
       return if code == Binding::OK
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hide-protocol
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - HIDE contributors