pcsc-lite  1.8.13
reader.h
Go to the documentation of this file.
1 /*
2  * MUSCLE SmartCard Development ( http://pcsclite.alioth.debian.org/pcsclite.html )
3  *
4  * Copyright (C) 1999-2005
5  * David Corcoran <corcoran@musclecard.com>
6  * Copyright (C) 2005-2009
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  * $Id: reader.h 7004 2014-10-02 09:26:36Z rousseau $
33  */
34 
40 #ifndef __reader_h__
41 #define __reader_h__
42 
43 /*
44  * Tags for requesting card and reader attributes
45  */
46 
47 #define SCARD_ATTR_VALUE(Class, Tag) ((((ULONG)(Class)) << 16) | ((ULONG)(Tag)))
48 
49 #define SCARD_CLASS_VENDOR_INFO 1
50 #define SCARD_CLASS_COMMUNICATIONS 2
51 #define SCARD_CLASS_PROTOCOL 3
52 #define SCARD_CLASS_POWER_MGMT 4
53 #define SCARD_CLASS_SECURITY 5
54 #define SCARD_CLASS_MECHANICAL 6
55 #define SCARD_CLASS_VENDOR_DEFINED 7
56 #define SCARD_CLASS_IFD_PROTOCOL 8
57 #define SCARD_CLASS_ICC_STATE 9
58 #define SCARD_CLASS_SYSTEM 0x7fff
60 #define SCARD_ATTR_VENDOR_NAME SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0100)
61 #define SCARD_ATTR_VENDOR_IFD_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0101)
62 #define SCARD_ATTR_VENDOR_IFD_VERSION SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0102)
63 #define SCARD_ATTR_VENDOR_IFD_SERIAL_NO SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0103)
64 #define SCARD_ATTR_CHANNEL_ID SCARD_ATTR_VALUE(SCARD_CLASS_COMMUNICATIONS, 0x0110)
65 #define SCARD_ATTR_ASYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0120)
66 #define SCARD_ATTR_DEFAULT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0121)
67 #define SCARD_ATTR_MAX_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0122)
68 #define SCARD_ATTR_DEFAULT_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0123)
69 #define SCARD_ATTR_MAX_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0124)
70 #define SCARD_ATTR_MAX_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0125)
71 #define SCARD_ATTR_SYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0126)
72 #define SCARD_ATTR_POWER_MGMT_SUPPORT SCARD_ATTR_VALUE(SCARD_CLASS_POWER_MGMT, 0x0131)
73 #define SCARD_ATTR_USER_TO_CARD_AUTH_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0140)
74 #define SCARD_ATTR_USER_AUTH_INPUT_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0142)
75 #define SCARD_ATTR_CHARACTERISTICS SCARD_ATTR_VALUE(SCARD_CLASS_MECHANICAL, 0x0150)
77 #define SCARD_ATTR_CURRENT_PROTOCOL_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0201)
78 #define SCARD_ATTR_CURRENT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0202)
79 #define SCARD_ATTR_CURRENT_F SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0203)
80 #define SCARD_ATTR_CURRENT_D SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0204)
81 #define SCARD_ATTR_CURRENT_N SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0205)
82 #define SCARD_ATTR_CURRENT_W SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0206)
83 #define SCARD_ATTR_CURRENT_IFSC SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0207)
84 #define SCARD_ATTR_CURRENT_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0208)
85 #define SCARD_ATTR_CURRENT_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0209)
86 #define SCARD_ATTR_CURRENT_CWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020a)
87 #define SCARD_ATTR_CURRENT_EBC_ENCODING SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020b)
88 #define SCARD_ATTR_EXTENDED_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020c)
90 #define SCARD_ATTR_ICC_PRESENCE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0300)
91 #define SCARD_ATTR_ICC_INTERFACE_STATUS SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0301)
92 #define SCARD_ATTR_CURRENT_IO_STATE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0302)
93 #define SCARD_ATTR_ATR_STRING SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0303)
94 #define SCARD_ATTR_ICC_TYPE_PER_ATR SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0304)
96 #define SCARD_ATTR_ESC_RESET SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA000)
97 #define SCARD_ATTR_ESC_CANCEL SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA003)
98 #define SCARD_ATTR_ESC_AUTHREQUEST SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA005)
99 #define SCARD_ATTR_MAXINPUT SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA007)
101 #define SCARD_ATTR_DEVICE_UNIT SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0001)
102 #define SCARD_ATTR_DEVICE_IN_USE SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0002)
103 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0003)
104 #define SCARD_ATTR_DEVICE_SYSTEM_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0004)
105 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0005)
106 #define SCARD_ATTR_DEVICE_SYSTEM_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0006)
107 #define SCARD_ATTR_SUPRESS_T1_IFS_REQUEST SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0007)
109 #ifdef UNICODE
110 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_W
111 #define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_W
112 #else
113 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_A
114 #define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_A
115 #endif
116 
120 #define SCARD_CTL_CODE(code) (0x42000000 + (code))
121 
125 #define CM_IOCTL_GET_FEATURE_REQUEST SCARD_CTL_CODE(3400)
126 
127 #define FEATURE_VERIFY_PIN_START 0x01
128 #define FEATURE_VERIFY_PIN_FINISH 0x02
129 #define FEATURE_MODIFY_PIN_START 0x03
130 #define FEATURE_MODIFY_PIN_FINISH 0x04
131 #define FEATURE_GET_KEY_PRESSED 0x05
132 #define FEATURE_VERIFY_PIN_DIRECT 0x06
133 #define FEATURE_MODIFY_PIN_DIRECT 0x07
134 #define FEATURE_MCT_READER_DIRECT 0x08
135 #define FEATURE_MCT_UNIVERSAL 0x09
136 #define FEATURE_IFD_PIN_PROPERTIES 0x0A
137 #define FEATURE_ABORT 0x0B
138 #define FEATURE_SET_SPE_MESSAGE 0x0C
139 #define FEATURE_VERIFY_PIN_DIRECT_APP_ID 0x0D
140 #define FEATURE_MODIFY_PIN_DIRECT_APP_ID 0x0E
141 #define FEATURE_WRITE_DISPLAY 0x0F
142 #define FEATURE_GET_KEY 0x10
143 #define FEATURE_IFD_DISPLAY_PROPERTIES 0x11
144 #define FEATURE_GET_TLV_PROPERTIES 0x12
145 #define FEATURE_CCID_ESC_COMMAND 0x13
146 #define FEATURE_EXECUTE_PACE 0x20
147 
148 /* structures used (but not defined) in PC/SC Part 10:
149  * "IFDs with Secure Pin Entry Capabilities" */
150 
151 #include <inttypes.h>
152 
153 /* Set structure elements aligment on bytes
154  * http://gcc.gnu.org/onlinedocs/gcc/Structure_002dPacking-Pragmas.html */
155 #if defined(__APPLE__) | defined(sun)
156 #pragma pack(1)
157 #else
158 #pragma pack(push, 1)
159 #endif
160 
162 typedef struct
163 {
164  uint8_t tag;
165  uint8_t length;
166  uint32_t value;
168 
171 #define HOST_TO_CCID_16(x) (x)
172 #define HOST_TO_CCID_32(x) (x)
173 
175 typedef struct
176 {
177  uint8_t bTimerOut;
178  uint8_t bTimerOut2;
179  uint8_t bmFormatString;
187  uint16_t wPINMaxExtraDigit;
191  uint8_t bNumberMessage;
192  uint16_t wLangId;
193  uint8_t bMsgIndex;
194  uint8_t bTeoPrologue[3];
195  uint32_t ulDataLength;
196  uint8_t abData
197 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
198  [] /* valid C99 code */
199 #else
200  [0] /* non-standard, but usually working code */
201 #endif
202  ;
204 
206 typedef struct
207 {
208  uint8_t bTimerOut;
209  uint8_t bTimerOut2;
210  uint8_t bmFormatString;
225  uint8_t bConfirmPIN;
228  uint8_t bNumberMessage;
229  uint16_t wLangId;
230  uint8_t bMsgIndex1;
231  uint8_t bMsgIndex2;
232  uint8_t bMsgIndex3;
233  uint8_t bTeoPrologue[3];
234  uint32_t ulDataLength;
235  uint8_t abData
236 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
237  [] /* valid C99 code */
238 #else
239  [0] /* non-standard, but usually working code */
240 #endif
241  ;
243 
245 typedef struct {
246  uint16_t wLcdLayout;
247  uint8_t bEntryValidationCondition;
248  uint8_t bTimeOut2;
250 
251 /* restore default structure elements alignment */
252 #if defined(__APPLE__) | defined(sun)
253 #pragma pack()
254 #else
255 #pragma pack(pop)
256 #endif
257 
258 /* properties returned by FEATURE_GET_TLV_PROPERTIES */
259 #define PCSCv2_PART10_PROPERTY_wLcdLayout 1
260 #define PCSCv2_PART10_PROPERTY_bEntryValidationCondition 2
261 #define PCSCv2_PART10_PROPERTY_bTimeOut2 3
262 #define PCSCv2_PART10_PROPERTY_wLcdMaxCharacters 4
263 #define PCSCv2_PART10_PROPERTY_wLcdMaxLines 5
264 #define PCSCv2_PART10_PROPERTY_bMinPINSize 6
265 #define PCSCv2_PART10_PROPERTY_bMaxPINSize 7
266 #define PCSCv2_PART10_PROPERTY_sFirmwareID 8
267 #define PCSCv2_PART10_PROPERTY_bPPDUSupport 9
268 #define PCSCv2_PART10_PROPERTY_dwMaxAPDUDataSize 10
269 #define PCSCv2_PART10_PROPERTY_wIdVendor 11
270 #define PCSCv2_PART10_PROPERTY_wIdProduct 12
271 
272 #endif
273 
uint32_t value
This value is always in BIG ENDIAN format as documented in PCSC v2 part 10 ch 2.2 page 2...
Definition: reader.h:166
uint8_t bmFormatString
formatting options
Definition: reader.h:179
uint8_t bmPINBlockString
bits 7-4 bit size of PIN length in APDU, bits 3-0 PIN block size in bytes after justification and for...
Definition: reader.h:180
uint32_t ulDataLength
length of Data to be sent to the ICC
Definition: reader.h:195
the structure must be 6-bytes long
Definition: reader.h:162
uint32_t ulDataLength
length of Data to be sent to the ICC
Definition: reader.h:234
uint8_t bNumberMessage
Number of messages to display for PIN verification.
Definition: reader.h:191
uint8_t bMsgIndex2
index of 2d prompting message
Definition: reader.h:231
uint8_t bTimerOut2
timeout in seconds after first key stroke
Definition: reader.h:178
uint8_t bmFormatString
formatting options
Definition: reader.h:210
uint16_t wPINMaxExtraDigit
0xXXYY where XX is minimum PIN size in digits, and YY is maximum PIN size in digits ...
Definition: reader.h:222
uint8_t bEntryValidationCondition
Conditions under which PIN entry should be considered complete.
Definition: reader.h:226
uint8_t bTimerOut
timeout is seconds (00 means use default timeout)
Definition: reader.h:208
uint8_t bNumberMessage
Number of messages to display for PIN verification.
Definition: reader.h:228
uint8_t bEntryValidationCondition
Conditions under which PIN entry should be considered complete.
Definition: reader.h:189
uint16_t wLangId
Language for messages.
Definition: reader.h:229
uint8_t bTimerOut
timeout is seconds (00 means use default timeout)
Definition: reader.h:177
uint8_t bInsertionOffsetNew
Insertion position offset in bytes for the new PIN.
Definition: reader.h:220
uint8_t bMsgIndex
Message index (should be 00)
Definition: reader.h:193
uint8_t bTimerOut2
timeout in seconds after first key stroke
Definition: reader.h:209
uint16_t wLcdLayout
display characteristics
Definition: reader.h:246
uint8_t bConfirmPIN
Flags governing need for confirmation of new PIN.
Definition: reader.h:225
uint16_t wLangId
Language for messages.
Definition: reader.h:192
uint8_t bmPINLengthFormat
bits 7-5 RFU, bit 4 set if system units are bytes, clear if system units are bits, bits 3-0 PIN length position in system units
Definition: reader.h:183
structure used with FEATURE_IFD_PIN_PROPERTIES
Definition: reader.h:245
structure used with FEATURE_MODIFY_PIN_DIRECT
Definition: reader.h:206
uint8_t bmPINLengthFormat
bits 7-5 RFU, bit 4 set if system units are bytes, clear if system units are bits, bits 3-0 PIN length position in system units
Definition: reader.h:214
uint8_t bMsgIndex3
index of 3d prompting message
Definition: reader.h:232
uint8_t bMsgIndex1
index of 1st prompting message
Definition: reader.h:230
structure used with FEATURE_VERIFY_PIN_DIRECT
Definition: reader.h:175
uint16_t wPINMaxExtraDigit
0xXXYY where XX is minimum PIN size in digits, and YY is maximum PIN size in digits ...
Definition: reader.h:187
uint8_t bmPINBlockString
bits 7-4 bit size of PIN length in APDU, bits 3-0 PIN block size in bytes after justification and for...
Definition: reader.h:211
uint8_t bInsertionOffsetOld
Insertion position offset in bytes for the current PIN.
Definition: reader.h:218