SE Key Establishment Cluster

Data Structures
struct	zb_zcl_kec_attrs_s
	Key Establishment cluster attributes. More...

Macros
#define	ZB_ZCL_ATTR_KEY_ESTABLISHMENT_SUITE_ID   0x0000U
	Key Establishment cluster's attributes IDs. More...
#define	ZB_ZCL_KEY_ESTABLISHMENT_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0002u)
	Default value for Key Establishment cluster revision global attribute. More...
#define	ZB_KEC_SUPPORTED_CRYPTO_ATTR   (KEC_CS1 | KEC_CS2)
	Attribute value const (supported CryptoSuites) More...
#define	ZB_ZCL_DECLARE_KEC_ATTR_LIST(attr_list, attrs)   ZB_ZCL_DECLARE_KEC_ATTRIB_LIST(attr_list, &attrs.kec_suite)
	Declare attribute list for Key Establishment cluster. More...

Typedefs
typedef zb_uint8_t	zb_kec_key_suite_t
	Type for KeyEstablishmentSuite attribute values. More...
typedef struct zb_zcl_kec_attrs_s	zb_zcl_kec_attrs_t
	Key Establishment cluster attributes. More...

KeyEstablishmentSuite attribute values
Table Values of the KeyEstablishmentSuite Attribute (Table C-4)
#define	KEC_CS1   (1U << 0)
#define	KEC_CS2   (1U << 1)

Detailed Description

This cluster provides attributes and commands to perform mutual authentication and establish keys between two Zigbee devices. Figure C-3 depicts a diagram of a successful key establishment negotiation.

Macro Definition Documentation

KEC_CS1

#define KEC_CS1   (1U << 0)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_se.h>

Certificate-based Key Establishment Cryptographic Suite 1 (Crypto Suite 1)

KEC_CS2

#define KEC_CS2   (1U << 1)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_se.h>

Certificate-based Key Establishment Cryptographic Suite 2 (Crypto Suite 2)

ZB_KEC_SUPPORTED_CRYPTO_ATTR

#define ZB_KEC_SUPPORTED_CRYPTO_ATTR   (KEC_CS1 | KEC_CS2)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_se.h>

Attribute value const (supported CryptoSuites)

ZB_ZCL_ATTR_KEY_ESTABLISHMENT_SUITE_ID

#define ZB_ZCL_ATTR_KEY_ESTABLISHMENT_SUITE_ID   0x0000U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_se.h>

Key Establishment cluster's attributes IDs.

The Information attribute set contains the attributes summarized in table below

Key Establishment Attribute Sets

Identifier	Name	Type	Range	Access	Default
0x0000	KeyEstablishmentSuite	16-bit Enumeration	0x0000-0xFFFF	Readonly	0x0000

See also

SE spec, C.3.1.2.2.1KeyEstablishmentSuite attribute

ZB_ZCL_DECLARE_KEC_ATTR_LIST

#define ZB_ZCL_DECLARE_KEC_ATTR_LIST	(		attr_list,
			attrs
	)		ZB_ZCL_DECLARE_KEC_ATTRIB_LIST(attr_list, &attrs.kec_suite)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_se.h>

Declare attribute list for Key Establishment cluster.

Parameters

[in]	attr_list	- attribute list variable name
[in]	attrs	- pointer to zb_zcl_kec_attrs_s structure

ZB_ZCL_KEY_ESTABLISHMENT_CLUSTER_REVISION_DEFAULT

#define ZB_ZCL_KEY_ESTABLISHMENT_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0002u)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_se.h>

Default value for Key Establishment cluster revision global attribute.

Typedef Documentation

zb_kec_key_suite_t

typedef zb_uint8_t zb_kec_key_suite_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_se.h>

Type for KeyEstablishmentSuite attribute values.

Deprecated:

holds one of kec_key_suite. Kept only for backward compatibility as kec_key_suite were declared previously as enum. Can be removed in future releases.

zb_zcl_kec_attrs_t

typedef struct zb_zcl_kec_attrs_s zb_zcl_kec_attrs_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zboss_api_se.h>

Key Establishment cluster attributes.