cddl 0.10.2 → 0.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33adef2ddb191ca70e7ad3742684cea679e675fe0169a139c9fa5bcc59abfaa6
-  data.tar.gz: 7b7b7d2cd0623645d6dca87c5c7a8a3d40540e7eec390411e9cbf3adcc6f7c9d
+  metadata.gz: b3b0177b945919083ba2e0595570d098809b87839cb86e823dd54c62f225ad6b
+  data.tar.gz: 45302758ba30682f746f9b515cd293a5ac0883b2b126d6f74cd13a4911286e9e
 SHA512:
-  metadata.gz: b4a8ccd11e9dbf1b0ebf2541c03691a94a8430538fbe81db3bd178a2fab1732626114689d305048e88fb54c3336f0e95853c86f8336586d722df90639f82efa6
-  data.tar.gz: 1c6494a0fa4ead8ea548f61f3af5595dde99707359ce8aa8695c074288248334849f2452cae52620541bb762c9cf3979b159f415a1b787009d1061df54d849b5
+  metadata.gz: d613c36a0b4e7e1a18c68c1a2c5df9b0c46389936fdc063465bc8c130ba470b5c6467872fd55befa47972ea8cce8362f45a2164e2ee32c02539f29bd45fb1279
+  data.tar.gz: 6dca2e75e676eb00aba31e03671b2baf37568a2e4eb8fb0b506c8b02829efb88d6efda323891962e6ca3644be4added36482ee555bbf4d13565517c59cbaf397

data/cddl.gemspec

@@ -1,21 +1,23 @@
 spec = Gem::Specification.new do |s|
   s.name = 'cddl'
-  s.version = '0.10.2'
+  s.version = '0.10.5'
   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

@@ -2,11 +2,14 @@ require 'abnc'
 require 'pp'
 require 'pathname'
 require 'cbor-pure' unless defined?(CBOR::Tagged)
+require 'cbor-deterministic'
 require 'regexp-examples'
 require 'abnftt'
 require 'colorize'
 require 'base64'
 require 'base32'
+require 'base45_lite'
+require 'scanf'
 
 module CDDL
 
