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