cddl 0.8.8 → 0.8.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c877883cb125426e061f527ba4375c0f021d70dfef060336fe0bb0f5e2ca3d4
-  data.tar.gz: 7a3dc4065f3616bf57c229b410782b35140018ecada4418c0ef45056c62aef0b
+  metadata.gz: 3c83003981d07eae336683b02bebaa0340f56941724ed6f91d89c6b8baf8f234
+  data.tar.gz: bf5e14489fd50c0b14bd27a99f11c3a35c046ed8113764094d8fc6a7ef4ff0d8
 SHA512:
-  metadata.gz: b3987fbe82e80dddba2f650b1a12941ed6092708297302cf1a78dfe45b20b79d08e85901cb8739b5fc79eab8cde70ca8efb88698f4340da72c722a7a461565c6
-  data.tar.gz: 68c35688bac9b30411ee419e171860c463df28c3452bce1741399274e51295b609e0acc8df54e9876037f9d96ba02e369fd9465c2fe7c38bb9682d5ec19018cd
+  metadata.gz: 74f3d9b8cb2f1c188aff29fe9e8dcc3496cb978063e67e7a84932cbe7045163529586547836747237f8f5451b2ffaeaf550165df5aea3003ee9a31c882408488
+  data.tar.gz: b021259524e95100b668a5b335adf85c714f73fbf4b22fd2cd7a84dcc9ea35c227401339c8a40a06f8e46e77d77fa19d2d0240fef60f89703eb66cff0f31ebf1

data/cddl.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'cddl'
-  s.version = '0.8.8'
+  s.version = '0.8.10'
   s.summary = "CDDL generator and validator."
   s.description = %{A parser, generator, and validator for CDDL}
   s.add_dependency('cbor-diag')
@@ -19,3 +19,4 @@ spec = Gem::Specification.new do |s|
   s.homepage = "http://github.com/cabo/cddl"
   s.license = 'MIT'
 end
+

data/lib/cddl.rb

@@ -329,8 +329,12 @@ module CDDL
           unless kr
             case vr[0]
             when :grpent
-              fail "grpent in map #{vr.inspect}" unless vr.size == 2
-              g = Array.new(st) { generate1(vr[1], true) }.flatten(1)
+              # fail "grpent in map #{vr.inspect}" unless vr.size == 2
+              g = Array.new(st) {
+                vr[1..-1].map{ |vrx|
+                  generate1(vrx, true)
+                }.flatten(1)
+              }.flatten(1)
               # warn "GGG #{g.inspect}"
               return g
             when :grpchoice
@@ -523,7 +527,7 @@ module CDDL
       end
     end
 
-    VALUE_TYPE = {text: String, int: Integer, float: Float}
+    VALUE_TYPE = {text: String, bytes: String, int: Integer, float: Float}
     SIMPLE_VALUE = {
       [:prim, 7, 20] => [true, false, :bool],
       [:prim, 7, 21] => [true, true, :bool],
@@ -552,6 +556,7 @@ module CDDL
         if warn
           warn "CDDL validation failure (#{result.inspect} for #{d.inspect}):"
           PP::pp(validate_diag, STDERR)
+          puts(validate_diag.cbor_diagnostic)
         end
       end
       result
@@ -741,9 +746,12 @@ module CDDL
           idx, ann = validate_forward(d, 0, where)
           ann if validate_result(idx == d.size) { "#{validate_diag.inspect} -- cannot complete (#{idx}, #{d.size}) array #{d} for #{where}" }
         end
-      when :text, :int, :float, :bytes
+      when :int, :float
         _, v = extract_value(where)
         [] if d == v
+      when :text, :bytes
+        _, v = extract_value(where)
+        [] if d == v && ((d.encoding == Encoding::BINARY) == (v.encoding == Encoding::BINARY))
       when :range
         [] if where[2] === d && where[1].include?(d)
       when :anno
@@ -837,6 +845,14 @@ module CDDL
         when 3
           String === d && d.encoding != Encoding::BINARY # cheat
         when 6
+          if Integer === d
+            t = 2               # assuming only 2/3 match an Integer
+            if d < 0
+              d = ~d
+              t = 3
+            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])
         when 7
           t, v = extract_value(where)
