fido2_storage.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Siratul Islam <email@sirat.me>
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_AUTHENTICATION_FIDO2_FIDO2_STORAGE_H_
#define ZEPHYR_INCLUDE_AUTHENTICATION_FIDO2_FIDO2_STORAGE_H_
 
#include <zephyr/authentication/fido2/fido2_types.h>
#include <stddef.h>

 
#ifdef __cplusplus
extern "C" {
#endif

typedef int (*fido2_storage_iterate_cb_t)(const struct fido2_credential *cred, void *user_data);

struct fido2_storage_api {
        int (*init)(void);
        int (*store)(const struct fido2_credential *cred);
        int (*load)(const uint8_t *cred_id, size_t cred_id_len, struct fido2_credential *cred);
        int (*remove)(const uint8_t *cred_id, size_t cred_id_len, struct fido2_credential *cred);
        int (*find_by_rp)(const uint8_t rp_id_hash[FIDO2_SHA256_SIZE],
                          struct fido2_credential *creds, size_t max_creds, size_t *count);
        int (*enumerate_rps)(size_t offset, struct fido2_credential *creds, size_t max_creds,
                             size_t *count);
        int (*iterate)(fido2_storage_iterate_cb_t cb, void *user_data);
        int (*sign_count_increment)(const uint8_t *cred_id, size_t cred_id_len,
                                    uint32_t *new_count);
        int (*update_user_info)(const uint8_t *cred_id, size_t cred_id_len, const char *user_name,
                                const char *user_display_name);
        int (*credential_count)(size_t *count);
        int (*wipe_all)(void);
        int (*pin_set)(const uint8_t pin_hash[FIDO2_PIN_HASH_SIZE]);
        int (*pin_get)(uint8_t pin_hash[FIDO2_PIN_HASH_SIZE]);
        int (*pin_retries_get)(uint8_t *retries);
        int (*pin_retries_decrement)(void);
        int (*pin_retries_reset)(void);
};

extern const struct fido2_storage_api fido2_storage_backend;


int fido2_storage_init(void);

int fido2_storage_store(const struct fido2_credential *cred);

int fido2_storage_load(const uint8_t *cred_id, size_t cred_id_len, struct fido2_credential *cred);

int fido2_storage_remove(const uint8_t *cred_id, size_t cred_id_len);

int fido2_storage_find_by_rp(const uint8_t rp_id_hash[FIDO2_SHA256_SIZE],
                             struct fido2_credential *creds, size_t max_creds, size_t *count);

int fido2_storage_enumerate_rps(size_t offset, struct fido2_credential *creds, size_t max_creds,
                                size_t *count);

int fido2_storage_sign_count_increment(const uint8_t *cred_id, size_t cred_id_len,
                                       uint32_t *new_count);

int fido2_storage_pin_retries_get(uint8_t *retries);

int fido2_storage_pin_retries_decrement(void);

int fido2_storage_pin_retries_reset(void);

int fido2_storage_pin_set(uint8_t pin_hash[FIDO2_PIN_HASH_SIZE]);

int fido2_storage_pin_get(uint8_t pin_hash[FIDO2_PIN_HASH_SIZE]);

 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_AUTHENTICATION_FIDO2_FIDO2_STORAGE_H_ */