pcsc-lite  1.8.20
prothandler.c
Go to the documentation of this file.
1 /*
2  * MUSCLE SmartCard Development ( http://pcsclite.alioth.debian.org/pcsclite.html )
3  *
4  * Copyright (C) 1999
5  * David Corcoran <corcoran@musclecard.com>
6  * Copyright (C) 2004-2011
7  * Ludovic Rousseau <ludovic.rousseau@free.fr>
8  *
9 Redistribution and use in source and binary forms, with or without
10 modification, are permitted provided that the following conditions
11 are met:
12 
13 1. Redistributions of source code must retain the above copyright
14  notice, this list of conditions and the following disclaimer.
15 2. Redistributions in binary form must reproduce the above copyright
16  notice, this list of conditions and the following disclaimer in the
17  documentation and/or other materials provided with the distribution.
18 3. The name of the author may not be used to endorse or promote products
19  derived from this software without specific prior written permission.
20 
21 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
38 #include "config.h"
39 #include <string.h>
40 
41 #include "misc.h"
42 #include "pcscd.h"
43 #include "debuglog.h"
44 #include "readerfactory.h"
45 #include "prothandler.h"
46 #include "atrhandler.h"
47 #include "ifdwrapper.h"
48 #include "eventhandler.h"
49 
60 DWORD PHSetProtocol(struct ReaderContext * rContext,
61  DWORD dwPreferred, UCHAR ucAvailable, UCHAR ucDefault)
62 {
63  DWORD protocol;
64  LONG rv;
65  UCHAR ucChosen;
66 
67  /* App has specified no protocol */
68  if (dwPreferred == 0)
69  return SET_PROTOCOL_WRONG_ARGUMENT;
70 
71  /* requested protocol is not available */
72  if (! (dwPreferred & ucAvailable))
73  {
74  /* Note:
75  * dwPreferred must be either SCARD_PROTOCOL_T0 or SCARD_PROTOCOL_T1
76  * if dwPreferred == SCARD_PROTOCOL_T0 | SCARD_PROTOCOL_T1 the test
77  * (SCARD_PROTOCOL_T0 == dwPreferred) will not work as expected
78  * and the debug message will not be correct.
79  *
80  * This case may only occur if
81  * dwPreferred == SCARD_PROTOCOL_T0 | SCARD_PROTOCOL_T1
82  * and ucAvailable == 0 since we have (dwPreferred & ucAvailable) == 0
83  * and the case ucAvailable == 0 should never occur (the card is at
84  * least T=0 or T=1)
85  */
86  Log2(PCSC_LOG_ERROR, "Protocol T=%d requested but unsupported by the card",
87  (SCARD_PROTOCOL_T0 == dwPreferred) ? 0 : 1);
88  return SET_PROTOCOL_WRONG_ARGUMENT;
89  }
90 
91  /* set default value */
92  protocol = ucDefault;
93 
94  /* keep only the available protocols */
95  dwPreferred &= ucAvailable;
96 
97  /* we try to use T=1 first */
98  if (dwPreferred & SCARD_PROTOCOL_T1)
99  ucChosen = SCARD_PROTOCOL_T1;
100  else
101  if (dwPreferred & SCARD_PROTOCOL_T0)
102  ucChosen = SCARD_PROTOCOL_T0;
103  else
104  /* App wants unsupported protocol */
105  return SET_PROTOCOL_WRONG_ARGUMENT;
106 
107  Log2(PCSC_LOG_INFO, "Attempting PTS to T=%d",
108  (SCARD_PROTOCOL_T0 == ucChosen ? 0 : 1));
109  rv = IFDSetPTS(rContext, ucChosen, 0x00, 0x00, 0x00, 0x00);
110 
111  if (IFD_SUCCESS == rv)
112  protocol = ucChosen;
113  else
114  if (IFD_NOT_SUPPORTED == rv)
115  Log2(PCSC_LOG_INFO, "PTS not supported by driver, using T=%d",
116  (SCARD_PROTOCOL_T0 == protocol) ? 0 : 1);
117  else
118  if (IFD_PROTOCOL_NOT_SUPPORTED == rv)
119  Log2(PCSC_LOG_INFO, "PTS protocol not supported, using T=%d",
120  (SCARD_PROTOCOL_T0 == protocol) ? 0 : 1);
121  else
122  {
123  Log3(PCSC_LOG_INFO, "PTS failed (%ld), using T=%d", rv,
124  (SCARD_PROTOCOL_T0 == protocol) ? 0 : 1);
125 
126  /* ISO 7816-3:1997 ch. 7.2 PPS protocol page 14
127  * - If the PPS exchange is unsuccessful, then the interface device
128  * shall either reset or reject the card.
129  */
130  return SET_PROTOCOL_PPS_FAILED;
131  }
132 
133  return protocol;
134 }
135 
LONG IFDSetPTS(READER_CONTEXT *rContext, DWORD dwProtocol, UCHAR ucFlags, UCHAR ucPTS1, UCHAR ucPTS2, UCHAR ucPTS3)
Set the protocol type selection (PTS).
Definition: ifdwrapper.c:67
#define IFD_NOT_SUPPORTED
request is not supported
Definition: ifdhandler.h:364
This handles protocol defaults, PTS, etc.
This wraps the dynamic ifdhandler functions.
#define SCARD_PROTOCOL_T1
T=1 active protocol.
Definition: pcsclite.h:242
This keeps track of smart card protocols, timing issues and Answer to Reset ATR handling.
#define SCARD_PROTOCOL_T0
T=0 active protocol.
Definition: pcsclite.h:241
This handles card insertion/removal events, updates ATR, protocol, and status information.
DWORD PHSetProtocol(struct ReaderContext *rContext, DWORD dwPreferred, UCHAR ucAvailable, UCHAR ucDefault)
Determine which protocol to use.
Definition: prothandler.c:60
This keeps a list of defines for pcsc-lite.
This keeps track of a list of currently available reader structures.
#define IFD_PROTOCOL_NOT_SUPPORTED
requested protocol not supported
Definition: ifdhandler.h:357
This handles debugging.
#define IFD_SUCCESS
no error
Definition: ifdhandler.h:351