cddlc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 119d5084051bfbc6889d6a9b36e22308cbb580c9d71b738e4c99ea2f908496cb
-  data.tar.gz: 33fafda14412916c5883260cb64bea2793785e359d833e6d9cee37cf76260186
+  metadata.gz: 446e27ac8733454e0a3a9a9e2f24a43f600f60a414400419287fe147649a7a1f
+  data.tar.gz: 1a4e7b41949419befd15479d0373bf3c316e22c62a6796c6453db6c3467f2b5d
 SHA512:
-  metadata.gz: c5936c13d4bca770fbcd628851f14a604e27a95e5c1c76329eb81932e7d9c7e72edf898d4989176baffa1d99a88f827e981fad338bb731560eb5547dba69342b
-  data.tar.gz: d3fe1f230d47841385cc12dd7cf3092c0feae0326ca6889eefb889ceb55903cac6919075cfaf2879961c185adf695df218cb2e1df418a781e6098bf4269d4d49
+  metadata.gz: 5fce60c859d8b361973c52a9e4d0a4e18908a7978d938a91c0e50125d64db3a5d704a9cc7f6ad8d17fb7f242bed3f31bb5df2107459d9fdacc57afae9f8df53e
+  data.tar.gz: 2c8a8e5f3653125cb719d6aeb7f46642643b561702824a4fcdd404dd40bcdf3ae362ca5cda5323b97f6da521dc555677d8f5139774a12ef9b2f599539b08850e

data/bin/cddlc

@@ -58,6 +58,9 @@ begin
     opts.on("-u", "--[no-]undefined", "Note undefined names") do |v|
       $options.note_undefined = v
     end
+    opts.on("-2", "--[no-]cddl2", "Perform some CDDL 2.0 processing") do |v|
+      $options.cddl2 = v
+    end
     opts.on("-tFMT", "--to=FMT", [:basic, :neat, :json, :yaml, :enum, :cddl], "Target format") do |v|
       $options.target = v
     end
@@ -88,6 +91,46 @@ result = if $options.rules
 
 warn "** can't note undefined for target != cddl" if $options.note_undefined && $options.target != :cddl
 