@@ -959,7 +975,7 @@ module CDDL
          when ""
            parts[1].b
          when "h"
-           parts[1].gsub(/\s/, "").chars.each_slice(2).map{ |x| Integer(x.join, 16).chr("BINARY") }.join
+           parts[1].gsub(/\s/, "").chars.each_slice(2).map{ |x| Integer(x.join, 16).chr("BINARY") }.join.b
          when "b64"
             Base64.urlsafe_decode64(parts[1])
          else
@@ -1142,7 +1158,7 @@ module CDDL
           end
         when :recurse_grpent # XXX we don't have the entry yet
         when :member
-          fail "map entry without member key given: #{member}" unless member[3] || member[4][0] == :grpent || member[4][0] == :grpchoice
+          fail "map entry #{member.inspect} without member key given: #{member}" unless member[3] || member[4][0] == :grpent || member[4][0] == :grpchoice
         else
           fail ["type1 member", member].inspect unless member[0] == :member
         end

data/test/test-cddl.rb

@@ -171,6 +171,57 @@ HERE
     assert parser.validate_for_test(true)
   end
 
+  def test_validate_bignum
+    parser = CDDL::Parser.new <<HERE
+test = bigint
+HERE
+    assert parser.validate_for_test(2**4711)
+    assert parser.validate_for_test(-2**815)
+    assert parser.validate_for_test(1)
+    assert parser.validate_for_test(0)
+    assert parser.validate_for_test(-11)
+  end
+
+  def test_aaaaaaaa_invalidate_bignum
+    parser = CDDL::Parser.new <<HERE
+test = bignint
+HERE
+    refute parser.validate_for_test(2**4711, false)
+    assert parser.validate_for_test(-2**815)
+    refute parser.validate_for_test(1, false)
+    refute parser.validate_for_test(0, false)
+    assert parser.validate_for_test(-11)
+  end
+
+  
+  def test_aaaaaaaa_validate_bignum0b
+    parser = CDDL::Parser.new <<HERE
+test = #6.2("")
+HERE
+    refute parser.validate_for_test(1, false)
+    refute parser.validate_for_test(0, false)
+  end
+
+  
+  def test_aaaaaaaa_validate_bignum0
+    parser = CDDL::Parser.new <<HERE
+test = #6.2(h'')
+HERE
+    assert parser.validate_for_test(0)
+    refute parser.validate_for_test(1, false)
+  end
+
+  
+  def test_aaaaaaaa_validate_bignum1
+    parser = CDDL::Parser.new <<HERE
+test = #6.2(h'01')
+HERE
+    assert parser.validate_for_test(1)
+    refute parser.validate_for_test(0, false)
+    refute parser.validate_for_test(2, false)
+  end
+
+
   def test_validate_a
     parser = CDDL::Parser.new <<HERE
 test = [* one: 1]

data/test-data/7807.cddl

@@ -0,0 +1,14 @@
+coap-problem-details = {
+ type => uint,
+ ? title => text,
+ ? response-code => bstr .size 1,
+ ? detail => text,
+ ? instance => uri,
+ * $$coap-problem-details-extension,
+}
+
+type = 0
+title = 1
+response-code = 2
+detail = 3
+instance = 4

data/test-data/abignum.cddl

@@ -0,0 +1 @@
+abignum = unsigned

data/test-data/bpv7.cddl

