Abtract class that gives a high-level access to SpringCore devices. Child classes implements the direct commununication layer, depending on how the device is connected to the computer. More...

Inheritance diagram for SpringCard.SpringCore.Direct.DirectDevice:

Classes
class	AtCryptoI
	Implementation of the AT_CRYPTO class (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/AT_CRYPTO_class/) More...

class	Configuration
	Configuration registers (registers 0x0200 to 0x02FF) More...

class	Constants
	Registers storing the constants (registers 0x0100 to 0x01FF) More...

class	ControlI
	Implementation of the CONTROL class (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/) More...

class	DeviceEvent
	This class represents a processed event. More...

class	DFUI
	Implementation of the DFU class (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/DFU_class) More...

class	ExchangeI
	Communication interface. More...

class	ExchangeOptions
	Set of optional parameters for the Exchange methods. More...

class	GetData
	GET_DATA instruction (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Queries/GET_DATA) More...

class	HceEvent

class	HCEI
	Implementation of the HCE class. More...

class	IncomingEvent
	This class represents a raw event coming from a device. More...

class	ProtocolI
	Implementation of the PROTOCOL class (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/PROTOCOL_class/) More...

class	ReaderEvent

class	SamAvI
	Implementation of the SAM_AV class (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/SAM_AV_class/) More...

class	Statistics
	Statistics (registers 0x0400 to 0x04FF) More...

class	Templates
	Smart Reader Templates (registers 0x0300 to 0x03FF) More...

Public Types
enum	ListMode { ListMode.None = 0x0000, ListMode.Companion = 0x0001, ListMode.UsbDirect = 0x0010, ListMode.BleDirect = 0x0020, ListMode.Direct = 0x00F0, ListMode.Pcsc = 0x0100, ListMode.PcscAll = 0x0300 }
	How to list the devices? More...

enum	CLA : byte { CLA.Protocol = 0x00, CLA.HCE = 0x57, CLA.Control = 0x58, CLA.AtCrypto = 0x59, CLA.NxpSam = 0x5A, CLA.RDR = 0x5B, CLA.I2C = 0x5C, CLA.DFU = 0x5D, CLA.Echo = 0x5E }
	CLAsses uses for direct communication with a SpringCore device (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/List_of_CLAsses) More...

enum	KeySelect : byte { KeySelect.HostCommUserKey = 0, KeySelect.HostCommAdminKey = 1 }
	Authentication mode. More...

Public Member Functions
abstract bool	Open ()
	Open a connection to the device. More...

abstract void	Close ()
	Close the connection with the device. More...

abstract void	Release ()
	Release the device but keep the connection open. More...

abstract bool	Active ()
	Is the connection open and not released? More...

virtual void	Dispose ()
	Dispose of the device object. More...

abstract bool	Exchange (byte cla, byte[] send, out byte[] recv, ExchangeOptions options)
	Send a command to the device (and wait for its response). More...

abstract bool	Exchange (byte cla, byte cmd, byte[] send_data, out byte sta, out byte[] out_data, ExchangeOptions options)
	Send a command to the device (and wait for its response). More...

bool	Exchange (byte cla, byte[] send, out byte[] recv)
	Send a command to the device (and wait for its response). More...

bool	Exchange (CLA cla, byte[] send, out byte[] recv, ExchangeOptions options)
	Send a command to the device (and wait for its response). More...

bool	Exchange (CLA cla, byte[] send, out byte[] recv)
	Send a command to the device (and wait for its response). More...

bool	Exchange (byte cla, byte[] send, ExchangeOptions options)
	Send a command to the device (and wait for its response, but the response is discarded). More...

bool	Exchange (byte cla, byte[] send)
	Send a command to the device (and wait for its response, but the response is discarded). More...

bool	Exchange (CLA cla, byte[] send, ExchangeOptions options)
	Send a command to the device (and wait for its response, but the response is discarded). More...

bool	Exchange (CLA cla, byte[] send)
	Send a command to the device (and wait for its response, but the response is discarded). More...

bool	Exchange (CLA cla, byte cmd, byte[] send_data, out byte sta, out byte[] out_data, ExchangeOptions options)
	Send a command to the device (and wait for its response). More...

