View as markdown
Copy for LLM Open in ChatGPT Open in Claude Open in Perplexity

SmartCardEmulation

Experimental

Commands

SmartCardEmulation.enable

Enables the |SmartCardEmulation| domain.

SmartCardEmulation.disable

Disables the |SmartCardEmulation| domain.

SmartCardEmulation.reportEstablishContextResult

Reports the successful result of a |SCardEstablishContext| call.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaa1b8970169fd4883a6dc4a8f43f19b67
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardestablishcontext

Parameters
Name Type Description
requestId string
contextId integer

SmartCardEmulation.reportReleaseContextResult

Reports the successful result of a |SCardReleaseContext| call.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga6aabcba7744c5c9419fdd6404f73a934
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardreleasecontext

Parameters
Name Type Description
requestId string

SmartCardEmulation.reportListReadersResult

Reports the successful result of a |SCardListReaders| call.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga93b07815789b3cf2629d439ecf20f0d9
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardlistreadersa

Parameters
Name Type Description
requestId string
readers array<string>

SmartCardEmulation.reportGetStatusChangeResult

Reports the successful result of a |SCardGetStatusChange| call.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga33247d5d1257d59e55647c3bb717db24
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetstatuschangea

Parameters
Name Type Description
requestId string
readerStates array<ReaderStateOut>

SmartCardEmulation.reportBeginTransactionResult

Reports the result of a |SCardBeginTransaction| call.
On success, this creates a new transaction object.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaddb835dce01a0da1d6ca02d33ee7d861
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardbegintransaction

Parameters
Name Type Description
requestId string
handle integer

SmartCardEmulation.reportPlainResult

Reports the successful result of a call that returns only a result code.
Used for: |SCardCancel|, |SCardDisconnect|, |SCardSetAttrib|, |SCardEndTransaction|.

This maps to:
1. SCardCancel
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacbbc0c6d6c0cbbeb4f4debf6fbeeee6
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcancel

2. SCardDisconnect
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4be198045c73ec0deb79e66c0ca1738a
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scarddisconnect

3. SCardSetAttrib
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga060f0038a4ddfd5dd2b8fadf3c3a2e4f
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardsetattrib

4. SCardEndTransaction
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae8742473b404363e5c587f570d7e2f3b
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardendtransaction

Parameters
Name Type Description
requestId string

SmartCardEmulation.reportConnectResult

Reports the successful result of a |SCardConnect| call.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4e515829752e0a8dbc4d630696a8d6a5
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardconnecta

Parameters
Name Type Description
requestId string
handle integer
activeProtocol (optional) Protocol

SmartCardEmulation.reportDataResult

Reports the successful result of a call that sends back data on success.
Used for |SCardTransmit|, |SCardControl|, and |SCardGetAttrib|.

This maps to:
1. SCardTransmit
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga9a2d77242a271310269065e64633ab99
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardtransmit

2. SCardControl
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gac3454d4657110fd7f753b2d3d8f4e32f
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcontrol

3. SCardGetAttrib
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacfec51917255b7a25b94c5104961602
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetattrib

Parameters
Name Type Description
requestId string
data binary

SmartCardEmulation.reportStatusResult

Reports the successful result of a |SCardStatus| call.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae49c3c894ad7ac12a5b896bde70d0382
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardstatusa

Parameters
Name Type Description
requestId string
readerName string
state ConnectionState
atr binary
protocol (optional) Protocol

SmartCardEmulation.reportError

Reports an error result for the given request.

Parameters
Name Type Description
requestId string
resultCode ResultCode

Events

SmartCardEmulation.establishContextRequested

Fired when |SCardEstablishContext| is called.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaa1b8970169fd4883a6dc4a8f43f19b67
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardestablishcontext

Parameters
Name Type Description
requestId string

SmartCardEmulation.releaseContextRequested

Fired when |SCardReleaseContext| is called.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga6aabcba7744c5c9419fdd6404f73a934
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardreleasecontext

Parameters
Name Type Description
requestId string
contextId integer

SmartCardEmulation.listReadersRequested

Fired when |SCardListReaders| is called.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga93b07815789b3cf2629d439ecf20f0d9
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardlistreadersa

Parameters
Name Type Description
requestId string
contextId integer

SmartCardEmulation.getStatusChangeRequested

Fired when |SCardGetStatusChange| is called. Timeout is specified in milliseconds.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga33247d5d1257d59e55647c3bb717db24
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetstatuschangea

Parameters
Name Type Description
requestId string
contextId integer
readerStates array<ReaderStateIn>
timeout (optional) integer in milliseconds, if absent, it means "infinite"

SmartCardEmulation.cancelRequested

Fired when |SCardCancel| is called.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacbbc0c6d6c0cbbeb4f4debf6fbeeee6
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcancel

