Interface KeySetReadResponse

This command shall be generated in response to the KeySetRead command, if a valid Group Key Set was found. It shall contain the configuration of the requested Group Key Set, with the EpochKey0, EpochKey1 and EpochKey2 key contents replaced by null.

See

MatterSpecification.v13.Core § 11.2.7.3

interface KeySetReadResponse {
    groupKeySet: TypeFromFields<{
        epochKey0: FieldType<null | Uint8Array>;
        epochKey1: FieldType<null | Uint8Array>;
        epochKey2: FieldType<null | Uint8Array>;
        epochStartTime0: FieldType<null | number | bigint>;
        epochStartTime1: FieldType<null | number | bigint>;
        epochStartTime2: FieldType<null | number | bigint>;
        groupKeyMulticastPolicy: OptionalFieldType<GroupKeyManagement.GroupKeyMulticastPolicy>;
        groupKeySecurityPolicy: FieldType<GroupKeyManagement.GroupKeySecurityPolicy>;
        groupKeySetId: FieldType<number>;
    }>;
}

Hierarchy (view full)

Properties

groupKeySet

Properties

groupKeySet

groupKeySet: TypeFromFields<{
    epochKey0: FieldType<null | Uint8Array>;
    epochKey1: FieldType<null | Uint8Array>;
    epochKey2: FieldType<null | Uint8Array>;
    epochStartTime0: FieldType<null | number | bigint>;
    epochStartTime1: FieldType<null | number | bigint>;
    epochStartTime2: FieldType<null | number | bigint>;
    groupKeyMulticastPolicy: OptionalFieldType<GroupKeyManagement.GroupKeyMulticastPolicy>;
    groupKeySecurityPolicy: FieldType<GroupKeyManagement.GroupKeySecurityPolicy>;
    groupKeySetId: FieldType<number>;
}>

Type declaration

  • epochKey0: FieldType<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: FieldType<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: FieldType<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: FieldType<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: FieldType<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: FieldType<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

  • groupKeyMulticastPolicy: OptionalFieldType<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: FieldType<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: FieldType<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