-
Notifications
You must be signed in to change notification settings - Fork 1
/
PCSCspi.cpp
535 lines (490 loc) · 38 KB
/
PCSCspi.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
#include "Manager.h"
#include "Service.h"
#include "Settings.h"
#include "PCSC/Status.h"
#include "XFS/Result.h"
// Для strncpy.
#include <cstring>
// Для std::size_t.
#include <cstddef>
// Для std::pair
#include <utility>
#include <vector>
// CEN/XFS API -- Наш файл, так как оригинальный предназначен для использования
// клиентами, а нам надо экспортировать функции, а не импортировать их.
#include "xfsspi.h"
// Определения для ридеров карт (Identification card unit (IDC))
#include <XFSIDC.h>
// Линкуемся с библиотекой реализации стандарта PC/SC в Windows
#pragma comment(lib, "winscard.lib")
// Линкуемся с библиотекой реализации XFS
#pragma comment(lib, "msxfs.lib")
// Линкуемся с библиотекой поддержки конфигурационных функций XFS
#pragma comment(lib, "xfs_conf.lib")
// Линкуемся с библиотекой для использования оконных функций (PostMessage)
#pragma comment(lib, "user32.lib")
#define MAKE_VERSION(major, minor) (((major) << 8) | (minor))
#define DLL_VERSION \
"PC/SC to CEN/XFS bridge\n" \
"https://bitbucket.org/Mingun/pcsc-cenxfs-bridge\n" \
"Build: Date: " __DATE__ ", time: " __TIME__
template<std::size_t N1, std::size_t N2>
void safecopy(char (&dst)[N1], const char (&src)[N2]) {
std::strncpy(dst, src, N1 < N2 ? N1 : N2);
}
/** При загрузке DLL будут вызваны конструкторы всех глобальных объектов и установится
соединение с подсистемой PC/SC. При выгрузке DLL вызовутся деструкторы глобальных
объектов и соединение автоматически закроется.
*/
Manager pcsc;
extern "C" {
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/** Пытается определить наличие считывателя с указанным в настройках (ключ ReaderName) именем.
Если данный ключ не указан, привязывается к первому найденному считывателю. Если в данный
момент никаких считывателей в системе не обнаружено, ждет указанное в `dwTimeOut` время, пока
его не подключат.
@message WFS_OPEN_COMPLETE
@param hService Хендл сессии, с которым необходимо соотнести хендл открываемой карты.
@param lpszLogicalName Имя логического сервиса, настраивается в реестре HKLM\<user>\XFS\LOGICAL_SERVICES
@param hApp Хендл приложения, созданного вызовом WFSCreateAppHandle.
@param lpszAppID Идентификатор приложения. Может быть `NULL`.
@param dwTraceLevel
@param dwTimeOut Таймаут (в мс), в течении которого необходимо открыть сервис. `WFS_INDEFINITE_WAIT`,
если таймаут не требуется.
@param hWnd Окно, которое должно получить сообщение о завершении асинхронной операции.
@param ReqID Идентификатора запроса, который нужно передать окну `hWnd` при завершении операции.
@param hProvider Хендл данного сервис-провайдера. Может быть переден, например, в фукнцию WFMReleaseDLL.
@param dwSPIVersionsRequired Диапазон требуетмых версий провайдера. 0x00112233 означает диапазон
версий [0.11; 22.33].
@param lpSPIVersion Информация об открытом соединении (выходной параметр).
@param dwSrvcVersionsRequired Специфичная для сервиса (карточный ридер) требуемая версия провайдера.
0x00112233 означает диапазон версий [0.11; 22.33].
@param lpSrvcVersion Информация об открытом соединении, специфичная для вида провайдера (карточный ридер)
(выходной параметр).
@return Всегда `WFS_SUCCESS`.
*/
HRESULT SPI_API WFPOpen(HSERVICE hService, LPSTR lpszLogicalName,
HAPP hApp, LPSTR lpszAppID,
DWORD dwTraceLevel, DWORD dwTimeOut,
HWND hWnd, REQUESTID ReqID,
HPROVIDER hProvider,
DWORD dwSPIVersionsRequired, LPWFSVERSION lpSPIVersion,
DWORD dwSrvcVersionsRequired, LPWFSVERSION lpSrvcVersion
) {
// Возвращаем поддерживаемые версии.
if (lpSPIVersion != NULL) {
// Версия XFS менеджера, которая будет использоваться. Т.к. мы поддерживаем все версии,
// то просто максимальная запрошенная версия (она в старшем слове).
lpSPIVersion->wVersion = HIWORD(dwSPIVersionsRequired);
// Минимальная и максимальная поддерживаемая нами версия
//TODO: Уточнить минимальную поддерживаемую версию!
lpSPIVersion->wLowVersion = MAKE_VERSION(0, 0);
lpSPIVersion->wHighVersion = MAKE_VERSION(255, 255);
safecopy(lpSPIVersion->szDescription, DLL_VERSION);
}
if (lpSrvcVersion != NULL) {
// Версия XFS менеджера, которая будет использоваться. Т.к. мы поддерживаем все версии,
// то просто максимальная запрошенная версия (она в старшем слове).
lpSrvcVersion->wVersion = HIWORD(dwSrvcVersionsRequired);
// Минимальная и максимальная поддерживаемая нами версия
//TODO: Уточнить минимальную поддерживаемую версию!
lpSrvcVersion->wLowVersion = MAKE_VERSION(0, 0);
lpSrvcVersion->wHighVersion = MAKE_VERSION(255, 255);
safecopy(lpSrvcVersion->szDescription, DLL_VERSION);
}
pcsc.create(hService, Settings(lpszLogicalName, dwTraceLevel));
XFS::Result(ReqID, hService, WFS_SUCCESS).send(hWnd, WFS_OPEN_COMPLETE);
// Возможные коды завершения асинхронного запроса (могут возвращаться и другие)
// WFS_ERR_CANCELED The request was canceled by WFSCancelAsyncRequest.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_TIMEOUT The timeout interval expired.
// WFS_ERR_VERSION_ERROR_IN_SRVC Within the service, a version mismatch of two modules occurred.
// Возможные коды завершения функции:
// WFS_ERR_CONNECTION_LOST The connection to the service is lost.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_INVALID_HSERVICE The hService parameter is not a valid service handle.
// WFS_ERR_INVALID_HWND The hWnd parameter is not a valid window handle.
// WFS_ERR_INVALID_POINTER A pointer parameter does not point to accessible memory.
// WFS_ERR_INVALID_TRACELEVEL The dwTraceLevel parameter does not correspond to a valid trace level or set of levels.
// WFS_ERR_SPI_VER_TOO_HIGH The range of versions of XFS SPI support requested by the XFS Manager is higher than any supported by this particular service provider.
// WFS_ERR_SPI_VER_TOO_LOW The range of versions of XFS SPI support requested by the XFS Manager is lower than any supported by this particular service provider.
// WFS_ERR_SRVC_VER_TOO_HIGH The range of versions of the service-specific interface support requested by the application is higher than any supported by the service provider for the logical service being opened.
// WFS_ERR_SRVC_VER_TOO_LOW The range of versions of the service-specific interface support requested by the application is lower than any supported by the service provider for the logical service being opened.
// WFS_ERR_VERSION_ERROR_IN_SRVC Within the service, a version mismatch of two modules occurred.
return WFS_SUCCESS;
}
/** Завершает сессию (серию запросов к сервису, инициированную вызовом SPI функции WFPOpen)
между XFS менеджером и указанным сервис-провайдером.
@par
Если провайдер заблокирован вызовом WFPLock, он автоматически будет разблокирован и отписан от
всех событий (если это не сделали ранее вызовом WFPDeregister).
@message WFS_CLOSE_COMPLETE
@param hService Закрываемый сервис-провайдер.
@param hWnd Окно, которое должно получить сообщение о завершении асинхронной операции.
@param ReqId Идентификатора запроса, который нужно передать окну `hWnd` при завершении операции.
*/
HRESULT SPI_API WFPClose(HSERVICE hService, HWND hWnd, REQUESTID ReqID) {
if (!pcsc.isValid(hService))
return WFS_ERR_INVALID_HSERVICE;
pcsc.remove(hService);
XFS::Result(ReqID, hService, WFS_SUCCESS).send(hWnd, WFS_CLOSE_COMPLETE);
// Возможные коды завершения асинхронного запроса (могут возвращаться и другие)
// WFS_ERR_CANCELED The request was canceled by WFSCancelAsyncRequest.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// Возможные коды завершения функции:
// WFS_ERR_CONNECTION_LOST The connection to the service is lost.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_INVALID_HSERVICE The hService parameter is not a valid service handle.
// WFS_ERR_INVALID_HWND The hWnd parameter is not a valid window handle.
return WFS_SUCCESS;
}
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/** Подписывает указанное окно на события указанных классов от указанного сервис-провайдера.
@message WFS_REGISTER_COMPLETE
@param hService Сервис, чьи сообщения требуется мониторить.
@param dwEventClass Логический OR классов сообщений, которые нужно мониторить. 0 означает, что
производится подписка на все классы событий.
@param hWndReg Окно, которое будет получать события указанных классов.
@param hWnd Окно, которое должно получить сообщение о завершении асинхронной операции.
@param ReqID Идентификатора запроса, который нужно передать окну `hWnd` при завершении операции.
*/
HRESULT SPI_API WFPRegister(HSERVICE hService, DWORD dwEventClass, HWND hWndReg, HWND hWnd, REQUESTID ReqID) {
// Регистрируем событие для окна.
if (!pcsc.addSubscriber(hService, hWndReg, dwEventClass)) {
// Если сервиса нет в PC/SC, то он потерян.
return WFS_ERR_INVALID_HSERVICE;
}
// Добавление подписчика всегда успешно.
XFS::Result(ReqID, hService, WFS_SUCCESS).send(hWnd, WFS_REGISTER_COMPLETE);
// Возможные коды завершения асинхронного запроса (могут возвращаться и другие)
// WFS_ERR_CANCELED The request was canceled by WFSCancelAsyncRequest.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// Возможные коды завершения функции:
// WFS_ERR_CONNECTION_LOST The connection to the service is lost.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_INVALID_EVENT_CLASS The dwEventClass parameter specifies one or more event classes not supported by the service.
// WFS_ERR_INVALID_HSERVICE The hService parameter is not a valid service handle.
// WFS_ERR_INVALID_HWND The hWnd parameter is not a valid window handle.
// WFS_ERR_INVALID_HWNDREG The hWndReg parameter is not a valid window handle.
return WFS_SUCCESS;
}
/** Прерывает мониторинг указанных классов сообщений от указанного сервис-провайдера для указанных окон.
@message WFS_DEREGISTER_COMPLETE
@param hService Сервис, чьи сообщения больше не требуется мониторить.
@param dwEventClass Логический OR классов сообщений, которые не нужно мониторить. 0 означает, что отписка
производится от всех классов событий.
@param hWndReg Окно, которое больше не должно получать указанные сообщения. NULL означает, что отписка
производится для всех окон.
@param hWnd Окно, которое должно получить сообщение о завершении асинхронной операции.
@param ReqID Идентификатора запроса, который нужно передать окну `hWnd` при завершении операции.
*/
HRESULT SPI_API WFPDeregister(HSERVICE hService, DWORD dwEventClass, HWND hWndReg, HWND hWnd, REQUESTID ReqID) {
// Отписываемся от событий. Если никого не было удалено, то никто не был зарегистрирован.
if (!pcsc.removeSubscriber(hService, hWndReg, dwEventClass)) {
// Если сервиса нет в PC/SC, то он потерян.
return WFS_ERR_INVALID_HSERVICE;
}
// Удаление подписчика всегда успешно.
XFS::Result(ReqID, hService, WFS_SUCCESS).send(hWnd, WFS_DEREGISTER_COMPLETE);
// Возможные коды завершения асинхронного запроса (могут возвращаться и другие)
// WFS_ERR_CANCELED The request was canceled by WFSCancelAsyncRequest.
// Возможные коды завершения функции:
// WFS_ERR_CONNECTION_LOST The connection to the service is lost.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_INVALID_EVENT_CLASS The dwEventClass parameter specifies one or more event classes not supported by the service.
// WFS_ERR_INVALID_HSERVICE The hService parameter is not a valid service handle.
// WFS_ERR_INVALID_HWND The hWnd parameter is not a valid window handle.
// WFS_ERR_INVALID_HWNDREG The hWndReg parameter is not a valid window handle.
// WFS_ERR_NOT_REGISTERED The specified hWndReg window was not registered to receive messages for any event classes.
return WFS_SUCCESS;
}
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/** Получает эксклюзивный доступ к устройству.
@message WFS_LOCK_COMPLETE
@param hService Сервис, к которому нужно получить эксклюзивный доступ.
@param dwTimeOut Таймаут (в мс), в течении которого необходимо получить доступ. `WFS_INDEFINITE_WAIT`,
если таймаут не требуется.
@param hWnd Окно, которое должно получить сообщение о завершении асинхронной операции.
@param ReqID Идентификатора запроса, который нужно передать окну `hWnd` при завершении операции.
*/
HRESULT SPI_API WFPLock(HSERVICE hService, DWORD dwTimeOut, HWND hWnd, REQUESTID ReqID) {
if (!pcsc.isValid(hService))
return WFS_ERR_INVALID_HSERVICE;
PCSC::Status st = pcsc.get(hService).lock();
XFS::Result(ReqID, hService, st).send(hWnd, WFS_LOCK_COMPLETE);
// Возможные коды завершения асинхронного запроса (могут возвращаться и другие)
// WFS_ERR_CANCELED The request was canceled by WFSCancelAsyncRequest.
// WFS_ERR_DEV_NOT_READY The function required device access, and the device was not ready or timed out.
// WFS_ERR_HARDWARE_ERROR The function required device access, and an error occurred on the device.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_SOFTWARE_ERROR The function required access to configuration information, and an error occurred on the software.
// WFS_ERR_TIMEOUT The timeout interval expired.
// Возможные коды завершения функции:
// WFS_ERR_CONNECTION_LOST The connection to the service is lost.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_INVALID_HSERVICE The hService parameter is not a valid service handle.
// WFS_ERR_INVALID_HWND The hWnd parameter is not a valid window handle.
return WFS_SUCCESS;
}
/**
@message WFS_UNLOCK_COMPLETE
@param hService Сервис, к которому больше ну нужно иметь эксклюзивный доступ.
@param hWnd Окно, которое должно получить сообщение о завершении асинхронной операции.
@param ReqID Идентификатора запроса, который нужно передать окну `hWnd` при завершении операции.
*/
HRESULT SPI_API WFPUnlock(HSERVICE hService, HWND hWnd, REQUESTID ReqID) {
if (!pcsc.isValid(hService))
return WFS_ERR_INVALID_HSERVICE;
PCSC::Status st = pcsc.get(hService).unlock();
XFS::Result(ReqID, hService, st).send(hWnd, WFS_UNLOCK_COMPLETE);
// Возможные коды завершения асинхронного запроса (могут возвращаться и другие)
// WFS_ERR_CANCELED The request was canceled by WFSCancelAsyncRequest.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_NOT_LOCKED The service to be unlocked is not locked under the calling hService.
// Возможные коды завершения функции:
// WFS_ERR_CONNECTION_LOST The connection to the service is lost.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_INVALID_HSERVICE The hService parameter is not a valid service handle.
// WFS_ERR_INVALID_HWND The hWnd parameter is not a valid window handle.
return WFS_SUCCESS;
}
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/** Получает различную информацию о сервис-провайдере.
@message WFS_GETINFO_COMPLETE
@param hService Хендл сервис-провайдера, о котором получается информация.
@param dwCategory Вид запрашиваемой информации. Поддерживаются только стандартные виды информации.
@param pQueryDetails Указатель на дополнительные данные для запроса или `NULL`, если их нет.
@param dwTimeOut Таймаут, за который нужно завершить операцию.
@param hWnd Окно, которое должно получить сообщение о завершении асинхронной операции.
@param ReqID Идентификатора запроса, который нужно передать окну `hWnd` при завершении операции.
*/
HRESULT SPI_API WFPGetInfo(HSERVICE hService, DWORD dwCategory, LPVOID lpQueryDetails, DWORD dwTimeOut, HWND hWnd, REQUESTID ReqID) {
if (!pcsc.isValid(hService))
return WFS_ERR_INVALID_HSERVICE;
// Для IDC могут запрашиваться только эти константы (WFS_INF_IDC_*)
switch (dwCategory) {
case WFS_INF_IDC_STATUS: { // Дополнительных параметров нет
std::pair<WFSIDCSTATUS*, PCSC::Status> status = pcsc.get(hService).getStatus();
// Получение информации о считывателе всегда успешно.
XFS::Result(ReqID, hService, WFS_SUCCESS).attach(status.first).send(hWnd, WFS_GETINFO_COMPLETE);
break;
}
case WFS_INF_IDC_CAPABILITIES: {// Дополнительных параметров нет
std::pair<WFSIDCCAPS*, PCSC::Status> caps = pcsc.get(hService).getCaps();
XFS::Result(ReqID, hService, caps.second).attach(caps.first).send(hWnd, WFS_GETINFO_COMPLETE);
break;
}
case WFS_INF_IDC_FORM_LIST:
case WFS_INF_IDC_QUERY_FORM: {
// Формы не поддерживаем. Форма определяет, в каких местах на треках находятся данные.
// Так как треки мы не читаем и не пишем, то формы не поддерживаем.
return WFS_ERR_UNSUPP_COMMAND;
}
default:
return WFS_ERR_INVALID_CATEGORY;
}
// Возможные коды завершения асинхронного запроса (могут возвращаться и другие)
// WFS_ERR_CANCELED The request was canceled by WFSCancelAsyncRequest.
// WFS_ERR_DEV_NOT_READY The function required device access, and the device was not ready or timed out.
// WFS_ERR_HARDWARE_ERROR The function required device access, and an error occurred on the device.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_INVALID_DATA The data structure passed as input parameter contains invalid data..
// WFS_ERR_SOFTWARE_ERROR The function required access to configuration information, and an error occurred on the software.
// WFS_ERR_TIMEOUT The timeout interval expired.
// WFS_ERR_USER_ERROR A user is preventing proper operation of the device.
// WFS_ERR_UNSUPP_DATA The data structure passed as an input parameter although valid for this service class, is not supported by this service provider or device.
// Возможные коды завершения функции:
// WFS_ERR_CONNECTION_LOST The connection to the service is lost.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_INVALID_CATEGORY The dwCategory issued is not supported by this service class.
// WFS_ERR_INVALID_HSERVICE The hService parameter is not a valid service handle.
// WFS_ERR_INVALID_HWND The hWnd parameter is not a valid window handle.
// WFS_ERR_INVALID_POINTER A pointer parameter does not point to accessible memory.
// WFS_ERR_UNSUPP_CATEGORY The dwCategory issued, although valid for this service class, is not supported by this service provider.
return WFS_SUCCESS;
}
/** Посылает команду для выполнения карточным ридером.
@message WFS_EXECUTE_COMPLETE
@message WFS_EXEE_IDC_MEDIAINSERTED Генерируется, когда в устройстве появляется карточка.
@message WFS_SRVE_IDC_MEDIAREMOVED Генерируется, когда из устройства вынимается карточка.
@message WFS_EXEE_IDC_INVALIDMEDIA
@message WFS_SRVE_IDC_MEDIADETECTED
@message WFS_EXEE_IDC_INVALIDTRACKDATA Никогда не генерируется.
@message WFS_USRE_IDC_RETAINBINTHRESHOLD Никогда не генерируется.
@param hService Хендл сервис-провайдера, который должен выполнить команду.
@param dwCommand Вид выполняемой команды.
@param lpCmdData Даные для команды. Зависят от вида.
@param dwTimeOut Количество миллисекунд, за которое команда должна выполниться, или `WFS_INDEFINITE_WAIT`,
если таймаут не требуется.
@param hWnd Окно, которое должно получить сообщение о завершении асинхронной операции.
@param ReqID Идентификатора запроса, который нужно передать окну `hWnd` при завершении операции.
*/
HRESULT SPI_API WFPExecute(HSERVICE hService, DWORD dwCommand, LPVOID lpCmdData, DWORD dwTimeOut, HWND hWnd, REQUESTID ReqID) {
if (!pcsc.isValid(hService))
return WFS_ERR_INVALID_HSERVICE;
switch (dwCommand) {
// Ожидание вставки карты с указанным таймаутом, немедленное чтение треков согласно форме,
// переданой в параметре. Так как мы не умеем читать треки, то команда не поддерживается.
case WFS_CMD_IDC_READ_TRACK: {
if (lpCmdData == NULL) {
return WFS_ERR_INVALID_POINTER;
}
LPSTR formName = (LPSTR)lpCmdData;
return WFS_ERR_UNSUPP_COMMAND;
}
// Аналогично чтению треков.
case WFS_CMD_IDC_WRITE_TRACK: {
//WFSIDCWRITETRACK* input = (WFSIDCWRITETRACK*)lpCmdData;
return WFS_ERR_UNSUPP_COMMAND;
}
// Команда говорит считывателю вернуть карту. Так как наш считыватель не умеет сам что-либо
// делать с картой, эту команду мы не поддерживаем.
case WFS_CMD_IDC_EJECT_CARD: {// Входных параметров нет.
// Kalignite пытается извлечь карту, невзирая на то, что мы сообщает, что эта возможность
// не поддерживается, и падает с Fatal Error, если сообщить ему, что он требует невозможного,
// хотя по спецификации мы обязаны сообщать о том, что данная возможность не поддерживается
// кодом ответа WFS_ERR_UNSUPP_COMMAND и имеем право не поддерживать эту возможность.
if (pcsc.get(hService).settings().workarounds.canEject) {
XFS::Result(ReqID, hService, WFS_SUCCESS).eject().send(hWnd, WFS_EXECUTE_COMPLETE);
return WFS_SUCCESS;
}
return WFS_ERR_UNSUPP_COMMAND;
}
// Команда на захват карты считывателем. Аналогично предыдущей команде.
case WFS_CMD_IDC_RETAIN_CARD: {// Входных параметров нет.
return WFS_ERR_UNSUPP_COMMAND;
}
// Команда на сброс счетчика захваченных карт. Так как мы их не захватываем, то не поддерживаем.
case WFS_CMD_IDC_RESET_COUNT: {// Входных параметров нет.
return WFS_ERR_UNSUPP_COMMAND;
}
// Устанавливает DES-ключ, необходимый для работы модуля CIM86. Не поддерживаем,
// т.к. у нас нет такого модуля.
case WFS_CMD_IDC_SETKEY: {
//WFSIDCSETKEY* = (WFSIDCSETKEY*)lpCmdData;
return WFS_ERR_UNSUPP_COMMAND;
}
// Подключаем чип, сбрасываем его и читаем ATR (Answer To Reset).
// Также данная команда может быть использована для "холодного" сброса чипа.
// Эта команда не должна использоваться для постоянно присоединенного чипа.
//TODO: Чип постоянно подсоединен или нет?
case WFS_CMD_IDC_READ_RAW_DATA: {
if (lpCmdData == NULL) {
return WFS_ERR_INVALID_POINTER;
}
// Битовая маска с данными, которые должны быть прочитаны.
XFS::ReadFlags readData = *((WORD*)lpCmdData);
if (readData.value() & WFS_IDC_CHIP) {
pcsc.get(hService).asyncRead(dwTimeOut, hWnd, ReqID, readData);
return WFS_SUCCESS;
}
return WFS_ERR_UNSUPP_COMMAND;
}
// Ждет указанное время, пока не вставят карточку, а потом записывает данные на указанный трек.
// Не поддерживаем, т.к. не умеем писать треки.
case WFS_CMD_IDC_WRITE_RAW_DATA: {
//NULL-terminated массив
//WFSIDCCARDDATA** data = (WFSIDCCARDDATA**)lpCmdData;
return WFS_ERR_UNSUPP_COMMAND;
}
// Посылает данные чипу и получает от него ответ. Данные прозрачны для провайдера.
case WFS_CMD_IDC_CHIP_IO: {
if (lpCmdData == NULL) {
return WFS_ERR_INVALID_POINTER;
}
const WFSIDCCHIPIO* data = (const WFSIDCCHIPIO*)lpCmdData;
std::pair<WFSIDCCHIPIO*, PCSC::Status> result = pcsc.get(hService).transmit(data);
XFS::Result(ReqID, hService, result.second).attach(result.first).send(hWnd, WFS_EXECUTE_COMPLETE);
return WFS_SUCCESS;
}
// Отключает питание чипа.
case WFS_CMD_IDC_RESET: {
// Битовая маска. NULL означает, что провайдер сам решает, что делать.
WORD wResetIn = lpCmdData ? *((WORD*)lpCmdData) : WFS_IDC_NOACTION;
//TODO: Реализовать команду WFS_CMD_IDC_RESET
return WFS_ERR_UNSUPP_COMMAND;
}
case WFS_CMD_IDC_CHIP_POWER: {
if (lpCmdData == NULL) {
return WFS_ERR_INVALID_POINTER;
}
WORD wChipPower = *((WORD*)lpCmdData);
std::pair<WFSIDCCHIPPOWEROUT*, PCSC::Status> result = pcsc.get(hService).reset(wChipPower);
XFS::Result(ReqID, hService, result.second).attach(result.first).send(hWnd, WFS_EXECUTE_COMPLETE);
return WFS_SUCCESS;
}
// Разбирает результат, ранее возвращенный командой WFS_CMD_IDC_READ_RAW_DATA. Так как мы ее
// не поддерживаем, то и эту команду мы не поддерживаем.
case WFS_CMD_IDC_PARSE_DATA: {
// WFSIDCPARSEDATA* parseData = (WFSIDCPARSEDATA*)lpCmdData;
return WFS_ERR_UNSUPP_COMMAND;
}
default: {
// Все остальные команды недопустимы.
return WFS_ERR_INVALID_COMMAND;
}
}// switch (dwCommand)
// Возможные коды завершения асинхронного запроса (могут возвращаться и другие)
// WFS_ERR_CANCELED The request was canceled by WFSCancelAsyncRequest.
// WFS_ERR_DEV_NOT_READY The function required device access, and the device was not ready or timed out.
// WFS_ERR_HARDWARE_ERROR The function required device access, and an error occurred on the device.
// WFS_ERR_INVALID_DATA The data structure passed as input parameter contains invalid data..
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_LOCKED The service is locked under a different hService.
// WFS_ERR_SOFTWARE_ERROR The function required access to configuration information, and an error occurred on the software.
// WFS_ERR_TIMEOUT The timeout interval expired.
// WFS_ERR_USER_ERROR A user is preventing proper operation of the device.
// WFS_ERR_UNSUPP_DATA The data structure passed as an input parameter although valid for this service class, is not supported by this service provider or device.
// Возможные коды завершения функции:
// WFS_ERR_CONNECTION_LOST The connection to the service is lost.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_INVALID_COMMAND The dwCommand issued is not supported by this service class.
// WFS_ERR_INVALID_HSERVICE The hService parameter is not a valid service handle.
// WFS_ERR_INVALID_HWND The hWnd parameter is not a valid window handle.
// WFS_ERR_INVALID_POINTER A pointer parameter does not point to accessible memory.
// WFS_ERR_UNSUPP_COMMAND The dwCommand issued, although valid for this service class, is not supported by this service provider.
return WFS_ERR_INTERNAL_ERROR;
}
/** Отменяет указанный (либо все) асинхронный запрос, выполняемый провайдером, прежде, чем он завершится.
Все запросы, котрые не успели выпонится к этому времени, завершатся с кодом `WFS_ERR_CANCELED`.
Отмена запросов не поддерживается.
@param hService
@param ReqID Идентификатор запроса для отмены или `NULL`, если необходимо отменить все запросы
для указанного сервися `hService`.
*/
HRESULT SPI_API WFPCancelAsyncRequest(HSERVICE hService, REQUESTID ReqID) {
if (!pcsc.isValid(hService))
return WFS_ERR_INVALID_HSERVICE;
if (!pcsc.cancelTask(hService, ReqID)) {
return WFS_ERR_INVALID_REQ_ID;
}
// Возможные коды завершения функции:
// WFS_ERR_CONNECTION_LOST The connection to the service is lost.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_INVALID_HSERVICE The hService parameter is not a valid service handle.
// WFS_ERR_INVALID_REQ_ID The ReqID parameter does not correspond to an outstanding request on the service.
return WFS_SUCCESS;
}
HRESULT SPI_API WFPSetTraceLevel(HSERVICE hService, DWORD dwTraceLevel) {
if (!pcsc.isValid(hService))
return WFS_ERR_INVALID_HSERVICE;
pcsc.get(hService).setTraceLevel(dwTraceLevel);
// Возможные коды завершения функции:
// WFS_ERR_CONNECTION_LOST The connection to the service is lost.
// WFS_ERR_INTERNAL_ERROR An internal inconsistency or other unexpected error occurred in the XFS subsystem.
// WFS_ERR_INVALID_HSERVICE The hService parameter is not a valid service handle.
// WFS_ERR_INVALID_TRACELEVEL The dwTraceLevel parameter does not correspond to a valid trace level or set of levels.
// WFS_ERR_NOT_STARTED The application has not previously performed a successful WFSStartUp.
// WFS_ERR_OP_IN_PROGRESS A blocking operation is in progress on the thread; only WFSCancelBlockingCall and WFSIsBlocking are permitted at this time.
return WFS_SUCCESS;
}
/** Вызывается XFS для определения того, можно ли выгрузить DLL с данным сервис-провайдером прямо сейчас. */
HRESULT SPI_API WFPUnloadService() {
// Возможные коды завершения функции:
// WFS_ERR_NOT_OK_TO_UNLOAD
// The XFS Manager may not unload the service provider DLL at this time. It will repeat this
// request to the service provider until the return is WFS_SUCCESS, or until a new session is
// started by an application with this service provider.
return pcsc.isEmpty() ? WFS_SUCCESS : WFS_ERR_NOT_OK_TO_UNLOAD;
}
} // extern "C"