bool	Exchange (CLA cla, byte cmd, byte[] send_data, out byte sta, out byte[] out_data)
	Send a command to the device (and wait for its response). More...

bool	Exchange (byte cla, byte cmd, byte[] send_data, ExchangeOptions options)
	Send a command to the device (and wait for its response, but the response is discarded). More...

bool	Exchange (byte cla, byte cmd, byte[] send_data)
	Send a command to the device (and wait for its response, but the response is discarded). More...

bool	Exchange (CLA cla, byte cmd, byte[] send_data, ExchangeOptions options)
	Send a command to the device (and wait for its response, but the response is discarded). More...

bool	Exchange (CLA cla, byte cmd, byte[] send_data)
	Send a command to the device (and wait for its response, but the response is discarded). More...

bool	Exchange (byte cla, byte cmd, byte[] send_data, out byte[] recv_data, ExchangeOptions options)
	Send a command to the device (and wait for its response). More...

bool	Exchange (byte cla, byte cmd, byte[] send_data, out byte[] recv_data)
	Send a command to the device (and wait for its response). More...

bool	Exchange (CLA cla, byte cmd, byte[] send_data, out byte[] recv_data, ExchangeOptions options)
	Send a command to the device (and wait for its response). More...

bool	Exchange (CLA cla, byte cmd, byte[] send_data, out byte[] recv_data)
	Send a command to the device (and wait for its response). More...

bool	Ping ()
	Ping the device to verify that the connection stays active. More...

virtual string	GetVendorName ()
	Get the device's Vendor Name. More...

virtual string	GetProductName ()
	Get the device's Product Name. More...

virtual string	GetSerialNumber ()
	Get the device's Serial Number. More...

virtual string	GetPnpId ()
	Get the device's Plug'N'Play ID. More...

virtual string	GetVersion ()
	Get the device's Firmware Version. More...

virtual string	GetRevision ()
	Get the device's Firmware Revision. More...

virtual string	GetBuildUser ()
	Get the user that has built the device's Firmware. More...

virtual string	GetBuildDateTime ()
	Get the date and time of building the device's Firmware. More...

virtual string	GetFirmwareName ()
	Get the name of the device's Firmware. More...

virtual string	GetUniqueId ()
	Get the device's Unique ID. More...

virtual string	GetConfigurationId ()
	Get the GUID of the configuration. More...

virtual string	GetHardwareReference ()
	Get the device's Hardware Reference. More...

virtual string	GetHardwareCharacteristics ()
	Get the device's Hardware Characteristics. More...

virtual string	GetOriginalVendorName ()
	Get the device's original Vendor Name. More...

virtual string	GetOriginalProductName ()
	Get the device's original Product Name. More...

virtual string	GetDetectedProductVariant ()
	Get the device's Product Variant. More...

bool	AuthenticateAes (KeySelect keySelect, byte[] keyValue)
	Get authenticated onto the SpringCore device (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/Secure_Communication) More...

bool	ChangeKeyAes (KeySelect keySelect, byte[] keyValue)
	Change a key (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/PROTOCOL_class/CHANGE_KEY) More...

bool	ResetAuthentication ()
	Clear the authenticate state (forget the session keys) More...

bool	AuthenticateFactory (string privateKeyFile=null)

Static Public Member Functions
static List< string >	GetList (ListMode listMode)
	List the available devices. More...

static DirectDevice	CreateNoDevice ()
	Instantiate a dummy device (for test only). More...

static DirectDevice	Create (string devicePath, BlockingCollection< DirectDevice.IncomingEvent > eventQueue=null)
	Instantiate a device, given a devicePath returned by GetList. More...

static DirectDevice	Create (ListMode listMode, int deviceIndex, BlockingCollection< DirectDevice.IncomingEvent > eventQueue=null)
	Instantiate a device, given an (assumed) index in the list of devices. More...

static DirectDevice	Create (List< string > devicePaths, int deviceIndex, BlockingCollection< DirectDevice.IncomingEvent > eventQueue=null)
	Instantiate a device, given an index and the list of devices. More...

