reader.h

Go to the documentation of this file.
00001 /*
00002  * MUSCLE SmartCard Development ( http://www.linuxnet.com )
00003  *
00004  * Copyright (C) 1999-2005
00005  *  David Corcoran <corcoran@linuxnet.com>
00006  * Copyright (C) 1999-2009
00007  *  Ludovic Rousseau <ludovic.rousseau@free.fr>
00008  *
00009  * $Id: reader.h.in 4210 2009-05-14 13:14:59Z rousseau $
00010  */
00011 
00017 #ifndef __reader_h__
00018 #define __reader_h__
00019 
00020 /*
00021  * Tags for requesting card and reader attributes
00022  */
00023 
00024 #define SCARD_ATTR_VALUE(Class, Tag) ((((ULONG)(Class)) << 16) | ((ULONG)(Tag)))
00025 
00026 #define SCARD_CLASS_VENDOR_INFO     1   
00027 #define SCARD_CLASS_COMMUNICATIONS  2   
00028 #define SCARD_CLASS_PROTOCOL        3   
00029 #define SCARD_CLASS_POWER_MGMT      4   
00030 #define SCARD_CLASS_SECURITY        5   
00031 #define SCARD_CLASS_MECHANICAL      6   
00032 #define SCARD_CLASS_VENDOR_DEFINED  7   
00033 #define SCARD_CLASS_IFD_PROTOCOL    8   
00034 #define SCARD_CLASS_ICC_STATE       9   
00035 #define SCARD_CLASS_SYSTEM     0x7fff   
00037 #define SCARD_ATTR_VENDOR_NAME SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0100) 
00038 #define SCARD_ATTR_VENDOR_IFD_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0101) 
00039 #define SCARD_ATTR_VENDOR_IFD_VERSION SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0102) 
00040 #define SCARD_ATTR_VENDOR_IFD_SERIAL_NO SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0103) 
00041 #define SCARD_ATTR_CHANNEL_ID SCARD_ATTR_VALUE(SCARD_CLASS_COMMUNICATIONS, 0x0110) 
00042 #define SCARD_ATTR_ASYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0120) 
00043 #define SCARD_ATTR_DEFAULT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0121) 
00044 #define SCARD_ATTR_MAX_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0122) 
00045 #define SCARD_ATTR_DEFAULT_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0123) 
00046 #define SCARD_ATTR_MAX_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0124) 
00047 #define SCARD_ATTR_MAX_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0125) 
00048 #define SCARD_ATTR_SYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0126) 
00049 #define SCARD_ATTR_POWER_MGMT_SUPPORT SCARD_ATTR_VALUE(SCARD_CLASS_POWER_MGMT, 0x0131) 
00050 #define SCARD_ATTR_USER_TO_CARD_AUTH_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0140) 
00051 #define SCARD_ATTR_USER_AUTH_INPUT_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0142) 
00052 #define SCARD_ATTR_CHARACTERISTICS SCARD_ATTR_VALUE(SCARD_CLASS_MECHANICAL, 0x0150) 
00054 #define SCARD_ATTR_CURRENT_PROTOCOL_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0201) 
00055 #define SCARD_ATTR_CURRENT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0202) 
00056 #define SCARD_ATTR_CURRENT_F SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0203) 
00057 #define SCARD_ATTR_CURRENT_D SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0204) 
00058 #define SCARD_ATTR_CURRENT_N SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0205) 
00059 #define SCARD_ATTR_CURRENT_W SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0206) 
00060 #define SCARD_ATTR_CURRENT_IFSC SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0207) 
00061 #define SCARD_ATTR_CURRENT_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0208) 
00062 #define SCARD_ATTR_CURRENT_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0209) 
00063 #define SCARD_ATTR_CURRENT_CWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020a) 
00064 #define SCARD_ATTR_CURRENT_EBC_ENCODING SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020b) 
00065 #define SCARD_ATTR_EXTENDED_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020c) 
00067 #define SCARD_ATTR_ICC_PRESENCE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0300) 
00068 #define SCARD_ATTR_ICC_INTERFACE_STATUS SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0301) 
00069 #define SCARD_ATTR_CURRENT_IO_STATE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0302) 
00070 #define SCARD_ATTR_ATR_STRING SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0303) 
00071 #define SCARD_ATTR_ICC_TYPE_PER_ATR SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0304) 
00073 #define SCARD_ATTR_ESC_RESET SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA000) 
00074 #define SCARD_ATTR_ESC_CANCEL SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA003) 
00075 #define SCARD_ATTR_ESC_AUTHREQUEST SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA005) 
00076 #define SCARD_ATTR_MAXINPUT SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA007) 
00078 #define SCARD_ATTR_DEVICE_UNIT SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0001) 
00079 #define SCARD_ATTR_DEVICE_IN_USE SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0002) 
00080 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0003)
00081 #define SCARD_ATTR_DEVICE_SYSTEM_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0004)
00082 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0005)
00083 #define SCARD_ATTR_DEVICE_SYSTEM_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0006)
00084 #define SCARD_ATTR_SUPRESS_T1_IFS_REQUEST SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0007) 
00086 #ifdef UNICODE
00087 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_W 
00088 #define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_W 
00089 #else
00090 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_A 
00091 #define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_A 
00092 #endif
00093 
00097 #define SCARD_CTL_CODE(code) (0x42000000 + (code))
00098 
00102 #define CM_IOCTL_GET_FEATURE_REQUEST SCARD_CTL_CODE(3400)
00103 
00104 #define FEATURE_VERIFY_PIN_START         0x01
00105 #define FEATURE_VERIFY_PIN_FINISH        0x02
00106 #define FEATURE_MODIFY_PIN_START         0x03
00107 #define FEATURE_MODIFY_PIN_FINISH        0x04
00108 #define FEATURE_GET_KEY_PRESSED          0x05
00109 #define FEATURE_VERIFY_PIN_DIRECT        0x06 
00110 #define FEATURE_MODIFY_PIN_DIRECT        0x07 
00111 #define FEATURE_MCT_READERDIRECT         0x08
00112 #define FEATURE_MCT_UNIVERSAL            0x09
00113 #define FEATURE_IFD_PIN_PROPERTIES       0x0A 
00114 #define FEATURE_ABORT                    0x0B
00115 #define FEATURE_SET_SPE_MESSAGE          0x0C
00116 #define FEATURE_VERIFY_PIN_DIRECT_APP_ID 0x0D
00117 #define FEATURE_MODIFY_PIN_DIRECT_APP_ID 0x0E
00118 #define FEATURE_WRITE_DISPLAY            0x0F
00119 #define FEATURE_GET_KEY                  0x10
00120 #define FEATURE_IFD_DISPLAY_PROPERTIES   0x11
00121 
00122 /* structures used (but not defined) in PC/SC Part 10 revision 2.02.05:
00123  * "IFDs with Secure Pin Entry Capabilities" */
00124 
00125 #include <inttypes.h>
00126 
00127 /* Set structure elements aligment on bytes
00128  * http://gcc.gnu.org/onlinedocs/gcc/Structure_002dPacking-Pragmas.html */
00129 #if defined(__APPLE__) | defined(sun)
00130 #pragma pack(1)
00131 #else
00132 #pragma pack(push, 1)
00133 #endif
00134 
00136 typedef struct
00137 {
00138     uint8_t tag;
00139     uint8_t length;
00140     uint32_t value; 
00141 } PCSC_TLV_STRUCTURE;
00142 
00145 #define HOST_TO_CCID_16(x) (x)
00146 #define HOST_TO_CCID_32(x) (x)
00147 
00149 typedef struct
00150 {
00151     uint8_t bTimerOut;  
00152     uint8_t bTimerOut2; 
00153     uint8_t bmFormatString; 
00154     uint8_t bmPINBlockString; 
00157     uint8_t bmPINLengthFormat; 
00161     uint16_t wPINMaxExtraDigit; 
00163     uint8_t bEntryValidationCondition; 
00165     uint8_t bNumberMessage; 
00166     uint16_t wLangId; 
00167     uint8_t bMsgIndex; 
00168     uint8_t bTeoPrologue[3]; 
00169     uint32_t ulDataLength; 
00170     uint8_t abData[1]; 
00171 } PIN_VERIFY_STRUCTURE;
00172 
00174 typedef struct
00175 {
00176     uint8_t bTimerOut;  
00177     uint8_t bTimerOut2; 
00178     uint8_t bmFormatString; 
00179     uint8_t bmPINBlockString; 
00182     uint8_t bmPINLengthFormat; 
00186     uint8_t bInsertionOffsetOld; 
00188     uint8_t bInsertionOffsetNew; 
00190     uint16_t wPINMaxExtraDigit;
00193     uint8_t bConfirmPIN; 
00194     uint8_t bEntryValidationCondition; 
00196     uint8_t bNumberMessage; 
00197     uint16_t wLangId; 
00198     uint8_t bMsgIndex1; 
00199     uint8_t bMsgIndex2; 
00200     uint8_t bMsgIndex3; 
00201     uint8_t bTeoPrologue[3]; 
00202     uint32_t ulDataLength; 
00203     uint8_t abData[1]; 
00204 } PIN_MODIFY_STRUCTURE;
00205 
00207 typedef struct {
00208     uint16_t wLcdLayout; 
00209     uint16_t wLcdMaxCharacters;
00210     uint16_t wLcdMaxLines;
00211     uint8_t bEntryValidationCondition;
00212     uint8_t bTimeOut2;
00213 } PIN_PROPERTIES_STRUCTURE;
00214 
00215 /* restore default structure elements alignment */
00216 #if defined(__APPLE__) | defined(sun)
00217 #pragma pack()
00218 #else
00219 #pragma pack(pop)
00220 #endif
00221 
00222 #endif
00223