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
emberAfApsLinkKeyAuthorizationIsEnabled(void)

Get APS Link key authorization state.

bool
emberAfApsLinkKeyAuthorizationIsClusterExempted(uint16_t clusterId)

APS link key authorization cluster exempted state.

bool
emberAfApsLinkKeyAuthorizationIsExemptClusterListFull(void)

Exempted cluster list full state.

void
emberAfApsLinkKeyAuthorizationGetExemptClusterList(uint8_t *exemptListCount, uint16_t *exemptClusterList)

Get exempt cluster list.

void
emberAfApsLinkKeyAuthorizationClearExemptClusterList(void)

Clear exempt cluster list.

void
emberAfApsLinkKeyAuthorizationEnable(bool enable)

Enable/disable APS link ket authorization.

EmberStatus
emberAfApsLinkKeyAuthorizationAddClusterExempted(uint16_t clusterId)

Add a cluster to the exempted cluster list.

EmberStatus
emberAfApsLinkKeyAuthorizationEnableWithExemptClusterList(uint8_t numberExemptClusters, uint8_t *exemptClusterList)

Enable APS link key authorization with exempted cluster list.

EmberStatus
emberAfApsLinkKeyAuthorizationDisableWithExemptClusterList(uint8_t numberExemptClusters, uint8_t *exemptClusterList)

Disable link ket authorization with exempt cluster list.

#define
emberAfApsLinkKeyAuthorizationIsRequiredOnCluster (clusterId)

Get APS Link key authorization state.

API Documentation#

emberAfApsLinkKeyAuthorizationIsEnabled#

bool emberAfApsLinkKeyAuthorizationIsEnabled (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

emberAfApsLinkKeyAuthorizationIsClusterExempted#

bool emberAfApsLinkKeyAuthorizationIsClusterExempted (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

emberAfApsLinkKeyAuthorizationIsExemptClusterListFull#

bool emberAfApsLinkKeyAuthorizationIsExemptClusterListFull (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

emberAfApsLinkKeyAuthorizationExemptClusterListCount#

uint8_t emberAfApsLinkKeyAuthorizationExemptClusterListCount (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

emberAfApsLinkKeyAuthorizationGetExemptClusterList#

void emberAfApsLinkKeyAuthorizationGetExemptClusterList (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

emberAfApsLinkKeyAuthorizationClearExemptClusterList#

void emberAfApsLinkKeyAuthorizationClearExemptClusterList (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

emberAfApsLinkKeyAuthorizationEnable#

void emberAfApsLinkKeyAuthorizationEnable (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

emberAfApsLinkKeyAuthorizationAddClusterExempted#

EmberStatus emberAfApsLinkKeyAuthorizationAddClusterExempted (uint16_t clusterId)

Add a cluster to the exempted cluster list.

Parameters
N/AclusterId

Ver.:Always

Returns

  • EmberStaus status code


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

emberAfApsLinkKeyAuthorizationEnableWithExemptClusterList#

EmberStatus emberAfApsLinkKeyAuthorizationEnableWithExemptClusterList (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

  • EmberStatus status code


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

emberAfApsLinkKeyAuthorizationDisableWithExemptClusterList#

EmberStatus emberAfApsLinkKeyAuthorizationDisableWithExemptClusterList (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

  • EmberStatus status code


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

emberAfApsLinkKeyAuthorizationIsRequiredOnCluster#

#define emberAfApsLinkKeyAuthorizationIsRequiredOnCluster
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 */ \
(emberAfApsLinkKeyAuthorizationIsEnabled() != emberAfApsLinkKeyAuthorizationIsClusterExempted(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