melos 0.0.2 → 0.1.0

data/lib/melos/tree.rb

@@ -1,83 +1,7 @@
+# Tree math over node indexes in the array representation of a left-balanced binary tree (RFC 9420 Appendix C).
+# Functions that depend on the tree's contents live on Melos::RatchetTree.
 class Melos::Tree
-  attr_accessor :array, :leaf_count
-  # attr_reader @array
-
-  def initialize
-    @array = []
-    @leaf_count = 0
-  end
-
-  def self.empty_tree(n_leaves)
-    instance = self.allocate
-    instance.leaf_count = n_leaves
-    instance.array = Array.new(node_width(n_leaves))
-    instance
-  end
-
-  def add(val)
-    raise ArgumentError.new('Cannot add nil element') if val.nil?
-    if @leaf_count == 0
-      # initialize tree with one node
-      @array = [val]
-      @leaf_count = 1
-    else
-      # find leftmost empty leaf
-      extend_tree = true
-      for k in 0 .. (@leaf_count - 1) do
-        if @array[k * 2].nil?
-          @array[k * 2] = val
-          extend_tree = false
-          break
-        end
-      end
-      if extend_tree
-        # if tree is full, extend
-        @leaf_count = @leaf_count * 2
-        for k in 0 .. @leaf_count - 2
-          @array[@leaf_count + k] = nil
-        end
-        @array[@leaf_count] = val
-      end
-    end
-    @array
-  end
-
-  def remove_leaf(leaf_idx)
-    raise ArgumentError.new('Cannot remove from empty tree') if @leaf_count == 0
-    remove_node(leaf_idx * 2)
-    # then if rigbt half of the tree is empty, truncate tree
-    # q: do we recursively shrink tree?
-    right_tree_empty = true
-    for i in 0 .. (@leaf_count / 2) - 1 do
-      if !@array[@leaf_count + 2 * i].nil?
-        right_tree_empty = false
-        break
-      end
-    end
-    if right_tree_empty
-      @array = @array.first(@leaf_count - 1)
-      @leaf_count = @leaf_count / 2
-    end
-    @array
-  end
-
-  def remove_node(node_idx)
-    @array[node_idx] = nil
-  end
-
-  def root
-    self.class.root(@leaf_count)
-  end
-
-  def leaf_at(leaf_index)
-    @array[leaf_index * 2]
-  end
-
   class << self
-    def n_leaves(tree)
-      (tree.size + 1) / 2
-    end
-
     def log2(x)
       if x == 0
         return 0
@@ -184,7 +108,7 @@ class Melos::Tree
         raise ArgumentError.new('Failed to find common ancestor')
       end
 
-      dxy.min { level(_1) }
+      dxy.min_by { level(_1) }
     end
 
     def overlap_with_filtered_direct_path(x, filtered_direct_path, n)
@@ -195,53 +119,13 @@ class Melos::Tree
         raise ArgumentError.new('Failed to find overlap')
       end
 
-      dxf.min { level(_1) }
+      dxf.min_by { level(_1) }
     end
 
     def leaf?(node_index)
       node_index % 2 == 0
     end
 
-    def truncate!(tree)
-      root = root(n_leaves(tree))
-      if tree[(root + 1)..]&.all?(nil)
-        tree.slice!(root..) # keep left half of tree
-        truncate!(tree) # then attempt to truncate again
-      end
-      # right half of tree has an element, so finish
-    end
-
-    def filtered_direct_path(tree, node_index)
-      n_l = n_leaves(tree)
-      direct_path(node_index, n_l).reject { resolution(tree, sibling_from_leaf(node_index, _1, n_l)) == [] }
-    end
-
-    def copath_nodes_of_filtered_direct_path(tree, node_index)
-      filtered_direct_path(tree, node_index).map do |a|
-        sibling_from_leaf(node_index, a, n_leaves(tree))
-      end
-    end
-
-    def resolution(tree, node_index)
-      node = tree[node_index]
-      if node.nil?
-        if Melos::Tree.leaf?(node_index)
-          # The resolution of a blank leaf node is the empty list.
-          []
-        else
-          # The resolution of a blank intermediate node is the result of concatenating the resolution of its left child with the resolution of its right child, in that order.
-          resolution(tree, Melos::Tree.left(node_index)) + resolution(tree, Melos::Tree.right(node_index))
-        end
-      else
-        # The resolution of a non-blank node comprises the node itself, followed by its list of unmerged leaves, if any.
-        if node.parent_node
-          [node_index] + node.parent_node.unmerged_leaves.map { _1 * 2} # convert leaf index to node index
-        else
-          [node_index]
-        end
-      end
-    end
-
     # def common_ancestor_direct(x, y)
     #   lx = level(x) + 1
     #   ly = level(y) + 1

