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?
take a look at nfc-pcsc which offers 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()
  • 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?
• License

Installation

In order to install the package you need to have installed in the system the pcsclite libraries.

In macOS and Windows you don't have to install anything.

For example, in Debian/Ubuntu:

apt-get install libpcsclite1 libpcsclite-dev

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

apt-get install pcscd

Once you have all needed libraries, you can install using npm:

npm install @pokusew/pcsclite --save

Example

constpcsclite=require('@pokusew/pcsclite');constpcsc=pcsclite();pcsc.on('reader',(reader)=>{console.log('New reader detected',reader.name);reader.on('error',err=>{console.log('Error(',reader.name,'):',err.message);});reader.on('status',(status)=>{console.log('Status(',reader.name,'):',status);// check what has changedconstchanges=reader.state^status.state;if(!changes){return;}// noinspection JSBitwiseOperatorUsageif((changes&reader.SCARD_STATE_EMPTY)&&(status.state&reader.SCARD_STATE_EMPTY)){console.log("card removed");reader.disconnect(reader.SCARD_LEAVE_CARD,err=>{if(err){console.log(err);return;}console.log('Disconnected');});return;}// noinspection JSBitwiseOperatorUsageif((changes&reader.SCARD_STATE_EMPTY)&&(status.state&reader.SCARD_STATE_EMPTY)){console.log("card inserted");reader.connect({share_mode: reader.SCARD_SHARE_SHARED},(err,protocol)=>{if(err){console.log(err);return;}console.log('Protocol(',reader.name,'):',protocol);reader.transmit(Buffer.from([0x00,0xB0,0x00,0x00,0x20]),40,protocol,(err,data)=>{if(err){console.log(err);return;}console.log('Data received',data);reader.close();pcsc.close();});});// noinspection UnnecessaryReturnStatementJSreturn;}});reader.on('end',()=>{console.log('Reader',reader.name,'removed');});});pcsc.on('error',err=>{console.log('PCSC error',err.message);});

Behavior on different OS

TODO document

API

Class: PCSCLite

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

Event: 'error'

• errError Object. The error.

Event: 'reader'

• readerCardReader. 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'

• errError Object. The error.

Event: 'end'

Emitted when the card reader has been removed.

Event: 'status'

• statusObject.
  • 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)

• optionsObject Optional
  • share_modeNumber Shared mode. Defaults to SCARD_SHARE_EXCLUSIVE
  • protocolNumber Preferred protocol. Defaults to SCARD_PROTOCOL_T0 | SCARD_PROTOCOL_T1
• callbackFunction called when connection operation ends
  • errorError
  • protocolNumber Established protocol to this connection.

Wrapper around SCardConnect. Establishes a connection to the reader.

reader.disconnect(disposition, callback)

• dispositionNumber. Reader function to execute. Defaults to SCARD_UNPOWER_CARD
• callbackFunction called when disconnection operation ends
  • errorError

Wrapper around SCardDisconnect. Terminates a connection to the reader.

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

• inputBuffer input data to be transmitted
• res_lenNumber. Max. expected length of the response
• protocolNumber. Protocol to be used in the transmission
• callbackFunction called when transmit operation ends
  • errorError
  • outputBuffer

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

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

• inputBuffer input data to be transmitted
• control_codeNumber. Control code for the operation
• res_lenNumber. Max. expected length of the response
• callbackFunction called when control operation ends
  • errorError
  • outputBuffer

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 CICodeShip.

License

ISC