cddl 0.10.3 → 0.10.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e60b48882767d7e76926473b44c79369891e4203326d4e31f5693a3819f391d
-  data.tar.gz: 6ed2f45e7fa8468557e73c96a4dbfdd142d65fdebeeb362efeebec8007b7948f
+  metadata.gz: cd34ee2aa2fc9a5d0d504d0dc48222f4e94722b4e19086d4932b8bcc82980e92
+  data.tar.gz: b397db50185a9f899c6b3d4bc9ce63946a1f57c6989cb7cf55215eb1d6da9868
 SHA512:
-  metadata.gz: 2124a4fc046c3dc03d007ca949e4f9191497b359fe19fafe307ed2227c4b5654d909815575504e452add310dfc8487bfc13db94794d4b6c06a7af0bb2701e55f
-  data.tar.gz: 8a223332d81282eb9ad651dad887579ceb7b44a01d05ccff6458e271ea999a3c5fad5f81c87a6a2ccf927307b3bb9c4e06075361b0f8fc8b02005926a3d9a5b7
+  metadata.gz: 96be7107033f0e3ef5da1ee747738bcd712eeb5af8230e11f128d64d0649920c8d15f5f4a13c5ccfb0ececad19dac7da1a145337f6e1a322ffe3573d7af4c689
+  data.tar.gz: d3edd46ef0698fde296cb18509101f98700568c942652e77e6d36abdd7a9a79e27d2fb920a3a5efc46160466feff0ecaa0ae0fda45411a94d234ed4ace037deb

data/cddl.gemspec

@@ -1,21 +1,23 @@
 spec = Gem::Specification.new do |s|
   s.name = 'cddl'
-  s.version = '0.10.3'
+  s.version = '0.10.7'
   s.summary = "CDDL generator and validator."
   s.description = %{A parser, generator, and validator for CDDL}
   s.add_dependency('cbor-diag')
-  s.add_dependency('abnc')
+  s.add_dependency('abnc', '~> 0.1.1')
   s.add_dependency('json_pure')
   s.add_dependency('abnftt')
   s.add_dependency('regexp-examples') # , '1.1.0')
   s.add_dependency('colorize')
   s.add_dependency('base32', '~> 0.3')
+  s.add_dependency('base45_lite', '~> 1.0')
+  s.add_dependency('scanf', '~> 1.0')
   s.files = `git ls-files`.split("\n").grep(/^[a-z]/)
   s.files = Dir['lib/**/*.rb'] + %w(cddl.gemspec) + Dir['data/**/*.abnf'] + Dir['data/**/*.cddl'] + Dir['test-data/**/*.cddl'] + Dir['test/**/*.rb']
   s.require_path = 'lib'
   s.executables = ['cddl']
   s.default_executable = 'cddl'
-  s.required_ruby_version = '>= 2.0'
+  s.required_ruby_version = '>= 2.3'
   s.author = "Carsten Bormann"
   s.email = "cabo@tzi.org"
   s.homepage = "http://github.com/cabo/cddl"

data/data/cddl.abnf

@@ -13,7 +13,7 @@ genericarg = "<" S type1 S *("," S type1 S ) ">"
 type = type1 S *("/" S type1 S)
 
 type1 = type2 [S (rangeop / annotator) S type2]
-     / "#" "6" ["." uint] "(" S type S ")" ; note no space!
+     / "#" "6" ["." tagnumber] "(" S type S ")" ; note no space!
      / "#" DIGIT ["." uint]                ; major/ai
      / "#"                                 ; any
      / "~" S typename [genericarg]
@@ -22,6 +22,8 @@ type1 = type2 [S (rangeop / annotator) S type2]
      / "&" S "(" S group S ")"
      / "&" S groupname [genericarg]
 
+tagnumber = uint / ("<" type ">")
+
 type2 = value
       / typename [genericarg]
       / "(" type ")"

data/lib/cddl.rb

@@ -9,6 +9,7 @@ require 'colorize'
 require 'base64'
 require 'base32'
 require 'base45_lite'
+require 'scanf'
 
 module CDDL
 
@@ -422,7 +423,11 @@ module CDDL
         when 3
           gen_word
         when 6
-          CBOR::Tagged.new(where[2], generate1(where[3]))
+          tn = Integer === where[2] ? where[2] : generate1(where[2])
+          unless Integer === tn && tn >= 0
+            fail "Can't generate a tag number out of #{where[2]}"
+          end
+          CBOR::Tagged.new(tn, generate1(where[3]))
         when 7
           case where[2]
           when nil
@@ -433,8 +438,8 @@ module CDDL
             true
           when 22
             nil
-          when 23
-            :undefined
+          when 0..19, 23, 32..255
+            CBOR::Simple.new(where[2])
           when 25, 26, 27
             rand()
           end
@@ -551,8 +556,7 @@ module CDDL
               warn "HUH gen #{where.inspect} #{try.inspect}" unless try.nil?
             end
           end
-          32.times do
-            content = generate1(target)
+          try_generate(target) do |content|
             if validate1(content, where)
               return content
             end
