tlv 0.0.3

data/LICENSE

@@ -0,0 +1,58 @@
+This package is copyrighted free software by Tim Becker <tim@kuriositaet.de>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see COPYING.txt file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+

data/README

@@ -0,0 +1,38 @@
+= tlv -- lib to facilitate working with tlv data
+   
+
+== Installing
+
+Having a "Installing" section is a bit of a chicken or egg question.
+Someone reading this README has, in all likelyhood already installed the
+package. 
+
+ You can install the +tlv+ package by executing:
+
+	gem install tlv -r
+
+alternatively, you can download +.tar.gz+ or +.zip+ archives from 
+Rubyforge[http://rubyforge.org/frs/?group_id=2203].
+
+
+== Mail
+
+In case you discover bugs, spelling errors, offer suggestions for
+improvements or would like to help out with the project, you can contact
+me directly (tim@kuriositaet.de).	
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+=

data/Rakefile

@@ -0,0 +1,163 @@
+require "rdoc/task"
+require "rubygems/package_task"
+require "rake/testtask"
+require "rake/clean"
+require "rubygems"
+
+# Some definitions that you'll need to edit in case you reuse this
+# Rakefile for your own project.
+
+SHORTNAME	      ='tlv'	# this should be the rubyforge project name
+DESC		        ='lib for handling tlv data'
+PKG_VERSION 	  ='0.0.3'
+LONG_DESC	= <<END_DESC
+  lib for handling tlv (der) and dgi encoded data	
+END_DESC
+RUBYFORGE_USER	='a2800276'
+AUTHOR          = "Tim Becker"
+EMAIL           = "tim@kuriositaet.de"
+HOMEPAGE        = "http://github.com/a2800276/tlv"
+
+
+# Specifies the default task to execute. This is often the "test" task
+# and we'll change things around as soon as we have some tests.
+
+task  :default => [:test]
+
+# The directory to generate +rdoc+ in.
+RDOC_DIR="doc/html"
+
+# This global variable contains files that will be erased by the `clean` task.
+# The `clean` task itself is automatically generated by requiring `rake/clean`.
+
+CLEAN << RDOC_DIR << "pkg"
+
+
+# This is the task that generates the +rdoc+ documentation from the
+# source files. Instantiating Rake::RDocTask automatically generates a
+# task called `rdoc`.
+
+Rake::RDocTask.new do |rd|
+	# Options for documenation generation are specified inside of
+	# this block. For example the following line specifies that the
+	# content of the README file should be the main page of the
+	# documenation.
+	rd.main = "README" 
+	
+	# The following line specifies all the files to extract
+	# documenation from.
+	rd.rdoc_files.include(	"README", "AUTHORS", "LICENSE", "TODO",
+				"CHANGELOG", "bin/**/*", "lib/**/*.rb", 
+				"examples/**/*rb", "doc/*.rdoc")
+	# This one specifies the output directory ...
+	rd.rdoc_dir 	= "doc/html"
+
+	# Or the HTML title of the generated documentation set.
+	rd.title 	= "#{SHORTNAME}: #{DESC}"
+
+	# These are options specifiying how source code inlined in the
+	# documentation should be formatted.
+	
+	rd.options 	= ["--line-numbers", "--inline-source"]
+
+	# Check:
+	# `rdoc --help` for more rdoc options
+	# the {rdoc documenation home}[http://www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/index.html]
+	# or the documentation for the +Rake::RDocTask+ task[http://rake.rubyforge.org/classes/Rake/RDocTask.html]
+end
+Rake::RDocTask.new(:rdoc_dev) do |rd|
+	# Options for documenation generation are specified inside of
+	# this block. For example the following line specifies that the
+	# content of the README file should be the main page of the
+	# documenation.
+	rd.main = "README" 
+	
+	# The following line specifies all the files to extract
+	# documenation from.
+	rd.rdoc_files.include(	"README", "AUTHORS", "LICENSE", "TODO",
+				"CHANGELOG", "bin/**/*", "lib/**/*.rb", 
+				"examples/**/*rb","test/**/*.rb", "doc/*.rdoc")
+	# This one specifies the output directory ...
+	rd.rdoc_dir 	= "doc/dev_html"
+
+	# Or the HTML title of the generated documentation set.
+	rd.title 	= "#{SHORTNAME}: #{DESC}"
+
+	# These are options specifiying how source code inlined in the
+	# documentation should be formatted.
+	
+	rd.options 	= ["--line-numbers", "--inline-source"]
+
+	# Check:
+	# `rdoc --help` for more rdoc options
+	# the {rdoc documenation home}[http://www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/index.html]
+	# or the documentation for the +Rake::RDocTask+ task[http://rake.rubyforge.org/classes/Rake/RDocTask.html]
+end
+
+# The GemPackageTask facilitates getting all your files collected
+# together into gem archives. You can also use it to generate tarball
+# and zip archives.
+
+# First you'll need to assemble a gemspec
+
+PKG_FILES 	= FileList['lib/**/*.rb', 'bin/**/*', 'examples/**/*', '[A-Z]*', 'test/**/*'].to_a
+
+spec = Gem::Specification.new do |s|
+	s.platform = Gem::Platform::RUBY
+	s.summary = "#{SHORTNAME}: #{DESC}"
+	s.add_dependency "hexy"
+	s.name = SHORTNAME
+	s.version = PKG_VERSION
+	s.files = PKG_FILES
+	s.requirements << "none"
+	s.require_path = 'lib'
+	s.description = LONG_DESC
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.has_rdoc = true
+	s.executables = ["parse_tlv", "parse_dgi"]
+end
+
+# Adding a new GemPackageTask adds a task named `package`, which generates
+# packages as gems, tarball and zip archives.
+Gem::PackageTask.new(spec) do |pkg|
+	pkg.need_zip = true
+	pkg.need_tar_gz = true
+end
+
+
+# This task is used to demonstrate how to upload files to Rubyforge.
+# Calling `upload_page` creates a current version of the +rdoc+
+# documentation and uploads it to the Rubyforge homepage of the project,
+# assuming it's hosted there and naming conventions haven't changed.
+#
+# This task uses `sh` to call the `scp` binary, which is plattform
+# dependant and may not be installed on your computer if you're using
+# Windows. I'm currently not aware of any pure ruby way to do scp
+# transfers.
+
+RubyForgeProject=SHORTNAME
+
+desc "Upload the web pages to the web."
+task :upload_pages => ["rdoc"] do
+  if RubyForgeProject then
+    path = "/var/www/gforge-projects/#{RubyForgeProject}"
+    sh "scp -r doc/html/* #{RUBYFORGE_USER}@rubyforge.org:#{path}"
+    sh "scp doc/images/*.png #{RUBYFORGE_USER}@rubyforge.org:#{path}/images"
+  end
+end
+
+# This task will run the unit tests provided in files called
+# `test/test*.rb`. The task itself can be run with a call to `rake test`
+
+Rake::TestTask.new do |t| 
+	t.libs << "test" 
+	t.libs << "lib" 
+	t.test_files = FileList['test/*.rb'] 
+	t.ruby_opts = ["-rubygems"]
+	t.verbose = true 
+end
+
+
+

data/TODO

@@ -0,0 +1,2 @@
+* Unit Tests
+testin for `payload_hook`

data/bin/parse_dgi

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+
+require 'tlv'
+require 'tlv/parser/dictionaries/dictionaries'
+
+USAGE =<<END
+usage: parse_dgi [-hex] [-dictionaries] [-d dictionary] (file_to_parse | < file_to_parse)
+  -hex          interpred input data as hex
+  -dictionaries list available dictionaries
+END
+
+hex               = ARGV.delete "-hex"
+list_dictionaries = ARGV.delete "-dictionaries"
+
+if (i = ARGV.index("-d"))
+  dict = TLV::DICTIONARIES[ARGV[i+1]]
+  ARGV.delete_at i
+  ARGV.delete_at i
+end
+file              = ARGV.last
+
+if file 
+  unless File.exists?(file) && File.readable?(file)
+    STDERR.puts USAGE
+    exit(1)
+  end
+end
+
+if list_dictionaries
+  TLV::DICTIONARIES.each_key{|key|
+    puts key
+  }
+  exit(0)
+end
+
+io = file ? File.open(file) : STDIN
+
+lines = io.readlines
+#lines.each {|line|
+#  puts TLV.s2b(line)+"<<<<<"
+#  puts line
+#}
+if hex
+  puts TLV.parse_dgi_hex(lines.join, dict || {})
+else
+  puts TLV.parse_dgi(lines.join, dict || {})
+end
+
+io.close

data/bin/parse_tlv

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+
+require 'tlv'
+require 'tlv/parser/dictionaries/dictionaries'
+
+
+USAGE =<<END
+usage: parse_tlv [-hex] [-dictionaries] [-d dictionary] (file_to_parse | < file_to_parse)
+  -hex          interpred input data as hex
+  -dictionaries list available dictionaries
+END
+
+hex               = ARGV.delete "-hex"
+list_dictionaries = ARGV.delete "-dictionaries"
+
+if (i = ARGV.index("-d"))
+  dict = TLV::DICTIONARIES[ARGV[i+1]]
+  ARGV.delete_at i
+  ARGV.delete_at i
+end
+file              = ARGV.last
+
+if file 
+  unless File.exists?(file) && File.readable?(file)
+    STDERR.puts USAGE
+    exit(1)
+  end
+end
+
+if list_dictionaries
+  TLV::DICTIONARIES.each_key{|key|
+    puts key
+  }
+  exit(0)
+end
+
+io = file ? File.open(file) : STDIN
+
+
+lines = io.readlines
+#lines.each {|line|
+#  puts TLV.s2b(line)
+#}
+if hex
+  puts TLV.parse_hex(lines.join, dict)
+else
+  puts TLV.parse(lines.join,dict)
+end
+
+io.close

data/lib/tlv.rb

@@ -0,0 +1,11 @@
+
+require 'tlv/field'
+require 'tlv/tlv'
+require 'tlv/b'
+require 'tlv/raw'
+require 'tlv/parse'
+require 'tlv/tag'
+require 'tlv/constructed'
+require 'tlv/to_bytes'
+require 'tlv/dgi'
+require 'tlv/parser/parser'

data/lib/tlv/b.rb

@@ -0,0 +1,32 @@
+module TLV
+
+class TLV
+ class B < Field
+    def define_accessor clazz
+      super
+      name = @name
+      len  = @length 
+      clazz.instance_eval{
+        define_method("#{name}="){|val|
+          raise("invalid value nil")        unless val
+          raise("must be a String #{val}")  unless val.is_a?(String)
+          raise("incorrect length: #{val}") unless (val.length*8) <= len
+          self.instance_variable_set("@#{name}", val)
+        }
+        
+        define_method("#{name}") {
+          self.instance_variable_get("@#{name}") || "\x00" * (len/8) 
+        }
+      }
+    end
+
+    def parse tlv, bytes, _len
+      val  = bytes[0, length/8]
+      rest = bytes[length/8, bytes.length]
+      # check val...
+      tlv.send("#{name}=", val)
+      rest 
+    end
+  end
+end
+end # module

data/lib/tlv/constructed.rb

@@ -0,0 +1,116 @@
+module TLV
+class TLV
+  class << self
+    
+    def mand_tags
+      @mand_tags ||= (self == TLV ? [] : superclass.mand_tags.dup)
+    end
+    def opt_tags
+      @opt_tags ||= (self == TLV ? [] : superclass.opt_tags.dup)
+    end
+
+    #    Takes either a subclass of TLV or the following options, which are used to
+    #    create an subclass.
+    #    Options:
+    #      :tag
+    #      :display_name
+    #
+    #      :classname (will be derived from display_name if not given)
+    #      :accessor_name (will be derived from display_name if not given)
+    def mandatory tlv, accessor_name=nil
+      handle_subtag mand_tags, tlv, accessor_name
+    end
+
+    # for constructed tlv's, add subtags that may be present
+    def optional tlv, accessor_name=nil
+      handle_subtag opt_tags, tlv, accessor_name
+    end
+    
+    def register tlv
+      @tlv_classes ||= {}
+      warn "tag #{TLV.b2s(tlv.tag)} already defined!" if @tlv_classes[tlv.tag]
+      @tlv_classes[tlv.tag] = tlv
+    end
+
+    def lookup tag
+      return self if tag == self.tag
+      @tlv_classes ||= {}
+      tlv = @tlv_classes[tag]
+      if !tlv && ! (self == TLV)
+        warn "looking up tag #{TLV.b2s(tag)} in super!"
+        raise "bla"
+        tlv ||= super
+      end
+      tlv
+    end
+
+    # internal, common functionality for mndatory and optional
+    def handle_subtag arr, tlv, accessor_name
+      tlv = handle_options(tlv) if tlv.is_a? Hash
+      raise "#{tlv} must be a subclass of TLV!" unless tlv.ancestors.include? TLV
+      if accessor_name
+        tlv= tlv.dup
+        tlv.accessor_name= accessor_name
+      end
+      define_accessor(tlv)
+      
+      register(tlv)
+      arr << tlv
+    end
+
+    def handle_options options
+      tag = options[:tag]
+      display_name = options[:display_name]
+      classname = options[:classname] || rubify_c(display_name)
+      new_class = self.const_set(classname, Class.new(TLV))
+      new_class.tlv(tag, display_name, options[:accessor_name])
+      new_class.raw
+      new_class
+    end
+
+    def rubify_a display
+      name = display.strip.gsub(/\s+/, "_")
+      name = name.downcase.to_sym
+    end
+
+    def rubify_c display
+      name = display.gsub(/\s+/, "")
+    end
+    
+    def define_accessor tlv_class
+      s = tlv_class
+      # check we are actually creating an accessor for an TLV
+      while s = s.superclass
+        break if s == TLV
+      end      
+      raise "not a TLV class!" unless s
+
+      # determine the accessor name
+      # currently the call graph of this method ensures the class 
+      # will have an accessor name.
+      name = tlv_class.accessor_name
+      
+      define_method("#{name}="){ |val|
+        # must either be an instance of tlv_val
+        # or a raw value.
+        if val.is_a? TLV
+          self.instance_variable_set("@#{name}", val)
+        else
+          v = tlv_class.new
+          # _should_ be a String, but we'll bang anything 
+          # into value for now...
+          v.value = val.to_s
+          self.instance_variable_set("@#{name}", v)
+        end 
+      }
+
+      define_method("#{name}") {
+        self.instance_variable_get("@#{name}") 
+      }
+
+    end
+
+  end
+
+end
+end #module