331 lines
12 KiB
Plaintext
331 lines
12 KiB
Plaintext
|
/*++
|
||
|
|
|
||
|
|
Copyright (c) 1996 Microsoft Corporation
|
||
|
|
|
||
|
|
Module Name:
|
||
|
|
|
||
|
|
winsmcrd.h
|
||
|
|
|
||
|
|
Abstract:
|
||
|
|
Smart Card class/port IOCTL codes. This file is required for all code
|
||
|
|
user mode and kernel mode, using Smart Card IOCTL's, defines,
|
||
|
|
data structures
|
||
|
|
|
||
|
|
Revision History:
|
||
|
|
|
||
|
|
--*/
|
||
|
|
|
||
|
|
|
||
|
|
#ifndef _NTDDSCRD_H2_
|
||
|
|
#define _NTDDSCRD_H2_
|
||
|
|
|
||
|
|
#if defined (_MSC_VER) && (_MSC_VER >= 1020)
|
||
|
|
#pragma once
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifdef _WINSCARD_H_
|
||
|
|
typedef DWORD ULONG;
|
||
|
|
typedef WORD UWORD;
|
||
|
|
typedef BYTE UCHAR;
|
||
|
|
#else
|
||
|
|
typedef ULONG DWORD;
|
||
|
|
// typedef UWORD WORD;
|
||
|
|
typedef UCHAR BYTE;
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#ifndef DEVICE_TYPE_SMARTCARD
|
||
|
|
#define FILE_DEVICE_SMARTCARD 0x00000031
|
||
|
|
#else
|
||
|
|
#if 0x00000031 != FILE_DEVICE_SMARTCARD
|
||
|
|
#error "Incorrect Smart Card Device Definition"
|
||
|
|
#endif
|
||
|
|
#endif
|
||
|
|
|
||
|
|
|
||
|
|
//
|
||
|
|
// Various constants
|
||
|
|
//
|
||
|
|
|
||
|
|
#define SCARD_ATR_LENGTH 33 // ISO 7816-3 spec.
|
||
|
|
|
||
|
|
//
|
||
|
|
///////////////////////////////////////////////////////////////////////////////
|
||
|
|
//
|
||
|
|
// Protocol Flag definitions
|
||
|
|
//
|
||
|
|
|
||
|
|
#define SCARD_PROTOCOL_UNDEFINED 0x00000000 // There is no active protocol.
|
||
|
|
#define SCARD_PROTOCOL_T0 0x00000001 // T=0 is the active protocol.
|
||
|
|
#define SCARD_PROTOCOL_T1 0x00000002 // T=1 is the active protocol.
|
||
|
|
#define SCARD_PROTOCOL_RAW 0x00010000 // Raw is the active protocol.
|
||
|
|
//
|
||
|
|
// This is the mask of ISO defined transmission protocols
|
||
|
|
//
|
||
|
|
#define SCARD_PROTOCOL_Tx (SCARD_PROTOCOL_T0 | SCARD_PROTOCOL_T1)
|
||
|
|
//
|
||
|
|
// Use the default transmission parameters / card clock freq.
|
||
|
|
//
|
||
|
|
#define SCARD_PROTOCOL_DEFAULT 0x80000000
|
||
|
|
//
|
||
|
|
// Use optimal transmission parameters / card clock freq.
|
||
|
|
// Since using the optimal parameters is the default case no bit is defined to be 1
|
||
|
|
//
|
||
|
|
#define SCARD_PROTOCOL_OPTIMAL 0x00000000
|
||
|
|
|
||
|
|
|
||
|
|
//
|
||
|
|
// Ioctl parameters 1 for IOCTL_SMARTCARD_POWER
|
||
|
|
//
|
||
|
|
#define SCARD_POWER_DOWN 0 // Power down the card.
|
||
|
|
#define SCARD_COLD_RESET 1 // Cycle power and reset the card.
|
||
|
|
#define SCARD_WARM_RESET 2 // Force a reset on the card.
|
||
|
|
|
||
|
|
//
|
||
|
|
///////////////////////////////////////////////////////////////////////////////
|
||
|
|
//
|
||
|
|
// Reader Action IOCTLs
|
||
|
|
//
|
||
|
|
|
||
|
|
#define SCARD_CTL_CODE(code) CTL_CODE(FILE_DEVICE_SMARTCARD, \
|
||
|
|
(code), \
|
||
|
|
METHOD_BUFFERED, \
|
||
|
|
FILE_ANY_ACCESS)
|
||
|
|
|
||
|
|
#define IOCTL_SMARTCARD_POWER SCARD_CTL_CODE( 1)
|
||
|
|
#define IOCTL_SMARTCARD_GET_ATTRIBUTE SCARD_CTL_CODE( 2)
|
||
|
|
#define IOCTL_SMARTCARD_SET_ATTRIBUTE SCARD_CTL_CODE( 3)
|
||
|
|
#define IOCTL_SMARTCARD_CONFISCATE SCARD_CTL_CODE( 4)
|
||
|
|
#define IOCTL_SMARTCARD_TRANSMIT SCARD_CTL_CODE( 5)
|
||
|
|
#define IOCTL_SMARTCARD_EJECT SCARD_CTL_CODE( 6)
|
||
|
|
#define IOCTL_SMARTCARD_SWALLOW SCARD_CTL_CODE( 7)
|
||
|
|
// #define IOCTL_SMARTCARD_READ SCARD_CTL_CODE( 8) obsolete
|
||
|
|
// #define IOCTL_SMARTCARD_WRITE SCARD_CTL_CODE( 9) obsolete
|
||
|
|
#define IOCTL_SMARTCARD_IS_PRESENT SCARD_CTL_CODE(10)
|
||
|
|
#define IOCTL_SMARTCARD_IS_ABSENT SCARD_CTL_CODE(11)
|
||
|
|
#define IOCTL_SMARTCARD_SET_PROTOCOL SCARD_CTL_CODE(12)
|
||
|
|
#define IOCTL_SMARTCARD_GET_STATE SCARD_CTL_CODE(14)
|
||
|
|
#define IOCTL_SMARTCARD_GET_LAST_ERROR SCARD_CTL_CODE(15)
|
||
|
|
#define IOCTL_SMARTCARD_GET_PERF_CNTR SCARD_CTL_CODE(16)
|
||
|
|
|
||
|
|
|
||
|
|
//
|
||
|
|
///////////////////////////////////////////////////////////////////////////////
|
||
|
|
//
|
||
|
|
// Tags for requesting card and reader attributes
|
||
|
|
//
|
||
|
|
|
||
|
|
#define MAXIMUM_ATTR_STRING_LENGTH 32 // Nothing bigger than this from getAttr
|
||
|
|
#define MAXIMUM_SMARTCARD_READERS 10 // Limit the readers on the system
|
||
|
|
|
||
|
|
#define SCARD_ATTR_VALUE(Class, Tag) ((((ULONG)(Class)) << 16) | ((ULONG)(Tag)))
|
||
|
|
|
||
|
|
#define SCARD_CLASS_VENDOR_INFO 1 // Vendor information definitions
|
||
|
|
#define SCARD_CLASS_COMMUNICATIONS 2 // Communication definitions
|
||
|
|
#define SCARD_CLASS_PROTOCOL 3 // Protocol definitions
|
||
|
|
#define SCARD_CLASS_POWER_MGMT 4 // Power Management definitions
|
||
|
|
#define SCARD_CLASS_SECURITY 5 // Security Assurance definitions
|
||
|
|
#define SCARD_CLASS_MECHANICAL 6 // Mechanical characteristic definitions
|
||
|
|
#define SCARD_CLASS_VENDOR_DEFINED 7 // Vendor specific definitions
|
||
|
|
#define SCARD_CLASS_IFD_PROTOCOL 8 // Interface Device Protocol options
|
||
|
|
#define SCARD_CLASS_ICC_STATE 9 // ICC State specific definitions
|
||
|
|
#define SCARD_CLASS_PERF 0x7ffe // performace counters
|
||
|
|
#define SCARD_CLASS_SYSTEM 0x7fff // System-specific definitions
|
||
|
|
|
||
|
|
#define SCARD_ATTR_VENDOR_NAME SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0100)
|
||
|
|
#define SCARD_ATTR_VENDOR_IFD_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0101)
|
||
|
|
#define SCARD_ATTR_VENDOR_IFD_VERSION SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0102)
|
||
|
|
#define SCARD_ATTR_VENDOR_IFD_SERIAL_NO SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_INFO, 0x0103)
|
||
|
|
#define SCARD_ATTR_CHANNEL_ID SCARD_ATTR_VALUE(SCARD_CLASS_COMMUNICATIONS, 0x0110)
|
||
|
|
#define SCARD_ATTR_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0120)
|
||
|
|
// #define SCARD_ATTR_ASYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0120)
|
||
|
|
#define SCARD_ATTR_DEFAULT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0121)
|
||
|
|
#define SCARD_ATTR_MAX_CLK SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0122)
|
||
|
|
#define SCARD_ATTR_DEFAULT_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0123)
|
||
|
|
#define SCARD_ATTR_MAX_DATA_RATE SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0124)
|
||
|
|
#define SCARD_ATTR_MAX_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0125)
|
||
|
|
// #define SCARD_ATTR_SYNC_PROTOCOL_TYPES SCARD_ATTR_VALUE(SCARD_CLASS_PROTOCOL, 0x0126)
|
||
|
|
#define SCARD_ATTR_POWER_MGMT_SUPPORT SCARD_ATTR_VALUE(SCARD_CLASS_POWER_MGMT, 0x0131)
|
||
|
|
#define SCARD_ATTR_USER_TO_CARD_AUTH_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0140)
|
||
|
|
#define SCARD_ATTR_USER_AUTH_INPUT_DEVICE SCARD_ATTR_VALUE(SCARD_CLASS_SECURITY, 0x0142)
|
||
|
|
#define SCARD_ATTR_CHARACTERISTICS SCARD_ATTR_VALUE(SCARD_CLASS_MECHANICAL, 0x0150)
|
||
|
|
|
||
|
|
#define SCARD_ATTR_CURRENT_PROTOCOL_TYPE SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0201)
|
||
|
|
#define SCARD_ATTR_CURRENT_CLK SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0202)
|
||
|
|
#define SCARD_ATTR_CURRENT_F SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0203)
|
||
|
|
#define SCARD_ATTR_CURRENT_D SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0204)
|
||
|
|
#define SCARD_ATTR_CURRENT_N SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0205)
|
||
|
|
#define SCARD_ATTR_CURRENT_W SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0206)
|
||
|
|
#define SCARD_ATTR_CURRENT_IFSC SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0207)
|
||
|
|
#define SCARD_ATTR_CURRENT_IFSD SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0208)
|
||
|
|
#define SCARD_ATTR_CURRENT_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x0209)
|
||
|
|
#define SCARD_ATTR_CURRENT_CWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020a)
|
||
|
|
#define SCARD_ATTR_CURRENT_EBC_ENCODING SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020b)
|
||
|
|
#define SCARD_ATTR_EXTENDED_BWT SCARD_ATTR_VALUE(SCARD_CLASS_IFD_PROTOCOL, 0x020c)
|
||
|
|
|
||
|
|
#define SCARD_ATTR_ICC_PRESENCE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0300)
|
||
|
|
#define SCARD_ATTR_ICC_INTERFACE_STATUS SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0301)
|
||
|
|
#define SCARD_ATTR_CURRENT_IO_STATE SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0302)
|
||
|
|
#define SCARD_ATTR_ATR_STRING SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0303)
|
||
|
|
#define SCARD_ATTR_ICC_TYPE_PER_ATR SCARD_ATTR_VALUE(SCARD_CLASS_ICC_STATE, 0x0304)
|
||
|
|
|
||
|
|
#define SCARD_ATTR_ESC_RESET SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA000)
|
||
|
|
#define SCARD_ATTR_ESC_CANCEL SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA003)
|
||
|
|
#define SCARD_ATTR_ESC_AUTHREQUEST SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA005)
|
||
|
|
#define SCARD_ATTR_MAXINPUT SCARD_ATTR_VALUE(SCARD_CLASS_VENDOR_DEFINED, 0xA007)
|
||
|
|
|
||
|
|
#define SCARD_ATTR_DEVICE_UNIT SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0001)
|
||
|
|
#define SCARD_ATTR_DEVICE_IN_USE SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0002)
|
||
|
|
#define SCARD_ATTR_DEVICE_FRIENDLY_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0003)
|
||
|
|
#define SCARD_ATTR_DEVICE_SYSTEM_NAME_A SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0004)
|
||
|
|
#define SCARD_ATTR_DEVICE_FRIENDLY_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0005)
|
||
|
|
#define SCARD_ATTR_DEVICE_SYSTEM_NAME_W SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0006)
|
||
|
|
#define SCARD_ATTR_SUPRESS_T1_IFS_REQUEST SCARD_ATTR_VALUE(SCARD_CLASS_SYSTEM, 0x0007)
|
||
|
|
|
||
|
|
#define SCARD_PERF_NUM_TRANSMISSIONS SCARD_ATTR_VALUE(SCARD_CLASS_PERF, 0x0001)
|
||
|
|
#define SCARD_PERF_BYTES_TRANSMITTED SCARD_ATTR_VALUE(SCARD_CLASS_PERF, 0x0002)
|
||
|
|
#define SCARD_PERF_TRANSMISSION_TIME SCARD_ATTR_VALUE(SCARD_CLASS_PERF, 0x0003)
|
||
|
|
|
||
|
|
#ifdef UNICODE
|
||
|
|
#define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_W
|
||
|
|
#define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_W
|
||
|
|
#else
|
||
|
|
#define SCARD_ATTR_DEVICE_FRIENDLY_NAME SCARD_ATTR_DEVICE_FRIENDLY_NAME_A
|
||
|
|
#define SCARD_ATTR_DEVICE_SYSTEM_NAME SCARD_ATTR_DEVICE_SYSTEM_NAME_A
|
||
|
|
#endif
|
||
|
|
|
||
|
|
|
||
|
|
//
|
||
|
|
// T=0 Protocol Defines
|
||
|
|
//
|
||
|
|
|
||
|
|
#define SCARD_T0_HEADER_LENGTH 7
|
||
|
|
#define SCARD_T0_CMD_LENGTH 5
|
||
|
|
|
||
|
|
|
||
|
|
//
|
||
|
|
// T=1 Protocol Defines
|
||
|
|
//
|
||
|
|
|
||
|
|
#define SCARD_T1_PROLOGUE_LENGTH 3
|
||
|
|
#define SCARD_T1_EPILOGUE_LENGTH 2
|
||
|
|
#define SCARD_T1_MAX_IFS 254
|
||
|
|
|
||
|
|
|
||
|
|
//
|
||
|
|
///////////////////////////////////////////////////////////////////////////////
|
||
|
|
//
|
||
|
|
// Reader states
|
||
|
|
//
|
||
|
|
|
||
|
|
#define SCARD_UNKNOWN 0 // This value implies the driver is unaware
|
||
|
|
// of the current state of the reader.
|
||
|
|
#define SCARD_ABSENT 1 // This value implies there is no card in
|
||
|
|
// the reader.
|
||
|
|
#define SCARD_PRESENT 2 // This value implies there is a card is
|
||
|
|
// present in the reader, but that it has
|
||
|
|
// not been moved into position for use.
|
||
|
|
#define SCARD_SWALLOWED 3 // This value implies there is a card in the
|
||
|
|
// reader in position for use. The card is
|
||
|
|
// not powered.
|
||
|
|
#define SCARD_POWERED 4 // This value implies there is power is
|
||
|
|
// being provided to the card, but the
|
||
|
|
// Reader Driver is unaware of the mode of
|
||
|
|
// the card.
|
||
|
|
#define SCARD_NEGOTIABLE 5 // This value implies the card has been
|
||
|
|
// reset and is awaiting PTS negotiation.
|
||
|
|
#define SCARD_SPECIFIC 6 // This value implies the card has been
|
||
|
|
// reset and specific communication
|
||
|
|
// protocols have been established.
|
||
|
|
|
||
|
|
////////////////////////////////////////////////////////////////////////////////
|
||
|
|
//
|
||
|
|
// I/O Services
|
||
|
|
//
|
||
|
|
// The following services provide access to the I/O capabilities of the
|
||
|
|
// reader drivers. Services of the Smart Card are requested by placing the
|
||
|
|
// following structure into the protocol buffer:
|
||
|
|
//
|
||
|
|
|
||
|
|
|
||
|
|
typedef struct _SCARD_IO_REQUEST{
|
||
|
|
DWORD dwProtocol; // Protocol identifier
|
||
|
|
DWORD cbPciLength; // Protocol Control Information Length
|
||
|
|
} SCARD_IO_REQUEST, *PSCARD_IO_REQUEST, *LPSCARD_IO_REQUEST;
|
||
|
|
typedef const SCARD_IO_REQUEST *LPCSCARD_IO_REQUEST;
|
||
|
|
|
||
|
|
|
||
|
|
//
|
||
|
|
// T=0 protocol services.
|
||
|
|
//
|
||
|
|
|
||
|
|
typedef struct {
|
||
|
|
BYTE
|
||
|
|
bCla, // The instruction class
|
||
|
|
bIns, // The instruction code within the instruction class
|
||
|
|
bP1,
|
||
|
|
bP2, // Parameters to the instruction
|
||
|
|
bP3; // Size of I/O Transfer
|
||
|
|
} SCARD_T0_COMMAND, *LPSCARD_T0_COMMAND;
|
||
|
|
|
||
|
|
typedef struct {
|
||
|
|
SCARD_IO_REQUEST ioRequest;
|
||
|
|
BYTE
|
||
|
|
bSw1,
|
||
|
|
bSw2; // Return codes from the instruction
|
||
|
|
union
|
||
|
|
{
|
||
|
|
SCARD_T0_COMMAND CmdBytes;
|
||
|
|
BYTE rgbHeader[5];
|
||
|
|
};
|
||
|
|
} SCARD_T0_REQUEST;
|
||
|
|
|
||
|
|
typedef SCARD_T0_REQUEST *PSCARD_T0_REQUEST, *LPSCARD_T0_REQUEST;
|
||
|
|
|
||
|
|
|
||
|
|
//
|
||
|
|
// T=1 Protocol Services
|
||
|
|
//
|
||
|
|
|
||
|
|
typedef struct {
|
||
|
|
SCARD_IO_REQUEST ioRequest;
|
||
|
|
} SCARD_T1_REQUEST;
|
||
|
|
typedef SCARD_T1_REQUEST *PSCARD_T1_REQUEST, *LPSCARD_T1_REQUEST;
|
||
|
|
|
||
|
|
|
||
|
|
//
|
||
|
|
////////////////////////////////////////////////////////////////////////////////
|
||
|
|
//
|
||
|
|
// Driver attribute flags
|
||
|
|
//
|
||
|
|
|
||
|
|
#define SCARD_READER_SWALLOWS 0x00000001 // Reader has a card swallowing
|
||
|
|
// mechanism.
|
||
|
|
#define SCARD_READER_EJECTS 0x00000002 // Reader has a card ejection
|
||
|
|
// mechanism.
|
||
|
|
#define SCARD_READER_CONFISCATES 0x00000004 // Reader has a card capture
|
||
|
|
// mechanism.
|
||
|
|
|
||
|
|
//
|
||
|
|
///////////////////////////////////////////////////////////////////////////////
|
||
|
|
//
|
||
|
|
// Type of reader
|
||
|
|
//
|
||
|
|
#define SCARD_READER_TYPE_SERIAL 0x01
|
||
|
|
#define SCARD_READER_TYPE_PARALELL 0x02
|
||
|
|
#define SCARD_READER_TYPE_KEYBOARD 0x04
|
||
|
|
#define SCARD_READER_TYPE_SCSI 0x08
|
||
|
|
#define SCARD_READER_TYPE_IDE 0x10
|
||
|
|
#define SCARD_READER_TYPE_USB 0x20
|
||
|
|
#define SCARD_READER_TYPE_PCMCIA 0x40
|
||
|
|
#define SCARD_READER_TYPE_VENDOR 0xF0
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
#endif
|
||
|
|
|