Module credentials.security_key
Use a physical security key to unlock an encrypted credential vault.
Typical flow:
1. findSecurityKeys() to show or select a connected key; 2. while the vault is unlocked, call addSecurityKeyUnlock(); 3. persist the returned VaultUnlockMethod; 4. later open the vault and call unlockWithSecurityKey().
Functions
| Name | Description |
|---|---|
addSecurityKeyUnlock(vault, keyId, access, method)
|
Add a connected security key as a way to unlock this vault. |
addSecurityKeyUnlock(vault, keyId, access, pin, method)
|
Add a security key when setup requires its PIN. |
findSecurityKeys(keys)
|
Find the security keys currently available to the application. |
getSecurityKeyCapabilities(keyId, capabilities)
|
Check which vault-unlock features one connected key offers. |
unlockWithSecurityKey(vault, keyId, method)
|
Unlock an opened vault with a connected security key. |
unlockWithSecurityKey(vault, keyId, method, pin)
|
Unlock a vault with a security key and PIN. |
Structs
| Name | Description |
|---|---|
SecurityKeyCapabilities
|
Features that can affect setup or the user experience for one security key. |
SecurityKeyInfo
|
One currently connected security key. |
Enums
| Name | Description |
|---|---|
SecurityKeyAccess
|
How the user should prove presence or identity when using the key. |