rbor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f277956fa01f8ecc1f4adcc4fc2168b0b6a7fea002a3330dce4a89b4fa2f83b8
+  data.tar.gz: 36568d6d3106fa0193be560d76396f7e8bbaca5e1488970a58051ce1cd2fc468
+SHA512:
+  metadata.gz: 49e15f6656f1beec5746aae587162e7732ba44c33ccbcccfb70b27d30240a27dec73dfa89f538e6dd8bd44d1fbf40c8d6c371535806ad32c942b6827fec2489e
+  data.tar.gz: d3641a6e489c7914027f4de2be93b0765b44be898386638376020182778357f8bbf0f2841d76695cc77e51b08d2b525649632f3929829d673c7d6f35e703dcb6

data/lib/rbor/array.rb

@@ -0,0 +1,101 @@
+class Array
+
+  # Serialize an Array into a CBOR array.
+  #
+  # @author David P. Sugar (r4gus)
+  # @return [String] the object serialized to CBOR.
+  def cbor_serialize(options = {})
+    len = self.length.cbor_serialize.bytes
+    len[0] |= 4 << 5
+    out = len.pack('C*')
+    self.each do |elem|
+      out += elem.cbor_serialize
+    end
+    return out
+  end
+
+  # Treat the object as CBOR `BINARY` data and deserialize it into a Ruby object.
+  # 
+  # Depending on the major type of the CBOR data, this method will return
+  # a object of one of the following types:
+  # - major type 0: Integer
+  # - major type 1: Integer
+  # - major type 2: String
+  # - major type 3: String
+  # - major type 4: Array
+  # - major type 5: Hash
+  # - major type 7: FalseClass, TrueClass, NilClass
+  #
+  # @author David P. Sugar (r4gus)
+  def cbor_deserialize
+    raise "empty" if self.empty?
+    case self[0]
+    when 0x00..0x3b
+      v = nil 
+    
+      case self[0] & 0x1f
+      when 0x00..0x17
+        v = self[0] & 0x1f, self[1..]
+      when 0x18
+        v = self[1], self[2..]
+      when 0x19
+        v = self[1..2].pack("C*").unpack("S>")[0], self[3..]
+      when 0x1a
+        v = self[1..4].pack("C*").unpack("L>")[0], self[5..]
+      when 0x1b
+        v = self[1..8].pack("C*").unpack("Q>")[0], self[9..]
+      else
+        raise "invalid additional information"
+      end
+
+      if self[0] & 1 << 5 != 0
+        v[0] = -v[0] - 1
+      end
+
+      return v
+    when 0x40..0x5b
+      old = self[0] & 0b11100000
+      self[0] &= 0x1f
+      len, rem = self.cbor_deserialize
+      self[0] |= old
+      return String.new(rem[0..len - 1].pack('C*'), encoding: "BINARY"), rem[len..]
+    when 0x60..0x7b
+      old = self[0] & 0b11100000
+      self[0] &= 0x1f
+      len, rem = self.cbor_deserialize
+      self[0] |= old
+      return String.new(rem[0..len - 1].pack('C*'), encoding: "UTF-8"), rem[len..]
+    when 0x80..0x9b
+      old = self[0] & 0b11100000
+      self[0] &= 0x1f
+      len, rem = self.cbor_deserialize
+      self[0] |= old
+      out = []
+      len.times do |n|
+        obj, rem = rem.cbor_deserialize
+        out.append obj
+      end
+      return out, rem
+    when 0xa0..0xbb
+      old = self[0] & 0b11100000
+      self[0] &= 0x1f
+      len, rem = self.cbor_deserialize
+      self[0] |= old
+      out = {}
+      len.times do |n|
+        k, rem = rem.cbor_deserialize
+        v, rem = rem.cbor_deserialize
+        out[k] = v
+      end
+      return out, rem
+    when 0xf4
+      return false, self[1..]
+    when 0xf5
+      return true, self[1..]
+    when 0xf6
+      return nil, self[1..]
+    else
+      raise "undefined major type"
+    end
+  end
+end

data/lib/rbor/bool.rb

@@ -0,0 +1,32 @@
+class FalseClass
+
+  # Serialize false into a CBOR string.
+  #
+  # @author David P. Sugar (r4gus)
+  # @return [String] the object serialized to CBOR.
+  def cbor_serialize
+    return String.new("\xf4", encoding: "BINARY")
+  end
+end
+
+class TrueClass
+
+  # Serialize true into a CBOR string.
+  #
+  # @author David P. Sugar (r4gus)
+  # @return [String] the object serialized to CBOR.
+  def cbor_serialize
+    return String.new("\xf5", encoding: "BINARY")
+  end
+end
+
+class NilClass
+
+  # Serialize nil into a CBOR string.
+  #
+  # @author David P. Sugar (r4gus)
+  # @return [String] the object serialized to CBOR.
+  def cbor_serialize
+    return String.new("\xf6", encoding: "BINARY")
+  end
+end

data/lib/rbor/hash.rb

