ccid/ccid-1.3.8/README

USB CCID IFD Handler
====================

  This package provides the source code for a generic USB CCID
(Chip/Smart Card Interface Devices) driver. See [1] for the USB CCID
specifications from the USB working group.


Author:
=======

- Ludovic Rousseau <ludovic.rousseau@free.fr>


Supported CCID readers:
=======================

(in alphabetical order)
- Gemplus GemPC 433 SL [2]
- Gemplus GemPC Key [3]
- Gemplus GemPC Twin [4]
- LTC31 from C3PO [8]
- OmniKey CardMan 3121 [5]
- SCM Micro SCR 331 [6]
- SCM Micro SCR 335 [7]


Unsupported CCID readers:
=========================

None known.


Supported operating systems:
============================

- GNU/Linux (libusb 0.1.7)
- MacOS X/Darwin (libusb 0.1.8beta, CVS snapshot. See "Known problems")
  to libusb)


Known problems:
===============

All platforms
    T=1 and TPDU
    """"""""""""
      I do not yet included support of T=1 cards when the reader is in
      TPDU mode.
      If you have a T=1 card I recommand you to use a reader working in
      APDU mode. T=1 and TPDU will be supported in a future version of
      the driver.

    readers enumeration
    """""""""""""""""""
      You may have wrong reader identification if you connect two or
      more reader at the exact same time.

      The daemon pcscd and the CCID driver do not list connected readers
      in the same order. The driver has no way to know which reader has
      been detected as a new reader by pcscd.
      
      So if you plug two readers at the same time (for example if you
      start pcscd with two readers connected or if you plug a USB hub
      with two readers on the hub) you may have this (with two readers
      foo and bar):
      - pcscd scans the USB bus and finds a new CCID reader foo and
        calls the driver
      - the CCID driver scan the USB bus and finds a new different
        reader bar
      - pcscd continues scanning the USB bus and finds the second reader
        bar and calls the driver
      - the CCID driver scan the USB bus and finds an unused reader foo.

        Now the reader foo will be called bar by pcscd and bar will be
        called foo. This may not be a problem if the two readers have
        the same name. But it is strange to insert a card in the
        physical reader foo and see pcscd detect the card insertion in
        the reader he calls bar.
        
        The solution is to use IFDHCreateChannelByName() instead of
        IFDHCreateChannel() and specify the USB device to use. But pcscd
        does not implement IFDHCreateChannelByName() yet. Maybe in the
        future.
        
        Another solution is to plug readers one after the other and not
        at the same time.

MacOS X/Darwin
    hotplug
    """""""
      Due to libusb work in progress the driver may crash on a reader
      insertion after a few insert/remove actions.
      So if your reader is always connected you should not have
      problems.
      A new version of libusb should fix this bug

*BSD
    libusb
    """"""
      The libusb does not yet support USB interrupt endpoints. You will
      notice that the driver will stop working as soon as you insert a
      card in the reader.
      A new version of libusb should fix this bug.


Licence:
========

  This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.

  This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

  You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA


History:
========