+if $options.cddl2
+  require_relative '../lib/processor/cddl-undefined.rb'
+  directives = cddl_file.lines.grep(/^;# /).map(&:chomp).map{|l| l.sub(/^;#\s+/, '')}
+  # puts "** Directives: <<"
+  # puts directives
+  directives.each do |di|
+    case di
+    when /\Ainclude\s+([-._a-zA-Z0-9]+)(?:\s+as\s+([-._a-zA-Z0-9]+))?\s*\z/
+      docref = $1
+      explicit_preferred_tag = $2
+      preferred_tag = explicit_preferred_tag || docref
+      puts "PREFERRED_TAG #{preferred_tag}" if $options.verbose
+      puts "DOCREF #{docref}" if $options.verbose
+      fn = docref.downcase << ".cddl"
+      io = File.open(fn) rescue File.open(CDDL::DATA_DIR + fn) # XXX CDDL_PATH
+      include_file = io.read
+      # XXX: processing directives recursively!
+      included_cddl = CDDL.from_cddl(include_file)
+      # XXX: Should namespace that thing now! all names -> preferred_tag.name
+      p included_cddl.rules.keys
+      # XXX: do once, first, to rename COSE_Key to RFC9052.COSE_Key
+      loop do
+        undef_rule, _undef_gen = cddl.cddl_undefined # ignore undef_gen for now
+        # p undef_rule
+        got_more = false
+        undef_rule.each do |name|
+          if rule = included_cddl.rules[name]
+            cddl.rules[name] = rule                     # XXX must be namespaced!
+            puts "IMPORTED #{name} from #{fn}" # ...: #{rule}... if $options.verbose
+            got_more = true
+          end
+        end
+        break unless got_more
+      end
+    else
+      warn "** unknown directive '#{di}' ignored"
+    end
+  end
+end
+
 case $options.target
 when :basic, nil
   pp result
@@ -116,32 +159,13 @@ when :enum
 when :cddl
   require_relative '../lib/writer/cddl-writer.rb'
   if $options.note_undefined
-    require_relative "../lib/processor/cddl-visitor.rb"
-    used = {}
-    gen_used = {}
-    def_gen = {}
-    cddl.rules.each do |k, v|
-      def_gen[k[0]] = true if Array === k
-      cddl.visit(v) do |p, &block|
-        case p
-        in ["gen", name, *_gen_args]
-          gen_used[name] = true
-        in ["name", name]
-          used[name] = true
-        else
-          false
-        end
-      end
+    require_relative '../lib/processor/cddl-undefined.rb'
+    undef_rule, undef_gen = cddl.cddl_undefined
+    undef_rule.each do |k|
+      puts ";;; *** undefined: #{k}"
     end
-    used.each do |k, v|
-      unless cddl.rules[k] || cddl.prelude.rules[k]
-        puts ";;; *** undefined: #{k}"
-      end
-    end
-    gen_used.each do |k, v|
-      unless def_gen[k]
-        puts ";;; *** undefined: #{k}<>"
-      end
+    undef_gen.each do |k|
+      puts ";;; *** undefined: #{k}<>"
     end
   end
   puts cddl.to_s

data/cddlc.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name = "cddlc"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
   s.summary = "CDDL (Concise Data Definition Language) converters and miscellaneous tools"
   s.description = %q{cddlc implements converters and miscellaneous tools for CDDL, RFC 8610}
   s.author = "Carsten Bormann"
   s.email = "cabo@tzi.org"
   s.license = "MIT"
   s.homepage = "http://github.com/cabo/cddlc"
-  s.files = Dir['lib/**/*.rb'] + %w(cddlc.gemspec data/prelude.cddl) + Dir['bin/**/*.rb']
+  s.files = Dir['lib/**/*.rb'] + %w(cddlc.gemspec) + Dir['data/*.cddl'] + Dir['bin/**/*.rb']
   s.executables = Dir['bin/*'].map {|x| File.basename(x)}
   s.required_ruby_version = '>= 1.9.2'
 

data/data/rfc9052.cddl

@@ -0,0 +1,154 @@
+
+start = COSE_Messages / COSE_Key / COSE_KeySet / Internal_Types
+
+; This is defined to make the tool quieter:
+Internal_Types = Sig_structure / Enc_structure / MAC_structure
+
+
+label = int / tstr
+values = any
+
+
+COSE_Messages = COSE_Untagged_Message / COSE_Tagged_Message
+
+COSE_Untagged_Message = COSE_Sign / COSE_Sign1 /
+    COSE_Encrypt / COSE_Encrypt0 /
+    COSE_Mac / COSE_Mac0
+
+COSE_Tagged_Message = COSE_Sign_Tagged / COSE_Sign1_Tagged /
+    COSE_Encrypt_Tagged / COSE_Encrypt0_Tagged /
+    COSE_Mac_Tagged / COSE_Mac0_Tagged
+
+
+Headers = (
+    protected : empty_or_serialized_map,
+    unprotected : header_map
+)
+
+header_map = {
+    Generic_Headers,
+    * label => values
+}
+
+empty_or_serialized_map = bstr .cbor header_map / bstr .size 0
+
+
+
+Generic_Headers = (
+    ? 1 => int / tstr,  ; algorithm identifier
+    ? 2 => [+label],    ; criticality
+    ? 3 => tstr / int,  ; content type
+    ? 4 => bstr,        ; key identifier
+    ? ( 5 => bstr //    ; IV
+        6 => bstr )     ; Partial IV
+)
+
+
+COSE_Sign_Tagged = #6.98(COSE_Sign)
+
+
+COSE_Sign = [
+    Headers,
+    payload : bstr / nil,
+    signatures : [+ COSE_Signature]
+]
+
+
+COSE_Signature =  [
+    Headers,
+    signature : bstr
+]
+
+
+COSE_Sign1_Tagged = #6.18(COSE_Sign1)
+
+
+COSE_Sign1 = [
+    Headers,
+    payload : bstr / nil,
+    signature : bstr
+]
+
+
+Sig_structure = [
+    context : "Signature" / "Signature1",
+    body_protected : empty_or_serialized_map,
+    ? sign_protected : empty_or_serialized_map,
+    external_aad : bstr,
+    payload : bstr
+]
+
+
+COSE_Encrypt_Tagged = #6.96(COSE_Encrypt)
+
+
+COSE_Encrypt = [
+    Headers,
+    ciphertext : bstr / nil,
+    recipients : [+COSE_recipient]
+]
+
+
+COSE_recipient = [
+    Headers,
+    ciphertext : bstr / nil,
+    ? recipients : [+COSE_recipient]
+]
+
+
+COSE_Encrypt0_Tagged = #6.16(COSE_Encrypt0)
+
+
+COSE_Encrypt0 = [
+    Headers,
+    ciphertext : bstr / nil,
+]
+
+
+Enc_structure = [
+    context : "Encrypt" / "Encrypt0" / "Enc_Recipient" /
+        "Mac_Recipient" / "Rec_Recipient",
+    protected : empty_or_serialized_map,
+    external_aad : bstr
+]
+
+
+COSE_Mac_Tagged = #6.97(COSE_Mac)
+
+
+COSE_Mac = [
+   Headers,
+   payload : bstr / nil,
+   tag : bstr,
+   recipients : [+COSE_recipient]
+]
+
+
+COSE_Mac0_Tagged = #6.17(COSE_Mac0)
+
+
+COSE_Mac0 = [
+   Headers,
+   payload : bstr / nil,
+   tag : bstr,
+]
+
+
+MAC_structure = [
+     context : "MAC" / "MAC0",
+     protected : empty_or_serialized_map,
+     external_aad : bstr,
+     payload : bstr
+]
+
+
+COSE_Key = {
+    1 => tstr / int,          ; kty
+    ? 2 => bstr,              ; kid
+    ? 3 => tstr / int,        ; alg
+    ? 4 => [+ (tstr / int) ], ; key_ops
+    ? 5 => bstr,              ; Base IV
+    * label => values
+}
+
+COSE_KeySet = [+COSE_Key]

data/lib/cddlc.rb

@@ -66,9 +66,12 @@ class CDDL
     @rules
   end
 
+  DATA_DIR = Pathname.new(__FILE__) + "../../data/"
+
   def prelude
     if @prelude.nil?
-      @prelude = CDDL.from_cddl(File.read(Pathname.new(__FILE__) + "../../data/prelude.cddl"))
+      @prelude = CDDL.from_cddl(File.read(DATA_DIR + "prelude.cddl"))
+
     end
     @prelude
   end

data/lib/processor/cddl-undefined.rb

@@ -0,0 +1,29 @@
+require_relative "../cddlc.rb"
+require_relative "./cddl-visitor.rb"
+require_relative "./cddl-expander.rb"
+
+class CDDL
+  def cddl_undefined
+    # currently only works on expanded...
+    cddl2 = self
+    cddl2.expand_generics
+    used = {}
+    gen_used = {}
+    def_gen = {}
+    cddl2.rules.each do |k, v|
+      def_gen[k[0]] = true if Array === k
+      cddl2.visit(v) do |p, &block|
+        case p
+        in ["gen", name, *_gen_args]
+          gen_used[name] = true
+        in ["name", name]
+          used[name] = true
+        else
+          false
+        end
+      end
+    end
+    [used.keys.reject {|name| cddl2.rules[name] || prelude.rules[name]},
+     gen_used.keys.reject {|name| def_gen[name] }]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cddlc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Carsten Bormann
@@ -76,10 +76,12 @@ files:
 - bin/cddlc
 - cddlc.gemspec
 - data/prelude.cddl
+- data/rfc9052.cddl
 - lib/cddlc.rb
 - lib/parser/cddl-util.rb
 - lib/parser/cddlgrammar.rb
 - lib/processor/cddl-expander.rb
+- lib/processor/cddl-undefined.rb
 - lib/processor/cddl-visitor.rb
 - lib/writer/cddl-writer.rb
 homepage: http://github.com/cabo/cddlc