cddl 0.11.1 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b75dfee163242854b4a139d3a6e84710d9ac31702e57e502ac125b1b5e9dc944
-  data.tar.gz: 4a5360b99c364b7cd6c1aa518a332e79616e65331a95243ba2406a8d04712639
+  metadata.gz: a29d5d85e11598502b09d04e3b08a7ada9b6d0d8a9eb0e425bb01da81b92532b
+  data.tar.gz: 61c2a191c264c34600f0b66a8e7cfb2ea1359f3954676828a56a63aa25e3015c
 SHA512:
-  metadata.gz: 1127b09451324ff3842890e59e077c96f3c248082c9dac7f194f453faf88d0c9ffc8e7326c8087677ec953c03b62cbe50e582a2d8362876e57375289453ab3e4
-  data.tar.gz: 74ce9832d9a84dd4204411beecd9b029ddb76eacbc9e09e2056512310cbdb4309d439360d9bc1bf6c86ca60a87b7ca3423f9ef8471481657bda327f816b4426b
+  metadata.gz: 671d119f1cb328151c0631cbcd808f5a32d1f82d6c715a64cb5e5c9702b3452c996278a6b5055613de74b00f76489a9874037b336ac3a760947d4a2526d84cc9
+  data.tar.gz: 8146d9b66bb87e84b2179507fb9144012676be726dd5f4312da2482a047e46429a6d41d5b1d49097724aa8cfd68519be06e6e8f860e97f0cbc187de0c20242ca

data/bin/cddl

@@ -7,10 +7,13 @@ require 'json'
 
 Encoding.default_external = "UTF-8" # wake up, smell the coffee
 
+CDDL_VERSION = Gem.loaded_specs["cddl"].version rescue "unknown-version"
+
 EX_USAGE = 64
 EX_DATAERR = 65
 
 def usage
+  warn "cddl tool version #{CDDL_VERSION}"
   warn "Usage:"
   warn "#$0 spec.cddl generate [n]"
   warn "#$0 spec.cddl json-generate [n]"
@@ -26,7 +29,10 @@ def read_arg(arg, remember_fn = true)
   else
     usage unless arg
     $fn = arg if remember_fn
-    File.read(arg, mode: "rb")
+    File.read(arg, mode: "rb").force_encoding(Encoding::UTF_8).scrub { |c|
+      warn "*** replaced invalid UTF-8 byte sequence #{c.inspect} by U+FFFD REPLACEMENT CHARACTER"
+      0xFFFD.chr(Encoding::UTF_8)
+    }
   end
 end
 

data/cddl.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'cddl'
-  s.version = '0.11.1'
+  s.version = '0.12.1'
   s.summary = "CDDL generator and validator."
   s.description = %{A parser, generator, and validator for CDDL}
   s.add_dependency('cbor-diag')

data/data/cddl.abnf

@@ -70,27 +70,39 @@ fraction = 1*DIGIT
 exponent = int
 
 text = %x22 *SCHAR %x22
