security.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 HAW Hamburg
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#pragma once

 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
 
#include "liblwm2m.h"
#include "net/credman.h"
#include "lwm2m_client.h"
#include "lwm2m_client_config.h"
 
/* these are defined in liblwm2m.h, and are reproduced here for documentation purposes */
#ifdef DOXYGEN
#define LWM2M_SECURITY_MODE_PRE_SHARED_KEY  0

#define LWM2M_SECURITY_MODE_RAW_PUBLIC_KEY  1

#define LWM2M_SECURITY_MODE_CERTIFICATE     2

#define LWM2M_SECURITY_MODE_NONE            3

#define LWM2M_SECURITY_URI_ID                 0

#define LWM2M_SECURITY_BOOTSTRAP_ID           1

#define LWM2M_SECURITY_SECURITY_ID            2

#define LWM2M_SECURITY_PUBLIC_KEY_ID          3

#define LWM2M_SECURITY_SERVER_PUBLIC_KEY_ID   4

#define LWM2M_SECURITY_SECRET_KEY_ID          5

#define LWM2M_SECURITY_SMS_SECURITY_ID        6

#define LWM2M_SECURITY_SMS_KEY_PARAM_ID       7

#define LWM2M_SECURITY_SMS_SECRET_KEY_ID      8

#define LWM2M_SECURITY_SMS_SERVER_NUMBER_ID   9

#define LWM2M_SECURITY_SHORT_SERVER_ID        10

#define LWM2M_SECURITY_HOLD_OFF_ID            11

#define LWM2M_SECURITY_BOOTSTRAP_TIMEOUT_ID   12
#endif /* DOXYGEN */

#ifndef CONFIG_LWM2M_OBJ_SECURITY_INSTANCES_MAX
#define CONFIG_LWM2M_OBJ_SECURITY_INSTANCES_MAX              (2)
#endif

#ifndef CONFIG_LWM2M_OBJ_SECURITY_PUB_KEY_ID_BUFSIZE
#define CONFIG_LWM2M_OBJ_SECURITY_PUB_KEY_ID_BUFSIZE         (128)
#endif

#ifndef CONFIG_LWM2M_OBJ_SECURITY_SERVER_PUB_KEY_BUFSIZE
#define CONFIG_LWM2M_OBJ_SECURITY_SERVER_PUB_KEY_BUFSIZE     (128)
#endif

#ifndef CONFIG_LWM2M_OBJ_SECURITY_SEC_KEY_BUFSIZE
#define CONFIG_LWM2M_OBJ_SECURITY_SEC_KEY_BUFSIZE            (64)
#endif

typedef struct lwm2m_obj_security_args {
    uint16_t server_id;

    const char *server_uri;

    uint8_t security_mode;

    const uint8_t *pub_key_or_id;

    size_t pub_key_or_id_len;

    const uint8_t *secret_key;

    size_t secret_key_len;

    const uint8_t *server_pub_key;

    size_t server_pub_key_len;

    bool is_bootstrap;

    uint32_t client_hold_off_time;

    uint32_t bootstrap_account_timeout;
} lwm2m_obj_security_args_t;

lwm2m_object_t *lwm2m_object_security_init(lwm2m_client_data_t *client_data);

int lwm2m_object_security_instance_create(const lwm2m_obj_security_args_t *args,
                                          int32_t instance_id);

credman_tag_t lwm2m_object_security_get_credential(uint16_t instance_id);
 
#ifdef __cplusplus
}
#endif