pcsc-lite 1.9.9
winscard_msg.h
Go to the documentation of this file.
1/*
2 * MUSCLE SmartCard Development ( https://pcsclite.apdu.fr/ )
3 *
4 * Copyright (C) 2001-2004
5 * David Corcoran <corcoran@musclecard.com>
6 * Copyright (C) 2003-2004
7 * Damien Sauveron <damien.sauveron@labri.fr>
8 * Copyright (C) 2002-2010
9 * Ludovic Rousseau <ludovic.rousseau@free.fr>
10 *
11Redistribution and use in source and binary forms, with or without
12modification, are permitted provided that the following conditions
13are met:
14
151. Redistributions of source code must retain the above copyright
16 notice, this list of conditions and the following disclaimer.
172. Redistributions in binary form must reproduce the above copyright
18 notice, this list of conditions and the following disclaimer in the
19 documentation and/or other materials provided with the distribution.
203. The name of the author may not be used to endorse or promote products
21 derived from this software without specific prior written permission.
22
23THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
41#ifndef __winscard_msg_h__
42#define __winscard_msg_h__
43
44#include <stdint.h>
45
46#include "pcsclite.h"
47#include "wintypes.h"
48
50#define PROTOCOL_VERSION_MAJOR 4
52#define PROTOCOL_VERSION_MINOR 4
53
63
72
101
103 {
104 uint32_t hContext;
105 };
106
115
122 {
123 uint32_t dwScope;
124 uint32_t hContext;
125 uint32_t rv;
126 };
127
134 {
135 uint32_t hContext;
136 uint32_t rv;
137 };
138
145 {
146 uint32_t hContext;
147 char szReader[MAX_READERNAME];
148 uint32_t dwShareMode;
149 uint32_t dwPreferredProtocols;
150 int32_t hCard;
151 uint32_t dwActiveProtocol;
152 uint32_t rv;
153 };
154
161 {
162 int32_t hCard;
163 uint32_t dwShareMode;
164 uint32_t dwPreferredProtocols;
165 uint32_t dwInitialization;
166 uint32_t dwActiveProtocol;
167 uint32_t rv;
168 };
169
176 {
177 int32_t hCard;
178 uint32_t dwDisposition;
179 uint32_t rv;
180 };
181
188 {
189 int32_t hCard;
190 uint32_t rv;
191 };
192
199 {
200 int32_t hCard;
201 uint32_t dwDisposition;
202 uint32_t rv;
203 };
204
211 {
212 int32_t hContext;
213 uint32_t rv;
214 };
215
222 {
223 int32_t hCard;
224 uint32_t rv;
225 };
226
233 {
234 int32_t hCard;
235 uint32_t ioSendPciProtocol;
236 uint32_t ioSendPciLength;
237 uint32_t cbSendLength;
238 uint32_t ioRecvPciProtocol;
239 uint32_t ioRecvPciLength;
240 uint32_t pcbRecvLength;
241 uint32_t rv;
242 };
243
250 {
251 int32_t hCard;
252 uint32_t dwControlCode;
253 uint32_t cbSendLength;
254 uint32_t cbRecvLength;
255 uint32_t dwBytesReturned;
256 uint32_t rv;
257 };
258
265 {
266 int32_t hCard;
267 uint32_t dwAttrId;
268 uint8_t pbAttr[MAX_BUFFER_SIZE];
269 uint32_t cbAttrLen;
270 uint32_t rv;
271 };
272
273 /*
274 * Now some function definitions
275 */
276
277#ifdef PCSCD
281#else
282 char *getSocketName(void);
285 LONG MessageReceiveTimeout(uint32_t command, /*@out@*/ void *buffer,
286 uint64_t buffer_size, int32_t filedes, long timeOut);
287 LONG MessageSendWithHeader(uint32_t command, uint32_t dwClientID,
288 uint64_t size, void *data);
289#endif
291 LONG MessageReceive(/*@out@*/ void *buffer, uint64_t buffer_size,
293
294#endif
@ POWER_STATE_POWERED
powered
Definition pcscd.h:64
This keeps a list of defines for pcsc-lite.
#define MAX_BUFFER_SIZE
Maximum Tx/Rx Buffer for short APDU.
Definition pcsclite.h:297
contained in SCARD_BEGIN_TRANSACTION Messages.
contained in SCARD_CANCEL Messages.
contained in SCARD_CONNECT Messages.
contained in SCARD_CONTROL Messages.
contained in SCARD_DISCONNECT Messages.
contained in SCARD_END_TRANSACTION Messages.
Information contained in SCARD_ESTABLISH_CONTEXT Messages.
contained in SCARD_GET_ATTRIB and Messages.
contained in SCARD_RECONNECT Messages.
Information contained in SCARD_RELEASE_CONTEXT Messages.
header structure for client/server message data exchange.
uint32_t size
size of the message excluding this header
uint32_t command
one of the pcsc_msg_commands
contained in SCARD_STATUS Messages.
contained in SCARD_TRANSMIT Messages.
Information transmitted in CMD_VERSION Messages.
int32_t major
IPC major PROTOCOL_VERSION_MAJOR.
int32_t minor
IPC minor PROTOCOL_VERSION_MINOR.
Information contained in CMD_WAIT_READER_STATE_CHANGE Messages.
uint32_t timeOut
timeout in ms
LONG MessageSend(void *buffer, uint64_t buffer_size, int32_t filedes)
Sends a menssage from client to server or vice-versa.
LONG MessageReceive(void *buffer, uint64_t buffer_size, int32_t filedes)
Called by the Client to get the response from the server or vice-versa.
LONG MessageReceiveTimeout(uint32_t command, void *buffer, uint64_t buffer_size, int32_t filedes, long timeOut)
Called by the Client to get the response from the server or vice-versa.
LONG MessageSendWithHeader(uint32_t command, uint32_t dwClientID, uint64_t size, void *data)
Wrapper for the MessageSend() function.
void ClientCloseSession(uint32_t)
Closes the socket used by the client to communicate with the server.
int32_t ClientSetupSession(uint32_t *)
Prepares a communication channel for the client to talk to the server.
pcsc_msg_commands
Commands available to use in the field sharedSegmentMsg.command.
@ SCARD_DISCONNECT
used by SCardDisconnect()
@ SCARD_SET_ATTRIB
used by SCardSetAttrib()
@ SCARD_RELEASE_CONTEXT
used by SCardReleaseContext()
@ CMD_STOP_WAITING_READER_STATE_CHANGE
stop waiting for a reader state change
@ CMD_GET_READERS_STATE
get the readers state
@ SCARD_GET_STATUS_CHANGE
not used
@ SCARD_CONTROL
used by SCardControl()
@ CMD_VERSION
get the client/server protocol version
@ CMD_WAIT_READER_STATE_CHANGE
wait for a reader state change
@ SCARD_RECONNECT
used by SCardReconnect()
@ SCARD_STATUS
used by SCardStatus()
@ SCARD_GET_ATTRIB
used by SCardGetAttrib()
@ SCARD_BEGIN_TRANSACTION
used by SCardBeginTransaction()
@ SCARD_TRANSMIT
used by SCardTransmit()
@ SCARD_LIST_READERS
used by SCardListReaders()
@ SCARD_END_TRANSACTION
used by SCardEndTransaction()
@ SCARD_CANCEL
used by SCardCancel()
@ SCARD_CANCEL_TRANSACTION
not used
@ SCARD_CONNECT
used by SCardConnect()
@ SCARD_ESTABLISH_CONTEXT
used by SCardEstablishContext()
INTERNAL int32_t InitializeSocket(void)
Prepares the communication channel used by the server to talk to the clients.
INTERNAL int32_t ProcessEventsServer(uint32_t *pdwClientID)
Looks for messages sent by clients.
This keeps a list of Windows(R) types.