-SCHAR = %x20-21 / %x23-7E / SESC
-SESC = "\" %x20-7E
+SCHAR = %x20-21 / %x23-5B / %x5D-7E / NONASCII / SESC
+
+SESC = "\" ( %x22 / "/" / "\" /                 ; \" \/ \\
+             %x62 / %x66 / %x6E / %x72 / %x74 / ; \b \f \n \r \t
+             (%x75 hexchar) )                   ; \uXXXX
+
+hexchar = "{" (1*"0" [ hexscalar ] / hexscalar) "}" /
+          non-surrogate / (high-surrogate "\" %x75 low-surrogate)
+non-surrogate = ((DIGIT / "A"/"B"/"C" / "E"/"F") HEXDIG HEXDIG HEXDIG) /
+                ("D" %x30-37 HEXDIG HEXDIG)
+high-surrogate = "D" ("8"/"9"/"A"/"B") HEXDIG HEXDIG
+low-surrogate = "D" ("C"/"D"/"E"/"F") HEXDIG HEXDIG
+hexscalar = "10" HEXDIG HEXDIG HEXDIG HEXDIG / HEXDIG1 HEXDIG HEXDIG HEXDIG HEXDIG
+          / non-surrogate / HEXDIG [HEXDIG [HEXDIG]]
 
 bytes = [bsqual] %x27 *BCHAR %x27
-BCHAR = %x20-26 / %x28-5B / %x5D-7E / SESC / CRLF
-bsqual = %x68 ; "h"
-       / %x62.36.34 ; "b64"
+BCHAR = %x20-26 / %x28-5B / %x5D-7E / NONASCII / SESC / "\'" / CRLF
+bsqual = "h" / "b64"
 
 id = EALPHA *(*("-" / ".") (EALPHA / DIGIT))
 ALPHA = %x41-5A / %x61-7A
-EALPHA = %x41-5A / %x61-7A / "@" / "_" / "$"
+EALPHA = ALPHA / "@" / "_" / "$"
 DIGIT = %x30-39
 DIGIT1 = %x31-39
 HEXDIG = DIGIT / "A" / "B" / "C" / "D" / "E" / "F"
+HEXDIG1 = DIGIT1 / "A" / "B" / "C" / "D" / "E" / "F"
 BINDIG = %x30-31
 
 S = *WS
 WS = SP / NL
 SP = %x20
 NL = COMMENT / CRLF
-COMMENT = ";" *(SP / VCHAR) CRLF
-VCHAR = %x21-7E
+COMMENT = ";" *PCHAR CRLF
+PCHAR = %x20-7E / NONASCII
+NONASCII = %xA0-D7FF / %xE000-10FFFD
 CRLF = %x0A / %x0D.0A
-

data/lib/cddl.rb

@@ -61,7 +61,7 @@ module CDDL
         if upto - presult < 100
           part2 = source_text[presult...upto]
         else
-          part2 = source_text[presult, 50] + "......." + source_text[upto-50, 50]
+          part2 = source_text[presult, 50] + "......." + (source_text[upto-50, 50] || "")
         end
         warn "*** Look for syntax problems around the #{
                "%%%".colorize(background: :light_yellow)} markers:\n#{
@@ -747,7 +747,7 @@ module CDDL
         end
       elsif t[0] == :anno
         _, conop, target, control = t
-        # warn ["EXV0", conop, target, control].inspect
+        warn ["EXV0", conop, target, control].inspect   if ENV["CDDL_TRACE"]
         if conop == :cat || conop == :plus || conop == :det
           ok1, v1, vt1 = extract_value(target)
           ok2, v2, vt2 = extract_value(control)
@@ -980,6 +980,19 @@ module CDDL
       }
     end
 
+    def validate1a_ignore_encoding(d, where)
+      if String === d
+        validate1a(d.force_encoding(Encoding::BINARY), where) or (
+          text = d.force_encoding(Encoding::UTF_8).scrub {
+            fail "can't use bytes as text"
+          } rescue :NOT_A_TEXT_STRING
+          validate1a(text, where)
+        )
+      else
+        validate1a(d, where)
+      end
+    end
+
     def validate1a(d, where)
       if ann = validate1(d, where)
         here = [d, where]
@@ -1039,7 +1052,7 @@ module CDDL
         if conop == :cat || conop == :plus || conop == :det
           ok1, v1, vt1 = extract_value(target)
           ok2, v2, vt2 = extract_value(control)
-          # warn ["ANNO0", ok1, v1, vt1, ok2, v2, vt2, d].inspect
+          warn ["ANNO0", ok1, v1, vt1, ok2, v2, vt2, d].inspect  if ENV["CDDL_TRACE"]
           if ok1 && ok2
             v2 = Integer(v2) if vt1 == Integer
             if conop == :det
@@ -1048,6 +1061,30 @@ module CDDL
             end
             # warn ["ANNO", ok1, v1, vt1, ok2, v2, vt2, d].inspect
             [] if d == v1 + v2  # XXX Focus ArgumentError
