Storage backend API. More...

#include <zephyr/authentication/fido2/fido2_storage.h>

Data Fields
int(*	init )(void)
	Initialize the storage backend.
int(*	store )(const struct fido2_credential *cred)
	Store a credential.
int(*	load )(const uint8_t cred_id, size_t cred_id_len, struct fido2_credential cred)
	Load a credential by ID.
int(*	remove )(const uint8_t cred_id, size_t cred_id_len, struct fido2_credential cred)
	Remove a credential by ID.
int(*	find_by_rp )(const uint8_t rp_id_hash[32], struct fido2_credential creds, size_t max_creds, size_t count)
	Find credentials by relying party ID hash.
int(*	enumerate_rps )(size_t offset, struct fido2_credential creds, size_t max_creds, size_t count)
	Enumerate unique Relying Party IDs from stored credentials.
int(*	iterate )(fido2_storage_iterate_cb_t cb, void *user_data)
	Iterate all stored credentials.
int(*	sign_count_increment )(const uint8_t cred_id, size_t cred_id_len, uint32_t new_count)
	Increment and return the signature counter.
int(*	update_user_info )(const uint8_t cred_id, size_t cred_id_len, const char user_name, const char *user_display_name)
	Update user information for an existing credential.
int(*	credential_count )(size_t *count)
	Get the total number of discoverable credentials stored.
int(*	wipe_all )(void)
	Wipe all stored credentials and PIN state.
int(*	pin_set )(const uint8_t pin_hash[16])
	Store PIN hash.
int(*	pin_get )(uint8_t pin_hash[16])
	Load stored PIN hash.
int(*	pin_retries_get )(uint8_t *retries)
	Get remaining PIN retry count.
int(*	pin_retries_decrement )(void)
	Decrement PIN retry counter.
int(*	pin_retries_reset )(void)
	Reset PIN retry counter to maximum.

Detailed Description

Storage backend API.

Field Documentation

◆ credential_count

int(* fido2_storage_api::credential_count) (size_t *count)

Get the total number of discoverable credentials stored.

◆ enumerate_rps

int(* fido2_storage_api::enumerate_rps) (size_t offset, struct fido2_credential *creds, size_t max_creds, size_t *count)

Enumerate unique Relying Party IDs from stored credentials.

◆ find_by_rp

int(* fido2_storage_api::find_by_rp) (const uint8_t rp_id_hash[32], struct fido2_credential *creds, size_t max_creds, size_t *count)

Find credentials by relying party ID hash.

◆ init

int(* fido2_storage_api::init) (void)

Initialize the storage backend.

◆ iterate

int(* fido2_storage_api::iterate) (fido2_storage_iterate_cb_t cb, void *user_data)

Iterate all stored credentials.

◆ load

int(* fido2_storage_api::load) (const uint8_t *cred_id, size_t cred_id_len, struct fido2_credential *cred)

Load a credential by ID.

◆ pin_get

int(* fido2_storage_api::pin_get) (uint8_t pin_hash[16])

Load stored PIN hash.

◆ pin_retries_decrement

int(* fido2_storage_api::pin_retries_decrement) (void)

Decrement PIN retry counter.

◆ pin_retries_get

int(* fido2_storage_api::pin_retries_get) (uint8_t *retries)

Get remaining PIN retry count.

◆ pin_retries_reset

int(* fido2_storage_api::pin_retries_reset) (void)

Reset PIN retry counter to maximum.

◆ pin_set

int(* fido2_storage_api::pin_set) (const uint8_t pin_hash[16])

Store PIN hash.

◆ remove

int(* fido2_storage_api::remove) (const uint8_t *cred_id, size_t cred_id_len, struct fido2_credential *cred)

Remove a credential by ID.

◆ sign_count_increment

int(* fido2_storage_api::sign_count_increment) (const uint8_t *cred_id, size_t cred_id_len, uint32_t *new_count)

Increment and return the signature counter.

◆ store

int(* fido2_storage_api::store) (const struct fido2_credential *cred)

Store a credential.

◆ update_user_info

int(* fido2_storage_api::update_user_info) (const uint8_t *cred_id, size_t cred_id_len, const char *user_name, const char *user_display_name)

Update user information for an existing credential.

◆ wipe_all

int(* fido2_storage_api::wipe_all) (void)

Wipe all stored credentials and PIN state.

The documentation for this struct was generated from the following file:

zephyr/authentication/fido2/fido2_storage.h

Data Fields