Logo Search packages:      
Sourcecode: pcsc-lite version File versions  Download package

pcsclite.h

Go to the documentation of this file.
/*
 * MUSCLE SmartCard Development ( http://www.linuxnet.com )
 *
 * Copyright (C) 1999-2004
 *  David Corcoran <corcoran@linuxnet.com>
 * Copyright (C) 2002-2011
 *  Ludovic Rousseau <ludovic.rousseau@free.fr>
 * Copyright (C) 2005
 *  Martin Paljak <martin@paljak.pri.ee>
 *
 * $Id: pcsclite.h.in 5736 2011-05-12 08:43:33Z rousseau $
 */

/**
 * @file
 * @brief This keeps a list of defines for pcsc-lite.
 *
 * Error codes from http://msdn.microsoft.com/en-us/library/aa924526.aspx
 */

#ifndef __pcsclite_h__
#define __pcsclite_h__

#include <wintypes.h>

#ifdef __cplusplus
extern "C"
{
#endif

00031 typedef LONG SCARDCONTEXT; /**< \p hContext returned by SCardEstablishContext() */
typedef SCARDCONTEXT *PSCARDCONTEXT;
typedef SCARDCONTEXT *LPSCARDCONTEXT;
00034 typedef LONG SCARDHANDLE; /**< \p hCard returned by SCardConnect() */
typedef SCARDHANDLE *PSCARDHANDLE;
typedef SCARDHANDLE *LPSCARDHANDLE;

00038 #define MAX_ATR_SIZE                33    /**< Maximum ATR size */

/* Set structure elements aligment on bytes
 * http://gcc.gnu.org/onlinedocs/gcc/Structure_002dPacking-Pragmas.html */
#ifdef __APPLE__
#pragma pack(1)
#endif

00046 typedef struct
{
      const char *szReader;
      void *pvUserData;
      DWORD dwCurrentState;
      DWORD dwEventState;
      DWORD cbAtr;
      unsigned char rgbAtr[MAX_ATR_SIZE];
}
SCARD_READERSTATE, *LPSCARD_READERSTATE;

/** Protocol Control Information (PCI) */
00058 typedef struct
{
00060       unsigned long dwProtocol;     /**< Protocol identifier */
00061       unsigned long cbPciLength;    /**< Protocol Control Inf Length */
}
SCARD_IO_REQUEST, *PSCARD_IO_REQUEST, *LPSCARD_IO_REQUEST;

typedef const SCARD_IO_REQUEST *LPCSCARD_IO_REQUEST;

extern const SCARD_IO_REQUEST g_rgSCardT0Pci, g_rgSCardT1Pci, g_rgSCardRawPci;

/* restore default structure elements alignment */
#ifdef __APPLE__
#pragma pack()
#endif

00074 #define SCARD_PCI_T0    (&g_rgSCardT0Pci) /**< protocol control information (PCI) for T=0 */
00075 #define SCARD_PCI_T1    (&g_rgSCardT1Pci) /**< protocol control information (PCI) for T=1 */
00076 #define SCARD_PCI_RAW   (&g_rgSCardRawPci) /**< protocol control information (PCI) for RAW protocol */

/** error codes from http://msdn.microsoft.com/en-us/library/aa924526.aspx
 */
00080 #define SCARD_S_SUCCESS             ((LONG)0x00000000) /**< No error was encountered. */
00081 #define SCARD_F_INTERNAL_ERROR            ((LONG)0x80100001) /**< An internal consistency check failed. */
00082 #define SCARD_E_CANCELLED           ((LONG)0x80100002) /**< The action was cancelled by an SCardCancel request. */
00083 #define SCARD_E_INVALID_HANDLE            ((LONG)0x80100003) /**< The supplied handle was invalid. */
00084 #define SCARD_E_INVALID_PARAMETER   ((LONG)0x80100004) /**< One or more of the supplied parameters could not be properly interpreted. */
00085 #define SCARD_E_INVALID_TARGET            ((LONG)0x80100005) /**< Registry startup information is missing or invalid. */
00086 #define SCARD_E_NO_MEMORY           ((LONG)0x80100006) /**< Not enough memory available to complete this command. */
00087 #define SCARD_F_WAITED_TOO_LONG           ((LONG)0x80100007) /**< An internal consistency timer has expired. */
00088 #define SCARD_E_INSUFFICIENT_BUFFER ((LONG)0x80100008) /**< The data buffer to receive returned data is too small for the returned data. */
00089 #define SCARD_E_UNKNOWN_READER            ((LONG)0x80100009) /**< The specified reader name is not recognized. */
00090 #define SCARD_E_TIMEOUT             ((LONG)0x8010000A) /**< The user-specified timeout value has expired. */
00091 #define SCARD_E_SHARING_VIOLATION   ((LONG)0x8010000B) /**< The smart card cannot be accessed because of other connections outstanding. */
00092 #define SCARD_E_NO_SMARTCARD        ((LONG)0x8010000C) /**< The operation requires a Smart Card, but no Smart Card is currently in the device. */
00093 #define SCARD_E_UNKNOWN_CARD        ((LONG)0x8010000D) /**< The specified smart card name is not recognized. */
00094 #define SCARD_E_CANT_DISPOSE        ((LONG)0x8010000E) /**< The system could not dispose of the media in the requested manner. */
00095 #define SCARD_E_PROTO_MISMATCH            ((LONG)0x8010000F) /**< The requested protocols are incompatible with the protocol currently in use with the smart card. */
00096 #define SCARD_E_NOT_READY           ((LONG)0x80100010) /**< The reader or smart card is not ready to accept commands. */
00097 #define SCARD_E_INVALID_VALUE       ((LONG)0x80100011) /**< One or more of the supplied parameters values could not be properly interpreted. */
00098 #define SCARD_E_SYSTEM_CANCELLED    ((LONG)0x80100012) /**< The action was cancelled by the system, presumably to log off or shut down. */
00099 #define SCARD_F_COMM_ERROR          ((LONG)0x80100013) /**< An internal communications error has been detected. */
00100 #define SCARD_F_UNKNOWN_ERROR       ((LONG)0x80100014) /**< An internal error has been detected, but the source is unknown. */
00101 #define SCARD_E_INVALID_ATR         ((LONG)0x80100015) /**< An ATR obtained from the registry is not a valid ATR string. */
00102 #define SCARD_E_NOT_TRANSACTED            ((LONG)0x80100016) /**< An attempt was made to end a non-existent transaction. */
00103 #define SCARD_E_READER_UNAVAILABLE  ((LONG)0x80100017) /**< The specified reader is not currently available for use. */
00104 #define SCARD_P_SHUTDOWN            ((LONG)0x80100018) /**< The operation has been aborted to allow the server application to exit. */
00105 #define SCARD_E_PCI_TOO_SMALL       ((LONG)0x80100019) /**< The PCI Receive buffer was too small. */
00106 #define SCARD_E_READER_UNSUPPORTED  ((LONG)0x8010001A) /**< The reader driver does not meet minimal requirements for support. */
00107 #define SCARD_E_DUPLICATE_READER    ((LONG)0x8010001B) /**< The reader driver did not produce a unique reader name. */
00108 #define SCARD_E_CARD_UNSUPPORTED    ((LONG)0x8010001C) /**< The smart card does not meet minimal requirements for support. */
00109 #define SCARD_E_NO_SERVICE          ((LONG)0x8010001D) /**< The Smart card resource manager is not running. */
00110 #define SCARD_E_SERVICE_STOPPED           ((LONG)0x8010001E) /**< The Smart card resource manager has shut down. */
00111 #define SCARD_E_UNEXPECTED          ((LONG)0x8010001F) /**< An unexpected card error has occurred. */
00112 #define SCARD_E_UNSUPPORTED_FEATURE ((LONG)0x8010001F) /**< This smart card does not support the requested feature. */
00113 #define SCARD_E_ICC_INSTALLATION    ((LONG)0x80100020) /**< No primary provider can be found for the smart card. */
00114 #define SCARD_E_ICC_CREATEORDER           ((LONG)0x80100021) /**< The requested order of object creation is not supported. */
/* #define SCARD_E_UNSUPPORTED_FEATURE    ((LONG)0x80100022) / **< This smart card does not support the requested feature. */
00116 #define SCARD_E_DIR_NOT_FOUND       ((LONG)0x80100023) /**< The identified directory does not exist in the smart card. */
00117 #define SCARD_E_FILE_NOT_FOUND            ((LONG)0x80100024) /**< The identified file does not exist in the smart card. */ 
00118 #define SCARD_E_NO_DIR              ((LONG)0x80100025) /**< The supplied path does not represent a smart card directory. */
00119 #define SCARD_E_NO_FILE             ((LONG)0x80100026) /**< The supplied path does not represent a smart card file. */
00120 #define SCARD_E_NO_ACCESS           ((LONG)0x80100027) /**< Access is denied to this file. */
00121 #define SCARD_E_WRITE_TOO_MANY            ((LONG)0x80100028) /**< The smart card does not have enough memory to store the information. */
00122 #define SCARD_E_BAD_SEEK            ((LONG)0x80100029) /**< There was an error trying to set the smart card file object pointer. */
00123 #define SCARD_E_INVALID_CHV         ((LONG)0x8010002A) /**< The supplied PIN is incorrect. */
00124 #define SCARD_E_UNKNOWN_RES_MNG           ((LONG)0x8010002B) /**< An unrecognized error code was returned from a layered component. */ 
00125 #define SCARD_E_NO_SUCH_CERTIFICATE ((LONG)0x8010002C) /**< The requested certificate does not exist. */
00126 #define SCARD_E_CERTIFICATE_UNAVAILABLE   ((LONG)0x8010002D) /**< The requested certificate could not be obtained. */
00127 #define SCARD_E_NO_READERS_AVAILABLE    ((LONG)0x8010002E) /**< Cannot find a smart card reader. */
00128 #define SCARD_E_COMM_DATA_LOST            ((LONG)0x8010002F) /**< A communications error with the smart card has been detected. Retry the operation. */
00129 #define SCARD_E_NO_KEY_CONTAINER    ((LONG)0x80100030) /**< The requested key container does not exist on the smart card. */
00130 #define SCARD_E_SERVER_TOO_BUSY           ((LONG)0x80100031) /**< The Smart Card Resource Manager is too busy to complete this operation. */

00132 #define SCARD_W_UNSUPPORTED_CARD    ((LONG)0x80100065) /**< The reader cannot communicate with the card, due to ATR string configuration conflicts. */
00133 #define SCARD_W_UNRESPONSIVE_CARD   ((LONG)0x80100066) /**< The smart card is not responding to a reset. */
00134 #define SCARD_W_UNPOWERED_CARD            ((LONG)0x80100067) /**< Power has been removed from the smart card, so that further communication is not possible. */
00135 #define SCARD_W_RESET_CARD          ((LONG)0x80100068) /**< The smart card has been reset, so any shared state information is invalid. */
00136 #define SCARD_W_REMOVED_CARD        ((LONG)0x80100069) /**< The smart card has been removed, so further communication is not possible. */

00138 #define SCARD_W_SECURITY_VIOLATION  ((LONG)0x8010006A) /**< Access was denied because of a security violation. */
00139 #define SCARD_W_WRONG_CHV           ((LONG)0x8010006B) /**< The card cannot be accessed because the wrong PIN was presented. */
00140 #define SCARD_W_CHV_BLOCKED         ((LONG)0x8010006C) /**< The card cannot be accessed because the maximum number of PIN entry attempts has been reached. */
00141 #define SCARD_W_EOF                 ((LONG)0x8010006D) /**< The end of the smart card file has been reached. */
00142 #define SCARD_W_CANCELLED_BY_USER   ((LONG)0x8010006E) /**< The user pressed "Cancel" on a Smart Card Selection Dialog. */
00143 #define SCARD_W_CARD_NOT_AUTHENTICATED    ((LONG)0x8010006F) /**< No PIN was presented to the smart card. */

00145 #define SCARD_AUTOALLOCATE (DWORD)(-1)    /**< see SCardFreeMemory() */
00146 #define SCARD_SCOPE_USER            0x0000      /**< Scope in user space */
00147 #define SCARD_SCOPE_TERMINAL        0x0001      /**< Scope in terminal */
00148 #define SCARD_SCOPE_SYSTEM          0x0002      /**< Scope in system */

00150 #define SCARD_PROTOCOL_UNDEFINED    0x0000      /**< protocol not set */
#define SCARD_PROTOCOL_UNSET SCARD_PROTOCOL_UNDEFINED /* backward compat */
00152 #define SCARD_PROTOCOL_T0           0x0001      /**< T=0 active protocol. */
00153 #define SCARD_PROTOCOL_T1           0x0002      /**< T=1 active protocol. */
00154 #define SCARD_PROTOCOL_RAW          0x0004      /**< Raw active protocol. */
00155 #define SCARD_PROTOCOL_T15          0x0008      /**< T=15 protocol. */

00157 #define SCARD_PROTOCOL_ANY          (SCARD_PROTOCOL_T0|SCARD_PROTOCOL_T1)     /**< IFD determines prot. */

00159 #define SCARD_SHARE_EXCLUSIVE       0x0001      /**< Exclusive mode only */
00160 #define SCARD_SHARE_SHARED          0x0002      /**< Shared mode only */
00161 #define SCARD_SHARE_DIRECT          0x0003      /**< Raw mode only */

00163 #define SCARD_LEAVE_CARD            0x0000      /**< Do nothing on close */
00164 #define SCARD_RESET_CARD            0x0001      /**< Reset on close */
00165 #define SCARD_UNPOWER_CARD          0x0002      /**< Power down on close */
00166 #define SCARD_EJECT_CARD            0x0003      /**< Eject on close */

00168 #define SCARD_UNKNOWN               0x0001      /**< Unknown state */
00169 #define SCARD_ABSENT                0x0002      /**< Card is absent */
00170 #define SCARD_PRESENT               0x0004      /**< Card is present */
00171 #define SCARD_SWALLOWED             0x0008      /**< Card not powered */
00172 #define SCARD_POWERED               0x0010      /**< Card is powered */
00173 #define SCARD_NEGOTIABLE            0x0020      /**< Ready for PTS */
00174 #define SCARD_SPECIFIC              0x0040      /**< PTS has been set */

00176 #define SCARD_STATE_UNAWARE         0x0000      /**< App wants status */
00177 #define SCARD_STATE_IGNORE          0x0001      /**< Ignore this reader */
00178 #define SCARD_STATE_CHANGED         0x0002      /**< State has changed */
00179 #define SCARD_STATE_UNKNOWN         0x0004      /**< Reader unknown */
00180 #define SCARD_STATE_UNAVAILABLE           0x0008      /**< Status unavailable */
00181 #define SCARD_STATE_EMPTY           0x0010      /**< Card removed */
00182 #define SCARD_STATE_PRESENT         0x0020      /**< Card inserted */
00183 #define SCARD_STATE_ATRMATCH        0x0040      /**< ATR matches card */
00184 #define SCARD_STATE_EXCLUSIVE       0x0080      /**< Exclusive Mode */
00185 #define SCARD_STATE_INUSE           0x0100      /**< Shared Mode */
00186 #define SCARD_STATE_MUTE            0x0200      /**< Unresponsive card */
00187 #define SCARD_STATE_UNPOWERED       0x0400      /**< Unpowered card */

#ifndef INFINITE
00190 #define INFINITE              0xFFFFFFFF  /**< Infinite timeout */
#endif

00193 #define PCSCLITE_VERSION_NUMBER           "1.7.4"     /**< Current version */
/** Maximum readers context (a slot is count as a reader) */
00195 #define PCSCLITE_MAX_READERS_CONTEXTS                 16

#define MAX_READERNAME              100

#ifndef SCARD_ATR_LENGTH
00200 #define SCARD_ATR_LENGTH            MAX_ATR_SIZE      /**< Maximum ATR size */
#endif

/*
 * The message and buffer sizes must be multiples of 16.
 * The max message size must be at least large enough
 * to accomodate the transmit_struct
 */
00208 #define MAX_BUFFER_SIZE             264   /**< Maximum Tx/Rx Buffer for short APDU */
00209 #define MAX_BUFFER_SIZE_EXTENDED    (4 + 3 + (1<<16) + 3)   /**< enhanced (64K + APDU + Lc + Le) Tx/Rx Buffer */

/*
 * Gets a stringified error response
 */
char *pcsc_stringify_error(const LONG);

#ifdef __cplusplus
}
#endif

#endif

Generated by  Doxygen 1.6.0   Back to index