@@ -267,6 +270,21 @@ module CDDL
       l.map {|l| l.sub(/^ {0,#{indent}}/, "")}.join
     end
 
+    def unpack_array_to_sequence(content, where)
+      # remove the first head
+      n = case content.getbyte(0) - (4 << 5)
+          when 0..23; 1
+          when 24; 2
+          when 25; 3
+          when 26; 5
+          when 27; 9      # unlikely :-)
+          else fail ".cborseq sequence for #{where} not an array"
+          end
+      content[0...n] = ''
+      content
+    end
+
+
     # Memoize a bit here
 
     REGEXP_FOR_STRING = Hash.new {|h, k|
@@ -405,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
@@ -534,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
@@ -561,22 +582,18 @@ module CDDL
           end
           enc = bytes ? Encoding::BINARY : Encoding::UTF_8
           out.force_encoding(enc)
-        when :cbor, :cborseq
+        when :cbor, :cborseq, :cbordet, :cborseqdet
           unless target == [:prim, 2]
             fail "Don't know yet how to generate #{where}"
           end
-          content = CBOR::encode(generate1(control))
-          if conop == :cborseq
+          input = generate1(control)
+          if conop == :cbordet || conop == :cborseqdet
+            input = input.cbor_prepare_deterministic
+          end
+          content = CBOR::encode(input)
+          if conop == :cborseq || conop == :cborseqdet
             # remove the first head
-            n = case content.getbyte(0) - (4 << 5)
-                when 0..23; 1
-                when 24; 2
-                when 25; 3
-                when 26; 5
-                when 27; 9      # unlikely :-)
-                else fail "Generated .cborseq sequence for #{where} not an array"
-                end
-            content[0...n] = ''
+            content = unpack_array_to_sequence(content, where)
           end
           content
         when :json
@@ -592,25 +609,28 @@ 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}"
-          end
-          content = content.join
-          content
-        when :b64u, :b64c, :b32, :h32, :hex, :hexlc, :hexuc
-          content = generate1(control)
-          unless String === content
-            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 = case conop
-                    when :b64u
+          fail "Don't know yet how to generate #{where}"
+        when :b64u, :"b64u-sloppy", :b64c, :"b64c-sloppy",
+             :b45, :b32, :h32, :hex, :hexlc, :hexuc
+          try_generate(control) do |content|
+            if String === content
+              content = case conop
+                    when :b64u, :"b64u-sloppy"
                       Base64.urlsafe_encode64(content, padding: false)
-                    when :b64c
+                    when :b64c, :"b64c-sloppy"
                       Base64.strict_encode64(content)
+                    when :b45
+                      Base45Lite.encode(content)
                     when :b32
                       Base32.table = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567"
                       Base32.encode(content).gsub("=", "")
@@ -623,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
@@ -654,6 +696,13 @@ 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],
@@ -701,6 +750,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
@@ -1040,6 +1102,22 @@ module CDDL
             ann if validate1((CBOR::decode(d) rescue :BAD_CBOR), control)
           when :cborseq
             ann if validate1((CBOR::decode("\x9f".b << d << "\xff".b) rescue :BAD_CBOR), control)
+          when :cbordet
+            decoded = CBOR::decode(d) rescue :BAD_CBOR
+            if d != decoded.to_deterministic_cbor
+              @last_message = "CBOR #{d.inspect} not deterministically encoded"
+              nil
+            else
+              ann if validate1(decoded, control)
+            end
+          when :cborseqdet
+            decoded = CBOR::decode("\x9f".b << d << "\xff".b) rescue :BAD_CBOR
+            if d != unpack_array_to_sequence(decoded.to_deterministic_cbor, d.inspect)
+              @last_message = "CBOR Sequence #{d.inspect} not deterministically encoded"
+              nil
+            else
+              ann if validate1(decoded, control)
+            end
           when :json
             ann if validate1((JSON::load(d) rescue :BAD_JSON), control)
           when :decimal
@@ -1060,19 +1138,26 @@ module CDDL
             else
               fail "Don't know yet how to validate against #{where}"
             end
-          when :b64u, :b64c, :b32, :h32, :hex, :hexlc, :hexuc
+          when :b64u, :"b64u-sloppy", :b64c, :"b64c-sloppy", :b45, :b32, :h32, :hex, :hexlc, :hexuc
             ann if (
                 String === d && (
                 decoded = case conop
                     when :b64u
                       /=/ !~ d &&
                       Base64.urlsafe_decode64(d)
+                    when :"b64u-sloppy"
+                      /[-_=]/ !~ d &&
+                      Base64.decode64(d.tr("+/", "-_"))
                     when :b64c
                       Base64.strict_decode64(d)
+                    when :"b64c-sloppy"
+                      Base64.decode64(d)
                     when :b32
                       /=/ !~ d &&
                         (Base32.table = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567") &&
                         Base32.decode(d)
+                    when :b45
+                      Base45Lite.decode(d)
                     when :h32
                       /=/ !~ d &&
                         (Base32.table = "0123456789ABCDEFGHIJKLMNOPQRSTUV") &&
@@ -1087,6 +1172,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
@@ -1122,7 +1222,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
@@ -1441,11 +1543,15 @@ module CDDL
 
     BRACE = {"{" => :map, "[" => :array}
     RANGE_EXCLUDE_END = {".." => false, "..." => true}
-    SUPPORTED_ANNOTATIONS = [:bits, :size, :regexp, :cbor, :cborseq, :within, :and,
+    SUPPORTED_ANNOTATIONS = [:bits, :size, :regexp,
+                             :cbor, :cborseq, :cbordet, :cborseqdet,
+                             :within, :and,
                              :default, :lt, :le, :gt, :ge, :eq, :ne,
                              :feature, :abnf, :abnfb, :det, :cat, :plus,
                              :json, :decimal, :join,
-                             :b64u, :b64c, :b32, :h32, :hex, :hexlc, :hexuc,
+                             :b64u, :"b64u-sloppy", :b64c, :"b64c-sloppy",
+                             :b45, :b32, :h32, :hex, :hexlc, :hexuc,
+                             :printf,
                             ]
 
     def type1(n, canbegroup = false)
@@ -1477,7 +1583,14 @@ module CDDL
           [:prim]
         when /\A#(\d+)/
           maj = $1.to_i
-          s = [:prim, maj, *n.children(:uint).map(&:to_s).map(&:to_i)]
+          s = [:prim, maj]
+          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/b64c-sloppy.cddl

@@ -0,0 +1 @@
+a = text .b64c-sloppy 'mnoabcdue=='

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.2
+  version: 0.10.5
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-25 00:00:00.000000000 Z
+date: 2024-01-14 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:
@@ -133,6 +161,7 @@ files:
 - test-data/abnf3.cddl
 - test-data/ambig.cddl
 - test-data/b.cddl
+- test-data/b64c-sloppy.cddl
 - test-data/b64c.cddl
 - test-data/b64u.cddl
 - test-data/badaddr.cddl
@@ -206,6 +235,11 @@ files:
 - test-data/oidbat.cddl
 - test-data/patch1.cddl
 - test-data/plus.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
@@ -238,14 +272,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.2
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: CDDL generator and validator.