pcsc-lite  1.8.20
Data Structures | Macros | Typedefs | Functions | Variables
winscard_clnt.c File Reference
#include "config.h"
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <fcntl.h>
#include <unistd.h>
#include <sys/un.h>
#include <errno.h>
#include <stddef.h>
#include <sys/time.h>
#include <pthread.h>
#include <sys/wait.h>
#include "misc.h"
#include "pcscd.h"
#include "winscard.h"
#include "debuglog.h"
#include "readerfactory.h"
#include "eventhandler.h"
#include "sys_generic.h"
#include "winscard_msg.h"
#include "utils.h"

Go to the source code of this file.

Data Structures

struct  _psChannelMap
 Represents an Application Context Channel. More...
 
struct  _psContextMap
 Represents an Application Context on the Client side. More...
 

Macros

#define SCARD_PROTOCOL_ANY_OLD   0x1000
 used for backward compatibility
 
#define TRUE   1
 
#define FALSE   0
 
#define COLOR_RED   "\33[01;31m"
 
#define COLOR_GREEN   "\33[32m"
 
#define COLOR_BLUE   "\33[34m"
 
#define COLOR_MAGENTA   "\33[35m"
 
#define COLOR_NORMAL   "\33[0m"
 
#define API_TRACE_IN(...)
 
#define API_TRACE_OUT(...)
 
#define PROFILE_START
 
#define PROFILE_END(rv)
 

Typedefs

typedef struct _psChannelMap CHANNEL_MAP
 
typedef struct _psContextMap SCONTEXTMAP
 Represents an Application Context on the Client side. More...
 

Functions

static int CHANNEL_MAP_seeker (const void *el, const void *key)
 
static int SCONTEXTMAP_seeker (const void *el, const void *key)
 
static LONG SCardAddContext (SCARDCONTEXT hContext, DWORD dwClientID)
 Functions for managing instances of SCardEstablishContext() These functions keep track of Context handles and associate the blocking variable contextBlockStatus to an hContext. More...
 
static SCONTEXTMAPSCardGetAndLockContext (SCARDCONTEXT hContext)
 Get the SCONTEXTMAP * from the Application Context vector _psContextMap for the passed context. More...
 
static SCONTEXTMAPSCardGetContextTH (SCARDCONTEXT hContext)
 Get the address from the Application Context list _psContextMap for the passed context. More...
 
static void SCardRemoveContext (SCARDCONTEXT hContext)
 Removes an Application Context from a control vector. More...
 
static void SCardCleanContext (SCONTEXTMAP *)
 
static LONG SCardAddHandle (SCARDHANDLE, SCONTEXTMAP *, LPCSTR)
 
static LONG SCardGetContextChannelAndLockFromHandle (SCARDHANDLE, SCONTEXTMAP **, CHANNEL_MAP **)
 
static LONG SCardGetContextAndChannelFromHandleTH (SCARDHANDLE, SCONTEXTMAP **, CHANNEL_MAP **)
 
static void SCardRemoveHandle (SCARDHANDLE)
 
static LONG SCardGetSetAttrib (SCARDHANDLE hCard, int command, DWORD dwAttrId, LPBYTE pbAttr, LPDWORD pcbAttrLen)
 
static LONG getReaderStates (SCONTEXTMAP *currentContextMap)
 
static void SCardLockThread (void)
 Locks a mutex so another thread must wait to use this function. More...
 
static void SCardUnlockThread (void)
 Unlocks a mutex so another thread may use the client. More...
 
static int SCardGetContextValidity (SCARDCONTEXT hContext)
 Tell if a context index from the Application Context vector _psContextMap is valid or not. More...
 
static LONG SCardEstablishContextTH (DWORD dwScope, LPCVOID pvReserved1, LPCVOID pvReserved2, LPSCARDCONTEXT phContext)
 Creates a communication context to the PC/SC Resource Manager. More...
 
LONG SCardEstablishContext (DWORD dwScope, LPCVOID pvReserved1, LPCVOID pvReserved2, LPSCARDCONTEXT phContext)
 Creates an Application Context to the PC/SC Resource Manager. More...
 
LONG SCardReleaseContext (SCARDCONTEXT hContext)
 Destroys a communication context to the PC/SC Resource Manager. More...
 
LONG SCardConnect (SCARDCONTEXT hContext, LPCSTR szReader, DWORD dwShareMode, DWORD dwPreferredProtocols, LPSCARDHANDLE phCard, LPDWORD pdwActiveProtocol)
 Establishes a connection to the reader specified in * szReader. More...
 
LONG SCardReconnect (SCARDHANDLE hCard, DWORD dwShareMode, DWORD dwPreferredProtocols, DWORD dwInitialization, LPDWORD pdwActiveProtocol)
 Reestablishes a connection to a reader that was previously connected to using SCardConnect(). More...
 
