Data Structures | Defines | 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 "strlcpycat.h"
#include "readerfactory.h"
#include "eventhandler.h"
#include "sys_generic.h"
#include "winscard_msg.h"
#include "utils.h"
Include dependency graph for winscard_clnt.c:

Go to the source code of this file.

Data Structures

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

Defines

#define SCARD_PROTOCOL_ANY_OLD   0x1000
 used for backward compatibility
#define FALSE   0
#define PROFILE_START
#define PROFILE_END(rv)
#define CHECK_SAME_PROCESS

Typedefs

typedef struct _psChannelMap CHANNEL_MAP
typedef struct _psContextMap SCONTEXTMAP

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.
static SCONTEXTMAPSCardGetContext (SCARDCONTEXT hContext)
 Get the index from the Application Context vector _psContextMap for the passed context.
static SCONTEXTMAPSCardGetContextTH (SCARDCONTEXT hContext)
 Get the address from the Application Context list _psContextMap for the passed context.
static LONG SCardRemoveContext (SCARDCONTEXT hContext)
 Removes an Application Context from a control vector.
static LONG SCardCleanContext (SCONTEXTMAP *)
static LONG SCardAddHandle (SCARDHANDLE, SCONTEXTMAP *, LPCSTR)
static LONG SCardGetContextAndChannelFromHandle (SCARDHANDLE, SCONTEXTMAP **, CHANNEL_MAP **)
static LONG SCardGetContextAndChannelFromHandleTH (SCARDHANDLE, SCONTEXTMAP **, CHANNEL_MAP **)
static LONG SCardRemoveHandle (SCARDHANDLE)
static LONG SCardGetSetAttrib (SCARDHANDLE hCard, int command, DWORD dwAttrId, LPBYTE pbAttr, LPDWORD pcbAttrLen)
static LONG getReaderStates (SCONTEXTMAP *currentContextMap)
static LONG SCardLockThread (void)
 This function locks a mutex so another thread must wait to use this function.
static LONG SCardUnlockThread (void)
 This function unlocks a mutex so another thread may use the client.
static LONG SCardEstablishContextTH (DWORD dwScope,LPCVOID pvReserved1,LPCVOID pvReserved2, LPSCARDCONTEXT phContext)
 Creates a communication context to the PC/SC Resource Manager.
LONG SCardEstablishContext (DWORD dwScope, LPCVOID pvReserved1, LPCVOID pvReserved2, LPSCARDCONTEXT phContext)
 Creates an Application Context to the PC/SC Resource Manager.
LONG SCardReleaseContext (SCARDCONTEXT hContext)
 This function destroys a communication context to the PC/SC Resource Manager.
LONG SCardSetTimeout (SCARDCONTEXT hContext, DWORD dwTimeout)
 The function does not do anything except returning SCARD_S_SUCCESS.
LONG SCardConnect (SCARDCONTEXT hContext, LPCSTR szReader, DWORD dwShareMode, DWORD dwPreferredProtocols, LPSCARDHANDLE phCard, LPDWORD pdwActiveProtocol)
 This function establishes a connection to the reader specified in szReader.
LONG SCardReconnect (SCARDHANDLE hCard, DWORD dwShareMode, DWORD dwPreferredProtocols, DWORD dwInitialization, LPDWORD pdwActiveProtocol)
 This function reestablishes a connection to a reader that was previously connected to using SCardConnect().
LONG SCardDisconnect (SCARDHANDLE hCard, DWORD dwDisposition)
 This function terminates a connection made through SCardConnect().
LONG SCardBeginTransaction (SCARDHANDLE hCard)
 This function establishes a temporary exclusive access mode for doing a serie of commands in a transaction.
LONG SCardEndTransaction (SCARDHANDLE hCard, DWORD dwDisposition)
 This function ends a previously begun transaction.
LONG SCardCancelTransaction (SCARDHANDLE hCard)
LONG SCardStatus (SCARDHANDLE hCard, LPSTR mszReaderName, LPDWORD pcchReaderLen, LPDWORD pdwState, LPDWORD pdwProtocol, LPBYTE pbAtr, LPDWORD pcbAtrLen)
 This function returns the current status of the reader connected to by hCard.
