Security#

emberTransientKeyTimeoutS#

uint16_t emberTransientKeyTimeoutS

The length of time, in seconds, that a trust center will store a transient link key that a device can use to join its network. A transient key is added with a call to emberAddTransientLinkKey. After the transient key is added, it will be removed once this amount of time has passed. A joining device will not be able to use that key to join until it is added again on the trust center. The default value is 300 seconds, i.e., 5 minutes.

emberSetInitialSecurityState#

EmberStatus emberSetInitialSecurityState (EmberInitialSecurityState * state)

Set the initial security state that will be used by the device when it forms or joins a network. If security is enabled, this function must be called prior to forming or joining the network. It must also be called if the device left the network and wishes to form or join another network.

This call should not be used when restoring prior network operation from saved state via emberNetworkInit because this will cause saved security settings and keys table from the prior network to be erased, resulting in improper keys and/or frame counter values being used, which will prevent proper communication with other devices in the network. Calling emberNetworkInit is sufficient to restore all saved security settings after a reboot and re-enter the network.

The call may be used by either the Trust Center or non Trust Center devices, the options that are set are different depending on which role the device will assume. See the EmberInitialSecurityState structure for more explanation about the various security settings.

The function will return EMBER_SECURITY_CONFIGURATION_INVALID in the following cases:

• Distributed Trust Center Mode was enabled with Hashed Link Keys.

Returns

• An EmberStatus value. EMBER_SUCCESS if the security state has been set successfully. EMBER_INVALID_CALL if the device is not in the EMBER_NO_NETWORK state. The value EMBER_SECURITY_CONFIGURATION_INVALID is returned if the combination of security parameters is not valid. EMBER_KEY_INVALID is returned if a reserved or invalid key value was passed in the key structure for one of the keys.

emberSetExtendedSecurityBitmask#

EmberStatus emberSetExtendedSecurityBitmask (EmberExtendedSecurityBitmask mask)

Set the extended initial security bitmask.

Returns

• EMBER_SUCCESS if the security settings were successfully retrieved. EMBER_INVALID_CALL otherwise.

emberGetExtendedSecurityBitmask#

EmberStatus emberGetExtendedSecurityBitmask (EmberExtendedSecurityBitmask * mask)

Get the extended security bitmask that is used by a device.

Returns

• EMBER_SUCCESS if the security settings were successfully retrieved. EMBER_INVALID_CALL otherwise.

emberGetCurrentSecurityState#

EmberStatus emberGetCurrentSecurityState (EmberCurrentSecurityState * state)

Get the security state that is used by a device joined into the Network.

Returns

• EMBER_SUCCESS if the security settings were successfully retrieved. EMBER_NOT_JOINED if the device is not currently joined in the network.

emberGetKey#

EmberStatus emberGetKey (EmberKeyType type, EmberKeyStruct * keyStruct)

Get the specified key and its associated data. This can retrieve the Trust Center Link Key, Current Network Key, or Next Network Key. On the 35x series chips, the data returned by this call is governed by the security policy set in the manufacturing token for TOKEN_MFG_SECURITY_CONFIG. See the API calls emberSetMfgSecurityConfig() and emberGetMfgSecurityConfig() for more information. If the security policy is not set to EMBER_KEY_PERMISSIONS_READING_ALLOWED, the actual encryption key value will not be returned. Other metadata about the key will be returned.

Returns

• EMBER_SUCCESS if the key was retrieved successfully. EMBER_INVALID_CALL if an attempt was made to retrieve an EMBER_APPLICATION_LINK_KEY.

emberHaveLinkKey#

bool emberHaveLinkKey (EmberEUI64 remoteDevice)

Return true if a link key is available for securing messages sent to the remote device.

Returns

• bool Returns true if a link key is available.

emberGenerateRandomKey#

EmberStatus emberGenerateRandomKey (EmberKeyData * keyAddress)

Generate a Random Key (link, network, or master) and returns the result.

It copies the key into the array that result points to. This is an time-expensive operation as it needs to obtain truly random numbers.

Returns

