APS Link Key Authorization#

API and Callbacks for the APS Link Key Authorization Component.

This component enables a better granularity of cluster-specific APS link key security.

API#

bool
sl_zigbee_af_aps_link_key_authorization_is_enabled(void)

Get APS Link key authorization state.

bool
sl_zigbee_af_aps_link_key_authorization_is_cluster_exempted(uint16_t clusterId)

APS link key authorization cluster exempted state.

void
sl_zigbee_af_aps_link_key_authorization_get_exempt_cluster_list(uint8_t *exemptListCount, uint16_t *exemptClusterList)

Get exempt cluster list.

void
sl_zigbee_af_aps_link_key_authorization_enable(bool enable)

Enable/disable APS link ket authorization.

sl_status_t
sl_zigbee_af_aps_link_key_authorization_add_cluster_exempted(uint16_t clusterId)

Add a cluster to the exempted cluster list.

sl_status_t
sl_zigbee_af_aps_link_key_authorization_enable_with_exempt_cluster_list(uint8_t numberExemptClusters, uint8_t *exemptClusterList)

Enable APS link key authorization with exempted cluster list.

sl_status_t
sl_zigbee_af_aps_link_key_authorization_disable_with_exempt_cluster_list(uint8_t numberExemptClusters, uint8_t *exemptClusterList)

Disable link ket authorization with exempt cluster list.

#define
sl_zigbee_af_aps_link_key_authorization_is_required_on_cluster (clusterId)

Get APS Link key authorization state.

API Documentation#

sl_zigbee_af_aps_link_key_authorization_is_enabled#

bool sl_zigbee_af_aps_link_key_authorization_is_enabled (void )

Get APS Link key authorization state.

Parameters
N/A

Returns

  • bool APS link key authorization state


Definition at line 49 of file app/framework/plugin/aps-link-key-authorization/aps-link-key-authorization.h

sl_zigbee_af_aps_link_key_authorization_is_cluster_exempted#

bool sl_zigbee_af_aps_link_key_authorization_is_cluster_exempted (uint16_t clusterId)

APS link key authorization cluster exempted state.

Parameters
N/AclusterId

Ver.:Always

Returns

  • bool exempted state


Definition at line 57 of file app/framework/plugin/aps-link-key-authorization/aps-link-key-authorization.h

sl_zigbee_af_aps_link_key_authorization_is_exempt_cluster_list_full#

bool sl_zigbee_af_aps_link_key_authorization_is_exempt_cluster_list_full (void )

Exempted cluster list full state.

Parameters
N/A

Returns

  • bool cluster list full state


Definition at line 64 of file app/framework/plugin/aps-link-key-authorization/aps-link-key-authorization.h

sl_zigbee_af_aps_link_key_authorization_exempt_cluster_list_count#

uint8_t sl_zigbee_af_aps_link_key_authorization_exempt_cluster_list_count (void )
Parameters
N/A

Get exempt cluster list count.

Returns

  • uint8_t exempt cluster link count


Definition at line 71 of file app/framework/plugin/aps-link-key-authorization/aps-link-key-authorization.h

sl_zigbee_af_aps_link_key_authorization_get_exempt_cluster_list#

void sl_zigbee_af_aps_link_key_authorization_get_exempt_cluster_list (uint8_t * exemptListCount, uint16_t * exemptClusterList)

Get exempt cluster list.

Parameters
N/AexemptListCount

Ver.:Always

N/AexemptClusterList

Ver.:Always


Definition at line 79 of file app/framework/plugin/aps-link-key-authorization/aps-link-key-authorization.h

sl_zigbee_af_aps_link_key_authorization_clear_exempt_cluster_list#

void sl_zigbee_af_aps_link_key_authorization_clear_exempt_cluster_list (void )

Clear exempt cluster list.

Parameters
N/A

Definition at line 84 of file app/framework/plugin/aps-link-key-authorization/aps-link-key-authorization.h

sl_zigbee_af_aps_link_key_authorization_enable#

void sl_zigbee_af_aps_link_key_authorization_enable (bool enable)

Enable/disable APS link ket authorization.

Parameters
N/Aenable

enable value Ver.:Always


Definition at line 91 of file app/framework/plugin/aps-link-key-authorization/aps-link-key-authorization.h

sl_zigbee_af_aps_link_key_authorization_add_cluster_exempted#

sl_status_t sl_zigbee_af_aps_link_key_authorization_add_cluster_exempted (uint16_t clusterId)

Add a cluster to the exempted cluster list.

Parameters
N/AclusterId

Ver.:Always

Returns

  • sl_zigbee_staus_t status code


Definition at line 100 of file app/framework/plugin/aps-link-key-authorization/aps-link-key-authorization.h

sl_zigbee_af_aps_link_key_authorization_enable_with_exempt_cluster_list#

sl_status_t sl_zigbee_af_aps_link_key_authorization_enable_with_exempt_cluster_list (uint8_t numberExemptClusters, uint8_t * exemptClusterList)

Enable APS link key authorization with exempted cluster list.

Parameters
N/AnumberExemptClusters

exempt cluster count Ver.:Always

N/AexemptClusterList

Ver.:Always

Returns

  • sl_status_t status code


Definition at line 110 of file app/framework/plugin/aps-link-key-authorization/aps-link-key-authorization.h

sl_zigbee_af_aps_link_key_authorization_disable_with_exempt_cluster_list#

sl_status_t sl_zigbee_af_aps_link_key_authorization_disable_with_exempt_cluster_list (uint8_t numberExemptClusters, uint8_t * exemptClusterList)

Disable link ket authorization with exempt cluster list.

Parameters
N/AnumberExemptClusters

exempt cluster count Ver.:Always

N/AexemptClusterList

Ver.:Always

Returns

  • sl_status_t status code


Definition at line 120 of file app/framework/plugin/aps-link-key-authorization/aps-link-key-authorization.h

sl_zigbee_af_aps_link_key_authorization_is_required_on_cluster#

#define sl_zigbee_af_aps_link_key_authorization_is_required_on_cluster
Value:
/* If APS level security is enabled, the exempt list serves as a security disabler, */ \
/* whereas, if security is disabled, the exempt list serves as a security enabler */ \
(sl_zigbee_af_aps_link_key_authorization_is_enabled() != sl_zigbee_af_aps_link_key_authorization_is_cluster_exempted(clusterId))

Get APS Link key authorization state.

Returns

  • bool APS link key authorization state


Definition at line 40 of file app/framework/plugin/aps-link-key-authorization/aps-link-key-authorization.h