@@ -0,0 +1,136 @@
+   start = bundle
+
+   dtn-time = uint
+
+   creation-timestamp = [dtn-time, sequence: uint]
+
+   eid-generic = [uri-code, SSP: any]
+
+   uri-code = uint
+
+   eid = eid-choice .within eid-generic
+
+   eid-choice /= [dtn-code, SSP: (text / 0)]
+
+   dtn-code = 1 ; TBD
+
+   eid-choice /= [ipn-code, SSP: [nodenum: uint, servicenum: uint]]
+
+   ipn-code = 2 ; TBD
+
+   bundle-control-flags = uint .bits bundleflagbits
+
+   bundleflagbits = &(
+
+     reserved: 15
+
+     reserved: 14
+
+     reserved: 13
+
+     bundle-deletion-status-reports-are-requested: 12
+
+     bundle-delivery-status-reports-are-requested: 11
+
+     bundle-forwarding-status-reports-are-requested: 10
+
+     reserved: 9
+
+     bundle-reception-status-reports-are-requested: 8
+
+     bundle-contains-a-Manifest-block: 7
+
+     status-time-is-requested-in-all-status-reports: 6
+
+     user-application-acknowledgement-is-requested: 5
+
+     reserved: 4
+
+     reserved: 3
+
+     bundle-must-not-be-fragmented: 2
+
+     payload-is-an-administrative-record: 1
+
+     bundle-is-a-fragment: 0
+
+   )
+
+   crc = bytes
+
+   block-control-flags = uint .bits blockflagbits
+
+   blockflagbits = &(
+
+     reserved: 7
+
+     reserved: 6
+
+     reserved: 5
+
+     reserved: 4
+
+     bundle-must-be-deleted-if-block-cannot-be-processed: 3
+
+     status-report-must-be-transmitted-if-block-cannot-be-processed: 2
+
+     block-must-be-removed-from-bundle-if-it-cannot-be-processed: 1
+
+     block-must-be-replicated-in-every-fragment: 0
+
+   )
+
+   bundle = [primary-block, *extension-block, payload-block]
+
+   primary-block = [
+
+                 version: 7,
+
+                 bundle-control-flags,
+
+                 crc-type: uint,
+
+                 destination: eid,
+
+                 source-node: eid,
+
+                 report-to: eid,
+
+                 creation-timestamp,
+
+                 lifetime: uint,
+
+                 ? fragment-offset: uint,
+
+                 ? total-application-data-length: uint,
+
+                 ? crc,
+
+   ]
+
+   canonical-block = [
+
+                           block-type-code: uint,
+
+                           canonical-block-common,
+
+                           ? crc
+
+   ]
+
+   canonical-block-common = (
+
+                          block-number: uint,
+
+                          block-control-flags,
+
+                          crc-type: uint,
+
+                          block-type-specific-data: bytes
+
+   )
+
+
+payload-block = ([block-type-code: 1, canonical-block-common, ?crc]) .within canonical-block
+
+extension-block = ([block-type-code: (uint .ne 1), canonical-block-common, ?crc]) .within canonical-block

data/test-data/bpv7a.cddl

