pcsclite.h

   1 /*
   2  * MUSCLE SmartCard Development ( http://www.linuxnet.com )
   3  *
   4  * Copyright (C) 1999-2004
   5  *  David Corcoran <corcoran@linuxnet.com>
   6  *  Ludovic Rousseau <ludovic.rousseau@free.fr>
   7  *
   8  * $Id: pcsclite.h.in 4316 2009-07-16 14:47:03Z rousseau $
   9  */
  10
  11 /**
  12  * @file
  13  * @brief This keeps a list of defines for pcsc-lite.
  14  *
  15  * Error codes from http://msdn.microsoft.com/en-us/library/aa924526.aspx
  16  */
  17
  18 #ifndef __pcsclite_h__
  19 #define __pcsclite_h__
  20
  21 #include <wintypes.h>
  22
  23 #ifdef __cplusplus
  24 extern "C"
  25 {
  26 #endif
  27
  28 typedef long SCARDCONTEXT; /**< \p hContext returned by SCardEstablishContext() */
  29 typedef SCARDCONTEXT *PSCARDCONTEXT;
  30 typedef SCARDCONTEXT *LPSCARDCONTEXT;
  31 typedef long SCARDHANDLE; /**< \p hCard returned by SCardConnect() */
  32 typedef SCARDHANDLE *PSCARDHANDLE;
  33 typedef SCARDHANDLE *LPSCARDHANDLE;
  34
  35 #define MAX_ATR_SIZE                    33      /**< Maximum ATR size */
  36
  37 typedef struct
  38 {
  39         const char *szReader;
  40         void *pvUserData;
  41         unsigned long dwCurrentState;
  42         unsigned long dwEventState;
  43         unsigned long cbAtr;
  44         unsigned char rgbAtr[MAX_ATR_SIZE];
  45 }
  46 SCARD_READERSTATE_A;
  47
  48 typedef SCARD_READERSTATE_A SCARD_READERSTATE, *PSCARD_READERSTATE_A,
  49         *LPSCARD_READERSTATE_A;
  50
  51 /** Protocol Control Information (PCI) */
  52 typedef struct
  53 {
  54         unsigned long dwProtocol;       /**< Protocol identifier */
  55         unsigned long cbPciLength;      /**< Protocol Control Inf Length */
  56 }
  57 SCARD_IO_REQUEST, *PSCARD_IO_REQUEST, *LPSCARD_IO_REQUEST;
  58
  59 typedef const SCARD_IO_REQUEST *LPCSCARD_IO_REQUEST;
  60
  61 extern SCARD_IO_REQUEST g_rgSCardT0Pci, g_rgSCardT1Pci,
  62         g_rgSCardRawPci;
  63
  64 #define SCARD_PCI_T0    (&g_rgSCardT0Pci) /**< protocol control information (PCI) for T=0 */
  65 #define SCARD_PCI_T1    (&g_rgSCardT1Pci) /**< protocol control information (PCI) for T=1 */
  66 #define SCARD_PCI_RAW   (&g_rgSCardRawPci) /**< protocol control information (PCI) for RAW protocol */
  67
  68 /** error codes from http://msdn.microsoft.com/en-us/library/aa924526.aspx
  69  */
  70 #define SCARD_S_SUCCESS                 0x00000000 /**< No error was encountered. */
  71 #define SCARD_F_INTERNAL_ERROR          0x80100001 /**< An internal consistency check failed. */
  72 #define SCARD_E_CANCELLED               0x80100002 /**< The action was cancelled by an SCardCancel request. */
  73 #define SCARD_E_INVALID_HANDLE          0x80100003 /**< The supplied handle was invalid. */
  74 #define SCARD_E_INVALID_PARAMETER       0x80100004 /**< One or more of the supplied parameters could not be properly interpreted. */
  75 #define SCARD_E_INVALID_TARGET          0x80100005 /**< Registry startup information is missing or invalid. */
  76 #define SCARD_E_NO_MEMORY               0x80100006 /**< Not enough memory available to complete this command. */
  77 #define SCARD_F_WAITED_TOO_LONG         0x80100007 /**< An internal consistency timer has expired. */
  78 #define SCARD_E_INSUFFICIENT_BUFFER     0x80100008 /**< The data buffer to receive returned data is too small for the returned data. */
  79 #define SCARD_E_UNKNOWN_READER          0x80100009 /**< The specified reader name is not recognized. */
  80 #define SCARD_E_TIMEOUT                 0x8010000A /**< The user-specified timeout value has expired. */
  81 #define SCARD_E_SHARING_VIOLATION       0x8010000B /**< The smart card cannot be accessed because of other connections outstanding. */
  82 #define SCARD_E_NO_SMARTCARD            0x8010000C /**< The operation requires a Smart Card, but no Smart Card is currently in the device. */
  83 #define SCARD_E_UNKNOWN_CARD            0x8010000D /**< The specified smart card name is not recognized. */
  84 #define SCARD_E_CANT_DISPOSE            0x8010000E /**< The system could not dispose of the media in the requested manner. */
  85 #define SCARD_E_PROTO_MISMATCH          0x8010000F /**< The requested protocols are incompatible with the protocol currently in use with the smart card. */
  86 #define SCARD_E_NOT_READY               0x80100010 /**< The reader or smart card is not ready to accept commands. */
  87 #define SCARD_E_INVALID_VALUE           0x80100011 /**< One or more of the supplied parameters values could not be properly interpreted. */
  88 #define SCARD_E_SYSTEM_CANCELLED        0x80100012 /**< The action was cancelled by the system, presumably to log off or shut down. */
  89 #define SCARD_F_COMM_ERROR              0x80100013 /**< An internal communications error has been detected. */
  90 #define SCARD_F_UNKNOWN_ERROR           0x80100014 /**< An internal error has been detected, but the source is unknown. */
  91 #define SCARD_E_INVALID_ATR             0x80100015 /**< An ATR obtained from the registry is not a valid ATR string. */
  92 #define SCARD_E_NOT_TRANSACTED          0x80100016 /**< An attempt was made to end a non-existent transaction. */
  93 #define SCARD_E_READER_UNAVAILABLE      0x80100017 /**< The specified reader is not currently available for use. */
  94 #define SCARD_P_SHUTDOWN                0x80100018 /**< The operation has been aborted to allow the server application to exit. */
  95 #define SCARD_E_PCI_TOO_SMALL           0x80100019 /**< The PCI Receive buffer was too small. */
  96 #define SCARD_E_READER_UNSUPPORTED      0x8010001A /**< The reader driver does not meet minimal requirements for support. */
  97 #define SCARD_E_DUPLICATE_READER        0x8010001B /**< The reader driver did not produce a unique reader name. */
  98 #define SCARD_E_CARD_UNSUPPORTED        0x8010001C /**< The smart card does not meet minimal requirements for support. */
  99 #define SCARD_E_NO_SERVICE              0x8010001D /**< The Smart card resource manager is not running. */
 100 #define SCARD_E_SERVICE_STOPPED         0x8010001E /**< The Smart card resource manager has shut down. */
 101 #define SCARD_E_UNEXPECTED              0x8010001F /**< An unexpected card error has occurred. */
 102 #define SCARD_E_ICC_INSTALLATION        0x80100020 /**< No primary provider can be found for the smart card. */
 103 #define SCARD_E_ICC_CREATEORDER         0x80100021 /**< The requested order of object creation is not supported. */
 104 /* #define SCARD_E_UNSUPPORTED_FEATURE  0x80100022 / **< This smart card does not support the requested feature. */
 105 #define SCARD_E_DIR_NOT_FOUND           0x80100023 /**< The identified directory does not exist in the smart card. */
 106 #define SCARD_E_FILE_NOT_FOUND          0x80100024 /**< The identified file does not exist in the smart card. */
 107 #define SCARD_E_NO_DIR                  0x80100025 /**< The supplied path does not represent a smart card directory. */
 108 #define SCARD_E_NO_FILE                 0x80100026 /**< The supplied path does not represent a smart card file. */
 109 #define SCARD_E_NO_ACCESS               0x80100027 /**< Access is denied to this file. */
 110 #define SCARD_E_WRITE_TOO_MANY          0x80100028 /**< The smart card does not have enough memory to store the information. */
 111 #define SCARD_E_BAD_SEEK                0x80100029 /**< There was an error trying to set the smart card file object pointer. */
 112 #define SCARD_E_INVALID_CHV             0x8010002A /**< The supplied PIN is incorrect. */
 113 #define SCARD_E_UNKNOWN_RES_MNG         0x8010002B /**< An unrecognized error code was returned from a layered component. */
 114 #define SCARD_E_NO_SUCH_CERTIFICATE     0x8010002C /**< The requested certificate does not exist. */
 115 #define SCARD_E_CERTIFICATE_UNAVAILABLE 0x8010002D /**< The requested certificate could not be obtained. */
 116 #define SCARD_E_NO_READERS_AVAILABLE    0x8010002E /**< Cannot find a smart card reader. */
 117 #define SCARD_E_COMM_DATA_LOST          0x8010002F /**< A communications error with the smart card has been detected. Retry the operation. */
 118 #define SCARD_E_NO_KEY_CONTAINER        0x80100030 /**< The requested key container does not exist on the smart card. */
 119 #define SCARD_E_SERVER_TOO_BUSY         0x80100031 /**< The Smart Card Resource Manager is too busy to complete this operation. */
 120
 121 #define SCARD_W_UNSUPPORTED_CARD        0x80100065 /**< The reader cannot communicate with the card, due to ATR string configuration conflicts. */
 122 #define SCARD_W_UNRESPONSIVE_CARD       0x80100066 /**< The smart card is not responding to a reset. */
 123 #define SCARD_W_UNPOWERED_CARD          0x80100067 /**< Power has been removed from the smart card, so that further communication is not possible. */
 124 #define SCARD_W_RESET_CARD              0x80100068 /**< The smart card has been reset, so any shared state information is invalid. */
 125 #define SCARD_W_REMOVED_CARD            0x80100069 /**< The smart card has been removed, so further communication is not possible. */
 126
 127 #define SCARD_W_SECURITY_VIOLATION      0x8010006A /**< Access was denied because of a security violation. */
 128 #define SCARD_W_WRONG_CHV               0x8010006B /**< The card cannot be accessed because the wrong PIN was presented. */
 129 #define SCARD_W_CHV_BLOCKED             0x8010006C /**< The card cannot be accessed because the maximum number of PIN entry attempts has been reached. */
 130 #define SCARD_W_EOF                     0x8010006D /**< The end of the smart card file has been reached. */
 131 #define SCARD_W_CANCELLED_BY_USER       0x8010006E /**< The user pressed "Cancel" on a Smart Card Selection Dialog. */
 132 #define SCARD_W_CARD_NOT_AUTHENTICATED  0x8010006F /**< No PIN was presented to the smart card. */
 133
 134 #define SCARD_AUTOALLOCATE (DWORD)(-1)  /**< see SCardFreeMemory() */
 135 #define SCARD_SCOPE_USER                0x0000  /**< Scope in user space */
 136 #define SCARD_SCOPE_TERMINAL            0x0001  /**< Scope in terminal */
 137 #define SCARD_SCOPE_SYSTEM              0x0002  /**< Scope in system */
 138
 139 #define SCARD_PROTOCOL_UNDEFINED        0x0000  /**< protocol not set */
 140 #define SCARD_PROTOCOL_UNSET SCARD_PROTOCOL_UNDEFINED   /* backward compat */
 141 #define SCARD_PROTOCOL_T0               0x0001  /**< T=0 active protocol. */
 142 #define SCARD_PROTOCOL_T1               0x0002  /**< T=1 active protocol. */
 143 #define SCARD_PROTOCOL_RAW              0x0004  /**< Raw active protocol. */
 144 #define SCARD_PROTOCOL_T15              0x0008  /**< T=15 protocol. */
 145
 146 #define SCARD_PROTOCOL_ANY              (SCARD_PROTOCOL_T0|SCARD_PROTOCOL_T1)   /**< IFD determines prot. */
 147
 148 #define SCARD_SHARE_EXCLUSIVE           0x0001  /**< Exclusive mode only */
 149 #define SCARD_SHARE_SHARED              0x0002  /**< Shared mode only */
 150 #define SCARD_SHARE_DIRECT              0x0003  /**< Raw mode only */
 151
 152 #define SCARD_LEAVE_CARD                0x0000  /**< Do nothing on close */
 153 #define SCARD_RESET_CARD                0x0001  /**< Reset on close */
 154 #define SCARD_UNPOWER_CARD              0x0002  /**< Power down on close */
 155 #define SCARD_EJECT_CARD                0x0003  /**< Eject on close */
 156
 157 #define SCARD_UNKNOWN                   0x0001  /**< Unknown state */
 158 #define SCARD_ABSENT                    0x0002  /**< Card is absent */
 159 #define SCARD_PRESENT                   0x0004  /**< Card is present */
 160 #define SCARD_SWALLOWED                 0x0008  /**< Card not powered */
 161 #define SCARD_POWERED                   0x0010  /**< Card is powered */
 162 #define SCARD_NEGOTIABLE                0x0020  /**< Ready for PTS */
 163 #define SCARD_SPECIFIC                  0x0040  /**< PTS has been set */
 164
 165 #define SCARD_STATE_UNAWARE             0x0000  /**< App wants status */
 166 #define SCARD_STATE_IGNORE              0x0001  /**< Ignore this reader */
 167 #define SCARD_STATE_CHANGED             0x0002  /**< State has changed */
 168 #define SCARD_STATE_UNKNOWN             0x0004  /**< Reader unknown */
 169 #define SCARD_STATE_UNAVAILABLE         0x0008  /**< Status unavailable */
 170 #define SCARD_STATE_EMPTY               0x0010  /**< Card removed */
 171 #define SCARD_STATE_PRESENT             0x0020  /**< Card inserted */
 172 #define SCARD_STATE_ATRMATCH            0x0040  /**< ATR matches card */
 173 #define SCARD_STATE_EXCLUSIVE           0x0080  /**< Exclusive Mode */
 174 #define SCARD_STATE_INUSE               0x0100  /**< Shared Mode */
 175 #define SCARD_STATE_MUTE                0x0200  /**< Unresponsive card */
 176 #define SCARD_STATE_UNPOWERED           0x0400  /**< Unpowered card */
 177
 178 /** PC/SC Lite specific extensions */
 179 #define SCARD_W_INSERTED_CARD           0x8010006A
 180 #define SCARD_E_UNSUPPORTED_FEATURE     0x8010001F /**< feature not supported. */
 181
 182 #ifndef INFINITE
 183 #define INFINITE                        0xFFFFFFFF      /**< Infinite timeout */
 184 #endif
 185
 186 #define PCSCLITE_VERSION_NUMBER         "1.5.5" /**< Current version */
 187 /** Maximum readers context (a slot is count as a reader) */
 188 #define PCSCLITE_MAX_READERS_CONTEXTS                   16
 189
 190 #define MAX_READERNAME                  100
 191
 192 #ifndef SCARD_ATR_LENGTH
 193 #define SCARD_ATR_LENGTH                MAX_ATR_SIZE    /**< Maximum ATR size */
 194 #endif
 195
 196 /*
 197  * The message and buffer sizes must be multiples of 16.
 198  * The max message size must be at least large enough
 199  * to accomodate the transmit_struct
 200  */
 201 #define MAX_BUFFER_SIZE                 264     /**< Maximum Tx/Rx Buffer for short APDU */
 202 #define MAX_BUFFER_SIZE_EXTENDED        (4 + 3 + (1<<16) + 3)   /**< enhanced (64K + APDU + Lc + Le) Tx/Rx Buffer */
 203
 204 /*
 205  * Gets a stringified error response
 206  */
 207 char *pcsc_stringify_error(const long);
 208
 209 #ifdef __cplusplus
 210 }
 211 #endif
 212
 213 #endif