• EMBER_SUCCESS on success, EMBER_INSUFFICIENT_RANDOM_DATA on failure.

emberSwitchNetworkKeyHandler#

void emberSwitchNetworkKeyHandler (uint8_t sequenceNumber)

Inform the application that the Network Key has been updated and the node has been switched over to use the new key. The actual key being used is not passed up, but the sequence number is.

emberRequestLinkKey#

EmberStatus emberRequestLinkKey (EmberEUI64 partner)

Request a Link Key from the Trust Center with another device device on the Network (which could be the Trust Center). A Link Key with the Trust Center is possible but the requesting device can't be the Trust Center. Link Keys are optional in ZigBee Standard Security. Therefore, the stack can't know whether the other device supports them.

If the partner device is the Trust Center, only that device needs to request the key. The Trust Center will immediately respond to those requests and send the key back to the device.

If the partner device is not the Trust Center, both devices must request an Application Link Key with each other. The requests will be sent to the Trust Center for it to answer. The Trust Center will store the first request and wait EMBER_REQUEST_KEY_TIMEOUT for the second request to be received. The Trust Center only supports one outstanding Application key request at a time and therefore will ignore other requests that are not associated with the first request.

Sleepy devices should poll at a higher rate until a response is received or the request times out.

The success or failure of the request is returned via ::emberZigbeeKeyEstablishmentHandler(...)

Returns

• EMBER_SUCCESS if the call succeeds, or EMBER_NO_BUFFERS.

emberUpdateTcLinkKey#

EmberStatus emberUpdateTcLinkKey (uint8_t maxAttempts)

Request a new link link key from the Trust Center. This function starts by sending a Node Descriptor request to the Trust Center to verify its R21+ stack version compliance. A Request Key message will then be sent, followed by a Verify Key Confirm message.

Returns

• EMBER_ERR_FATAL is the Security Core Library is not included. EMBER_INVALID_CALL if already requesting a key from TC, not on network, or if local node is Trust Center. EMBER_SECURITY_CONFIGURATION_INVALID if the Trust Center's EUI is unknown. Otherwise, the return status from sending the initial Node Descriptor is returned.

emberZigbeeKeyEstablishmentHandler#

void emberZigbeeKeyEstablishmentHandler (EmberEUI64 partner, EmberKeyStatus status)

Notify the application about the status of the request for a Link Key. The application should define EMBER_APPLICATION_HAS_ZIGBEE_KEY_ESTABLISHMENT_HANDLER to implement its own handler.

emberGetKeyTableEntry#

EmberStatus emberGetKeyTableEntry (uint8_t index, EmberKeyStruct * result)

Get data from the Key Table. On the 35x series chips, the data returned by this call is governed by the security policy set in the manufacturing token for TOKEN_MFG_SECURITY_CONFIG. See the API calls emberSetMfgSecurityConfig() and emberGetMfgSecurityConfig() for more information. If the security policy is not set to EMBER_KEY_PERMISSIONS_READING_ALLOWED, the actual encryption key value will not be returned. Other metadata about the key will be returned.

Returns

• EMBER_TABLE_ENTRY_ERASED if the index is an erased key entry. EMBER_INDEX_OUT_OF_RANGE if the passed index is not valid. EMBER_SUCCESS on success.

emberSetKeyTableEntry#

EmberStatus emberSetKeyTableEntry (uint8_t index, EmberEUI64 address, bool linkKey, EmberKeyData * keyData)

Set an entry in the key table.

Returns

• EMBER_KEY_INVALID if the passed key data is using one of the reserved key values. EMBER_INDEX_OUT_OF_RANGE if passed index is not valid. EMBER_SUCCESS on success.

emberAddOrUpdateKeyTableEntry#

EmberStatus emberAddOrUpdateKeyTableEntry (EmberEUI64 address, bool linkKey, EmberKeyData * keyData)

Add a new entry in the key table or updates an existing entry with a new key. It first searches the key table for an entry that has a matching EUI64. If it does not find one, it searches for the first free entry. If it is successful in either case, it sets the entry with the EUI64, key data, and flag that indicates if it is a Link or Master Key. The Incoming Frame Counter for that key is also reset to 0. If no existing entry was found and there are no free entries in the table, the call will fail.

