switcloud-l2/io.switstack.switcloud.switcloudl2/IXsecCallback

IXsecCallback

interface IXsecCallback

Unified external security (xsec) callback interface.

One method prefix per moka module: rdr (reader, rng (random number generation), sred (sensitive data), hsm (CA public key store).

Every method has a default implementation, so an implementer only needs to override the methods it actually cares about:

A reader-only implementation (e.g. the "std" build, or a third-party DSEC integrator) typically overrides only rdrDetectCardInterface, rdrExchangeApdu and rdrActivate (and rdrCancelTagDetection if cancellation support is available).
A full security-module implementation (e.g. the "xsec" build) overrides every method, forwarding each one to its own security bridge.

Since

1.5.0

Inheritors

NoOpXsecCallback

Functions

open fun hsmFlushCaKeys()

Clears all CA public keys.

open fun hsmGetCaKey(inbound: ByteArray): ByteArray

Gets a CA public key modulus and exponent for a RID and CAPK index.

hsmGetCapkIndexPresenceStatus

open fun hsmGetCapkIndexPresenceStatus(inbound: ByteArray): Boolean

Checks CAPK index presence.

open fun hsmStoreCaKey(inbound: ByteArray)

Registers a CA public key for a RID.

abstract fun rdrActivate()

Activate contactless card (EMV Level 1).

rdrCancelTagDetection

open fun rdrCancelTagDetection()

Cancels an in-progress rdrDetectCardInterface call.

rdrDetectCardInterface

abstract fun rdrDetectCardInterface(supportedInterface: Int, timeout: Int): Int

Performs card detection (swipe, instert & tap) on all supported interfaces until timeout.

rdrDetectCollision

open fun rdrDetectCollision()

Detection potential contactless card collision (EMV Level 1).

rdrExchangeApdu

abstract fun rdrExchangeApdu(command: ByteArray): ByteArray

Sends an APDU command to the card and waits for a response.

rdrGetCardStatus

open fun rdrGetCardStatus(): Int

Returns the current card status.

rdrIsCardInserted

open fun rdrIsCardInserted(): Boolean

open fun rdrPowerOff()

Powers card off.

open fun rdrPowerOn(): Pair<Int, ByteArray?>

Powers card on.

open fun rdrRemove(holdTime: Int)

Performs contactless card removal (EMV Level 1).

rdrResetAntenna

open fun rdrResetAntenna()

Reset contactless card antenna (EMV Level 1).

rdrSwitchAntenna

open fun rdrSwitchAntenna(onOff: Boolean)

Switch antenna on or off.

open fun rngGetRandom(len: Int, range: Int): ByteArray

Retrieves a len bytes random with each byte in the range 0-range

sredComputeSsdSha

open fun sredComputeSsdSha(inbound: ByteArray): ByteArray

Compute SSD SHA.

sredExtractPanAndExpirationDate

open fun sredExtractPanAndExpirationDate(): ByteArray

Extract PAN and Expiration date.

sredGetDdFromTrack1Data

open fun sredGetDdFromTrack1Data(): ByteArray

Retrieves DD from Track1 data.

sredGetDdFromTrack2Data

open fun sredGetDdFromTrack2Data(): ByteArray

Retrieves DD from Track2 data.

open fun sredGetIccKey(inbound: ByteArray): ByteArray

ICC key request.

sredGetIssuerKey

open fun sredGetIssuerKey(inbound: ByteArray): ByteArray

Issuer key request.

sredSetSignedRecord

open fun sredSetSignedRecord(inbound: ByteArray)

Sets signed record.

sredStoreRrpInTrack2EquivalentData

open fun sredStoreRrpInTrack2EquivalentData(inbound: ByteArray): ByteArray

Stores the Relay Resistance Protocol (RRP) results into track 2 equivalent data (tag 57).

vcardGetApduResponse

open fun vcardGetApduResponse(inbound: ByteArray): ByteArray

Exchanges a C-APDU/R-APDU pair with the loaded virtual card script.

vcardGetCardInterface

open fun vcardGetCardInterface(): Int

Gets the interface the virtual card is currently presented on.

vcardGetCardStatus

open fun vcardGetCardStatus(): Int

Gets the current virtual card status.

open fun vcardLoad(inbound: ByteArray)

Loads a virtual card script.

open fun vcardPresent()

Presents the virtual card (consumes the next presentation tag in the loaded script).

open fun vcardRemove()

Removes the virtual card.

open fun vcardUnload()

Unloads the current virtual card script.