pcsc-lite  1.8.8
reader.h
Go to the documentation of this file.
1 /*
2  * MUSCLE SmartCard Development ( http://www.linuxnet.com )
3  *
4  * Copyright (C) 1999-2005
5  * David Corcoran <corcoran@linuxnet.com>
6  * Copyright (C) 2005-2009
7  * Ludovic Rousseau <ludovic.rousseau@free.fr>
8  *
9  * $Id: reader.h 6241 2012-03-20 16:42:11Z rousseau $
10  */
11 
17 #ifndef __reader_h__
18 #define __reader_h__
19 
20 /*
21  * Tags for requesting card and reader attributes
22  */
23 
24 #define SCARD_ATTR_VALUE(Class, Tag) ((((ULONG)(Class)) << 16) | ((ULONG)(Tag)))
25 
26 #define SCARD_CLASS_VENDOR_INFO 1
27 #define SCARD_CLASS_COMMUNICATIONS 2
28 #define SCARD_CLASS_PROTOCOL 3
29 #define SCARD_CLASS_POWER_MGMT 4
30 #define SCARD_CLASS_SECURITY 5
31 #define SCARD_CLASS_MECHANICAL 6
32 #define SCARD_CLASS_VENDOR_DEFINED 7
33 #define SCARD_CLASS_IFD_PROTOCOL 8
34 #define SCARD_CLASS_ICC_STATE 9
35 #define SCARD_CLASS_SYSTEM 0x7fff
37 #define SCARD_ATTR_VENDOR_NAME SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0100)
38 #define SCARD_ATTR_VENDOR_IFD_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0101)
39 #define SCARD_ATTR_VENDOR_IFD_VERSION SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0102)
40 #define SCARD_ATTR_VENDOR_IFD_SERIAL_NO SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0103)
41 #define SCARD_ATTR_CHANNEL_ID SCARD_ATTR_VALUE(SCARD_CLASS_COMMUNICATIONS, 0x0110)
42 #define SCARD_ATTR_ASYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0120)
43 #define SCARD_ATTR_DEFAULT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0121)
44 #define SCARD_ATTR_MAX_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0122)
45 #define SCARD_ATTR_DEFAULT_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0123)
46 #define SCARD_ATTR_MAX_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0124)
47 #define SCARD_ATTR_MAX_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0125)
48 #define SCARD_ATTR_SYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0126)
49 #define SCARD_ATTR_POWER_MGMT_SUPPORT SCARD_ATTR_VALUE(SCARD_CLASS_POWER_MGMT, 0x0131)
50 #define SCARD_ATTR_USER_TO_CARD_AUTH_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0140)
51 #define SCARD_ATTR_USER_AUTH_INPUT_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0142)
52 #define SCARD_ATTR_CHARACTERISTICS SCARD_ATTR_VALUE(SCARD_CLASS_MECHANICAL, 0x0150)
54 #define SCARD_ATTR_CURRENT_PROTOCOL_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0201)
55 #define SCARD_ATTR_CURRENT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0202)
56 #define SCARD_ATTR_CURRENT_F SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0203)
57 #define SCARD_ATTR_CURRENT_D SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0204)
58 #define SCARD_ATTR_CURRENT_N SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0205)
59 #define SCARD_ATTR_CURRENT_W SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0206)
60 #define SCARD_ATTR_CURRENT_IFSC SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0207)
61 #define SCARD_ATTR_CURRENT_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0208)
62 #define SCARD_ATTR_CURRENT_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0209)
63 #define SCARD_ATTR_CURRENT_CWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020a)
64 #define SCARD_ATTR_CURRENT_EBC_ENCODING SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020b)
65 #define SCARD_ATTR_EXTENDED_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020c)
67 #define SCARD_ATTR_ICC_PRESENCE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0300)
68 #define SCARD_ATTR_ICC_INTERFACE_STATUS SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0301)
69 #define SCARD_ATTR_CURRENT_IO_STATE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0302)
70 #define SCARD_ATTR_ATR_STRING SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0303)
71 #define SCARD_ATTR_ICC_TYPE_PER_ATR SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0304)
73 #define SCARD_ATTR_ESC_RESET SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA000)
74 #define SCARD_ATTR_ESC_CANCEL SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA003)
75 #define SCARD_ATTR_ESC_AUTHREQUEST SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA005)
76 #define SCARD_ATTR_MAXINPUT SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA007)
78 #define SCARD_ATTR_DEVICE_UNIT SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0001)
79 #define SCARD_ATTR_DEVICE_IN_USE SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0002)
80 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0003)
81 #define SCARD_ATTR_DEVICE_SYSTEM_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0004)
82 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0005)
83 #define SCARD_ATTR_DEVICE_SYSTEM_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0006)
84 #define SCARD_ATTR_SUPRESS_T1_IFS_REQUEST SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0007)
86 #ifdef UNICODE
87 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_W
88 #define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_W
89 #else
90 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_A
91 #define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_A
92 #endif
93 
97 #define SCARD_CTL_CODE(code) (0x42000000 + (code))
98 
102 #define CM_IOCTL_GET_FEATURE_REQUEST SCARD_CTL_CODE(3400)
103 
104 #define FEATURE_VERIFY_PIN_START 0x01
105 #define FEATURE_VERIFY_PIN_FINISH 0x02
106 #define FEATURE_MODIFY_PIN_START 0x03
107 #define FEATURE_MODIFY_PIN_FINISH 0x04
108 #define FEATURE_GET_KEY_PRESSED 0x05
109 #define FEATURE_VERIFY_PIN_DIRECT 0x06
110 #define FEATURE_MODIFY_PIN_DIRECT 0x07
111 #define FEATURE_MCT_READER_DIRECT 0x08
112 #define FEATURE_MCT_UNIVERSAL 0x09
113 #define FEATURE_IFD_PIN_PROPERTIES 0x0A
114 #define FEATURE_ABORT 0x0B
115 #define FEATURE_SET_SPE_MESSAGE 0x0C
116 #define FEATURE_VERIFY_PIN_DIRECT_APP_ID 0x0D
117 #define FEATURE_MODIFY_PIN_DIRECT_APP_ID 0x0E
118 #define FEATURE_WRITE_DISPLAY 0x0F
119 #define FEATURE_GET_KEY 0x10
120 #define FEATURE_IFD_DISPLAY_PROPERTIES 0x11
121 #define FEATURE_GET_TLV_PROPERTIES 0x12
122 #define FEATURE_CCID_ESC_COMMAND 0x13
123 #define FEATURE_EXECUTE_PACE 0x20
124 
125 /* structures used (but not defined) in PC/SC Part 10:
126  * "IFDs with Secure Pin Entry Capabilities" */
127 
128 #include <inttypes.h>
129 
130 /* Set structure elements aligment on bytes
131  * http://gcc.gnu.org/onlinedocs/gcc/Structure_002dPacking-Pragmas.html */
132 #if defined(__APPLE__) | defined(sun)
133 #pragma pack(1)
134 #else
135 #pragma pack(push, 1)
136 #endif
137 
139 typedef struct
140 {
141  uint8_t tag;
142  uint8_t length;
143  uint32_t value;
145 
148 #define HOST_TO_CCID_16(x) (x)
149 #define HOST_TO_CCID_32(x) (x)
150 
152 typedef struct
153 {
154  uint8_t bTimerOut;
155  uint8_t bTimerOut2;
156  uint8_t bmFormatString;
164  uint16_t wPINMaxExtraDigit;
168  uint8_t bNumberMessage;
169  uint16_t wLangId;
170  uint8_t bMsgIndex;
171  uint8_t bTeoPrologue[3];
172  uint32_t ulDataLength;
173  uint8_t abData[1];
175 
177 typedef struct
178 {
179  uint8_t bTimerOut;
180  uint8_t bTimerOut2;
181  uint8_t bmFormatString;
196  uint8_t bConfirmPIN;
199  uint8_t bNumberMessage;
200  uint16_t wLangId;
201  uint8_t bMsgIndex1;
202  uint8_t bMsgIndex2;
203  uint8_t bMsgIndex3;
204  uint8_t bTeoPrologue[3];
205  uint32_t ulDataLength;
206  uint8_t abData[1];
208 
210 typedef struct {
211  uint16_t wLcdLayout;
212  uint8_t bEntryValidationCondition;
213  uint8_t bTimeOut2;
215 
216 /* restore default structure elements alignment */
217 #if defined(__APPLE__) | defined(sun)
218 #pragma pack()
219 #else
220 #pragma pack(pop)
221 #endif
222 
223 /* properties returned by FEATURE_GET_TLV_PROPERTIES */
224 #define PCSCv2_PART10_PROPERTY_wLcdLayout 1
225 #define PCSCv2_PART10_PROPERTY_bEntryValidationCondition 2
226 #define PCSCv2_PART10_PROPERTY_bTimeOut2 3
227 #define PCSCv2_PART10_PROPERTY_wLcdMaxCharacters 4
228 #define PCSCv2_PART10_PROPERTY_wLcdMaxLines 5
229 #define PCSCv2_PART10_PROPERTY_bMinPINSize 6
230 #define PCSCv2_PART10_PROPERTY_bMaxPINSize 7
231 #define PCSCv2_PART10_PROPERTY_sFirmwareID 8
232 #define PCSCv2_PART10_PROPERTY_bPPDUSupport 9
233 #define PCSCv2_PART10_PROPERTY_dwMaxAPDUDataSize 10
234 #define PCSCv2_PART10_PROPERTY_wIdVendor 11
235 #define PCSCv2_PART10_PROPERTY_wIdProduct 12
236 
237 #endif
238 
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:143
uint8_t bmFormatString
formatting options
Definition: reader.h:156
uint8_t bmPINBlockString
bits 7-4 bit size of PIN length in APDU, bits 3-0 PIN block size in bytes after justification and f...
Definition: reader.h:157
uint32_t ulDataLength
length of Data to be sent to the ICC
Definition: reader.h:172
the structure must be 6-bytes long
Definition: reader.h:139
uint32_t ulDataLength
length of Data to be sent to the ICC
Definition: reader.h:205
uint8_t bNumberMessage
Number of messages to display for PIN verification.
Definition: reader.h:168
uint8_t bMsgIndex2
index of 2d prompting message
Definition: reader.h:202
uint8_t bTimerOut2
timeout in seconds after first key stroke
Definition: reader.h:155
uint8_t bmFormatString
formatting options
Definition: reader.h:181
uint16_t wPINMaxExtraDigit
0xXXYY where XX is minimum PIN size in digits, and YY is maximum PIN size in digits ...
Definition: reader.h:193
uint8_t bEntryValidationCondition
Conditions under which PIN entry should be considered complete
Definition: reader.h:197
uint8_t bTimerOut
timeout is seconds (00 means use default timeout)
Definition: reader.h:179
uint8_t bNumberMessage
Number of messages to display for PIN verification.
Definition: reader.h:199
uint8_t bEntryValidationCondition
Conditions under which PIN entry should be considered complete
Definition: reader.h:166
uint16_t wLangId
Language for messages.
Definition: reader.h:200
uint8_t bTimerOut
timeout is seconds (00 means use default timeout)
Definition: reader.h:154
uint8_t bInsertionOffsetNew
Insertion position offset in bytes for the new PIN
Definition: reader.h:191
uint8_t bMsgIndex
Message index (should be 00)
Definition: reader.h:170
uint8_t bTimerOut2
timeout in seconds after first key stroke
Definition: reader.h:180
uint16_t wLcdLayout
display characteristics
Definition: reader.h:211
uint8_t bConfirmPIN
Flags governing need for confirmation of new PIN.
Definition: reader.h:196
uint16_t wLangId
Language for messages.
Definition: reader.h:169
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:160
structure used with FEATURE_IFD_PIN_PROPERTIES
Definition: reader.h:210
structure used with FEATURE_MODIFY_PIN_DIRECT
Definition: reader.h:177
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:185
uint8_t bMsgIndex3
index of 3d prompting message
Definition: reader.h:203
uint8_t bMsgIndex1
index of 1st prompting message
Definition: reader.h:201
structure used with FEATURE_VERIFY_PIN_DIRECT
Definition: reader.h:152
uint16_t wPINMaxExtraDigit
0xXXYY where XX is minimum PIN size in digits, and YY is maximum PIN size in digits ...
Definition: reader.h:164
uint8_t bmPINBlockString
bits 7-4 bit size of PIN length in APDU, bits 3-0 PIN block size in bytes after justification and f...
Definition: reader.h:182
uint8_t bInsertionOffsetOld
Insertion position offset in bytes for the current PIN
Definition: reader.h:189