+          elsif conop == :cat && String === d
+            warn ["CAT-L", ok1, v1, vt1, ok2, v2, vt2, d].inspect  if ENV["CDDL_TRACE"]
+            if ok1 && vt1 == String
+              # d and lhs (v1) need to agree in encoding
+              if d.encoding == v1.encoding
+                if d[0...v1.length] == v1
+                  d2 = d[v1.length..-1]
+                  warn ["CAT-L1", d2, d2.encoding, control].inspect  if ENV["CDDL_TRACE"]
+                  validate1a_ignore_encoding(d2, control)
+                end
+              end
+            elsif ok2 && vt2 == String
+            warn ["CAT-R", ok1, v1, vt1, ok2, v2, vt2, d].inspect  if ENV["CDDL_TRACE"]
+              if d[-v2.length..-1] == v2
+                d1 = d[0...-v2.length]
+                validate1a(d1, control)
+              end
+            end
+          elsif conop == :plus && Integer === d
+            if ok1 && vt1 == Integer
+              validate1a(d - Integer(v1), control)
+            elsif ok2 && vt2 == Integer
+              validate1a(d - Integer(v2), target)
+            end
           end
         elsif ann = validate1a(d, target)
           case conop
@@ -1157,14 +1194,75 @@ module CDDL
                 end
               )
           when :join
-            ok, *v = extract_array(control)
-            # warn "@@@JJJ@@@ #{ok.inspect} #{v.inspect}"
-            if ok
-              expected = v.map {|ve|
-                fail "Not a string in #{where}" unless String === ve[0]
-                ve[0]
-              }.join
-              ann if d == expected
+            t = control
+            v = if t[0] == :array
+                  t[1..-1].map { |el|
+                    if el[0..2] == [:member, 1, 1]
+                      ok, v, vt = extract_value(el[4])
+                      if ok
+                        [true, v, vt]
+                      else
+                        [false, el[4]]
+                      end
+                    end
+                  }
+                end
+            warn "@@@JOIN@@@ #{v.inspect}" if ENV["CDDL_TRACE"]
+            ok = true
+            if v
+              ix = 0
+              rest = d.dup
+              while ix < v.length
+                if left = v[ix]
+                  if left[0]    # match constant value first
+                    fail "Not a string for #{left.inspect} in #{where}" unless String == left[2]
+                    want = left[1]
+                    have = rest[0...left[1].length]
+                    if want == have
+                      rest[0...left[1].length] = ''
+                      ix += 1
+                      next
+                    else
+                      fail ".join: want #{want.inspect}, have #{have.inspect}"
+                    end
+                  else
+                    ix += 1
+                    if ix == v.length # match remaining
+                      warn "@@@JOIN ok in #{ok.inspect} rest #{rest.inspect}"  if ENV["CDDL_TRACE"]
+                      ok &&= validate1(rest, left[1])
+                      warn "@@@JOIN ok out #{ok.inspect}"  if ENV["CDDL_TRACE"]
+                      # more diag
+                      rest = ''
+                      next
+                    else
+                      if mid = v[ix]
+                        if mid[0] # have constant value to split over
+                          fail "Not a string for #{mid} in #{where}" unless String == mid[2]
+                          rest1, rest2 = rest.split(mid[1], 2)
+                          if rest2
+                            warn "@@@JOIN ok in #{ok.inspect} rest1 #{rest1.inspect}"   if ENV["CDDL_TRACE"]
+                            ok &&= validate1(rest1, left[1])
+                            warn "@@@JOIN ok out #{ok.inspect}"   if ENV["CDDL_TRACE"]
+                            rest = rest2
+                            ix += 1
+                            next
+                          else
+                            fail "Can't find #{mid[1].inspect} in #{rest.inspect}"
+                          end
+                        else
+                          fail "Cannot validate consecutive non-constant members of .join in #{where}"
+                        end
+                      else
+                        fail "Cannot handle .join over #{t[ix+1]} in #{where}"
+                      end
+                    end
+                  end
+                else
+                  fail "Cannot handle .join over #{t[ix+1]} in #{where}"
+                end
+              end
+              fail "Can't match #{rest.inspect} for .join in #{where}" if rest != ''
+              ann if ok
             else
               fail "Don't know yet how to validate against #{where}"
             end
