smartcard 0.4.6 → 0.4.7

data/BUILD

@@ -22,8 +22,8 @@ anything.
 
 You need to install the Developer Tools to get gcc.
 
-Leopard (OSX 10.5) includes a working PC/SC provider, as well as a good driver
-for CCID readers.
+Leopard and Snow Leopard (OSX 10.5 / 10.6) include a working PC/SC provider, as
+well as a good driver for CCID readers.
 
 Tiger's (OSX 10.4) PC/SC implementation is broken and incomplete, so the Ruby
 extension code in +smartcard+ has a few hacks to work around that (look for the
@@ -35,13 +35,13 @@ don't work:
 * Smartcard::PCSC::Card#control (Tiger's API is broken, the call may not work)
 
 The developer team doesn't support or test against ports of +gcc+ or +pcsclite+,
-but we success notifications are welcome.
+but we welcome patches or success stories.
 
 == Windows
 
 A lot of effort has been spent to make Windows builds as easy as possible.
 +smartcard+ is currently built using a full edition of
-{Visual Studio 2005}[http://msdn.microsoft.com/vstudio/], but all sources
+{Visual Studio 6.0}[http://msdn.microsoft.com/vstudio/], but all sources
 indicate that
 {Visual C++ Express 2005}[http://www.microsoft.com/express/download/]
 works, as long as you also install a Windows SDK (you're on your own for that).
@@ -69,7 +69,7 @@ readers.
 === Ubuntu
 
 Installing the following packages (and their dependencies) gets you going on
-Ubuntu (tested on 7.10, 8.04, and 8.10):
+Ubuntu (tested on 8.04, 8.10, 9.04 and 9.10):
 * build-essential
 * libccid
 * libpcsclite-dev (depends on libpcsclite or libpcsclite1)

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.4.7. Custom exception class for APDU responses with error codes.
+
 v0.4.6. Automatic detection of package AID from CAP in install_applet.
 
 v0.4.5. More bugfixes in JcopRemoteTransport's ATR forwarding logic.

data/Manifest

@@ -22,6 +22,7 @@ lib/smartcard/gp/asn1_ber.rb
 lib/smartcard/gp/cap_loader.rb
 lib/smartcard/gp/des.rb
 lib/smartcard/gp/gp_card_mixin.rb
+lib/smartcard/iso/apdu_error.rb
 lib/smartcard/iso/auto_configurator.rb
 lib/smartcard/iso/iso_card_mixin.rb
 lib/smartcard/iso/jcop_remote_protocol.rb
@@ -30,6 +31,7 @@ lib/smartcard/iso/jcop_remote_transport.rb
 lib/smartcard/iso/pcsc_transport.rb
 lib/smartcard/iso/transport.rb
 lib/smartcard/pcsc/pcsc_exception.rb
+smartcard.gemspec
 test/gp/asn1_ber_test.rb
 test/gp/cap_loader_test.rb
 test/gp/des_test.rb
@@ -38,6 +40,7 @@ test/gp/hello.apdu
 test/gp/hello.cap
 test/iso/auto_configurator_test.rb
 test/iso/iso_card_mixin_test.rb
+test/iso/iso_exception_test.rb
 test/iso/jcop_remote_test.rb
 test/pcsc/containers_test.rb
 test/pcsc/smoke_test.rb

data/lib/smartcard.rb

@@ -2,6 +2,7 @@ require 'smartcard/pcsc'
 require 'smartcard/pcsc/pcsc_exception.rb'
 
 
+require 'smartcard/iso/apdu_error.rb'
 require 'smartcard/iso/iso_card_mixin.rb'
 require 'smartcard/iso/jcop_remote_protocol.rb'
 require 'smartcard/iso/jcop_remote_transport.rb'

data/lib/smartcard/gp/gp_card_mixin.rb

@@ -179,7 +179,7 @@ module GpCardMixin
       raw = iso_apdu :cla => 0x80, :ins => 0xF2, :p1 => scope_byte,
                      :p2 => (first ? 0 : 1), :data => [0x4F, 0x00]
       if raw[:status] != 0x9000 && raw[:status] != 0x6310 
-        Smartcard::Iso::IsoCardMixin.raise_response_exception raw
+        raise Smartcard::Iso::ApduException, raw
       end
       
       offset = 0

data/lib/smartcard/iso/apdu_error.rb

@@ -0,0 +1,43 @@
+# Exception indicating an error code in an ISO-7618 response APDU.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Massachusetts Institute of Technology
+# License:: MIT
+
+# :nodoc: namespace
+module Smartcard::Iso
+  
+
+# Indicates an error code in an ISO-7618 response APDU.
+#
+# This exception should be raised if the response obtained from iso_apdu has an
+# error status. When raising the exception, supply the entire response as the
+# only argument to raise.
+#
+# Usage example:
+#   response = transport.iso_apdu :ins => 0x12
+#   raise Smartcard::Iso::ApduError, response unless response[:status] == 0x9000
+class ApduError < RuntimeError
+  # The data in the error APDU. 
+  attr_accessor :data
+  # The error status.
+  attr_accessor :status
+  
+  # Creates a new exception (for raising).
+  #
+  # Args:
+  #   response:: the APDU response (hash with +:data+ and +:status+ keys)
+  def initialize(response)
+    @data = response[:data]
+    @status = response[:status]
+    super ApduError.message_for_apdu_response response
+  end
+  
+  # Computes the exception message for an APDU response.
+  def self.message_for_apdu_response(response)
+    "ISO-7816 response APDU has error status 0x#{'%04x' % response[:status]}" +
+        " - #{response[:data].map { |ch| '%02x' % ch }.join(' ')}"
+  end
+end  # class Smartcard::Iso::ApduError
+
+end  # namespace Smartcard::Iso

data/lib/smartcard/iso/iso_card_mixin.rb

@@ -16,7 +16,7 @@ module Smartcard::Iso
 # the APDU data as an array of integers between 0 and 255, and expects a
 # response in the same format.
 module IsoCardMixin  
-  # APDU exchange with the ISO7816 card, raising an exception if the return
+  # APDU exchange with the ISO7816 card, raising an ApduError if the return
   # code is not success (0x9000).
   #
   # :call_seq:
@@ -24,22 +24,13 @@ module IsoCardMixin
   #
   # The apdu_data should be in the format expected by
   # IsoCardMixin#serialize_apdu. Returns the response data, if the response
-  # status indicates success (0x9000). Otherwise, raises an exeception.
+  # status indicates success (0x9000). Otherwise, raises an ApduError.
   def iso_apdu!(apdu_data)
     response = self.iso_apdu apdu_data
     return response[:data] if response[:status] == 0x9000
-    IsoCardMixin.raise_response_exception response
+    raise ApduError, response
   end
   
-  # Raises an exception in response to an error status in an APDU.
-  #
-  # :call_seq:
-  #   IsoCardMixin.raise_response_exception(response)
-  def self.raise_response_exception(response)
-    raise "JavaCard response has error status 0x#{'%04x' % response[:status]}" +
-          " - #{response[:data].map { |ch| '%02x' % ch }.join(' ')}"    
-  end
-
   # Performs an APDU exchange with the ISO7816 card.
   #
   # :call-seq:

data/smartcard.gemspec

@@ -2,23 +2,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{smartcard}
-  s.version = "0.4.6"
+  s.version = "0.4.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Victor Costan"]
-  s.date = %q{2009-11-01}
+  s.date = %q{2009-11-10}
   s.description = %q{Interface with ISO 7816 smart cards.}
   s.email = %q{victor@costan.us}
   s.extensions = ["ext/smartcard_pcsc/extconf.rb"]
-  s.extra_rdoc_files = ["BUILD", "CHANGELOG", "LICENSE", "README", "ext/smartcard_pcsc/extconf.rb", "ext/smartcard_pcsc/pcsc.h", "ext/smartcard_pcsc/pcsc_card.c", "ext/smartcard_pcsc/pcsc_constants.c", "ext/smartcard_pcsc/pcsc_context.c", "ext/smartcard_pcsc/pcsc_exception.c", "ext/smartcard_pcsc/pcsc_io_request.c", "ext/smartcard_pcsc/pcsc_main.c", "ext/smartcard_pcsc/pcsc_multi_strings.c", "ext/smartcard_pcsc/pcsc_namespace.c", "ext/smartcard_pcsc/pcsc_reader_states.c", "ext/smartcard_pcsc/pcsc_surrogate_reader.h", "ext/smartcard_pcsc/pcsc_surrogate_wintypes.h", "lib/smartcard.rb", "lib/smartcard/gp/asn1_ber.rb", "lib/smartcard/gp/cap_loader.rb", "lib/smartcard/gp/des.rb", "lib/smartcard/gp/gp_card_mixin.rb", "lib/smartcard/iso/auto_configurator.rb", "lib/smartcard/iso/iso_card_mixin.rb", "lib/smartcard/iso/jcop_remote_protocol.rb", "lib/smartcard/iso/jcop_remote_server.rb", "lib/smartcard/iso/jcop_remote_transport.rb", "lib/smartcard/iso/pcsc_transport.rb", "lib/smartcard/iso/transport.rb", "lib/smartcard/pcsc/pcsc_exception.rb"]
-  s.files = ["BUILD", "CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "ext/smartcard_pcsc/extconf.rb", "ext/smartcard_pcsc/pcsc.h", "ext/smartcard_pcsc/pcsc_card.c", "ext/smartcard_pcsc/pcsc_constants.c", "ext/smartcard_pcsc/pcsc_context.c", "ext/smartcard_pcsc/pcsc_exception.c", "ext/smartcard_pcsc/pcsc_io_request.c", "ext/smartcard_pcsc/pcsc_main.c", "ext/smartcard_pcsc/pcsc_multi_strings.c", "ext/smartcard_pcsc/pcsc_namespace.c", "ext/smartcard_pcsc/pcsc_reader_states.c", "ext/smartcard_pcsc/pcsc_surrogate_reader.h", "ext/smartcard_pcsc/pcsc_surrogate_wintypes.h", "lib/smartcard.rb", "lib/smartcard/gp/asn1_ber.rb", "lib/smartcard/gp/cap_loader.rb", "lib/smartcard/gp/des.rb", "lib/smartcard/gp/gp_card_mixin.rb", "lib/smartcard/iso/auto_configurator.rb", "lib/smartcard/iso/iso_card_mixin.rb", "lib/smartcard/iso/jcop_remote_protocol.rb", "lib/smartcard/iso/jcop_remote_server.rb", "lib/smartcard/iso/jcop_remote_transport.rb", "lib/smartcard/iso/pcsc_transport.rb", "lib/smartcard/iso/transport.rb", "lib/smartcard/pcsc/pcsc_exception.rb", "test/gp/asn1_ber_test.rb", "test/gp/cap_loader_test.rb", "test/gp/des_test.rb", "test/gp/gp_card_mixin_test.rb", "test/gp/hello.apdu", "test/gp/hello.cap", "test/iso/auto_configurator_test.rb", "test/iso/iso_card_mixin_test.rb", "test/iso/jcop_remote_test.rb", "test/pcsc/containers_test.rb", "test/pcsc/smoke_test.rb", "tests/ts_pcsc_ext.rb", "smartcard.gemspec"]
+  s.extra_rdoc_files = ["BUILD", "CHANGELOG", "LICENSE", "README", "ext/smartcard_pcsc/extconf.rb", "ext/smartcard_pcsc/pcsc.h", "ext/smartcard_pcsc/pcsc_card.c", "ext/smartcard_pcsc/pcsc_constants.c", "ext/smartcard_pcsc/pcsc_context.c", "ext/smartcard_pcsc/pcsc_exception.c", "ext/smartcard_pcsc/pcsc_io_request.c", "ext/smartcard_pcsc/pcsc_main.c", "ext/smartcard_pcsc/pcsc_multi_strings.c", "ext/smartcard_pcsc/pcsc_namespace.c", "ext/smartcard_pcsc/pcsc_reader_states.c", "ext/smartcard_pcsc/pcsc_surrogate_reader.h", "ext/smartcard_pcsc/pcsc_surrogate_wintypes.h", "lib/smartcard.rb", "lib/smartcard/gp/asn1_ber.rb", "lib/smartcard/gp/cap_loader.rb", "lib/smartcard/gp/des.rb", "lib/smartcard/gp/gp_card_mixin.rb", "lib/smartcard/iso/apdu_error.rb", "lib/smartcard/iso/auto_configurator.rb", "lib/smartcard/iso/iso_card_mixin.rb", "lib/smartcard/iso/jcop_remote_protocol.rb", "lib/smartcard/iso/jcop_remote_server.rb", "lib/smartcard/iso/jcop_remote_transport.rb", "lib/smartcard/iso/pcsc_transport.rb", "lib/smartcard/iso/transport.rb", "lib/smartcard/pcsc/pcsc_exception.rb"]
+  s.files = ["BUILD", "CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "ext/smartcard_pcsc/extconf.rb", "ext/smartcard_pcsc/pcsc.h", "ext/smartcard_pcsc/pcsc_card.c", "ext/smartcard_pcsc/pcsc_constants.c", "ext/smartcard_pcsc/pcsc_context.c", "ext/smartcard_pcsc/pcsc_exception.c", "ext/smartcard_pcsc/pcsc_io_request.c", "ext/smartcard_pcsc/pcsc_main.c", "ext/smartcard_pcsc/pcsc_multi_strings.c", "ext/smartcard_pcsc/pcsc_namespace.c", "ext/smartcard_pcsc/pcsc_reader_states.c", "ext/smartcard_pcsc/pcsc_surrogate_reader.h", "ext/smartcard_pcsc/pcsc_surrogate_wintypes.h", "lib/smartcard.rb", "lib/smartcard/gp/asn1_ber.rb", "lib/smartcard/gp/cap_loader.rb", "lib/smartcard/gp/des.rb", "lib/smartcard/gp/gp_card_mixin.rb", "lib/smartcard/iso/apdu_error.rb", "lib/smartcard/iso/auto_configurator.rb", "lib/smartcard/iso/iso_card_mixin.rb", "lib/smartcard/iso/jcop_remote_protocol.rb", "lib/smartcard/iso/jcop_remote_server.rb", "lib/smartcard/iso/jcop_remote_transport.rb", "lib/smartcard/iso/pcsc_transport.rb", "lib/smartcard/iso/transport.rb", "lib/smartcard/pcsc/pcsc_exception.rb", "smartcard.gemspec", "test/gp/asn1_ber_test.rb", "test/gp/cap_loader_test.rb", "test/gp/des_test.rb", "test/gp/gp_card_mixin_test.rb", "test/gp/hello.apdu", "test/gp/hello.cap", "test/iso/auto_configurator_test.rb", "test/iso/iso_card_mixin_test.rb", "test/iso/iso_exception_test.rb", "test/iso/jcop_remote_test.rb", "test/pcsc/containers_test.rb", "test/pcsc/smoke_test.rb", "tests/ts_pcsc_ext.rb"]
   s.homepage = %q{http://www.costan.us/smartcard}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Smartcard", "--main", "README"]
   s.require_paths = ["lib", "ext"]
   s.rubyforge_project = %q{smartcard}
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Interface with ISO 7816 smart cards.}
-  s.test_files = ["test/gp/asn1_ber_test.rb", "test/gp/cap_loader_test.rb", "test/gp/des_test.rb", "test/gp/gp_card_mixin_test.rb", "test/iso/auto_configurator_test.rb", "test/iso/iso_card_mixin_test.rb", "test/iso/jcop_remote_test.rb", "test/pcsc/containers_test.rb", "test/pcsc/smoke_test.rb"]
+  s.test_files = ["test/iso/iso_card_mixin_test.rb", "test/iso/auto_configurator_test.rb", "test/iso/iso_exception_test.rb", "test/iso/jcop_remote_test.rb", "test/pcsc/smoke_test.rb", "test/pcsc/containers_test.rb", "test/gp/gp_card_mixin_test.rb", "test/gp/cap_loader_test.rb", "test/gp/asn1_ber_test.rb", "test/gp/des_test.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/test/iso/iso_card_mixin_test.rb

@@ -89,8 +89,15 @@ class IsoCardMixinTest < Test::Unit::TestCase
   
   def test_iso_apdu_bang
     assert_equal [0x67, 0x31], win_mock.iso_apdu!(win_apdu)
-    assert_raise(RuntimeError) do
+    assert_raise(Smartcard::Iso::ApduError) do
       lose_mock.iso_apdu!(lose_apdu)
     end
+    
+    begin
+      lose_mock.iso_apdu! lose_apdu
+    rescue Smartcard::Iso::ApduError => e
+      assert_equal [], e.data, 'APDU data in raised error'
+      assert_equal 0x8631, e.status, 'APDU error status in raised error'
+    end
   end
 end

data/test/iso/iso_exception_test.rb

@@ -0,0 +1,36 @@
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2008 Massachusetts Institute of Technology
+# License:: MIT
+
+require 'smartcard'
+
+require 'test/unit'
+
+require 'rubygems'
+require 'flexmock/test_unit'
+
+
+class ApduErrorTest < Test::Unit::TestCase
+  def setup
+    @response = { :data => [0x31, 0x41, 0x59], :status => 0x6A88 }
+  end
+  
+  def test_raise
+    assert_raise Smartcard::Iso::ApduError do
+      raise Smartcard::Iso::ApduError, @response
+    end
+  end
+  
+  def test_contents
+    begin
+      raise Smartcard::Iso::ApduError, @response
+    rescue Smartcard::Iso::ApduError => e
+      assert_equal @response[:status], e.status, 'Error status attribute'
+      assert_equal @response[:data], e.data, 'APDU data attribute'
+      golden_message =
+          'ISO-7816 response APDU has error status 0x6a88 - 31 41 59'
+      assert_equal golden_message, e.message, 'Exception message'
+    end
+  end
+  IsoCardMixin = Smartcard::Iso::IsoCardMixin
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smartcard
 version: !ruby/object:Gem::Version 
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors: 
 - Victor Costan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-01 01:00:00 -04:00
+date: 2009-11-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,6 +51,7 @@ extra_rdoc_files:
 - lib/smartcard/gp/cap_loader.rb
 - lib/smartcard/gp/des.rb
 - lib/smartcard/gp/gp_card_mixin.rb
+- lib/smartcard/iso/apdu_error.rb
 - lib/smartcard/iso/auto_configurator.rb
 - lib/smartcard/iso/iso_card_mixin.rb
 - lib/smartcard/iso/jcop_remote_protocol.rb
@@ -84,6 +85,7 @@ files:
 - lib/smartcard/gp/cap_loader.rb
 - lib/smartcard/gp/des.rb
 - lib/smartcard/gp/gp_card_mixin.rb
+- lib/smartcard/iso/apdu_error.rb
 - lib/smartcard/iso/auto_configurator.rb
 - lib/smartcard/iso/iso_card_mixin.rb
 - lib/smartcard/iso/jcop_remote_protocol.rb
@@ -92,6 +94,7 @@ files:
 - lib/smartcard/iso/pcsc_transport.rb
 - lib/smartcard/iso/transport.rb
 - lib/smartcard/pcsc/pcsc_exception.rb
+- smartcard.gemspec
 - test/gp/asn1_ber_test.rb
 - test/gp/cap_loader_test.rb
 - test/gp/des_test.rb
@@ -100,11 +103,11 @@ files:
 - test/gp/hello.cap
 - test/iso/auto_configurator_test.rb
 - test/iso/iso_card_mixin_test.rb
+- test/iso/iso_exception_test.rb
 - test/iso/jcop_remote_test.rb
 - test/pcsc/containers_test.rb
 - test/pcsc/smoke_test.rb
 - tests/ts_pcsc_ext.rb
-- smartcard.gemspec
 has_rdoc: true
 homepage: http://www.costan.us/smartcard
 licenses: []
@@ -140,12 +143,13 @@ signing_key:
 specification_version: 3
 summary: Interface with ISO 7816 smart cards.
 test_files: 
-- test/gp/asn1_ber_test.rb
-- test/gp/cap_loader_test.rb
-- test/gp/des_test.rb
-- test/gp/gp_card_mixin_test.rb
-- test/iso/auto_configurator_test.rb
 - test/iso/iso_card_mixin_test.rb
+- test/iso/auto_configurator_test.rb
+- test/iso/iso_exception_test.rb
 - test/iso/jcop_remote_test.rb
-- test/pcsc/containers_test.rb
 - test/pcsc/smoke_test.rb
+- test/pcsc/containers_test.rb
+- test/gp/gp_card_mixin_test.rb
+- test/gp/cap_loader_test.rb
+- test/gp/asn1_ber_test.rb
+- test/gp/des_test.rb