static byte[]	CreateFactoryChallengeResponse (string privateKeyFile, byte[] challenge)
	Create a signature for the challenge, using the specified private key file (.pem format) More...

static byte[]	CreateFactoryChallengeResponse (byte[] challenge)
	Create a signature for the challenge, using the SpringCoreAuthenticateFactory.private.pem private key (if present in the execution path) More...

static byte[]	CreateSignature (AsymmetricCipherKeyPair privateKey, byte[] message)
	Create a signature, using the SpringCoreAuthenticitySeal.private.pem private key (if present in the execution path) More...

static bool	IsSealValid (string publicKeyFile, byte[] subject, byte[] seal)
	Verify that the device's seal is genuine, using the specified public key file (.pem format) More...

static bool	IsSealValid (byte[] subject, byte[] seal)
	Verify that the device's seal is genuine, using the SpringCoreAuthenticitySeal.pem public key (if present in the execution path) More...

static byte[]	CreateSeal (string privateKeyFile, byte[] subject)
	Create a seal for the device, using the specified private key file (.pem format) More...

static byte[]	CreateSeal (byte[] subject)
	Create a seal for the device, using the SpringCoreAuthenticitySeal.private.pem private key (if present in the execution path) More...

Public Attributes
ControlI	Control
	Control interface. More...

AtCryptoI	AtCrypto
	Crypto Companion interface. More...

SamAvI	SamAv
	Secure Element interface. More...

HCEI	Hce
	HCE interface. More...

DFUI	Dfu
	DFU interface. More...

Static Public Attributes
static bool	UseLogger = false
	Forward debug information to underlying logger library? More...

const uint	DefaultDeviceTimeout = 60000
	Default timeout when communicating with the device. More...

const string	AuthenticySealPublicPemFile = @"SpringCoreAuthenticitySeal.pem"
	Name of the public key file (.pem format) More...

const string	AuthenticySealPrivatePemFile = @"SpringCoreAuthenticitySeal.private.pem"
	Name of the private key file (.pem format) - for factory only. More...

Protected Member Functions
void	Prepare ()

Protected Attributes
string	deviceId

BlockingCollection< DirectDevice.IncomingEvent >	eventQueue

Detailed Description

Abtract class that gives a high-level access to SpringCore devices. Child classes implements the direct commununication layer, depending on how the device is connected to the computer.

Member Enumeration Documentation

◆ CLA

enum SpringCard.SpringCore.Direct.DirectDevice.CLA : byte

strong

CLAsses uses for direct communication with a SpringCore device (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/List_of_CLAsses)

Enumerator
Protocol	PROTOCOL class (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/PROTOCOL_class/)
HCE	HCE class
Control	CONTROL class (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/)
AtCrypto	CRYPTO_COMPANION class (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CRYPTO_COMPANION_class/)
NxpSam	SECURE_ELEMENT class (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/SECURE_ELEMENT_class/)
RDR	READER class (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/READER_class)
I2C	I2C class
DFU	DFU class (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/DFU_class)
Echo	ECHO class (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/ECHO_class)

◆ KeySelect

enum SpringCard.SpringCore.Direct.DirectDevice.KeySelect : byte

strong

Authentication mode.

Enumerator
HostCommUserKey	User key
HostCommAdminKey	Admin key

◆ ListMode

enum SpringCard.SpringCore.Direct.DirectDevice.ListMode

strong

How to list the devices?

Enumerator
None	Dummy value, will not return anything
Companion	List devices available through the SpringCard Companion REST service
UsbDirect	List devices connected through USB Direct
BleDirect	List devices connected through BLE Direct
Direct	List all Direct devices
Pcsc	List devices connected through PC/SC, only if their Vendor Name is SpringCard
PcscAll	List devices connected through PC/SC, even if their Vendor Name is not SpringCard

Member Function Documentation

◆ Active()

abstract bool SpringCard.SpringCore.Direct.DirectDevice.Active ( )

pure virtual

Is the connection open and not released?

Implemented in SpringCard.SpringCore.Direct.Usb.UsbDirectDevice, SpringCard.SpringCore.Direct.PCSC.SCardDirectDevice, SpringCard.SpringCore.Direct.Ble.BleDirectDevice, and SpringCard.SpringCore.Direct.CompanionDirectDevice.

