zigbee-on-host
    Preparing search index...

    Type Alias APSDeviceKeyPairSet

    see 05-3474-23 Table 4-35 A set of key-pair descriptors containing link keys shared with other devices.

    type APSDeviceKeyPairSet = {
        apsLinkKeyType: number;
        deviceAddress: bigint;
        featuresCapabilities: number;
        incomingFrameCounter: number;
        initialJoinAuthentication: number;
        isVirtualDevice: boolean;
        keyAttributes: number;
        keyNegotiationMethod: number;
        keyNegotiationState: number;
        linkKey: Buffer;
        outgoingFrameCounter: number;
        passphrase?: Buffer;
        passphraseUpdateAllowed: boolean;
        postJoinKeyUpdateMethod: number;
        timeout: number;
        trustCenterSwapOutLinkKey?: Buffer;
        verifiedFrameCounter: boolean;
    }
    Index

    Properties

    apsLinkKeyType deviceAddress featuresCapabilities incomingFrameCounter initialJoinAuthentication isVirtualDevice keyAttributes keyNegotiationMethod keyNegotiationState linkKey outgoingFrameCounter passphrase? passphraseUpdateAllowed postJoinKeyUpdateMethod timeout trustCenterSwapOutLinkKey? verifiedFrameCounter

    Properties

    apsLinkKeyType: number

    The type of link key in use. This will determine the security policies associated with sending and receiving APS messages.

    • 0x00 = Unique Link Key
    • 0x01 = Global Link Key

    Default: 0x00

    deviceAddress: bigint

    Identifies the address of the entity with which this key-pair is shared.

    featuresCapabilities: number

    A set of feature flags pertaining to this security material or denoting the peer’s support for specific APS security features:

    • Bit #0: Frame Counter Synchronization Support When set to ‘1' the peer device supports APS frame counter synchronization; else, when set to '0’, the peer device does not support APS frame counter synchronization.
    • Bits #1..#7 are reserved and SHALL be set to '0' by implementations of the current Revision of this specification and ignored when processing.

    0x00-0x01, default: 0x00

    incomingFrameCounter: number

    Incoming frame counter value corresponding to DeviceAddress. uint32_t

    initialJoinAuthentication: number
    • 0x00 = NO_AUTHENTICATION
    • 0x01 = INSTALL_CODE_KEY
    • 0x02 = ANONYMOUS_KEY_NEGOTIATION
    • 0x03 = KEY_NEGOTIATION_WITH_AUTHENTICATION

    Default: 0x00

    isVirtualDevice: boolean

    If set to TRUE, the device identified by DeviceAddress is a Zigbee Direct Virtual Device (ZVD). A Trust Center SHALL NOT send network keys to this device.

    default: false

    keyAttributes: number

    This indicates attributes about the key.

    • 0x00 = PROVISIONAL_KEY
    • 0x01 = UNVERIFIED_KEY
    • 0x02 = VERIFIED_KEY
    keyNegotiationMethod: number

    The value of the selected TLV sent to the device. 0x00-0x08, default: 0x00 (APS Request Key method)

    keyNegotiationState: number
    • 0x00 = NO_KEY_NEGOTIATION
    • 0x01 = START_KEY_NEGOTIATION
    • 0x02 = COMPLETE_KEY_NEGOTIATION

    default: 0x00

    linkKey: Buffer

    The actual value of the link key.

    outgoingFrameCounter: number

    Outgoing frame counter for use with this link key. uint32_t

    passphrase?: Buffer

    A value that is used by both sides during dynamic key negotiation. An unset value means this key-pair entry was not dynamically negotiated. Any other value indicates the entry was dynamically negotiated.

    passphraseUpdateAllowed: boolean

    This indicates whether the particular KeyPair passphrase MAY be updated for the device. A passphrase update is normally only allowed shortly after joining. See section 4.7.2.1.

    default: true

    postJoinKeyUpdateMethod: number

    This indicates what Link Key update method was used after the device joined the network.

    • 0x00 = Not Updated
    • 0x01 = Key Request Method
    • 0x02 = Unauthenticated Key Negotiation
    • 0x03 = Authenticated Key Negotiation
    • 0x04 = Application Defined Certificate Based Mutual Authentication
    timeout: number

    The timeout, in seconds, for the specified key. When this timeout expires, the key SHALL be marked EXPIRED_KEY in the KeyAttributes and the LinkKey value SHALL not be used for encryption of messages. A value of 0xFFFF for the Timeout mean the key never expires.

    default: 0xffff

    trustCenterSwapOutLinkKey?: Buffer

    The key used to indicate a Trust Center Swap-out has occurred. This key SHALL always be set to a hash of the LinkKey element. If the LinkKey is updated, then this value MUST be updated as well. See section 4.7.4.1.2.4. If the entry in the apsDeviceKeyPairSet is an application link key (where local device and the partner are not Trust Centers), implementations MAY elide this element for that entry.

    verifiedFrameCounter: boolean

    Indicates whether the incoming frame counter value has been verified through a challenge response.

    default: false

    Settings

    Member Visibility

    On This Page

    Properties