@@ -0,0 +1,181 @@
+start = bundle / #6.55799(bundle)
+
+; Times before 2000 are invalid
+dtn-time = uint
+
+; CRC enumerated type
+crc-type = 0 / 1 / 2
+; Either 16-bit or 32-bit
+crc-value = (bstr .size 2) / (bstr .size 4)
+
+creation-timestamp = [dtn-time, sequence: uint]
+
+eid = $eid-choice .within eid-structure
+eid-structure = [
+ uri-code: uint,
+ SSP: any
+]
+$eid-choice /= [
+ uri-code: 1,
+ SSP: (tstr / 0)
+]
+$eid-choice /= [
+ uri-code: 2,
+ SSP: [
+   nodenum: uint,
+   servicenum: uint
+ ]
+]
+
+bundle-control-flags = uint .bits bundleflagbits
+bundleflagbits = &(
+ reserved: 15
+ reserved: 14
+ reserved: 13
+ bundle-deletion-status-reports-are-requested: 12
+ bundle-delivery-status-reports-are-requested: 11
+ bundle-forwarding-status-reports-are-requested: 10
+ reserved: 9
+ bundle-reception-status-reports-are-requested: 8
+ bundle-contains-a-Manifest-block: 7
+ status-time-is-requested-in-all-status-reports: 6
+ user-application-acknowledgement-is-requested: 5
+ reserved: 4
+ reserved: 3
+ bundle-must-not-be-fragmented: 2
+ payload-is-an-administrative-record: 1
+ bundle-is-a-fragment: 0
+)
+
+block-control-flags = uint .bits blockflagbits
+blockflagbits = &(
+ reserved: 7
+ reserved: 6
+ reserved: 5
+ reserved: 4
+ bundle-must-be-deleted-if-block-cannot-be-processed: 3
+ status-report-must-be-transmitted-if-block-cannot-be-processed: 2
+ block-must-be-removed-from-bundle-if-it-cannot-be-processed: 1
+ block-must-be-replicated-in-every-fragment: 0
+)
+
+bundle = [primary-block, *extension-block, payload-block]
+
+primary-block = [
+ version: 7,
+ bundle-control-flags,
+ crc-type,
+ destination: eid,
+ source-node: eid,
+ report-to: eid,
+ creation-timestamp,
+ lifetime: uint,
+ ? (
+   fragment-offset: uint,
+;    total-application-data-length: uint,
+ )
+ ? crc-value,
+]
+
+; Abstract shared structure of all non-primary blocks
+canonical-block-structure = [
+ block-type-code: uint,
+ block-number: uint,
+ block-control-flags,
+ crc-type,
+ ; Each block type defines the content within the bytestring
+ block-type-specific-data,
+ ? crc-value
+]
+block-type-specific-data = bstr / #6.24(bstr)
+; Extension block type, which does not specialize any more than the code/number
+extension-block = $extension-block-structure .within canonical-block-structure
+$extension-block-structure = [
+ block-type-code: (uint .gt 1),
+ extension-block-number,
+ block-control-flags,
+ crc-type,
+ ($extension-block-data .within block-type-specific-data)
+ ? crc-value
+]
+extension-block-number = (uint .ne 0)
+; Payload block type
+payload-block = payload-block-structure .within canonical-block-structure
+payload-block-structure = [
+ block-type-code: 1,
+ block-number: 0,
+ block-control-flags,
+ crc-type,
+ ($payload-block-data .within block-type-specific-data)
+ ? crc-value
+]
+
+; Arbitrary payload data
+$payload-block-data /= bstr
+
+
+; Administrative record as a payload data specialization
+$payload-block-data /= block-type-specific-data .cbor admin-record
+admin-record = $admin-record .within admin-record-structure
+admin-record-structure = [
+ record-type-code: uint,
+ record-content: any
+]
+; Only one defined record type
+$admin-record /= [1, status-record-content]
+status-record-content = [
+ bundle-status-information,
+ status-report-reason-code: uint,
+ source-node-eid: eid,
+ subject-creation-timestamp: creation-timestamp,
+ ? (
+   subject-payload-offset: uint,
+   subject-payload-length: uint
+ )
+]
+bundle-status-information = [
+ reporting-node-received-bundle: status-info-content,
+ reporting-node-forwarded-bundle: status-info-content,
+ reporting-node-delivered-bundle: status-info-content,
+ reporting-node-deleted-bundle: status-info-content
+]
+status-info-content = [
+ status-indicator: bool,
+ ? timestamp: dtn-time
+]
+
+; Previous Node extension block
+$extension-block-structure /= [
+ block-type-code: 7,
+ extension-block-number,
+ block-control-flags,
+ crc-type,
+ (block-type-specific-data .cbor ext-data-previous-node)
+ ? crc-value
+]
+ext-data-previous-node = eid
+
+; Bundle Age extension block
+$extension-block-structure /= [
+ block-type-code: 8,
+ extension-block-number,
+ block-control-flags,
+ crc-type,
+ (block-type-specific-data .cbor ext-data-bundle-age)
+ ? crc-value
+]
+ext-data-bundle-age = uint
+
+; Hop Count extension block
+$extension-block-structure /= [
+ block-type-code: 9,
+ extension-block-number,
+ block-control-flags,
+ crc-type,
+ (block-type-specific-data .cbor ext-data-hop-count)
+ ? crc-value
+]
+ext-data-hop-count = [
+ hop-limit: uint,
+ hop-count: uint
+]