◆ AuthenticateAes()

bool SpringCard.SpringCore.Direct.DirectDevice.AuthenticateAes	(	KeySelect	keySelect,
		byte[]	keyValue
	)

Get authenticated onto the SpringCore device (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/Secure_Communication)

◆ ChangeKeyAes()

bool SpringCard.SpringCore.Direct.DirectDevice.ChangeKeyAes	(	KeySelect	keySelect,
		byte[]	keyValue
	)

Change a key (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/PROTOCOL_class/CHANGE_KEY)

◆ Close()

abstract void SpringCard.SpringCore.Direct.DirectDevice.Close ( )

pure virtual

Close the connection with the device.

Implemented in SpringCard.SpringCore.Direct.Usb.UsbDirectDevice, SpringCard.SpringCore.Direct.PCSC.SCardDirectDevice, SpringCard.SpringCore.Direct.Ble.BleDirectDevice, and SpringCard.SpringCore.Direct.CompanionDirectDevice.

◆ Create() [1/3]

static DirectDevice SpringCard.SpringCore.Direct.DirectDevice.Create	(	List< string >	devicePaths,
		int	deviceIndex,
		BlockingCollection< DirectDevice.IncomingEvent >	eventQueue = `null`
	)

static

Instantiate a device, given an index and the list of devices.

◆ Create() [2/3]

static DirectDevice SpringCard.SpringCore.Direct.DirectDevice.Create	(	ListMode	listMode,
		int	deviceIndex,
		BlockingCollection< DirectDevice.IncomingEvent >	eventQueue = `null`
	)

static

Instantiate a device, given an (assumed) index in the list of devices.

◆ Create() [3/3]

static DirectDevice SpringCard.SpringCore.Direct.DirectDevice.Create	(	string	devicePath,
		BlockingCollection< DirectDevice.IncomingEvent >	eventQueue = `null`
	)

static

Instantiate a device, given a devicePath returned by GetList.

◆ CreateFactoryChallengeResponse() [1/2]

static byte [] SpringCard.SpringCore.Direct.DirectDevice.CreateFactoryChallengeResponse ( byte[] challenge )

static

Create a signature for the challenge, using the SpringCoreAuthenticateFactory.private.pem private key (if present in the execution path)

◆ CreateFactoryChallengeResponse() [2/2]

static byte [] SpringCard.SpringCore.Direct.DirectDevice.CreateFactoryChallengeResponse	(	string	privateKeyFile,
		byte[]	challenge
	)

static

Create a signature for the challenge, using the specified private key file (.pem format)

◆ CreateNoDevice()

static DirectDevice SpringCard.SpringCore.Direct.DirectDevice.CreateNoDevice ( )

static

Instantiate a dummy device (for test only).

◆ CreateSeal() [1/2]

static byte [] SpringCard.SpringCore.Direct.DirectDevice.CreateSeal ( byte[] subject )

static

Create a seal for the device, using the SpringCoreAuthenticitySeal.private.pem private key (if present in the execution path)

◆ CreateSeal() [2/2]

static byte [] SpringCard.SpringCore.Direct.DirectDevice.CreateSeal	(	string	privateKeyFile,
		byte[]	subject
	)

static

Create a seal for the device, using the specified private key file (.pem format)

◆ CreateSignature()

static byte [] SpringCard.SpringCore.Direct.DirectDevice.CreateSignature	(	AsymmetricCipherKeyPair	privateKey,
		byte[]	message
	)

static

Create a signature, using the SpringCoreAuthenticitySeal.private.pem private key (if present in the execution path)

◆ Dispose()

virtual void SpringCard.SpringCore.Direct.DirectDevice.Dispose ( )

virtual

Dispose of the device object.

Reimplemented in SpringCard.SpringCore.Direct.Ble.BleDirectDevice, SpringCard.SpringCore.Direct.PCSC.SCardDirectDevice, and SpringCard.SpringCore.Direct.Usb.UsbDirectDevice.

◆ Exchange() [1/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	byte	cla,
		byte	cmd,
		byte[]	send_data
	)

Send a command to the device (and wait for its response, but the response is discarded).

