connection.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2010-2026, Karsten Ohme
 *  This file is part of GlobalPlatform.
 *
 *  GlobalPlatform is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  GlobalPlatform is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with GlobalPlatform.  If not, see <https://www.gnu.org/licenses/>.
 *
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, and distribute linked combinations
 * including the two.
 * You must obey the GNU Lesser General Public License in all respects
 * for all of the code used other than OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.
 */
 
#ifndef OPGP_CONNECTION_H
#define OPGP_CONNECTION_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdio.h>
#ifdef WIN32
#include <WinSCard.h>
#else
#include <winscard.h>
#endif
#include "unicode.h"
#include "types.h"
#include "library.h"
#include "security.h"
#include "error.h"
 
#if !defined __winscard_h__
#define MAX_ATR_SIZE 33 
#endif
 
#define OPGP_TRACE_MODE_ENABLE 1 
#define OPGP_TRACE_MODE_DISABLE 0 
 
#define OPGP_CARD_PROTOCOL_T0 SCARD_PROTOCOL_T0 
#define OPGP_CARD_PROTOCOL_T1 SCARD_PROTOCOL_T1 
 
typedef struct OPGP_CARD_CONTEXT OPGP_CARD_CONTEXT;
typedef struct OPGP_CARD_INFO OPGP_CARD_INFO;
 
typedef OPGP_ERROR_STATUS (*OPGP_ESTABLISH_CONTEXT_FN)(OPGP_CARD_CONTEXT *);
typedef OPGP_ERROR_STATUS (*OPGP_RELEASE_CONTEXT_FN)(OPGP_CARD_CONTEXT *);
typedef OPGP_ERROR_STATUS (*OPGP_CARD_CONNECT_FN)(OPGP_CARD_CONTEXT, OPGP_CSTRING, OPGP_CARD_INFO *, DWORD);
typedef OPGP_ERROR_STATUS (*OPGP_CARD_DISCONNECT_FN)(OPGP_CARD_CONTEXT, OPGP_CARD_INFO *);
typedef OPGP_ERROR_STATUS (*OPGP_LIST_READERS_FN)(OPGP_CARD_CONTEXT, OPGP_STRING, PDWORD, DWORD);
typedef OPGP_ERROR_STATUS (*OPGP_SEND_APDU_FN)(OPGP_CARD_CONTEXT, OPGP_CARD_INFO, PBYTE, DWORD, PBYTE, PDWORD);
typedef OPGP_ERROR_STATUS (*OPGP_SUPPORTS_EXTENDED_APDU_FN)(OPGP_CARD_CONTEXT, OPGP_CARD_INFO, BOOL *);
 
typedef struct
{
        OPGP_ESTABLISH_CONTEXT_FN establishContext; 
        OPGP_RELEASE_CONTEXT_FN releaseContext; 
        OPGP_CARD_CONNECT_FN cardConnect; 
        OPGP_CARD_DISCONNECT_FN cardDisconnect; 
        OPGP_LIST_READERS_FN listReaders; 
        OPGP_SEND_APDU_FN sendAPDU; 
        OPGP_SUPPORTS_EXTENDED_APDU_FN supportsExtendedAPDU; 
 
} OPGP_CONNECTION_FUNCTIONS;
 
typedef struct OPGP_CARD_CONTEXT {
        PVOID librarySpecific; 
        TCHAR libraryName[64]; 
        TCHAR libraryVersion[32]; 
        PVOID libraryHandle; 
        OPGP_CONNECTION_FUNCTIONS connectionFunctions; 
} OPGP_CARD_CONTEXT;
 
typedef struct OPGP_CARD_INFO {
        BYTE ATR[MAX_ATR_SIZE]; 
        DWORD ATRLength; 
        BYTE logicalChannel; 
        BYTE specVersion; 
        BOOL extendedAPDUSupported; 
        PVOID librarySpecific; 
} OPGP_CARD_INFO;
 
// functions
 
OPGP_API
void OPGP_enable_trace_mode(DWORD enable, FILE *out);
 
extern DWORD traceEnable;
extern FILE *traceFile;
 
OPGP_API
OPGP_ERROR_STATUS OPGP_establish_context(OPGP_CARD_CONTEXT *cardContext);
 
OPGP_API
OPGP_ERROR_STATUS OPGP_release_context(OPGP_CARD_CONTEXT *cardContext);
 
OPGP_API
OPGP_ERROR_STATUS OPGP_list_readers(OPGP_CARD_CONTEXT cardContext, OPGP_STRING readerNames, PDWORD readerNamesLength, DWORD presentOnly);
 
OPGP_API
OPGP_ERROR_STATUS OPGP_card_connect(OPGP_CARD_CONTEXT cardContext, OPGP_CSTRING readerName, OPGP_CARD_INFO *cardInfo, DWORD protocol);
 
OPGP_API
OPGP_ERROR_STATUS OPGP_card_disconnect(OPGP_CARD_CONTEXT cardContext, OPGP_CARD_INFO *cardInfo);
 
OPGP_API
OPGP_ERROR_STATUS OPGP_send_APDU(OPGP_CARD_CONTEXT cardContext, OPGP_CARD_INFO cardInfo, GP211_SECURITY_INFO *secInfo, PBYTE capdu, DWORD capduLength, PBYTE rapdu, PDWORD rapduLength);
 
OPGP_API
OPGP_ERROR_STATUS OPGP_send_chained_APDU(OPGP_CARD_CONTEXT cardContext, OPGP_CARD_INFO cardInfo, GP211_SECURITY_INFO *secInfo, PBYTE capdus[], DWORD capduLengths[], DWORD numCapdus, PBYTE rapdu, PDWORD rapduLength);
 
OPGP_ERROR_STATUS OPGP_send_chained_APDU_extended(OPGP_CARD_CONTEXT cardContext, OPGP_CARD_INFO cardInfo, GP211_SECURITY_INFO *secInfo, PBYTE capdus[], DWORD capduLengths[], DWORD numCapdus, PBYTE rapdu, PDWORD rapduLength, BOOL allowExtendedApdu);
 
#ifdef __cplusplus
}
#endif
#endif