iso7816 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,9 @@
+
+= pcsc - ruby interface to pcsc smartcard libs 
+
+== Dependencies
+
+* smartcard : http://github.com/costan/smartcard
+* hexy      : http://github.com/a2800276/hexy
+* tlv       : http://github.com/a2800276/tlv
+	

data/Rakefile

@@ -0,0 +1,141 @@
+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     ='iso7816'  # this should be the rubyforge project name
+DESC          ='ruby smartcard access'
+PKG_VERSION   ='0.0.3'
+LONG_DESC  = <<END_DESC
+  Utilities to provided ISO 7816 smartcard functionality  
+END_DESC
+RUBYFORGE_USER  ='a2800276'
+
+# Specifies the default task to execute. 
+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","test/**/*.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"]
+
+  # 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.name      = SHORTNAME
+  s.version   = PKG_VERSION
+  s.files     = PKG_FILES
+  s.author    = "Tim Becker"
+  s.email     = "tim.becker@kuriositaet.de"
+  s.homepage  = "https://github.com/a2800276/7816"
+  s.requirements << "none"
+  s.require_path = 'lib'
+  s.add_dependency("hexy")
+  s.add_dependency("tlv")
+  s.add_dependency("smartcard")
+  #s.has_rdoc=true
+  s.description = LONG_DESC
+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.ruby_opts = ["-rubygems"]
+  t.test_files = FileList['test/*.rb'] 
+  t.verbose = true 
+end
+
+
+desc "generate iso apdu command classes"
+task :iso_apdu do
+  ruby "-rubygems build/create_apdu.rb -i lib/apdu.spec -o lib/apdu_generated.rb -s lib/apdu_generated_impl.rb"
+end
+
+desc "delete generated apdu classes"
+task :iso_apdu_clean do
+  File.delete "lib/apdu_generated.rb" if File.exist? "lib/apdu_generated.rb"
+end
+
+
+

data/TODO

@@ -0,0 +1,2 @@
+
+the atr list contains regular expression type wildcards, handle those for better recognition.

data/lib/7816.rb

@@ -0,0 +1,5 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'iso7816'
+

data/lib/7816/apdu.rb