◆ Exchange() [2/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	byte	cla,
		byte	cmd,
		byte[]	send_data,
		ExchangeOptions	options
	)

Send a command to the device (and wait for its response, but the response is discarded).

◆ Exchange() [3/19]

abstract bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	byte	cla,
		byte	cmd,
		byte[]	send_data,
		out byte	sta,
		out byte[]	out_data,
		ExchangeOptions	options
	)

pure virtual

Send a command to the device (and wait for its response).

Implemented in SpringCard.SpringCore.Direct.Usb.UsbDirectDevice, SpringCard.SpringCore.Direct.PCSC.SCardDirectDevice, SpringCard.SpringCore.Direct.Ble.BleDirectDevice, and SpringCard.SpringCore.Direct.CompanionDirectDevice.

◆ Exchange() [4/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	byte	cla,
		byte	cmd,
		byte[]	send_data,
		out byte[]	recv_data
	)

Send a command to the device (and wait for its response).

◆ Exchange() [5/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	byte	cla,
		byte	cmd,
		byte[]	send_data,
		out byte[]	recv_data,
		ExchangeOptions	options
	)

Send a command to the device (and wait for its response).

◆ Exchange() [6/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	byte	cla,
		byte[]	send
	)

Send a command to the device (and wait for its response, but the response is discarded).

◆ Exchange() [7/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	byte	cla,
		byte[]	send,
		ExchangeOptions	options
	)

Send a command to the device (and wait for its response, but the response is discarded).

◆ Exchange() [8/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	byte	cla,
		byte[]	send,
		out byte[]	recv
	)

Send a command to the device (and wait for its response).

◆ Exchange() [9/19]

abstract bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	byte	cla,
		byte[]	send,
		out byte[]	recv,
		ExchangeOptions	options
	)

pure virtual

Send a command to the device (and wait for its response).

Implemented in SpringCard.SpringCore.Direct.Usb.UsbDirectDevice, SpringCard.SpringCore.Direct.PCSC.SCardDirectDevice, SpringCard.SpringCore.Direct.CompanionDirectDevice, and SpringCard.SpringCore.Direct.Ble.BleDirectDevice.

◆ Exchange() [10/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	CLA	cla,
		byte	cmd,
		byte[]	send_data
	)

Send a command to the device (and wait for its response, but the response is discarded).

◆ Exchange() [11/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	CLA	cla,
		byte	cmd,
		byte[]	send_data,
		ExchangeOptions	options
	)

Send a command to the device (and wait for its response, but the response is discarded).

◆ Exchange() [12/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	CLA	cla,
		byte	cmd,
		byte[]	send_data,
		out byte	sta,
		out byte[]	out_data
	)

Send a command to the device (and wait for its response).

◆ Exchange() [13/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	CLA	cla,
		byte	cmd,
		byte[]	send_data,
		out byte	sta,
		out byte[]	out_data,
		ExchangeOptions	options
	)

Send a command to the device (and wait for its response).

◆ Exchange() [14/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	CLA	cla,
		byte	cmd,
		byte[]	send_data,
		out byte[]	recv_data
	)

Send a command to the device (and wait for its response).

◆ Exchange() [15/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	CLA	cla,
		byte	cmd,
		byte[]	send_data,
		out byte[]	recv_data,
		ExchangeOptions	options
	)

Send a command to the device (and wait for its response).

◆ Exchange() [16/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	CLA	cla,
		byte[]	send
	)

Send a command to the device (and wait for its response, but the response is discarded).

◆ Exchange() [17/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	CLA	cla,
		byte[]	send,
		ExchangeOptions	options
	)

Send a command to the device (and wait for its response, but the response is discarded).

◆ Exchange() [18/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	CLA	cla,
		byte[]	send,
		out byte[]	recv
	)

Send a command to the device (and wait for its response).

◆ Exchange() [19/19]

bool SpringCard.SpringCore.Direct.DirectDevice.Exchange	(	CLA	cla,
		byte[]	send,
		out byte[]	recv,
		ExchangeOptions	options
	)

Send a command to the device (and wait for its response).

◆ GetBuildDateTime()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetBuildDateTime ( )

virtual

