smartcard 3.2.1 → 3.4.0

package/lib/control-codes.js

@@ -1,107 +0,0 @@
-// @ts-check
-'use strict';
-
-/**
- * Control codes and feature constants for PC/SC smart card operations
- */
-
-/**
- * Generate a control code (platform-specific)
- * @param {number} code - The control code number
- * @returns {number} The platform-specific control code
- */
-function SCARD_CTL_CODE(code) {
-    if (process.platform === 'win32') {
-        // Windows: (FILE_DEVICE_SMARTCARD << 16) + (code << 2)
-        // FILE_DEVICE_SMARTCARD = 0x31
-        return (0x31 << 16) + (code << 2);
-    } else {
-        // macOS/Linux: 0x42000000 + code
-        return 0x42000000 + code;
-    }
-}
-
-// Common control codes
-const CM_IOCTL_GET_FEATURE_REQUEST = SCARD_CTL_CODE(3400);
-
-// CCID Feature tags (from CCID spec)
-const FEATURE_VERIFY_PIN_START = 0x01;
-const FEATURE_VERIFY_PIN_FINISH = 0x02;
-const FEATURE_MODIFY_PIN_START = 0x03;
-const FEATURE_MODIFY_PIN_FINISH = 0x04;
-const FEATURE_GET_KEY_PRESSED = 0x05;
-const FEATURE_VERIFY_PIN_DIRECT = 0x06;
-const FEATURE_MODIFY_PIN_DIRECT = 0x07;
-const FEATURE_MCT_READER_DIRECT = 0x08;
-const FEATURE_MCT_UNIVERSAL = 0x09;
-const FEATURE_IFD_PIN_PROPERTIES = 0x0A;
-const FEATURE_ABORT = 0x0B;
-const FEATURE_SET_SPE_MESSAGE = 0x0C;
-const FEATURE_VERIFY_PIN_DIRECT_APP_ID = 0x0D;
-const FEATURE_MODIFY_PIN_DIRECT_APP_ID = 0x0E;
-const FEATURE_WRITE_DISPLAY = 0x0F;
-const FEATURE_GET_KEY = 0x10;
-const FEATURE_IFD_DISPLAY_PROPERTIES = 0x11;
-const FEATURE_GET_TLV_PROPERTIES = 0x12;
-const FEATURE_CCID_ESC_COMMAND = 0x13;
-
-/**
- * Parse feature TLV response from CM_IOCTL_GET_FEATURE_REQUEST
- * @param {Buffer} response - The TLV response buffer
- * @returns {Map<number, number>} Map of feature tag to control code
- */
-function parseFeatures(response) {
-    const features = new Map();
-    let offset = 0;
-
-    while (offset + 4 <= response.length) {
-        const tag = response[offset];
-        const length = response[offset + 1];
-
-        if (length === 4 && offset + 2 + length <= response.length) {
-            // Big-endian control code
-            const controlCode =
-                (response[offset + 2] << 24) |
-                (response[offset + 3] << 16) |
-                (response[offset + 4] << 8) |
-                response[offset + 5];
-            features.set(tag, controlCode);
-        }
-
-        offset += 2 + length;
-    }
-
-    return features;
-}
-
-module.exports = {
-    // Control code generator
-    SCARD_CTL_CODE,
-
-    // Common control codes
-    CM_IOCTL_GET_FEATURE_REQUEST,
-
-    // CCID Feature tags
-    FEATURE_VERIFY_PIN_START,
-    FEATURE_VERIFY_PIN_FINISH,
-    FEATURE_MODIFY_PIN_START,
-    FEATURE_MODIFY_PIN_FINISH,
-    FEATURE_GET_KEY_PRESSED,
-    FEATURE_VERIFY_PIN_DIRECT,
-    FEATURE_MODIFY_PIN_DIRECT,
-    FEATURE_MCT_READER_DIRECT,
-    FEATURE_MCT_UNIVERSAL,
-    FEATURE_IFD_PIN_PROPERTIES,
-    FEATURE_ABORT,
-    FEATURE_SET_SPE_MESSAGE,
-    FEATURE_VERIFY_PIN_DIRECT_APP_ID,
-    FEATURE_MODIFY_PIN_DIRECT_APP_ID,
-    FEATURE_WRITE_DISPLAY,
-    FEATURE_GET_KEY,
-    FEATURE_IFD_DISPLAY_PROPERTIES,
-    FEATURE_GET_TLV_PROPERTIES,
-    FEATURE_CCID_ESC_COMMAND,
-
-    // Helper functions
-    parseFeatures,
-};

package/lib/index.d.ts

@@ -1,325 +0,0 @@
-/// <reference types="node" />
-
-import { EventEmitter } from 'events';
-
-/**
- * Reader state information returned from waitForChange
- */
-export interface ReaderState {
-    name: string;
-    state: number;
-    changed: boolean;
-    atr: Buffer | null;
-}
-
-/**
- * Card status information
- */
-export interface CardStatus {
-    state: number;
-    protocol: number;
-    atr: Buffer;
-}
-
-/**
- * Options for card.transmit()
- */
-export interface TransmitOptions {
-    /**
-     * Maximum receive buffer size in bytes.
-     * Default: 258 (standard APDU: 256 data + 2 status bytes)
-     * Maximum: 262144 (256KB for extended APDUs)
-     */
-    maxRecvLength?: number;
-}
-
-/**
- * Represents a connected smart card
- */
-export interface Card {
-    /** The active protocol (T0, T1, or RAW) */
-    readonly protocol: number;
-    /** Whether the card is still connected */
-    readonly connected: boolean;
-    /** The card's ATR (Answer To Reset) */
-    readonly atr: Buffer | null;
-
-    /**
-     * Transmit an APDU command to the card
-     * @param command - The command buffer or byte array
-     * @param options - Optional transmit options
-     * @returns Promise resolving to the response buffer
-     */
-    transmit(command: Buffer | number[], options?: TransmitOptions): Promise<Buffer>;
-
-    /**
-     * Send a control command to the reader
-     * @param code - Control code
-     * @param data - Optional data buffer
-     * @returns Promise resolving to the response buffer
-     */
-    control(code: number, data?: Buffer | number[]): Promise<Buffer>;
-
-    /**
-     * Get the current card status
-     * @returns Card status object
-     */
-    getStatus(): CardStatus;
-
-    /**
-     * Disconnect from the card
-     * @param disposition - What to do with the card (default: SCARD_LEAVE_CARD)
-     */
-    disconnect(disposition?: number): void;
-
-    /**
-     * Reconnect to the card (async)
-     * @param shareMode - Share mode
-     * @param protocol - Preferred protocol(s)
-     * @param initialization - Initialization action
-     * @returns Promise resolving to the new active protocol
-     */
-    reconnect(shareMode?: number, protocol?: number, initialization?: number): Promise<number>;
-}
-
-/**
- * Represents a smart card reader
- */
-export interface Reader {
-    /** The reader name */
-    readonly name: string;
-    /** Current reader state flags */
-    readonly state: number;
-    /** ATR of the card if present */
-    readonly atr: Buffer | null;
-
-    /**
-     * Connect to a card in the reader
-     * @param shareMode - Share mode (default: SCARD_SHARE_SHARED)
-     * @param protocol - Preferred protocol(s) (default: T0 | T1)
-     * @returns Promise resolving to a Card object
-     */
-    connect(shareMode?: number, protocol?: number): Promise<Card>;
-}
-
-/**
- * Low-level PC/SC context
- */
-export declare class Context {
-    constructor();
-
-    /** Whether the context is still valid */
-    readonly isValid: boolean;
-
-    /**
-     * List available readers
-     * @returns Array of Reader objects
-     */
-    listReaders(): Reader[];
-
-    /**
-     * Wait for reader/card state changes
-     * @param readers - Optional array of readers to monitor
-     * @param timeout - Timeout in milliseconds (default: infinite)
-     * @returns Promise resolving to array of reader states
-     */
-    waitForChange(readers?: Reader[] | ReaderState[], timeout?: number): Promise<ReaderState[] | null>;
-
-    /**
-     * Cancel a pending waitForChange call
-     */
-    cancel(): void;
-
-    /**
-     * Close the context and release resources
-     */
-    close(): void;
-}
-
-/**
- * Monitor event from native ReaderMonitor
- */
-export interface MonitorEvent {
-    type: 'reader-attached' | 'reader-detached' | 'card-inserted' | 'card-removed' | 'error';
-    reader: string;
-    state: number;
-    atr: Buffer | null;
-}
-
-/**
- * Native PC/SC event monitor using ThreadSafeFunction
- * Runs monitoring on a background thread for efficiency
- */
-export declare class ReaderMonitor {
-    constructor();
-
-    /** Whether the monitor is currently running */
-    readonly isRunning: boolean;
-
-    /**
-     * Start monitoring for reader/card changes
-     * @param callback - Function called when events occur
-     */
-    start(callback: (event: MonitorEvent) => void): void;
-
-    /**
-     * Stop monitoring
-     */
-    stop(): void;
-}
-
-/**
- * Event types for Devices class
- */
-export interface DeviceEvents {
-    'reader-attached': (reader: Reader) => void;
-    'reader-detached': (reader: Reader) => void;
-    'card-inserted': (event: { reader: Reader; card: Card }) => void;
-    'card-removed': (event: { reader: Reader; card: Card | null }) => void;
-    'error': (error: Error) => void;
-}
-
-/**
- * High-level event-driven API for monitoring PC/SC devices
- */
-export declare class Devices extends EventEmitter {
-    constructor();
-
-    /**
-     * Start monitoring for device changes
-     */
-    start(): void;
-
-    /**
-     * Stop monitoring and release resources
-     */
-    stop(): void;
-
-    /**
-     * List currently known readers
-     * @returns Array of Reader objects
-     */
-    listReaders(): Reader[];
-
-    on<K extends keyof DeviceEvents>(event: K, listener: DeviceEvents[K]): this;
-    once<K extends keyof DeviceEvents>(event: K, listener: DeviceEvents[K]): this;
-    off<K extends keyof DeviceEvents>(event: K, listener: DeviceEvents[K]): this;
-    emit<K extends keyof DeviceEvents>(event: K, ...args: Parameters<DeviceEvents[K]>): boolean;
-}
-
-/**
- * Base PC/SC error class
- */
-export declare class PCSCError extends Error {
-    readonly code: number;
-    constructor(message: string, code: number);
-}
-
-/**
- * Error thrown when card is removed during operation
- */
-export declare class CardRemovedError extends PCSCError {
-    constructor(message?: string);
-}
-
-/**
- * Error thrown when operation times out
- */
-export declare class TimeoutError extends PCSCError {
-    constructor(message?: string);
-}
-
-/**
- * Error thrown when no readers are available
- */
-export declare class NoReadersError extends PCSCError {
-    constructor(message?: string);
-}
-
-/**
- * Error thrown when PC/SC service is not running
- */
-export declare class ServiceNotRunningError extends PCSCError {
-    constructor(message?: string);
-}
-
-/**
- * Error thrown when there's a sharing violation
- */
-export declare class SharingViolationError extends PCSCError {
-    constructor(message?: string);
-}
-
-/**
- * Factory function to create the appropriate error class based on PC/SC error code
- */
-export declare function createPCSCError(message: string, code: number): PCSCError;
-
-// Share modes
-export declare const SCARD_SHARE_EXCLUSIVE: number;
-export declare const SCARD_SHARE_SHARED: number;
-export declare const SCARD_SHARE_DIRECT: number;
-
-// Protocols
-export declare const SCARD_PROTOCOL_T0: number;
-export declare const SCARD_PROTOCOL_T1: number;
-export declare const SCARD_PROTOCOL_RAW: number;
-export declare const SCARD_PROTOCOL_UNDEFINED: number;
-
-// Disposition
-export declare const SCARD_LEAVE_CARD: number;
-export declare const SCARD_RESET_CARD: number;
-export declare const SCARD_UNPOWER_CARD: number;
-export declare const SCARD_EJECT_CARD: number;
-
-// State flags
-export declare const SCARD_STATE_UNAWARE: number;
-export declare const SCARD_STATE_IGNORE: number;
-export declare const SCARD_STATE_CHANGED: number;
-export declare const SCARD_STATE_UNKNOWN: number;
-export declare const SCARD_STATE_UNAVAILABLE: number;
-export declare const SCARD_STATE_EMPTY: number;
-export declare const SCARD_STATE_PRESENT: number;
-export declare const SCARD_STATE_ATRMATCH: number;
-export declare const SCARD_STATE_EXCLUSIVE: number;
-export declare const SCARD_STATE_INUSE: number;
-export declare const SCARD_STATE_MUTE: number;
-
-// Control code generator
-/**
- * Generate a platform-specific control code
- * @param code - The control code number
- * @returns The platform-specific control code
- */
-export declare function SCARD_CTL_CODE(code: number): number;
-
-// Common control codes
-export declare const CM_IOCTL_GET_FEATURE_REQUEST: number;
-
-// CCID Feature tags
-export declare const FEATURE_VERIFY_PIN_START: number;
-export declare const FEATURE_VERIFY_PIN_FINISH: number;
-export declare const FEATURE_MODIFY_PIN_START: number;
-export declare const FEATURE_MODIFY_PIN_FINISH: number;
-export declare const FEATURE_GET_KEY_PRESSED: number;
-export declare const FEATURE_VERIFY_PIN_DIRECT: number;
-export declare const FEATURE_MODIFY_PIN_DIRECT: number;
-export declare const FEATURE_MCT_READER_DIRECT: number;
-export declare const FEATURE_MCT_UNIVERSAL: number;
-export declare const FEATURE_IFD_PIN_PROPERTIES: number;
-export declare const FEATURE_ABORT: number;
-export declare const FEATURE_SET_SPE_MESSAGE: number;
-export declare const FEATURE_VERIFY_PIN_DIRECT_APP_ID: number;
-export declare const FEATURE_MODIFY_PIN_DIRECT_APP_ID: number;
-export declare const FEATURE_WRITE_DISPLAY: number;
-export declare const FEATURE_GET_KEY: number;
-export declare const FEATURE_IFD_DISPLAY_PROPERTIES: number;
-export declare const FEATURE_GET_TLV_PROPERTIES: number;
-export declare const FEATURE_CCID_ESC_COMMAND: number;
-
-/**
- * Parse feature TLV response from CM_IOCTL_GET_FEATURE_REQUEST
- * @param response - The TLV response buffer
- * @returns Map of feature tag to control code
- */
-export declare function parseFeatures(response: Buffer): Map<number, number>;

package/lib/index.js

@@ -1,151 +0,0 @@
-// @ts-check
-'use strict';
-
-// Load native addon
-const addon = require('../build/Release/smartcard_napi.node');
-
-// Re-export native classes
-const { Context, Reader, Card, ReaderMonitor } = addon;
-
-// Re-export constants
-const SCARD_SHARE_EXCLUSIVE = addon.SCARD_SHARE_EXCLUSIVE;
-const SCARD_SHARE_SHARED = addon.SCARD_SHARE_SHARED;
-const SCARD_SHARE_DIRECT = addon.SCARD_SHARE_DIRECT;
-
-const SCARD_PROTOCOL_T0 = addon.SCARD_PROTOCOL_T0;
-const SCARD_PROTOCOL_T1 = addon.SCARD_PROTOCOL_T1;
-const SCARD_PROTOCOL_RAW = addon.SCARD_PROTOCOL_RAW;
-const SCARD_PROTOCOL_UNDEFINED = addon.SCARD_PROTOCOL_UNDEFINED;
-
-const SCARD_LEAVE_CARD = addon.SCARD_LEAVE_CARD;
-const SCARD_RESET_CARD = addon.SCARD_RESET_CARD;
-const SCARD_UNPOWER_CARD = addon.SCARD_UNPOWER_CARD;
-const SCARD_EJECT_CARD = addon.SCARD_EJECT_CARD;
-
-const SCARD_STATE_UNAWARE = addon.SCARD_STATE_UNAWARE;
-const SCARD_STATE_IGNORE = addon.SCARD_STATE_IGNORE;
-const SCARD_STATE_CHANGED = addon.SCARD_STATE_CHANGED;
-const SCARD_STATE_UNKNOWN = addon.SCARD_STATE_UNKNOWN;
-const SCARD_STATE_UNAVAILABLE = addon.SCARD_STATE_UNAVAILABLE;
-const SCARD_STATE_EMPTY = addon.SCARD_STATE_EMPTY;
-const SCARD_STATE_PRESENT = addon.SCARD_STATE_PRESENT;
-const SCARD_STATE_ATRMATCH = addon.SCARD_STATE_ATRMATCH;
-const SCARD_STATE_EXCLUSIVE = addon.SCARD_STATE_EXCLUSIVE;
-const SCARD_STATE_INUSE = addon.SCARD_STATE_INUSE;
-const SCARD_STATE_MUTE = addon.SCARD_STATE_MUTE;
-
-// Import Devices class
-const { Devices } = require('./devices');
-
-// Import error classes
-const {
-    PCSCError,
-    CardRemovedError,
-    TimeoutError,
-    NoReadersError,
-    ServiceNotRunningError,
-    SharingViolationError,
-    createPCSCError,
-} = require('./errors');
-
-// Import control codes
-const {
-    SCARD_CTL_CODE,
-    CM_IOCTL_GET_FEATURE_REQUEST,
-    FEATURE_VERIFY_PIN_START,
-    FEATURE_VERIFY_PIN_FINISH,
-    FEATURE_MODIFY_PIN_START,
-    FEATURE_MODIFY_PIN_FINISH,
-    FEATURE_GET_KEY_PRESSED,
-    FEATURE_VERIFY_PIN_DIRECT,
-    FEATURE_MODIFY_PIN_DIRECT,
-    FEATURE_MCT_READER_DIRECT,
-    FEATURE_MCT_UNIVERSAL,
-    FEATURE_IFD_PIN_PROPERTIES,
-    FEATURE_ABORT,
-    FEATURE_SET_SPE_MESSAGE,
-    FEATURE_VERIFY_PIN_DIRECT_APP_ID,
-    FEATURE_MODIFY_PIN_DIRECT_APP_ID,
-    FEATURE_WRITE_DISPLAY,
-    FEATURE_GET_KEY,
-    FEATURE_IFD_DISPLAY_PROPERTIES,
-    FEATURE_GET_TLV_PROPERTIES,
-    FEATURE_CCID_ESC_COMMAND,
-    parseFeatures,
-} = require('./control-codes');
-
-module.exports = {
-    // Classes
-    Context,
-    Reader,
-    Card,
-    Devices,
-    ReaderMonitor,
-
-    // Error classes
-    PCSCError,
-    CardRemovedError,
-    TimeoutError,
-    NoReadersError,
-    ServiceNotRunningError,
-    SharingViolationError,
-    createPCSCError,
-
-    // Share modes
-    SCARD_SHARE_EXCLUSIVE,
-    SCARD_SHARE_SHARED,
-    SCARD_SHARE_DIRECT,
-
-    // Protocols
-    SCARD_PROTOCOL_T0,
-    SCARD_PROTOCOL_T1,
-    SCARD_PROTOCOL_RAW,
-    SCARD_PROTOCOL_UNDEFINED,
-
-    // Disposition
-    SCARD_LEAVE_CARD,
-    SCARD_RESET_CARD,
-    SCARD_UNPOWER_CARD,
-    SCARD_EJECT_CARD,
-
-    // State flags
-    SCARD_STATE_UNAWARE,
-    SCARD_STATE_IGNORE,
-    SCARD_STATE_CHANGED,
-    SCARD_STATE_UNKNOWN,
-    SCARD_STATE_UNAVAILABLE,
-    SCARD_STATE_EMPTY,
-    SCARD_STATE_PRESENT,
-    SCARD_STATE_ATRMATCH,
-    SCARD_STATE_EXCLUSIVE,
-    SCARD_STATE_INUSE,
-    SCARD_STATE_MUTE,
-
-    // Control codes
-    SCARD_CTL_CODE,
-    CM_IOCTL_GET_FEATURE_REQUEST,
-
-    // CCID Feature tags
-    FEATURE_VERIFY_PIN_START,
-    FEATURE_VERIFY_PIN_FINISH,
-    FEATURE_MODIFY_PIN_START,
-    FEATURE_MODIFY_PIN_FINISH,
-    FEATURE_GET_KEY_PRESSED,
-    FEATURE_VERIFY_PIN_DIRECT,
-    FEATURE_MODIFY_PIN_DIRECT,
-    FEATURE_MCT_READER_DIRECT,
-    FEATURE_MCT_UNIVERSAL,
-    FEATURE_IFD_PIN_PROPERTIES,
-    FEATURE_ABORT,
-    FEATURE_SET_SPE_MESSAGE,
-    FEATURE_VERIFY_PIN_DIRECT_APP_ID,
-    FEATURE_MODIFY_PIN_DIRECT_APP_ID,
-    FEATURE_WRITE_DISPLAY,
-    FEATURE_GET_KEY,
-    FEATURE_IFD_DISPLAY_PROPERTIES,
-    FEATURE_GET_TLV_PROPERTIES,
-    FEATURE_CCID_ESC_COMMAND,
-
-    // Helper functions
-    parseFeatures,
-};