@@ -0,0 +1,36 @@
+class Hash
+
+  # Serialize a Hash into a CBOR map.
+  #
+  # @author David P. Sugar (r4gus)
+  # @return [String] the object serialized to CBOR.
+  def cbor_serialize(options = {})
+    len = self.length.cbor_serialize.bytes
+    len[0] |= 5 << 5
+    out = len.pack('C*')
+    tmp = self.sort do |a, b| 
+      if a[0].is_a? Integer and b[0].is_a? Integer
+        if a[0] >= 0 and b[0] >= 0 or a[0] < 0 and b[0] < 0
+          a[0] <=> b[0]
+        elsif a[0] >= 0
+          -1
+        else 
+          1
+        end
+      elsif a[0].is_a? Integer and b[0].is_a? String
+        -1
+      elsif a[0].is_a? String and b[0].is_a? Integer
+        1
+      elsif a[0].is_a? String and b[0].is_a? String
+        a[0] <=> b[0]
+      else
+        0
+      end
+    end
+    tmp.each do |k, v|
+      out += k.cbor_serialize
+      out += v.cbor_serialize
+    end
+    return out
+  end
+end

data/lib/rbor/integer.rb

@@ -0,0 +1,29 @@
+class Integer
+
+  # Serialize an Integer into a CBOR string.
+  #
+  # @author David P. Sugar (r4gus)
+  # @return [String] the object serialized to CBOR.
+  def cbor_serialize
+    v = self
+    mt = 0
+
+    if v < 0 and v >= -2**64
+      v = -1 - v
+      mt = 1
+    end
+
+    case v
+    when 0x00..0x17
+      return [mt << 5 | v].pack('C')
+    when 0x18..0xff
+      return [mt << 5 | 24, v].pack('C*')
+    when 0x0100..0xffff
+      return [mt << 5 | 0x19].pack('C') + [v].pack("S>")
+    when 0x00010000..0xffffffff
+      return [mt << 5 | 0x1a].pack('C') + [v].pack("L>")
+    when 0x0000000100000000..0xffffffffffffffff
+      return [mt << 5 | 0x1b].pack('C') + [v].pack("Q>")
+    end
+  end
+end

data/lib/rbor/string.rb

@@ -0,0 +1,38 @@
+class String
+
+  # Treat the object as CBOR `BINARY` data and deserialize it into a Ruby object.
+  # 
+  # Depending on the major type of the CBOR data, this method will return
+  # a object of one of the following types:
+  # - major type 0: Integer
+  # - major type 1: Integer
+  # - major type 2: String
+  # - major type 3: String
+  # - major type 4: Array
+  # - major type 5: Hash
+  # - major type 7: FalseClass, TrueClass, NilClass
+  #
+  # @author David P. Sugar (r4gus)
+  def cbor_deserialize
+    return self.bytes.cbor_deserialize
+  end
+  
+  # Serialize a String into a CBOR string.
+  #
+  # If the `encoding` is of type `UTF-8`, the object will be serialized
+  # to a text string (major type 3). Otherwise, the obejct will be
+  # serialized to a byte string (major type 2).
+  #
+  # @author David P. Sugar (r4gus)
+  # @param options [Hash] the serialization options.
+  # @return [String] the object serialized to CBOR.
+  def cbor_serialize(options = {})
+    len = self.bytesize.cbor_serialize.bytes
+    mt = 2
+    if self.encoding.to_s == "UTF-8"
+      mt = 3
+    end
+    len[0] = mt << 5 | len[0]
+    return len.pack('C*') + String.new(self, encoding: "BINARY")
+  end
+end

data/lib/rbor.rb

@@ -0,0 +1,15 @@
+# The Concise Binary Object Representation (CBOR) is a data format whose 
+# design goals include the possibility of extremely small code size, fairly 
+# small message size, and extensibility without the need for version negotiation 
+# (RFC8949). It is used in different protocols like the Client to Authenticator 
+# Protocol CTAP2 which is a essential part of FIDO2 authenticators/ Passkeys.
+
+class Cbor
+
+end
+
+require_relative 'rbor/integer.rb'
+require_relative 'rbor/string.rb'
+require_relative 'rbor/array.rb'
+require_relative 'rbor/hash.rb'
+require_relative 'rbor/bool.rb'

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: rbor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David P. Sugar
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-08 00:00:00.000000000 Z
+dependencies: []
+description: The Concise Binary Object Representation (CBOR) is a data format whose
+  design goals include the possibility of extremely small code size, fairly small
+  message size, and extensibility without the need for version negotiation (RFC8949).
+  It is used in different protocols like the Client to Authenticator Protocol CTAP2
+  which is a essential part of FIDO2 authenticators/ Passkeys.
+email: david@thesugar.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rbor.rb
+- lib/rbor/array.rb
+- lib/rbor/bool.rb
+- lib/rbor/hash.rb
+- lib/rbor/integer.rb
+- lib/rbor/string.rb
+homepage: https://rubygems.org/gems/rbor
+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.5.16
+signing_key:
+specification_version: 4
+summary: Concise Binary Object Representation
+test_files: []