@@ -1173,7 +1271,7 @@ module CDDL
                 String === d && (
                 decoded = case conop
                     when :b64u
-                      /=/ !~ d &&
+                      /[+\/=]/ !~ d &&
                       Base64.urlsafe_decode64(d)
                     when :"b64u-sloppy"
                       /[-_=]/ !~ d &&
@@ -1375,6 +1473,18 @@ module CDDL
                      end
     end
 
+    STRING_ESCAPES = {
+      "\"" => "\"",
+      "/" => "/",
+      "\\" => "\\",
+      "'" => "'",
+      "b" => "\b",
+      "f" => "\f",
+      "n" => "\n",
+      "r" => "\r",
+      "t" => "\t",
+    }
+
     def value(n)
       # cheat:
       # warn n
@@ -1384,7 +1494,20 @@ module CDDL
         if parts[-1] != ""
           warn "*** Problem decoding byte string #{s.inspect}"
         end
-        bsval = parts[0...-1].join("'").gsub(/\\(.)/){$1}
+        bsval = parts[0...-1].join("'").gsub(/\\u([Dd][89AaBb][0-9a-zA-Z]{2})\\u([Dd][CcDdEeFf][0-9a-zA-Z]{2})|\\u([0-9a-zA-Z]{4})|\\u\{([0-9a-zA-Z]+)\}|\r?(\n)|\\([^u])/) {
+          if hex = $3 || $4
+            hex.to_i(16).chr(Encoding::UTF_8)
+          elsif lf = $5
+            lf
+          elsif escaped = $6
+            STRING_ESCAPES[$6] or (
+              fail "Invalid String Escape #{escaped.inspect} in #{s.inspect}"
+            )
+          else
+            ((($1.to_i(16) & 0x3ff) << 10) +
+             ($2.to_i(16) & 0x3ff) + 0x10000).chr(Encoding::UTF_8)
+          end
+        }
         [:bytes,
          case bsqual
          when ""
@@ -1398,7 +1521,17 @@ module CDDL
          end
         ]
       else
-        val = eval(n.to_s)
+        if s[-1] == '"'
+          s.gsub!(/\\u([Dd][89AaBb][0-9a-zA-Z]{2})\\u([Dd][CcDdEeFf][0-9a-zA-Z]{2})|\\([^u]|u[0-9a-zA-Z]{4})/) {
+            if $3
+              "\\#$3" # skip this, use eval parser
+            else
+              ((($1.to_i(16) & 0x3ff) << 10) +
+               ($2.to_i(16) & 0x3ff) + 0x10000).chr(Encoding::UTF_8)
+            end
+          }
+        end
+        val = eval(s)
         # warn val
         case val
          when Integer; [:int, val]

data/test-data/b64u-strict.cddl

@@ -0,0 +1,12 @@
+a = text .b64u bytes
+
+;;gp 10
+
+;;vp "AAAA"
+;;vp "AAA-"
+;;vp "AAA_"
+; fail with 0.11.5:
+;;vp "AAA+"
+;;vp "AAA/"
+;;vp "AAA="
+;;vp "+kd8"

data/test-data/cat-re.cddl

@@ -1,2 +1,4 @@
 foo = text .regexp myregexp
 myregexp = "A" .cat "B"
+
+;;gp 10

data/test-data/catb64.cddl

@@ -0,0 +1,8 @@
+a1 = '' .cat a2
+a2 = text .b64u ain
+; a = "e30" .b64u ain
+ain = '{}'
+
+;;gp 3
+;;vp 'e30'
+;;vp "e30"

data/test-data/dotplus1.cddl

@@ -0,0 +1,3 @@
+a = b<13..15>
+b<T> = #7.<32 .plus T>
+; cddl dotplus1.cddl gp 10

data/test-data/dotplus2.cddl

@@ -0,0 +1,3 @@
+a = d<17..19>
+d<T> = #7.<T .plus 32>
+; cddl dotplus.cddl gp 10

data/test-data/dotplus3.cddl

@@ -0,0 +1,3 @@
+a = d<17..19>
+d<T> = 32.5 .plus T
+; cddl dotplus4.cddl gp 10

data/test-data/dotplus4.cddl

@@ -0,0 +1,3 @@
+a = d<17..19>
+d<T> = T .plus 32.5
+; cddl dotplus4.cddl gp 10

data/test-data/enum.cddl

@@ -0,0 +1,14 @@
+              terminal-color = &basecolors
+              basecolors = (
+                black: 0,  red: 1,  green: 2,  yellow: 3,
+                blue: 4,  magenta: 5,  cyan: 6,  white: 7,
+                reserved: (8..255) .feature "extension"
+              )
+              ; extended-color = &(
+              ;   basecolors,
+              ;   orange: 8,  pink: 9,  purple: 10,  brown: 11,
+              ; )
+
+;;gp 10
+;;vp 42
+;;vp 433

data/test-data/enum1.cddl

@@ -0,0 +1,12 @@
+terminal-color = $terminal-color / text .feature "extension"
+$terminal-color /= &basecolors
+basecolors = (
+               black: "black",  red: "red",  green: "green", 
+             )
+
+pastelcolors = ( pink: "pink", mauve: "mauve", peach: "peach", lavender: "lavender" )
+$terminal-color /= &pastelcolors
+
+;;gp 10
+;;vp "florp"
+;;vp "lavender"

data/test-data/json1.cddl

@@ -0,0 +1,15 @@
+; JWT-JWS = text .join ([
+;              b64u<jwt-headers>, ".",
+;              b64u<jwt-payload>, ".",
+;              b64u<jwt-signature>])
+; ; a = jwt-headers
+; ; a = b64u<"abc"> ; fails
+; ; a = b64u<'abc'> ; succeeds
+; b64u<B> = text .b64u B
+jwt-headers = '' .cat jwt-headers1
+jwt-headers1 = text .json jwt-headermap
+jwt-headermap = { * text => any } ; simplified
+jwt-payload = bytes
+jwt-signature = bytes
+
+;;gp 10

data/test-data/jwt.cddl

@@ -0,0 +1,15 @@
+JWT-JWS = text .join ([
+             b64u<jwt-headers>, ".",
+             b64u<jwt-payload>, ".",
+             b64u<jwt-signature>])
+; a = jwt-headers
+; a = b64u<"abc"> ; fails
+; a = b64u<'abc'> ; succeeds
+b64u<B> = text .b64u B
+jwt-headers = '' .cat jwt-headers1
+jwt-headers1 = text .json jwt-headermap
+jwt-headermap = { * text => any } ; simplified
+jwt-payload = bytes
+jwt-signature = bytes
+
+;;gp 10

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cddl
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.1
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-02 00:00:00.000000000 Z
+date: 2024-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cbor-diag
@@ -163,6 +163,7 @@ files:
 - test-data/b.cddl
 - test-data/b64c-sloppy.cddl
 - test-data/b64c.cddl
+- test-data/b64u-strict.cddl
 - test-data/b64u.cddl
 - test-data/badaddr.cddl
 - test-data/base32.cddl
@@ -173,6 +174,7 @@ files:
 - test-data/bpv7a.cddl
 - test-data/bpv7b.cddl
 - test-data/cat-re.cddl
+- test-data/catb64.cddl
 - test-data/cdni-ct.cddl
 - test-data/complex-occ.cddl
 - test-data/coral.cddl
@@ -185,7 +187,13 @@ files:
 - test-data/decimal.cddl
 - test-data/decimal2.cddl
 - test-data/det1.cddl
+- test-data/dotplus1.cddl
+- test-data/dotplus2.cddl
+- test-data/dotplus3.cddl
+- test-data/dotplus4.cddl
 - test-data/dotsize.cddl
+- test-data/enum.cddl
+- test-data/enum1.cddl
 - test-data/extractor-demo.cddl
 - test-data/feat1.cddl
 - test-data/feature-controller.cddl
@@ -213,8 +221,10 @@ files:
 - test-data/joini.cddl
 - test-data/joinx.cddl
 - test-data/json.cddl
+- test-data/json1.cddl
 - test-data/json2.cddl
 - test-data/jsoniodef.cddl
+- test-data/jwt.cddl
 - test-data/kevin5.cddl
 - test-data/lint1.cddl
 - test-data/map-group.cddl
@@ -280,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: CDDL generator and validator.