cddl 0.8.1 → 0.8.12

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/dotsize.cddl

@@ -0,0 +1,7 @@
+foo = [a, b, c]
+
+a = uint .size 4
+
+b = bytes .size 4
+
+c = text .size (0..30)

data/test-data/feat1.cddl

@@ -0,0 +1,4 @@
+bla = {
+    a: int
+    ? ("b" .feature "foo") => float
+}

data/test-data/foo.cddl

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

data/test-data/grasp-09.cddl

@@ -0,0 +1,108 @@
+  grasp-message = (message .within message-structure) / noop-message
+
+  message-structure = [MESSAGE_TYPE, session-id, ?initiator,
+                       *grasp-option]
+
+  MESSAGE_TYPE = 0..255
+  session-id = 0..4294967295 ;up to 32 bits
+  grasp-option = any
+
+  message /= discovery-message
+  discovery-message = [M_DISCOVERY, session-id, initiator, objective]
+
+  message /= response-message ;response to Discovery
+  response-message = [M_RESPONSE, session-id, initiator, ttl,
+                     (+locator-option // divert-option), ?objective]
+
+  message /= synch-message ;response to Synchronization request
+  synch-message = [M_SYNCH, session-id, objective]
+
+  message /= flood-message
+  flood-message = [M_FLOOD, session-id, initiator, ttl,
+                  +[objective, (locator-option / [])]]
+
+  message /= request-negotiation-message
+  request-negotiation-message = [M_REQ_NEG, session-id, objective]
+
+  message /= request-synchronization-message
+  request-synchronization-message = [M_REQ_SYN, session-id, objective]
+
+  message /= negotiation-message
+  negotiation-message = [M_NEGOTIATE, session-id, objective]
+
+  message /= end-message
+  end-message = [M_END, session-id, accept-option / decline-option ]
+
+  message /= wait-message
+  wait-message = [M_WAIT, session-id, waiting-time]
+
+  message /= invalid-message
+  invalid-message = [M_INVALID, session-id, ?any]
+
+  noop-message = [M_NOOP]
+
+  divert-option = [O_DIVERT, +locator-option]
+
+  accept-option = [O_ACCEPT]
+
+  decline-option = [O_DECLINE, ?reason]
+  reason = text  ;optional error message
+
+  waiting-time = 0..4294967295 ; in milliseconds
+  ttl = 0..4294967295 ; in milliseconds
+
+  locator-option /= [O_IPv4_LOCATOR, ipv4-address,
+                     transport-proto, port-number]
+  ipv4-address = bytes .size 4
+
+  locator-option /= [O_IPv6_LOCATOR, ipv6-address,
+                     transport-proto, port-number]
+  ipv6-address = bytes .size 16
+
+  locator-option /= [O_FQDN_LOCATOR, text, transport-proto, port-number]
+
+  transport-proto = IPPROTO_TCP / IPPROTO_UDP
+  IPPROTO_TCP = 6
+  IPPROTO_UDP = 17
+  port-number = 0..65535
+
+  locator-option /= [O_URI_LOCATOR, text]
+
+  initiator = ipv4-address / ipv6-address
+
+  objective-flags = uint .bits objective-flag
+
+  objective-flag = &(
+    F_DISC: 0    ; valid for discovery
+    F_NEG: 1     ; valid for negotiation
+    F_SYNCH: 2   ; valid for synchronization
+    F_NEG_DRY: 3 ; negotiation is dry-run
+  )
+
+  objective = [objective-name, objective-flags, loop-count, ?any]
+
+  objective-name = text ;see specification for uniqueness rules
+
+  loop-count = 0..255
+
+  ; Constants for message types and option types
+
+  M_NOOP = 0
+  M_DISCOVERY = 1
+  M_RESPONSE = 2
+  M_REQ_NEG = 3
+  M_REQ_SYN = 4
+  M_NEGOTIATE = 5
+  M_END = 6
+  M_WAIT = 7
+  M_SYNCH = 8
+  M_FLOOD = 9
+  M_INVALID = 99
+
+  O_DIVERT = 100
+  O_ACCEPT = 101
+  O_DECLINE = 102
+  O_IPv6_LOCATOR = 103
+  O_IPv4_LOCATOR = 104
+  O_FQDN_LOCATOR = 105
+  O_URI_LOCATOR = 106

data/test-data/jim-cut-2.cddl

@@ -0,0 +1,11 @@
+
+map-example = {
+  ? optional-key : int,
+  * map-example-extension,
+  * tstr => any
+}
+
+map-example-extension = ()
+
+map-example-extension //= (another-optional-key : tstr,)
+map-example-extension //= ("and a third" : bstr,)

data/test-data/jim-cut.cddl

@@ -0,0 +1,12 @@
+map-example = {
+  ? "optional-key" : int,
+  map-example-extensions,
+  * tstr => any
+}
+
+map-example-extensions = ()
+
+map-example-extensions //= (
+  "another-optional-key" : tstr,
+ "and a third": bstr
+)