@@ -0,0 +1,554 @@
+require 'hexy'
+module ISO7816
+        def ISO7816.b2s bytestr
+          r = bytestr.unpack("H*")[0]
+          r.length > 1 ? r : "  "
+        end
+        def ISO7816.make_binary value
+          value = [value].pack("C") if value.is_a? Numeric
+        end
+
+        def b2s bytestr
+          ISO7816.b2s bytestr
+        end
+
+        def s2b string
+          ISO7816.s2b string
+        end
+
+        def ISO7816.s2b string
+          string = string.gsub(/\s+/, "")
+          [string].pack("H*") 
+        end
+
+       
+module APDU
+
+#
+# Models an ISO 7816 APDU (Application Protocol Data Unit) the basic
+# "packet"/unit of communication sent from terminal/cardreader to the
+# card attributes are: CLASS (.cla) INS (.ins), PARAM1 (p1), PARAM2
+# (.p2) DATA (.data) and LE (.le), the length of the data expected in
+# the response from the card.  
+         
+class APDU
+  include ISO7816
+  # data is the transported data
+  attr_accessor :card, :name
+  attr_writer :data, :le
+  #attr_reader :cla, :ins, :p1, :p2
+
+  def initialize card=nil
+    @card=card
+  end
+
+  def cla
+    @cla || self.class._cla
+  end
+
+  def ins
+    @ins || self.class._ins
+  end
+
+  def p1
+    @p1 || self.class._p1
+  end
+
+  def p2
+    @p2 || self.class._p2 
+  end
+
+  def le
+    @le || self.class._le 
+  end
+
+  def data
+    @data || self.class._data 
+  end
+
+  def cla= cla
+    @cla = "" << cla
+  end
+  def ins= ins
+    @ins = "" << ins
+  end
+  def p1= p1
+    @p1 = "" << p1
+  end
+  def p2= p2
+    @p2 = "" << p2
+  end
+  def lc
+    unless @lc
+      return "" if @data == "" || @data==nil 
+      return [@data.length].pack("C")
+    end
+    @lc   
+  end 
+  
+
+  # normally don't need to set lc, because it's calculated from the
+  # data's length, but for testing it may be necessary to set an 
+  # correct value ...
+  def lc= val
+    if val.is_a? Numeric
+      @lc = [val].pack("C")
+    else
+      @lc=val
+    end
+  end
+
+  def le= val
+    if val.is_a? Numeric
+      @le = [val].pack("C")
+    else
+      @le=val
+    end
+  end
+  
+  # add data field to the apdu, contrary to
+  # the +data+ accessor, this method takes a hex string
+  # and not a binary string. The following are identical:
+  #
+  #   apdu.data = "\xaa\xaa\xaa"
+  #
+  # and
+  #    
+  #   apdu.hex_data = "aa aa aa" 
+  def hex_data= val
+    self.data = s2b(val)
+  end
+  
+  # Indicate whether this is a case_4 APDU.
+  # In case of T=0, le field is NOT sent along for case 4 APDUs
+  def case_4?
+    data!="" && le!=""
+  end
+
+  # INS may not have values of 0x60..0x6f and 0x90..0x9f
+  def ins_valid?
+    invalid = APDU.in_range(@ins, "\x60", "\x6f") || APDU.in_range(@ins, "\x90", "\x9f")
+    !invalid
+  end
+    
+  def self.in_range byte, from, to
+    byte >= from && byte <= to  
+  end
+
+  def to_b
+    bytes = "" 
+    bytes << cla 
+    bytes << ins
+    bytes << p1
+    bytes << p2
+
+    if data != "" || lc != nil
+      bytes << lc
+      bytes << data
+    end
+    if le != "" && le != nil
+      bytes << le
+    end
+    bytes
+  end
+
+  def send handle_more_data=true, card=nil
+    card = card || @card
+    raise "no card to send data to" unless card
+    
+    data_to_send = self.to_b
+    data_to_send = data_to_send.chop if card.t0? && self.case_4? 
+    
+    if card.t0? && data_to_send.length == 4
+      #7816-3: ... case1 apdu mapped onto TPDU with P3=00
+      data_to_send << "\x00"
+    end
+    if card.respond_to? :comment
+      card.comment "#{self.class.to_s}\n#{self.to_s.strip}" 
+    end
+
+    card.send data_to_send 
+    
+    to_receive = 2 
+    to_receive += le.unpack("C")[0] if le && le != ""
+    if card.t0? && self.case_4?
+      to_receive = 2
+    end
+
+    r = card.receive(to_receive)
+    resp = Response.new(r, self)
+    
+    if (handle_more_data && how_much_more = resp.more_data?)
+      gr = GET_RESPONSE.new
+      gr.le = how_much_more
+      resp = gr.send(false, card) # avoid infinite get_response loop... how to handle? 
+    end
+
+    resp
+  end
+
+  def to_s
+
+    line1 = "#{@name}\n|CLA|INS| P1| P2|"
+    line2 = [cla, ins, p1, p2].map { |b|
+      "| "+ ( b.unpack("H*")[0] )
+    }.join+"|"
+
+    data_ = data
+    if data_.length > 16
+      data_ = ""
+    end
+    if data_ != "" || le != ""
+      field_size = data_.length*2>"Data".length ? data_.length*2 : "Data".length 
+      if data_.length >=2
+        pad0 = " "*((data_.length*2 - 4)/2) 
+        pad1 = ""
+      else
+        pad0 = ""
+        pad1 = " "   
+      end
+      
+      #line1 += "| LC|#{pad0}Data#{pad0}| LE|"      
+      line1 += ("| LC|% #{field_size}s| LE|" % "Data")     
+      #line2 += "| #{b2s(self.lc)}|#{pad1}#{b2s(@data)}#{pad1}| #{@le?b2s(@le):"  "}|"
+      line2 += "| #{b2s(lc)}|%#{field_size}s| #{le ? b2s(le) : '  '}|" % b2s(data_)
+    end
+    txt = "#{line1}\n#{line2}"
+    if data.length > 16
+      h = Hexy.new @data
+      txt << "\n\n"
+      txt << h.to_s
+    end
+    txt
+  end
+  
+  # parses a string of bytes into an APDU object.
+  def self.to_apdu bytes, sanity=true
+    apdu = APDU.new 
+    apdu.cla = bytes[0,1]
+    apdu.ins = bytes[1,1]
+    apdu.p1  = bytes[2,1]
+    apdu.p2  = bytes[3,1]
+    if bytes.size > 4 # at least le
+      if bytes.size > 5 # weird, 0 size lc and no data
+        apdu.lc = bytes[4,1]
+        len = apdu.lc.unpack("C")[0]
+        apdu.data = bytes[5,len]
+        if bytes.size > 5+len
+          raise "Too many bytes!" if bytes.size > 6+len
+          apdu.le = bytes[5+len,1]
+        end
+      else # only le
+        apdu.le = bytes[4,1]
+      end #le
+    end # lc, data, le
+    apdu 
+  end #to_apdu
+
+  class << self
+
+    def cla cla
+      @cla=""<<cla
+    end
+    def ins ins
+      @ins=""<<ins
+    end
+    def p1 p1
+      @p1=""<<p1
+    end
+    def p2 p2
+      @p2=""<<p2
+    end
+    def data data
+      @data=""<<data
+    end
+    def le le
+      @le=""<<le
+    end
+
+    def _cla
+      @cla ||= self == APDU ? "\x00" : superclass._cla
+    end
+ 
+    def _ins
+      @ins ||= self == APDU ? "\x00" : superclass._ins
+    end
+    
+    def _p1
+      @p1 ||= self == APDU ? "\x00" : superclass._p1
+    end
+
+    def _p2
+      @p2 ||= self == APDU ? "\x00" : superclass._p2
+    end
+
+    def _data
+      @data ||= self == APDU ? "" : superclass._data
+    end
+    def _le
+      @le ||= self == APDU ? "" : superclass._le
+    end
+  end
+end # class APDU 
+
+
+# Each new APDU generated provides a random CLA, INS
+class RandomAPDU < APDU
+  def initialize card=nil, rand_p1p2 = true, rand_le = true, rand_data=0
+    super card
+    @cla = [rand(256)].pack("C")
+    @ins = [rand(256)].pack("C")
+    until ins_valid?
+      @ins = [rand(256)].pack("C")
+    end
+    if (rand_p1p2)
+      @p1 = [rand(256)].pack("C") 
+      @p2 = [rand(256)].pack("C") 
+    end
+
+    if (rand_le)
+      if rand() > 0.5
+        @le = [rand(256)].pack("C") 
+      end
+    end
+    
+    if (rand_data && rand_data>0)
+      data=[]
+      1.upto(rand_data) {
+        data <<  [rand(256)].pack("C") 
+      }
+      @data = data.join
+    end
+    
+  end
+
+  def self.get_random card, num, seed=0, allow_invalid_ins = false
+    srand(seed)
+    arr = []
+    1.upto(num) { 
+      apdu = RandomAPDU.new card
+      while allow_invalid_ins || !apdu.ins_valid?
+        apdu = RandomAPDU.new card
+      end
+      arr << apdu
+    }
+    arr
+  end
+
+end
+
+class Response
+  include ISO7816
+  attr_accessor :data, :sw1, :sw2
+
+  def initialize data, le=0
+    if le.is_a? ISO7816::APDU::APDU
+      le = le.le.unpack("C")[0]
+      le = le ? le : 0
+    end
+    @data = data[0,le]
+    @sw1 = data[-2,1]
+    @sw2 = data[-1,1]
+
+  end
+  
+  def status
+    if @sw1 && @sw2
+      status = @sw1.dup
+      return b2s(status<<@sw2)
+    end
+    "????"
+  end
+
+  def normal?
+    (@sw1 == "\x90" && @sw2 == "\x00") || @sw1 == "\x61"
+  end
+
+  def warning?
+    ["\x62","\x63"].include? @sw1
+  end
+
+  def execution_err?
+    ["\x64", "\x65", "\x66"].include? @sw1
+  end
+
+  def checking_err?
+    ["\x67", "\x68", "\x69", "\x6a", "\x6b", "\x6c", "\x6d", "\x6e", "\x6f"].include? @sw1
+  end
+
+  def more_data?
+    return @sw1 == "\x61" ? @sw2 : false 
+  end
+
+  def to_s
+    str = ""      
+    str << "APDU Response\n"
+    str << "  Data(#{@data.length}): #{b2s(@data)}\n" unless @data == ""
+    str << "  SW1: #{b2s(@sw1)} (#{sw1_explanation})\n" 
+    str << "  SW2: #{b2s(@sw2)} (#{sw2_explanation})\n" 
+    str
+  end
+
+  def sw1_explanation
+    case @sw1
+      when "\x90" 
+        return "OK: No further qualification"
+      when "\x61" 
+        return "OK: SW2 indicates the number of response bytes still available"
+	# Warning processings
+      when "\x62"
+        return "WARN: State of non-volatile memory unchanged"
+      when "\x63" : return "WARN: State of non-volatile memory changed"
+	# Execution errors
+      when "\x64"
+        return "EXE ERR: State of non-volatile memory unchanged" 
+      when "\x65"
+        return "EXE ERR: State of non-volatile memory changed"
+      when "\x66"
+        return "EXE ERR: Reserved for security-related issues"
+	# Checking errors
+      when "\x67"
+        return "CHK ERR: Wrong length"
+      when "\x68"
+        return "CHK ERR: Functions in CLA not supported"
+      when "\x69"
+        return "CHK ERR: Command not allowed"
+      when "\x6A"
+        return "CHK ERR: Wrong parameter(s) P1-P2"
+      when "\x6B"
+        return "CHK ERR: Wrong parameter(s) P1-P2"
+      when "\x6C"
+        return "CHK ERR: Wrong length Le: SW2 indicates the exact length"
+      when "\x6D"
+        return "CHK ERR: Instruction code not supported or invalid"
+      when "\x6E"
+        return "CHK ERR: Class not supported"
+      when "\x6F"
+        return "CHK ERR: No precise diagnosis"
+      else 
+        return "UNKNOWN : #{b2s(@sw1)}"
+    end
+  end
+
+  def sw2_explanation
+    case @sw1
+      when "\x90", "\x64", "\x67", "\x6b", "\x6d", "\x6e", "\x6f"
+        sw2_check00
+      when "\x61"
+        "#{b2s(@sw2)} bytes remaining."
+      when "\x62"
+        sw2_62
+      when "\x63"
+        sw2_63
+      when "\x65"
+        sw2_65
+      when "\x66"
+        "security (undefined)"
+      when "\x68"
+        sw2_68
+      when "\x69"
+        sw2_69
+      when "\x6a"
+        sw2_6a
+      when "\x6c"
+        "wrong lenght. Exact len: #{b2s(@sw2)}"
+      else
+        "UNKNOWN : #{b2s(@sw2)}"
+    end
+  end
+
+  private
+
+  def sw2_check00
+    @sw2 == "\x00" ? "" : "sw2 should be 0x00, is #{b2s(@sw2)}"
+  end
+  def sw2_62
+    case @sw2
+      when "\x00": "No information given"
+      when "\x81": "Part of returned data may be corrupted"
+      when "\x82": "End of file/record reached before reading Le bytes"
+      when "\x83": "Selected file invalidated"
+      when "\x84": "FCI not formatted according to spec"
+      else "unknown sw2 for sw1=#{b2s(@sw1)}: #{b2s(@sw2)}"
+    end
+  end
+
+  def sw2_63
+    case @sw2
+      when "\x00": "No information given"
+      when "\x81": "File filled up by the last write"
+      when "\xC0","\xC1","\xC2","\xC3","\xC4","\xC5","\xC6","\xC7","\xC8","\xC9","\xCA","\xCB","\xCC","\xCD","\xCE","\xCF"
+        "Counter provided by '#{@sw2[0] & 0x0f}'"
+      else "unknown sw2 for sw1=#{b2s(@sw1)}: #{b2s(@sw2)}"
+    end
+  end
+
+  def sw2_65
+    case @sw2
+      when "\x00": "No information given"
+      when "\x81": "Memory failure"
+      else "unknown sw2 for sw1=#{b2s(@sw1)}: #{b2s(@sw2)}"
+    end
+  end
+
+  def sw2_68
+    case @sw2
+      when "\x00": "No information given"
+      when "\x81": "Logical channel not supported"
+      when "\x82": "Secure messaging not supported"
+      else "unknown sw2 for sw1=#{b2s(@sw1)}: #{b2s(@sw2)}"
+    end
+  end
+
+  def sw2_69
+    case @sw2
+      when "\x00": "No information given"
+      when "\x81": "Command incompatible with file structure"
+      when "\x82": "Security status not satisfied"
+      when "\x83": "Authentication method blocked"
+      when "\x84": "Referenced data invalidated"
+      when "\x85": "Conditions of use not satisfied"
+      when "\x86": "Command not allowed (no current EF)"
+      when "\x87": "Expected SM data objects missing"
+      when "\x88": "SM data objects incorrect"
+      else "unknown sw2 for sw1=#{b2s(@sw1)}: #{b2s(@sw2)}"
+    end
+  end
+
+  def sw2_6a
+    case @sw2
+      when "\x00": "No information given"
+      when "\x80": "Incorrect parameters in the data field"
+      when "\x81": "Function not supported"
+      when "\x82": "File not found"
+      when "\x83": "Record not found"
+      when "\x84": "Not enough memory space in the file"
+      when "\x85": "Lc inconsistent with TLV structure"
+      when "\x86": "Incorrect parameters P1-P2"
+      when "\x87": "Lc inconsistent with P1-P2"
+      when "\x88": "Referenced data not found"
+      else "unknown sw2 for sw1=#{b2s(@sw1)}: #{b2s(@sw2)}"
+    end
+  end
+
+end
+
+
+end # module APDU
+
+end # ISO7816
+
+if __FILE__ == $0
+        puts 0x04.class
+  puts "here"
+  a = ISO7816::APDU::APDU.new
+  puts a
+  a.data = "\xde\xad\xbe\xef"
+  puts a
+  a = ISO7816::APDU::APDU.new
+  a.data = "\xde"
+  a.le = "\x01"
+  puts a
+  a = ISO7816::APDU::SELECT.new
+  puts a
+end