Returns

• EMBER_TABLE_FULL if no free entry was found to add. EMBER_KEY_INVALID if the passed key was a reserved value. ::EMBER_KEY_TABLE_ADDRESS_NOT_VALID if the passed address is reserved or invalid. EMBER_SUCCESS on success.

emberFindKeyTableEntry#

uint8_t emberFindKeyTableEntry (EmberEUI64 address, bool linkKey)

Search the key table to find an entry matching the specified IEEE address and key type.

Returns

• The index that matches the search criteria, or 0xFF if no matching entry was found.

emberEraseKeyTableEntry#

EmberStatus emberEraseKeyTableEntry (uint8_t index)

Clear a single entry in the key table.

Returns

• EMBER_SUCCESS if the index is valid and the key data was erased. EMBER_KEY_INVALID if the index is out of range for the size of the key table.

emberClearKeyTable#

EmberStatus emberClearKeyTable (void )

Clear the key table of the current network.

Returns

• EMBER_SUCCESS if the key table was successfully cleared. EMBER_INVALID_CALL otherwise.

emberStopWritingStackTokens#

EmberStatus emberStopWritingStackTokens (void )

Suppress normal write operations of the stack tokens. This is only done in rare circumstances when the device already has network parameters but needs to conditionally rejoin a network in order to perform a security message exchange (i.e., key establishment). If the network is not authenticated properly, it needs to forget any stack data it used and return to the old network. By suppressing writing of the stack tokens the device will not have stored any persistent data about the network and a reboot will clear the RAM copies. The Smart Energy profile feature Trust Center Swap-out uses this to securely replace the Trust Center and re-authenticate to it.

Returns

• EMBER_SUCCESS if it could allocate temporary buffers to store network information. EMBER_NO_BUFFERS otherwise.

emberStartWritingStackTokens#

EmberStatus emberStartWritingStackTokens (void )

Immediately write the value of stack tokens and then resume normal network operation by writing the stack tokens at appropriate intervals or changes in state. It has no effect unless a previous call was made to emberStopWritingStackTokens().

Returns

• EMBER_SUCCESS if it had previously unwritten tokens from a call to emberStopWritingStackTokens() that it now wrote to the token system. EMBER_INVALID_CALL otherwise.

emberWritingStackTokensEnabled#

bool emberWritingStackTokensEnabled (void )

Determine whether stack tokens will be written to persistent storage when they change. By default, it is set to true meaning the stack will update its internal tokens via HAL calls when the associated RAM values change.

Returns

• True if the device will update the persistent storage for tokens when values in RAM change. False otherwise.

emberApsCryptMessage#

EmberStatus emberApsCryptMessage (bool encrypt, EmberMessageBuffer * buffer, uint8_t apsHeaderEndIndex, EmberEUI64 remoteEui64)

Perform APS encryption/decryption of messages directly. Normally, the stack handles all APS encryption/decryption automatically and there is no need to call this function. If APS data is sent or received via some other means (such as over interpan), APS encryption/decryption must be done manually. If the decryption is performed, the Auxiliary security header and MIC will be removed from the message. If encrypting, the auxiliary header and MIC will be added to the message. This is only available on SOC platforms.

Returns

• EMBER_SUCCESS if encryption/decryption was performed successfully. An appropriate EmberStatus code on failure.

emberGetMfgSecurityConfig#

EmberStatus emberGetMfgSecurityConfig (EmberMfgSecurityStruct * settings)

Retrieve the security configuration stored in manufacturing tokens. It is only available on the 35x series. See emberSetMfgSecurityConfig() for more details.

Returns

• EMBER_SUCCESS if the tokens were successfully read. EmberStatus error code otherwise.

emberSetMfgSecurityConfig#

EmberStatus emberSetMfgSecurityConfig (uint32_t magicNumber, const EmberMfgSecurityStruct * settings)