LONG SCardGetStatusChange (SCARDCONTEXT hContext, DWORD dwTimeout, LPSCARD_READERSTATE_A rgReaderStates, DWORD cReaders)
 This function blocks execution until the current availability of the cards in a specific set of readers changes.
LONG SCardControl (SCARDHANDLE hCard, DWORD dwControlCode, LPCVOID pbSendBuffer, DWORD cbSendLength, LPVOID pbRecvBuffer, DWORD cbRecvLength, LPDWORD lpBytesReturned)
 This function sends a command directly to the IFD Handler (reader driver) to be processed by the reader.
LONG SCardGetAttrib (SCARDHANDLE hCard, DWORD dwAttrId, LPBYTE pbAttr, LPDWORD pcbAttrLen)
 This function get an attribute from the IFD Handler (reader driver).
LONG SCardSetAttrib (SCARDHANDLE hCard, DWORD dwAttrId, LPCBYTE pbAttr, DWORD cbAttrLen)
 This function set an attribute of the IFD Handler.
LONG SCardTransmit (SCARDHANDLE hCard, LPCSCARD_IO_REQUEST pioSendPci, LPCBYTE pbSendBuffer, DWORD cbSendLength, LPSCARD_IO_REQUEST pioRecvPci, LPBYTE pbRecvBuffer, LPDWORD pcbRecvLength)
 This function sends an APDU to the smart card contained in the reader connected to by SCardConnect().
LONG SCardListReaders (SCARDCONTEXT hContext, LPCSTR mszGroups, LPSTR mszReaders, LPDWORD pcchReaders)
 This function returns a list of currently available readers on the system.
LONG SCardFreeMemory (SCARDCONTEXT hContext, LPCVOID pvMem)
 Releases memory that has been returned from the resource manager using the SCARD_AUTOALLOCATE length designator.
LONG SCardListReaderGroups (SCARDCONTEXT hContext, LPSTR mszGroups, LPDWORD pcchGroups)
 This function returns a list of currently available reader groups on the system.
LONG SCardCancel (SCARDCONTEXT hContext)
 This function cancels all pending blocking requests on the SCardGetStatusChange() function.
LONG SCardIsValidContext (SCARDCONTEXT hContext)
 Check if a SCARDCONTEXT is valid.
static LONG SCardInvalidateHandles (void)
LONG SCardCheckDaemonAvailability (void)
 Checks if the server is running.

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 time_t daemon_ctime = 0
 creation time of pcscd PCSCLITE_CSOCK_NAME file
static pid_t daemon_pid = 0
static pid_t client_pid = 0
 PID of the client application.
static pthread_mutex_t clientMutex = PTHREAD_MUTEX_INITIALIZER
 Ensure that some functions be accessed in thread-safe mode.
static READER_STATE readerStates [PCSCLITE_MAX_READERS_CONTEXTS]
 Area used to read status information about the readers.
PCSC_API SCARD_IO_REQUEST g_rgSCardT0Pci = { SCARD_PROTOCOL_T0, sizeof(SCARD_IO_REQUEST) }
 Protocol Control Information for T=0.
PCSC_API SCARD_IO_REQUEST g_rgSCardT1Pci = { SCARD_PROTOCOL_T1, sizeof(SCARD_IO_REQUEST) }
 Protocol Control Information for T=1.
PCSC_API SCARD_IO_REQUEST g_rgSCardRawPci = { SCARD_PROTOCOL_RAW, sizeof(SCARD_IO_REQUEST) }
 Protocol Control Information for raw access.

Detailed Description

Definition in file winscard_clnt.c.


Function Documentation

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] hContext Application Context ID.
[in] dwClientID Client connection ID.
Returns:
Error code.
Return values:
SCARD_S_SUCCESS Success (SCARD_S_SUCCESS)
SCARD_E_NO_MEMORY There is no free slot to store hContext (SCARD_E_NO_MEMORY)

Definition at line 3433 of file winscard_clnt.c.

References _psContextMap::dwClientID, _psContextMap::hContext, and _psContextMap::mMutex.

Referenced by SCardEstablishContextTH().

LONG SCardCheckDaemonAvailability ( void   ) 

Checks if the server is running.

If the server has been restarted or the client has forked we invalidate all the PC/SC handles. The client has to call SCardEstablishContext() again.