@@ -605,22 +609,22 @@ module CDDL
           content = Integer(generate1(control)).to_s
           content
         when :join
-          content = generate1(control)
-          unless Array === content && 
-                 content.all? {|x| String === x &&
-                               ((target == [:prim, 2] && x.encoding == Encoding::BINARY) ||
-                                (target == [:prim, 3] && x.encoding != Encoding::BINARY))}
-            fail "Don't know yet how to generate #{where}"
+          try_generate(control) do |content|
+            if Array === content &&
+               content.all? {|x| String === x} &&
+               Set[content.map {|x| x.encoding}].size == 1
+              content = content.join
+              if validate1(content, target)
+                return content
+              end
+            end
           end
-          content = content.join
-          content
+          fail "Don't know yet how to generate #{where}"
         when :b64u, :"b64u-sloppy", :b64c, :"b64c-sloppy",
              :b45, :b32, :h32, :hex, :hexlc, :hexuc
-          content = generate1(control)
-          unless String === content
-            fail "Don't know yet how to generate #{where}"
-          end
-          content = case conop
+          try_generate(control) do |content|
+            if String === content
+              content = case conop
                     when :b64u, :"b64u-sloppy"
                       Base64.urlsafe_encode64(content, padding: false)
                     when :b64c, :"b64c-sloppy"
@@ -639,10 +643,32 @@ module CDDL
                       content.unpack("H*")[0]
                     else fail "Cannot happen"
                     end
-          content
+              if validate1(content, target)
+                return content
+              end
+            end
+          end
+          fail "Not smart enough to generate #{where}"
+        when :printf
+          try_generate(control) do |content|
+            if Array === content && content.size >= 1
+              fmt, *data = content
+              if String === fmt
+                begin
+                  content = fmt % data
+                  if validate1(content, target)
+                    return content
+                  end
+                rescue ArgumentError => e
+                  # be verbose about mismatches here
+                  @last_message << "\n** #{fmt.inspect} ArgumentError #{e}"
+                end
+              end
+            end
+          end
+          fail "Not smart enough to generate #{where}#{@last_message}"
         when :within, :and
-          32.times do
-            content = generate1(target)
+          try_generate(target) do |content|
             if validate1(content, control)
               return content
             elsif conop == :within
@@ -670,12 +696,24 @@ module CDDL
       end
     end
 
+    def try_generate(target)
+      32.times do
+        content = generate1(target)
+        yield content           # should return if success
+      end
+    end
+
     VALUE_TYPE = {text: String, bytes: String, int: Integer, float: Float}
     SIMPLE_VALUE = {
       [:prim, 7, 20] => [true, false, :bool],
       [:prim, 7, 21] => [true, true, :bool],
       [:prim, 7, 22] => [true, nil, :nil],
-      [:prim, 7, 23] => [true, :undefined, :undefined],
+    }
+    SIMPLE_VALUE_SIMPLE = Set[23] + (0..19) + (32..255)
+    SIMPLE_VALUE.default_proc = proc { |hash, t|
+      if t[0] == :prim && t[1] == 7 && SIMPLE_VALUE_SIMPLE.include?(t[2])
+        [true, CBOR::Simple.new(t[2]), :simple]
+      end
     }
 
     def extract_value(t)        # []
@@ -717,6 +755,19 @@ module CDDL
        }]
     end
 
+
+    def extract_arg0(t)
+      return [false] unless t[0] == :array
+      [true,
+       (el = t[1]
+        return [false] unless el[0..3] == [:member, 1, 1, nil]
+        ok, v, vt = extract_value(el[4])
+        return [false] unless ok
+        [v, vt]
+       ),
+       *t[2..-1]]
+    end
+
     def extract_feature(control, d)
       ok, v, vt = extract_value(control)
       if ok
@@ -1126,6 +1177,21 @@ module CDDL
                     end
                 ) && validate1(decoded.b, control)
               )
+          when :printf
+            ann if String === d && (
+                     ok, fmt, *v = extract_arg0(control)
+                     if ok && String == fmt[1]
+                       fmt = fmt[0]
+                       # warn "** ok #{ok.inspect} fmt #{fmt.inspect} v #{v.inspect}"
+                       decoded = d.scanf(fmt) # this is a bit too lenient, so let's do:
+                       encode_again = fmt % decoded
+                       if encode_again != d
+                         warn "** fmt #{fmt.inspect} d #{d.inspect} decoded #{decoded.inspect} encode_again #{encode_again.inspect}"
+                       else
+                         validate1(decoded, [:array, *v])
+                       end
+                     end
+                   )
           when :within
             if validate1(d, control)
               ann
@@ -1161,7 +1227,9 @@ module CDDL
             end
             d = CBOR::Tagged.new(t, d == 0 ? "".b : d.digits(256).reverse!.pack("C*"))
           end
-          CBOR::Tagged === d && d.tag == where[2] && validate1a(d.data, where[3])
+          CBOR::Tagged === d && (
+            Integer === where[2] ? d.tag == where[2] : validate1a(d.tag, where[2])
+          ) && validate1a(d.data, where[3])
         when 7
           t, v = extract_value(where)
           if t