LONG SCardDisconnect (SCARDHANDLE hCard, DWORD dwDisposition)
 Terminates a connection made through SCardConnect(). More...
 
LONG SCardBeginTransaction (SCARDHANDLE hCard)
 Establishes a temporary exclusive access mode for doing a serie of commands in a transaction. More...
 
LONG SCardEndTransaction (SCARDHANDLE hCard, DWORD dwDisposition)
 Ends a previously begun transaction. More...
 
LONG SCardStatus (SCARDHANDLE hCard, LPSTR szReaderName, LPDWORD pcchReaderLen, LPDWORD pdwState, LPDWORD pdwProtocol, LPBYTE pbAtr, LPDWORD pcbAtrLen)
 Returns the current status of the reader connected to by hCard. More...
 
LONG SCardGetStatusChange (SCARDCONTEXT hContext, DWORD dwTimeout, SCARD_READERSTATE *rgReaderStates, DWORD cReaders)
 Blocks execution until the current availability of the cards in a specific set of readers changes. More...
 
LONG SCardControl (SCARDHANDLE hCard, DWORD dwControlCode, LPCVOID pbSendBuffer, DWORD cbSendLength, LPVOID pbRecvBuffer, DWORD cbRecvLength, LPDWORD lpBytesReturned)
 Sends a command directly to the IFD Handler (reader driver) to be processed by the reader. More...
 
LONG SCardGetAttrib (SCARDHANDLE hCard, DWORD dwAttrId, LPBYTE pbAttr, LPDWORD pcbAttrLen)
 Get an attribute from the IFD Handler (reader driver). More...
 
LONG SCardSetAttrib (SCARDHANDLE hCard, DWORD dwAttrId, LPCBYTE pbAttr, DWORD cbAttrLen)
 Set an attribute of the IFD Handler. More...
 
LONG SCardTransmit (SCARDHANDLE hCard, const SCARD_IO_REQUEST *pioSendPci, LPCBYTE pbSendBuffer, DWORD cbSendLength, SCARD_IO_REQUEST *pioRecvPci, LPBYTE pbRecvBuffer, LPDWORD pcbRecvLength)
 Sends an APDU to the smart card contained in the reader connected to by SCardConnect(). More...
 
LONG SCardListReaders (SCARDCONTEXT hContext, LPCSTR mszGroups, LPSTR mszReaders, LPDWORD pcchReaders)
 Returns a list of currently available readers on the system. More...
 
LONG SCardFreeMemory (SCARDCONTEXT hContext, LPCVOID pvMem)
 Releases memory that has been returned from the resource manager using the SCARD_AUTOALLOCATE length designator. More...
 
LONG SCardListReaderGroups (SCARDCONTEXT hContext, LPSTR mszGroups, LPDWORD pcchGroups)
 Returns a list of currently available reader groups on the system. More...
 
LONG SCardCancel (SCARDCONTEXT hContext)
 Cancels a specific blocking SCardGetStatusChange() function. More...
 
LONG SCardIsValidContext (SCARDCONTEXT hContext)
 Check if a SCARDCONTEXT is valid. More...
 
LONG SCardCheckDaemonAvailability (void)
 Checks if the server is running. More...
 

Variables

static char sharing_shall_block = TRUE
 
static list_t contextMapList
 
static short isExecuted = 0
 Make sure the initialization code is executed only once.
 
static pthread_mutex_t clientMutex = PTHREAD_MUTEX_INITIALIZER
 Ensure that some functions be accessed in thread-safe mode. More...
 
static READER_STATE readerStates [PCSCLITE_MAX_READERS_CONTEXTS]
 Area used to read status information about the readers.
 
PCSC_API const SCARD_IO_REQUEST g_rgSCardT0Pci = { SCARD_PROTOCOL_T0, sizeof(SCARD_IO_REQUEST) }
 Protocol Control Information for T=0.
 
PCSC_API const SCARD_IO_REQUEST g_rgSCardT1Pci = { SCARD_PROTOCOL_T1, sizeof(SCARD_IO_REQUEST) }
 Protocol Control Information for T=1.
 
PCSC_API const SCARD_IO_REQUEST g_rgSCardRawPci = { SCARD_PROTOCOL_RAW, sizeof(SCARD_IO_REQUEST) }
 Protocol Control Information for raw access.
 

Typedef Documentation

◆ SCONTEXTMAP

typedef struct _psContextMap SCONTEXTMAP

Represents an Application Context on the Client side.

typedef of _psContextMap

Definition at line 327 of file winscard_clnt.c.

Function Documentation

◆ SCardAddContext()

static LONG SCardAddContext ( SCARDCONTEXT  hContext,
DWORD  dwClientID 
)
static

Functions for managing instances of SCardEstablishContext() These functions keep track of Context handles and associate the blocking variable contextBlockStatus to an hContext.

Adds an Application Context to the vector _psContextMap.

