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  *  Ludovic Rousseau <ludovic.rousseau@free.fr>
00007  *
00008  * $Id: reader.h.in 1748 2005-11-24 16:00:29Z rousseau $
00009  */
00010 
00016 #ifndef __reader_h__
00017 #define __reader_h__
00018 
00019 /*
00020  * Tags for requesting card and reader attributes
00021  */
00022 
00023 #define SCARD_ATTR_VALUE(Class, Tag) ((((ULONG)(Class)) << 16) | ((ULONG)(Tag)))
00024 
00025 #define SCARD_CLASS_VENDOR_INFO     1   /* Vendor information definitions */
00026 #define SCARD_CLASS_COMMUNICATIONS  2   /* Communication definitions */
00027 #define SCARD_CLASS_PROTOCOL        3   /* Protocol definitions */
00028 #define SCARD_CLASS_POWER_MGMT      4   /* Power Management definitions */
00029 #define SCARD_CLASS_SECURITY        5   /* Security Assurance definitions */
00030 #define SCARD_CLASS_MECHANICAL      6   /* Mechanical characteristic definitions */
00031 #define SCARD_CLASS_VENDOR_DEFINED  7   /* Vendor specific definitions */
00032 #define SCARD_CLASS_IFD_PROTOCOL    8   /* Interface Device Protocol options */
00033 #define SCARD_CLASS_ICC_STATE       9   /* ICC State specific definitions */
00034 #define SCARD_CLASS_SYSTEM     0x7fff   /* System-specific definitions */
00035 
00036 #define SCARD_ATTR_VENDOR_NAME SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0100)
00037 #define SCARD_ATTR_VENDOR_IFD_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0101)
00038 #define SCARD_ATTR_VENDOR_IFD_VERSION SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0102)
00039 #define SCARD_ATTR_VENDOR_IFD_SERIAL_NO SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0103)
00040 #define SCARD_ATTR_CHANNEL_ID SCARD_ATTR_VALUE(SCARD_CLASS_COMMUNICATIONS, 0x0110)
00041 #define SCARD_ATTR_ASYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0120)
00042 #define SCARD_ATTR_DEFAULT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0121)
00043 #define SCARD_ATTR_MAX_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0122)
00044 #define SCARD_ATTR_DEFAULT_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0123)
00045 #define SCARD_ATTR_MAX_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0124)
00046 #define SCARD_ATTR_MAX_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0125)
00047 #define SCARD_ATTR_SYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0126)
00048 #define SCARD_ATTR_POWER_MGMT_SUPPORT SCARD_ATTR_VALUE(SCARD_CLASS_POWER_MGMT, 0x0131)
00049 #define SCARD_ATTR_USER_TO_CARD_AUTH_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0140)
00050 #define SCARD_ATTR_USER_AUTH_INPUT_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0142)
00051 #define SCARD_ATTR_CHARACTERISTICS SCARD_ATTR_VALUE(SCARD_CLASS_MECHANICAL, 0x0150)
00052 
00053 #define SCARD_ATTR_CURRENT_PROTOCOL_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0201)
00054 #define SCARD_ATTR_CURRENT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0202)
00055 #define SCARD_ATTR_CURRENT_F SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0203)
00056 #define SCARD_ATTR_CURRENT_D SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0204)
00057 #define SCARD_ATTR_CURRENT_N SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0205)
00058 #define SCARD_ATTR_CURRENT_W SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0206)
00059 #define SCARD_ATTR_CURRENT_IFSC SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0207)
00060 #define SCARD_ATTR_CURRENT_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0208)
00061 #define SCARD_ATTR_CURRENT_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0209)
00062 #define SCARD_ATTR_CURRENT_CWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020a)
00063 #define SCARD_ATTR_CURRENT_EBC_ENCODING SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020b)
00064 #define SCARD_ATTR_EXTENDED_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020c)
00065 
00066 #define SCARD_ATTR_ICC_PRESENCE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0300)
00067 #define SCARD_ATTR_ICC_INTERFACE_STATUS SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0301)
00068 #define SCARD_ATTR_CURRENT_IO_STATE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0302)
00069 #define SCARD_ATTR_ATR_STRING SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0303)
00070 #define SCARD_ATTR_ICC_TYPE_PER_ATR SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0304)
00071 
00072 #define SCARD_ATTR_ESC_RESET SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA000)
00073 #define SCARD_ATTR_ESC_CANCEL SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA003)
00074 #define SCARD_ATTR_ESC_AUTHREQUEST SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA005)
00075 #define SCARD_ATTR_MAXINPUT SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA007)
00076 
00077 #define SCARD_ATTR_DEVICE_UNIT SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0001)
00078 #define SCARD_ATTR_DEVICE_IN_USE SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0002)
00079 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0003)
00080 #define SCARD_ATTR_DEVICE_SYSTEM_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0004)
00081 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0005)
00082 #define SCARD_ATTR_DEVICE_SYSTEM_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0006)
00083 #define SCARD_ATTR_SUPRESS_T1_IFS_REQUEST SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0007)
00084 
00085 #ifdef UNICODE
00086 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_W
00087 #define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_W
00088 #else
00089 #define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_A
00090 #define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_A
00091 #endif
00092 
00093 /*
00094  * Provide source compatibility on different platforms
00095  */
00096 #define SCARD_CTL_CODE(code) (0x42000000 + (code))
00097 
00098 /*
00099  * TeleTrust Class 2 reader tags
00100  */
00101 #define CM_IOCTL_GET_FEATURE_REQUEST SCARD_CTL_CODE(3400)
00102 
00103 #define FEATURE_VERIFY_PIN_START  0x01 /* OMNIKEY Proposal */
00104 #define FEATURE_VERIFY_PIN_FINISH 0x02 /* OMNIKEY Proposal */
00105 #define FEATURE_MODIFY_PIN_START  0x03 /* OMNIKEY Proposal */
00106 #define FEATURE_MODIFY_PIN_FINISH 0x04 /* OMNIKEY Proposal */
00107 #define FEATURE_GET_KEY_PRESSED   0x05 /* OMNIKEY Proposal */
00108 #define FEATURE_VERIFY_PIN_DIRECT 0x06 /* USB CCID PIN Verify */
00109 #define FEATURE_MODIFY_PIN_DIRECT 0x07 /* USB CCID PIN Modify */
00110 #define FEATURE_MCT_READERDIRECT  0x08 /* KOBIL Proposal */
00111 #define FEATURE_MCT_UNIVERSAL     0x09 /* KOBIL Proposal */
00112 #define FEATURE_IFD_PIN_PROP      0x0A /* Gemplus Proposal */
00113 #define FEATURE_ABORT             0x0B /* SCM Proposal */
00114 
00115 /* structures used (but not defined) in PCSC Part 10 revision 2.01.02:
00116  * "IFDs with Secure Pin Entry Capabilities" */
00117 
00118 #include <inttypes.h>
00119 
00120 /* Set structure elements aligment on bytes
00121  * http://gcc.gnu.org/onlinedocs/gcc/Structure_002dPacking-Pragmas.html */
00122 #ifdef __APPLE__
00123 #pragma pack(1)
00124 #else
00125 #pragma pack(push, 1)
00126 #endif
00127 
00128 /* the structure must be 6-bytes long */
00129 typedef struct
00130 {
00131     uint8_t tag;
00132     uint8_t length;
00133     uint32_t value;
00134 } PCSC_TLV_STRUCTURE;
00135 
00136 /* the wLangId and wPINMaxExtraDigit are 16-bits long so are subject to byte
00137  * ordering */
00138 #define HOST_TO_CCID_16(x) (x)
00139 #define HOST_TO_CCID_32(x) (x)
00140 
00141 typedef struct
00142 {
00143     uint8_t bTimerOut;  /* timeout is seconds (00 means use default timeout) */
00144     uint8_t bTimerOut2; /* timeout in seconds after first key stroke */
00145     uint8_t bmFormatString; /* formatting options */
00146     uint8_t bmPINBlockString; /* bits 7-4 bit size of PIN length in APDU,
00147                             * bits 3-0 PIN block size in bytes after
00148                             * justification and formatting */
00149     uint8_t bmPINLengthFormat; /* bits 7-5 RFU,
00150                              * bit 4 set if system units are bytes, clear if
00151                              * system units are bits,
00152                              * bits 3-0 PIN length position in system units */
00153     uint16_t wPINMaxExtraDigit; /* 0xXXYY where XX is minimum PIN size in digits,
00154                                 and YY is maximum PIN size in digits */
00155     uint8_t bEntryValidationCondition; /* Conditions under which PIN entry should
00156                                      * be considered complete */
00157     uint8_t bNumberMessage; /* Number of messages to display for PIN verification */
00158     uint16_t wLangId; /* Language for messages */
00159     uint8_t bMsgIndex; /* Message index (should be 00) */
00160     uint8_t bTeoPrologue[3]; /* T=1 block prologue field to use (fill with 00) */
00161     uint32_t ulDataLength; /* length of Data to be sent to the ICC */
00162     uint8_t abData[1]; /* Data to send to the ICC */
00163 } PIN_VERIFY_STRUCTURE;
00164 
00165 typedef struct
00166 {
00167     uint8_t bTimerOut;  /* timeout is seconds (00 means use default timeout) */
00168     uint8_t bTimerOut2; /* timeout in seconds after first key stroke */
00169     uint8_t bmFormatString; /* formatting options */
00170     uint8_t bmPINBlockString; /* bits 7-4 bit size of PIN length in APDU,
00171                             * bits 3-0 PIN block size in bytes after
00172                             * justification and formatting */
00173     uint8_t bmPINLengthFormat; /* bits 7-5 RFU,
00174                              * bit 4 set if system units are bytes, clear if
00175                              * system units are bits,
00176                              * bits 3-0 PIN length position in system units */
00177     uint8_t bInsertionOffsetOld; /* Insertion position offset in bytes for
00178                                  the current PIN */
00179     uint8_t bInsertionOffsetNew; /* Insertion position offset in bytes for
00180                                  the new PIN */
00181     uint16_t wPINMaxExtraDigit;
00182                              /* 0xXXYY where XX is minimum PIN size in digits,
00183                                 and YY is maximum PIN size in digits */
00184     uint8_t bConfirmPIN; /* Flags governing need for confirmation of new PIN */
00185     uint8_t bEntryValidationCondition; /* Conditions under which PIN entry should
00186                                      * be considered complete */
00187     uint8_t bNumberMessage; /* Number of messages to display for PIN verification*/
00188     uint16_t wLangId; /* Language for messages */
00189     uint8_t bMsgIndex1; /* index of 1st prompting message */
00190     uint8_t bMsgIndex2; /* index of 2d prompting message */
00191     uint8_t bMsgIndex3; /* index of 3d prompting message */
00192     uint8_t bTeoPrologue[3]; /* T=1 block prologue field to use (fill with 00) */
00193     uint32_t ulDataLength; /* length of Data to be sent to the ICC */
00194     uint8_t abData[1]; /* Data to send to the ICC */
00195 } PIN_MODIFY_STRUCTURE;
00196 
00197 /* restore default structure elements alignment */
00198 #ifdef __APPLE__
00199 #pragma pack()
00200 #else
00201 #pragma pack(pop)
00202 #endif
00203 
00204 #endif
00205 

Generated on Sat Sep 15 17:18:32 2007 for pcsc-lite by  doxygen 1.4.7