astarte_credentials.h

Go to the documentation of this file.

/*
 * (C) Copyright 2018-2023, SECO Mind Srl
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later OR Apache-2.0
 */
 
#ifndef _ASTARTE_CREDENTIALS_H_
#define _ASTARTE_CREDENTIALS_H_
 
#include "astarte.h"
 
#include <stdbool.h>
#include <string.h>
 
#define CERT_LENGTH 4096
#define CN_LENGTH 512
 
#define ASTARTE_CREDENTIALS_DEFAULT_NVS_PARTITION NULL
 
enum credential_type_t
{
    ASTARTE_CREDENTIALS_CSR = 1,
    ASTARTE_CREDENTIALS_KEY,
    ASTARTE_CREDENTIALS_CERTIFICATE
} __attribute__((deprecated("Please use the typedef credential_type_t")));
 
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
typedef enum credential_type_t credential_type_t;
#pragma GCC diagnostic pop
 
typedef astarte_err_t (*astarte_credentials_store_t)(
    void *opaque, credential_type_t cred_type, const void *credential, size_t length);
typedef astarte_err_t (*astarte_credentials_fetch_t)(
    void *opaque, credential_type_t cred_type, char *out, size_t length);
typedef bool (*astarte_credentials_exists_t)(void *opaque, credential_type_t cred_type);
typedef astarte_err_t (*astarte_credentials_remove_t)(void *opaque, credential_type_t cred_type);
 
typedef struct
{
    astarte_credentials_store_t astarte_credentials_store;
    astarte_credentials_fetch_t astarte_credentials_fetch;
    astarte_credentials_exists_t astarte_credentials_exists;
    astarte_credentials_remove_t astarte_credentials_remove;
} astarte_credentials_storage_functions_t;
 
typedef struct
{
    const astarte_credentials_storage_functions_t *functions;
    void *opaque;
} astarte_credentials_context_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
astarte_err_t astarte_credentials_set_storage_context(astarte_credentials_context_t *creds_context);
 
astarte_err_t astarte_credentials_use_nvs_storage(const char *partition_label);
 
astarte_err_t astarte_credentials_init();
 
bool astarte_credentials_is_initialized();
 
astarte_err_t astarte_credentials_create_key();
 
astarte_err_t astarte_credentials_create_csr();
 
astarte_err_t astarte_credentials_save_certificate(const char *cert_pem);
 
astarte_err_t astarte_credentials_delete_certificate();
 
astarte_err_t astarte_credentials_get_csr(char *out, size_t length);
 
astarte_err_t astarte_credentials_get_certificate(char *out, size_t length);
 
astarte_err_t astarte_credentials_get_certificate_common_name(
    const char *cert_pem, char *out, size_t length);
 
astarte_err_t astarte_credentials_get_key(char *out, size_t length);
 
astarte_err_t astarte_credentials_get_stored_credentials_secret(char *out, size_t length);
 
astarte_err_t astarte_credentials_set_stored_credentials_secret(const char *credentials_secret);
 
astarte_err_t astarte_credentials_erase_stored_credentials_secret();
 
bool astarte_credentials_has_certificate();
 
bool astarte_credentials_has_csr();
 
bool astarte_credentials_has_key();
 
/*
 * @brief store a credential using filesystem storage
 *
 * @details this API might change in future versions.
 */
astarte_err_t astarte_credentials_store(
    void *opaque, credential_type_t cred_type, const void *credential, size_t length);
 
/*
 * @brief fetch a credential using filesystem storage
 *
 * @details this API might change in future versions.
 */
astarte_err_t astarte_credentials_fetch(
    void *opaque, credential_type_t cred_type, char *out, size_t length);
 
/*
 * @brief return true whether a credential exists on fileystem storage
 *
 * @details this API might change in future versions.
 */
bool astarte_credentials_exists(void *opaque, credential_type_t cred_type);
 
/*
 * @brief remove a credential from filesystem storage
 *
 * @details this API might change in future versions.
 */
astarte_err_t astarte_credentials_remove(void *opaque, credential_type_t cred_type);
 
/*
 * @brief store a credential using NVS
 *
 * @details this API might change in future versions.
 */
astarte_err_t astarte_credentials_nvs_store(
    void *opaque, credential_type_t cred_type, const void *credential, size_t length);
 
/*
 * @brief fetch a credential using NVS
 *
 * @details this API might change in future versions.
 */
astarte_err_t astarte_credentials_nvs_fetch(
    void *opaque, credential_type_t cred_type, char *out, size_t length);
 
/*
 * @brief return true whether a credential exists on NVS
 *
 * @details this API might change in future versions.
 */
bool astarte_credentials_nvs_exists(void *opaque, credential_type_t cred_type);
 
/*
 * @brief remove a credential from NVS
 *
 * @details this API might change in future versions.
 */
astarte_err_t astarte_credentials_nvs_remove(void *opaque, credential_type_t cred_type);
 
#ifdef __cplusplus
}
#endif
 
#endif