Parameters
Name Type Description
requestId string
contextId integer

SmartCardEmulation.connectRequested

Fired when |SCardConnect| is called.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4e515829752e0a8dbc4d630696a8d6a5
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardconnecta

Parameters
Name Type Description
requestId string
contextId integer
reader string
shareMode ShareMode
preferredProtocols ProtocolSet

SmartCardEmulation.disconnectRequested

Fired when |SCardDisconnect| is called.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga4be198045c73ec0deb79e66c0ca1738a
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scarddisconnect

Parameters
Name Type Description
requestId string
handle integer
disposition Disposition

SmartCardEmulation.transmitRequested

Fired when |SCardTransmit| is called.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga9a2d77242a271310269065e64633ab99
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardtransmit

Parameters
Name Type Description
requestId string
handle integer
data binary
protocol (optional) Protocol

SmartCardEmulation.controlRequested

Fired when |SCardControl| is called.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gac3454d4657110fd7f753b2d3d8f4e32f
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardcontrol

Parameters
Name Type Description
requestId string
handle integer
controlCode integer
data binary

SmartCardEmulation.getAttribRequested

Fired when |SCardGetAttrib| is called.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaacfec51917255b7a25b94c5104961602
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardgetattrib

Parameters
Name Type Description
requestId string
handle integer
attribId integer

SmartCardEmulation.setAttribRequested

Fired when |SCardSetAttrib| is called.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#ga060f0038a4ddfd5dd2b8fadf3c3a2e4f
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardsetattrib

Parameters
Name Type Description
requestId string
handle integer
attribId integer
data binary

SmartCardEmulation.statusRequested

Fired when |SCardStatus| is called.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae49c3c894ad7ac12a5b896bde70d0382
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardstatusa

Parameters
Name Type Description
requestId string
handle integer

SmartCardEmulation.beginTransactionRequested

Fired when |SCardBeginTransaction| is called.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gaddb835dce01a0da1d6ca02d33ee7d861
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardbegintransaction

Parameters
Name Type Description
requestId string
handle integer

SmartCardEmulation.endTransactionRequested

Fired when |SCardEndTransaction| is called.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__API.html#gae8742473b404363e5c587f570d7e2f3b
Microsoft: https://learn.microsoft.com/en-us/windows/win32/api/winscard/nf-winscard-scardendtransaction

Parameters
Name Type Description
requestId string
handle integer
disposition Disposition

Types

ResultCode

(string)

Indicates the PC/SC error code.

This maps to:
PC/SC Lite: https://pcsclite.apdu.fr/api/group__ErrorCodes.html
Microsoft: https://learn.microsoft.com/en-us/windows/win32/secauthn/authentication-return-values

Allowed Values
  • success
  • removed-card
  • reset-card
  • unpowered-card
  • unresponsive-card
  • unsupported-card
  • reader-unavailable
  • sharing-violation
  • not-transacted
  • no-smartcard
  • proto-mismatch
  • system-cancelled
  • not-ready
  • cancelled
  • insufficient-buffer
  • invalid-handle
  • invalid-parameter
  • invalid-value
  • no-memory
  • timeout
  • unknown-reader
  • unsupported-feature
  • no-readers-available
  • service-stopped
  • no-service
  • comm-error
  • internal-error
  • server-too-busy
  • unexpected
  • shutdown
  • unknown-card
  • unknown

ShareMode

(string)

Maps to the |SCARD_SHARE_*| values.

Allowed Values
  • shared
  • exclusive
  • direct

Disposition

(string)

Indicates what the reader should do with the card.

Allowed Values
  • leave-card
  • reset-card
  • unpower-card
  • eject-card

ConnectionState

(string)

Maps to |SCARD_*| connection state values.

Allowed Values
  • absent
  • present
  • swallowed
  • powered
  • negotiable
  • specific

ReaderStateFlags

(object)

Maps to the |SCARD_STATE_*| flags.

Properties
Name Type Description
unaware (optional) boolean
ignore (optional) boolean
changed (optional) boolean
unknown (optional) boolean
unavailable (optional) boolean
empty (optional) boolean
present (optional) boolean
exclusive (optional) boolean
inuse (optional) boolean
mute (optional) boolean
unpowered (optional) boolean

ProtocolSet

(object)

Maps to the |SCARD_PROTOCOL_*| flags.

Properties
Name Type Description
t0 (optional) boolean
t1 (optional) boolean
raw (optional) boolean

Protocol

(string)

Maps to the |SCARD_PROTOCOL_*| values.

Allowed Values
  • t0
  • t1
  • raw

ReaderStateIn

(object)
Properties
Name Type Description
reader string
currentState ReaderStateFlags
currentInsertionCount integer

ReaderStateOut

(object)
Properties
Name Type Description
reader string
eventState ReaderStateFlags
eventCount integer
atr binary

Summary