@@ -1170,11 +1238,11 @@ module CDDL
             case where[2]
             when nil
               # XXX
-              fail
+              fail [:valnil, d, where].inspect
             when 25, 26, 27
               Float === d
             else
-              fail
+              fail [:val7, d, where].inspect
             end
           end
         else
@@ -1488,6 +1556,7 @@ module CDDL
                              :json, :decimal, :join,
                              :b64u, :"b64u-sloppy", :b64c, :"b64c-sloppy",
                              :b45, :b32, :h32, :hex, :hexlc, :hexuc,
+                             :printf,
                             ]
 
     def type1(n, canbegroup = false)
@@ -1520,6 +1589,13 @@ module CDDL
         when /\A#(\d+)/
           maj = $1.to_i
           s = [:prim, maj, *n.children(:uint).map(&:to_s).map(&:to_i)]
+          if tn = n.tagnumber
+            if ui = tn.uint
+              s << ui.to_s.to_i
+            elsif tt = tn.type
+              s << type(tt)
+            end
+          end
           if tagged_type = n.type
               s << type(tagged_type)
           end

data/test-data/prim.cddl

@@ -0,0 +1,7 @@
+start = [a, e, b, c, d]
+a = false
+e = undefined
+b = float32
+; c = #7.32
+c = #6.<12>(3)
+d = #6.13(4)

data/test-data/printf.cddl

@@ -0,0 +1,2 @@
+a = text .printf (["%8d %06d", ~arr])
+arr = [uint, uint]

data/test-data/printf0.cddl

@@ -0,0 +1 @@
+my_label = text .printf (["0x%x: %a", 4711, 81.5])

data/test-data/printf1.cddl

@@ -0,0 +1,2 @@
+my_alg_sha = hexlabel<4>
+hexlabel<K> = text .printf (["0x%04x", K])

data/test-data/printf2.cddl

@@ -0,0 +1,2 @@
+my_alg_sha = hexlabel<int>
+hexlabel<K> = text .printf (["0x%04x", K])

data/test-data/printf3.cddl

@@ -0,0 +1,2 @@
+any_alg = hexlabel<1..20>
+hexlabel<K> = text .printf (["0x%04x", K])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cddl
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.10.7
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2024-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cbor-diag
@@ -28,16 +28,16 @@ dependencies:
   name: abnc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: json_pure
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: base45_lite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: scanf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: A parser, generator, and validator for CDDL
 email: cabo@tzi.org
 executables:
@@ -119,7 +147,6 @@ files:
 - cddl.gemspec
 - data/cddl.abnf
 - data/prelude.cddl
-- lib/base45_lite.rb
 - lib/cbor-pp-play.rb
 - lib/cbor-pp.rb
 - lib/cddl.rb
@@ -208,6 +235,12 @@ files:
 - test-data/oidbat.cddl
 - test-data/patch1.cddl
 - test-data/plus.cddl
+- test-data/prim.cddl
+- test-data/printf.cddl
+- test-data/printf0.cddl
+- test-data/printf1.cddl
+- test-data/printf2.cddl
+- test-data/printf3.cddl
 - test-data/reused_named_group.cddl
 - test-data/sasl.cddl
 - test-data/sequence.cddl
@@ -240,14 +273,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: CDDL generator and validator.

data/lib/base45_lite.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright (c) 2022 Weihang Jian <https://tonytonyjan.net>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-# An implementation of draft-faltstrom-base45-10, see
-# https://datatracker.ietf.org/doc/draft-faltstrom-base45/
-module Base45Lite
-  class Error < ::StandardError; end
-  class OverflowError < Error; end
-  class InvalidCharacterError < Error; end
-  class ForbiddenLengthError < Error; end
-
-  MAX_UINT18 = 2**16 - 1
-  SQUARED_45 = 45**2
-  MAPPING = [
-    *'0'..'9',
-    *'A'..'Z',
-    ' ', '$', '%', '*', '+', '-', '.', '/', ':'
-  ].map!.with_index { |x, i| [i, x] }.to_h.freeze
-  REVERSE_MAPPING = MAPPING.invert.freeze
-
-  def self.encode(input)
-    sequence = []
-    input.unpack('n*').map! do |uint16|
-      i, c = uint16.divmod(45)
-      i, d = i.divmod(45)
-      _, e = i.divmod(45)
-      sequence.push(c, d, e)
-    end
-    if input.bytesize.odd?
-      i, c = input.getbyte(-1).divmod(45)
-      _, d = i.divmod(45)
-      sequence.push(c, d)
-    end
-    sequence.map!{ |n| MAPPING[n] }.join
-  end
-
-  def self.decode(input)
-    input
-      .chars.map! { |c| REVERSE_MAPPING[c] || raise(InvalidCharacterError) }
-      .each_slice(3).map do |slice|
-        c, d, e = slice
-        raise ForbiddenLengthError if d.nil?
-
-        sum = c + d * 45
-        sum += e * SQUARED_45 if e
-        raise OverflowError if sum > MAX_UINT18
-
-        sum
-      end
-      .pack((input.length % 3).zero? ? 'n*' : "n#{input.length / 3}C")
-  end
-end