Returns:
Error code.
Return values:
SCARD_S_SUCCESS Server is running (SCARD_S_SUCCESS)
SCARD_E_NO_SERVICE Server is not running (SCARD_E_NO_SERVICE)
SCARD_E_INVALID_HANDLE Server was restarted or after fork() (SCARD_E_INVALID_HANDLE)

Definition at line 3739 of file winscard_clnt.c.

Referenced by MessageReceiveTimeout(), and SCardEstablishContext().

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] dwScope Scope of the establishment. This can either be a local or remote connection.

[in] pvReserved1 Reserved for future use. Can be used for remote connection.
[in] pvReserved2 Reserved for future use.
[out] phContext Returned reference to this connection.
Returns:
Connection status.
Return values:
SCARD_S_SUCCESS Successful (SCARD_S_SUCCESS)
SCARD_E_INVALID_PARAMETER phContext is null. (SCARD_E_INVALID_PARAMETER)
SCARD_E_INVALID_VALUE Invalid scope type passed (SCARD_E_INVALID_VALUE)
SCARD_E_NO_MEMORY There is no free slot to store hContext (SCARD_E_NO_MEMORY)
SCARD_E_NO_SERVICE The server is not runing (SCARD_E_NO_SERVICE)
SCARD_F_COMM_ERROR An internal communications error has been detected (SCARD_F_COMM_ERROR)
SCARD_F_INTERNAL_ERROR An internal consistency check failed (SCARD_F_INTERNAL_ERROR)

Definition at line 503 of file winscard_clnt.c.

References ClientSetupSession(), CMD_VERSION, version_struct::major, MessageReceive(), MessageSendWithHeader(), version_struct::minor, SCARD_ESTABLISH_CONTEXT, SCARD_S_SUCCESS, SCardAddContext(), and SCardGetContextTH().

Referenced by SCardEstablishContext().

Here is the call graph for this function:

static SCONTEXTMAP * SCardGetContext ( SCARDCONTEXT  hContext  )  [static]

Get the index from the Application Context vector _psContextMap for the passed context.

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

Parameters:
[in] hContext Application Context whose index will be find.
Returns:
Index corresponding to the Application Context or -1 if it is not found.

Definition at line 3504 of file winscard_clnt.c.

References SCardGetContextTH(), SCardLockThread(), and SCardUnlockThread().

Referenced by SCardCancel(), SCardConnect(), SCardFreeMemory(), SCardGetStatusChange(), SCardIsValidContext(), SCardListReaderGroups(), SCardListReaders(), and SCardReleaseContext().

Here is the call graph for this function:

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] hContext Application Context whose index will be find.
Returns:
Address corresponding to the Application Context or NULL if it is not found.

Definition at line 3527 of file winscard_clnt.c.

Referenced by SCardEstablishContextTH(), SCardGetContext(), and SCardRemoveContext().

static LONG SCardLockThread ( void   )  [inline, static]

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

Wrapper to the function pthread_mutex_lock().

Definition at line 335 of file winscard_clnt.c.

Referenced by SCardEstablishContext(), SCardGetContext(), and SCardReleaseContext().

static LONG SCardRemoveContext ( SCARDCONTEXT  hContext  )  [static]

Removes an Application Context from a control vector.

Parameters:
[in] hContext Application Context to be removed.
Returns:
Error code.
Return values:
SCARD_S_SUCCESS Success (SCARD_S_SUCCESS)
SCARD_E_INVALID_HANDLE The context hContext was not found (SCARD_E_INVALID_HANDLE)

Definition at line 3541 of file winscard_clnt.c.

References SCardGetContextTH().

Referenced by SCardReleaseContext().

Here is the call graph for this function:

static LONG SCardUnlockThread ( void   )  [inline, static]

This function unlocks a mutex so another thread may use the client.

Wrapper to the function pthread_mutex_unlock().

Definition at line 345 of file winscard_clnt.c.

Referenced by SCardEstablishContext(), SCardGetContext(), and SCardReleaseContext().


Variable Documentation

pid_t client_pid = 0 [static]

PID of the client application.

Used to detect fork() and disable handles in the child process

Definition at line 279 of file winscard_clnt.c.

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 285 of file winscard_clnt.c.