Class EmberTokensManager

Index

Constructors

Methods

getCreatorFromNvm3Key ncpUsesPSAKeyStorage restoreKeysFromData restoreTokens saveKeysToData saveTokens writeNcpTokensToZigbeedTokens

Constructors

constructor

new EmberTokensManager(): EmberTokensManager
Returns EmberTokensManager

Methods

`Static`getCreatorFromNvm3Key

getCreatorFromNvm3Key(nvm3Key: number): number
Matcher for Zigbeed tokens.
Parameters
- nvm3Key: number
Returns number
- Defined in src/adapter/ember/adapter/tokensManager.ts:316

`Static`ncpUsesPSAKeyStorage

ncpUsesPSAKeyStorage(ezsp: Ezsp): Promise<boolean>
Host-only API to check whether the NCP uses key storage.
Parameters
- ezsp: Ezsp
Returns Promise<boolean>
false if keys are in classic key storage, and true if they are located in PSA key storage.
- Defined in src/adapter/ember/adapter/tokensManager.ts:301

`Static`restoreKeysFromData

restoreKeysFromData(
    ezsp: Ezsp,
    tokenData: EmberTokenData,
    nvm3Key: number,
    index: number,
): Promise<SLStatus>
Parameters
- ezsp: Ezsp
- tokenData: EmberTokenData
- nvm3Key: number
  uint32_t
- index: number
  uint8_t
Returns Promise<SLStatus>
From
sli_zigbee_af_trust_center_backup_restore_keys_from_data
- Defined in src/adapter/ember/adapter/tokensManager.ts:619

`Static`restoreTokens

restoreTokens(ezsp: Ezsp, inBuffer: Buffer): Promise<SLStatus>
Restores tokens. Only for NVM3-based NCP. XXX: If a previous backup from an NVM3 NCP is attempted on a non-NVM3 NCP, it should just fail (LIBRARY_NOT_PRESENT all on token-related functions).
Parameters
- ezsp: Ezsp
- inBuffer: Buffer
Returns Promise<SLStatus>
SLStatus status code

See
EmberTokensManager.saveTokens() for format
- Defined in src/adapter/ember/adapter/tokensManager.ts:430

`Static`saveKeysToData

saveKeysToData(
    ezsp: Ezsp,
    tokenData: EmberTokenData,
    nvm3Key: number,
    index: number,
): Promise<SLStatus>
Secure key storage needs to export the keys first so backup file has them.
Parameters
- ezsp: Ezsp
- tokenData: EmberTokenData
  EmberTokenData* [IN/OUT]
- nvm3Key: number
  uint32_t
- index: number
  uint8_t
Returns Promise<SLStatus>
- Defined in src/adapter/ember/adapter/tokensManager.ts:487

`Static`saveTokens

saveTokens(
ezsp: Ezsp,
localEui64: Buffer,
): Promise<undefined | Buffer<ArrayBufferLike>>
Saves tokens. Only for NVM3-based NCP.

The binary file format to save the tokens are

Number of Tokens (1 byte) Token0 (4 bytes) Token0Size(1 byte) Token0ArraySize(1 byte) Token0Data(Token0Size * Token0ArraySize) : : TokenM (4 bytes) TokenMSize(1 byte) TokenMArraySize(1 byte) TokenMData(TokenMSize * TokenMArraySize)
Parameters
- ezsp: Ezsp
- localEui64: Buffer
  Used in place of blank restoredEui64 keys
Returns Promise<undefined | Buffer<ArrayBufferLike>>
Saved tokens buffer or null.
- Defined in src/adapter/ember/adapter/tokensManager.ts:341

`Static`writeNcpTokensToZigbeedTokens

writeNcpTokensToZigbeedTokens(ezsp: Ezsp, inBuffer: Buffer): Promise<SLStatus>
Updates zigbeed tokens from a backup of NCP tokens.
Parameters
- ezsp: Ezsp
- inBuffer: Buffer
Returns Promise<SLStatus>
SLStatus status code
- Defined in src/adapter/ember/adapter/tokensManager.ts:744