0.3.1 - 23 September 2003, Ludovic Rouseau
    - add --enable-multi-thread (enabled by default) for thread safe
      support an APDU multiplexing. You will need pcsc-lite-1.2.0-rc3 or
      above to use this feature.
    - add --enable-libusb=PATH option is your libusb is not installed in
      /usr or /usr/local
    - honor DESTDIR in install rules (closes [ #300110 ]). Thanks to
      Ville Skytt� for the patch.
    - src/ccid.c: do not switch the GemPC Key and GemPC Twin in APDU
      mode since it also swicth in EMV mode and may not work with non
      EMV cards
    - src/ccid_serial.c: complete reimplementation of the Twin serial
      protocol using a finite state automata (code much simpler)

0.3.0 - 10 September 2003, Ludovic Rousseau
    - support of GemPC Twin connected to a serial port. Thanks to Niki
      W. Waibel for a working prototype.
    - support of auto voltage at power up if the reader support it
      instead of forcing a 5V in all cases.
    - support of APDU mode instead of just TPDU if the reader support
      it. Thanks to Jean-Luc Giraud for the idea and inspiration I got
      from his "concurrent" driver.
    - support of "time request" from the card.
    - parse: new indentation for more readability of supported features.
    - switch the GemPC Key and GemPC Twin in APDU mode since they
      support it but do not announce it in the dwFeatures.
    - new build process using autoconf/automake.

0.2.0 - 26 August 2003, Ludovic Rousseau
    - Works under MacOS X
    - Info.plist: use an <array></array> for the alias enumeration
    - Makefile rework for *BSD and MacOS X

0.1.0 - 13 August 2003, Ludovic Rousseau
    - First public release


Bibliography:
=============

[1] http://www.usb.org/developers/devclass_docs/ccid_classspec_1_00a.pdf
[2] http://www.gemplus.com/products/gempc433/
[3] http://www.gemplus.com/products/gempckey/
[4] http://www.gemplus.com/products/gempctwin/
[5] http://www.omnikey.com/en/produkt_details.php3?produkt=1&variante=47
[6] http://www.scmmicro.com/security/SCR331.html
[7] http://www.scmmicro.com/security/SCR335.html
[8] http://www.c3po.es/pcsc.htm

$Id$

 vim:ts=20
1	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	specifications from the USB working group.
7
8
9	Author:
10	=======
11
12	- Ludovic Rousseau <ludovic.rousseau@free.fr>
13
14
15	Supported CCID readers:
16	=======================
17
18	(in alphabetical order)
19	- Gemplus GemPC 433 SL [2]
20	- Gemplus GemPC Key [3]
21	- Gemplus GemPC Twin [4]
22	- LTC31 from C3PO [8]
23	- OmniKey CardMan 3121 [5]
24	- SCM Micro SCR 331 [6]
25	- SCM Micro SCR 335 [7]
26
27
28	Unsupported CCID readers:
29	=========================
30
31	None known.
32
33
34	Supported operating systems:
35	============================
36
37	- GNU/Linux (libusb 0.1.7)
38	- MacOS X/Darwin (libusb 0.1.8beta, CVS snapshot. See "Known problems")
39	to libusb)
40
41
42	Known problems:
43	===============
44
45	All platforms
46	T=1 and TPDU
47	""""""""""""
48	I do not yet included support of T=1 cards when the reader is in
49	TPDU mode.
50	If you have a T=1 card I recommand you to use a reader working in
51	APDU mode. T=1 and TPDU will be supported in a future version of
52	the driver.
53
54	readers enumeration
55	"""""""""""""""""""
56	You may have wrong reader identification if you connect two or
57	more reader at the exact same time.
58
59	The daemon pcscd and the CCID driver do not list connected readers
60	in the same order. The driver has no way to know which reader has
61	been detected as a new reader by pcscd.
62
63	So if you plug two readers at the same time (for example if you
64	start pcscd with two readers connected or if you plug a USB hub
65	with two readers on the hub) you may have this (with two readers
66	foo and bar):
67	- pcscd scans the USB bus and finds a new CCID reader foo and
68	calls the driver
69	- the CCID driver scan the USB bus and finds a new different
70	reader bar
71	- pcscd continues scanning the USB bus and finds the second reader
72	bar and calls the driver
73	- the CCID driver scan the USB bus and finds an unused reader foo.
74
75	Now the reader foo will be called bar by pcscd and bar will be
76	called foo. This may not be a problem if the two readers have
77	the same name. But it is strange to insert a card in the
78	physical reader foo and see pcscd detect the card insertion in
79	the reader he calls bar.
80
81	The solution is to use IFDHCreateChannelByName() instead of
82	IFDHCreateChannel() and specify the USB device to use. But pcscd
83	does not implement IFDHCreateChannelByName() yet. Maybe in the
84	future.
85
86	Another solution is to plug readers one after the other and not
87	at the same time.
88
89	MacOS X/Darwin
90	hotplug
91	"""""""
92	Due to libusb work in progress the driver may crash on a reader
93	insertion after a few insert/remove actions.
94	So if your reader is always connected you should not have
95	problems.
96	A new version of libusb should fix this bug
97
98	*BSD
99	libusb
100	""""""
101	The libusb does not yet support USB interrupt endpoints. You will
102	notice that the driver will stop working as soon as you insert a
103	card in the reader.
104	A new version of libusb should fix this bug.
105
106
107	Licence:
108	========
109
110	This program is free software; you can redistribute it and/or modify
111	it under the terms of the GNU General Public License as published by the
112	Free Software Foundation; either version 2 of the License, or (at your
113	option) any later version.
114
115	This program is distributed in the hope that it will be useful, but
116	WITHOUT ANY WARRANTY; without even the implied warranty of
117	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
118	General Public License for more details.
119
120	You should have received a copy of the GNU General Public License
121	along with this program; if not, write to the Free Software Foundation,
122	Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
123
124
125	History:
126	========
127
128	0.3.1 - 23 September 2003, Ludovic Rouseau
129	- add --enable-multi-thread (enabled by default) for thread safe
130	support an APDU multiplexing. You will need pcsc-lite-1.2.0-rc3 or
131	above to use this feature.
132	- add --enable-libusb=PATH option is your libusb is not installed in
133	/usr or /usr/local
134	- honor DESTDIR in install rules (closes [ #300110 ]). Thanks to
135	Ville Skytt� for the patch.
136	- src/ccid.c: do not switch the GemPC Key and GemPC Twin in APDU
137	mode since it also swicth in EMV mode and may not work with non
138	EMV cards
139	- src/ccid_serial.c: complete reimplementation of the Twin serial
140	protocol using a finite state automata (code much simpler)
141
142	0.3.0 - 10 September 2003, Ludovic Rousseau
143	- support of GemPC Twin connected to a serial port. Thanks to Niki
144	W. Waibel for a working prototype.
145	- support of auto voltage at power up if the reader support it
146	instead of forcing a 5V in all cases.
147	- support of APDU mode instead of just TPDU if the reader support
148	it. Thanks to Jean-Luc Giraud for the idea and inspiration I got
149	from his "concurrent" driver.
150	- support of "time request" from the card.
151	- parse: new indentation for more readability of supported features.
152	- switch the GemPC Key and GemPC Twin in APDU mode since they
153	support it but do not announce it in the dwFeatures.
154	- new build process using autoconf/automake.
155
156	0.2.0 - 26 August 2003, Ludovic Rousseau
157	- Works under MacOS X
158	- Info.plist: use an <array></array> for the alias enumeration
159	- Makefile rework for *BSD and MacOS X
160
161	0.1.0 - 13 August 2003, Ludovic Rousseau
162	- First public release
163
164
165	Bibliography:
166	=============
167
168	[1] http://www.usb.org/developers/devclass_docs/ccid_classspec_1_00a.pdf
169	[2] http://www.gemplus.com/products/gempc433/
170	[3] http://www.gemplus.com/products/gempckey/
171	[4] http://www.gemplus.com/products/gempctwin/
172	[5] http://www.omnikey.com/en/produkt_details.php3?produkt=1&variante=47
173	[6] http://www.scmmicro.com/security/SCR331.html
174	[7] http://www.scmmicro.com/security/SCR335.html
175	[8] http://www.c3po.es/pcsc.htm
176
177	$Id$
178
179	vim:ts=20
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision