node-pcsclite

Bindings over pcsclite to access Smart Cards. It works in Linux, macOS and Windows.

📌 Looking for library to work easy with NFC tags?
Then take a look at nfc-pcsc which offers an easy to use high level API for detecting / reading and writing NFC tags and cards.

Content

• Installation
• Example
• Behavior on different OS
• API
  • Class: PCSCLite
    • Event: error
    • Event: reader
    • pcsclite.close()
    • pcsclite.readers
  • Class: CardReader
    • Event: error
    • Event: end
    • Event: status
    • reader.connect([options], callback)
    • reader.disconnect(disposition, callback)
    • reader.transmit(input, res_len, protocol, callback)
    • reader.control(input, control_code, res_len, callback)
    • reader.close()
• FAQ
  • Can I use this library in my Electron app?
  • Are prebuilt binaries provided?
  • Disabling drivers to make pcsclite working on Linux
  • Which Node.js versions are supported?
• License

Installation

Requirements: at least Node.js 8 or newer (see this FAQ for more info)

1. Node Native Modules build tools

   Because this library uses Node Native Modules (C++ Addons), which are automatically built (using node-gyp) when installing via npm or yarn, you need to have installed C/C++ compiler toolchain and some other tools depending on your OS.

   Please refer to the node-gyp > Installation for the list of required tools depending on your OS and steps how to install them.

2. PC/SC API in your OS

   On macOS and Windows you don't have to install anything, pcsclite API is provided by the OS.

   On Linux/UNIX you'd probably need to install pcsclite library and deamon**.

   For example, in Debian/Ubuntu:

   1apt-get install libpcsclite1 libpcsclite-dev

   To run any code you will also need to have installed the pcsc daemon:

   1apt-get install pcscd

3. Once you have all needed libraries, you can install node-pcsclite using npm:

   1npm install @pokusew/pcsclite --save

   or using Yarn:

   1yarn add @pokusew/pcsclite

Example

👉 If you'd prefer an easy to use high level API for detecting / reading and writing NFC tags and cards, take a look at nfc-pcsc.

1const pcsclite = require('@pokusew/pcsclite');
2
3const pcsc = pcsclite();
4
5pcsc.on('reader', (reader) => {
6
7    console.log('New reader detected', reader.name);
8
9    reader.on('error', err => {
10        console.log('Error(', reader.name, '):', err.message);
11    });
12
13    reader.on('status', (status) => {
14
15        console.log('Status(', reader.name, '):', status);
16
17        // check what has changed
18        const changes = reader.state ^ status.state;
19
20        if (!changes) {
21            return;
22        }
23
24        if ((changes & reader.SCARD_STATE_EMPTY) && (status.state & reader.SCARD_STATE_EMPTY)) {
25
26            console.log("card removed");
27
28            reader.disconnect(reader.SCARD_LEAVE_CARD, err => {
29
30                if (err) {
31                    console.log(err);
32                    return;
33                }
34
35                console.log('Disconnected');
36
37            });
38
39        }
40        else if ((changes & reader.SCARD_STATE_PRESENT) && (status.state & reader.SCARD_STATE_PRESENT)) {
41
42            console.log("card inserted");
43
44            reader.connect({ share_mode: reader.SCARD_SHARE_SHARED }, (err, protocol) => {
45
46                if (err) {
47                    console.log(err);
48                    return;
49                }
50
51                console.log('Protocol(', reader.name, '):', protocol);
52
53                reader.transmit(Buffer.from([0x00, 0xB0, 0x00, 0x00, 0x20]), 40, protocol, (err, data) => {
54
55                    if (err) {
56                        console.log(err);
57                        return;
58                    }
59
60                    console.log('Data received', data);
61                    reader.close();
62                    pcsc.close();
63
64                });
65
66            });
67
68        }
69
70    });
71
72    reader.on('end', () => {
73        console.log('Reader', reader.name, 'removed');
74    });
75
76});
77
78pcsc.on('error', err => {
79    console.log('PCSC error', err.message);
80});

Behavior on different OS

TODO document

API

Class: PCSCLite

The PCSCLite object is an EventEmitter that notifies the existence of Card Readers.

Event: error

• err Error Object. The error.

Event: reader

• reader CardReader. A CardReader object associated to the card reader detected

Emitted whenever a new card reader is detected.

pcsclite.close()

It frees the resources associated with this PCSCLite instance. At a low level it calls SCardCancel so it stops watching for new readers.

pcsclite.readers

An object containing all detected readers by name. Updated as readers are attached and removed.

Class: CardReader

The CardReader object is an EventEmitter that allows to manipulate a card reader.

Event: error

• err Error Object. The error.

Event: end

Emitted when the card reader has been removed.

Event: status

• status Object.
  • state The current status of the card reader as returned by SCardGetStatusChange
  • atr ATR of the card inserted (if any)

Emitted whenever the status of the reader changes.

reader.connect([options], callback)

• options Object Optional
  • share_mode Number Shared mode. Defaults to SCARD_SHARE_EXCLUSIVE
  • protocol Number Preferred protocol. Defaults to SCARD_PROTOCOL_T0 | SCARD_PROTOCOL_T1
• callback Function called when connection operation ends
  • error Error
  • protocol Number Established protocol to this connection.

Wrapper around SCardConnect. Establishes a connection to the reader.

reader.disconnect(disposition, callback)

• disposition Number. Reader function to execute. Defaults to SCARD_UNPOWER_CARD
• callback Function called when disconnection operation ends
  • error Error

Wrapper around SCardDisconnect. Terminates a connection to the reader.

reader.transmit(input, res_len, protocol, callback)

• input Buffer input data to be transmitted
• res_len Number. Max. expected length of the response
• protocol Number. Protocol to be used in the transmission
• callback Function called when transmit operation ends
  • error Error
  • output Buffer

Wrapper around SCardTransmit. Sends an APDU to the smart card contained in the reader connected to.

reader.control(input, control_code, res_len, callback)

• input Buffer input data to be transmitted
• control_code Number. Control code for the operation
• res_len Number. Max. expected length of the response
• callback Function called when control operation ends
  • error Error
  • output Buffer

Wrapper around SCardControl. Sends a command directly to the IFD Handler (reader driver) to be processed by the reader.

reader.close()

It frees the resources associated with this CardReader instance. At a low level it calls SCardCancel so it stops watching for the reader status changes.

FAQ

Can I use this library in my Electron app?

Yes, you can! It works well.

But please read carefully Using Native Node Modules guide in Electron documentation to fully understand the problematic.

Note, that because of Node Native Modules, you must build your app on target platform (you must run Windows build on Windows machine, etc.).
You can use CI/CD server to build your app for certain platforms.
For Windows, I recommend you to use AppVeyor.
For macOS and Linux build, there are plenty of services to choose from, for example CircleCI, Travis CI CodeShip.

Are prebuilt binaries provided?

No, because it brings more problems than it solves. The C++ code (Node Native Modules, C++ Addons) is built automatically during installation (using node-gyp).

That means that cross-compilation is not possible by default. If you want to use this library in your Electron or NW.js, see Can I use this library in my Electron app?.

Disabling drivers to make pcsclite working on Linux

TODO document

in the meantime see #10

Which Node.js versions are supported?

@pokusew/pcsclite officially supports the following Node.js versions: 8.x, 9.x, 10.x, 11.x, 12.x, 13.x.

License

ISC