data/lib/melos/vec.rb

@@ -2,6 +2,7 @@ module Melos::Vec
   extend self
 
   def read_varint(data)
+    raise ArgumentError.new('variable-length vector is truncated') if data.nil? || data.empty?
     byte = 0
     v = data[byte].ord
     prefix = v >> 6
@@ -10,6 +11,7 @@ module Melos::Vec
     v = v & 0x3f
     (length - 1).times do
       byte += 1
+      raise ArgumentError.new('variable-length vector is truncated') if data[byte].nil?
       v = (v << 8) + data[byte].ord
     end
 
@@ -36,54 +38,37 @@ module Melos::Vec
     header.pack('C*')
   end
 
-  def from_string(str) # = to_vec
+  # Adds variable length header to string, thus making it a variable length vector
+  def string_to_vec(str)
     write_varint(str.bytesize) + str
   end
 
-  def parse_vec(vec_as_string)
-    prefix = vec_as_string[0].ord >> 6
-    length = read_varint(vec_as_string)
-    case prefix
-    when 0
-      str = vec_as_string.byteslice(1, length)
-      rest = vec_as_string.byteslice((1 + length)..)
-    when 1
-      str = vec_as_string.byteslice(2, length)
-      rest = vec_as_string.byteslice((2 + length)..)
-    when 2
-      str = vec_as_string[4, length]
-      rest = vec_as_string[(4 + length)..]
-    else
-      raise ArgumentError.new('invalid header')
-    end
-
-    [str, rest]
-  end
-
-  def parse_stringio(vec_as_stringio)
-    prefix = prefix_from_stringio(vec_as_stringio)
-    length = length_from_stringio(vec_as_stringio)
-    case prefix
-    when 0..2
-      vec_as_stringio.pos = (vec_as_stringio.pos + (2 ** prefix))
-      str = vec_as_stringio.read(length)
-    else
-      raise ArgumentError.new('invalid header')
-    end
-
+  # sig { params(stream: StringIO).returns(String) }
+  def parse_stream(stream)
+    prefix = prefix_from_stream(stream)
+    raise ArgumentError.new('invalid header') unless (0..2).include?(prefix) # 2.1.2: prefix 3 is invalid
+    header_length = 2 ** prefix
+    length = length_from_stream(stream)
+    # 2.1.2: the length MUST be encoded in the minimum number of bytes; a longer encoding is rejected
+    raise ArgumentError.new('variable-length header is not minimal') unless write_varint(length).bytesize == header_length
+    stream.pos += header_length
+    str = stream.read(length) || ''
+    raise ArgumentError.new('variable-length vector is truncated') if str.bytesize < length
     str
   end
 
   private
 
-  def prefix_from_stringio(stringio)
+  def prefix_from_stream(stringio)
     pos = stringio.pos
-    prefix_ = stringio.getbyte >> 6
+    first = stringio.getbyte
+    raise ArgumentError.new('variable-length vector is truncated') if first.nil?
+    prefix_ = first >> 6
     stringio.seek(pos)
     prefix_
   end
 
-  def length_from_stringio(stringio)
+  def length_from_stream(stringio)
     pos = stringio.pos
     buf = stringio.read(4)
     stringio.seek(pos)

data/lib/melos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Melos
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/melos.rb

@@ -1,3 +1,5 @@
+require 'stringio'
+
 module Melos
   MLS_VERSION = 0x01 # mls10
 end
