Interface GroupKeySet

See

MatterSpecification.v13.Core § 11.2.5.4

interface GroupKeySet {
    epochKey0: null | Uint8Array;
    epochKey1: null | Uint8Array;
    epochKey2: null | Uint8Array;
    epochStartTime0: null | number | bigint;
    epochStartTime1: null | number | bigint;
    epochStartTime2: null | number | bigint;
    groupKeyMulticastPolicy?: GroupKeyManagement.GroupKeyMulticastPolicy;
    groupKeySecurityPolicy: GroupKeyManagement.GroupKeySecurityPolicy;
    groupKeySetId: number;
}

Hierarchy (view full)

Properties

epochKey0 epochKey1 epochKey2 epochStartTime0 epochStartTime1 epochStartTime2 groupKeyMulticastPolicy? groupKeySecurityPolicy groupKeySetId

Properties

epochKey0

epochKey0: null | Uint8Array

This field, if not null, shall be the root credential used in the derivation of an operational group key for epoch slot 0 of the given group key set. If EpochKey0 is not null, EpochStartTime0 shall NOT be null.

See

MatterSpecification.v13.Core § 11.2.5.4.3

epochKey1

epochKey1: null | Uint8Array

This field, if not null, shall be the root credential used in the derivation of an operational group

key for epoch slot 1 of the given group key set. If EpochKey1 is not null, EpochStartTime1 shall NOT be null.

See

MatterSpecification.v13.Core § 11.2.5.4.5

epochKey2

epochKey2: null | Uint8Array

This field, if not null, shall be the root credential used in the derivation of an operational group key for epoch slot 2 of the given group key set. If EpochKey2 is not null, EpochStartTime2 shall NOT be null.

See

MatterSpecification.v13.Core § 11.2.5.4.7

epochStartTime0

epochStartTime0: null | number | bigint

This field, if not null, shall define when EpochKey0 becomes valid as specified by Section 4.16.3, “Epoch Keys”. Units are absolute UTC time in microseconds encoded using the epoch-us representation.

See

MatterSpecification.v13.Core § 11.2.5.4.4

epochStartTime1

epochStartTime1: null | number | bigint

This field, if not null, shall define when EpochKey1 becomes valid as specified by Section 4.16.3, “Epoch Keys”. Units are absolute UTC time in microseconds encoded using the epoch-us representation.

See

MatterSpecification.v13.Core § 11.2.5.4.6

epochStartTime2

epochStartTime2: null | number | bigint

This field, if not null, shall define when EpochKey2 becomes valid as specified by Section 4.16.3, “Epoch Keys”. Units are absolute UTC time in microseconds encoded using the epoch-us representation.

See

MatterSpecification.v13.Core § 11.2.5.4.8

OptionalgroupKeyMulticastPolicy

groupKeyMulticastPolicy?: GroupKeyManagement.GroupKeyMulticastPolicy

This field specifies how the IPv6 Multicast Address shall be formed for groups using this operational group key set.

The PerGroupID method maximizes filtering of multicast messages, so that receiving nodes receive only multicast messages for groups to which they are subscribed.

The AllNodes method minimizes the number of multicast addresses to which a receiver node needs to subscribe.

NOTE

Support for GroupKeyMulticastPolicy is provisional. Correct default behavior is that implied by value PerGroupID.

See

MatterSpecification.v13.Core § 11.2.5.4.9

groupKeySecurityPolicy

groupKeySecurityPolicy: GroupKeyManagement.GroupKeySecurityPolicy

This field shall provide the security policy for an operational group key set.

When CacheAndSync is not supported in the FeatureMap of this cluster, any action attempting to set CacheAndSync in the GroupKeySecurityPolicy field shall fail with an INVALID_COMMAND error.

See

MatterSpecification.v13.Core § 11.2.5.4.2

groupKeySetId

groupKeySetId: number

This field shall provide the fabric-unique index for the associated group key set, as specified in Section 4.16.3.5.1, “Group Key Set ID”.

See

MatterSpecification.v13.Core § 11.2.5.4.1

Settings

Member Visibility

On This Page

Properties