2
* This keeps a list of defines for pcsc-lite.
4
* MUSCLE SmartCard Development ( http://www.linuxnet.com )
6
* Copyright (C) 1999-2004
7
* David Corcoran <corcoran@linuxnet.com>
8
* Ludovic Rousseau <ludovic.rousseau@free.fr>
10
* $Id: pcsclite.h.in,v 1.47 2004/08/24 21:46:57 rousseau Exp $
13
#ifndef __pcsclite_h__
14
#define __pcsclite_h__
26
typedef long SCARDCONTEXT;
27
typedef SCARDCONTEXT *PSCARDCONTEXT;
28
typedef SCARDCONTEXT *LPSCARDCONTEXT;
29
typedef long SCARDHANDLE;
30
typedef SCARDHANDLE *PSCARDHANDLE;
31
typedef SCARDHANDLE *LPSCARDHANDLE;
33
#define MAX_ATR_SIZE 33 /* Maximum ATR size */
39
unsigned long dwCurrentState;
40
unsigned long dwEventState;
42
unsigned char rgbAtr[MAX_ATR_SIZE];
46
typedef SCARD_READERSTATE_A SCARD_READERSTATE, *PSCARD_READERSTATE_A,
47
*LPSCARD_READERSTATE_A;
49
typedef struct _SCARD_IO_REQUEST
51
unsigned long dwProtocol; /* Protocol identifier */
52
unsigned long cbPciLength; /* Protocol Control Inf Length */
54
SCARD_IO_REQUEST, *PSCARD_IO_REQUEST, *LPSCARD_IO_REQUEST;
56
typedef const SCARD_IO_REQUEST *LPCSCARD_IO_REQUEST;
58
extern SCARD_IO_REQUEST g_rgSCardT0Pci, g_rgSCardT1Pci,
61
#define SCARD_PCI_T0 (&g_rgSCardT0Pci)
62
#define SCARD_PCI_T1 (&g_rgSCardT1Pci)
63
#define SCARD_PCI_RAW (&g_rgSCardRawPci)
65
#define SCARD_S_SUCCESS 0x00000000
66
#define SCARD_E_CANCELLED 0x80100002
67
#define SCARD_E_CANT_DISPOSE 0x8010000E
68
#define SCARD_E_INSUFFICIENT_BUFFER 0x80100008
69
#define SCARD_E_INVALID_ATR 0x80100015
70
#define SCARD_E_INVALID_HANDLE 0x80100003
71
#define SCARD_E_INVALID_PARAMETER 0x80100004
72
#define SCARD_E_INVALID_TARGET 0x80100005
73
#define SCARD_E_INVALID_VALUE 0x80100011
74
#define SCARD_E_NO_MEMORY 0x80100006
75
#define SCARD_F_COMM_ERROR 0x80100013
76
#define SCARD_F_INTERNAL_ERROR 0x80100001
77
#define SCARD_F_UNKNOWN_ERROR 0x80100014
78
#define SCARD_F_WAITED_TOO_LONG 0x80100007
79
#define SCARD_E_UNKNOWN_READER 0x80100009
80
#define SCARD_E_TIMEOUT 0x8010000A
81
#define SCARD_E_SHARING_VIOLATION 0x8010000B
82
#define SCARD_E_NO_SMARTCARD 0x8010000C
83
#define SCARD_E_UNKNOWN_CARD 0x8010000D
84
#define SCARD_E_PROTO_MISMATCH 0x8010000F
85
#define SCARD_E_NOT_READY 0x80100010
86
#define SCARD_E_SYSTEM_CANCELLED 0x80100012
87
#define SCARD_E_NOT_TRANSACTED 0x80100016
88
#define SCARD_E_READER_UNAVAILABLE 0x80100017
90
#define SCARD_W_UNSUPPORTED_CARD 0x80100065
91
#define SCARD_W_UNRESPONSIVE_CARD 0x80100066
92
#define SCARD_W_UNPOWERED_CARD 0x80100067
93
#define SCARD_W_RESET_CARD 0x80100068
94
#define SCARD_W_REMOVED_CARD 0x80100069
96
#define SCARD_E_PCI_TOO_SMALL 0x80100019
97
#define SCARD_E_READER_UNSUPPORTED 0x8010001A
98
#define SCARD_E_DUPLICATE_READER 0x8010001B
99
#define SCARD_E_CARD_UNSUPPORTED 0x8010001C
100
#define SCARD_E_NO_SERVICE 0x8010001D
101
#define SCARD_E_SERVICE_STOPPED 0x8010001E
103
#define SCARD_SCOPE_USER 0x0000 /* Scope in user space */
104
#define SCARD_SCOPE_TERMINAL 0x0001 /* Scope in terminal */
105
#define SCARD_SCOPE_SYSTEM 0x0002 /* Scope in system */
107
#define SCARD_PROTOCOL_UNSET 0x0000 /* protocol not set */
108
#define SCARD_PROTOCOL_T0 0x0001 /* T=0 active protocol. */
109
#define SCARD_PROTOCOL_T1 0x0002 /* T=1 active protocol. */
110
#define SCARD_PROTOCOL_RAW 0x0004 /* Raw active protocol. */
111
#define SCARD_PROTOCOL_T15 0x0008 /* T=15 protocol. */
113
#define SCARD_PROTOCOL_ANY (SCARD_PROTOCOL_T0|SCARD_PROTOCOL_T1) /* IFD determines prot. */
115
#define SCARD_SHARE_EXCLUSIVE 0x0001 /* Exclusive mode only */
116
#define SCARD_SHARE_SHARED 0x0002 /* Shared mode only */
117
#define SCARD_SHARE_DIRECT 0x0003 /* Raw mode only */
119
#define SCARD_LEAVE_CARD 0x0000 /* Do nothing on close */
120
#define SCARD_RESET_CARD 0x0001 /* Reset on close */
121
#define SCARD_UNPOWER_CARD 0x0002 /* Power down on close */
122
#define SCARD_EJECT_CARD 0x0003 /* Eject on close */
124
#define SCARD_UNKNOWN 0x0001 /* Unknown state */
125
#define SCARD_ABSENT 0x0002 /* Card is absent */
126
#define SCARD_PRESENT 0x0004 /* Card is present */
127
#define SCARD_SWALLOWED 0x0008 /* Card not powered */
128
#define SCARD_POWERED 0x0010 /* Card is powered */
129
#define SCARD_NEGOTIABLE 0x0020 /* Ready for PTS */
130
#define SCARD_SPECIFIC 0x0040 /* PTS has been set */
132
#define SCARD_STATE_UNAWARE 0x0000 /* App wants status */
133
#define SCARD_STATE_IGNORE 0x0001 /* Ignore this reader */
134
#define SCARD_STATE_CHANGED 0x0002 /* State has changed */
135
#define SCARD_STATE_UNKNOWN 0x0004 /* Reader unknown */
136
#define SCARD_STATE_UNAVAILABLE 0x0008 /* Status unavailable */
137
#define SCARD_STATE_EMPTY 0x0010 /* Card removed */
138
#define SCARD_STATE_PRESENT 0x0020 /* Card inserted */
139
#define SCARD_STATE_ATRMATCH 0x0040 /* ATR matches card */
140
#define SCARD_STATE_EXCLUSIVE 0x0080 /* Exclusive Mode */
141
#define SCARD_STATE_INUSE 0x0100 /* Shared Mode */
142
#define SCARD_STATE_MUTE 0x0200 /* Unresponsive card */
143
#define SCARD_STATE_UNPOWERED 0x0400 /* Unpowered card */
146
* Tags for requesting card and reader attributes
149
#define SCARD_ATTR_VALUE(Class, Tag) ((((ULONG)(Class)) << 16) | ((ULONG)(Tag)))
151
#define SCARD_CLASS_VENDOR_INFO 1 /* Vendor information definitions */
152
#define SCARD_CLASS_COMMUNICATIONS 2 /* Communication definitions */
153
#define SCARD_CLASS_PROTOCOL 3 /* Protocol definitions */
154
#define SCARD_CLASS_POWER_MGMT 4 /* Power Management definitions */
155
#define SCARD_CLASS_SECURITY 5 /* Security Assurance definitions */
156
#define SCARD_CLASS_MECHANICAL 6 /* Mechanical characteristic definitions */
157
#define SCARD_CLASS_VENDOR_DEFINED 7 /* Vendor specific definitions */
158
#define SCARD_CLASS_IFD_PROTOCOL 8 /* Interface Device Protocol options */
159
#define SCARD_CLASS_ICC_STATE 9 /* ICC State specific definitions */
160
#define SCARD_CLASS_SYSTEM 0x7fff /* System-specific definitions */
162
#define SCARD_ATTR_VENDOR_NAME SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0100)
163
#define SCARD_ATTR_VENDOR_IFD_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0101)
164
#define SCARD_ATTR_VENDOR_IFD_VERSION SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0102)
165
#define SCARD_ATTR_VENDOR_IFD_SERIAL_NO SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0103)
166
#define SCARD_ATTR_CHANNEL_ID SCARD_ATTR_VALUE(SCARD_CLASS_COMMUNICATIONS, 0x0110)
167
#define SCARD_ATTR_ASYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0120)
168
#define SCARD_ATTR_DEFAULT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0121)
169
#define SCARD_ATTR_MAX_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0122)
170
#define SCARD_ATTR_DEFAULT_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0123)
171
#define SCARD_ATTR_MAX_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0124)
172
#define SCARD_ATTR_MAX_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0125)
173
#define SCARD_ATTR_SYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0126)
174
#define SCARD_ATTR_POWER_MGMT_SUPPORT SCARD_ATTR_VALUE(SCARD_CLASS_POWER_MGMT, 0x0131)
175
#define SCARD_ATTR_USER_TO_CARD_AUTH_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0140)
176
#define SCARD_ATTR_USER_AUTH_INPUT_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0142)
177
#define SCARD_ATTR_CHARACTERISTICS SCARD_ATTR_VALUE(SCARD_CLASS_MECHANICAL, 0x0150)
179
#define SCARD_ATTR_CURRENT_PROTOCOL_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0201)
180
#define SCARD_ATTR_CURRENT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0202)
181
#define SCARD_ATTR_CURRENT_F SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0203)
182
#define SCARD_ATTR_CURRENT_D SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0204)
183
#define SCARD_ATTR_CURRENT_N SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0205)
184
#define SCARD_ATTR_CURRENT_W SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0206)
185
#define SCARD_ATTR_CURRENT_IFSC SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0207)
186
#define SCARD_ATTR_CURRENT_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0208)
187
#define SCARD_ATTR_CURRENT_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0209)
188
#define SCARD_ATTR_CURRENT_CWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020a)
189
#define SCARD_ATTR_CURRENT_EBC_ENCODING SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020b)
190
#define SCARD_ATTR_EXTENDED_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020c)
192
#define SCARD_ATTR_ICC_PRESENCE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0300)
193
#define SCARD_ATTR_ICC_INTERFACE_STATUS SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0301)
194
#define SCARD_ATTR_CURRENT_IO_STATE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0302)
195
#define SCARD_ATTR_ATR_STRING SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0303)
196
#define SCARD_ATTR_ICC_TYPE_PER_ATR SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0304)
198
#define SCARD_ATTR_ESC_RESET SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA000)
199
#define SCARD_ATTR_ESC_CANCEL SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA003)
200
#define SCARD_ATTR_ESC_AUTHREQUEST SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA005)
201
#define SCARD_ATTR_MAXINPUT SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA007)
203
#define SCARD_ATTR_DEVICE_UNIT SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0001)
204
#define SCARD_ATTR_DEVICE_IN_USE SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0002)
205
#define SCARD_ATTR_DEVICE_FRIENDLY_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0003)
206
#define SCARD_ATTR_DEVICE_SYSTEM_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0004)
207
#define SCARD_ATTR_DEVICE_FRIENDLY_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0005)
208
#define SCARD_ATTR_DEVICE_SYSTEM_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0006)
209
#define SCARD_ATTR_SUPRESS_T1_IFS_REQUEST SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0007)
212
#define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_W
213
#define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_W
215
#define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_A
216
#define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_A
221
/* PC/SC Lite specific extensions */
222
#define SCARD_W_INSERTED_CARD 0x8010006A
223
#define SCARD_E_UNSUPPORTED_FEATURE 0x8010001F
225
#define SCARD_SCOPE_GLOBAL 0x0003 /* Scope is global */
227
#define SCARD_RESET 0x0001 /* Card was reset */
228
#define SCARD_INSERTED 0x0002 /* Card was inserted */
229
#define SCARD_REMOVED 0x0004 /* Card was removed */
231
#define BLOCK_STATUS_RESUME 0x00FF /* Normal resume */
232
#define BLOCK_STATUS_BLOCKING 0x00FA /* Function is blocking */
234
#define PCSCLITE_CONFIG_DIR "@confdir_exp@"
237
#define PCSCLITE_IPC_DIR "/var/run"
239
#define PCSCLITE_IPC_DIR USE_IPCDIR
242
#define PCSCLITE_READER_CONFIG PCSCLITE_CONFIG_DIR "/reader.conf"
243
#define PCSCLITE_PUBSHM_FILE PCSCLITE_IPC_DIR "/pcscd.pub"
244
#define PCSCLITE_CSOCK_NAME PCSCLITE_IPC_DIR "/pcscd.comm"
246
#define PCSCLITE_SVC_IDENTITY 0x01030000 /* Service ID */
249
#define INFINITE 0xFFFFFFFF /* Infinite timeout */
251
#define PCSCLITE_INFINITE_TIMEOUT 4320000 /* 50 day infinite t/o */
253
#define PCSCLITE_VERSION_NUMBER "@VERSION@" /* Current version */
254
#define PCSCLITE_CLIENT_ATTEMPTS 120 /* Attempts to reach sv */
255
#define PCSCLITE_MCLIENT_ATTEMPTS 20 /* Attempts to reach sv */
256
#define PCSCLITE_STATUS_POLL_RATE 400000 /* Status polling rate */
257
#define PCSCLITE_MSG_KEY_LEN 16 /* App ID key length */
258
#define PCSCLITE_RW_ATTEMPTS 100 /* Attempts to rd/wrt */
260
/* Maximum applications */
261
#define PCSCLITE_MAX_APPLICATIONS 16
262
/* Maximum contexts by application */
263
#define PCSCLITE_MAX_APPLICATION_CONTEXTS 16
264
/* Maximum of applications contexts that pcscd can accept */
265
#define PCSCLITE_MAX_APPLICATIONS_CONTEXTS \
266
PCSCLITE_MAX_APPLICATIONS * PCSCLITE_MAX_APPLICATION_CONTEXTS
267
/* Maximum channels on a reader context */
268
#define PCSCLITE_MAX_READER_CONTEXT_CHANNELS 16
269
/* Maximum channels on an application context */
270
#define PCSCLITE_MAX_APPLICATION_CONTEXT_CHANNELS 16
271
/* Maximum readers context (a slot is count as a reader) */
272
#define PCSCLITE_MAX_READERS_CONTEXTS 16
274
/* PCSCLITE_MAX_READERS is deprecated
275
* use PCSCLITE_MAX_READERS_CONTEXTS instead */
276
/* extern int PCSCLITE_MAX_READERS __attribute__ ((deprecated)); */
278
#define PCSCLITE_MAX_THREADS 16 /* Stat change threads */
279
#define PCSCLITE_STATUS_WAIT 200000 /* Status Change Sleep */
280
#define PCSCLITE_TRANSACTION_TIMEOUT 40 /* Transaction timeout */
281
#define MAX_READERNAME 52
282
#define MAX_LIBNAME 100
283
#define MAX_DEVICENAME 255
285
#ifndef SCARD_ATR_LENGTH
286
#define SCARD_ATR_LENGTH MAX_ATR_SIZE /* Maximum ATR size */
290
* Enhanced messaging has been added to accomodate newer devices which have
291
* more advanced capabilites, such as dedicated secure co-processors which
292
* can stream and encrypt data over USB. In order to used enhanced messaging
293
* you must define PCSCLITE_ENHANCED_MESSAGING in the framework(library),
294
* the daemon, and your application
297
#ifndef PCSCLITE_ENHANCED_MESSAGING
298
#define PCSCLITE_MAX_MESSAGE_SIZE 2048 /* Transport msg len */
299
#define MAX_BUFFER_SIZE 264 /* Maximum Tx/Rx Buffer */
300
#define PCSCLITE_SERVER_ATTEMPTS 5 /* Attempts to reach cl */
303
* The message and buffer sizes must be multiples of 16.
304
* The max message size must be at least large enough
305
* to accomodate the transmit_struct
307
#define PCSCLITE_MAX_MESSAGE_SIZE (1<<17) /* enhanced (128K) msg len */
308
#define MAX_BUFFER_SIZE (1<<15) /* enhanced (32K) Tx/Rx Buffer */
309
#define PCSCLITE_SERVER_ATTEMPTS 200 /* To allow larger data reads/writes */
313
* Gets a stringified error response
315
char *pcsc_stringify_error(long);