smartcard 0.2.0 → 0.2.1

data/BUILD

@@ -0,0 +1,65 @@
+= Builds are hard
++smartcard+ needs to talk to hardware (card readers), so it's bound to use a Ruby extension.
+This means C, and platform-specific building nightmares. Read below for details.
+
+= The build system
++smartcard+ uses {echoe}[http://blog.evanweaver.com/files/doc/fauna/echoe/] for builds. This
+automates most of the building and packaging work, and can even push the gem to rubyforge,
+with a bit of luck. Most used commands:
+	rake manifest # builds the manifest (do this after checking out)
+	rake package # builds the gem for your platform
+	rake mswin package # cross-builds the gem for Windows
+	rake test # builds the gem and runs the tests
+	rake docs # runs Rdoc to produce the docs
+
+On the other hand, you have to <tt>gem install echoe</tt> to be able to build anything.
+
+= Platform-specific information
+
+== OSX
+
+You need to install the Developer Tools to get gcc.
+
+Leopard includes a working PC/SC provider, as well as a good driver for CCID readers.
+Tiger's 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 <tt>RB_SMARTCARD_OSX_TIGER_HACK</tt> define.
+The following commands are broken / don't work:
+* Smartcard::PCSC::Context#is_valid (always returs +true+)
+* Smartcard::PCSC::Card#get_attribute (throws exception because it's not implemented)
+* Smartcard::PCSC::Card#set_attribute (throws exception because it's not implemented)
+* Smartcard::PCSC::Card#control (Tiger's API is broken, so the call will probably not work)
+
+The developer team doesn't support or test against ports of +gcc+ or +pcsclite+,
+but we success notifications are welcome.
+
+== 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
+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). Visual Studio 2008
+might work, but it hasn't been tested yet.
+
+A summary of the hacks that have been done to get Windows builds working:
+* removing the extension files from the gemspec at the "right time" so that +echoe+ compiles the extension, and the gem doesn't require re-compilation (see the +Rakefile+)
+* adding the compiled extension to the file list in the gemspec
+* adding code to <tt>extconf.rb</tt> to patch the +Makefile+ so a manifest is embedded in the extension dll (and ruby doesn't crash if it uses a different version of the C runtime)
+
+== Linux
+
++smartcard+ is developed (and tested) against the
+{MUSCLE project}[http://www.linuxnet.com/software.html]. If you go this route, you need to
+get at least the {pcsclite library}[http://pcsclite.alioth.debian.org/] and a driver.
++smartcard+ developers use the {CCID driver}[http://pcsclite.alioth.debian.org/], which
+works on most (new) readers.
+
+=== Ubuntu
+
+Installing the following packages (and their dependencies) gets you going on Ubuntu (tested on 7.10):
+* buildessentials
+* libccid
+* libpcsclite
+* libpcsclite-dev
+* pcscd
+* pcsc-tools

data/CHANGELOG

@@ -1,3 +1,7 @@
+v0.2.1 Added OSX Tiger support
+	Many workarounds for Tiger's buggy/incomplete PC/SC.
+	Small bugfixes for PC/SC status constants.
+
 v0.2.0 Added automatic builds
 	Rakefile for auto builds using echoe
 	extconf.rb: hack to fix Windows makefiles 

data/Manifest

@@ -1,3 +1,4 @@
+BUILD
 CHANGELOG
 ext/smartcard_pcsc/extconf.rb
 ext/smartcard_pcsc/pcsc.h
@@ -13,7 +14,7 @@ ext/smartcard_pcsc/pcsc_surrogate_reader.h
 ext/smartcard_pcsc/pcsc_surrogate_wintypes.h
 lib/smartcard.rb
 LICENSE
+Manifest
 README
 test/test_all.rb
 tests/ts_pcsc_ext.rb
-Manifest

data/README

@@ -1,22 +1,29 @@
-SUMMARY
++smartcard+ aims to become the standard support library for smart-card development on ruby.
+Right now, the project offers a PC/SC binding that is working on ruby 1.8, under
+Linux, OSX, and Windows. Future plans include a high level abstraction for the PC/SC binding 
+(plus any other bindings people need), and an interface for Java cards.
 
-'smartcard' aims to become the de-facto support library for smart-card development on ruby.
-At the moment, 'smartcard' offers a PC/SC binding that is working on ruby 1.8, under
-linux, osx, and windows. Future plans include a high level abstraction for the PC/SC binding 
-(and any other bindings people need), and an interface for Java cards.
+= Installation
 
-LICENSE
+	gem install smartcard
+Windows:: Select the <tt>win32</tt> gem.
+OSX:: Install the Developer Tools to get +gcc+. Requires Tiger or Leopard.
+UNIX:: You need a PC/SC provider. See the {BUILD file}[link://files/BUILD.html] for details. The file also contains package lists for popular distributions.
 
-'smartcard' is released under the MIT license. This means you're free to do whatever you want
-with it. For the legalese version, please see the 'LICENSE' file.
+= Documentation
 
-DOCUMENTATION
+The documentation you see was generated with RDoc. If you install the +smartcard+ gem, you should be
+able to use ri to see the documentation. If you're using the SVN version, you can <tt>rake doc</tt> to build
+the HTML documentation yourself.
 
-The API is fully documented with RDoc. If you installed the 'smartcard' gem, you should be
-able to use ri to see the documentation. If you're using the SVN version, you can use rdoc to
-build the HTML and RI documentation yourself.
+= License
 
-ACKNOWLEDGEMENTS
++smartcard+ is released under the MIT license. This means you're free to do whatever you want
+with it. However, it'd be nice to let the developers know if you plan to include this in a
+distribution (bragging rights are always good). The {LICENSE file}[link://files/LICENSE.html]
+has the license in legalese.
 
-'smartcard' was developed for Victor Costan while working as a Research Assistant for MIT.
-The work was sponsored by a grant from Quanta Computer Inc (www.quanta.com.tw)
+= Acknowledgements
+
++smartcard+ is developed by Victor Costan while working as a Research Assistant for MIT.
+The work is sponsored by a grant from Quanta Computer Inc (www.quanta.com.tw)

data/ext/smartcard_pcsc/extconf.rb

@@ -3,8 +3,14 @@ require 'mkmf'
 $CFLAGS ||= ''
 $LDFLAGS ||= ''
 
+pcsc_defines = []
+
 if RUBY_PLATFORM =~ /darwin/
   $LDFLAGS += ' -framework PCSC'
+  darwin_version = `uname -r`
+  if darwin_version =~ /^8./
+    pcsc_defines.push 'RB_SMARTCARD_OSX_TIGER_HACK'
+  end
 elsif RUBY_PLATFORM =~ /win/
   have_library('winscard')
 else
@@ -23,8 +29,6 @@ pcsc_headers = []
   end
 end
 
-pcsc_defines = []
-
 File.open('pcsc_autogen.h', 'w') do |f|
   pcsc_defines.each { |d| f.write "\#define #{d}\n" }
   pcsc_headers.each { |h| f.write "\#include #{h}\n" }

data/ext/smartcard_pcsc/pcsc_card.c

@@ -192,6 +192,10 @@ static VALUE PCSC_Card_get_attribute(VALUE self, VALUE rbAttributeId) {
 	
 	attribute_id = NUM2UINT(rbAttributeId);
 	attribute_length;
+#if defined(RB_SMARTCARD_OSX_TIGER_HACK)
+	card->pcsc_error = SCARD_F_INTERNAL_ERROR;
+	rb_raise(rb_eRuntimeError, "SCardSetAttrib: not implemented in OSX Tiger");
+#else
 	card->pcsc_error = SCardGetAttrib(card->card_handle, attribute_id, NULL, &attribute_length);
 	if(card->pcsc_error == SCARD_S_SUCCESS) {
 		attribute_buffer = ALLOC_N(char, attribute_length);
@@ -206,6 +210,7 @@ static VALUE PCSC_Card_get_attribute(VALUE self, VALUE rbAttributeId) {
 	}
 	if(card->pcsc_error != SCARD_S_SUCCESS)
 		rb_raise(rb_eRuntimeError, "SCardGetAttrib: %s", pcsc_stringify_error(card->pcsc_error));	
+#endif
 	return Qnil;
 }
 
@@ -236,10 +241,15 @@ static VALUE PCSC_Card_set_attribute(VALUE self, VALUE rbAttributeId, VALUE rbAt
 		rb_raise(rb_eArgError, "second argument (attribute buffer) does not convert to a String");
 		return self;
 	}
-	
-	card->pcsc_error = SCardSetAttrib(card->card_handle, attribute_id, (LPSTR)RSTRING(rbFinalAttributeValue)->ptr, RSTRING(rbFinalAttributeValue)->len);	
+
+#if defined(RB_SMARTCARD_OSX_TIGER_HACK)
+	card->pcsc_error = SCARD_F_INTERNAL_ERROR;
+	rb_raise(rb_eRuntimeError, "SCardSetAttrib: not implemented in OSX Tiger");
+#else
+	card->pcsc_error = SCardSetAttrib(card->card_handle, attribute_id, (LPSTR)RSTRING(rbFinalAttributeValue)->ptr, RSTRING(rbFinalAttributeValue)->len);
 	if(card->pcsc_error != SCARD_S_SUCCESS)
 		rb_raise(rb_eRuntimeError, "SCardSetAttrib: %s", pcsc_stringify_error(card->pcsc_error));	
+#endif
 	return self;
 }
 
@@ -343,10 +353,17 @@ static VALUE PCSC_Card_control(VALUE self, VALUE rbControlCode, VALUE rbSendData
 	recv_length = NUM2UINT(rbMaxRecvBytes);
 	recv_buffer = ALLOC_N(char, recv_length);
 	if(recv_buffer == NULL) return Qnil;
-	
+		
+#if defined(RB_SMARTCARD_OSX_TIGER_HACK)
+	/* TODO: this will compile and run, but it won't do anything useful */
+	card->pcsc_error = SCardControl(card->card_handle,
+			(LPSTR)RSTRING(rbFinalSendData)->ptr, RSTRING(rbFinalSendData)->len,
+			recv_buffer, &recv_length);
+#else
 	card->pcsc_error = SCardControl(card->card_handle, control_code,
 			(LPSTR)RSTRING(rbFinalSendData)->ptr, RSTRING(rbFinalSendData)->len,
 			recv_buffer, recv_length, &recv_length);
+#endif
 	if(card->pcsc_error != SCARD_S_SUCCESS) {
 		xfree(recv_buffer);
 		rb_raise(rb_eRuntimeError, "SCardControl: %s", pcsc_stringify_error(card->pcsc_error));

data/ext/smartcard_pcsc/pcsc_constants.c

@@ -50,21 +50,21 @@ void Init_PCSC_Consts() {
 	/* SCARD_F_COMM_ERROR : An internal communications error has been detected. */
 	rb_define_const(mPcsc, "SCARD_F_COMM_ERROR", INT2NUM(SCARD_F_COMM_ERROR));
 	/* SCARD_F_UNKNOWN_ERROR : An internal error has been detected, but the source is unknown. */
-	rb_define_const(mPcsc, "SCARD_F_UNKNOWN_ERROR", INT2NUM(SCARD_E_TIMEOUT));
+	rb_define_const(mPcsc, "SCARD_F_UNKNOWN_ERROR", INT2NUM(SCARD_F_UNKNOWN_ERROR));
 	/* SCARD_E_INVALID_ATR : An ATR obtained from the registry is not a valid ATR string. */
-	rb_define_const(mPcsc, "SCARD_E_INVALID_ATR", INT2NUM(SCARD_E_TIMEOUT));
+	rb_define_const(mPcsc, "SCARD_E_INVALID_ATR", INT2NUM(SCARD_E_INVALID_ATR));
 	/* SCARD_E_NOT_TRANSACTED : An attempt was made to end a non-existent transaction. */
-	rb_define_const(mPcsc, "SCARD_E_NOT_TRANSACTED", INT2NUM(SCARD_E_TIMEOUT));
+	rb_define_const(mPcsc, "SCARD_E_NOT_TRANSACTED", INT2NUM(SCARD_E_NOT_TRANSACTED));
 	/* SCARD_E_READER_UNAVAILABLE : The specified reader is not currently available for use. */
-	rb_define_const(mPcsc, "SCARD_E_READER_UNAVAILABLE", INT2NUM(SCARD_E_TIMEOUT));
+	rb_define_const(mPcsc, "SCARD_E_READER_UNAVAILABLE", INT2NUM(SCARD_E_READER_UNAVAILABLE));
 	/* SCARD_W_UNSUPPORTED_CARD : The reader cannot communicate with the card, due to ATR string configuration conflicts. */
-	rb_define_const(mPcsc, "SCARD_W_UNSUPPORTED_CARD", INT2NUM(SCARD_E_TIMEOUT));
+	rb_define_const(mPcsc, "SCARD_W_UNSUPPORTED_CARD", INT2NUM(SCARD_W_UNSUPPORTED_CARD));
 	/* SCARD_W_UNRESPONSIVE_CARD : The smart card is not responding to a reset. */
-	rb_define_const(mPcsc, "SCARD_W_UNRESPONSIVE_CARD", INT2NUM(SCARD_E_TIMEOUT));
+	rb_define_const(mPcsc, "SCARD_W_UNRESPONSIVE_CARD", INT2NUM(SCARD_W_UNRESPONSIVE_CARD));
 	/* SCARD_W_UNPOWERED_CARD : Power has been removed from the smart card, so that further communication is not possible. */
-	rb_define_const(mPcsc, "SCARD_W_UNPOWERED_CARD", INT2NUM(SCARD_E_TIMEOUT));
+	rb_define_const(mPcsc, "SCARD_W_UNPOWERED_CARD", INT2NUM(SCARD_W_UNPOWERED_CARD));
 	/* SCARD_W_RESET_CARD : The smart card has been reset, so any shared state information is invalid. */
-	rb_define_const(mPcsc, "SCARD_W_RESET_CARD", INT2NUM(SCARD_E_TIMEOUT));
+	rb_define_const(mPcsc, "SCARD_W_RESET_CARD", INT2NUM(SCARD_W_RESET_CARD));
 	/* SCARD_W_REMOVED_CARD : The smart card has been removed, so further communication is not possible. */
 	rb_define_const(mPcsc, "SCARD_W_REMOVED_CARD", INT2NUM(SCARD_W_REMOVED_CARD));
 	/* SCARD_E_PCI_TOO_SMALL : The PCI Receive buffer was too small. */
@@ -113,8 +113,10 @@ void Init_PCSC_Consts() {
 	rb_define_const(mPcsc, "STATE_INUSE", INT2NUM(SCARD_STATE_INUSE));
 	/* SCARD_STATE_MUTE : Unresponsive card. */
 	rb_define_const(mPcsc, "STATE_MUTE", INT2NUM(SCARD_STATE_MUTE));
+#if defined(SCARD_STATE_UNPOWERED)
 	/* SCARD_STATE_UNPOWERED : Unpowered card. */
 	rb_define_const(mPcsc, "STATE_UNPOWERED", INT2NUM(SCARD_STATE_UNPOWERED));
+#endif /* SCARD_STATE_UNPOWERED */
 	
 	/* INFINITE : Infinite timeout. */
 	rb_define_const(mPcsc, "INFINITE_TIMEOUT", INT2NUM(INFINITE));

data/ext/smartcard_pcsc/pcsc_context.c

@@ -89,8 +89,12 @@ static VALUE PCSC_Context_is_valid(VALUE self) {
 	Data_Get_Struct(self, struct SCardContextEx, context);
 	if(context == NULL) return self;
 
-	context->pcsc_error = SCardIsValidContext(context->pcsc_context);		
+#if defined(RB_SMARTCARD_OSX_TIGER_HACK)	
+	return Qtrue;
+#else
+	context->pcsc_error = SCardIsValidContext(context->pcsc_context);
 	return (context->pcsc_error == SCARD_S_SUCCESS) ? Qtrue : Qfalse;
+#endif
 }
 
 /* :Document-method: list_reader_groups

data/smartcard.gemspec

@@ -1,11 +1,11 @@
 
-# Gem::Specification for Smartcard-0.2.0
+# Gem::Specification for Smartcard-0.2.1
 # Originally generated by Echoe
 
 Gem::Specification.new do |s|
   s.name = %q{smartcard}
-  s.version = "0.2.0"
-  s.date = %q{2007-11-18}
+  s.version = "0.2.1"
+  s.date = %q{2007-11-19}
   s.summary = %q{Interface with ISO 7816 smart cards.}
   s.require_paths = ["lib", "ext"]
   s.email = %q{victor@costan.us}
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.description = %q{Interface with ISO 7816 smart cards.}
   s.has_rdoc = true
   s.authors = ["Victor Costan"]
-  s.files = ["CHANGELOG", "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_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", "LICENSE", "README", "test/test_all.rb", "tests/ts_pcsc_ext.rb", "Manifest", "smartcard.gemspec"]
+  s.files = ["BUILD", "CHANGELOG", "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_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", "LICENSE", "Manifest", "README", "test/test_all.rb", "tests/ts_pcsc_ext.rb", "smartcard.gemspec"]
   s.test_files = ["test/test_all.rb"]
   s.extensions = ["ext/smartcard_pcsc/extconf.rb"]
 end
@@ -24,6 +24,7 @@ end
 # 
 # # Needs the 'echoe' gem
 # require 'echoe'
+# require 'pp'
 # 
 # Echoe.new('smartcard') do |p|
 #   p.project = 'smartcard' # rubyforge project
@@ -35,6 +36,7 @@ end
 #   
 #   p.need_tar_gz = false
 #   p.clean_pattern += ['ext/**/*.manifest', 'ext/**/*_autogen.h']
+#   p.rdoc_pattern = /^(lib|bin|tasks|ext)|^BUILD|^README|^CHANGELOG|^TODO|^LICENSE|^COPYING$/
 #   
 #   p.eval = proc do |p|
 #     case RUBY_PLATFORM

data/tests/ts_pcsc_ext.rb

@@ -99,7 +99,11 @@ card0 = Smartcard::PCSC::Card.new(context, reader0, Smartcard::PCSC::SHARE_SHARE
 card0.begin_transaction
 card0.end_transaction Smartcard::PCSC::DISPOSITION_LEAVE
 
+begin
 card0.reconnect Smartcard::PCSC::SHARE_EXCLUSIVE, Smartcard::PCSC::PROTOCOL_ANY, Smartcard::PCSC::INITIALIZATION_RESET
+rescue RuntimeException => e
+puts "Card.reconnect threw exception #{e}\n" 
+end
 
 card_status = card0.status
 pp card_status
@@ -132,4 +136,4 @@ end
 
 puts "Disconnecting and cleaning up\n"
 card0.disconnect Smartcard::PCSC::DISPOSITION_LEAVE
-context.release
+context.release

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: smartcard
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2007-11-18 00:00:00 -05:00
+  version: 0.2.1
+date: 2007-11-19 00:00:00 -05:00
 summary: Interface with ISO 7816 smart cards.
 require_paths: 
 - lib
@@ -30,6 +30,7 @@ post_install_message:
 authors: 
 - Victor Costan
 files: 
+- BUILD
 - CHANGELOG
 - ext/smartcard_pcsc/extconf.rb
 - ext/smartcard_pcsc/pcsc.h
@@ -45,10 +46,10 @@ files:
 - ext/smartcard_pcsc/pcsc_surrogate_wintypes.h
 - lib/smartcard.rb
 - LICENSE
+- Manifest
 - README
 - test/test_all.rb
 - tests/ts_pcsc_ext.rb
-- Manifest
 - smartcard.gemspec
 test_files: 
 - test/test_all.rb