hwsecurity / de.cotech.hw / SecurityKey /

SecurityKey

abstract class SecurityKey

An abstract connected Security Key. Concrete instances of this class, such as FidoSecurityKey, PivSecurityKey, or OpenPgpSecurityKey, offer methods to interact with the connected Security Key and applet.

See also

Name Summary
de.cotech.hw.SecurityKeyCallback
de.cotech.hw.SecurityKeyManager SecurityKeyManager#registerCallback

Constructors

Name Summary
SecurityKey open fun SecurityKey(config: SecurityKeyManagerConfig, transport: Transport)

Functions

Name Summary
checkConnectionOrThrow

open fun checkConnectionOrThrow()

This method checks if communication with the security key is still available by sending a no-op ping command.

isPersistentlyConnected

open fun isPersistentlyConnected(): Boolean

true if the underlying transport is persistently connected.

isTransportNfc

open fun isTransportNfc(): Boolean

true if the underlying transport is NFC.

isTransportUsb

open fun isTransportUsb(): Boolean

true if the underlying transport is USB.

release

open fun release()

Releases the Security Key as well as the underlying transport.

Inheritors

Name
RawSecurityKey