Parameters
[in]hContextApplication Context ID.
[in]dwClientIDClient connection ID.
Returns
Error code.
Return values
SCARD_S_SUCCESSSuccess (SCARD_S_SUCCESS)
SCARD_E_NO_MEMORYThere is no free slot to store hContext (SCARD_E_NO_MEMORY)

Definition at line 3232 of file winscard_clnt.c.

◆ SCardCheckDaemonAvailability()

LONG SCardCheckDaemonAvailability ( void  )

Checks if the server is running.

Returns
Error code.
Return values
SCARD_S_SUCCESSServer is running (SCARD_S_SUCCESS)
SCARD_E_NO_SERVICEServer is not running (SCARD_E_NO_SERVICE)

Definition at line 3513 of file winscard_clnt.c.

◆ SCardEstablishContextTH()

static LONG SCardEstablishContextTH ( DWORD  dwScope,
LPCVOID  pvReserved1,
LPCVOID  pvReserved2,
LPSCARDCONTEXT  phContext 
)
static

Creates a communication context to the PC/SC Resource Manager.

This function should not be called directly. Instead, the thread-safe function SCardEstablishContext() should be called.

Parameters
[in]dwScopeScope of the establishment. This can either be a local or remote connection.
[in]pvReserved1Reserved for future use. Can be used for remote connection.
[in]pvReserved2Reserved for future use.
[out]phContextReturned reference to this connection.
Returns
Connection status.
Return values
SCARD_S_SUCCESSSuccessful (SCARD_S_SUCCESS)
SCARD_E_INVALID_PARAMETERphContext is null. (SCARD_E_INVALID_PARAMETER)
SCARD_E_INVALID_VALUEInvalid scope type passed (SCARD_E_INVALID_VALUE)
SCARD_E_NO_MEMORYThere is no free slot to store hContext (SCARD_E_NO_MEMORY)
SCARD_E_NO_SERVICEThe server is not running (SCARD_E_NO_SERVICE)
SCARD_F_COMM_ERRORAn internal communications error has been detected (SCARD_F_COMM_ERROR)
SCARD_F_INTERNAL_ERRORAn internal consistency check failed (SCARD_F_INTERNAL_ERROR)

Definition at line 525 of file winscard_clnt.c.

◆ SCardGetAndLockContext()

static SCONTEXTMAP * SCardGetAndLockContext ( SCARDCONTEXT  hContext)
static

Get the SCONTEXTMAP * from the Application Context vector _psContextMap for the passed context.

This function is a thread-safe wrapper to the function SCardGetContextTH().

If the context is valid then &currentContextMap->mMutex lock is acquired. The mutex lock needs to be released when the structure is no more used.

Parameters
[in]hContextApplication Context whose SCONTEXTMAP will be find.
Returns
context map corresponding to the Application Context or NULL if it is not found.

Definition at line 3300 of file winscard_clnt.c.

◆ SCardGetContextTH()

static SCONTEXTMAP * SCardGetContextTH ( SCARDCONTEXT  hContext)
static

Get the address from the Application Context list _psContextMap for the passed context.

This functions is not thread-safe and should not be called. Instead, call the function SCardGetContext().

Parameters
[in]hContextApplication Context whose index will be find.
Returns
Address corresponding to the Application Context or NULL if it is not found.

Definition at line 3328 of file winscard_clnt.c.

◆ SCardGetContextValidity()

static int SCardGetContextValidity ( SCARDCONTEXT  hContext)
static

Tell if a context index from the Application Context vector _psContextMap is valid or not.

Parameters
[in]hContextApplication Context whose index will be find.
Returns
TRUE if the context exists
FALSE if the context does not exist

Definition at line 425 of file winscard_clnt.c.

◆ SCardLockThread()

static void SCardLockThread ( void  )
inlinestatic

Locks a mutex so another thread must wait to use this function.

Wrapper to the function pthread_mutex_lock().

Definition at line 401 of file winscard_clnt.c.

◆ SCardRemoveContext()

static void SCardRemoveContext ( SCARDCONTEXT  hContext)
static

Removes an Application Context from a control vector.

Parameters
[in]hContextApplication Context to be removed.
Returns
Error code.
Return values
SCARD_S_SUCCESSSuccess (SCARD_S_SUCCESS)
SCARD_E_INVALID_HANDLEThe context hContext was not found (SCARD_E_INVALID_HANDLE)

Definition at line 3342 of file winscard_clnt.c.

◆ SCardUnlockThread()

static void SCardUnlockThread ( void  )
inlinestatic

Unlocks a mutex so another thread may use the client.

Wrapper to the function pthread_mutex_unlock().

Definition at line 411 of file winscard_clnt.c.

Variable Documentation

◆ clientMutex

pthread_mutex_t clientMutex = PTHREAD_MUTEX_INITIALIZER
static

Ensure that some functions be accessed in thread-safe mode.

These function's names finishes with "TH".

Definition at line 359 of file winscard_clnt.c.