gpg: Split a utility function out of a large function.
[gnupg.git] / scd / ccid-driver.c
1 /* ccid-driver.c - USB ChipCardInterfaceDevices driver
2  * Copyright (C) 2003, 2004, 2005, 2006, 2007
3  *               2008, 2009, 2013  Free Software Foundation, Inc.
4  * Written by Werner Koch.
5  *
6  * This file is part of GnuPG.
7  *
8  * GnuPG is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * GnuPG is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, see <http://www.gnu.org/licenses/>.
20  *
21  * ALTERNATIVELY, this file may be distributed under the terms of the
22  * following license, in which case the provisions of this license are
23  * required INSTEAD OF the GNU General Public License. If you wish to
24  * allow use of your version of this file only under the terms of the
25  * GNU General Public License, and not to allow others to use your
26  * version of this file under the terms of the following license,
27  * indicate your decision by deleting this paragraph and the license
28  * below.
29  *
30  * Redistribution and use in source and binary forms, with or without
31  * modification, are permitted provided that the following conditions
32  * are met:
33  * 1. Redistributions of source code must retain the above copyright
34  *    notice, and the entire permission notice in its entirety,
35  *    including the disclaimer of warranties.
36  * 2. Redistributions in binary form must reproduce the above copyright
37  *    notice, this list of conditions and the following disclaimer in the
38  *    documentation and/or other materials provided with the distribution.
39  * 3. The name of the author may not be used to endorse or promote
40  *    products derived from this software without specific prior
41  *    written permission.
42  *
43  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
44  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
45  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
46  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
47  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
48  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
49  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
51  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
52  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
53  * OF THE POSSIBILITY OF SUCH DAMAGE.
54  */
55
56
57 /* CCID (ChipCardInterfaceDevices) is a specification for accessing
58    smartcard via a reader connected to the USB.
59
60    This is a limited driver allowing to use some CCID drivers directly
61    without any other specila drivers. This is a fallback driver to be
62    used when nothing else works or the system should be kept minimal
63    for security reasons.  It makes use of the libusb library to gain
64    portable access to USB.
65
66    This driver has been tested with the SCM SCR335 and SPR532
67    smartcard readers and requires that a reader implements APDU or
68    TPDU level exchange and does fully automatic initialization.
69 */
70
71 #ifdef HAVE_CONFIG_H
72 # include <config.h>
73 #endif
74
75 #if defined(HAVE_LIBUSB) || defined(TEST)
76
77 #include <errno.h>
78 #include <stdio.h>
79 #include <stdlib.h>
80 #include <string.h>
81 #include <assert.h>
82 #include <sys/types.h>
83 #include <sys/stat.h>
84 #include <fcntl.h>
85 #include <time.h>
86 #ifdef HAVE_NPTH
87 # include <npth.h>
88 #endif /*HAVE_NPTH*/
89
90 #include <usb.h>
91
92 #include "scdaemon.h"
93 #include "iso7816.h"
94 #define CCID_DRIVER_INCLUDE_USB_IDS 1
95 #include "ccid-driver.h"
96
97 #define DRVNAME "ccid-driver: "
98
99 /* Max length of buffer with out CCID message header of 10-byte
100    Sending: 547 for RSA-4096 key import
101         APDU size = 540 (24+4+256+256)
102         commnd + lc + le = 4 + 3 + 0
103    Sending: write data object of cardholder certificate
104         APDU size = 2048
105         commnd + lc + le = 4 + 3 + 0
106    Receiving: 2048 for cardholder certificate
107 */
108 #define CCID_MAX_BUF (2048+7+10)
109
110 /* CCID command timeout.  OpenPGPcard v2.1 requires timeout of 13 seconds.  */
111 #define CCID_CMD_TIMEOUT (13*1000)
112
113 /* Depending on how this source is used we either define our error
114    output to go to stderr or to the GnuPG based logging functions.  We
115    use the latter when GNUPG_MAJOR_VERSION or GNUPG_SCD_MAIN_HEADER
116    are defined.  */
117 #if defined(GNUPG_MAJOR_VERSION) || defined(GNUPG_SCD_MAIN_HEADER)
118
119 #if defined(GNUPG_SCD_MAIN_HEADER)
120 #  include GNUPG_SCD_MAIN_HEADER
121 #elif GNUPG_MAJOR_VERSION == 1 /* GnuPG Version is < 1.9. */
122 #  include "options.h"
123 #  include "util.h"
124 #  include "memory.h"
125 #  include "cardglue.h"
126 # else /* This is the modularized GnuPG 1.9 or later. */
127 #  include "scdaemon.h"
128 #endif
129
130
131 # define DEBUGOUT(t)         do { if (debug_level) \
132                                   log_debug (DRVNAME t); } while (0)
133 # define DEBUGOUT_1(t,a)     do { if (debug_level) \
134                                   log_debug (DRVNAME t,(a)); } while (0)
135 # define DEBUGOUT_2(t,a,b)   do { if (debug_level) \
136                                   log_debug (DRVNAME t,(a),(b)); } while (0)
137 # define DEBUGOUT_3(t,a,b,c) do { if (debug_level) \
138                                   log_debug (DRVNAME t,(a),(b),(c));} while (0)
139 # define DEBUGOUT_4(t,a,b,c,d) do { if (debug_level) \
140                               log_debug (DRVNAME t,(a),(b),(c),(d));} while (0)
141 # define DEBUGOUT_CONT(t)    do { if (debug_level) \
142                                   log_printf (t); } while (0)
143 # define DEBUGOUT_CONT_1(t,a)  do { if (debug_level) \
144                                   log_printf (t,(a)); } while (0)
145 # define DEBUGOUT_CONT_2(t,a,b)   do { if (debug_level) \
146                                   log_printf (t,(a),(b)); } while (0)
147 # define DEBUGOUT_CONT_3(t,a,b,c) do { if (debug_level) \
148                                   log_printf (t,(a),(b),(c)); } while (0)
149 # define DEBUGOUT_LF()       do { if (debug_level) \
150                                   log_printf ("\n"); } while (0)
151
152 #else /* Other usage of this source - don't use gnupg specifics. */
153
154 # define DEBUGOUT(t)          do { if (debug_level) \
155                      fprintf (stderr, DRVNAME t); } while (0)
156 # define DEBUGOUT_1(t,a)      do { if (debug_level) \
157                      fprintf (stderr, DRVNAME t, (a)); } while (0)
158 # define DEBUGOUT_2(t,a,b)    do { if (debug_level) \
159                      fprintf (stderr, DRVNAME t, (a), (b)); } while (0)
160 # define DEBUGOUT_3(t,a,b,c)  do { if (debug_level) \
161                      fprintf (stderr, DRVNAME t, (a), (b), (c)); } while (0)
162 # define DEBUGOUT_4(t,a,b,c,d)  do { if (debug_level) \
163                      fprintf (stderr, DRVNAME t, (a), (b), (c), (d));} while(0)
164 # define DEBUGOUT_CONT(t)     do { if (debug_level) \
165                      fprintf (stderr, t); } while (0)
166 # define DEBUGOUT_CONT_1(t,a) do { if (debug_level) \
167                      fprintf (stderr, t, (a)); } while (0)
168 # define DEBUGOUT_CONT_2(t,a,b) do { if (debug_level) \
169                      fprintf (stderr, t, (a), (b)); } while (0)
170 # define DEBUGOUT_CONT_3(t,a,b,c) do { if (debug_level) \
171                      fprintf (stderr, t, (a), (b), (c)); } while (0)
172 # define DEBUGOUT_LF()        do { if (debug_level) \
173                      putc ('\n', stderr); } while (0)
174
175 #endif /* This source not used by scdaemon. */
176
177
178 #ifndef EAGAIN
179 #define EAGAIN  EWOULDBLOCK
180 #endif
181
182
183
184 enum {
185   RDR_to_PC_NotifySlotChange= 0x50,
186   RDR_to_PC_HardwareError   = 0x51,
187
188   PC_to_RDR_SetParameters   = 0x61,
189   PC_to_RDR_IccPowerOn      = 0x62,
190   PC_to_RDR_IccPowerOff     = 0x63,
191   PC_to_RDR_GetSlotStatus   = 0x65,
192   PC_to_RDR_Secure          = 0x69,
193   PC_to_RDR_T0APDU          = 0x6a,
194   PC_to_RDR_Escape          = 0x6b,
195   PC_to_RDR_GetParameters   = 0x6c,
196   PC_to_RDR_ResetParameters = 0x6d,
197   PC_to_RDR_IccClock        = 0x6e,
198   PC_to_RDR_XfrBlock        = 0x6f,
199   PC_to_RDR_Mechanical      = 0x71,
200   PC_to_RDR_Abort           = 0x72,
201   PC_to_RDR_SetDataRate     = 0x73,
202
203   RDR_to_PC_DataBlock       = 0x80,
204   RDR_to_PC_SlotStatus      = 0x81,
205   RDR_to_PC_Parameters      = 0x82,
206   RDR_to_PC_Escape          = 0x83,
207   RDR_to_PC_DataRate        = 0x84
208 };
209
210
211 /* Two macro to detect whether a CCID command has failed and to get
212    the error code.  These macros assume that we can access the
213    mandatory first 10 bytes of a CCID message in BUF. */
214 #define CCID_COMMAND_FAILED(buf) ((buf)[7] & 0x40)
215 #define CCID_ERROR_CODE(buf)     (((unsigned char *)(buf))[8])
216
217
218 /* A list and a table with special transport descriptions. */
219 enum {
220   TRANSPORT_USB    = 0, /* Standard USB transport. */
221   TRANSPORT_CM4040 = 1  /* As used by the Cardman 4040. */
222 };
223
224 static struct
225 {
226   char *name;  /* Device name. */
227   int  type;
228
229 } transports[] = {
230   { "/dev/cmx0", TRANSPORT_CM4040 },
231   { "/dev/cmx1", TRANSPORT_CM4040 },
232   { NULL },
233 };
234
235
236 /* Store information on the driver's state.  A pointer to such a
237    structure is used as handle for most functions. */
238 struct ccid_driver_s
239 {
240   usb_dev_handle *idev;
241   char *rid;
242   int dev_fd;  /* -1 for USB transport or file descriptor of the
243                    transport device. */
244   unsigned short id_vendor;
245   unsigned short id_product;
246   unsigned short bcd_device;
247   int ifc_no;
248   int ep_bulk_out;
249   int ep_bulk_in;
250   int ep_intr;
251   int seqno;
252   unsigned char t1_ns;
253   unsigned char t1_nr;
254   unsigned char nonnull_nad;
255   int max_ifsd;
256   int max_ccid_msglen;
257   int ifsc;
258   unsigned char apdu_level:2;     /* Reader supports short APDU level
259                                      exchange.  With a value of 2 short
260                                      and extended level is supported.*/
261   unsigned int auto_voltage:1;
262   unsigned int auto_param:1;
263   unsigned int auto_pps:1;
264   unsigned int auto_ifsd:1;
265   unsigned int powered_off:1;
266   unsigned int has_pinpad:2;
267   unsigned int enodev_seen:1;
268
269   time_t last_progress; /* Last time we sent progress line.  */
270
271   /* The progress callback and its first arg as supplied to
272      ccid_set_progress_cb.  */
273   void (*progress_cb)(void *, const char *, int, int, int);
274   void *progress_cb_arg;
275 };
276
277
278 static int initialized_usb; /* Tracks whether USB has been initialized. */
279 static int debug_level;     /* Flag to control the debug output.
280                                0 = No debugging
281                                1 = USB I/O info
282                                2 = Level 1 + T=1 protocol tracing
283                                3 = Level 2 + USB/I/O tracing of SlotStatus.
284                               */
285
286
287 static unsigned int compute_edc (const unsigned char *data, size_t datalen,
288                                  int use_crc);
289 static int bulk_out (ccid_driver_t handle, unsigned char *msg, size_t msglen,
290                      int no_debug);
291 static int bulk_in (ccid_driver_t handle, unsigned char *buffer, size_t length,
292                     size_t *nread, int expected_type, int seqno, int timeout,
293                     int no_debug);
294 static int abort_cmd (ccid_driver_t handle, int seqno);
295 static int send_escape_cmd (ccid_driver_t handle, const unsigned char *data,
296                             size_t datalen, unsigned char *result,
297                             size_t resultmax, size_t *resultlen);
298
299 /* Convert a little endian stored 4 byte value into an unsigned
300    integer. */
301 static unsigned int
302 convert_le_u32 (const unsigned char *buf)
303 {
304   return buf[0] | (buf[1] << 8) | (buf[2] << 16) | ((unsigned int)buf[3] << 24);
305 }
306
307
308 /* Convert a little endian stored 2 byte value into an unsigned
309    integer. */
310 static unsigned int
311 convert_le_u16 (const unsigned char *buf)
312 {
313   return buf[0] | (buf[1] << 8);
314 }
315
316 static void
317 set_msg_len (unsigned char *msg, unsigned int length)
318 {
319   msg[1] = length;
320   msg[2] = length >> 8;
321   msg[3] = length >> 16;
322   msg[4] = length >> 24;
323 }
324
325
326 static void
327 my_sleep (int seconds)
328 {
329 #ifdef USE_NPTH
330   npth_sleep (seconds);
331 #else
332 # ifdef HAVE_W32_SYSTEM
333   Sleep (seconds*1000);
334 # else
335   sleep (seconds);
336 # endif
337 #endif
338 }
339
340 static void
341 print_progress (ccid_driver_t handle)
342 {
343   time_t ct = time (NULL);
344
345   /* We don't want to print progress lines too often. */
346   if (ct == handle->last_progress)
347     return;
348
349   if (handle->progress_cb)
350     handle->progress_cb (handle->progress_cb_arg, "card_busy", 'w', 0, 0);
351
352   handle->last_progress = ct;
353 }
354
355
356
357 /* Pint an error message for a failed CCID command including a textual
358    error code.  MSG shall be the CCID message at a minimum of 10 bytes. */
359 static void
360 print_command_failed (const unsigned char *msg)
361 {
362   const char *t;
363   char buffer[100];
364   int ec;
365
366   if (!debug_level)
367     return;
368
369   ec = CCID_ERROR_CODE (msg);
370   switch (ec)
371     {
372     case 0x00: t = "Command not supported"; break;
373
374     case 0xE0: t = "Slot busy"; break;
375     case 0xEF: t = "PIN cancelled"; break;
376     case 0xF0: t = "PIN timeout"; break;
377
378     case 0xF2: t = "Automatic sequence ongoing"; break;
379     case 0xF3: t = "Deactivated Protocol"; break;
380     case 0xF4: t = "Procedure byte conflict"; break;
381     case 0xF5: t = "ICC class not supported"; break;
382     case 0xF6: t = "ICC protocol not supported"; break;
383     case 0xF7: t = "Bad checksum in ATR"; break;
384     case 0xF8: t = "Bad TS in ATR"; break;
385
386     case 0xFB: t = "An all inclusive hardware error occurred"; break;
387     case 0xFC: t = "Overrun error while talking to the ICC"; break;
388     case 0xFD: t = "Parity error while talking to the ICC"; break;
389     case 0xFE: t = "CCID timed out while talking to the ICC"; break;
390     case 0xFF: t = "Host aborted the current activity"; break;
391
392     default:
393       if (ec > 0 && ec < 128)
394         sprintf (buffer, "Parameter error at offset %d", ec);
395       else
396         sprintf (buffer, "Error code %02X", ec);
397       t = buffer;
398       break;
399     }
400   DEBUGOUT_1 ("CCID command failed: %s\n", t);
401 }
402
403
404 static void
405 print_pr_data (const unsigned char *data, size_t datalen, size_t off)
406 {
407   int any = 0;
408
409   for (; off < datalen; off++)
410     {
411       if (!any || !(off % 16))
412         {
413           if (any)
414             DEBUGOUT_LF ();
415           DEBUGOUT_1 ("  [%04lu] ", (unsigned long) off);
416         }
417       DEBUGOUT_CONT_1 (" %02X", data[off]);
418       any = 1;
419     }
420   if (any && (off % 16))
421     DEBUGOUT_LF ();
422 }
423
424
425 static void
426 print_p2r_header (const char *name, const unsigned char *msg, size_t msglen)
427 {
428   DEBUGOUT_1 ("%s:\n", name);
429   if (msglen < 7)
430     return;
431   DEBUGOUT_1 ("  dwLength ..........: %u\n", convert_le_u32 (msg+1));
432   DEBUGOUT_1 ("  bSlot .............: %u\n", msg[5]);
433   DEBUGOUT_1 ("  bSeq ..............: %u\n", msg[6]);
434 }
435
436
437 static void
438 print_p2r_iccpoweron (const unsigned char *msg, size_t msglen)
439 {
440   print_p2r_header ("PC_to_RDR_IccPowerOn", msg, msglen);
441   if (msglen < 10)
442     return;
443   DEBUGOUT_2 ("  bPowerSelect ......: 0x%02x (%s)\n", msg[7],
444               msg[7] == 0? "auto":
445               msg[7] == 1? "5.0 V":
446               msg[7] == 2? "3.0 V":
447               msg[7] == 3? "1.8 V":"");
448   print_pr_data (msg, msglen, 8);
449 }
450
451
452 static void
453 print_p2r_iccpoweroff (const unsigned char *msg, size_t msglen)
454 {
455   print_p2r_header ("PC_to_RDR_IccPowerOff", msg, msglen);
456   print_pr_data (msg, msglen, 7);
457 }
458
459
460 static void
461 print_p2r_getslotstatus (const unsigned char *msg, size_t msglen)
462 {
463   print_p2r_header ("PC_to_RDR_GetSlotStatus", msg, msglen);
464   print_pr_data (msg, msglen, 7);
465 }
466
467
468 static void
469 print_p2r_xfrblock (const unsigned char *msg, size_t msglen)
470 {
471   unsigned int val;
472
473   print_p2r_header ("PC_to_RDR_XfrBlock", msg, msglen);
474   if (msglen < 10)
475     return;
476   DEBUGOUT_1 ("  bBWI ..............: 0x%02x\n", msg[7]);
477   val = convert_le_u16 (msg+8);
478   DEBUGOUT_2 ("  wLevelParameter ...: 0x%04x%s\n", val,
479               val == 1? " (continued)":
480               val == 2? " (continues+ends)":
481               val == 3? " (continues+continued)":
482               val == 16? " (DataBlock-expected)":"");
483   print_pr_data (msg, msglen, 10);
484 }
485
486
487 static void
488 print_p2r_getparameters (const unsigned char *msg, size_t msglen)
489 {
490   print_p2r_header ("PC_to_RDR_GetParameters", msg, msglen);
491   print_pr_data (msg, msglen, 7);
492 }
493
494
495 static void
496 print_p2r_resetparameters (const unsigned char *msg, size_t msglen)
497 {
498   print_p2r_header ("PC_to_RDR_ResetParameters", msg, msglen);
499   print_pr_data (msg, msglen, 7);
500 }
501
502
503 static void
504 print_p2r_setparameters (const unsigned char *msg, size_t msglen)
505 {
506   print_p2r_header ("PC_to_RDR_SetParameters", msg, msglen);
507   if (msglen < 10)
508     return;
509   DEBUGOUT_1 ("  bProtocolNum ......: 0x%02x\n", msg[7]);
510   print_pr_data (msg, msglen, 8);
511 }
512
513
514 static void
515 print_p2r_escape (const unsigned char *msg, size_t msglen)
516 {
517   print_p2r_header ("PC_to_RDR_Escape", msg, msglen);
518   print_pr_data (msg, msglen, 7);
519 }
520
521
522 static void
523 print_p2r_iccclock (const unsigned char *msg, size_t msglen)
524 {
525   print_p2r_header ("PC_to_RDR_IccClock", msg, msglen);
526   if (msglen < 10)
527     return;
528   DEBUGOUT_1 ("  bClockCommand .....: 0x%02x\n", msg[7]);
529   print_pr_data (msg, msglen, 8);
530 }
531
532
533 static void
534 print_p2r_to0apdu (const unsigned char *msg, size_t msglen)
535 {
536   print_p2r_header ("PC_to_RDR_T0APDU", msg, msglen);
537   if (msglen < 10)
538     return;
539   DEBUGOUT_1 ("  bmChanges .........: 0x%02x\n", msg[7]);
540   DEBUGOUT_1 ("  bClassGetResponse .: 0x%02x\n", msg[8]);
541   DEBUGOUT_1 ("  bClassEnvelope ....: 0x%02x\n", msg[9]);
542   print_pr_data (msg, msglen, 10);
543 }
544
545
546 static void
547 print_p2r_secure (const unsigned char *msg, size_t msglen)
548 {
549   unsigned int val;
550
551   print_p2r_header ("PC_to_RDR_Secure", msg, msglen);
552   if (msglen < 10)
553     return;
554   DEBUGOUT_1 ("  bBMI ..............: 0x%02x\n", msg[7]);
555   val = convert_le_u16 (msg+8);
556   DEBUGOUT_2 ("  wLevelParameter ...: 0x%04x%s\n", val,
557               val == 1? " (continued)":
558               val == 2? " (continues+ends)":
559               val == 3? " (continues+continued)":
560               val == 16? " (DataBlock-expected)":"");
561   print_pr_data (msg, msglen, 10);
562 }
563
564
565 static void
566 print_p2r_mechanical (const unsigned char *msg, size_t msglen)
567 {
568   print_p2r_header ("PC_to_RDR_Mechanical", msg, msglen);
569   if (msglen < 10)
570     return;
571   DEBUGOUT_1 ("  bFunction .........: 0x%02x\n", msg[7]);
572   print_pr_data (msg, msglen, 8);
573 }
574
575
576 static void
577 print_p2r_abort (const unsigned char *msg, size_t msglen)
578 {
579   print_p2r_header ("PC_to_RDR_Abort", msg, msglen);
580   print_pr_data (msg, msglen, 7);
581 }
582
583
584 static void
585 print_p2r_setdatarate (const unsigned char *msg, size_t msglen)
586 {
587   print_p2r_header ("PC_to_RDR_SetDataRate", msg, msglen);
588   if (msglen < 10)
589     return;
590   print_pr_data (msg, msglen, 7);
591 }
592
593
594 static void
595 print_p2r_unknown (const unsigned char *msg, size_t msglen)
596 {
597   print_p2r_header ("Unknown PC_to_RDR command", msg, msglen);
598   if (msglen < 10)
599     return;
600   print_pr_data (msg, msglen, 0);
601 }
602
603
604 static void
605 print_r2p_header (const char *name, const unsigned char *msg, size_t msglen)
606 {
607   DEBUGOUT_1 ("%s:\n", name);
608   if (msglen < 9)
609     return;
610   DEBUGOUT_1 ("  dwLength ..........: %u\n", convert_le_u32 (msg+1));
611   DEBUGOUT_1 ("  bSlot .............: %u\n", msg[5]);
612   DEBUGOUT_1 ("  bSeq ..............: %u\n", msg[6]);
613   DEBUGOUT_1 ("  bStatus ...........: %u\n", msg[7]);
614   if (msg[8])
615     DEBUGOUT_1 ("  bError ............: %u\n", msg[8]);
616 }
617
618
619 static void
620 print_r2p_datablock (const unsigned char *msg, size_t msglen)
621 {
622   print_r2p_header ("RDR_to_PC_DataBlock", msg, msglen);
623   if (msglen < 10)
624     return;
625   if (msg[9])
626     DEBUGOUT_2 ("  bChainParameter ...: 0x%02x%s\n", msg[9],
627                 msg[9] == 1? " (continued)":
628                 msg[9] == 2? " (continues+ends)":
629                 msg[9] == 3? " (continues+continued)":
630                 msg[9] == 16? " (XferBlock-expected)":"");
631   print_pr_data (msg, msglen, 10);
632 }
633
634
635 static void
636 print_r2p_slotstatus (const unsigned char *msg, size_t msglen)
637 {
638   print_r2p_header ("RDR_to_PC_SlotStatus", msg, msglen);
639   if (msglen < 10)
640     return;
641   DEBUGOUT_2 ("  bClockStatus ......: 0x%02x%s\n", msg[9],
642               msg[9] == 0? " (running)":
643               msg[9] == 1? " (stopped-L)":
644               msg[9] == 2? " (stopped-H)":
645               msg[9] == 3? " (stopped)":"");
646   print_pr_data (msg, msglen, 10);
647 }
648
649
650 static void
651 print_r2p_parameters (const unsigned char *msg, size_t msglen)
652 {
653   print_r2p_header ("RDR_to_PC_Parameters", msg, msglen);
654   if (msglen < 10)
655     return;
656
657   DEBUGOUT_1 ("  protocol ..........: T=%d\n", msg[9]);
658   if (msglen == 17 && msg[9] == 1)
659     {
660       /* Protocol T=1.  */
661       DEBUGOUT_1 ("  bmFindexDindex ....: %02X\n", msg[10]);
662       DEBUGOUT_1 ("  bmTCCKST1 .........: %02X\n", msg[11]);
663       DEBUGOUT_1 ("  bGuardTimeT1 ......: %02X\n", msg[12]);
664       DEBUGOUT_1 ("  bmWaitingIntegersT1: %02X\n", msg[13]);
665       DEBUGOUT_1 ("  bClockStop ........: %02X\n", msg[14]);
666       DEBUGOUT_1 ("  bIFSC .............: %d\n", msg[15]);
667       DEBUGOUT_1 ("  bNadValue .........: %d\n", msg[16]);
668     }
669   else
670     print_pr_data (msg, msglen, 10);
671 }
672
673
674 static void
675 print_r2p_escape (const unsigned char *msg, size_t msglen)
676 {
677   print_r2p_header ("RDR_to_PC_Escape", msg, msglen);
678   if (msglen < 10)
679     return;
680   DEBUGOUT_1 ("  buffer[9] .........: %02X\n", msg[9]);
681   print_pr_data (msg, msglen, 10);
682 }
683
684
685 static void
686 print_r2p_datarate (const unsigned char *msg, size_t msglen)
687 {
688   print_r2p_header ("RDR_to_PC_DataRate", msg, msglen);
689   if (msglen < 10)
690     return;
691   if (msglen >= 18)
692     {
693       DEBUGOUT_1 ("  dwClockFrequency ..: %u\n", convert_le_u32 (msg+10));
694       DEBUGOUT_1 ("  dwDataRate ..... ..: %u\n", convert_le_u32 (msg+14));
695       print_pr_data (msg, msglen, 18);
696     }
697   else
698     print_pr_data (msg, msglen, 10);
699 }
700
701
702 static void
703 print_r2p_unknown (const unsigned char *msg, size_t msglen)
704 {
705   print_r2p_header ("Unknown RDR_to_PC command", msg, msglen);
706   if (msglen < 10)
707     return;
708   DEBUGOUT_1 ("  bMessageType ......: %02X\n", msg[0]);
709   DEBUGOUT_1 ("  buffer[9] .........: %02X\n", msg[9]);
710   print_pr_data (msg, msglen, 10);
711 }
712
713
714 /* Given a handle used for special transport prepare it for use.  In
715    particular setup all information in way that resembles what
716    parse_cccid_descriptor does. */
717 static void
718 prepare_special_transport (ccid_driver_t handle)
719 {
720   assert (!handle->id_vendor);
721
722   handle->nonnull_nad = 0;
723   handle->auto_ifsd = 0;
724   handle->max_ifsd = 32;
725   handle->max_ccid_msglen = CCID_MAX_BUF;
726   handle->has_pinpad = 0;
727   handle->apdu_level = 0;
728   switch (handle->id_product)
729     {
730     case TRANSPORT_CM4040:
731       DEBUGOUT ("setting up transport for CardMan 4040\n");
732       handle->apdu_level = 1;
733       break;
734
735     default: assert (!"transport not defined");
736     }
737 }
738
739 /* Parse a CCID descriptor, optionally print all available features
740    and test whether this reader is usable by this driver.  Returns 0
741    if it is usable.
742
743    Note, that this code is based on the one in lsusb.c of the
744    usb-utils package, I wrote on 2003-09-01. -wk. */
745 static int
746 parse_ccid_descriptor (ccid_driver_t handle,
747                        const unsigned char *buf, size_t buflen)
748 {
749   unsigned int i;
750   unsigned int us;
751   int have_t1 = 0, have_tpdu=0;
752
753
754   handle->nonnull_nad = 0;
755   handle->auto_ifsd = 0;
756   handle->max_ifsd = 32;
757   handle->has_pinpad = 0;
758   handle->apdu_level = 0;
759   handle->auto_voltage = 0;
760   handle->auto_param = 0;
761   handle->auto_pps = 0;
762   DEBUGOUT_3 ("idVendor: %04X  idProduct: %04X  bcdDevice: %04X\n",
763               handle->id_vendor, handle->id_product, handle->bcd_device);
764   if (buflen < 54 || buf[0] < 54)
765     {
766       DEBUGOUT ("CCID device descriptor is too short\n");
767       return -1;
768     }
769
770   DEBUGOUT   ("ChipCard Interface Descriptor:\n");
771   DEBUGOUT_1 ("  bLength             %5u\n", buf[0]);
772   DEBUGOUT_1 ("  bDescriptorType     %5u\n", buf[1]);
773   DEBUGOUT_2 ("  bcdCCID             %2x.%02x", buf[3], buf[2]);
774     if (buf[3] != 1 || buf[2] != 0)
775       DEBUGOUT_CONT("  (Warning: Only accurate for version 1.0)");
776   DEBUGOUT_LF ();
777
778   DEBUGOUT_1 ("  nMaxSlotIndex       %5u\n", buf[4]);
779   DEBUGOUT_2 ("  bVoltageSupport     %5u  %s\n",
780               buf[5], (buf[5] == 1? "5.0V" : buf[5] == 2? "3.0V"
781                        : buf[5] == 3? "1.8V":"?"));
782
783   us = convert_le_u32 (buf+6);
784   DEBUGOUT_1 ("  dwProtocols         %5u ", us);
785   if ((us & 1))
786     DEBUGOUT_CONT (" T=0");
787   if ((us & 2))
788     {
789       DEBUGOUT_CONT (" T=1");
790       have_t1 = 1;
791     }
792   if ((us & ~3))
793     DEBUGOUT_CONT (" (Invalid values detected)");
794   DEBUGOUT_LF ();
795
796   us = convert_le_u32(buf+10);
797   DEBUGOUT_1 ("  dwDefaultClock      %5u\n", us);
798   us = convert_le_u32(buf+14);
799   DEBUGOUT_1 ("  dwMaxiumumClock     %5u\n", us);
800   DEBUGOUT_1 ("  bNumClockSupported  %5u\n", buf[18]);
801   us = convert_le_u32(buf+19);
802   DEBUGOUT_1 ("  dwDataRate        %7u bps\n", us);
803   us = convert_le_u32(buf+23);
804   DEBUGOUT_1 ("  dwMaxDataRate     %7u bps\n", us);
805   DEBUGOUT_1 ("  bNumDataRatesSupp.  %5u\n", buf[27]);
806
807   us = convert_le_u32(buf+28);
808   DEBUGOUT_1 ("  dwMaxIFSD           %5u\n", us);
809   handle->max_ifsd = us;
810
811   us = convert_le_u32(buf+32);
812   DEBUGOUT_1 ("  dwSyncProtocols  %08X ", us);
813   if ((us&1))
814     DEBUGOUT_CONT ( " 2-wire");
815   if ((us&2))
816     DEBUGOUT_CONT ( " 3-wire");
817   if ((us&4))
818     DEBUGOUT_CONT ( " I2C");
819   DEBUGOUT_LF ();
820
821   us = convert_le_u32(buf+36);
822   DEBUGOUT_1 ("  dwMechanical     %08X ", us);
823   if ((us & 1))
824     DEBUGOUT_CONT (" accept");
825   if ((us & 2))
826     DEBUGOUT_CONT (" eject");
827   if ((us & 4))
828     DEBUGOUT_CONT (" capture");
829   if ((us & 8))
830     DEBUGOUT_CONT (" lock");
831   DEBUGOUT_LF ();
832
833   us = convert_le_u32(buf+40);
834   DEBUGOUT_1 ("  dwFeatures       %08X\n", us);
835   if ((us & 0x0002))
836     {
837       DEBUGOUT ("    Auto configuration based on ATR (assumes auto voltage)\n");
838       handle->auto_voltage = 1;
839     }
840   if ((us & 0x0004))
841     DEBUGOUT ("    Auto activation on insert\n");
842   if ((us & 0x0008))
843     {
844       DEBUGOUT ("    Auto voltage selection\n");
845       handle->auto_voltage = 1;
846     }
847   if ((us & 0x0010))
848     DEBUGOUT ("    Auto clock change\n");
849   if ((us & 0x0020))
850     DEBUGOUT ("    Auto baud rate change\n");
851   if ((us & 0x0040))
852     {
853       DEBUGOUT ("    Auto parameter negotiation made by CCID\n");
854       handle->auto_param = 1;
855     }
856   else if ((us & 0x0080))
857     {
858       DEBUGOUT ("    Auto PPS made by CCID\n");
859       handle->auto_pps = 1;
860     }
861   if ((us & (0x0040 | 0x0080)) == (0x0040 | 0x0080))
862     DEBUGOUT ("    WARNING: conflicting negotiation features\n");
863
864   if ((us & 0x0100))
865     DEBUGOUT ("    CCID can set ICC in clock stop mode\n");
866   if ((us & 0x0200))
867     {
868       DEBUGOUT ("    NAD value other than 0x00 accepted\n");
869       handle->nonnull_nad = 1;
870     }
871   if ((us & 0x0400))
872     {
873       DEBUGOUT ("    Auto IFSD exchange\n");
874       handle->auto_ifsd = 1;
875     }
876
877   if ((us & 0x00010000))
878     {
879       DEBUGOUT ("    TPDU level exchange\n");
880       have_tpdu = 1;
881     }
882   else if ((us & 0x00020000))
883     {
884       DEBUGOUT ("    Short APDU level exchange\n");
885       handle->apdu_level = 1;
886     }
887   else if ((us & 0x00040000))
888     {
889       DEBUGOUT ("    Short and extended APDU level exchange\n");
890       handle->apdu_level = 2;
891     }
892   else if ((us & 0x00070000))
893     DEBUGOUT ("    WARNING: conflicting exchange levels\n");
894
895   us = convert_le_u32(buf+44);
896   DEBUGOUT_1 ("  dwMaxCCIDMsgLen     %5u\n", us);
897   handle->max_ccid_msglen = us;
898
899   DEBUGOUT (  "  bClassGetResponse    ");
900   if (buf[48] == 0xff)
901     DEBUGOUT_CONT ("echo\n");
902   else
903     DEBUGOUT_CONT_1 ("  %02X\n", buf[48]);
904
905   DEBUGOUT (  "  bClassEnvelope       ");
906   if (buf[49] == 0xff)
907     DEBUGOUT_CONT ("echo\n");
908   else
909     DEBUGOUT_CONT_1 ("  %02X\n", buf[48]);
910
911   DEBUGOUT (  "  wlcdLayout           ");
912   if (!buf[50] && !buf[51])
913     DEBUGOUT_CONT ("none\n");
914   else
915     DEBUGOUT_CONT_2 ("%u cols %u lines\n", buf[50], buf[51]);
916
917   DEBUGOUT_1 ("  bPINSupport         %5u ", buf[52]);
918   if ((buf[52] & 1))
919     {
920       DEBUGOUT_CONT ( " verification");
921       handle->has_pinpad |= 1;
922     }
923   if ((buf[52] & 2))
924     {
925       DEBUGOUT_CONT ( " modification");
926       handle->has_pinpad |= 2;
927     }
928   DEBUGOUT_LF ();
929
930   DEBUGOUT_1 ("  bMaxCCIDBusySlots   %5u\n", buf[53]);
931
932   if (buf[0] > 54)
933     {
934       DEBUGOUT ("  junk             ");
935       for (i=54; i < buf[0]-54; i++)
936         DEBUGOUT_CONT_1 (" %02X", buf[i]);
937       DEBUGOUT_LF ();
938     }
939
940   if (!have_t1 || !(have_tpdu  || handle->apdu_level))
941     {
942       DEBUGOUT ("this drivers requires that the reader supports T=1, "
943                 "TPDU or APDU level exchange - this is not available\n");
944       return -1;
945     }
946
947
948   /* SCM drivers get stuck in their internal USB stack if they try to
949      send a frame of n*wMaxPacketSize back to us.  Given that
950      wMaxPacketSize is 64 for these readers we set the IFSD to a value
951      lower than that:
952         64 - 10 CCID header -  4 T1frame - 2 reserved = 48
953      Product Ids:
954          0xe001 - SCR 331
955          0x5111 - SCR 331-DI
956          0x5115 - SCR 335
957          0xe003 - SPR 532
958      The
959          0x5117 - SCR 3320 USB ID-000 reader
960      seems to be very slow but enabling this workaround boosts the
961      performance to a a more or less acceptable level (tested by David).
962
963   */
964   if (handle->id_vendor == VENDOR_SCM
965       && handle->max_ifsd > 48
966       && (  (handle->id_product == SCM_SCR331   && handle->bcd_device < 0x0516)
967           ||(handle->id_product == SCM_SCR331DI && handle->bcd_device < 0x0620)
968           ||(handle->id_product == SCM_SCR335   && handle->bcd_device < 0x0514)
969           ||(handle->id_product == SCM_SPR532   && handle->bcd_device < 0x0504)
970           ||(handle->id_product == SCM_SCR3320  && handle->bcd_device < 0x0522)
971           ))
972     {
973       DEBUGOUT ("enabling workaround for buggy SCM readers\n");
974       handle->max_ifsd = 48;
975     }
976
977   if (handle->id_vendor == VENDOR_GEMPC && handle->id_product == GEMPC_CT30)
978     {
979       DEBUGOUT ("enabling product quirk: disable non-null NAD\n");
980       handle->nonnull_nad = 0;
981     }
982
983   return 0;
984 }
985
986
987 static char *
988 get_escaped_usb_string (usb_dev_handle *idev, int idx,
989                         const char *prefix, const char *suffix)
990 {
991   int rc;
992   unsigned char buf[280];
993   unsigned char *s;
994   unsigned int langid;
995   size_t i, n, len;
996   char *result;
997
998   if (!idx)
999     return NULL;
1000
1001   /* Fixme: The next line is for the current Valgrid without support
1002      for USB IOCTLs. */
1003   memset (buf, 0, sizeof buf);
1004
1005   /* First get the list of supported languages and use the first one.
1006      If we do don't find it we try to use English.  Note that this is
1007      all in a 2 bute Unicode encoding using little endian. */
1008   rc = usb_control_msg (idev, USB_ENDPOINT_IN, USB_REQ_GET_DESCRIPTOR,
1009                         (USB_DT_STRING << 8), 0,
1010                         (char*)buf, sizeof buf, 1000 /* ms timeout */);
1011   if (rc < 4)
1012     langid = 0x0409; /* English.  */
1013   else
1014     langid = (buf[3] << 8) | buf[2];
1015
1016   rc = usb_control_msg (idev, USB_ENDPOINT_IN, USB_REQ_GET_DESCRIPTOR,
1017                         (USB_DT_STRING << 8) + idx, langid,
1018                         (char*)buf, sizeof buf, 1000 /* ms timeout */);
1019   if (rc < 2 || buf[1] != USB_DT_STRING)
1020     return NULL; /* Error or not a string. */
1021   len = buf[0];
1022   if (len > rc)
1023     return NULL; /* Larger than our buffer. */
1024
1025   for (s=buf+2, i=2, n=0; i+1 < len; i += 2, s += 2)
1026     {
1027       if (s[1])
1028         n++; /* High byte set. */
1029       else if (*s <= 0x20 || *s >= 0x7f || *s == '%' || *s == ':')
1030         n += 3 ;
1031       else
1032         n++;
1033     }
1034
1035   result = malloc (strlen (prefix) + n + strlen (suffix) + 1);
1036   if (!result)
1037     return NULL;
1038
1039   strcpy (result, prefix);
1040   n = strlen (prefix);
1041   for (s=buf+2, i=2; i+1 < len; i += 2, s += 2)
1042     {
1043       if (s[1])
1044         result[n++] = '\xff'; /* High byte set. */
1045       else if (*s <= 0x20 || *s >= 0x7f || *s == '%' || *s == ':')
1046         {
1047           sprintf (result+n, "%%%02X", *s);
1048           n += 3;
1049         }
1050       else
1051         result[n++] = *s;
1052     }
1053   strcpy (result+n, suffix);
1054
1055   return result;
1056 }
1057
1058 /* This function creates an reader id to be used to find the same
1059    physical reader after a reset.  It returns an allocated and possibly
1060    percent escaped string or NULL if not enough memory is available. */
1061 static char *
1062 make_reader_id (usb_dev_handle *idev,
1063                 unsigned int vendor, unsigned int product,
1064                 unsigned char serialno_index)
1065 {
1066   char *rid;
1067   char prefix[20];
1068
1069   sprintf (prefix, "%04X:%04X:", (vendor & 0xffff), (product & 0xffff));
1070   rid = get_escaped_usb_string (idev, serialno_index, prefix, ":0");
1071   if (!rid)
1072     {
1073       rid = malloc (strlen (prefix) + 3 + 1);
1074       if (!rid)
1075         return NULL;
1076       strcpy (rid, prefix);
1077       strcat (rid, "X:0");
1078     }
1079   return rid;
1080 }
1081
1082
1083 /* Helper to find the endpoint from an interface descriptor.  */
1084 static int
1085 find_endpoint (struct usb_interface_descriptor *ifcdesc, int mode)
1086 {
1087   int no;
1088   int want_bulk_in = 0;
1089
1090   if (mode == 1)
1091     want_bulk_in = 0x80;
1092   for (no=0; no < ifcdesc->bNumEndpoints; no++)
1093     {
1094       struct usb_endpoint_descriptor *ep = ifcdesc->endpoint + no;
1095       if (ep->bDescriptorType != USB_DT_ENDPOINT)
1096         ;
1097       else if (mode == 2
1098           && ((ep->bmAttributes & USB_ENDPOINT_TYPE_MASK)
1099               == USB_ENDPOINT_TYPE_INTERRUPT)
1100           && (ep->bEndpointAddress & 0x80))
1101         return (ep->bEndpointAddress & 0x0f);
1102       else if (((ep->bmAttributes & USB_ENDPOINT_TYPE_MASK)
1103                 == USB_ENDPOINT_TYPE_BULK)
1104                && (ep->bEndpointAddress & 0x80) == want_bulk_in)
1105         return (ep->bEndpointAddress & 0x0f);
1106     }
1107   /* Should never happen.  */
1108   return mode == 2? 0x83 : mode == 1? 0x82 :1;
1109 }
1110
1111
1112 /* Helper for scan_or_find_devices. This function returns true if a
1113    requested device has been found or the caller should stop scanning
1114    for other reasons. */
1115 static int
1116 scan_or_find_usb_device (int scan_mode,
1117                          int *readerno, int *count, char **rid_list,
1118                          const char *readerid,
1119                          struct usb_device *dev,
1120                          char **r_rid,
1121                          struct usb_device **r_dev,
1122                          usb_dev_handle **r_idev,
1123                          unsigned char **ifcdesc_extra,
1124                          size_t *ifcdesc_extra_len,
1125                          int *interface_number,
1126                          int *ep_bulk_out, int *ep_bulk_in, int *ep_intr)
1127 {
1128   int cfg_no;
1129   int ifc_no;
1130   int set_no;
1131   struct usb_config_descriptor *config;
1132   struct usb_interface *interface;
1133   struct usb_interface_descriptor *ifcdesc;
1134   char *rid;
1135   usb_dev_handle *idev;
1136
1137   *r_idev = NULL;
1138
1139   for (cfg_no=0; cfg_no < dev->descriptor.bNumConfigurations; cfg_no++)
1140     {
1141       config = dev->config + cfg_no;
1142       if(!config)
1143         continue;
1144
1145       for (ifc_no=0; ifc_no < config->bNumInterfaces; ifc_no++)
1146         {
1147           interface = config->interface + ifc_no;
1148           if (!interface)
1149             continue;
1150
1151           for (set_no=0; set_no < interface->num_altsetting; set_no++)
1152             {
1153               ifcdesc = (interface->altsetting + set_no);
1154               /* The second condition is for older SCM SPR 532 who did
1155                  not know about the assigned CCID class.  The third
1156                  condition does the same for a Cherry SmartTerminal
1157                  ST-2000.  Instead of trying to interpret the strings
1158                  we simply check the product ID. */
1159               if (ifcdesc && ifcdesc->extra
1160                   && ((ifcdesc->bInterfaceClass == 11
1161                        && ifcdesc->bInterfaceSubClass == 0
1162                        && ifcdesc->bInterfaceProtocol == 0)
1163                       || (ifcdesc->bInterfaceClass == 255
1164                           && dev->descriptor.idVendor == VENDOR_SCM
1165                           && dev->descriptor.idProduct == SCM_SPR532)
1166                       || (ifcdesc->bInterfaceClass == 255
1167                           && dev->descriptor.idVendor == VENDOR_CHERRY
1168                           && dev->descriptor.idProduct == CHERRY_ST2000)))
1169                 {
1170                   idev = usb_open (dev);
1171                   if (!idev)
1172                     {
1173                       DEBUGOUT_1 ("usb_open failed: %s\n",
1174                                   strerror (errno));
1175                       continue; /* with next setting. */
1176                     }
1177
1178                   rid = make_reader_id (idev,
1179                                         dev->descriptor.idVendor,
1180                                         dev->descriptor.idProduct,
1181                                         dev->descriptor.iSerialNumber);
1182                   if (rid)
1183                     {
1184                       if (scan_mode)
1185                         {
1186                           char *p;
1187
1188                           /* We are collecting infos about all
1189                              available CCID readers.  Store them and
1190                              continue. */
1191                           DEBUGOUT_2 ("found CCID reader %d (ID=%s)\n",
1192                                       *count, rid );
1193                           p = malloc ((*rid_list? strlen (*rid_list):0) + 1
1194                                       + strlen (rid) + 1);
1195                           if (p)
1196                             {
1197                               *p = 0;
1198                               if (*rid_list)
1199                                 {
1200                                   strcat (p, *rid_list);
1201                                   free (*rid_list);
1202                                 }
1203                               strcat (p, rid);
1204                               strcat (p, "\n");
1205                               *rid_list = p;
1206                             }
1207                           else /* Out of memory. */
1208                             free (rid);
1209
1210                           rid = NULL;
1211                           ++*count;
1212                         }
1213                       else if (!*readerno
1214                                || (*readerno < 0
1215                                    && readerid
1216                                    && !strcmp (readerid, rid)))
1217                         {
1218                           /* We found the requested reader. */
1219                           if (ifcdesc_extra && ifcdesc_extra_len)
1220                             {
1221                               *ifcdesc_extra = malloc (ifcdesc
1222                                                        ->extralen);
1223                               if (!*ifcdesc_extra)
1224                                 {
1225                                   usb_close (idev);
1226                                   free (rid);
1227                                   return 1; /* Out of core. */
1228                                 }
1229                               memcpy (*ifcdesc_extra, ifcdesc->extra,
1230                                       ifcdesc->extralen);
1231                               *ifcdesc_extra_len = ifcdesc->extralen;
1232                             }
1233
1234                           if (interface_number)
1235                             *interface_number = (ifcdesc->bInterfaceNumber);
1236
1237                           if (ep_bulk_out)
1238                             *ep_bulk_out = find_endpoint (ifcdesc, 0);
1239                           if (ep_bulk_in)
1240                             *ep_bulk_in = find_endpoint (ifcdesc, 1);
1241                           if (ep_intr)
1242                             *ep_intr = find_endpoint (ifcdesc, 2);
1243
1244                           if (r_dev)
1245                             *r_dev = dev;
1246                           if (r_rid)
1247                             {
1248                               *r_rid = rid;
1249                               rid = NULL;
1250                             }
1251                           else
1252                             free (rid);
1253
1254                           *r_idev = idev;
1255                           return 1; /* Found requested device. */
1256                         }
1257                       else
1258                         {
1259                           /* This is not yet the reader we want.
1260                              fixme: We should avoid the extra usb_open
1261                              in this case. */
1262                           if (*readerno >= 0)
1263                             --*readerno;
1264                         }
1265                       free (rid);
1266                     }
1267
1268                   usb_close (idev);
1269                   idev = NULL;
1270                   return 0;
1271                 }
1272             }
1273         }
1274     }
1275
1276   return 0;
1277 }
1278
1279 /* Combination function to either scan all CCID devices or to find and
1280    open one specific device.
1281
1282    The function returns 0 if a reader has been found or when a scan
1283    returned without error.
1284
1285    With READERNO = -1 and READERID is NULL, scan mode is used and
1286    R_RID should be the address where to store the list of reader_ids
1287    we found.  If on return this list is empty, no CCID device has been
1288    found; otherwise it points to an allocated linked list of reader
1289    IDs.  Note that in this mode the function always returns NULL.
1290
1291    With READERNO >= 0 or READERID is not NULL find mode is used.  This
1292    uses the same algorithm as the scan mode but stops and returns at
1293    the entry number READERNO and return the handle for the the opened
1294    USB device. If R_RID is not NULL it will receive the reader ID of
1295    that device.  If R_DEV is not NULL it will the device pointer of
1296    that device.  If IFCDESC_EXTRA is NOT NULL it will receive a
1297    malloced copy of the interfaces "extra: data filed;
1298    IFCDESC_EXTRA_LEN receive the length of this field.  If there is
1299    no reader with number READERNO or that reader is not usable by our
1300    implementation NULL will be returned.  The caller must close a
1301    returned USB device handle and free (if not passed as NULL) the
1302    returned reader ID info as well as the IFCDESC_EXTRA.  On error
1303    NULL will get stored at R_RID, R_DEV, IFCDESC_EXTRA and
1304    IFCDESC_EXTRA_LEN.  With READERID being -1 the function stops if
1305    the READERID was found.
1306
1307    If R_FD is not -1 on return the device is not using USB for
1308    transport but the device associated with that file descriptor.  In
1309    this case INTERFACE will receive the transport type and the other
1310    USB specific return values are not used; the return value is
1311    (void*)(1).
1312
1313    Note that the first entry of the returned reader ID list in scan mode
1314    corresponds with a READERNO of 0 in find mode.
1315 */
1316 static int
1317 scan_or_find_devices (int readerno, const char *readerid,
1318                       char **r_rid,
1319                       struct usb_device **r_dev,
1320                       unsigned char **ifcdesc_extra,
1321                       size_t *ifcdesc_extra_len,
1322                       int *interface_number,
1323                       int *ep_bulk_out, int *ep_bulk_in, int *ep_intr,
1324                       usb_dev_handle **r_idev,
1325                       int *r_fd)
1326 {
1327   char *rid_list = NULL;
1328   int count = 0;
1329   struct usb_bus *busses, *bus;
1330   struct usb_device *dev = NULL;
1331   usb_dev_handle *idev = NULL;
1332   int scan_mode = (readerno == -1 && !readerid);
1333   int i;
1334
1335   /* Set return values to a default. */
1336   if (r_rid)
1337     *r_rid = NULL;
1338   if (r_dev)
1339     *r_dev = NULL;
1340   if (ifcdesc_extra)
1341     *ifcdesc_extra = NULL;
1342   if (ifcdesc_extra_len)
1343     *ifcdesc_extra_len = 0;
1344   if (interface_number)
1345     *interface_number = 0;
1346   if (r_idev)
1347     *r_idev = NULL;
1348   if (r_fd)
1349     *r_fd = -1;
1350
1351   /* See whether we want scan or find mode. */
1352   if (scan_mode)
1353     {
1354       assert (r_rid);
1355     }
1356
1357   usb_find_busses();
1358   usb_find_devices();
1359
1360 #ifdef HAVE_USB_GET_BUSSES
1361   busses = usb_get_busses();
1362 #else
1363   busses = usb_busses;
1364 #endif
1365
1366   for (bus = busses; bus; bus = bus->next)
1367     {
1368       for (dev = bus->devices; dev; dev = dev->next)
1369         {
1370           if (scan_or_find_usb_device (scan_mode, &readerno, &count, &rid_list,
1371                                        readerid,
1372                                        dev,
1373                                        r_rid,
1374                                        r_dev,
1375                                        &idev,
1376                                        ifcdesc_extra,
1377                                        ifcdesc_extra_len,
1378                                        interface_number,
1379                                        ep_bulk_out, ep_bulk_in, ep_intr))
1380             {
1381               /* Found requested device or out of core. */
1382               if (!idev)
1383                 {
1384                   free (rid_list);
1385                   return -1; /* error */
1386                 }
1387               *r_idev = idev;
1388               return 0;
1389             }
1390         }
1391     }
1392
1393   /* Now check whether there are any devices with special transport types. */
1394   for (i=0; transports[i].name; i++)
1395     {
1396       int fd;
1397       char *rid, *p;
1398
1399       fd = open (transports[i].name, O_RDWR);
1400       if (fd == -1 && scan_mode && errno == EBUSY)
1401         {
1402           /* Ignore this error in scan mode because it indicates that
1403              the device exists but is already open (most likely by us)
1404              and thus in general suitable as a reader.  */
1405         }
1406       else if (fd == -1)
1407         {
1408           DEBUGOUT_2 ("failed to open '%s': %s\n",
1409                      transports[i].name, strerror (errno));
1410           continue;
1411         }
1412
1413       rid = malloc (strlen (transports[i].name) + 30 + 10);
1414       if (!rid)
1415         {
1416           if (fd != -1)
1417             close (fd);
1418           free (rid_list);
1419           return -1; /* Error. */
1420         }
1421       sprintf (rid, "0000:%04X:%s:0", transports[i].type, transports[i].name);
1422       if (scan_mode)
1423         {
1424           DEBUGOUT_2 ("found CCID reader %d (ID=%s)\n", count, rid);
1425           p = malloc ((rid_list? strlen (rid_list):0) + 1 + strlen (rid) + 1);
1426           if (!p)
1427             {
1428               if (fd != -1)
1429                 close (fd);
1430               free (rid_list);
1431               free (rid);
1432               return -1; /* Error. */
1433             }
1434           *p = 0;
1435           if (rid_list)
1436             {
1437               strcat (p, rid_list);
1438               free (rid_list);
1439             }
1440           strcat (p, rid);
1441           strcat (p, "\n");
1442           rid_list = p;
1443           ++count;
1444         }
1445       else if (!readerno ||
1446                (readerno < 0 && readerid && !strcmp (readerid, rid)))
1447         {
1448           /* Found requested device. */
1449           if (interface_number)
1450             *interface_number = transports[i].type;
1451           if (r_rid)
1452             *r_rid = rid;
1453           else
1454             free (rid);
1455           if (r_fd)
1456             *r_fd = fd;
1457           return 0; /* Okay, found device */
1458         }
1459       else /* This is not yet the reader we want. */
1460         {
1461           if (readerno >= 0)
1462             --readerno;
1463         }
1464       free (rid);
1465       if (fd != -1)
1466         close (fd);
1467     }
1468
1469   if (scan_mode)
1470     {
1471       *r_rid = rid_list;
1472       return 0;
1473     }
1474   else
1475     return -1;
1476 }
1477
1478
1479 /* Set the level of debugging to LEVEL and return the old level.  -1
1480    just returns the old level.  A level of 0 disables debugging, 1
1481    enables debugging, 2 enables additional tracing of the T=1
1482    protocol, 3 additionally enables debugging for GetSlotStatus, other
1483    values are not yet defined.
1484
1485    Note that libusb may provide its own debugging feature which is
1486    enabled by setting the envvar USB_DEBUG.  */
1487 int
1488 ccid_set_debug_level (int level)
1489 {
1490   int old = debug_level;
1491   if (level != -1)
1492     debug_level = level;
1493   return old;
1494 }
1495
1496
1497 char *
1498 ccid_get_reader_list (void)
1499 {
1500   char *reader_list;
1501
1502   if (!initialized_usb)
1503     {
1504       usb_init ();
1505       initialized_usb = 1;
1506     }
1507
1508   if (scan_or_find_devices (-1, NULL, &reader_list, NULL, NULL, NULL, NULL,
1509                             NULL, NULL, NULL, NULL, NULL))
1510     return NULL; /* Error. */
1511   return reader_list;
1512 }
1513
1514
1515 /* Vendor specific custom initialization.  */
1516 static int
1517 ccid_vendor_specific_init (ccid_driver_t handle)
1518 {
1519   if (handle->id_vendor == VENDOR_VEGA && handle->id_product == VEGA_ALPHA)
1520     {
1521       int r;
1522       /*
1523        * Vega alpha has a feature to show retry counter on the pinpad
1524        * display.  But it assumes that the card returns the value of
1525        * retry counter by VERIFY with empty data (return code of
1526        * 63Cx).  Unfortunately, existing OpenPGP cards don't support
1527        * VERIFY command with empty data.  This vendor specific command
1528        * sequence is to disable the feature.
1529        */
1530       const unsigned char cmd[] = { '\xb5', '\x01', '\x00', '\x03', '\x00' };
1531
1532       r = send_escape_cmd (handle, cmd, sizeof (cmd), NULL, 0, NULL);
1533       if (r != 0 && r != CCID_DRIVER_ERR_CARD_INACTIVE
1534           && r != CCID_DRIVER_ERR_NO_CARD)
1535         return r;
1536     }
1537
1538   return 0;
1539 }
1540
1541
1542 /* Open the reader with the internal number READERNO and return a
1543    pointer to be used as handle in HANDLE.  Returns 0 on success. */
1544 int
1545 ccid_open_reader (ccid_driver_t *handle, const char *readerid)
1546 {
1547   int rc = 0;
1548   struct usb_device *dev = NULL;
1549   usb_dev_handle *idev = NULL;
1550   int dev_fd = -1;
1551   char *rid = NULL;
1552   unsigned char *ifcdesc_extra = NULL;
1553   size_t ifcdesc_extra_len;
1554   int readerno;
1555   int ifc_no, ep_bulk_out, ep_bulk_in, ep_intr;
1556
1557   *handle = NULL;
1558
1559   if (!initialized_usb)
1560     {
1561       usb_init ();
1562       initialized_usb = 1;
1563     }
1564
1565   /* See whether we want to use the reader ID string or a reader
1566      number. A readerno of -1 indicates that the reader ID string is
1567      to be used. */
1568   if (readerid && strchr (readerid, ':'))
1569     readerno = -1; /* We want to use the readerid.  */
1570   else if (readerid)
1571     {
1572       readerno = atoi (readerid);
1573       if (readerno < 0)
1574         {
1575           DEBUGOUT ("no CCID readers found\n");
1576           rc = CCID_DRIVER_ERR_NO_READER;
1577           goto leave;
1578         }
1579     }
1580   else
1581     readerno = 0;  /* Default. */
1582
1583   if (scan_or_find_devices (readerno, readerid, &rid, &dev,
1584                             &ifcdesc_extra, &ifcdesc_extra_len,
1585                             &ifc_no, &ep_bulk_out, &ep_bulk_in, &ep_intr,
1586                             &idev, &dev_fd) )
1587     {
1588       if (readerno == -1)
1589         DEBUGOUT_1 ("no CCID reader with ID %s\n", readerid );
1590       else
1591         DEBUGOUT_1 ("no CCID reader with number %d\n", readerno );
1592       rc = CCID_DRIVER_ERR_NO_READER;
1593       goto leave;
1594     }
1595
1596   /* Okay, this is a CCID reader. */
1597   *handle = calloc (1, sizeof **handle);
1598   if (!*handle)
1599     {
1600       DEBUGOUT ("out of memory\n");
1601       rc = CCID_DRIVER_ERR_OUT_OF_CORE;
1602       goto leave;
1603     }
1604   (*handle)->rid = rid;
1605   if (idev) /* Regular USB transport. */
1606     {
1607       (*handle)->idev = idev;
1608       (*handle)->dev_fd = -1;
1609       (*handle)->id_vendor = dev->descriptor.idVendor;
1610       (*handle)->id_product = dev->descriptor.idProduct;
1611       (*handle)->bcd_device = dev->descriptor.bcdDevice;
1612       (*handle)->ifc_no = ifc_no;
1613       (*handle)->ep_bulk_out = ep_bulk_out;
1614       (*handle)->ep_bulk_in = ep_bulk_in;
1615       (*handle)->ep_intr = ep_intr;
1616     }
1617   else if (dev_fd != -1) /* Device transport. */
1618     {
1619       (*handle)->idev = NULL;
1620       (*handle)->dev_fd = dev_fd;
1621       (*handle)->id_vendor = 0;  /* Magic vendor for special transport. */
1622       (*handle)->id_product = ifc_no; /* Transport type */
1623       prepare_special_transport (*handle);
1624     }
1625   else
1626     {
1627       assert (!"no transport"); /* Bug. */
1628     }
1629
1630   DEBUGOUT_2 ("using CCID reader %d (ID=%s)\n",  readerno, rid );
1631
1632   if (idev)
1633     {
1634       if (parse_ccid_descriptor (*handle, ifcdesc_extra, ifcdesc_extra_len))
1635         {
1636           DEBUGOUT ("device not supported\n");
1637           rc = CCID_DRIVER_ERR_NO_READER;
1638           goto leave;
1639         }
1640
1641       rc = usb_claim_interface (idev, ifc_no);
1642       if (rc)
1643         {
1644           DEBUGOUT_1 ("usb_claim_interface failed: %d\n", rc);
1645           rc = CCID_DRIVER_ERR_CARD_IO_ERROR;
1646           goto leave;
1647         }
1648     }
1649
1650   rc = ccid_vendor_specific_init (*handle);
1651
1652  leave:
1653   free (ifcdesc_extra);
1654   if (rc)
1655     {
1656       free (rid);
1657       if (idev)
1658         usb_close (idev);
1659       if (dev_fd != -1)
1660         close (dev_fd);
1661       free (*handle);
1662       *handle = NULL;
1663     }
1664
1665   return rc;
1666 }
1667
1668
1669 static void
1670 do_close_reader (ccid_driver_t handle)
1671 {
1672   int rc;
1673   unsigned char msg[100];
1674   size_t msglen;
1675   unsigned char seqno;
1676
1677   if (!handle->powered_off)
1678     {
1679       msg[0] = PC_to_RDR_IccPowerOff;
1680       msg[5] = 0; /* slot */
1681       msg[6] = seqno = handle->seqno++;
1682       msg[7] = 0; /* RFU */
1683       msg[8] = 0; /* RFU */
1684       msg[9] = 0; /* RFU */
1685       set_msg_len (msg, 0);
1686       msglen = 10;
1687
1688       rc = bulk_out (handle, msg, msglen, 0);
1689       if (!rc)
1690         bulk_in (handle, msg, sizeof msg, &msglen, RDR_to_PC_SlotStatus,
1691                  seqno, 2000, 0);
1692       handle->powered_off = 1;
1693     }
1694   if (handle->idev)
1695     {
1696       usb_release_interface (handle->idev, handle->ifc_no);
1697       usb_close (handle->idev);
1698       handle->idev = NULL;
1699     }
1700   if (handle->dev_fd != -1)
1701     {
1702       close (handle->dev_fd);
1703       handle->dev_fd = -1;
1704     }
1705 }
1706
1707
1708 /* Reset a reader on HANDLE.  This is useful in case a reader has been
1709    plugged of and inserted at a different port.  By resetting the
1710    handle, the same reader will be get used.  Note, that on error the
1711    handle won't get released.
1712
1713    This does not return an ATR, so ccid_get_atr should be called right
1714    after this one.
1715 */
1716 int
1717 ccid_shutdown_reader (ccid_driver_t handle)
1718 {
1719   int rc = 0;
1720   struct usb_device *dev = NULL;
1721   usb_dev_handle *idev = NULL;
1722   unsigned char *ifcdesc_extra = NULL;
1723   size_t ifcdesc_extra_len;
1724   int ifc_no, ep_bulk_out, ep_bulk_in, ep_intr;
1725
1726   if (!handle || !handle->rid)
1727     return CCID_DRIVER_ERR_INV_VALUE;
1728
1729   do_close_reader (handle);
1730
1731   if (scan_or_find_devices (-1, handle->rid, NULL, &dev,
1732                             &ifcdesc_extra, &ifcdesc_extra_len,
1733                             &ifc_no, &ep_bulk_out, &ep_bulk_in, &ep_intr,
1734                             &idev, NULL) || !idev)
1735     {
1736       DEBUGOUT_1 ("no CCID reader with ID %s\n", handle->rid);
1737       return CCID_DRIVER_ERR_NO_READER;
1738     }
1739
1740   if (idev)
1741     {
1742       handle->idev = idev;
1743       handle->ifc_no = ifc_no;
1744       handle->ep_bulk_out = ep_bulk_out;
1745       handle->ep_bulk_in = ep_bulk_in;
1746       handle->ep_intr = ep_intr;
1747
1748       if (parse_ccid_descriptor (handle, ifcdesc_extra, ifcdesc_extra_len))
1749         {
1750           DEBUGOUT ("device not supported\n");
1751           rc = CCID_DRIVER_ERR_NO_READER;
1752           goto leave;
1753         }
1754
1755       rc = usb_claim_interface (idev, ifc_no);
1756       if (rc)
1757         {
1758           DEBUGOUT_1 ("usb_claim_interface failed: %d\n", rc);
1759           rc = CCID_DRIVER_ERR_CARD_IO_ERROR;
1760           goto leave;
1761         }
1762     }
1763
1764  leave:
1765   free (ifcdesc_extra);
1766   if (rc)
1767     {
1768       if (handle->idev)
1769         usb_close (handle->idev);
1770       handle->idev = NULL;
1771       if (handle->dev_fd != -1)
1772         close (handle->dev_fd);
1773       handle->dev_fd = -1;
1774     }
1775
1776   return rc;
1777
1778 }
1779
1780
1781 int
1782 ccid_set_progress_cb (ccid_driver_t handle,
1783                       void (*cb)(void *, const char *, int, int, int),
1784                       void *cb_arg)
1785 {
1786   if (!handle || !handle->rid)
1787     return CCID_DRIVER_ERR_INV_VALUE;
1788
1789   handle->progress_cb = cb;
1790   handle->progress_cb_arg = cb_arg;
1791   return 0;
1792 }
1793
1794
1795 /* Close the reader HANDLE. */
1796 int
1797 ccid_close_reader (ccid_driver_t handle)
1798 {
1799   if (!handle || (!handle->idev && handle->dev_fd == -1))
1800     return 0;
1801
1802   do_close_reader (handle);
1803   free (handle->rid);
1804   free (handle);
1805   return 0;
1806 }
1807
1808
1809 /* Return False if a card is present and powered. */
1810 int
1811 ccid_check_card_presence (ccid_driver_t handle)
1812 {
1813   (void)handle;  /* Not yet implemented.  */
1814   return -1;
1815 }
1816
1817
1818 /* Write NBYTES of BUF to file descriptor FD. */
1819 static int
1820 writen (int fd, const void *buf, size_t nbytes)
1821 {
1822   size_t nleft = nbytes;
1823   int nwritten;
1824
1825   while (nleft > 0)
1826     {
1827       nwritten = write (fd, buf, nleft);
1828       if (nwritten < 0)
1829         {
1830           if (errno == EINTR)
1831             nwritten = 0;
1832           else
1833             return -1;
1834         }
1835       nleft -= nwritten;
1836       buf = (const char*)buf + nwritten;
1837     }
1838
1839   return 0;
1840 }
1841
1842
1843 /* Write a MSG of length MSGLEN to the designated bulk out endpoint.
1844    Returns 0 on success. */
1845 static int
1846 bulk_out (ccid_driver_t handle, unsigned char *msg, size_t msglen,
1847           int no_debug)
1848 {
1849   int rc;
1850
1851   /* No need to continue and clutter the log with USB write error
1852      messages after we got the first ENODEV.  */
1853   if (handle->enodev_seen)
1854     return CCID_DRIVER_ERR_NO_READER;
1855
1856   if (debug_level && (!no_debug || debug_level >= 3))
1857     {
1858       switch (msglen? msg[0]:0)
1859         {
1860         case PC_to_RDR_IccPowerOn:
1861           print_p2r_iccpoweron (msg, msglen);
1862           break;
1863         case PC_to_RDR_IccPowerOff:
1864           print_p2r_iccpoweroff (msg, msglen);
1865           break;
1866         case PC_to_RDR_GetSlotStatus:
1867           print_p2r_getslotstatus (msg, msglen);
1868           break;
1869         case PC_to_RDR_XfrBlock:
1870           print_p2r_xfrblock (msg, msglen);
1871           break;
1872         case PC_to_RDR_GetParameters:
1873           print_p2r_getparameters (msg, msglen);
1874           break;
1875         case PC_to_RDR_ResetParameters:
1876           print_p2r_resetparameters (msg, msglen);
1877           break;
1878         case PC_to_RDR_SetParameters:
1879           print_p2r_setparameters (msg, msglen);
1880           break;
1881         case PC_to_RDR_Escape:
1882           print_p2r_escape (msg, msglen);
1883           break;
1884         case PC_to_RDR_IccClock:
1885           print_p2r_iccclock (msg, msglen);
1886           break;
1887         case PC_to_RDR_T0APDU:
1888           print_p2r_to0apdu (msg, msglen);
1889           break;
1890         case PC_to_RDR_Secure:
1891           print_p2r_secure (msg, msglen);
1892           break;
1893         case PC_to_RDR_Mechanical:
1894           print_p2r_mechanical (msg, msglen);
1895           break;
1896         case PC_to_RDR_Abort:
1897           print_p2r_abort (msg, msglen);
1898           break;
1899         case PC_to_RDR_SetDataRate:
1900           print_p2r_setdatarate (msg, msglen);
1901           break;
1902         default:
1903           print_p2r_unknown (msg, msglen);
1904           break;
1905         }
1906     }
1907
1908   if (handle->idev)
1909     {
1910       rc = usb_bulk_write (handle->idev,
1911                            handle->ep_bulk_out,
1912                            (char*)msg, msglen,
1913                            5000 /* ms timeout */);
1914       if (rc == msglen)
1915         return 0;
1916 #ifdef ENODEV
1917       if (rc == -(ENODEV))
1918         {
1919           /* The Linux libusb returns a negative error value.  Catch
1920              the most important one.  */
1921           errno = ENODEV;
1922           rc = -1;
1923         }
1924 #endif /*ENODEV*/
1925
1926       if (rc == -1)
1927         {
1928           DEBUGOUT_1 ("usb_bulk_write error: %s\n", strerror (errno));
1929 #ifdef ENODEV
1930           if (errno == ENODEV)
1931             {
1932               handle->enodev_seen = 1;
1933               return CCID_DRIVER_ERR_NO_READER;
1934             }
1935 #endif /*ENODEV*/
1936         }
1937       else
1938         DEBUGOUT_1 ("usb_bulk_write failed: %d\n", rc);
1939     }
1940   else
1941     {
1942       rc = writen (handle->dev_fd, msg, msglen);
1943       if (!rc)
1944         return 0;
1945       DEBUGOUT_2 ("writen to %d failed: %s\n",
1946                   handle->dev_fd, strerror (errno));
1947
1948     }
1949   return CCID_DRIVER_ERR_CARD_IO_ERROR;
1950 }
1951
1952
1953 /* Read a maximum of LENGTH bytes from the bulk in endpoint into
1954    BUFFER and return the actual read number if bytes in NREAD. SEQNO
1955    is the sequence number used to send the request and EXPECTED_TYPE
1956    the type of message we expect. Does checks on the ccid
1957    header. TIMEOUT is the timeout value in ms. NO_DEBUG may be set to
1958    avoid debug messages in case of no error; this can be overriden
1959    with a glibal debug level of at least 3. Returns 0 on success. */
1960 static int
1961 bulk_in (ccid_driver_t handle, unsigned char *buffer, size_t length,
1962          size_t *nread, int expected_type, int seqno, int timeout,
1963          int no_debug)
1964 {
1965   int rc;
1966   size_t msglen;
1967   int eagain_retries = 0;
1968
1969   /* Fixme: The next line for the current Valgrind without support
1970      for USB IOCTLs. */
1971   memset (buffer, 0, length);
1972  retry:
1973   if (handle->idev)
1974     {
1975       rc = usb_bulk_read (handle->idev,
1976                           handle->ep_bulk_in,
1977                           (char*)buffer, length,
1978                           timeout);
1979       if (rc < 0)
1980         {
1981           rc = errno;
1982           DEBUGOUT_1 ("usb_bulk_read error: %s\n", strerror (rc));
1983           if (rc == EAGAIN && eagain_retries++ < 3)
1984             {
1985               my_sleep (1);
1986               goto retry;
1987             }
1988           return CCID_DRIVER_ERR_CARD_IO_ERROR;
1989         }
1990       *nread = msglen = rc;
1991     }
1992   else
1993     {
1994       rc = read (handle->dev_fd, buffer, length);
1995       if (rc < 0)
1996         {
1997           rc = errno;
1998           DEBUGOUT_2 ("read from %d failed: %s\n",
1999                       handle->dev_fd, strerror (rc));
2000           if (rc == EAGAIN && eagain_retries++ < 5)
2001             {
2002               my_sleep (1);
2003               goto retry;
2004             }
2005           return CCID_DRIVER_ERR_CARD_IO_ERROR;
2006         }
2007       *nread = msglen = rc;
2008     }
2009   eagain_retries = 0;
2010
2011   if (msglen < 10)
2012     {
2013       DEBUGOUT_1 ("bulk-in msg too short (%u)\n", (unsigned int)msglen);
2014       abort_cmd (handle, seqno);
2015       return CCID_DRIVER_ERR_INV_VALUE;
2016     }
2017   if (buffer[5] != 0)
2018     {
2019       DEBUGOUT_1 ("unexpected bulk-in slot (%d)\n", buffer[5]);
2020       return CCID_DRIVER_ERR_INV_VALUE;
2021     }
2022   if (buffer[6] != seqno)
2023     {
2024       DEBUGOUT_2 ("bulk-in seqno does not match (%d/%d)\n",
2025                   seqno, buffer[6]);
2026       /* Retry until we are synced again.  */
2027       goto retry;
2028     }
2029
2030   /* We need to handle the time extension request before we check that
2031      we got the expected message type.  This is in particular required
2032      for the Cherry keyboard which sends a time extension request for
2033      each key hit.  */
2034   if ( !(buffer[7] & 0x03) && (buffer[7] & 0xC0) == 0x80)
2035     {
2036       /* Card present and active, time extension requested. */
2037       DEBUGOUT_2 ("time extension requested (%02X,%02X)\n",
2038                   buffer[7], buffer[8]);
2039       goto retry;
2040     }
2041
2042   if (buffer[0] != expected_type)
2043     {
2044       DEBUGOUT_1 ("unexpected bulk-in msg type (%02x)\n", buffer[0]);
2045       abort_cmd (handle, seqno);
2046       return CCID_DRIVER_ERR_INV_VALUE;
2047     }
2048
2049   if (debug_level && (!no_debug || debug_level >= 3))
2050     {
2051       switch (buffer[0])
2052         {
2053         case RDR_to_PC_DataBlock:
2054           print_r2p_datablock (buffer, msglen);
2055           break;
2056         case RDR_to_PC_SlotStatus:
2057           print_r2p_slotstatus (buffer, msglen);
2058           break;
2059         case RDR_to_PC_Parameters:
2060           print_r2p_parameters (buffer, msglen);
2061           break;
2062         case RDR_to_PC_Escape:
2063           print_r2p_escape (buffer, msglen);
2064           break;
2065         case RDR_to_PC_DataRate:
2066           print_r2p_datarate (buffer, msglen);
2067           break;
2068         default:
2069           print_r2p_unknown (buffer, msglen);
2070           break;
2071         }
2072     }
2073   if (CCID_COMMAND_FAILED (buffer))
2074     print_command_failed (buffer);
2075
2076   /* Check whether a card is at all available.  Note: If you add new
2077      error codes here, check whether they need to be ignored in
2078      send_escape_cmd. */
2079   switch ((buffer[7] & 0x03))
2080     {
2081     case 0: /* no error */ break;
2082     case 1: return CCID_DRIVER_ERR_CARD_INACTIVE;
2083     case 2: return CCID_DRIVER_ERR_NO_CARD;
2084     case 3: /* RFU */ break;
2085     }
2086   return 0;
2087 }
2088
2089
2090
2091 /* Send an abort sequence and wait until everything settled.  */
2092 static int
2093 abort_cmd (ccid_driver_t handle, int seqno)
2094 {
2095   int rc;
2096   char dummybuf[8];
2097   unsigned char msg[100];
2098   size_t msglen;
2099
2100   if (!handle->idev)
2101     {
2102       /* I don't know how to send an abort to non-USB devices.  */
2103       rc = CCID_DRIVER_ERR_NOT_SUPPORTED;
2104     }
2105
2106   seqno &= 0xff;
2107   DEBUGOUT_1 ("sending abort sequence for seqno %d\n", seqno);
2108   /* Send the abort command to the control pipe.  Note that we don't
2109      need to keep track of sent abort commands because there should
2110      never be another thread using the same slot concurrently.  */
2111   rc = usb_control_msg (handle->idev,
2112                         0x21,/* bmRequestType: host-to-device,
2113                                 class specific, to interface.  */
2114                         1,   /* ABORT */
2115                         (seqno << 8 | 0 /* slot */),
2116                         handle->ifc_no,
2117                         dummybuf, 0,
2118                         1000 /* ms timeout */);
2119   if (rc < 0)
2120     {
2121       DEBUGOUT_1 ("usb_control_msg error: %s\n", strerror (errno));
2122       return CCID_DRIVER_ERR_CARD_IO_ERROR;
2123     }
2124
2125   /* Now send the abort command to the bulk out pipe using the same
2126      SEQNO and SLOT.  Do this in a loop to so that all seqno are
2127      tried.  */
2128   seqno--;  /* Adjust for next increment.  */
2129   do
2130     {
2131       seqno++;
2132       msg[0] = PC_to_RDR_Abort;
2133       msg[5] = 0; /* slot */
2134       msg[6] = seqno;
2135       msg[7] = 0; /* RFU */
2136       msg[8] = 0; /* RFU */
2137       msg[9] = 0; /* RFU */
2138       msglen = 10;
2139       set_msg_len (msg, 0);
2140
2141       rc = usb_bulk_write (handle->idev,
2142                            handle->ep_bulk_out,
2143                            (char*)msg, msglen,
2144                            5000 /* ms timeout */);
2145       if (rc == msglen)
2146         rc = 0;
2147       else if (rc == -1)
2148         DEBUGOUT_1 ("usb_bulk_write error in abort_cmd: %s\n",
2149                     strerror (errno));
2150       else
2151         DEBUGOUT_1 ("usb_bulk_write failed in abort_cmd: %d\n", rc);
2152
2153       if (rc)
2154         return rc;
2155
2156       rc = usb_bulk_read (handle->idev,
2157                           handle->ep_bulk_in,
2158                           (char*)msg, sizeof msg,
2159                           5000 /*ms timeout*/);
2160       if (rc < 0)
2161         {
2162           DEBUGOUT_1 ("usb_bulk_read error in abort_cmd: %s\n",
2163                       strerror (errno));
2164           return CCID_DRIVER_ERR_CARD_IO_ERROR;
2165         }
2166       msglen = rc;
2167
2168       if (msglen < 10)
2169         {
2170           DEBUGOUT_1 ("bulk-in msg in abort_cmd too short (%u)\n",
2171                       (unsigned int)msglen);
2172           return CCID_DRIVER_ERR_INV_VALUE;
2173         }
2174       if (msg[5] != 0)
2175         {
2176           DEBUGOUT_1 ("unexpected bulk-in slot (%d) in abort_cmd\n", msg[5]);
2177           return CCID_DRIVER_ERR_INV_VALUE;
2178         }
2179
2180       DEBUGOUT_3 ("status: %02X  error: %02X  octet[9]: %02X\n",
2181                   msg[7], msg[8], msg[9]);
2182       if (CCID_COMMAND_FAILED (msg))
2183         print_command_failed (msg);
2184     }
2185   while (msg[0] != RDR_to_PC_SlotStatus && msg[5] != 0 && msg[6] != seqno);
2186
2187   handle->seqno = ((seqno + 1) & 0xff);
2188   DEBUGOUT ("sending abort sequence succeeded\n");
2189
2190   return 0;
2191 }
2192
2193
2194 /* Note that this function won't return the error codes NO_CARD or
2195    CARD_INACTIVE.  IF RESULT is not NULL, the result from the
2196    operation will get returned in RESULT and its length in RESULTLEN.
2197    If the response is larger than RESULTMAX, an error is returned and
2198    the required buffer length returned in RESULTLEN.  */
2199 static int
2200 send_escape_cmd (ccid_driver_t handle,
2201                  const unsigned char *data, size_t datalen,
2202                  unsigned char *result, size_t resultmax, size_t *resultlen)
2203 {
2204   int rc;
2205   unsigned char msg[100];
2206   size_t msglen;
2207   unsigned char seqno;
2208
2209   if (resultlen)
2210     *resultlen = 0;
2211
2212   if (datalen > sizeof msg - 10)
2213     return CCID_DRIVER_ERR_INV_VALUE; /* Escape data too large.  */
2214
2215   msg[0] = PC_to_RDR_Escape;
2216   msg[5] = 0; /* slot */
2217   msg[6] = seqno = handle->seqno++;
2218   msg[7] = 0; /* RFU */
2219   msg[8] = 0; /* RFU */
2220   msg[9] = 0; /* RFU */
2221   memcpy (msg+10, data, datalen);
2222   msglen = 10 + datalen;
2223   set_msg_len (msg, datalen);
2224
2225   rc = bulk_out (handle, msg, msglen, 0);
2226   if (rc)
2227     return rc;
2228   rc = bulk_in (handle, msg, sizeof msg, &msglen, RDR_to_PC_Escape,
2229                 seqno, 5000, 0);
2230   if (result)
2231     switch (rc)
2232       {
2233         /* We need to ignore certain errorcode here. */
2234       case 0:
2235       case CCID_DRIVER_ERR_CARD_INACTIVE:
2236       case CCID_DRIVER_ERR_NO_CARD:
2237         {
2238           if (msglen > resultmax)
2239             rc = CCID_DRIVER_ERR_INV_VALUE; /* Response too large. */
2240           else
2241             {
2242               memcpy (result, msg, msglen);
2243               *resultlen = msglen;
2244               rc = 0;
2245             }
2246         }
2247         break;
2248       default:
2249         break;
2250       }
2251
2252   return rc;
2253 }
2254
2255
2256 int
2257 ccid_transceive_escape (ccid_driver_t handle,
2258                         const unsigned char *data, size_t datalen,
2259                         unsigned char *resp, size_t maxresplen, size_t *nresp)
2260 {
2261   return send_escape_cmd (handle, data, datalen, resp, maxresplen, nresp);
2262 }
2263
2264
2265
2266 /* experimental */
2267 int
2268 ccid_poll (ccid_driver_t handle)
2269 {
2270   int rc;
2271   unsigned char msg[10];
2272   size_t msglen;
2273   int i, j;
2274
2275   if (handle->idev)
2276     {
2277       rc = usb_bulk_read (handle->idev,
2278                           handle->ep_intr,
2279                           (char*)msg, sizeof msg,
2280                           0 /* ms timeout */ );
2281       if (rc < 0 && errno == ETIMEDOUT)
2282         return 0;
2283     }
2284   else
2285     return 0;
2286
2287   if (rc < 0)
2288     {
2289       DEBUGOUT_1 ("usb_intr_read error: %s\n", strerror (errno));
2290       return CCID_DRIVER_ERR_CARD_IO_ERROR;
2291     }
2292
2293   msglen = rc;
2294   rc = 0;
2295
2296   if (msglen < 1)
2297     {
2298       DEBUGOUT ("intr-in msg too short\n");
2299       return CCID_DRIVER_ERR_INV_VALUE;
2300     }
2301
2302   if (msg[0] == RDR_to_PC_NotifySlotChange)
2303     {
2304       DEBUGOUT ("notify slot change:");
2305       for (i=1; i < msglen; i++)
2306         for (j=0; j < 4; j++)
2307           DEBUGOUT_CONT_3 (" %d:%c%c",
2308                            (i-1)*4+j,
2309                            (msg[i] & (1<<(j*2)))? 'p':'-',
2310                            (msg[i] & (2<<(j*2)))? '*':' ');
2311       DEBUGOUT_LF ();
2312     }
2313   else if (msg[0] == RDR_to_PC_HardwareError)
2314     {
2315       DEBUGOUT ("hardware error occured\n");
2316     }
2317   else
2318     {
2319       DEBUGOUT_1 ("unknown intr-in msg of type %02X\n", msg[0]);
2320     }
2321
2322   return 0;
2323 }
2324
2325
2326 /* Note that this function won't return the error codes NO_CARD or
2327    CARD_INACTIVE */
2328 int
2329 ccid_slot_status (ccid_driver_t handle, int *statusbits)
2330 {
2331   int rc;
2332   unsigned char msg[100];
2333   size_t msglen;
2334   unsigned char seqno;
2335   int retries = 0;
2336
2337  retry:
2338   msg[0] = PC_to_RDR_GetSlotStatus;
2339   msg[5] = 0; /* slot */
2340   msg[6] = seqno = handle->seqno++;
2341   msg[7] = 0; /* RFU */
2342   msg[8] = 0; /* RFU */
2343   msg[9] = 0; /* RFU */
2344   set_msg_len (msg, 0);
2345
2346   rc = bulk_out (handle, msg, 10, 1);
2347   if (rc)
2348     return rc;
2349   /* Note that we set the NO_DEBUG flag here, so that the logs won't
2350      get cluttered up by a ticker function checking for the slot
2351      status and debugging enabled. */
2352   rc = bulk_in (handle, msg, sizeof msg, &msglen, RDR_to_PC_SlotStatus,
2353                 seqno, retries? 1000 : 200, 1);
2354   if (rc == CCID_DRIVER_ERR_CARD_IO_ERROR && retries < 3)
2355     {
2356       if (!retries)
2357         {
2358           DEBUGOUT ("USB: CALLING USB_CLEAR_HALT\n");
2359           usb_clear_halt (handle->idev, handle->ep_bulk_in);
2360           usb_clear_halt (handle->idev, handle->ep_bulk_out);
2361         }
2362       else
2363           DEBUGOUT ("USB: RETRYING bulk_in AGAIN\n");
2364       retries++;
2365       goto retry;
2366     }
2367   if (rc && rc != CCID_DRIVER_ERR_NO_CARD
2368       && rc != CCID_DRIVER_ERR_CARD_INACTIVE)
2369     return rc;
2370   *statusbits = (msg[7] & 3);
2371
2372   return 0;
2373 }
2374
2375
2376 /* Parse ATR string (of ATRLEN) and update parameters at PARAM.
2377    Calling this routine, it should prepare default values at PARAM
2378    beforehand.  This routine assumes that card is accessed by T=1
2379    protocol.  It doesn't analyze historical bytes at all.
2380
2381    Returns < 0 value on error:
2382      -1 for parse error or integrity check error
2383      -2 for card doesn't support T=1 protocol
2384      -3 for parameters are nod explicitly defined by ATR
2385      -4 for this driver doesn't support CRC
2386
2387    Returns >= 0 on success:
2388       0 for card is negotiable mode
2389       1 for card is specific mode (and not negotiable)
2390  */
2391 static int
2392 update_param_by_atr (unsigned char *param, unsigned char *atr, size_t atrlen)
2393 {
2394   int i = -1;
2395   int t, y, chk;
2396   int historical_bytes_num, negotiable = 1;
2397
2398 #define NEXTBYTE() do { i++; if (atrlen <= i) return -1; } while (0)
2399
2400   NEXTBYTE ();
2401
2402   if (atr[i] == 0x3F)
2403     param[1] |= 0x02;           /* Convention is inverse.  */
2404   NEXTBYTE ();
2405
2406   y = (atr[i] >> 4);
2407   historical_bytes_num = atr[i] & 0x0f;
2408   NEXTBYTE ();
2409
2410   if ((y & 1))
2411     {
2412       param[0] = atr[i];        /* TA1 - Fi & Di */
2413       NEXTBYTE ();
2414     }
2415
2416   if ((y & 2))
2417     NEXTBYTE ();                /* TB1 - ignore */
2418
2419   if ((y & 4))
2420     {
2421       param[2] = atr[i];        /* TC1 - Guard Time */
2422       NEXTBYTE ();
2423     }
2424
2425   if ((y & 8))
2426     {
2427       y = (atr[i] >> 4);        /* TD1 */
2428       t = atr[i] & 0x0f;
2429       NEXTBYTE ();
2430
2431       if ((y & 1))
2432         {                       /* TA2 - PPS mode */
2433           if ((atr[i] & 0x0f) != 1)
2434             return -2;          /* Wrong card protocol (!= 1).  */
2435
2436           if ((atr[i] & 0x10) != 0x10)
2437             return -3; /* Transmission parameters are implicitly defined. */
2438
2439           negotiable = 0;       /* TA2 means specific mode.  */
2440           NEXTBYTE ();
2441         }
2442
2443       if ((y & 2))
2444         NEXTBYTE ();            /* TB2 - ignore */
2445
2446       if ((y & 4))
2447         NEXTBYTE ();            /* TC2 - ignore */
2448
2449       if ((y & 8))
2450         {
2451           y = (atr[i] >> 4);    /* TD2 */
2452           t = atr[i] & 0x0f;
2453           NEXTBYTE ();
2454         }
2455       else
2456         y = 0;
2457
2458       while (y)
2459         {
2460           if ((y & 1))
2461             {                   /* TAx */
2462               if (t == 1)
2463                 param[5] = atr[i]; /* IFSC */
2464               else if (t == 15)
2465                 /* XXX: check voltage? */
2466                 param[4] = (atr[i] >> 6); /* ClockStop */
2467
2468               NEXTBYTE ();
2469             }
2470
2471           if ((y & 2))
2472             {
2473               if (t == 1)
2474                 param[3] = atr[i]; /* TBx - BWI & CWI */
2475               NEXTBYTE ();
2476             }
2477
2478           if ((y & 4))
2479             {
2480               if (t == 1)
2481                 param[1] |= (atr[i] & 0x01); /* TCx - LRC/CRC */
2482               NEXTBYTE ();
2483
2484               if (param[1] & 0x01)
2485                 return -4;      /* CRC not supported yet.  */
2486             }
2487
2488           if ((y & 8))
2489             {
2490               y = (atr[i] >> 4); /* TDx */
2491               t = atr[i] & 0x0f;
2492               NEXTBYTE ();
2493             }
2494           else
2495             y = 0;
2496         }
2497     }
2498
2499   i += historical_bytes_num - 1;
2500   NEXTBYTE ();
2501   if (atrlen != i+1)
2502     return -1;
2503
2504 #undef NEXTBYTE
2505
2506   chk = 0;
2507   do
2508     {
2509       chk ^= atr[i];
2510       i--;
2511     }
2512   while (i > 0);
2513
2514   if (chk != 0)
2515     return -1;
2516
2517   return negotiable;
2518 }
2519
2520
2521 /* Return the ATR of the card.  This is not a cached value and thus an
2522    actual reset is done.  */
2523 int
2524 ccid_get_atr (ccid_driver_t handle,
2525               unsigned char *atr, size_t maxatrlen, size_t *atrlen)
2526 {
2527   int rc;
2528   int statusbits;
2529   unsigned char msg[100];
2530   unsigned char *tpdu;
2531   size_t msglen, tpdulen;
2532   unsigned char seqno;
2533   int use_crc = 0;
2534   unsigned int edc;
2535   int tried_iso = 0;
2536   int got_param;
2537   unsigned char param[7] = { /* For Protocol T=1 */
2538     0x11, /* bmFindexDindex */
2539     0x10, /* bmTCCKST1 */
2540     0x00, /* bGuardTimeT1 */
2541     0x4d, /* bmWaitingIntegersT1 */
2542     0x00, /* bClockStop */
2543     0x20, /* bIFSC */
2544     0x00  /* bNadValue */
2545   };
2546
2547   /* First check whether a card is available.  */
2548   rc = ccid_slot_status (handle, &statusbits);
2549   if (rc)
2550     return rc;
2551   if (statusbits == 2)
2552     return CCID_DRIVER_ERR_NO_CARD;
2553
2554   /* For an inactive and also for an active card, issue the PowerOn
2555      command to get the ATR.  */
2556  again:
2557   msg[0] = PC_to_RDR_IccPowerOn;
2558   msg[5] = 0; /* slot */
2559   msg[6] = seqno = handle->seqno++;
2560   /* power select (0=auto, 1=5V, 2=3V, 3=1.8V) */
2561   msg[7] = handle->auto_voltage ? 0 : 1;
2562   msg[8] = 0; /* RFU */
2563   msg[9] = 0; /* RFU */
2564   set_msg_len (msg, 0);
2565   msglen = 10;
2566
2567   rc = bulk_out (handle, msg, msglen, 0);
2568   if (rc)
2569     return rc;
2570   rc = bulk_in (handle, msg, sizeof msg, &msglen, RDR_to_PC_DataBlock,
2571                 seqno, 5000, 0);
2572   if (rc)
2573     return rc;
2574   if (!tried_iso && CCID_COMMAND_FAILED (msg) && CCID_ERROR_CODE (msg) == 0xbb
2575       && ((handle->id_vendor == VENDOR_CHERRY
2576            && handle->id_product == 0x0005)
2577           || (handle->id_vendor == VENDOR_GEMPC
2578               && handle->id_product == 0x4433)
2579           ))
2580     {
2581       tried_iso = 1;
2582       /* Try switching to ISO mode. */
2583       if (!send_escape_cmd (handle, (const unsigned char*)"\xF1\x01", 2,
2584                             NULL, 0, NULL))
2585         goto again;
2586     }
2587   else if (CCID_COMMAND_FAILED (msg))
2588     return CCID_DRIVER_ERR_CARD_IO_ERROR;
2589
2590
2591   handle->powered_off = 0;
2592
2593   if (atr)
2594     {
2595       size_t n = msglen - 10;
2596
2597       if (n > maxatrlen)
2598         n = maxatrlen;
2599       memcpy (atr, msg+10, n);
2600       *atrlen = n;
2601     }
2602
2603   param[6] = handle->nonnull_nad? ((1 << 4) | 0): 0;
2604   rc = update_param_by_atr (param, msg+10, msglen - 10);
2605   if (rc < 0)
2606     {
2607       DEBUGOUT_1 ("update_param_by_atr failed: %d\n", rc);
2608       return CCID_DRIVER_ERR_CARD_IO_ERROR;
2609     }
2610
2611   got_param = 0;
2612
2613   if (handle->auto_param)
2614     {
2615       msg[0] = PC_to_RDR_GetParameters;
2616       msg[5] = 0; /* slot */
2617       msg[6] = seqno = handle->seqno++;
2618       msg[7] = 0; /* RFU */
2619       msg[8] = 0; /* RFU */
2620       msg[9] = 0; /* RFU */
2621       set_msg_len (msg, 0);
2622       msglen = 10;
2623       rc = bulk_out (handle, msg, msglen, 0);
2624       if (!rc)
2625         rc = bulk_in (handle, msg, sizeof msg, &msglen, RDR_to_PC_Parameters,
2626                       seqno, 2000, 0);
2627       if (rc)
2628         DEBUGOUT ("GetParameters failed\n");
2629       else if (msglen == 17 && msg[9] == 1)
2630         got_param = 1;
2631     }
2632   else if (handle->auto_pps)
2633     ;
2634   else if (rc == 1)             /* It's negotiable, send PPS.  */
2635     {
2636       msg[0] = PC_to_RDR_XfrBlock;
2637       msg[5] = 0; /* slot */
2638       msg[6] = seqno = handle->seqno++;
2639       msg[7] = 0;
2640       msg[8] = 0;
2641       msg[9] = 0;
2642       msg[10] = 0xff;           /* PPSS */
2643       msg[11] = 0x11;           /* PPS0: PPS1, Protocol T=1 */
2644       msg[12] = param[0];       /* PPS1: Fi / Di */
2645       msg[13] = 0xff ^ 0x11 ^ param[0]; /* PCK */
2646       set_msg_len (msg, 4);
2647       msglen = 10 + 4;
2648
2649       rc = bulk_out (handle, msg, msglen, 0);
2650       if (rc)
2651         return rc;
2652
2653       rc = bulk_in (handle, msg, sizeof msg, &msglen, RDR_to_PC_DataBlock,
2654                     seqno, 5000, 0);
2655       if (rc)
2656         return rc;
2657
2658       if (msglen != 10 + 4)
2659         {
2660           DEBUGOUT_1 ("Setting PPS failed: %zu\n", msglen);
2661           return CCID_DRIVER_ERR_CARD_IO_ERROR;
2662         }
2663
2664       if (msg[10] != 0xff || msg[11] != 0x11 || msg[12] != param[0])
2665         {
2666           DEBUGOUT_1 ("Setting PPS failed: 0x%02x\n", param[0]);
2667           return CCID_DRIVER_ERR_CARD_IO_ERROR;
2668         }
2669     }
2670
2671   /* Setup parameters to select T=1. */
2672   msg[0] = PC_to_RDR_SetParameters;
2673   msg[5] = 0; /* slot */
2674   msg[6] = seqno = handle->seqno++;
2675   msg[7] = 1; /* Select T=1. */
2676   msg[8] = 0; /* RFU */
2677   msg[9] = 0; /* RFU */
2678
2679   if (!got_param)
2680     memcpy (&msg[10], param, 7);
2681   set_msg_len (msg, 7);
2682   msglen = 10 + 7;
2683
2684   rc = bulk_out (handle, msg, msglen, 0);
2685   if (rc)
2686     return rc;
2687   rc = bulk_in (handle, msg, sizeof msg, &msglen, RDR_to_PC_Parameters,
2688                 seqno, 5000, 0);
2689   if (rc)
2690     DEBUGOUT ("SetParameters failed (ignored)\n");
2691
2692   if (!rc && msglen > 15 && msg[15] >= 16 && msg[15] <= 254 )
2693     handle->ifsc = msg[15];
2694   else
2695     handle->ifsc = 128; /* Something went wrong, assume 128 bytes.  */
2696
2697   if (handle->nonnull_nad && msglen > 16 && msg[16] == 0)
2698     {
2699       DEBUGOUT ("Use Null-NAD, clearing handle->nonnull_nad.\n");
2700       handle->nonnull_nad = 0;
2701     }
2702
2703   handle->t1_ns = 0;
2704   handle->t1_nr = 0;
2705
2706   /* Send an S-Block with our maximum IFSD to the CCID.  */
2707   if (!handle->apdu_level && !handle->auto_ifsd)
2708     {
2709       tpdu = msg+10;
2710       /* NAD: DAD=1, SAD=0 */
2711       tpdu[0] = handle->nonnull_nad? ((1 << 4) | 0): 0;
2712       tpdu[1] = (0xc0 | 0 | 1); /* S-block request: change IFSD */
2713       tpdu[2] = 1;
2714       tpdu[3] = handle->max_ifsd? handle->max_ifsd : 32;
2715       tpdulen = 4;
2716       edc = compute_edc (tpdu, tpdulen, use_crc);
2717       if (use_crc)
2718         tpdu[tpdulen++] = (edc >> 8);
2719       tpdu[tpdulen++] = edc;
2720
2721       msg[0] = PC_to_RDR_XfrBlock;
2722       msg[5] = 0; /* slot */
2723       msg[6] = seqno = handle->seqno++;
2724       msg[7] = 0;
2725       msg[8] = 0; /* RFU */
2726       msg[9] = 0; /* RFU */
2727       set_msg_len (msg, tpdulen);
2728       msglen = 10 + tpdulen;
2729
2730       if (debug_level > 1)
2731         DEBUGOUT_3 ("T=1: put %c-block seq=%d%s\n",
2732                       ((msg[11] & 0xc0) == 0x80)? 'R' :
2733                                 (msg[11] & 0x80)? 'S' : 'I',
2734                       ((msg[11] & 0x80)? !!(msg[11]& 0x10)
2735                                        : !!(msg[11] & 0x40)),
2736                     (!(msg[11] & 0x80) && (msg[11] & 0x20)? " [more]":""));
2737
2738       rc = bulk_out (handle, msg, msglen, 0);
2739       if (rc)
2740         return rc;
2741
2742
2743       rc = bulk_in (handle, msg, sizeof msg, &msglen,
2744                     RDR_to_PC_DataBlock, seqno, 5000, 0);
2745       if (rc)
2746         return rc;
2747
2748       tpdu = msg + 10;
2749       tpdulen = msglen - 10;
2750
2751       if (tpdulen < 4)
2752         return CCID_DRIVER_ERR_ABORTED;
2753
2754       if (debug_level > 1)
2755         DEBUGOUT_4 ("T=1: got %c-block seq=%d err=%d%s\n",
2756                     ((msg[11] & 0xc0) == 0x80)? 'R' :
2757                               (msg[11] & 0x80)? 'S' : 'I',
2758                     ((msg[11] & 0x80)? !!(msg[11]& 0x10)
2759                                      : !!(msg[11] & 0x40)),
2760                     ((msg[11] & 0xc0) == 0x80)? (msg[11] & 0x0f) : 0,
2761                     (!(msg[11] & 0x80) && (msg[11] & 0x20)? " [more]":""));
2762
2763       if ((tpdu[1] & 0xe0) != 0xe0 || tpdu[2] != 1)
2764         {
2765           DEBUGOUT ("invalid response for S-block (Change-IFSD)\n");
2766           return -1;
2767         }
2768       DEBUGOUT_1 ("IFSD has been set to %d\n", tpdu[3]);
2769     }
2770
2771   return 0;
2772 }
2773
2774
2775 \f
2776
2777 static unsigned int
2778 compute_edc (const unsigned char *data, size_t datalen, int use_crc)
2779 {
2780   if (use_crc)
2781     {
2782       return 0x42; /* Not yet implemented. */
2783     }
2784   else
2785     {
2786       unsigned char crc = 0;
2787
2788       for (; datalen; datalen--)
2789         crc ^= *data++;
2790       return crc;
2791     }
2792 }
2793
2794
2795 /* Return true if APDU is an extended length one.  */
2796 static int
2797 is_exlen_apdu (const unsigned char *apdu, size_t apdulen)
2798 {
2799   if (apdulen < 7 || apdu[4])
2800     return 0;  /* Too short or no Z byte.  */
2801   return 1;
2802 }
2803
2804
2805 /* Helper for ccid_transceive used for APDU level exchanges.  */
2806 static int
2807 ccid_transceive_apdu_level (ccid_driver_t handle,
2808                             const unsigned char *apdu_buf, size_t apdu_len,
2809                             unsigned char *resp, size_t maxresplen,
2810                             size_t *nresp)
2811 {
2812   int rc;
2813   unsigned char msg[CCID_MAX_BUF];
2814   const unsigned char *apdu_p;
2815   size_t apdu_part_len;
2816   size_t msglen;
2817   unsigned char seqno;
2818   int bwi = 4;
2819   unsigned char chain = 0;
2820
2821   if (apdu_len == 0 || apdu_len > sizeof (msg) - 10)
2822     return CCID_DRIVER_ERR_INV_VALUE; /* Invalid length. */
2823
2824   apdu_p = apdu_buf;
2825   while (1)
2826     {
2827       apdu_part_len = apdu_len;
2828       if (apdu_part_len > handle->max_ccid_msglen - 10)
2829         {
2830           apdu_part_len = handle->max_ccid_msglen - 10;
2831           chain |= 0x01;
2832         }
2833
2834       msg[0] = PC_to_RDR_XfrBlock;
2835       msg[5] = 0; /* slot */
2836       msg[6] = seqno = handle->seqno++;
2837       msg[7] = bwi;
2838       msg[8] = chain;
2839       msg[9] = 0;
2840       memcpy (msg+10, apdu_p, apdu_part_len);
2841       set_msg_len (msg, apdu_part_len);
2842       msglen = 10 + apdu_part_len;
2843
2844       rc = bulk_out (handle, msg, msglen, 0);
2845       if (rc)
2846         return rc;
2847
2848       apdu_p += apdu_part_len;
2849       apdu_len -= apdu_part_len;
2850
2851       rc = bulk_in (handle, msg, sizeof msg, &msglen,
2852                     RDR_to_PC_DataBlock, seqno, CCID_CMD_TIMEOUT, 0);
2853       if (rc)
2854         return rc;
2855
2856       if (!(chain & 0x01))
2857         break;
2858
2859       chain = 0x02;
2860     }
2861
2862   apdu_len = 0;
2863   while (1)
2864     {
2865       apdu_part_len = msglen - 10;
2866       if (resp && apdu_len + apdu_part_len <= maxresplen)
2867         memcpy (resp + apdu_len, msg+10, apdu_part_len);
2868       apdu_len += apdu_part_len;
2869
2870       if (!(msg[9] & 0x01))
2871         break;
2872
2873       msg[0] = PC_to_RDR_XfrBlock;
2874       msg[5] = 0; /* slot */
2875       msg[6] = seqno = handle->seqno++;
2876       msg[7] = bwi;
2877       msg[8] = 0x10;                /* Request next data block */
2878       msg[9] = 0;
2879       set_msg_len (msg, 0);
2880       msglen = 10;
2881
2882       rc = bulk_out (handle, msg, msglen, 0);
2883       if (rc)
2884         return rc;
2885
2886       rc = bulk_in (handle, msg, sizeof msg, &msglen,
2887                     RDR_to_PC_DataBlock, seqno, CCID_CMD_TIMEOUT, 0);
2888       if (rc)
2889         return rc;
2890     }
2891
2892   if (resp)
2893     {
2894       if (apdu_len > maxresplen)
2895         {
2896           DEBUGOUT_2 ("provided buffer too short for received data "
2897                       "(%u/%u)\n",
2898                       (unsigned int)apdu_len, (unsigned int)maxresplen);
2899           return CCID_DRIVER_ERR_INV_VALUE;
2900         }
2901
2902       *nresp = apdu_len;
2903     }
2904
2905   return 0;
2906 }
2907
2908
2909
2910 /*
2911   Protocol T=1 overview
2912
2913   Block Structure:
2914            Prologue Field:
2915    1 byte     Node Address (NAD)
2916    1 byte     Protocol Control Byte (PCB)
2917    1 byte     Length (LEN)
2918            Information Field:
2919    0-254 byte APDU or Control Information (INF)
2920            Epilogue Field:
2921    1 byte     Error Detection Code (EDC)
2922
2923   NAD:
2924    bit 7     unused
2925    bit 4..6  Destination Node Address (DAD)
2926    bit 3     unused
2927    bit 2..0  Source Node Address (SAD)
2928
2929    If node adresses are not used, SAD and DAD should be set to 0 on
2930    the first block sent to the card.  If they are used they should
2931    have different values (0 for one is okay); that first block sets up
2932    the addresses of the nodes.
2933
2934   PCB:
2935    Information Block (I-Block):
2936       bit 7    0
2937       bit 6    Sequence number (yep, that is modulo 2)
2938       bit 5    Chaining flag
2939       bit 4..0 reserved
2940    Received-Ready Block (R-Block):
2941       bit 7    1
2942       bit 6    0
2943       bit 5    0
2944       bit 4    Sequence number
2945       bit 3..0  0 = no error
2946                 1 = EDC or parity error
2947                 2 = other error
2948                 other values are reserved
2949    Supervisory Block (S-Block):
2950       bit 7    1
2951       bit 6    1
2952       bit 5    clear=request,set=response
2953       bit 4..0  0 = resyncronisation request
2954                 1 = information field size request
2955                 2 = abort request
2956                 3 = extension of BWT request
2957                 4 = VPP error
2958                 other values are reserved
2959
2960 */
2961
2962 int
2963 ccid_transceive (ccid_driver_t handle,
2964                  const unsigned char *apdu_buf, size_t apdu_buflen,
2965                  unsigned char *resp, size_t maxresplen, size_t *nresp)
2966 {
2967   int rc;
2968   /* The size of the buffer used to be 10+259.  For the via_escape
2969      hack we need one extra byte, thus 11+259.  */
2970   unsigned char send_buffer[11+259], recv_buffer[11+259];
2971   const unsigned char *apdu;
2972   size_t apdulen;
2973   unsigned char *msg, *tpdu, *p;
2974   size_t msglen, tpdulen, last_tpdulen, n;
2975   unsigned char seqno;
2976   unsigned int edc;
2977   int use_crc = 0;
2978   int hdrlen, pcboff;
2979   size_t dummy_nresp;
2980   int via_escape = 0;
2981   int next_chunk = 1;
2982   int sending = 1;
2983   int retries = 0;
2984   int resyncing = 0;
2985   int nad_byte;
2986
2987   if (!nresp)
2988     nresp = &dummy_nresp;
2989   *nresp = 0;
2990
2991   /* Smarter readers allow to send APDUs directly; divert here. */
2992   if (handle->apdu_level)
2993     {
2994       /* We employ a hack for Omnikey readers which are able to send
2995          TPDUs using an escape sequence.  There is no documentation
2996          but the Windows driver does it this way.  Tested using a
2997          CM6121.  This method works also for the Cherry XX44
2998          keyboards; however there are problems with the
2999          ccid_tranceive_secure which leads to a loss of sync on the
3000          CCID level.  If Cherry wants to make their keyboard work
3001          again, they should hand over some docs. */
3002       if ((handle->id_vendor == VENDOR_OMNIKEY
3003            || (!handle->idev && handle->id_product == TRANSPORT_CM4040))
3004           && handle->apdu_level < 2
3005           && is_exlen_apdu (apdu_buf, apdu_buflen))
3006         via_escape = 1;
3007       else
3008         return ccid_transceive_apdu_level (handle, apdu_buf, apdu_buflen,
3009                                            resp, maxresplen, nresp);
3010     }
3011
3012   /* The other readers we support require sending TPDUs.  */
3013
3014   tpdulen = 0; /* Avoid compiler warning about no initialization. */
3015   msg = send_buffer;
3016   hdrlen = via_escape? 11 : 10;
3017
3018   /* NAD: DAD=1, SAD=0 */
3019   nad_byte = handle->nonnull_nad? ((1 << 4) | 0): 0;
3020   if (via_escape)
3021     nad_byte = 0;
3022
3023   last_tpdulen = 0;  /* Avoid gcc warning (controlled by RESYNCING). */
3024   for (;;)
3025     {
3026       if (next_chunk)
3027         {
3028           next_chunk = 0;
3029
3030           apdu = apdu_buf;
3031           apdulen = apdu_buflen;
3032           assert (apdulen);
3033
3034           /* Construct an I-Block. */
3035           tpdu = msg + hdrlen;
3036           tpdu[0] = nad_byte;
3037           tpdu[1] = ((handle->t1_ns & 1) << 6); /* I-block */
3038           if (apdulen > handle->ifsc )
3039             {
3040               apdulen = handle->ifsc;
3041               apdu_buf += handle->ifsc;
3042               apdu_buflen -= handle->ifsc;
3043               tpdu[1] |= (1 << 5); /* Set more bit. */
3044             }
3045           tpdu[2] = apdulen;
3046           memcpy (tpdu+3, apdu, apdulen);
3047           tpdulen = 3 + apdulen;
3048           edc = compute_edc (tpdu, tpdulen, use_crc);
3049           if (use_crc)
3050             tpdu[tpdulen++] = (edc >> 8);
3051           tpdu[tpdulen++] = edc;
3052         }
3053
3054       if (via_escape)
3055         {
3056           msg[0] = PC_to_RDR_Escape;
3057           msg[5] = 0; /* slot */
3058           msg[6] = seqno = handle->seqno++;
3059           msg[7] = 0; /* RFU */
3060           msg[8] = 0; /* RFU */
3061           msg[9] = 0; /* RFU */
3062           msg[10] = 0x1a; /* Omnikey command to send a TPDU.  */
3063           set_msg_len (msg, 1 + tpdulen);
3064         }
3065       else
3066         {
3067           msg[0] = PC_to_RDR_XfrBlock;
3068           msg[5] = 0; /* slot */
3069           msg[6] = seqno = handle->seqno++;
3070           msg[7] = 4; /* bBWI */
3071           msg[8] = 0; /* RFU */
3072           msg[9] = 0; /* RFU */
3073           set_msg_len (msg, tpdulen);
3074         }
3075       msglen = hdrlen + tpdulen;
3076       if (!resyncing)
3077         last_tpdulen = tpdulen;
3078       pcboff = hdrlen+1;
3079
3080       if (debug_level > 1)
3081         DEBUGOUT_3 ("T=1: put %c-block seq=%d%s\n",
3082                     ((msg[pcboff] & 0xc0) == 0x80)? 'R' :
3083                     (msg[pcboff] & 0x80)? 'S' : 'I',
3084                     ((msg[pcboff] & 0x80)? !!(msg[pcboff]& 0x10)
3085                      : !!(msg[pcboff] & 0x40)),
3086                     (!(msg[pcboff] & 0x80) && (msg[pcboff] & 0x20)?
3087                      " [more]":""));
3088
3089       rc = bulk_out (handle, msg, msglen, 0);
3090       if (rc)
3091         return rc;
3092
3093       msg = recv_buffer;
3094       rc = bulk_in (handle, msg, sizeof recv_buffer, &msglen,
3095                     via_escape? RDR_to_PC_Escape : RDR_to_PC_DataBlock,
3096                     seqno, CCID_CMD_TIMEOUT, 0);
3097       if (rc)
3098         return rc;
3099
3100       tpdu = msg + hdrlen;
3101       tpdulen = msglen - hdrlen;
3102       resyncing = 0;
3103
3104       if (tpdulen < 4)
3105         {
3106           usb_clear_halt (handle->idev, handle->ep_bulk_in);
3107           return CCID_DRIVER_ERR_ABORTED;
3108         }
3109
3110       if (debug_level > 1)
3111         DEBUGOUT_4 ("T=1: got %c-block seq=%d err=%d%s\n",
3112                     ((msg[pcboff] & 0xc0) == 0x80)? 'R' :
3113                               (msg[pcboff] & 0x80)? 'S' : 'I',
3114                     ((msg[pcboff] & 0x80)? !!(msg[pcboff]& 0x10)
3115                      : !!(msg[pcboff] & 0x40)),
3116                     ((msg[pcboff] & 0xc0) == 0x80)? (msg[pcboff] & 0x0f) : 0,
3117                     (!(msg[pcboff] & 0x80) && (msg[pcboff] & 0x20)?
3118                      " [more]":""));
3119
3120       if (!(tpdu[1] & 0x80))
3121         { /* This is an I-block. */
3122           retries = 0;
3123           if (sending)
3124             { /* last block sent was successful. */
3125               handle->t1_ns ^= 1;
3126               sending = 0;
3127             }
3128
3129           if (!!(tpdu[1] & 0x40) != handle->t1_nr)
3130             { /* Reponse does not match our sequence number. */
3131               msg = send_buffer;
3132               tpdu = msg + hdrlen;
3133               tpdu[0] = nad_byte;
3134               tpdu[1] = (0x80 | (handle->t1_nr & 1) << 4 | 2); /* R-block */
3135               tpdu[2] = 0;
3136               tpdulen = 3;
3137               edc = compute_edc (tpdu, tpdulen, use_crc);
3138               if (use_crc)
3139                 tpdu[tpdulen++] = (edc >> 8);
3140               tpdu[tpdulen++] = edc;
3141
3142               continue;
3143             }
3144
3145           handle->t1_nr ^= 1;
3146
3147           p = tpdu + 3; /* Skip the prologue field. */
3148           n = tpdulen - 3 - 1; /* Strip the epilogue field. */
3149           /* fixme: verify the checksum. */
3150           if (resp)
3151             {
3152               if (n > maxresplen)
3153                 {
3154                   DEBUGOUT_2 ("provided buffer too short for received data "
3155                               "(%u/%u)\n",
3156                               (unsigned int)n, (unsigned int)maxresplen);
3157                   return CCID_DRIVER_ERR_INV_VALUE;
3158                 }
3159
3160               memcpy (resp, p, n);
3161               resp += n;
3162               *nresp += n;
3163               maxresplen -= n;
3164             }
3165
3166           if (!(tpdu[1] & 0x20))
3167             return 0; /* No chaining requested - ready. */
3168
3169           msg = send_buffer;
3170           tpdu = msg + hdrlen;
3171           tpdu[0] = nad_byte;
3172           tpdu[1] = (0x80 | (handle->t1_nr & 1) << 4); /* R-block */
3173           tpdu[2] = 0;
3174           tpdulen = 3;
3175           edc = compute_edc (tpdu, tpdulen, use_crc);
3176           if (use_crc)
3177             tpdu[tpdulen++] = (edc >> 8);
3178           tpdu[tpdulen++] = edc;
3179         }
3180       else if ((tpdu[1] & 0xc0) == 0x80)
3181         { /* This is a R-block. */
3182           if ( (tpdu[1] & 0x0f))
3183             {
3184               retries++;
3185               if (via_escape && retries == 1 && (msg[pcboff] & 0x0f))
3186                 {
3187                   /* Error probably due to switching to TPDU.  Send a
3188                      resync request.  We use the recv_buffer so that
3189                      we don't corrupt the send_buffer.  */
3190                   msg = recv_buffer;
3191                   tpdu = msg + hdrlen;
3192                   tpdu[0] = nad_byte;
3193                   tpdu[1] = 0xc0; /* S-block resync request. */
3194                   tpdu[2] = 0;
3195                   tpdulen = 3;
3196                   edc = compute_edc (tpdu, tpdulen, use_crc);
3197                   if (use_crc)
3198                     tpdu[tpdulen++] = (edc >> 8);
3199                   tpdu[tpdulen++] = edc;
3200                   resyncing = 1;
3201                   DEBUGOUT ("T=1: requesting resync\n");
3202                 }
3203               else if (retries > 3)
3204                 {
3205                   DEBUGOUT ("T=1: 3 failed retries\n");
3206                   return CCID_DRIVER_ERR_CARD_IO_ERROR;
3207                 }
3208               else
3209                 {
3210                   /* Error: repeat last block */
3211                   msg = send_buffer;
3212                   tpdulen = last_tpdulen;
3213                 }
3214             }
3215           else if (sending && !!(tpdu[1] & 0x10) == handle->t1_ns)
3216             { /* Response does not match our sequence number. */
3217               DEBUGOUT ("R-block with wrong seqno received on more bit\n");
3218               return CCID_DRIVER_ERR_CARD_IO_ERROR;
3219             }
3220           else if (sending)
3221             { /* Send next chunk. */
3222               retries = 0;
3223               msg = send_buffer;
3224               next_chunk = 1;
3225               handle->t1_ns ^= 1;
3226             }
3227           else
3228             {
3229               DEBUGOUT ("unexpected ACK R-block received\n");
3230               return CCID_DRIVER_ERR_CARD_IO_ERROR;
3231             }
3232         }
3233       else
3234         { /* This is a S-block. */
3235           retries = 0;
3236           DEBUGOUT_2 ("T=1: S-block %s received cmd=%d\n",
3237                       (tpdu[1] & 0x20)? "response": "request",
3238                       (tpdu[1] & 0x1f));
3239           if ( !(tpdu[1] & 0x20) && (tpdu[1] & 0x1f) == 1 && tpdu[2] == 1)
3240             {
3241               /* Information field size request.  */
3242               unsigned char ifsc = tpdu[3];
3243
3244               if (ifsc < 16 || ifsc > 254)
3245                 return CCID_DRIVER_ERR_CARD_IO_ERROR;
3246
3247               msg = send_buffer;
3248               tpdu = msg + hdrlen;
3249               tpdu[0] = nad_byte;
3250               tpdu[1] = (0xc0 | 0x20 | 1); /* S-block response */
3251               tpdu[2] = 1;
3252               tpdu[3] = ifsc;
3253               tpdulen = 4;
3254               edc = compute_edc (tpdu, tpdulen, use_crc);
3255               if (use_crc)
3256                 tpdu[tpdulen++] = (edc >> 8);
3257               tpdu[tpdulen++] = edc;
3258               DEBUGOUT_1 ("T=1: requesting an ifsc=%d\n", ifsc);
3259             }
3260           else if ( !(tpdu[1] & 0x20) && (tpdu[1] & 0x1f) == 3 && tpdu[2])
3261             {
3262               /* Wait time extension request. */
3263               unsigned char bwi = tpdu[3];
3264               msg = send_buffer;
3265               tpdu = msg + hdrlen;
3266               tpdu[0] = nad_byte;
3267               tpdu[1] = (0xc0 | 0x20 | 3); /* S-block response */
3268               tpdu[2] = 1;
3269               tpdu[3] = bwi;
3270               tpdulen = 4;
3271               edc = compute_edc (tpdu, tpdulen, use_crc);
3272               if (use_crc)
3273                 tpdu[tpdulen++] = (edc >> 8);
3274               tpdu[tpdulen++] = edc;
3275               DEBUGOUT_1 ("T=1: waittime extension of bwi=%d\n", bwi);
3276               print_progress (handle);
3277             }
3278           else if ( (tpdu[1] & 0x20) && (tpdu[1] & 0x1f) == 0 && !tpdu[2])
3279             {
3280               DEBUGOUT ("T=1: resync ack from reader\n");
3281               /* Repeat previous block.  */
3282               msg = send_buffer;
3283               tpdulen = last_tpdulen;
3284             }
3285           else
3286             return CCID_DRIVER_ERR_CARD_IO_ERROR;
3287         }
3288     } /* end T=1 protocol loop. */
3289
3290   return 0;
3291 }
3292
3293
3294 /* Send the CCID Secure command to the reader.  APDU_BUF should
3295    contain the APDU template.  PIN_MODE defines how the pin gets
3296    formatted:
3297
3298      1 := The PIN is ASCII encoded and of variable length.  The
3299           length of the PIN entered will be put into Lc by the reader.
3300           The APDU should me made up of 4 bytes without Lc.
3301
3302    PINLEN_MIN and PINLEN_MAX define the limits for the pin length. 0
3303    may be used t enable reasonable defaults.
3304
3305    When called with RESP and NRESP set to NULL, the function will
3306    merely check whether the reader supports the secure command for the
3307    given APDU and PIN_MODE. */
3308 int
3309 ccid_transceive_secure (ccid_driver_t handle,
3310                         const unsigned char *apdu_buf, size_t apdu_buflen,
3311                         pininfo_t *pininfo,
3312                         unsigned char *resp, size_t maxresplen, size_t *nresp)
3313 {
3314   int rc;
3315   unsigned char send_buffer[10+259], recv_buffer[10+259];
3316   unsigned char *msg, *tpdu, *p;
3317   size_t msglen, tpdulen, n;
3318   unsigned char seqno;
3319   size_t dummy_nresp;
3320   int testmode;
3321   int cherry_mode = 0;
3322   int add_zero = 0;
3323   int enable_varlen = 0;
3324
3325   testmode = !resp && !nresp;
3326
3327   if (!nresp)
3328     nresp = &dummy_nresp;
3329   *nresp = 0;
3330
3331   if (apdu_buflen >= 4 && apdu_buf[1] == 0x20 && (handle->has_pinpad & 1))
3332     ;
3333   else if (apdu_buflen >= 4 && apdu_buf[1] == 0x24 && (handle->has_pinpad & 2))
3334     ;
3335   else
3336     return CCID_DRIVER_ERR_NO_PINPAD;
3337
3338   if (!pininfo->minlen)
3339     pininfo->minlen = 1;
3340   if (!pininfo->maxlen)
3341     pininfo->maxlen = 15;
3342
3343   /* Note that the 25 is the maximum value the SPR532 allows.  */
3344   if (pininfo->minlen < 1 || pininfo->minlen > 25
3345       || pininfo->maxlen < 1 || pininfo->maxlen > 25
3346       || pininfo->minlen > pininfo->maxlen)
3347     return CCID_DRIVER_ERR_INV_VALUE;
3348
3349   /* We have only tested a few readers so better don't risk anything
3350      and do not allow the use with other readers. */
3351   switch (handle->id_vendor)
3352     {
3353     case VENDOR_SCM:  /* Tested with SPR 532. */
3354     case VENDOR_KAAN: /* Tested with KAAN Advanced (1.02). */
3355     case VENDOR_FSIJ: /* Tested with Gnuk (0.21). */
3356       pininfo->maxlen = 25;
3357       enable_varlen = 1;
3358       break;
3359     case VENDOR_REINER:/* Tested with cyberJack go */
3360     case VENDOR_VASCO: /* Tested with DIGIPASS 920 */
3361       enable_varlen = 1;
3362       break;
3363     case VENDOR_CHERRY:
3364       pininfo->maxlen = 15;
3365       enable_varlen = 1;
3366       /* The CHERRY XX44 keyboard echos an asterisk for each entered
3367          character on the keyboard channel.  We use a special variant
3368          of PC_to_RDR_Secure which directs these characters to the
3369          smart card's bulk-in channel.  We also need to append a zero
3370          Lc byte to the APDU.  It seems that it will be replaced with
3371          the actual length instead of being appended before the APDU
3372          is send to the card. */
3373       add_zero = 1;
3374       if (handle->id_product != CHERRY_ST2000)
3375         cherry_mode = 1;
3376       break;
3377     default:
3378       if ((handle->id_vendor == VENDOR_GEMPC &&
3379            handle->id_product == GEMPC_PINPAD)
3380           || (handle->id_vendor == VENDOR_VEGA &&
3381               handle->id_product == VEGA_ALPHA))
3382         {
3383           enable_varlen = 0;
3384           pininfo->minlen = 4;
3385           pininfo->maxlen = 8;
3386           break;
3387         }
3388      return CCID_DRIVER_ERR_NOT_SUPPORTED;
3389     }
3390
3391   if (enable_varlen)
3392     pininfo->fixedlen = 0;
3393
3394   if (testmode)
3395     return 0; /* Success */
3396
3397   if (pininfo->fixedlen < 0 || pininfo->fixedlen >= 16)
3398     return CCID_DRIVER_ERR_NOT_SUPPORTED;
3399
3400   msg = send_buffer;
3401   if (handle->id_vendor == VENDOR_SCM)
3402     {
3403       DEBUGOUT ("sending escape sequence to switch to a case 1 APDU\n");
3404       rc = send_escape_cmd (handle, (const unsigned char*)"\x80\x02\x00", 3,
3405                             NULL, 0, NULL);
3406       if (rc)
3407         return rc;
3408     }
3409
3410   msg[0] = cherry_mode? 0x89 : PC_to_RDR_Secure;
3411   msg[5] = 0; /* slot */
3412   msg[6] = seqno = handle->seqno++;
3413   msg[7] = 0; /* bBWI */
3414   msg[8] = 0; /* RFU */
3415   msg[9] = 0; /* RFU */
3416   msg[10] = apdu_buf[1] == 0x20 ? 0 : 1;
3417                /* Perform PIN verification or PIN modification. */
3418   msg[11] = 0; /* Timeout in seconds. */
3419   msg[12] = 0x82; /* bmFormatString: Byte, pos=0, left, ASCII. */
3420   if (handle->id_vendor == VENDOR_SCM)
3421     {
3422       /* For the SPR532 the next 2 bytes need to be zero.  We do this
3423          for all SCM products.  Kudos to Martin Paljak for this
3424          hint.  */
3425       msg[13] = msg[14] = 0;
3426     }
3427   else
3428     {
3429       msg[13] = pininfo->fixedlen; /* bmPINBlockString:
3430                                       0 bits of pin length to insert.
3431                                       PIN block size by fixedlen.  */
3432       msg[14] = 0x00; /* bmPINLengthFormat:
3433                          Units are bytes, position is 0. */
3434     }
3435
3436   msglen = 15;
3437   if (apdu_buf[1] == 0x24)
3438     {
3439       msg[msglen++] = 0;    /* bInsertionOffsetOld */
3440       msg[msglen++] = pininfo->fixedlen;    /* bInsertionOffsetNew */
3441     }
3442
3443   /* The following is a little endian word. */
3444   msg[msglen++] = pininfo->maxlen;   /* wPINMaxExtraDigit-Maximum.  */
3445   msg[msglen++] = pininfo->minlen;   /* wPINMaxExtraDigit-Minimum.  */
3446
3447   if (apdu_buf[1] == 0x24)
3448     msg[msglen++] = apdu_buf[2] == 0 ? 0x03 : 0x01;
3449               /* bConfirmPIN
3450                *    0x00: new PIN once
3451                *    0x01: new PIN twice (confirmation)
3452                *    0x02: old PIN and new PIN once
3453                *    0x03: old PIN and new PIN twice (confirmation)
3454                */
3455
3456   msg[msglen] = 0x02; /* bEntryValidationCondition:
3457                          Validation key pressed */
3458   if (pininfo->minlen && pininfo->maxlen && pininfo->minlen == pininfo->maxlen)
3459     msg[msglen] |= 0x01; /* Max size reached.  */
3460   msglen++;
3461
3462   if (apdu_buf[1] == 0x20)
3463     msg[msglen++] = 0x01; /* bNumberMessage. */
3464   else
3465     msg[msglen++] = 0x03; /* bNumberMessage. */
3466
3467   msg[msglen++] = 0x09; /* wLangId-Low:  English FIXME: use the first entry. */
3468   msg[msglen++] = 0x04; /* wLangId-High. */
3469
3470   if (apdu_buf[1] == 0x20)
3471     msg[msglen++] = 0;    /* bMsgIndex. */
3472   else
3473     {
3474       msg[msglen++] = 0;    /* bMsgIndex1. */
3475       msg[msglen++] = 1;    /* bMsgIndex2. */
3476       msg[msglen++] = 2;    /* bMsgIndex3. */
3477     }
3478
3479   /* Calculate Lc.  */
3480   n = pininfo->fixedlen;
3481   if (apdu_buf[1] == 0x24)
3482     n += pininfo->fixedlen;
3483
3484   /* bTeoProlog follows: */
3485   msg[msglen++] = handle->nonnull_nad? ((1 << 4) | 0): 0;
3486   msg[msglen++] = ((handle->t1_ns & 1) << 6); /* I-block */
3487   if (n)
3488     msg[msglen++] = n + 5; /* apdulen should be filled for fixed length.  */
3489   else
3490     msg[msglen++] = 0; /* The apdulen will be filled in by the reader.  */
3491   /* APDU follows:  */
3492   msg[msglen++] = apdu_buf[0]; /* CLA */
3493   msg[msglen++] = apdu_buf[1]; /* INS */
3494   msg[msglen++] = apdu_buf[2]; /* P1 */
3495   msg[msglen++] = apdu_buf[3]; /* P2 */
3496   if (add_zero)
3497     msg[msglen++] = 0;
3498   else if (pininfo->fixedlen != 0)
3499     {
3500       msg[msglen++] = n;
3501       memset (&msg[msglen], 0xff, n);
3502       msglen += n;
3503     }
3504   /* An EDC is not required. */
3505   set_msg_len (msg, msglen - 10);
3506
3507   rc = bulk_out (handle, msg, msglen, 0);
3508   if (rc)
3509     return rc;
3510
3511   msg = recv_buffer;
3512   rc = bulk_in (handle, msg, sizeof recv_buffer, &msglen,
3513                 RDR_to_PC_DataBlock, seqno, 30000, 0);
3514   if (rc)
3515     return rc;
3516
3517   tpdu = msg + 10;
3518   tpdulen = msglen - 10;
3519
3520   if (handle->apdu_level)
3521     {
3522       if (resp)
3523         {
3524           if (tpdulen > maxresplen)
3525             {
3526               DEBUGOUT_2 ("provided buffer too short for received data "
3527                           "(%u/%u)\n",
3528                           (unsigned int)tpdulen, (unsigned int)maxresplen);
3529               return CCID_DRIVER_ERR_INV_VALUE;
3530             }
3531
3532           memcpy (resp, tpdu, tpdulen);