hwsecurity / de.cotech.hw / SecurityKeyManager /

SecurityKeyManager

open class SecurityKeyManager

The SecurityKeyManager is a singleton class for high-level management operations of security keys.

To use security keys in your App, you must first initialize it using init. This is usually done in onCreate.

Once initialized, this class will dispatch newly connected security keys to all currently registered listeners. Listeners can be registered with registerCallback.

public void onCreate() {
    super.onCreate();
    SecurityKeyManager securityKeyManager = SecurityKeyManager.getInstance();
    securityKeyManager.init(this);
}

A callback is registered together with a SecurityKeyConnectionMode, which establishes a connection to a particular type of Security Token, such as FIDO2, FIDO, PIV, or OpenPGP. Implementations for different SecurityKeyConnectionModes are shipped as artifacts, such as hwsecurity-fido2, hwsecurity-fido, hwsecurity-piv, and hwsecurity-openpgp. Apps will typically use only a single type of Security Key.

To receive callbacks in an Activity, register for a callback bound to the Activity’s lifecycle:

public void onCreate() {
    super.onResume();
    FidoSecurityKeyConnectionMode connectionMode = new FidoSecurityKeyConnectionMode();
    SecurityKeyManager.getInstance().registerCallback(connectionMode, this, this);
}
public void onSecurityKeyDiscovered(FidoSecurityKey securityKey) {
    // perform operations on FidoSecurityKey
}

Advanced applications that want to work with different applets on the same connected Security Key can do so using de.cotech.hw.raw.RawSecurityKeyConnectionMode.

Functions