Get the date and time of building the device's Firmware.

◆ GetBuildUser()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetBuildUser ( )

virtual

Get the user that has built the device's Firmware.

◆ GetConfigurationId()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetConfigurationId ( )

virtual

Get the GUID of the configuration.

◆ GetDetectedProductVariant()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetDetectedProductVariant ( )

virtual

Get the device's Product Variant.

◆ GetFirmwareName()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetFirmwareName ( )

virtual

Get the name of the device's Firmware.

◆ GetHardwareCharacteristics()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetHardwareCharacteristics ( )

virtual

Get the device's Hardware Characteristics.

◆ GetHardwareReference()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetHardwareReference ( )

virtual

Get the device's Hardware Reference.

◆ GetList()

static List<string> SpringCard.SpringCore.Direct.DirectDevice.GetList ( ListMode listMode )

static

List the available devices.

◆ GetOriginalProductName()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetOriginalProductName ( )

virtual

Get the device's original Product Name.

◆ GetOriginalVendorName()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetOriginalVendorName ( )

virtual

Get the device's original Vendor Name.

◆ GetPnpId()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetPnpId ( )

virtual

Get the device's Plug'N'Play ID.

Reimplemented in SpringCard.SpringCore.Direct.Ble.BleDirectDevice.

◆ GetProductName()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetProductName ( )

virtual

Get the device's Product Name.

Reimplemented in SpringCard.SpringCore.Direct.Ble.BleDirectDevice.

◆ GetRevision()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetRevision ( )

virtual

Get the device's Firmware Revision.

◆ GetSerialNumber()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetSerialNumber ( )

virtual

Get the device's Serial Number.

Reimplemented in SpringCard.SpringCore.Direct.Ble.BleDirectDevice.

◆ GetUniqueId()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetUniqueId ( )

virtual

Get the device's Unique ID.

◆ GetVendorName()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetVendorName ( )

virtual

Get the device's Vendor Name.

Reimplemented in SpringCard.SpringCore.Direct.Ble.BleDirectDevice.

◆ GetVersion()

virtual string SpringCard.SpringCore.Direct.DirectDevice.GetVersion ( )

virtual

Get the device's Firmware Version.

◆ IsSealValid() [1/2]

static bool SpringCard.SpringCore.Direct.DirectDevice.IsSealValid	(	byte[]	subject,
		byte[]	seal
	)

static

Verify that the device's seal is genuine, using the SpringCoreAuthenticitySeal.pem public key (if present in the execution path)

◆ IsSealValid() [2/2]

static bool SpringCard.SpringCore.Direct.DirectDevice.IsSealValid	(	string	publicKeyFile,
		byte[]	subject,
		byte[]	seal
	)

static

Verify that the device's seal is genuine, using the specified public key file (.pem format)

◆ Open()

abstract bool SpringCard.SpringCore.Direct.DirectDevice.Open ( )

pure virtual

Open a connection to the device.

Implemented in SpringCard.SpringCore.Direct.Ble.BleDirectDevice, SpringCard.SpringCore.Direct.CompanionDirectDevice, SpringCard.SpringCore.Direct.PCSC.SCardDirectDevice, and SpringCard.SpringCore.Direct.Usb.UsbDirectDevice.

◆ Ping()

bool SpringCard.SpringCore.Direct.DirectDevice.Ping ( )

Ping the device to verify that the connection stays active.

◆ Release()

abstract void SpringCard.SpringCore.Direct.DirectDevice.Release ( )

pure virtual

Release the device but keep the connection open.

Implemented in SpringCard.SpringCore.Direct.Usb.UsbDirectDevice, SpringCard.SpringCore.Direct.PCSC.SCardDirectDevice, SpringCard.SpringCore.Direct.Ble.BleDirectDevice, and SpringCard.SpringCore.Direct.CompanionDirectDevice.

◆ ResetAuthentication()

bool SpringCard.SpringCore.Direct.DirectDevice.ResetAuthentication ( )

Clear the authenticate state (forget the session keys)

Member Data Documentation

◆ AtCrypto

AtCryptoI SpringCard.SpringCore.Direct.DirectDevice.AtCrypto

Crypto Companion interface.