data/test-data/bpv7b.cddl

@@ -0,0 +1,167 @@
+start = bundle / #6.55799(bundle)
+
+; Times before 2000 are invalid
+dtn-time = uint
+
+; CRC enumerated type
+crc-type = 0 / 1 / 2
+; Either 16-bit or 32-bit
+crc-value = (bstr .size 2) / (bstr .size 4)
+
+creation-timestamp = [dtn-time, sequence: uint]
+
+eid = $eid-choice .within eid-structure
+eid-structure = [
+  uri-code: uint,
+  SSP: any
+]
+$eid-choice /= [
+  uri-code: 1,
+  SSP: (tstr / 0)
+]
+$eid-choice /= [
+  uri-code: 2,
+  SSP: [
+    nodenum: uint,
+    servicenum: uint
+  ]
+]
+
+; The root bundle array
+bundle = [primary-block, *extension-block, payload-block]
+
+primary-block = [
+  version: 7,
+  bundle-control-flags,
+  crc-type,
+  destination: eid,
+  source-node: eid,
+  report-to: eid,
+  creation-timestamp,
+  lifetime: uint,
+  ? (
+    fragment-offset: uint,
+    total-application-data-length: uint,
+  )
+  ? crc-value,
+]
+bundle-control-flags = uint .bits bundleflagbits
+bundleflagbits = &(
+  reserved: 15,
+  reserved: 14,
+  reserved: 13,
+  bundle-deletion-status-reports-are-requested: 12,
+  bundle-delivery-status-reports-are-requested: 11,
+  bundle-forwarding-status-reports-are-requested: 10,
+  reserved: 9,
+  bundle-reception-status-reports-are-requested: 8,
+  bundle-contains-a-Manifest-block: 7,
+  status-time-is-requested-in-all-status-reports: 6,
+  user-application-acknowledgement-is-requested: 5,
+  reserved: 4,
+  reserved: 3,
+  bundle-must-not-be-fragmented: 2,
+  payload-is-an-administrative-record: 1,
+  bundle-is-a-fragment: 0
+)
+
+; Abstract shared structure of all non-primary blocks
+canonical-block-structure = [
+  block-type-code: uint,
+  block-number: uint,
+  block-control-flags,
+  crc-type,
+  ; Each block type defines the content within the bytestring
+  block-type-specific-data,
+  ? crc-value
+]
+block-control-flags = uint .bits blockflagbits
+blockflagbits = &(
+  reserved: 7,
+  reserved: 6,
+  reserved: 5,
+  reserved: 4,
+  bundle-must-be-deleted-if-block-cannot-be-processed: 3,
+  status-report-must-be-transmitted-if-block-cannot-be-processed: 2,
+  block-must-be-removed-from-bundle-if-it-cannot-be-processed: 1,
+  block-must-be-replicated-in-every-fragment: 0
+)
+block-type-specific-data = bstr / #6.24(bstr)
+; Actual CBOR data embedded in a bytestring, with optional tag to indicate so
+embedded-cbor<Item> = (bstr .cbor Item) / #6.24(bstr .cbor Item)
+
+; Extension block type, which does not specialize other than the code/number
+extension-block = $extension-block-structure .within canonical-block-structure
+; Generic shared structure of all non-primary blocks
+extension-block-use<CodeValue, BlockData> = [
+  block-type-code: CodeValue,
+  block-number: (uint .ne 0),
+  block-control-flags,
+  crc-type,
+  BlockData,
+  ? crc-value
+]
+
+; Payload block type
+payload-block = payload-block-structure .within canonical-block-structure
+payload-block-structure = [
+  block-type-code: 1,
+  block-number: 0,
+  block-control-flags,
+  crc-type,
+  $payload-block-data,
+  ? crc-value
+]
+
+; Arbitrary payload data, including non-CBOR bytestring
+$payload-block-data /= block-type-specific-data
+
+
+; Administrative record as a payload data specialization
+$payload-block-data /= embedded-cbor<admin-record>
+admin-record = $admin-record .within admin-record-structure
+admin-record-structure = [
+  record-type-code: uint,
+  record-content: any
+]
+; Only one defined record type
+$admin-record /= [1, status-record-content]
+status-record-content = [
+  bundle-status-information,
+  status-report-reason-code: uint,
+  source-node-eid: eid,
+  subject-creation-timestamp: creation-timestamp,
+  ? (
+    subject-payload-offset: uint,
+    subject-payload-length: uint
+  )
+]
+bundle-status-information = [
+  reporting-node-received-bundle: status-info-content,
+  reporting-node-forwarded-bundle: status-info-content,
+  reporting-node-delivered-bundle: status-info-content,
+  reporting-node-deleted-bundle: status-info-content
+]
+status-info-content = [
+  status-indicator: bool,
+  ? timestamp: dtn-time
+]
+
+
+; Previous Node extension block
+$extension-block-structure /=
+  extension-block-use<7, embedded-cbor<ext-data-previous-node>>
+ext-data-previous-node = eid
+
+; Bundle Age extension block
+$extension-block-structure /= 
+  extension-block-use<8, embedded-cbor<ext-data-bundle-age>>
+ext-data-bundle-age = uint
+
+; Hop Count extension block
+$extension-block-structure /=
+  extension-block-use<9, embedded-cbor<ext-data-hop-count>>
+ext-data-hop-count = [
+  hop-limit: uint,
+  hop-count: uint
+]