Set the security configuration to be stored in manufacturing tokens. It is only available on the 35x series. This API must be called with care. Once set, a manufacturing token CANNOT BE UNSET without using the ISA3 tools and connecting the chip via JTAG. Additionally, a chip with read protection enabled cannot have its configuration changed without a full chip erase. Therefore, this provides a way to disallow access to the keys at runtime that cannot be undone.

To call this API, the magic number must be passed in corresponding to EMBER_MFG_SECURITY_CONFIG_MAGIC_NUMBER. This prevents accidental calls to this function when emberGetMfgSecurityConfig() was actually intended.

This function will disable external access to the actual key data used for decryption/encryption outside the stack. Attempts to call emberGetKey() or emberGetKeyTableEntry() will return the metadata (e.g., sequence number, associated EUI64, frame counters) but the key value may be modified, see below.

The stack always has access to the actual key data.

If the EmberKeySettings within the EmberMfgSecurityStruct are set to EMBER_KEY_PERMISSIONS_NONE, the key value will be set to zero when emberGetKey() or emberGetKeyTableEntry() is called. If the EmberKeySettings within the EmberMfgSecurityStruct are set to EMBER_KEY_PERMISSIONS_HASHING_ALLOWED, the AES-MMO hash of the key will replace the actual key data when calls to emberGetKey() or emberGetKeyTableEntry() are made. If the EmberKeySettings within the EmberMfgSecurityStruct are set to EMBER_KEY_PERMISSIONS_READING_ALLOWED, the actual key data is returned. This is the default value of the token.

Returns

• EMBER_BAD_ARGUMENT if the passed magic number is invalid. EMBER_INVALID_CALL if the chip does not support writing MFG tokens EMBER_SECURITY_CONFIGURATION_INVALID if there was an attempt to write an unerased manufacturing token (i.e., the token has already been set).

emberSetOutgoingNwkFrameCounter#

EmberStatus emberSetOutgoingNwkFrameCounter (uint32_t desiredValue)

Set the NWK layer outgoing frame counter (intended for device restoration purposes). Caveats:

• Can only be called before NetworkInit / FormNetwork / JoinNetwork, when emberNetworkState()==EMBER_NO_NETWORK.

• This function should be called before emberSetInitialSecurityState, and the EMBER_NO_FRAME_COUNTER_RESET bitmask should be added to the initial security bitmask when ::emberSetInitialSecuritState is called.

• If used in multi-network context, emberSetCurrentNetwork() must be called prior to calling this function.

Returns

• EMBER_SUCCESS if calling context is valid (emberNetworkState() == EMBER_NO_NETWORK) and desiredValue < MAX_INT32U_VALUE. Otherwise, EMBER_INVALID_CALL.

emberSetOutgoingApsFrameCounter#

EmberStatus emberSetOutgoingApsFrameCounter (uint32_t desiredValue)

Set the APS layer outgoing frame counter for Trust Center Link Key (intended for device restoration purposes). Caveats:

• Can only be called before NetworkInit / FormNetwork / JoinNetwork, when emberNetworkState()==EMBER_NO_NETWORK.

• This function should be called before emberSetInitialSecurityState, and the EMBER_NO_FRAME_COUNTER_RESET bitmask should be added to the initial security bitmask when ::emberSetInitialSecuritState is called.

• If used in multi-network context, call emberSetCurrentNetwork() prior to calling this function.

Returns

• EMBER_SUCCESS if calling context is valid (emberNetworkState() == EMBER_NO_NETWORK) and desiredValue < MAX_INT32U_VALUE. Otherwise, EMBER_INVALID_CALL.

emberAddTransientLinkKey#

EmberStatus emberAddTransientLinkKey (EmberEUI64 partnerEUI64, EmberKeyData * key)

Add a temporary link key for a joining device. The link key will be stored for emberTransientKeyTimeoutS seconds. After that time, the key will be removed. The removed key will need to be added again using this API before it can be used by a joining device again.

Returns

• EMBER_SUCCESS if the transient key has been added. EMBER_BAD_ARGUMENT if the parameters are invalid. EMBER_INVALID_CALL if the key type is invalid. EMBER_NO_BUFFERS if there are no buffers.

