Arguments for a new Security object instance creation (lwm2m_object_security_instance_create). More...

Detailed Description

Arguments for a new Security object instance creation (lwm2m_object_security_instance_create).

Definition at line 311 of file security.h.

#include <security.h>

Data Fields
uint16_t	server_id
	Server's short ID the instance is associated to.

const char *	server_uri
	Server's URI the instance is associated to.

uint8_t	security_mode
	Security mode to use.

const uint8_t *	pub_key_or_id
	Pointer to the Key ID when using LWM2M_SECURITY_MODE_PRE_SHARED_KEY.

size_t	pub_key_or_id_len
	Length of lwm2m_obj_security_args_t::pub_key_or_id.

const uint8_t *	secret_key
	Pointer to the Key when using LWM2M_SECURITY_MODE_PRE_SHARED_KEY.

size_t	secret_key_len
	Length of lwm2m_obj_security_args_t::secret_key.

const uint8_t *	server_pub_key
	Pointer to the server public key encoded as a `SubjectPublicKeyInfo` sequence when using LWM2M_SECURITY_MODE_RAW_PUBLIC_KEY (see credman_load_public_key).

size_t	server_pub_key_len
	Length of lwm2m_obj_security_args_t::server_pub_key.

bool	is_bootstrap
	When `true` the security instance is associated to the Bootstrap-Server.

uint32_t	client_hold_off_time
	Time, in seconds, to wait before initiating a 'Client Initiated Bootstrap', after it has been determined that it should be initiated.

uint32_t	bootstrap_account_timeout
	Time, in seconds, that the client waits before it purges the Bootstrap-Server's account.

Field Documentation

◆ bootstrap_account_timeout

uint32_t lwm2m_obj_security_args::bootstrap_account_timeout

Time, in seconds, that the client waits before it purges the Bootstrap-Server's account.

0 means never.

Definition at line 391 of file security.h.

◆ client_hold_off_time

uint32_t lwm2m_obj_security_args::client_hold_off_time

Time, in seconds, to wait before initiating a 'Client Initiated Bootstrap', after it has been determined that it should be initiated.

Definition at line 385 of file security.h.

◆ is_bootstrap

bool lwm2m_obj_security_args::is_bootstrap

When true the security instance is associated to the Bootstrap-Server.

Definition at line 379 of file security.h.

◆ pub_key_or_id

const uint8_t* lwm2m_obj_security_args::pub_key_or_id

Pointer to the Key ID when using LWM2M_SECURITY_MODE_PRE_SHARED_KEY.

Pointer to the public key encoded as a SubjectPublicKeyInfo sequence when using LWM2M_SECURITY_MODE_RAW_PUBLIC_KEY (see credman_load_public_key). May be NULL when LWM2M_SECURITY_MODE_NONE is used.

Note: This buffer will be copied internally.

Definition at line 339 of file security.h.

◆ pub_key_or_id_len

size_t lwm2m_obj_security_args::pub_key_or_id_len

Length of lwm2m_obj_security_args_t::pub_key_or_id.

Definition at line 344 of file security.h.

◆ secret_key

const uint8_t* lwm2m_obj_security_args::secret_key

Pointer to the Key when using LWM2M_SECURITY_MODE_PRE_SHARED_KEY.

Pointer to the private key PKCS8 DER encoded when using LWM2M_SECURITY_MODE_RAW_PUBLIC_KEY (see credman_load_private_key). May be NULL when LWM2M_SECURITY_MODE_NONE is used.

Note: This buffer will be copied internally.

Definition at line 354 of file security.h.

◆ secret_key_len

size_t lwm2m_obj_security_args::secret_key_len

Length of lwm2m_obj_security_args_t::secret_key.

Definition at line 359 of file security.h.

◆ security_mode

uint8_t lwm2m_obj_security_args::security_mode

Security mode to use.

For now only LWM2M_SECURITY_MODE_NONE and LWM2M_SECURITY_MODE_PRE_SHARED_KEY and LWM2M_SECURITY_MODE_RAW_PUBLIC_KEY are supported.

Definition at line 329 of file security.h.

◆ server_id

uint16_t lwm2m_obj_security_args::server_id

Server's short ID the instance is associated to.

Definition at line 315 of file security.h.

◆ server_pub_key

const uint8_t* lwm2m_obj_security_args::server_pub_key

Pointer to the server public key encoded as a SubjectPublicKeyInfo sequence when using LWM2M_SECURITY_MODE_RAW_PUBLIC_KEY (see credman_load_public_key).

May be NULL when LWM2M_SECURITY_MODE_NONE or LWM2M_SECURITY_MODE_PRE_SHARED_KEY are used.

Note: This buffer will be copied internally.

Definition at line 369 of file security.h.

◆ server_pub_key_len

size_t lwm2m_obj_security_args::server_pub_key_len

Length of lwm2m_obj_security_args_t::server_pub_key.

Definition at line 374 of file security.h.

◆ server_uri

const char* lwm2m_obj_security_args::server_uri

Server's URI the instance is associated to.

Note: This buffer will be copied internally.

Definition at line 322 of file security.h.

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

pkg/wakaama/include/objects/security.h