◆ AuthenticySealPrivatePemFile

const string SpringCard.SpringCore.Direct.DirectDevice.AuthenticySealPrivatePemFile = @"SpringCoreAuthenticitySeal.private.pem"

static

Name of the private key file (.pem format) - for factory only.

◆ AuthenticySealPublicPemFile

const string SpringCard.SpringCore.Direct.DirectDevice.AuthenticySealPublicPemFile = @"SpringCoreAuthenticitySeal.pem"

static

Name of the public key file (.pem format)

◆ Control

ControlI SpringCard.SpringCore.Direct.DirectDevice.Control

Control interface.

◆ DefaultDeviceTimeout

const uint SpringCard.SpringCore.Direct.DirectDevice.DefaultDeviceTimeout = 60000

static

Default timeout when communicating with the device.

◆ Dfu

DFUI SpringCard.SpringCore.Direct.DirectDevice.Dfu

DFU interface.

◆ Hce

HCEI SpringCard.SpringCore.Direct.DirectDevice.Hce

HCE interface.

◆ SamAv

SamAvI SpringCard.SpringCore.Direct.DirectDevice.SamAv

Secure Element interface.

◆ UseLogger

bool SpringCard.SpringCore.Direct.DirectDevice.UseLogger = false

static

Forward debug information to underlying logger library?

The documentation for this class was generated from the following files:

D:/dev/companion/springcard.software.companion-service/src/common/lib-cs/springcore/DirectDevice.cs
D:/dev/companion/springcard.software.companion-service/src/common/lib-cs/springcore/DirectDeviceEvents.cs
D:/dev/companion/springcard.software.companion-service/src/common/lib-cs/springcore/DirectDeviceFactory.cs
D:/dev/companion/springcard.software.companion-service/src/common/lib-cs/springcore/DirectDeviceGenuine.cs
D:/dev/companion/springcard.software.companion-service/src/common/lib-cs/springcore/DirectDeviceSecure.cs

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ CLA

◆ KeySelect

◆ ListMode

Member Function Documentation

◆ Active()

◆ AuthenticateAes()

◆ ChangeKeyAes()

◆ Close()

◆ Create() [1/3]

◆ Create() [2/3]

◆ Create() [3/3]

◆ CreateFactoryChallengeResponse() [1/2]

◆ CreateFactoryChallengeResponse() [2/2]

◆ CreateNoDevice()

◆ CreateSeal() [1/2]

◆ CreateSeal() [2/2]

◆ CreateSignature()

◆ Dispose()

◆ Exchange() [1/19]

◆ Exchange() [2/19]

◆ Exchange() [3/19]

◆ Exchange() [4/19]

◆ Exchange() [5/19]

◆ Exchange() [6/19]

◆ Exchange() [7/19]

◆ Exchange() [8/19]

◆ Exchange() [9/19]

◆ Exchange() [10/19]

◆ Exchange() [11/19]

◆ Exchange() [12/19]

◆ Exchange() [13/19]

◆ Exchange() [14/19]

◆ Exchange() [15/19]

◆ Exchange() [16/19]

◆ Exchange() [17/19]

◆ Exchange() [18/19]

◆ Exchange() [19/19]

◆ GetBuildDateTime()

◆ GetBuildUser()

◆ GetConfigurationId()

◆ GetDetectedProductVariant()

◆ GetFirmwareName()

◆ GetHardwareCharacteristics()

◆ GetHardwareReference()

◆ GetList()

◆ GetOriginalProductName()

◆ GetOriginalVendorName()

◆ GetPnpId()

◆ GetProductName()

◆ GetRevision()

◆ GetSerialNumber()

◆ GetUniqueId()

◆ GetVendorName()

◆ GetVersion()

◆ IsSealValid() [1/2]

◆ IsSealValid() [2/2]

◆ Open()

◆ Ping()

◆ Release()

◆ ResetAuthentication()

Member Data Documentation

◆ AtCrypto

◆ AuthenticySealPrivatePemFile

◆ AuthenticySealPublicPemFile

◆ Control

◆ DefaultDeviceTimeout

◆ Dfu

◆ Hce

◆ SamAv

◆ UseLogger