emberGetTransientKeyTableEntry#

EmberStatus emberGetTransientKeyTableEntry (uint8_t index, EmberTransientKeyData * transientKeyData)

Get the transient link key at the index specified in the transient key table.

Returns

• EMBER_SUCCESS if a valid transient key is returned. EMBER_BAD_ARGUMENT if no valid key is found at the specified index. EMBER_INVALID_CALL if transient key support is missing.

emberGetTransientLinkKey#

EmberStatus emberGetTransientLinkKey (const EmberEUI64 eui, EmberTransientKeyData * transientKeyData)

Get the transient link key for a device. This function searches the transient key table for an entry matching the EUI passed in.

Returns

• EMBER_SUCCESS if the transient key for the EUI is found. EMBER_BAD_ARGUMENT if the parameters are invalid. EMBER_INVALID_CALL if the this function is stubbed. EMBER_NOT_FOUND if the transient key for the EUI is not found.

emberClearTransientLinkKeys#

void emberClearTransientLinkKeys (void )

Clear all transient link keys from RAM.

emberHmacAesHash#

void emberHmacAesHash (const uint8_t * key, const uint8_t * data, uint8_t dataLength, uint8_t * result)

emberGetRejoinMode#

EmberApsRejoinMode emberGetRejoinMode (void )

emberSetRejoinMode#

void emberSetRejoinMode (EmberApsRejoinMode mode)

emberGetSecurityFrameCounter#

uint32_t emberGetSecurityFrameCounter (void )

emberGetApsFrameCounter#

uint32_t emberGetApsFrameCounter (void )

emberGetIncomingTcLinkKeyFrameCounter#

uint32_t emberGetIncomingTcLinkKeyFrameCounter (void )

emberSetIncomingTcLinkKeyFrameCounter#

void emberSetIncomingTcLinkKeyFrameCounter (uint32_t frameCounter)

emberAesMmoHashInit#

void emberAesMmoHashInit (EmberAesMmoHashContext * context)

This routine clears the passed context so that a new hash calculation can be performed.

emberAesMmoHashUpdate#

EmberStatus emberAesMmoHashUpdate (EmberAesMmoHashContext * context, uint32_t length, const uint8_t * data)

This routine processes the passed chunk of data and updates the hash calculation based on it. The data passed in MUST have a length that is a multiple of 16.

Returns

• An EmberStatus value indicating EMBER_SUCCESS if the hash was calculated successfully. EMBER_INVALID_CALL if the block size is not a multiple of 16 bytes, and EMBER_INDEX_OUT_OF_RANGE is returned when the data exceeds the maximum limits of the hash function.

emberAesMmoHashFinal#

EmberStatus emberAesMmoHashFinal (EmberAesMmoHashContext * context, uint32_t length, const uint8_t * finalData)

This routine processes the passed chunk of data (if non-NULL) and update the hash context that is passed in. In then performs the final calculations on the hash and returns the final answer in the result parameter of the EmberAesMmoHashContext structure. The length of the data passed in may be any value, it does not have to be a multiple of 16.

Returns

• An EmberStatus value indicating EMBER_SUCCESS if the hash was calculated successfully. EMBER_INVALID_CALL if the block size is not a multiple of 16 bytes, and EMBER_INDEX_OUT_OF_RANGE is returned when the data exceeds the maximum limits of the hash function.

emberAesHashSimple#

EmberStatus emberAesHashSimple (uint8_t totalLength, const uint8_t * data, uint8_t * result)

This is a convenience method when the hash data is less than 255 bytes. It inits, updates, and finalizes the hash in one function call.

Returns

• An EmberStatus value indicating EMBER_SUCCESS if the hash was calculated successfully. EMBER_INVALID_CALL if the block size is not a multiple of 16 bytes, and EMBER_INDEX_OUT_OF_RANGE is returned when the data exceeds the maximum limits of the hash function.

emberCcmEncryptAndTag#

