cddl 0.8.17 → 0.8.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e57d91298d6da2ed2f30060754b3c54f36ebdbf967e6e4e5f3e164fd8dfe2004
-  data.tar.gz: c1f33e309cee195a2438d4e840fcef8748de4f50625f55ec15dbb154e1b43994
+  metadata.gz: 72490cb2a368cfaec3e71cae79f323665fc64f0049feeb30050a6e8275566cda
+  data.tar.gz: 6ad8a0c69b34745dcd41f7c5627c57e9a4292539115f4d63c502d4c0a3cd0218
 SHA512:
-  metadata.gz: 871fba7d4ec1b1d94a28149c3c9f9c9cdc4e60ddadb9d503f9ada96b35809534ed576865133f5a78c8645f1cce67f03ef04c799528c5dfa18752398d7e193302
-  data.tar.gz: df38f1006d6c36782609681c994fd09c8b0eb8a23d35d8de57dcd6b252a18d97d05ef42b776b276b56359e8ee212b25e923e6b337c0944a7646e7770d36b6696
+  metadata.gz: 1fcbc5a8d49391656566b9f4b7d03392a579b5e999d301b2dab877aa25ff6d31c4575a94a771bdf8df0d0c3b88dd086bafe952359bb297690325204fbf732c11
+  data.tar.gz: 15ce2e416c02c834d3853520ca2fc8baa8b26359623dff75f6615a755a6ef4007abc2fb0170248ae5b57783e52fd779bc5c88be9cea70e7534ac9104cbfc67a8

data/bin/cddl

@@ -14,8 +14,8 @@ def usage
   warn "Usage:"
   warn "#$0 spec.cddl generate [n]"
   warn "#$0 spec.cddl json-generate [n]"
-  warn "#$0 spec.cddl validate instance.cbor"
-  warn "#$0 spec.cddl validate instance.json"
+  warn "#$0 spec.cddl validate instance.cbor..."
+  warn "#$0 spec.cddl validate instance.json..."
   exit EX_USAGE
 end
 
@@ -48,6 +48,8 @@ def my_diag(v)
   end
 end
 
+retcode = 0
+
 begin
   case ARGV[1]
   when /\A..*p/
@@ -85,19 +87,25 @@ begin
       g = parser.generate
       puts JSON.pretty_generate(g)
     end
-  when /\Av/
-    instance = read_arg(ARGV[2])
-    instance = if $sequence
-      CBOR.decode("\x9f".b << instance.b << "\xff".b)
-    else
-      CBOR.decode(instance.b) rescue JSON.load(instance)
+  when /\Av(v)?/
+    verbose = $1
+    ARGV[2..-1].each do |fn|
+      instance = read_arg(fn)
+      instance = if $sequence
+                   CBOR.decode("\x9f".b << instance.b << "\xff".b)
+                 else
+                   CBOR.decode(instance.b) rescue JSON.load(instance)
+                 end
+      instance = instance.cbor_clone if $annotate && ENV["EXPERIMENTAL_ANNOTATE"]
+      warn "#{fn}:" if verbose
+      ann = parser.validate(instance)
+      # my_pp ann
+      instance.cbor_add_annotations_from(ann) rescue nil
+      my_diag(instance) if $annotate
+      unless ann
+        retcode = 1
+      end
     end
-    instance = instance.cbor_clone if $annotate && ENV["EXPERIMENTAL_ANNOTATE"]
-    ann = parser.validate(instance)
-    # my_pp ann
-    instance.cbor_add_annotations_from(ann) rescue nil
-    my_diag(instance) if $annotate
-    exit 1 unless ann
   else
     usage
   end
@@ -105,3 +113,5 @@ rescue CDDL::ParseError => e
   warn e.message
   exit EX_DATAERR
 end
+
+exit retcode

data/cddl.gemspec

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

data/lib/cddl.rb

@@ -56,6 +56,8 @@ module CDDL
       @ast = @abnf.ast?
       # our little argument stack for rule processing
       @insides = []
+      # collect error information
+      @last_message = ""
     end
 
     def apr                     # for debugging
@@ -244,6 +246,12 @@ module CDDL
       [rule[0], *rule[1]]
     end
 
