1 | /*++
|
---|
2 |
|
---|
3 | Copyright (c) 1996 Microsoft Corporation
|
---|
4 |
|
---|
5 | Module Name:
|
---|
6 |
|
---|
7 | winsmcrd.h
|
---|
8 |
|
---|
9 | Abstract:
|
---|
10 | Smart Card class/port IOCTL codes. This file is required for all code
|
---|
11 | user mode and kernel mode, using Smart Card IOCTL's, defines,
|
---|
12 | data structures
|
---|
13 |
|
---|
14 | Revision History:
|
---|
15 |
|
---|
16 | --*/
|
---|
17 |
|
---|
18 |
|
---|
19 | #ifndef _NTDDSCRD_H2_
|
---|
20 | #define _NTDDSCRD_H2_
|
---|
21 |
|
---|
22 | #if defined (_MSC_VER) && (_MSC_VER >= 1020)
|
---|
23 | #pragma once
|
---|
24 | #endif
|
---|
25 |
|
---|
26 | #ifdef __cplusplus
|
---|
27 | extern "C" {
|
---|
28 | #endif
|
---|
29 |
|
---|
30 | #ifdef _WINSCARD_H_
|
---|
31 | typedef DWORD ULONG;
|
---|
32 | typedef WORD UWORD;
|
---|
33 | typedef BYTE UCHAR;
|
---|
34 | #else
|
---|
35 | typedef ULONG DWORD;
|
---|
36 | // typedef UWORD WORD;
|
---|
37 | typedef UCHAR BYTE;
|
---|
38 | #endif
|
---|
39 |
|
---|
40 | #ifndef DEVICE_TYPE_SMARTCARD
|
---|
41 | #ifndef FILE_DEVICE_SMARTCARD
|
---|
42 | #define FILE_DEVICE_SMARTCARD 0x00000031
|
---|
43 | #endif
|
---|
44 | #else
|
---|
45 | #if 0x00000031 != FILE_DEVICE_SMARTCARD
|
---|
46 | #error "Incorrect Smart Card Device Definition"
|
---|
47 | #endif
|
---|
48 | #endif
|
---|
49 |
|
---|
50 |
|
---|
51 | //
|
---|
52 | // Various constants
|
---|
53 | //
|
---|
54 |
|
---|
55 | #define SCARD_ATR_LENGTH 33 // ISO 7816-3 spec.
|
---|
56 |
|
---|
57 | //
|
---|
58 | ///////////////////////////////////////////////////////////////////////////////
|
---|
59 | //
|
---|
60 | // Protocol Flag definitions
|
---|
61 | //
|
---|
62 |
|
---|
63 | #define SCARD_PROTOCOL_UNDEFINED 0x00000000 // There is no active protocol.
|
---|
64 | #define SCARD_PROTOCOL_T0 0x00000001 // T=0 is the active protocol.
|
---|
65 | #define SCARD_PROTOCOL_T1 0x00000002 // T=1 is the active protocol.
|
---|
66 | #define SCARD_PROTOCOL_RAW 0x00010000 // Raw is the active protocol.
|
---|
67 | //
|
---|
68 | // This is the mask of ISO defined transmission protocols
|
---|
69 | //
|
---|
70 | #define SCARD_PROTOCOL_Tx (SCARD_PROTOCOL_T0 | SCARD_PROTOCOL_T1)
|
---|
71 | //
|
---|
72 | // Use the default transmission parameters / card clock freq.
|
---|
73 | //
|
---|
74 | #define SCARD_PROTOCOL_DEFAULT 0x80000000
|
---|
75 | //
|
---|
76 | // Use optimal transmission parameters / card clock freq.
|
---|
77 | // Since using the optimal parameters is the default case no bit is defined to be 1
|
---|
78 | //
|
---|
79 | #define SCARD_PROTOCOL_OPTIMAL 0x00000000
|
---|
80 |
|
---|
81 |
|
---|
82 | //
|
---|
83 | // Ioctl parameters 1 for IOCTL_SMARTCARD_POWER
|
---|
84 | //
|
---|
85 | #define SCARD_POWER_DOWN 0 // Power down the card.
|
---|
86 | #define SCARD_COLD_RESET 1 // Cycle power and reset the card.
|
---|
87 | #define SCARD_WARM_RESET 2 // Force a reset on the card.
|
---|
88 |
|
---|
89 | //
|
---|
90 | ///////////////////////////////////////////////////////////////////////////////
|
---|
91 | //
|
---|
92 | // Reader Action IOCTLs
|
---|
93 | //
|
---|
94 |
|
---|
95 | #define SCARD_CTL_CODE(code) CTL_CODE(FILE_DEVICE_SMARTCARD, \
|
---|
96 | (code), \
|
---|
97 | METHOD_BUFFERED, \
|
---|
98 | FILE_ANY_ACCESS)
|
---|
99 |
|
---|
100 | #define IOCTL_SMARTCARD_POWER SCARD_CTL_CODE( 1)
|
---|
101 | #define IOCTL_SMARTCARD_GET_ATTRIBUTE SCARD_CTL_CODE( 2)
|
---|
102 | #define IOCTL_SMARTCARD_SET_ATTRIBUTE SCARD_CTL_CODE( 3)
|
---|
103 | #define IOCTL_SMARTCARD_CONFISCATE SCARD_CTL_CODE( 4)
|
---|
104 | #define IOCTL_SMARTCARD_TRANSMIT SCARD_CTL_CODE( 5)
|
---|
105 | #define IOCTL_SMARTCARD_EJECT SCARD_CTL_CODE( 6)
|
---|
106 | #define IOCTL_SMARTCARD_SWALLOW SCARD_CTL_CODE( 7)
|
---|
107 | // #define IOCTL_SMARTCARD_READ SCARD_CTL_CODE( 8) obsolete
|
---|
108 | // #define IOCTL_SMARTCARD_WRITE SCARD_CTL_CODE( 9) obsolete
|
---|
109 | #define IOCTL_SMARTCARD_IS_PRESENT SCARD_CTL_CODE(10)
|
---|
110 | #define IOCTL_SMARTCARD_IS_ABSENT SCARD_CTL_CODE(11)
|
---|
111 | #define IOCTL_SMARTCARD_SET_PROTOCOL SCARD_CTL_CODE(12)
|
---|
112 | #define IOCTL_SMARTCARD_GET_STATE SCARD_CTL_CODE(14)
|
---|
113 | #define IOCTL_SMARTCARD_GET_LAST_ERROR SCARD_CTL_CODE(15)
|
---|
114 | #define IOCTL_SMARTCARD_GET_PERF_CNTR SCARD_CTL_CODE(16)
|
---|
115 |
|
---|
116 |
|
---|
117 | //
|
---|
118 | ///////////////////////////////////////////////////////////////////////////////
|
---|
119 | //
|
---|
120 | // Tags for requesting card and reader attributes
|
---|
121 | //
|
---|
122 |
|
---|
123 | #define MAXIMUM_ATTR_STRING_LENGTH 32 // Nothing bigger than this from getAttr
|
---|
124 | #define MAXIMUM_SMARTCARD_READERS 10 // Limit the readers on the system
|
---|
125 |
|
---|
126 | #define SCARD_ATTR_VALUE(Class, Tag) ((((ULONG)(Class)) << 16) | ((ULONG)(Tag)))
|
---|
127 |
|
---|
128 | #define SCARD_CLASS_VENDOR_INFO 1 // Vendor information definitions
|
---|
129 | #define SCARD_CLASS_COMMUNICATIONS 2 // Communication definitions
|
---|
130 | #define SCARD_CLASS_PROTOCOL 3 // Protocol definitions
|
---|
131 | #define SCARD_CLASS_POWER_MGMT 4 // Power Management definitions
|
---|
132 | #define SCARD_CLASS_SECURITY 5 // Security Assurance definitions
|
---|
133 | #define SCARD_CLASS_MECHANICAL 6 // Mechanical characteristic definitions
|
---|
134 | #define SCARD_CLASS_VENDOR_DEFINED 7 // Vendor specific definitions
|
---|
135 | #define SCARD_CLASS_IFD_PROTOCOL 8 // Interface Device Protocol options
|
---|
136 | #define SCARD_CLASS_ICC_STATE 9 // ICC State specific definitions
|
---|
137 | #define SCARD_CLASS_PERF 0x7ffe // performace counters
|
---|
138 | #define SCARD_CLASS_SYSTEM 0x7fff // System-specific definitions
|
---|
139 |
|
---|
140 | #define SCARD_ATTR_VENDOR_NAME SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0100)
|
---|
141 | #define SCARD_ATTR_VENDOR_IFD_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0101)
|
---|
142 | #define SCARD_ATTR_VENDOR_IFD_VERSION SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0102)
|
---|
143 | #define SCARD_ATTR_VENDOR_IFD_SERIAL_NO SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0103)
|
---|
144 | #define SCARD_ATTR_CHANNEL_ID SCARD_ATTR_VALUE(SCARD_CLASS_COMMUNICATIONS, 0x0110)
|
---|
145 | #define SCARD_ATTR_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0120)
|
---|
146 | // #define SCARD_ATTR_ASYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0120)
|
---|
147 | #define SCARD_ATTR_DEFAULT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0121)
|
---|
148 | #define SCARD_ATTR_MAX_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0122)
|
---|
149 | #define SCARD_ATTR_DEFAULT_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0123)
|
---|
150 | #define SCARD_ATTR_MAX_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0124)
|
---|
151 | #define SCARD_ATTR_MAX_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0125)
|
---|
152 | // #define SCARD_ATTR_SYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0126)
|
---|
153 | #define SCARD_ATTR_POWER_MGMT_SUPPORT SCARD_ATTR_VALUE(SCARD_CLASS_POWER_MGMT, 0x0131)
|
---|
154 | #define SCARD_ATTR_USER_TO_CARD_AUTH_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0140)
|
---|
155 | #define SCARD_ATTR_USER_AUTH_INPUT_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0142)
|
---|
156 | #define SCARD_ATTR_CHARACTERISTICS SCARD_ATTR_VALUE(SCARD_CLASS_MECHANICAL, 0x0150)
|
---|
157 |
|
---|
158 | #define SCARD_ATTR_CURRENT_PROTOCOL_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0201)
|
---|
159 | #define SCARD_ATTR_CURRENT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0202)
|
---|
160 | #define SCARD_ATTR_CURRENT_F SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0203)
|
---|
161 | #define SCARD_ATTR_CURRENT_D SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0204)
|
---|
162 | #define SCARD_ATTR_CURRENT_N SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0205)
|
---|
163 | #define SCARD_ATTR_CURRENT_W SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0206)
|
---|
164 | #define SCARD_ATTR_CURRENT_IFSC SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0207)
|
---|
165 | #define SCARD_ATTR_CURRENT_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0208)
|
---|
166 | #define SCARD_ATTR_CURRENT_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0209)
|
---|
167 | #define SCARD_ATTR_CURRENT_CWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020a)
|
---|
168 | #define SCARD_ATTR_CURRENT_EBC_ENCODING SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020b)
|
---|
169 | #define SCARD_ATTR_EXTENDED_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020c)
|
---|
170 |
|
---|
171 | #define SCARD_ATTR_ICC_PRESENCE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0300)
|
---|
172 | #define SCARD_ATTR_ICC_INTERFACE_STATUS SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0301)
|
---|
173 | #define SCARD_ATTR_CURRENT_IO_STATE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0302)
|
---|
174 | #define SCARD_ATTR_ATR_STRING SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0303)
|
---|
175 | #define SCARD_ATTR_ICC_TYPE_PER_ATR SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0304)
|
---|
176 |
|
---|
177 | #define SCARD_ATTR_ESC_RESET SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA000)
|
---|
178 | #define SCARD_ATTR_ESC_CANCEL SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA003)
|
---|
179 | #define SCARD_ATTR_ESC_AUTHREQUEST SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA005)
|
---|
180 | #define SCARD_ATTR_MAXINPUT SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA007)
|
---|
181 |
|
---|
182 | #define SCARD_ATTR_DEVICE_UNIT SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0001)
|
---|
183 | #define SCARD_ATTR_DEVICE_IN_USE SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0002)
|
---|
184 | #define SCARD_ATTR_DEVICE_FRIENDLY_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0003)
|
---|
185 | #define SCARD_ATTR_DEVICE_SYSTEM_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0004)
|
---|
186 | #define SCARD_ATTR_DEVICE_FRIENDLY_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0005)
|
---|
187 | #define SCARD_ATTR_DEVICE_SYSTEM_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0006)
|
---|
188 | #define SCARD_ATTR_SUPRESS_T1_IFS_REQUEST SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0007)
|
---|
189 |
|
---|
190 | #define SCARD_PERF_NUM_TRANSMISSIONS SCARD_ATTR_VALUE(SCARD_CLASS_PERF, 0x0001)
|
---|
191 | #define SCARD_PERF_BYTES_TRANSMITTED SCARD_ATTR_VALUE(SCARD_CLASS_PERF, 0x0002)
|
---|
192 | #define SCARD_PERF_TRANSMISSION_TIME SCARD_ATTR_VALUE(SCARD_CLASS_PERF, 0x0003)
|
---|
193 |
|
---|
194 | #ifdef UNICODE
|
---|
195 | #define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_W
|
---|
196 | #define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_W
|
---|
197 | #else
|
---|
198 | #define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_A
|
---|
199 | #define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_A
|
---|
200 | #endif
|
---|
201 |
|
---|
202 |
|
---|
203 | //
|
---|
204 | // T=0 Protocol Defines
|
---|
205 | //
|
---|
206 |
|
---|
207 | #define SCARD_T0_HEADER_LENGTH 7
|
---|
208 | #define SCARD_T0_CMD_LENGTH 5
|
---|
209 |
|
---|
210 |
|
---|
211 | //
|
---|
212 | // T=1 Protocol Defines
|
---|
213 | //
|
---|
214 |
|
---|
215 | #define SCARD_T1_PROLOGUE_LENGTH 3
|
---|
216 | #define SCARD_T1_EPILOGUE_LENGTH 2
|
---|
217 | #define SCARD_T1_MAX_IFS 254
|
---|
218 |
|
---|
219 |
|
---|
220 | //
|
---|
221 | ///////////////////////////////////////////////////////////////////////////////
|
---|
222 | //
|
---|
223 | // Reader states
|
---|
224 | //
|
---|
225 |
|
---|
226 | #define SCARD_UNKNOWN 0 // This value implies the driver is unaware
|
---|
227 | // of the current state of the reader.
|
---|
228 | #define SCARD_ABSENT 1 // This value implies there is no card in
|
---|
229 | // the reader.
|
---|
230 | #define SCARD_PRESENT 2 // This value implies there is a card is
|
---|
231 | // present in the reader, but that it has
|
---|
232 | // not been moved into position for use.
|
---|
233 | #define SCARD_SWALLOWED 3 // This value implies there is a card in the
|
---|
234 | // reader in position for use. The card is
|
---|
235 | // not powered.
|
---|
236 | #define SCARD_POWERED 4 // This value implies there is power is
|
---|
237 | // being provided to the card, but the
|
---|
238 | // Reader Driver is unaware of the mode of
|
---|
239 | // the card.
|
---|
240 | #define SCARD_NEGOTIABLE 5 // This value implies the card has been
|
---|
241 | // reset and is awaiting PTS negotiation.
|
---|
242 | #define SCARD_SPECIFIC 6 // This value implies the card has been
|
---|
243 | // reset and specific communication
|
---|
244 | // protocols have been established.
|
---|
245 |
|
---|
246 | ////////////////////////////////////////////////////////////////////////////////
|
---|
247 | //
|
---|
248 | // I/O Services
|
---|
249 | //
|
---|
250 | // The following services provide access to the I/O capabilities of the
|
---|
251 | // reader drivers. Services of the Smart Card are requested by placing the
|
---|
252 | // following structure into the protocol buffer:
|
---|
253 | //
|
---|
254 |
|
---|
255 |
|
---|
256 | typedef struct _SCARD_IO_REQUEST{
|
---|
257 | DWORD dwProtocol; // Protocol identifier
|
---|
258 | DWORD cbPciLength; // Protocol Control Information Length
|
---|
259 | } SCARD_IO_REQUEST, *PSCARD_IO_REQUEST, *LPSCARD_IO_REQUEST;
|
---|
260 | typedef const SCARD_IO_REQUEST *LPCSCARD_IO_REQUEST;
|
---|
261 |
|
---|
262 |
|
---|
263 | //
|
---|
264 | // T=0 protocol services.
|
---|
265 | //
|
---|
266 |
|
---|
267 | typedef struct {
|
---|
268 | BYTE
|
---|
269 | bCla, // The instruction class
|
---|
270 | bIns, // The instruction code within the instruction class
|
---|
271 | bP1,
|
---|
272 | bP2, // Parameters to the instruction
|
---|
273 | bP3; // Size of I/O Transfer
|
---|
274 | } SCARD_T0_COMMAND, *LPSCARD_T0_COMMAND;
|
---|
275 |
|
---|
276 | typedef struct {
|
---|
277 | SCARD_IO_REQUEST ioRequest;
|
---|
278 | BYTE
|
---|
279 | bSw1,
|
---|
280 | bSw2; // Return codes from the instruction
|
---|
281 | union
|
---|
282 | {
|
---|
283 | SCARD_T0_COMMAND CmdBytes;
|
---|
284 | BYTE rgbHeader[5];
|
---|
285 | } DUMMYUNIONNAME;
|
---|
286 | } SCARD_T0_REQUEST;
|
---|
287 |
|
---|
288 | typedef SCARD_T0_REQUEST *PSCARD_T0_REQUEST, *LPSCARD_T0_REQUEST;
|
---|
289 |
|
---|
290 |
|
---|
291 | //
|
---|
292 | // T=1 Protocol Services
|
---|
293 | //
|
---|
294 |
|
---|
295 | typedef struct {
|
---|
296 | SCARD_IO_REQUEST ioRequest;
|
---|
297 | } SCARD_T1_REQUEST;
|
---|
298 | typedef SCARD_T1_REQUEST *PSCARD_T1_REQUEST, *LPSCARD_T1_REQUEST;
|
---|
299 |
|
---|
300 |
|
---|
301 | //
|
---|
302 | ////////////////////////////////////////////////////////////////////////////////
|
---|
303 | //
|
---|
304 | // Driver attribute flags
|
---|
305 | //
|
---|
306 |
|
---|
307 | #define SCARD_READER_SWALLOWS 0x00000001 // Reader has a card swallowing
|
---|
308 | // mechanism.
|
---|
309 | #define SCARD_READER_EJECTS 0x00000002 // Reader has a card ejection
|
---|
310 | // mechanism.
|
---|
311 | #define SCARD_READER_CONFISCATES 0x00000004 // Reader has a card capture
|
---|
312 | // mechanism.
|
---|
313 |
|
---|
314 | //
|
---|
315 | ///////////////////////////////////////////////////////////////////////////////
|
---|
316 | //
|
---|
317 | // Type of reader
|
---|
318 | //
|
---|
319 | #define SCARD_READER_TYPE_SERIAL 0x01
|
---|
320 | #define SCARD_READER_TYPE_PARALELL 0x02
|
---|
321 | #define SCARD_READER_TYPE_KEYBOARD 0x04
|
---|
322 | #define SCARD_READER_TYPE_SCSI 0x08
|
---|
323 | #define SCARD_READER_TYPE_IDE 0x10
|
---|
324 | #define SCARD_READER_TYPE_USB 0x20
|
---|
325 | #define SCARD_READER_TYPE_PCMCIA 0x40
|
---|
326 | #define SCARD_READER_TYPE_VENDOR 0xF0
|
---|
327 |
|
---|
328 | #ifdef __cplusplus
|
---|
329 | }
|
---|
330 | #endif
|
---|
331 | #endif
|
---|
332 |
|
---|
333 |
|
---|