EmberStatus emberCcmEncryptAndTag (uint8_t * nonce, uint8_t * authData, uint16_t authlen, uint8_t * encryptData, uint16_t encryptlen, uint8_t * micResult)

performs aes-ccm encryption and tagging, producing an encrypted message and a MIC

Returns

• EMBER_SUCCESS or other EmberStatus indicating a failure

emberCcmAuthDecrypt#

EmberStatus emberCcmAuthDecrypt (uint8_t * nonce, uint8_t * authData, uint16_t authlen, uint8_t * encryptData, uint16_t encryptlen, uint8_t * mic)

performs an authenticated decryption on an encrypted message, doing the decryption in place

Returns

• EMBER_SUCCESS on successful authentication and decryption, EMBER_AUTH_FAILURE if the calculated MIC does not match what was passed

emberCcmEncryptAndTagPacket#

EmberStatus emberCcmEncryptAndTagPacket (uint8_t * nonce, uint8_t * packet, uint16_t authlen, uint16_t encryptlen, micResult)

calculates a message integrity code and performs ccm encryption on a flat packet. Assumes the packet is formatted AUTH_DATA | ENCRYPT_DATA. Performs encryption in place

Returns

• EMBER_SUCCESS or other EmberStatus indicating a failure

Note

• packet must be large enough to append the resulting MIC to the end of the buffer (len(packet) >= authlen + encryptlen + miclen)

emberCcmAuthDecryptPacket#

EmberStatus emberCcmAuthDecryptPacket (uint8_t * nonce, uint8_t * packet, uint16_t authlen, uint16_t encryptlen, encryptlen)

performs an authenticated decryption on a flat packet, assuming the format AUTH_DATA | ENCRYPT_DATA' | MIC, where ENCRYPT_DATA' is the message payload before decryption

Returns

• EMBER_SUCCESS on successful authentication and decryption, EMBER_AUTH_FAILURE if the calculated MIC does not match what was passed

emberCcmCalculateAndEncryptMic#

void emberCcmCalculateAndEncryptMic (uint8_t * nonce, uint8_t * authData, uint16_t authlen, uint8_t * payload, uint16_t payloadlen, uint8_t * micResult)

calculates the CCM* MIC of a given message without outputting the ciphertext.

Returns

• EMBER_SUCCESS or other EmberStatus indicating a failure

emberCcmEncryptBytes#

void emberCcmEncryptBytes (uint8_t * bytes, uint16_t length, uint8_t * nonce)

performs a CCM* encryption in place without tag (tag length zero). This operation basically reduces to AES-CTR with an IV constructed from nonce, and is thus symmetric for both encryption and decryption.

Note

• this function previously had an input parameter 'blockCount', which got removed since the function didn't adhere to its intent when setting blockCount to any other value then 1.

Returns

• EMBER_SUCCESS or other EmberStatus indicating a failure

emberGetStrongRandomNumberArray#

EmberStatus emberGetStrongRandomNumberArray (uint16_t * randomNumber, uint8_t count)

Used to get ::count number of true random numbers. The method of obtaining and quality of the random varies by chip family and the configuration used. For high security applications, please verify that that the generator's properties match your needs.

Returns

• An EmberStatus value.

  • EMBER_SUCCESS If success.

  • EMBER_INSUFFICIENT_RANDOM_DATA In case of any error.

emberGetStrongRandomEntropySource#

EmberEntropySource emberGetStrongRandomEntropySource (void )

Returns the entropy source used for true random number generation.

Returns

• An EmberEntropySource value.

  • EMBER_ENTROPY_SOURCE_ERROR If there is any error identifying the entroypy source.

  • EMBER_ENTROPY_SOURCE_RADIO Entropy source is the chips that support this. The method of obtaining and quality of the random varies by chip family. For high security applications, please verify that that the generator's properties match the requirements.

  • EMBER_ENTROPY_SOURCE_MBEDTLS_TRNG Entropy source is the TRNG hardware module (if applicable) and the interface driver is powered by mbed TLS.

  • EMBER_ENTROPY_SOURCE_MBEDTLS Entropy source is not the TRNG hardware module but the interface driver is powered by mbed TLS.