security_object.h

Go to the documentation of this file.

/*
 * Copyright 2023-2026 AVSystem <avsystem@avsystem.com>
 * AVSystem Anjay Lite LwM2M SDK
 * All rights reserved.
 *
 * Licensed under AVSystem Anjay Lite LwM2M Client SDK - Non-Commercial License.
 * See the attached LICENSE file for details.
 */
 
#include <anj/init.h>
 
#ifndef ANJ_DM_SECURITY_OBJECT_H
#    define ANJ_DM_SECURITY_OBJECT_H
 
#    include <stdbool.h>
#    include <stddef.h>
#    include <stdint.h>
 
#    include <anj/defs.h>
#    include <anj/dm/core.h>
 
#    ifdef ANJ_WITH_PERSISTENCE
#        include <anj/persistence.h>
#    endif // ANJ_WITH_PERSISTENCE
 
#    ifdef ANJ_WITH_SECURITY
#        include <anj/crypto.h>
#    endif // ANJ_WITH_SECURITY
 
#    ifdef __cplusplus
extern "C" {
#    endif
 
typedef enum {
    ANJ_DM_SECURITY_PSK = 0,
 
    ANJ_DM_SECURITY_RPK = 1,
 
    ANJ_DM_SECURITY_CERTIFICATE = 2,
 
    ANJ_DM_SECURITY_NOSEC = 3,
 
    ANJ_DM_SECURITY_EST = 4
} anj_dm_security_mode_t;
 
#    ifdef ANJ_WITH_DEFAULT_SECURITY_OBJ
 
#        ifdef ANJ_WITH_BOOTSTRAP
#            define ANJ_DM_SECURITY_OBJ_INSTANCES 2
#        else // ANJ_WITH_BOOTSTRAP
#            define ANJ_DM_SECURITY_OBJ_INSTANCES 1
#        endif // ANJ_WITH_BOOTSTRAP
typedef struct {
    // resources
    char server_uri[ANJ_SERVER_URI_MAX_SIZE];
    bool bootstrap_server;
    anj_dm_security_mode_t security_mode;
#        ifdef ANJ_WITH_SECURITY
    uint8_t public_key_or_identity_buff
            [ANJ_SEC_OBJ_MAX_PUBLIC_KEY_OR_IDENTITY_SIZE];
    uint8_t server_public_key_buff[ANJ_SEC_OBJ_MAX_SERVER_PUBLIC_KEY_SIZE];
    uint8_t secret_key_buff[ANJ_SEC_OBJ_MAX_SECRET_KEY_SIZE];
    anj_crypto_security_info_t public_key_or_identity;
    anj_crypto_security_info_t server_public_key;
    anj_crypto_security_info_t secret_key;
#        endif // ANJ_WITH_SECURITY
    uint16_t ssid;
    uint32_t client_hold_off_time;
 
    // metadata
    anj_iid_t iid;
} anj_dm_security_instance_t;
 
typedef struct {
    const char *server_uri;
 
    bool bootstrap_server;
 
    anj_dm_security_mode_t security_mode;
 
#        ifdef ANJ_WITH_SECURITY
    anj_crypto_security_info_t public_key_or_identity;
 
    anj_crypto_security_info_t server_public_key;
 
    anj_crypto_security_info_t secret_key;
#        endif // ANJ_WITH_SECURITY
 
    uint16_t ssid;
 
    uint32_t client_hold_off_time;
 
    const anj_iid_t *iid;
} anj_dm_security_instance_init_t;
 
typedef struct {
    anj_dm_obj_t obj;
    anj_dm_obj_inst_t inst[ANJ_DM_SECURITY_OBJ_INSTANCES];
    anj_dm_obj_inst_t cache_inst[ANJ_DM_SECURITY_OBJ_INSTANCES];
    anj_dm_security_instance_t
            security_instances[ANJ_DM_SECURITY_OBJ_INSTANCES];
    anj_dm_security_instance_t
            cache_security_instances[ANJ_DM_SECURITY_OBJ_INSTANCES];
    bool installed;
    anj_iid_t new_instance_iid;
} anj_dm_security_obj_t;
 
void anj_dm_security_obj_init(anj_dm_security_obj_t *security_obj_ctx);
 
int anj_dm_security_obj_add_instance(
        anj_dm_security_obj_t *security_obj_ctx,
        const anj_dm_security_instance_init_t *instance);
 
int anj_dm_security_obj_install(anj_t *anj,
                                anj_dm_security_obj_t *security_obj_ctx);
 
#        ifdef ANJ_WITH_SECURITY
 
int anj_dm_security_obj_get_psk(const anj_t *anj,
                                bool bootstrap_credentials,
                                anj_crypto_security_info_t *out_psk_identity,
                                anj_crypto_security_info_t *out_psk_key);
#        endif // ANJ_WITH_SECURITY
 
#        ifdef ANJ_WITH_PERSISTENCE
int anj_dm_security_obj_store(anj_t *anj,
                              anj_dm_security_obj_t *security_obj_ctx,
                              const anj_persistence_context_t *ctx);
 
int anj_dm_security_obj_restore(anj_t *anj,
                                anj_dm_security_obj_t *security_obj_ctx,
                                const anj_persistence_context_t *ctx);
#        endif // ANJ_WITH_PERSISTENCE
 
#    endif // ANJ_WITH_DEFAULT_SECURITY_OBJ
 
#    ifdef __cplusplus
}
#    endif
 
#endif // ANJ_DM_SECURITY_OBJECT_H