@@ -7,9 +9,14 @@ require_relative 'melos/vec'
 require_relative 'melos/tree'
 require_relative 'melos/util'
 require_relative 'melos/constants'
-require_relative 'melos/key_schedule'
+require_relative 'melos/epoch_secrets'
 require_relative 'melos/psk'
+require_relative 'melos/group'
 require_relative 'melos/secret_tree'
+require_relative 'melos/capabilities'
+require_relative 'melos/key_package_bundle'
+require_relative 'melos/client'
 require_relative 'melos/struct/base'
 require_relative 'melos/struct/structs'
-require_relative 'melos/struct/ratchet_tree'
+require_relative 'melos/ratchet_tree'
+require_relative 'melos/private_tree'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: melos
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryo Kajiwara
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -53,14 +53,21 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/validation.md
 - lib/melos.rb
+- lib/melos/capabilities.rb
+- lib/melos/client.rb
 - lib/melos/constants.rb
 - lib/melos/crypto.rb
-- lib/melos/key_schedule.rb
+- lib/melos/epoch_secrets.rb
+- lib/melos/group.rb
+- lib/melos/group/validation.rb
+- lib/melos/key_package_bundle.rb
+- lib/melos/private_tree.rb
 - lib/melos/psk.rb
+- lib/melos/ratchet_tree.rb
 - lib/melos/secret_tree.rb
 - lib/melos/struct/base.rb
-- lib/melos/struct/ratchet_tree.rb
 - lib/melos/struct/structs.rb
 - lib/melos/tree.rb
 - lib/melos/util.rb
@@ -103,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Messaging Layer Security Protocol (RFC 9420) on Ruby
 test_files: []

data/lib/melos/key_schedule.rb

@@ -1,62 +0,0 @@
-require_relative 'crypto'
-
-module Melos::KeySchedule
-  extend self
-
-  def joiner_secret(suite, init_secret, commit_secret, group_context)
-    Melos::Crypto.expand_with_label(
-      suite,
-      Melos::Crypto.kdf_extract(suite, init_secret, commit_secret),
-      "joiner",
-      group_context.raw,
-      suite.kdf.n_h
-    )
-  end
-
-  def welcome_secret(suite, joiner_secret, psk_secret)
-    Melos::Crypto.derive_secret(
-      suite,
-      Melos::Crypto.kdf_extract(suite, joiner_secret, psk_secret), # sometimes written as `member_secret`
-      "welcome"
-    )
-  end
-
-  def welcome_key_and_nonce(suite, joiner_secret, psk_secret)
-    ws = welcome_secret(suite, joiner_secret, psk_secret)
-    [
-      Melos::Crypto.expand_with_label(suite, ws, "key",   "", suite.hpke.n_k),
-      Melos::Crypto.expand_with_label(suite, ws, "nonce", "", suite.hpke.n_n)
-    ]
-  end
-
-  def epoch_secret(suite, joiner_secret, psk_secret, group_context)
-    Melos::Crypto.expand_with_label(
-      suite,
-      Melos::Crypto.kdf_extract(suite, joiner_secret, psk_secret),
-      "epoch",
-      group_context.raw,
-      suite.kdf.n_h
-    )
-  end
-
-  # epoch-derived secrets, from Table 4 in Section 8
-  # will be defined as something like:
-  # Melos::KeySchedule.sender_data_secret(suite, epoch_secret)
-  [
-    ['sender data', 'sender_data_secret'],
-    ['encryption',  'encryption_secret'],
-    ['exporter',    'exporter_secret'],
-    ['external',    'external_secret'],
-    ['confirm',     'confirmation_key'],
-    ['membership',  'membership_key'],
-    ['resumption',  'resumption_psk'],
-    ['authentication', 'epoch_authenticator'],
-    ['init', 'init_secret'] # this is not part of the table but is defined in the same way
-  ].each do |tuple|
-    label = tuple[0]
-    name  = tuple[1]
-    define_method(name.to_sym, ->(suite, epoch_secret){
-      Melos::Crypto.derive_secret(suite, epoch_secret, label)
-    })
-  end
-end