+    def remove_indentation(s)
+      l = s.lines
+      indent = l.grep(/\S/).map {|l| l[/^\s*/].size}.min
+      l.map {|l| l.sub(/^ {0,#{indent}}/, "")}.join
+    end
+
     # Memoize a bit here
 
     REGEXP_FOR_STRING = Hash.new {|h, k|
@@ -255,6 +263,11 @@ module CDDL
       h[k] = ABNF.from_abnf(grammar)
     }
 
+    ABNF_ENCODING_FOR_CONOP = {
+      abnf: Encoding::UTF_8,
+      abnfb: Encoding::BINARY
+    }
+
     def generate
       @recursion = 0
       generate1(rules)
@@ -399,7 +412,7 @@ module CDDL
       when :anno
         target = where[2]
         control = where[3]
-        case where[1]
+        case conop = where[1]
         when :size
           should_be_int = generate1(control)
           unless (Array === target && target[0] == :prim && [0, 2, 3].include?(target[1])) && Integer === should_be_int && should_be_int >= 0
@@ -447,9 +460,10 @@ module CDDL
           generate1(target, inmap)
         when :feature
           generate1(target, inmap)
-        when :cat
+        when :cat, :det
           lhs = generate1(target, inmap)
           rhs = generate1(control)
+          rhs = remove_indentation(rhs) if conop == :det
           begin
             lhs + rhs
           rescue Exception => e
@@ -483,7 +497,7 @@ module CDDL
                     content = Integer(content)
                     case target[1]
                     when 0
-                      case where[1]
+                      case conop
                       when :lt
                         rand(0...content)
                       when :le
@@ -510,18 +524,25 @@ module CDDL
             fail "Don't know yet how to generate #{where}"
           end
           REGEXP_FOR_STRING[regexp].random_example(max_repeater_variance: 5)
-        when :abnf
+        when :abnf, :abnfb
           grammar = generate1(control)
-          unless target == [:prim, 3] && String === grammar
+          bytes = true if target == [:prim, 2]
+          bytes = false if target == [:prim, 3]
+          unless !bytes.nil? && String === grammar
             fail "Don't know yet how to generate #{where}"
           end
-          ABNF_PARSER_FOR_STRING[grammar].generate
+          out = ABNF_PARSER_FOR_STRING[grammar].generate
+          if conop == :abnfb
+            out = out.codepoints.pack("C*")
+          end
+          enc = bytes ? Encoding::BINARY : Encoding::UTF_8
+          out.force_encoding(enc)
         when :cbor, :cborseq
           unless target == [:prim, 2]
             fail "Don't know yet how to generate #{where}"
           end
           content = CBOR::encode(generate1(control))
-          if where[1] == :cborseq
+          if conop == :cborseq
             # remove the first head
             n = case content.getbyte(0) - (4 << 5)
                 when 0..23; 1
@@ -539,7 +560,7 @@ module CDDL
             content = generate1(target)
             if validate1(content, control)
               return content
-            elsif where[1] == :within
+            elsif conop == :within
               warn "*** #{content.inspect} meets #{target.inspect} but not #{control.inspect}"
             end
           end
@@ -580,7 +601,7 @@ module CDDL
       elsif t[0] == :anno
         _, conop, target, control = t
         # warn ["EXV0", conop, target, control].inspect
-        if conop == :cat || conop == :plus
+        if conop == :cat || conop == :plus || conop == :det
           ok1, v1, vt1 = extract_value(target)
           ok2, v2, vt2 = extract_value(control)
           # warn ["EXV", ok1, v1, vt1, ok2, v2, vt2].inspect
@@ -590,6 +611,7 @@ module CDDL
             elsif vt1 == Float
               [true, v1 + v2, vt1] if vt2 == Integer || vt2 == Float
             else
+              v2 = remove_indentation(v2) if conop == :det
               [true, v1 + v2, vt1] if vt1 == vt2
             end
           end rescue nil
@@ -634,7 +656,7 @@ module CDDL
 
     def validate_result(check)
       check || (
-        @last_message = yield
+        @last_message << yield
         false
       )
     end
@@ -667,7 +689,9 @@ module CDDL
             ann.concat(ann2)
           end
           if occ < s
-            @last_message = "occur not reached in array #{d} for #{where}"
+            # warn "*** lme #{@last_message.encoding} #{@last_message}"
+            # warn "*** #{"\noccur #{occ} < #{s}, not reached at #{i} in array #{d} for #{where}".encoding}"
+            @last_message << "\noccur #{occ} < #{s}, not reached at #{i} in array #{d} for #{where}"
             return [false, ann]
           end
         end
@@ -832,6 +856,7 @@ module CDDL
           # warn ["ANNO0", ok1, v1, vt1, ok2, v2, vt2, d].inspect
           if ok1 && ok2
             v2 = Integer(v2) if vt1 == Integer
+            v2 = remove_indentation(v2) if conop == :det
             # warn ["ANNO", ok1, v1, vt1, ok2, v2, vt2, d].inspect
             [] if d == v1 + v2  # XXX Focus ArgumentError
           end
@@ -908,17 +933,19 @@ module CDDL
               end
             end
             )
-          when :abnf            # XXX .abnf vs. .abnfb
+          when :abnf, :abnfb
             ann if (
             if String === d
               ok, v, vt = extract_value(control)
               if ok && vt == String
                 begin
-                  ABNF_PARSER_FOR_STRING[v].validate(d)
+                  ABNF_PARSER_FOR_STRING[v].validate(
+                    d.dup.force_encoding(ABNF_ENCODING_FOR_CONOP[conop]).codepoints.pack("U*")
+                  )
                   true
                 rescue => e
                   # warn "*** #{e}" # XXX
-                  @last_message = e
+                  @last_message = e.to_s.force_encoding(Encoding::UTF_8)
                   nil
                 end
               end
@@ -1278,7 +1305,8 @@ module CDDL
     BRACE = {"{" => :map, "[" => :array}
     RANGE_EXCLUDE_END = {".." => false, "..." => true}
     SUPPORTED_ANNOTATIONS = [:bits, :size, :regexp, :cbor, :cborseq, :within, :and,
-                             :default, :lt, :le, :gt, :ge, :eq, :ne, :feature, :abnf, :cat, :plus]
+                             :default, :lt, :le, :gt, :ge, :eq, :ne,
+                             :feature, :abnf, :abnfb, :det, :cat, :plus]
 
     def type1(n, canbegroup = false)
 #      puts "NVALUE #{n.value.inspect}"

data/test-data/abnf2.cddl

@@ -0,0 +1,37 @@
+start = [Tag0, Tag1004]
+
+; for draft-ietf-cbor-date-tag
+Tag1004 = #6.1004(text .abnf full-date)
+; for RFC 7049
+Tag0 = #6.0(text .abnf date-time)
+
+full-date = "full-date" .cat rfc3339
+date-time = "date-time" .cat rfc3339
+
+; Note the trick of idiomatically starting with a newline, separating
+;   off the element in the .cat from the rule-list
+rfc3339 = '
+date-fullyear   = 4DIGIT
+date-month      = 2DIGIT  ; 01-12
+date-mday       = 2DIGIT  ; 01-28, 01-29, 01-30, 01-31 based on
+                        ; month/year
+time-hour       = 2DIGIT  ; 00-23
+time-minute     = 2DIGIT  ; 00-59
+time-second     = 2DIGIT  ; 00-58, 00-59, 00-60 based on leap sec
+                        ; rules
+time-secfrac    = "." 1*DIGIT
+time-numoffset  = ("+" / "-") time-hour ":" time-minute
+time-offset     = "Z" / time-numoffset
+
+partial-time    = time-hour ":" time-minute ":" time-second
+                [time-secfrac]
+full-date       = date-fullyear "-" date-month "-" date-mday
+full-time       = partial-time time-offset
+
+date-time       = full-date "T" full-time
+' .cat rfc5234-core
+
+rfc5234-core = '
+DIGIT          =  %x30-39 ; 0-9
+; abbreviated here
+'

data/test-data/abnf3.cddl

@@ -0,0 +1,32 @@
+start = [tt, tb, bt, bb]
+
+
+tt = text .abnf '4DIGIT 1FOO
+DIGIT          =  %x30-39 ; 0-9
+FOO = %xc0-cf
+'
+tb = text .abnfb '4DIGIT 1FOO
+DIGIT          =  %x30-39 ; 0-9
+FOO = %xc0-cf
+'
+bt = bytes .abnf '4DIGIT 1FOO
+DIGIT          =  %x30-39 ; 0-9
+FOO = %xc0-cf
+'
+bb = bytes .abnfb '4DIGIT 1FOO
+DIGIT          =  %x30-39 ; 0-9
+FOO = %xc0-cf
+'
+
+; ["7408\xC6", "7073\xC3", h'30383131CD', h'32363738CD']
+; ["5892\u00ca", "2145\u00c6", h'33333338C38B', h'31343033C388']
+
+
+; ** ENCOED UTF-8
+; ** ENCOED UTF-8
+; ** ENCOED UTF-8
+; ** ENCOED UTF-8
+; ["5845\u00c6", "9329\u00cb", h'38393538C389', h'33343230C386']
+
+
+; ["1066\u00cc", "9253\xC9", h'38333533C38A', h'32373337C4']

data/test-data/bat.cddl

@@ -0,0 +1,16 @@
+start = [v1, v2, v3, v4]
+
+v1 = "a" .bat "b"
+
+v2 = "a" .bat " b"
+
+v3 = "a" .bat '
+  oid = 1*arc
+  roid = *arc
+  arc = [nlsb] %x00-7f
+  nlsb = %x81-ff *%x80-ff
+'
+
+bbat<v1, v2> = ("" .bat v1) .bat v2
+
+v4 = bbat<" a", "   b">

data/test-data/oid.cddl

@@ -0,0 +1,8 @@
+oid = bytes .abnfb ("oid" .cat cbor-tags-oid)
+
+cbor-tags-oid = '
+oid = 1*arc
+roid = *arc
+arc = [nlsb] %x00-7f
+nlsb = %x81-ff *%x80-ff
+'

data/test-data/oidbat.cddl

@@ -0,0 +1,8 @@
+oid = bytes .abnfb ("oid" .bat cbor-tags-oid)
+
+cbor-tags-oid = '
+  oid = 1*arc
+  roid = *arc
+  arc = [nlsb] %x00-7f
+  nlsb = %x81-ff *%x80-ff
+'

data/test-data/sasl.cddl

@@ -0,0 +1,24 @@
+message = text .abnfb ("message" .cat rfc4505)
+
+rfc4505 = '
+message     = [ email / token ]
+              ;; to be prepared in accordance with Section 3
+
+UTF1        = %x00-3F / %x41-7F ;; less "@" (U+0040)
+UTF2        = %xC2-DF UTF0
+UTF3        = %xE0 %xA0-BF UTF0 / %xE1-EC 2(UTF0) /
+              %xED %x80-9F UTF0 / %xEE-EF 2(UTF0)
+UTF4        = %xF0 %x90-BF 2(UTF0) / %xF1-F3 3(UTF0) /
+              %xF4 %x80-8F 2(UTF0)
+UTF0        = %x80-BF
+
+TCHAR       = UTF1 / UTF2 / UTF3 / UTF4
+              ;; any UTF-8 encoded Unicode character
+              ;; except "@" (U+0040)
+
+email        = "too@much.work"; for this example
+;email       = addr-spec
+              ;; as defined in [IMAIL]
+
+token       = 1*255TCHAR
+'

data/test-data/yaron1.cddl

@@ -0,0 +1,95 @@
+csr-template-schema = {
+  keyTypes: [ 1* $keyType ]
+  ? subject: distinguishedName
+  extensions: extensions
+}
+
+mandatory-wildcard = "**"
+optional-wildcard = "*"
+wildcard = mandatory-wildcard / optional-wildcard
+
+; regtext matches all text strings but "*" and "**"
+regtext = text .regexp "([^\*].*)|([\*][^\*].*)|([\*][\*].+)"
+
+regtext-or-wildcard = regtext / wildcard
+
+distinguishedName = {
+  ? country: regtext-or-wildcard
+  ? stateOrProvince: regtext-or-wildcard
+  ? locality: regtext-or-wildcard
+  ? organization: regtext-or-wildcard
+  ? organizationalUnit: regtext-or-wildcard
+  ? emailAddress: regtext-or-wildcard
+  ? commonName: regtext-or-wildcard
+}
+
+$keyType /= rsaKeyType
+$keyType /= ecdsaKeyType
+
+rsaKeyType = {
+  PublicKeyType: "rsaEncryption" ; OID: 1.2.840.113549.1.1.1
+  PublicKeyLength: rsaKeySize
+  SignatureType: $rsaSignatureType
+}
+
+rsaKeySize = int .ge 2048
+
+; RSASSA-PKCS1-v1_5 with SHA-256
+$rsaSignatureType /= "sha256WithRSAEncryption"
+; RSASSA-PCKS1-v1_5 with SHA-384
+$rsaSignatureType /= "sha384WithRSAEncryption"
+; RSASSA-PCKS1-v1_5 with SHA-512
+$rsaSignatureType /= "sha512WithRSAEncryption"
+; RSASSA-PSS with SHA-256, MGF-1 with SHA-256, and a 32 byte salt
+$rsaSignatureType /= "sha256WithRSAandMGF1"
+; RSASSA-PSS with SHA-384, MGF-1 with SHA-384, and a 48 byte salt
+$rsaSignatureType /= "sha384WithRSAandMGF1"
+; RSASSA-PSS with SHA-512, MGF-1 with SHA-512, and a 64 byte salt
+$rsaSignatureType /= "sha512WithRSAandMGF1"
+
+ecdsaKeyType = {
+  PublicKeyType: "id-ecPublicKey" ; OID: 1.2.840.10045.2.1
+  namedCurve: $ecdsaCurve
+  SignatureType: $ecdsaSignatureType
+}
+
+$ecdsaCurve /= "secp256r1" ; OID: 1.2.840.10045.3.1.7
+$ecdsaCurve /= "secp384r1" ; OID: 1.3.132.0.34
+$ecdsaCurve /= "secp521r1" ; OID: 1.3.132.0.3
+
+$ecdsaSignatureType /= "ecdsa-with-SHA256" ; paired with secp256r1
+$ecdsaSignatureType /= "ecdsa-with-SHA384" ; paired with secp384r1
+$ecdsaSignatureType /= "ecdsa-with-SHA512" ; paired with secp521r1
+
+subjectaltname = {
+  ? DNS: [ 1* regtext-or-wildcard ]
+  ? Email: [ 1* regtext ]
+  ? URI: [ 1* regtext ]
+  * $$subjectaltname-extension
+}
+
+extensions = {
+  ? keyUsage: [ 1* keyUsageType ]
+  ? extendedKeyUsage: [ 1* extendedKeyUsageType ]
+  subjectAltName: subjectaltname
+}
+
+keyUsageType /= "digitalSignature"
+keyUsageType /= "nonRepudiation"
+keyUsageType /= "keyEncipherment"
+keyUsageType /= "dataEncipherment"
+keyUsageType /= "keyAgreement"
+keyUsageType /= "keyCertSign"
+keyUsageType /= "cRLSign"
+keyUsageType /= "encipherOnly"
+keyUsageType /= "decipherOnly"
+
+extendedKeyUsageType /= "serverAuth"
+extendedKeyUsageType /= "clientAuth"
+extendedKeyUsageType /= "codeSigning"
+extendedKeyUsageType /= "emailProtection"
+extendedKeyUsageType /= "timeStamping"
+extendedKeyUsageType /= "OCSPSigning"
+extendedKeyUsageType /= oid
+
+oid = text .regexp "[0-9]+(\\.[0-9]+)*"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cddl
 version: !ruby/object:Gem::Version
-  version: 0.8.17
+  version: 0.8.22
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cbor-diag
@@ -115,10 +115,13 @@ files:
 - test-data/a.cddl
 - test-data/abignum.cddl
 - test-data/abnf1.cddl
+- test-data/abnf2.cddl
+- test-data/abnf3.cddl
 - test-data/ambig.cddl
 - test-data/b.cddl
 - test-data/badaddr.cddl
 - test-data/basic_syntax_example.cddl
+- test-data/bat.cddl
 - test-data/bpv7.cddl
 - test-data/bpv7a.cddl
 - test-data/bpv7b.cddl
@@ -164,8 +167,11 @@ files:
 - test-data/mon-val.cddl
 - test-data/multipart-ct.cddl
 - test-data/named-group.cddl
+- test-data/oid.cddl
+- test-data/oidbat.cddl
 - test-data/patch1.cddl
 - test-data/reused_named_group.cddl
+- test-data/sasl.cddl
 - test-data/sequence.cddl
 - test-data/structure.cddl
 - test-data/test-gen.cddl
@@ -177,6 +183,7 @@ files:
 - test-data/wrong2.cddl
 - test-data/wrong2a.cddl
 - test-data/xmlmig.cddl
+- test-data/yaron1.cddl
 - test/test-cddl.rb
 homepage: http://github.com/cabo/cddl
 licenses: