| 1 |
rousseau |
269 |
USB CCID IFD Handler |
| 2 |
|
|
==================== |
| 3 |
|
|
|
| 4 |
|
|
This package provides the source code for a generic USB CCID |
| 5 |
|
|
(Chip/Smart Card Interface Devices) driver. See [1] for the USB CCID |
| 6 |
rousseau |
273 |
specifications from the USB working group. |
| 7 |
rousseau |
269 |
|
| 8 |
|
|
|
| 9 |
rousseau |
697 |
Authors: |
| 10 |
|
|
======== |
| 11 |
rousseau |
269 |
|
| 12 |
|
|
- Ludovic Rousseau <ludovic.rousseau@free.fr> |
| 13 |
rousseau |
1015 |
- Carlos Prados for the PPS and ATR parsing code (taken from his |
| 14 |
|
|
towitoto driver) in towitoko/ directory. |
| 15 |
|
|
- Olaf Kirch for the T=1 TPDU code (from the OpenCT package) in openct/ |
| 16 |
|
|
directory. I (Ludovic Rousseau) greatly improved this code. |
| 17 |
rousseau |
269 |
|
| 18 |
|
|
|
| 19 |
|
|
Supported CCID readers: |
| 20 |
|
|
======================= |
| 21 |
|
|
|
| 22 |
rousseau |
273 |
(in alphabetical order) |
| 23 |
rousseau |
1321 |
- Advanced Card Systems ACR 38 [16] |
| 24 |
|
|
old versions of this reader have a bug: the reader do timeout when a |
| 25 |
|
|
special USB frame is sent from the reader. If the frame size if a |
| 26 |
|
|
multiple of wMaxPacketSize the communication is stopped. |
| 27 |
rousseau |
969 |
- Cherry XX33 keyboard [?] |
| 28 |
|
|
- Dell keyboard SK-3106 [?] |
| 29 |
|
|
- Dell smart card reader keyboard [?] |
| 30 |
rousseau |
273 |
- Gemplus GemPC 433 SL [2] |
| 31 |
|
|
- Gemplus GemPC Key [3] |
| 32 |
|
|
- Gemplus GemPC Twin [4] |
| 33 |
rousseau |
1326 |
- Kobil KAAN Base [19] |
| 34 |
|
|
- Kobil KAAN Advanced [20] |
| 35 |
rousseau |
1393 |
- Kobil KAAN SIM III [21] |
| 36 |
rousseau |
273 |
- OmniKey CardMan 3121 [5] |
| 37 |
rousseau |
1314 |
- SCM Micro SCR 331 [6] |
| 38 |
|
|
You shall upgrade the firmware [17] using version 5.18 or later. |
| 39 |
|
|
- SCM Micro SCR 331-DI [11] |
| 40 |
|
|
You shall upgrade the firmware [17] using version 6.22 or later. |
| 41 |
|
|
- SCM Micro SCR 335 [7] |
| 42 |
|
|
The firmware of this reader can't be upgraded so be sure to buy a |
| 43 |
|
|
recent model with firmware 5.14 or later |
| 44 |
rousseau |
1392 |
- SCM Micro SCR 3310 |
| 45 |
rousseau |
1314 |
- SCM Micro SPR 532 [9] |
| 46 |
|
|
You shall contact Torsten Maykranz <tmaykranz@scmmicro.de> to get a |
| 47 |
|
|
firmware upgrade. |
| 48 |
rousseau |
606 |
|
| 49 |
|
|
|
| 50 |
|
|
Should work but untested by me: |
| 51 |
|
|
=============================== |
| 52 |
|
|
|
| 53 |
|
|
I would like to get these readers to perform test and validation and |
| 54 |
|
|
move them in the supported list above. If you are one of the |
| 55 |
|
|
manufacturers, please, contact me. |
| 56 |
|
|
|
| 57 |
rousseau |
1317 |
- Cherry XX44 keyboard (SmartBoard G83-6744) [18] |
| 58 |
rousseau |
708 |
- ActivCard USB reader 2.0 [10] |
| 59 |
rousseau |
709 |
- C3PO LTC32 [13] |
| 60 |
|
|
- SCM Micro SCR 333 [15] |
| 61 |
|
|
- Silitek SK-3105 keyboard [12] or C3PO TLTC2USB [14] |
| 62 |
rousseau |
269 |
|
| 63 |
|
|
|
| 64 |
rousseau |
969 |
Unsupported or partly supported CCID readers: |
| 65 |
|
|
============================================= |
| 66 |
rousseau |
269 |
|
| 67 |
rousseau |
1165 |
- C3PO LTC31 [8] |
| 68 |
|
|
The reader works fine with Linux kernel 2.4 but does not with Linux |
| 69 |
|
|
kernel 2.6. The ioctl() syscall returns EINVAL (Invalid argument) |
| 70 |
rousseau |
269 |
|
| 71 |
rousseau |
1165 |
|
| 72 |
rousseau |
321 |
Supported operating systems: |
| 73 |
|
|
============================ |
| 74 |
|
|
|
| 75 |
|
|
- GNU/Linux (libusb 0.1.7) |
| 76 |
|
|
- MacOS X/Darwin (libusb 0.1.8beta, CVS snapshot. See "Known problems") |
| 77 |
|
|
to libusb) |
| 78 |
|
|
|
| 79 |
|
|
|
| 80 |
rousseau |
862 |
Debug informations: |
| 81 |
|
|
=================== |
| 82 |
|
|
|
| 83 |
|
|
The driver uses the debug function provided by pcscd. So if pcscd sends |
| 84 |
|
|
its debug to stdout (pcscd --foreground) then the CCID will also send |
| 85 |
|
|
its debug to stdout. If pcscd sends its debug to syslog (by default) |
| 86 |
|
|
then the CCID will also send its debug to syslog. |
| 87 |
|
|
|
| 88 |
|
|
You can change the debug level using the Info.plist configuraion file. |
| 89 |
|
|
The Info.plist is installed, by default, in |
| 90 |
|
|
/usr/local/pcsc/drivers/ifd-ccid.bundle/Contents/Info.plist |
| 91 |
|
|
|
| 92 |
|
|
The debug level is set in the ifdLogLevel field. It is a binary OR |
| 93 |
|
|
combinaison of 4 different levels. |
| 94 |
|
|
- 1: critical: important error messages |
| 95 |
|
|
- 2: info: informative messages like what reader was detected |
| 96 |
|
|
- 4: periodic: periodic info when pcscd test if a card is present (every |
| 97 |
|
|
1/10 of a second) |
| 98 |
|
|
- 8: comm: a dump of all the bytes exchanged between the host and the |
| 99 |
|
|
reader |
| 100 |
|
|
|
| 101 |
|
|
By default the debug level is set to 3 (1 + 2) and correspond to the |
| 102 |
|
|
critical and info levels. |
| 103 |
|
|
|
| 104 |
|
|
You have to restart the driver so it read the configuration file again |
| 105 |
|
|
and use the new debug level value. To restart the driver you just need |
| 106 |
|
|
to unplug all your CCID readers so the the driver is unloaded and then |
| 107 |
|
|
replug your readers. You can also restart pcscd. |
| 108 |
|
|
|
| 109 |
|
|
|
| 110 |
rousseau |
321 |
Known problems: |
| 111 |
|
|
=============== |
| 112 |
|
|
|
| 113 |
rousseau |
1165 |
MacOSX libusb |
| 114 |
rousseau |
969 |
""""""""""""" |
| 115 |
|
|
There is a bug in libusb that crash the libusb library when you |
| 116 |
|
|
unplug a reader and replug it in another USB socket. So if you |
| 117 |
|
|
unplug a reader replug it in the same USB socket. |
| 118 |
|
|
|
| 119 |
|
|
see http://sourceforge.net/tracker/index.php?func=detail&aid=886778&group_id=1674&atid=101674 |
| 120 |
|
|
|
| 121 |
|
|
|
| 122 |
rousseau |
273 |
Licence: |
| 123 |
|
|
======== |
| 124 |
|
|
|
| 125 |
rousseau |
269 |
This program is free software; you can redistribute it and/or modify |
| 126 |
|
|
it under the terms of the GNU General Public License as published by the |
| 127 |
|
|
Free Software Foundation; either version 2 of the License, or (at your |
| 128 |
|
|
option) any later version. |
| 129 |
|
|
|
| 130 |
|
|
This program is distributed in the hope that it will be useful, but |
| 131 |
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of |
| 132 |
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 133 |
|
|
General Public License for more details. |
| 134 |
|
|
|
| 135 |
|
|
You should have received a copy of the GNU General Public License |
| 136 |
|
|
along with this program; if not, write to the Free Software Foundation, |
| 137 |
|
|
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 138 |
|
|
|
| 139 |
|
|
|
| 140 |
|
|
History: |
| 141 |
|
|
======== |
| 142 |
|
|
|
| 143 |
rousseau |
1186 |
0.9.2 - 15 August 2004, Ludovic Rousseau |
| 144 |
|
|
- T=1 TPDU code: |
| 145 |
|
|
. the work on T=1 TPDU code was possible thanks to Gemplus |
| 146 |
|
|
validation team who helped me test, debug and bring the code to |
| 147 |
|
|
an EMV validation level. Thanks to Jérôme, Jean-Yves, Xavier and |
| 148 |
|
|
the Gemplus readers department |
| 149 |
|
|
. error code was not checked correctly |
| 150 |
|
|
. avoid a (nearly) infinite loop when resynch are needed. |
| 151 |
|
|
. correctly initialise an internal value to allow more than one |
| 152 |
|
|
reader to work |
| 153 |
|
|
- multi-slots readers |
| 154 |
|
|
. add support for multi-slots readers. The only one I have is a |
| 155 |
|
|
SCM Micro SCR 331-DI with a contact and a contactless interface. |
| 156 |
|
|
The contactless interface may or may not work for you since the |
| 157 |
|
|
reader uses proprietary (undocumented) commands. |
| 158 |
|
|
- GemPC Twin serial reader |
| 159 |
|
|
. perform a command (get the reader firmware) to be sure a GemPC |
| 160 |
|
|
Twin (serial or pcmcia) reader is connected |
| 161 |
|
|
. use a dynamic timeout when reading the serial port. |
| 162 |
|
|
The first timeout used when detecting the reader is 2 seconds to |
| 163 |
|
|
not wait too long if no reader is connected. Later timeouts are |
| 164 |
|
|
set to 1 minute to allow long time APDU. |
| 165 |
|
|
- use `pkg-config libpcsclite --cflags` to locate the pcsc-lite |
| 166 |
|
|
header files |
| 167 |
|
|
- use `pkg-config --print-errors --atleast-version=1.2.9-beta5 libpcsclite` |
| 168 |
|
|
to test the pcsc-lite version |
| 169 |
|
|
- code improvements thanks to the splint tool (http://www.splint.org/) |
| 170 |
|
|
|
| 171 |
rousseau |
1018 |
0.9.1 - 1 July 2004, Ludovic Rousseau |
| 172 |
|
|
- I forgot to define IFD_PARITY_ERROR in a .h file |
| 173 |
|
|
|
| 174 |
rousseau |
1015 |
0.9.0 - 1 July 2004, Ludovic Rousseau |
| 175 |
|
|
- The T=1 TPDU automata from Carlos Prados' Towitoko driver is very |
| 176 |
|
|
limited and do not support error management mechanisms. |
| 177 |
|
|
I then used the T=1 TPDU automata from OpenCT (OpenSC project). |
| 178 |
|
|
This automata is much more powerful but still lacks a lot of error |
| 179 |
|
|
management code. |
| 180 |
|
|
I then added all the needed code to reach the quality level |
| 181 |
|
|
requested by the EMV standard. |
| 182 |
|
|
- add support for new readers: |
| 183 |
|
|
. Advanced Card Systems ACR 38 |
| 184 |
|
|
. Cherry XX33 |
| 185 |
|
|
. Dell keyboard SK-3106 |
| 186 |
|
|
. Dell smart card reader keyboard |
| 187 |
|
|
. SCR 333 |
| 188 |
|
|
- add support of multi procotol cards (T=0 and T=1) |
| 189 |
|
|
- the debug level is now dynamic and set in the Info.plist file (no |
| 190 |
|
|
need to recompile the driver any more) |
| 191 |
|
|
- add support for the libusb naming scheme: usb:%04x/%04x:libusb:%s |
| 192 |
|
|
- INSTALL: add a "configuring the driver for the serial reader |
| 193 |
|
|
(GemPC Twin)" part |
| 194 |
|
|
- use `pkg-config libpcsclite --variable=usbdropdir` so you do not |
| 195 |
|
|
have to use --enable-usbdropdir=DIR or --enable-ccidtwindir=DIR |
| 196 |
|
|
even if pcscd does not use the default /usr/local/pcsc/drivers |
| 197 |
|
|
- add support of IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE and |
| 198 |
|
|
IOCTL_SMARTCARD_VENDOR_VERIFY_PIN in IFDHControl() |
| 199 |
|
|
- read ifdDriverOptions from Info.plist to limit the use of |
| 200 |
|
|
IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE (idea from Peter Williams) |
| 201 |
|
|
- provide an example of use of SCardControl() |
| 202 |
|
|
IOCTL_SMARTCARD_VENDOR_IFD_EXCHANGE and |
| 203 |
|
|
IOCTL_SMARTCARD_VENDOR_VERIFY_PIN in example/ |
| 204 |
|
|
- add a --enable-pcsclite option (default to yes) so that the driver |
| 205 |
|
|
can be compiled for a different framework (one needing |
| 206 |
|
|
tokenparser.l like Solaris) |
| 207 |
|
|
- Reset action is power off and power on, not just power on |
| 208 |
|
|
- use the include files from pcsc-lite |
| 209 |
|
|
- add a mechanism to allow power on at 1.8V, 3V and then 5V as |
| 210 |
|
|
specified by ISO 7816. We still use 5V for now to avoid problems |
| 211 |
|
|
with non ISO compliant cards |
| 212 |
|
|
|
| 213 |
rousseau |
703 |
0.4.1 - 14 February 2004, Ludovic Rousseau |
| 214 |
|
|
- distribute missing files readers/supported_readers.txt and |
| 215 |
|
|
src/create_Info_plist.pl |
| 216 |
|
|
'make install' failed because of this. |
| 217 |
|
|
|
| 218 |
rousseau |
697 |
0.4.0 - 13 February 2004, Ludovic Rousseau |
| 219 |
|
|
- support of T=1 with TPDU readers. A lot of the T=1 code comes from |
| 220 |
|
|
Carlos Prados towitoko driver. |
| 221 |
|
|
My code is GNU GPL, his code is GNU LGPL so the global driver is |
| 222 |
|
|
GNU GPL |
| 223 |
|
|
- PPS negotiation if the reader does not do it automatically |
| 224 |
|
|
- add support for the Silitek SK-3105 keyboard. It's a USB device |
| 225 |
|
|
with multiple interfaces |
| 226 |
|
|
- use the create_Info_plist.pl script to generate the installed |
| 227 |
|
|
Info.plist from an Info.plist template and a list of supported |
| 228 |
|
|
readers. The Info.plist was too "complex" to maintain by hand |
| 229 |
|
|
since it now contains 11 entries |
| 230 |
|
|
- add support of IFDHCreateChannelByName to avoid wrong reader |
| 231 |
|
|
enumeration. This is not complete if you have multiple _identical_ |
| 232 |
|
|
readers. You need to use a > 1.2.0 pcsc-lite version (not yet |
| 233 |
|
|
released at that time) |
| 234 |
|
|
- build but do not install the serial ccidtwin driver by default |
| 235 |
|
|
since it is useless on computers without a serial port or without |
| 236 |
|
|
this reader for example. |
| 237 |
|
|
- read and write timeouts are not symmetric. write timout can be |
| 238 |
|
|
shorter since the reader and card is not supposed to do anything |
| 239 |
|
|
before receiving (write) a command |
| 240 |
|
|
- do not try to find usb.h and other libusb files if |
| 241 |
|
|
--disable-libusb is used. Needed if you only want to build the |
| 242 |
|
|
serial driver. Thanks to Niki Waibel for the patch |
| 243 |
|
|
- add a --enable-ccidtwindir argument to ./configure to specify the |
| 244 |
|
|
serial GemPC Twin installation directory |
| 245 |
|
|
- debug and code improvements and simplifications |
| 246 |
|
|
|
| 247 |
rousseau |
552 |
0.3.2 - 4 November 2003, Ludovic Rousseau |
| 248 |
|
|
- src/commands.c: correct a stupid bug that occurs with an APDU with |
| 249 |
|
|
2 bytes response. |
| 250 |
|
|
- Info.plist: add SPR 532 in list of supported readers |
| 251 |
|
|
- parse.c: do not exit if the InterfaceClass is 0xFF (proprietary). |
| 252 |
|
|
It is the case with old readers manufactured before the final |
| 253 |
|
|
release of the CCID specs. |
| 254 |
|
|
- move LTC31 reader from unsupported to supported reader list. It |
| 255 |
|
|
was my f ault since in used odd INS byte in my test applet and odd |
| 256 |
|
|
INS bytes are forbidden by ISO 7816-4 ch. 5.4.2 Instruction byte. |
| 257 |
|
|
Thanks to Josep Moné s Teixidor for pointing the problem. |
| 258 |
|
|
- src/commands.c: comment out the automatic GET RESPONSE part. I |
| 259 |
|
|
don't think it should be in the driver. Maybe in pcscd instead? |
| 260 |
|
|
|
| 261 |
rousseau |
467 |
0.3.1 - 23 September 2003, Ludovic Rouseau |
| 262 |
|
|
- add --enable-multi-thread (enabled by default) for thread safe |
| 263 |
|
|
support an APDU multiplexing. You will need pcsc-lite-1.2.0-rc3 or |
| 264 |
|
|
above to use this feature. |
| 265 |
|
|
- add --enable-libusb=PATH option is your libusb is not installed in |
| 266 |
|
|
/usr or /usr/local |
| 267 |
|
|
- honor DESTDIR in install rules (closes [ #300110 ]). Thanks to |
| 268 |
|
|
Ville Skyttä for the patch. |
| 269 |
|
|
- src/ccid.c: do not switch the GemPC Key and GemPC Twin in APDU |
| 270 |
|
|
mode since it also swicth in EMV mode and may not work with non |
| 271 |
|
|
EMV cards |
| 272 |
|
|
- src/ccid_serial.c: complete reimplementation of the Twin serial |
| 273 |
|
|
protocol using a finite state automata (code much simpler) |
| 274 |
|
|
|
| 275 |
rousseau |
423 |
0.3.0 - 10 September 2003, Ludovic Rousseau |
| 276 |
|
|
- support of GemPC Twin connected to a serial port. Thanks to Niki |
| 277 |
|
|
W. Waibel for a working prototype. |
| 278 |
|
|
- support of auto voltage at power up if the reader support it |
| 279 |
|
|
instead of forcing a 5V in all cases. |
| 280 |
|
|
- support of APDU mode instead of just TPDU if the reader support |
| 281 |
|
|
it. Thanks to Jean-Luc Giraud for the idea and inspiration I got |
| 282 |
|
|
from his "concurrent" driver. |
| 283 |
rousseau |
425 |
- support of "time request" from the card. |
| 284 |
rousseau |
423 |
- parse: new indentation for more readability of supported features. |
| 285 |
|
|
- switch the GemPC Key and GemPC Twin in APDU mode since they |
| 286 |
|
|
support it but do not announce it in the dwFeatures. |
| 287 |
|
|
- new build process using autoconf/automake. |
| 288 |
|
|
|
| 289 |
rousseau |
342 |
0.2.0 - 26 August 2003, Ludovic Rousseau |
| 290 |
|
|
- Works under MacOS X |
| 291 |
|
|
- Info.plist: use an <array></array> for the alias enumeration |
| 292 |
|
|
- Makefile rework for *BSD and MacOS X |
| 293 |
|
|
|
| 294 |
rousseau |
273 |
0.1.0 - 13 August 2003, Ludovic Rousseau |
| 295 |
|
|
- First public release |
| 296 |
rousseau |
269 |
|
| 297 |
|
|
|
| 298 |
rousseau |
425 |
Bibliography: |
| 299 |
|
|
============= |
| 300 |
rousseau |
269 |
|
| 301 |
|
|
[1] http://www.usb.org/developers/devclass_docs/ccid_classspec_1_00a.pdf |
| 302 |
rousseau |
273 |
[2] http://www.gemplus.com/products/gempc433/ |
| 303 |
|
|
[3] http://www.gemplus.com/products/gempckey/ |
| 304 |
rousseau |
269 |
[4] http://www.gemplus.com/products/gempctwin/ |
| 305 |
rousseau |
273 |
[5] http://www.omnikey.com/en/produkt_details.php3?produkt=1&variante=47 |
| 306 |
|
|
[6] http://www.scmmicro.com/security/SCR331.html |
| 307 |
|
|
[7] http://www.scmmicro.com/security/SCR335.html |
| 308 |
rousseau |
709 |
[8] http://www.c3po.es/ltc31.html |
| 309 |
rousseau |
553 |
[9] http://www.scmmicro.com/security/SPR532.html |
| 310 |
rousseau |
606 |
[10] http://www.activcard.com/products/usb_reader.html |
| 311 |
rousseau |
666 |
[11] http://www.scmmicro.com/security/SCR331-DI.html |
| 312 |
rousseau |
677 |
[12] http://www.silitek.com/prod/getProduct.do?xml_id=4_2&menu_id=4_2_8&cid=1_8_5 |
| 313 |
rousseau |
709 |
[13] http://www.c3po.es/ltc32.html |
| 314 |
|
|
[14] http://www.c3po.es/tltc2usb.html |
| 315 |
|
|
[15] http://www.scmmicro.com/security/SCR333.html |
| 316 |
rousseau |
1321 |
[16] http://www.acs.com.hk/Product_Readers.asp?productID=59&PCate=Products_PC_Linked_SmartCard_Readers |
| 317 |
rousseau |
1314 |
[17] http://www.scmmicro.com/support/pcs_product_drivers.html |
| 318 |
rousseau |
1317 |
[18] http://www.cherrycorp.com/english/advanced-line/advanced-line_smartboard_g83-6744.htm |
| 319 |
rousseau |
1326 |
[19] http://www.kobil.com/e/products/smartcard/kaan-base.php |
| 320 |
|
|
[20] http://www.kobil.com/e/products/smartcard/kaan-advanced.php |
| 321 |
rousseau |
1393 |
[21] http://www.kobil.de/d/products/smartcard/kaansim3.php |
| 322 |
rousseau |
269 |
|
| 323 |
|
|
$Id$ |
| 324 |
|
|
|
| 325 |
|
|
vim:ts=20 |
Parent Directory
| 
Revision Log