data/test-data/coral.cddl

@@ -0,0 +1,10 @@
+coral = [+ s-exp]
+s-exp = ((text, value, ?coral) // directive)
+value = ctext / cbytes / cint / cfloat / cboolean / cdatetime / null / {"_link": tstr} / {"_form": tstr}
+ctext = text / {"_text": text}
+cint = {"_int": int}
+cfloat = float / {"_float": float}
+cboolean = bool / {"_bool": bool}
+cdatetime = {"_datetime": text}
+cbytes = {"_bytes": text} ; base64url no padding
+directive = (("_using", {* text => text}) // ("_base", text))

data/test-data/coral1.cddl

@@ -0,0 +1,5 @@
+document = {*element}
+element = (relation => value / [2*value])
+
+relation = text
+value = text

data/test-data/coral2.cddl

@@ -0,0 +1,7 @@
+document = {*element}
+element = (text => value / [2*value])
+value = text / float / bool / tagged
+tagged = {"_int":int,*element} / {"_float":float,*element} / {"_text":text,*element} / {"_bytes":bytes,*element} / {"_datetime":text,*element} / {"_bool":bool,*element} / {"_link":ciri,*element} / {"_form":ciri,*element}
+ciri = text ; full IRI given
+     / [text] ; suffix for default prefix
+     / [text, text] ; prefix, suffix for that prefix

data/test-data/coral3.cddl

@@ -0,0 +1,7 @@
+document = {? ("_using" => {* text => text}), *element}
+element = (text => value / [2*value])
+value = text / float / bool / tagged / {*element}
+tagged = {"_int": int, *element} / {"_float": float, *element} / {"_text": text, *element} / {"_bytes": bytes, *element} / {"_datetime": text, *element} / {"_bool": bool, *element} / {"_link": ciri, *element} / {"_form": ciri, *element}
+ciri = text ; full IRI given
+     / [text] ; suffix for default prefix
+     / [text, text] ; prefix, suffix for that prefix

data/test-data/foo.cddl

@@ -0,0 +1 @@
+foo=bar=int