@matter/types 0.11.0-alpha.0-20241005-e3e4e4a7a

package/dist/esm/clusters/group-key-management.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"group-key-management.d.ts","sourceRoot":"","sources":["../../../src/clusters/group-key-management.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,6CAA6C;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EACH,6BAA6B,EAC7B,qBAAqB,EACrB,cAAc,EACd,OAAO,EAEV,MAAM,uBAAuB,CAAC;AAM/B,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAMrD,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGpC,yBAAiB,kBAAkB,CAAC;IAChC;;;;OAIG;IACH,KAAY,OAAO;QACf;;;;WAIG;QACH,YAAY,iBAAiB;KAChC;IAED;;OAEG;IACI,MAAM,cAAc;QACvB;;;;WAIG;;QAGH;;;;;;;WAOG;;;MAIL,CAAC;IAEH;;OAEG;IACH,UAAiB,WAAY,SAAQ,cAAc,CAAC,OAAO,cAAc,CAAC;KAAG;IAE7E;;OAEG;IACI,MAAM,eAAe;QACxB;;;;WAIG;;QAGH;;;;WAIG;;QAGH;;;;;WAKG;;;MAIL,CAAC;IAEH;;OAEG;IACH,UAAiB,YAAa,SAAQ,cAAc,CAAC,OAAO,eAAe,CAAC;KAAG;IAE/E;;OAEG;IACH,KAAY,sBAAsB;QAC9B;;WAEG;QACH,UAAU,IAAI;QAEd;;WAEG;QACH,YAAY,IAAI;KACnB;IAED;;OAEG;IACH,KAAY,uBAAuB;QAC/B;;;;;;WAMG;QACH,UAAU,IAAI;QAEd;;;;;;WAMG;QACH,QAAQ,IAAI;KACf;IAED;;OAEG;IACI,MAAM,cAAc;QACvB;;;;;WAKG;;QAGH;;;;;;;WAOG;;QAGH;;;;;WAKG;;QAGH;;;;;WAKG;;QAGH;;;;;;WAMG;;QAGH;;;;;WAKG;;QAGH;;;;;WAKG;;QAGH;;;;;WAKG;;QAGH;;;;;;;;;;;;;;;WAeG;;MAEL,CAAC;IAEH;;OAEG;IACH,UAAiB,WAAY,SAAQ,cAAc,CAAC,OAAO,cAAc,CAAC;KAAG;IAE7E;;;;OAIG;IACI,MAAM,qBAAqB;;YAhG9B;;;;;eAKG;;YAGH;;;;;;;eAOG;;YAGH;;;;;eAKG;;YAGH;;;;;eAKG;;YAGH;;;;;;eAMG;;YAGH;;;;;eAKG;;YAGH;;;;;eAKG;;YAGH;;;;;eAKG;;YAGH;;;;;;;;;;;;;;;eAeG;;;MAcqF,CAAC;IAE7F;;;;OAIG;IACH,UAAiB,kBAAmB,SAAQ,cAAc,CAAC,OAAO,qBAAqB,CAAC;KAAG;IAE3F;;;;OAIG;IACI,MAAM,oBAAoB;;MAAuD,CAAC;IAEzF;;;;OAIG;IACH,UAAiB,iBAAkB,SAAQ,cAAc,CAAC,OAAO,oBAAoB,CAAC;KAAG;IAEzF;;;;;;OAMG;IACI,MAAM,qBAAqB;;YA9H9B;;;;;eAKG;;YAGH;;;;;;;eAOG;;YAGH;;;;;eAKG;;YAGH;;;;;eAKG;;YAGH;;;;;;eAMG;;YAGH;;;;;eAKG;;YAGH;;;;;eAKG;;YAGH;;;;;eAKG;;YAGH;;;;;;;;;;;;;;;eAeG;;;MA4CqF,CAAC;IAE7F;;;;;;OAMG;IACH,UAAiB,kBAAmB,SAAQ,cAAc,CAAC,OAAO,qBAAqB,CAAC;KAAG;IAE3F;;;;OAIG;IACI,MAAM,sBAAsB;;MAAuD,CAAC;IAE3F;;;;OAIG;IACH,UAAiB,mBAAoB,SAAQ,cAAc,CAAC,OAAO,sBAAsB,CAAC;KAAG;IAE7F;;;;;OAKG;IACI,MAAM,+BAA+B;QACxC;;;;;;;WAOG;;MAEL,CAAC;IAEH;;;;;OAKG;IACH,UAAiB,4BAA6B,SAAQ,cAAc,CAAC,OAAO,+BAA+B,CAAC;KAAG;IAE/G;;OAEG;IACI,MAAM,IAAI;;;;;YAMT;;;;eAIG;;;;YAKH;;;;;eAKG;;gBA7SP;;;;mBAIG;;gBAGH;;;;;;;mBAOG;;;;YAsSC;;;;;;;;;;;eAWG;;gBAlSP;;;;mBAIG;;gBAGH;;;;mBAIG;;gBAGH;;;;;mBAKG;;;;YAkRC;;;;;;;eAOG;;YAGH;;;;;;eAMG;;;;YAKH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAiEG;;;oBAnTP;;;;;uBAKG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;;uBAMG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;;;;;;;;;;;uBAeG;;;;YAoOC;;;;;;;;;;;;;eAaG;;;;;oBAnUP;;;;;uBAKG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;;uBAMG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;;;;;;;;;;;uBAeG;;;;YA0PC;;;;;;;;;;;;;;;;;;;;;;eAsBG;;;;YASH;;;;;;;;;;;;;eAaG;;gBA1NP;;;;;;;mBAOG;;;;QA6NH;;;WAGG;;KAEL,CAAC;IAEH;;OAEG;IACI,MAAM,eAAe;;;;;YAlNpB;;;;eAIG;;;;YAKH;;;;;eAKG;;gBA7SP;;;;mBAIG;;gBAGH;;;;;;;mBAOG;;;;YAsSC;;;;;;;;;;;eAWG;;gBAlSP;;;;mBAIG;;gBAGH;;;;mBAIG;;gBAGH;;;;;mBAKG;;;;YAkRC;;;;;;;eAOG;;YAGH;;;;;;eAMG;;;;YAKH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAiEG;;;oBAnTP;;;;;uBAKG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;;uBAMG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;;;;;;;;;;;uBAeG;;;;YAoOC;;;;;;;;;;;;;eAaG;;;;;oBAnUP;;;;;uBAKG;;oBAGH;;;;;;;uBAOG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;;uBAMG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;uBAKG;;oBAGH;;;;;;;;;;;;;;;uBAeG;;;;YA0PC;;;;;;;;;;;;;;;;;;;;;;eAsBG;;;;YASH;;;;;;;;;;;;;eAaG;;gBA1NP;;;;;;;mBAOG;;;;QA6NH;;;WAGG;;UAO4C,CAAC;IAEpD;;;;;;;;;;;;;;;OAeG;IACH,UAAiB,OAAQ,SAAQ,QAAQ,CAAC,OAAO,eAAe,CAAC;KAAG;IAE7D,MAAM,OAAO,EAAE,OAAyB,CAAC;IACzC,MAAM,QAAQ,SAAU,CAAC;CACnC;AAED,MAAM,MAAM,yBAAyB,GAAG,kBAAkB,CAAC,OAAO,CAAC;AACnE,eAAO,MAAM,yBAAyB,4BAA6B,CAAC"}

package/dist/esm/clusters/group-key-management.js

@@ -0,0 +1,387 @@
+/**
+ * @license
+ * Copyright 2022-2024 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
+import { BitFlag } from "../schema/BitmapSchema.js";
+import {
+  WritableFabricScopedAttribute,
+  FabricScopedAttribute,
+  FixedAttribute,
+  Command,
+  TlvNoResponse
+} from "../cluster/Cluster.js";
+import { TlvArray } from "../tlv/TlvArray.js";
+import { TlvField, TlvObject, TlvOptionalField } from "../tlv/TlvObject.js";
+import { TlvGroupId } from "../datatype/GroupId.js";
+import { TlvUInt16, TlvEnum, TlvEpochUs } from "../tlv/TlvNumber.js";
+import { TlvFabricIndex } from "../datatype/FabricIndex.js";
+import { AccessLevel } from "#model";
+import { TlvEndpointNumber } from "../datatype/EndpointNumber.js";
+import { TlvString, TlvByteString } from "../tlv/TlvString.js";
+import { TlvNullable } from "../tlv/TlvNullable.js";
+import { TlvNoArguments } from "../tlv/TlvNoArguments.js";
+import { ClusterRegistry } from "../cluster/ClusterRegistry.js";
+var GroupKeyManagement;
+((GroupKeyManagement2) => {
+  let Feature;
+  ((Feature2) => {
+    Feature2["CacheAndSync"] = "CacheAndSync";
+  })(Feature = GroupKeyManagement2.Feature || (GroupKeyManagement2.Feature = {}));
+  GroupKeyManagement2.TlvGroupKeyMap = TlvObject({
+    /**
+     * This field uniquely identifies the group within the scope of the given Fabric.
+     *
+     * @see {@link MatterSpecification.v13.Core} § 11.2.5.3.1
+     */
+    groupId: TlvField(1, TlvGroupId),
+    /**
+     * This field references the set of group keys that generate operational group keys for use with this group, as
+     * specified in Section 4.16.3.5.1, “Group Key Set ID”.
+     *
+     * A GroupKeyMapStruct shall NOT accept GroupKeySetID of 0, which is reserved for the IPK.
+     *
+     * @see {@link MatterSpecification.v13.Core} § 11.2.5.3.2
+     */
+    groupKeySetId: TlvField(2, TlvUInt16.bound({ min: 1 })),
+    fabricIndex: TlvField(254, TlvFabricIndex)
+  });
+  GroupKeyManagement2.TlvGroupInfoMap = TlvObject({
+    /**
+     * This field uniquely identifies the group within the scope of the given Fabric.
+     *
+     * @see {@link MatterSpecification.v13.Core} § 11.2.5.5.1
+     */
+    groupId: TlvField(1, TlvGroupId),
+    /**
+     * This field provides the list of Endpoint IDs on the Node to which messages to this group shall be forwarded.
+     *
+     * @see {@link MatterSpecification.v13.Core} § 11.2.5.5.2
+     */
+    endpoints: TlvField(2, TlvArray(TlvEndpointNumber, { minLength: 1 })),
+    /**
+     * This field provides a name for the group. This field shall contain the last GroupName written for a given
+     * GroupId on any Endpoint via the Groups cluster.
+     *
+     * @see {@link MatterSpecification.v13.Core} § 11.2.5.5.3
+     */
+    groupName: TlvOptionalField(3, TlvString.bound({ maxLength: 16 })),
+    fabricIndex: TlvField(254, TlvFabricIndex)
+  });
+  let GroupKeySecurityPolicy;
+  ((GroupKeySecurityPolicy2) => {
+    GroupKeySecurityPolicy2[GroupKeySecurityPolicy2["TrustFirst"] = 0] = "TrustFirst";
+    GroupKeySecurityPolicy2[GroupKeySecurityPolicy2["CacheAndSync"] = 1] = "CacheAndSync";
+  })(GroupKeySecurityPolicy = GroupKeyManagement2.GroupKeySecurityPolicy || (GroupKeyManagement2.GroupKeySecurityPolicy = {}));
+  let GroupKeyMulticastPolicy;
+  ((GroupKeyMulticastPolicy2) => {
+    GroupKeyMulticastPolicy2[GroupKeyMulticastPolicy2["PerGroupId"] = 0] = "PerGroupId";
+    GroupKeyMulticastPolicy2[GroupKeyMulticastPolicy2["AllNodes"] = 1] = "AllNodes";
+  })(GroupKeyMulticastPolicy = GroupKeyManagement2.GroupKeyMulticastPolicy || (GroupKeyManagement2.GroupKeyMulticastPolicy = {}));
+  GroupKeyManagement2.TlvGroupKeySet = TlvObject({
+    /**
+     * 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 {@link MatterSpecification.v13.Core} § 11.2.5.4.1
+     */
+    groupKeySetId: TlvField(0, TlvUInt16),
+    /**
+     * 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 {@link MatterSpecification.v13.Core} § 11.2.5.4.2
+     */
+    groupKeySecurityPolicy: TlvField(1, TlvEnum()),
+    /**
+     * 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 {@link MatterSpecification.v13.Core} § 11.2.5.4.3
+     */
+    epochKey0: TlvField(2, TlvNullable(TlvByteString.bound({ length: 16 }))),
+    /**
+     * 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 {@link MatterSpecification.v13.Core} § 11.2.5.4.4
+     */
+    epochStartTime0: TlvField(3, TlvNullable(TlvEpochUs)),
+    /**
+     * 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 {@link MatterSpecification.v13.Core} § 11.2.5.4.5
+     */
+    epochKey1: TlvField(4, TlvNullable(TlvByteString.bound({ length: 16 }))),
+    /**
+     * 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 {@link MatterSpecification.v13.Core} § 11.2.5.4.6
+     */
+    epochStartTime1: TlvField(5, TlvNullable(TlvEpochUs)),
+    /**
+     * 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 {@link MatterSpecification.v13.Core} § 11.2.5.4.7
+     */
+    epochKey2: TlvField(6, TlvNullable(TlvByteString.bound({ length: 16 }))),
+    /**
+     * 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 {@link MatterSpecification.v13.Core} § 11.2.5.4.8
+     */
+    epochStartTime2: TlvField(7, TlvNullable(TlvEpochUs)),
+    /**
+     * 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 {@link MatterSpecification.v13.Core} § 11.2.5.4.9
+     */
+    groupKeyMulticastPolicy: TlvOptionalField(8, TlvEnum())
+  });
+  GroupKeyManagement2.TlvKeySetWriteRequest = TlvObject({ groupKeySet: TlvField(0, GroupKeyManagement2.TlvGroupKeySet) });
+  GroupKeyManagement2.TlvKeySetReadRequest = TlvObject({ groupKeySetId: TlvField(0, TlvUInt16) });
+  GroupKeyManagement2.TlvKeySetReadResponse = TlvObject({ groupKeySet: TlvField(0, GroupKeyManagement2.TlvGroupKeySet) });
+  GroupKeyManagement2.TlvKeySetRemoveRequest = TlvObject({ groupKeySetId: TlvField(0, TlvUInt16) });
+  GroupKeyManagement2.TlvKeySetReadAllIndicesResponse = TlvObject({
+    /**
+     * This field references the set of group keys that generate operational group keys for use with the accessing
+     * fabric.
+     *
+     * Each entry in GroupKeySetIDs is a GroupKeySetID field.
+     *
+     * @see {@link MatterSpecification.v13.Core} § 11.2.7.6.1
+     */
+    groupKeySetIDs: TlvField(0, TlvArray(TlvUInt16))
+  });
+  GroupKeyManagement2.Base = MutableCluster.Component({
+    id: 63,
+    name: "GroupKeyManagement",
+    revision: 2,
+    features: {
+      /**
+       * CacheAndSync
+       *
+       * The ability to support CacheAndSync security policy and MCSP.
+       */
+      cacheAndSync: BitFlag(0)
+    },
+    attributes: {
+      /**
+       * This attribute is a list of GroupKeyMapStruct entries. Each entry associates a logical Group Id with a
+       * particular group key set.
+       *
+       * @see {@link MatterSpecification.v13.Core} § 11.2.6.1
+       */
+      groupKeyMap: WritableFabricScopedAttribute(
+        0,
+        TlvArray(GroupKeyManagement2.TlvGroupKeyMap),
+        { persistent: true, default: [], writeAcl: AccessLevel.Manage }
+      ),
+      /**
+       * This attribute is a list of GroupInfoMapStruct entries. Each entry provides read-only information about
+       * how a given logical Group ID maps to a particular set of endpoints, and a name for the group. The
+       * content of this attribute reflects data managed via the Groups cluster (see AppClusters), and is in
+       * general terms referred to as the 'node-wide Group Table'.
+       *
+       * The GroupTable shall NOT contain any entry whose GroupInfoMapStruct has an empty Endpoints list. If a
+       * RemoveGroup or RemoveAllGroups command causes the removal of a group mapping from its last mapped
+       * endpoint, the entire GroupTable entry for that given GroupId shall be removed.
+       *
+       * @see {@link MatterSpecification.v13.Core} § 11.2.6.2
+       */
+      groupTable: FabricScopedAttribute(1, TlvArray(GroupKeyManagement2.TlvGroupInfoMap), { default: [] }),
+      /**
+       * Indicates the maximum number of groups that this node supports per fabric. The value of this attribute
+       * shall be set to be no less than the required minimum supported groups as specified in Group Limits. The
+       * length of the GroupKeyMap and GroupTable list attributes shall NOT exceed the value of the
+       * MaxGroupsPerFabric attribute multiplied by the number of supported fabrics.
+       *
+       * @see {@link MatterSpecification.v13.Core} § 11.2.6.3
+       */
+      maxGroupsPerFabric: FixedAttribute(2, TlvUInt16, { default: 0 }),
+      /**
+       * Indicates the maximum number of group key sets this node supports per fabric. The value of this
+       * attribute shall be set according to the minimum number of group key sets to support as specified in
+       * Group Limits.
+       *
+       * @see {@link MatterSpecification.v13.Core} § 11.2.6.4
+       */
+      maxGroupKeysPerFabric: FixedAttribute(3, TlvUInt16.bound({ min: 1 }), { default: 1 })
+    },
+    commands: {
+      /**
+       * This command is used by Administrators to set the state of a given Group Key Set, including atomically
+       * updating the state of all epoch keys.
+       *
+       * Effect on Receipt
+       *
+       * The following validations shall be done against the content of the GroupKeySet field:
+       *
+       *   • If the EpochKey0 field is null or its associated EpochStartTime0 field is null, then this command
+       *     shall fail with an INVALID_COMMAND status code responded to the client.
+       *
+       *   • If the EpochKey0 field’s length is not exactly 16 bytes, then this command shall fail with a
+       *     CONSTRAINT_ERROR status code responded to the client.
+       *
+       *   • If the EpochStartTime0 is set to 0, then this command shall fail with an INVALID_COMMAND status code
+       *     responded to the client. Note that internally, a GroupKeySetStruct’s EpochStartTime0 may be set to
+       *     zero, due to the behavior of the AddNOC command which synthesizes a GroupKeySetStruct (see
+       *     IPKValue). However, the value 0 is illegal in the GroupKeySet field sent by a client.
+       *
+       *   • If the EpochKey1 field is not null, then the EpochKey0 field shall NOT be null. Otherwise this
+       *     command shall fail with an INVALID_COMMAND status code responded to the client.
+       *
+       *   • If the EpochKey1 field is not null, and the field’s length is not exactly 16 bytes, then this
+       *     command shall fail with a CONSTRAINT_ERROR status code responded to the client.
+       *
+       *   • If the EpochKey1 field is not null, its associated EpochStartTime1 field shall NOT be null and shall
+       *     contain a later epoch start time than the epoch start time found in the EpochStartTime0 field.
+       *     Otherwise this command shall fail with an INVALID_COMMAND status code responded to the client.
+       *
+       *   • If exactly one of the EpochKey1 or EpochStartTime1 is null, rather than both being null, or neither
+       *     being null, then this command shall fail with an INVALID_COMMAND status code responded to the client.
+       *
+       *   • If the EpochKey2 field is not null, then the EpochKey1 and EpochKey0 fields shall NOT be null.
+       *     Otherwise this command shall fail with an INVALID_COMMAND status code responded to the client.
+       *
+       *   • If the EpochKey2 field is not null, and the field’s length is not exactly 16 bytes, then this
+       *     command shall fail with a CONSTRAINT_ERROR status code responded to the client.
+       *
+       *   • If the EpochKey2 field is not null, its associated EpochStartTime2 field shall NOT be null and shall
+       *     contain a later epoch start time than the epoch start time found in the EpochStartTime1 field.
+       *     Otherwise this command shall fail with an INVALID_COMMAND status code responded to the client.
+       *
+       *   • If exactly one of the EpochKey2 or EpochStartTime2 is null, rather than both being null, or neither
+       *     being null, then this command shall fail with an INVALID_COMMAND status code responded to the client.
+       *
+       * If there exists a Group Key Set associated with the accessing fabric which has the same GroupKeySetID as
+       * that provided in the GroupKeySet field, then the contents of that group key set shall be replaced. A
+       * replacement shall be done by executing the equivalent of entirely removing the previous Group Key Set
+       * with the given GroupKeySetID, followed by an addition of a Group Key Set with the provided
+       * configuration. Otherwise, if the GroupKeySetID did not match an existing entry, a new Group Key Set
+       * associated with the accessing fabric shall be created with the provided data. The Group Key Set shall be
+       * written to non-volatile storage.
+       *
+       * Upon completion, this command shall send a status code back to the initiator:
+       *
+       *   • If the Group Key Set was properly installed or updated on the Node, the status code shall be
+       *
+       * set to SUCCESS.
+       *
+       *   • If there are insufficient resources on the receiver to store an additional Group Key Set, the status
+       *     code shall be set to RESOURCE_EXHAUSTED (see group key limits);
+       *
+       *   • Otherwise, this status code shall be set to FAILURE.
+       *
+       * @see {@link MatterSpecification.v13.Core} § 11.2.7.1
+       */
+      keySetWrite: Command(0, GroupKeyManagement2.TlvKeySetWriteRequest, 0, TlvNoResponse, { invokeAcl: AccessLevel.Administer }),
+      /**
+       * This command is used by Administrators to read the state of a given Group Key Set.
+       *
+       * Effect on Receipt
+       *
+       * If there exists a Group Key Set associated with the accessing fabric which has the same GroupKeySetID as
+       * that provided in the GroupKeySetID field, then the contents of that Group Key Set shall be sent in a
+       * KeySetReadResponse command, but with the EpochKey0, EpochKey1 and EpochKey2 fields replaced by null.
+       *
+       * Otherwise, if the GroupKeySetID does not refer to a Group Key Set associated with the accessing fabric,
+       * then this command shall fail with a NOT_FOUND status code.
+       *
+       * @see {@link MatterSpecification.v13.Core} § 11.2.7.2
+       */
+      keySetRead: Command(
+        1,
+        GroupKeyManagement2.TlvKeySetReadRequest,
+        2,
+        GroupKeyManagement2.TlvKeySetReadResponse,
+        { invokeAcl: AccessLevel.Administer }
+      ),
+      /**
+       * This command is used by Administrators to remove all state of a given Group Key Set.
+       *
+       * Effect on Receipt
+       *
+       * If there exists a Group Key Set associated with the accessing fabric which has the same GroupKey
+       *
+       * SetID as that provided in the GroupKeySetID field, then the contents of that Group Key Set shall be
+       * removed, including all epoch keys it contains.
+       *
+       * If there exist any entries for the accessing fabric within the GroupKeyMap attribute that refer to the
+       * GroupKeySetID just removed, then these entries shall be removed from that list.
+       *
+       * This command shall fail with an INVALID_COMMAND status code back to the initiator if the GroupKeySetID
+       * being removed is 0, which is the Key Set associated with the Identity Protection Key (IPK). The only
+       * method to remove the IPK is usage of the RemoveFabric command or any operation which causes the
+       * equivalent of a RemoveFabric to occur by side-effect.
+       *
+       * This command shall send a SUCCESS status code back to the initiator on success, or NOT_FOUND if the
+       * GroupKeySetID requested did not exist.
+       *
+       * @see {@link MatterSpecification.v13.Core} § 11.2.7.4
+       */
+      keySetRemove: Command(
+        3,
+        GroupKeyManagement2.TlvKeySetRemoveRequest,
+        3,
+        TlvNoResponse,
+        { invokeAcl: AccessLevel.Administer }
+      ),
+      /**
+       * This command is used by Administrators to query a list of all Group Key Sets associated with the
+       * accessing fabric.
+       *
+       * NOTE Field 0 for this command is reserved and shall NOT be used.
+       *
+       * Effect on Receipt
+       *
+       * Upon receipt, this command shall iterate all stored GroupKeySetStruct associated with the accessing
+       * fabric and generate a KeySetReadAllIndicesResponse command containing the list of GroupKeySetID values
+       * from those structs.
+       *
+       * @see {@link MatterSpecification.v13.Core} § 11.2.7.5
+       */
+      keySetReadAllIndices: Command(
+        4,
+        TlvNoArguments,
+        5,
+        GroupKeyManagement2.TlvKeySetReadAllIndicesResponse,
+        { invokeAcl: AccessLevel.Administer }
+      )
+    },
+    /**
+     * This metadata controls which GroupKeyManagementCluster elements matter.js activates for specific feature
+     * combinations.
+     */
+    extensions: MutableCluster.Extensions()
+  });
+  GroupKeyManagement2.ClusterInstance = MutableCluster(GroupKeyManagement2.Base);
+  GroupKeyManagement2.Cluster = GroupKeyManagement2.ClusterInstance;
+  GroupKeyManagement2.Complete = GroupKeyManagement2.Cluster;
+})(GroupKeyManagement || (GroupKeyManagement = {}));
+const GroupKeyManagementCluster = GroupKeyManagement.Cluster;
+ClusterRegistry.register(GroupKeyManagement.Complete);
+export {
+  GroupKeyManagement,
+  GroupKeyManagementCluster
+};
+//# sourceMappingURL=group-key-management.js.map

package/dist/esm/clusters/group-key-management.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/clusters/group-key-management.ts"],
+  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,SAAS,sBAAsB;AAC/B,SAAS,eAAe;AACxB;AAAA,EACI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AACP,SAAS,gBAAgB;AACzB,SAAS,UAAU,WAAW,wBAAwB;AACtD,SAAS,kBAAkB;AAC3B,SAAS,WAAW,SAAS,kBAAkB;AAC/C,SAAS,sBAAsB;AAE/B,SAAS,mBAAmB;AAC5B,SAAS,yBAAyB;AAClC,SAAS,WAAW,qBAAqB;AACzC,SAAS,mBAAmB;AAC5B,SAAS,sBAAsB;AAE/B,SAAS,uBAAuB;AAEzB,IAAU;AAAA,CAAV,CAAUA,wBAAV;AAMI,MAAK;AAAL,IAAKC,aAAL;AAMH,IAAAA,SAAA,kBAAe;AAAA,KANP,UAAAD,oBAAA,YAAAA,oBAAA;AAYL,EAAMA,oBAAA,iBAAiB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMpC,SAAS,SAAS,GAAG,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAU/B,eAAe,SAAS,GAAG,UAAU,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;AAAA,IAEtD,aAAa,SAAS,KAAK,cAAc;AAAA,EAC7C,CAAC;AAUM,EAAMA,oBAAA,kBAAkB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMrC,SAAS,SAAS,GAAG,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAO/B,WAAW,SAAS,GAAG,SAAS,mBAAmB,EAAE,WAAW,EAAE,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQpE,WAAW,iBAAiB,GAAG,UAAU,MAAM,EAAE,WAAW,GAAG,CAAC,CAAC;AAAA,IAEjE,aAAa,SAAS,KAAK,cAAc;AAAA,EAC7C,CAAC;AAUM,MAAK;AAAL,IAAKE,4BAAL;AAIH,IAAAA,gDAAA,gBAAa,KAAb;AAKA,IAAAA,gDAAA,kBAAe,KAAf;AAAA,KATQ,yBAAAF,oBAAA,2BAAAA,oBAAA;AAeL,MAAK;AAAL,IAAKG,6BAAL;AAQH,IAAAA,kDAAA,gBAAa,KAAb;AASA,IAAAA,kDAAA,cAAW,KAAX;AAAA,KAjBQ,0BAAAH,oBAAA,4BAAAA,oBAAA;AAuBL,EAAMA,oBAAA,iBAAiB,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOpC,eAAe,SAAS,GAAG,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAUpC,wBAAwB,SAAS,GAAG,QAAgC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQrE,WAAW,SAAS,GAAG,YAAY,cAAc,MAAM,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQvE,iBAAiB,SAAS,GAAG,YAAY,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASpD,WAAW,SAAS,GAAG,YAAY,cAAc,MAAM,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQvE,iBAAiB,SAAS,GAAG,YAAY,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQpD,WAAW,SAAS,GAAG,YAAY,cAAc,MAAM,EAAE,QAAQ,GAAG,CAAC,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQvE,iBAAiB,SAAS,GAAG,YAAY,UAAU,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAkBpD,yBAAyB,iBAAiB,GAAG,QAAiC,CAAC;AAAA,EACnF,CAAC;AAYM,EAAMA,oBAAA,wBAAwB,UAAU,EAAE,aAAa,SAAS,GAAGA,oBAAA,cAAc,EAAE,CAAC;AAcpF,EAAMA,oBAAA,uBAAuB,UAAU,EAAE,eAAe,SAAS,GAAG,SAAS,EAAE,CAAC;AAgBhF,EAAMA,oBAAA,wBAAwB,UAAU,EAAE,aAAa,SAAS,GAAGA,oBAAA,cAAc,EAAE,CAAC;AAgBpF,EAAMA,oBAAA,yBAAyB,UAAU,EAAE,eAAe,SAAS,GAAG,SAAS,EAAE,CAAC;AAelF,EAAMA,oBAAA,kCAAkC,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASrD,gBAAgB,SAAS,GAAG,SAAS,SAAS,CAAC;AAAA,EACnD,CAAC;AAaM,EAAMA,oBAAA,OAAO,eAAe,UAAU;AAAA,IACzC,IAAI;AAAA,IACJ,MAAM;AAAA,IACN,UAAU;AAAA,IAEV,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAMN,cAAc,QAAQ,CAAC;AAAA,IAC3B;AAAA,IAEA,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAOR,aAAa;AAAA,QACT;AAAA,QACA,SAASA,oBAAA,cAAc;AAAA,QACvB,EAAE,YAAY,MAAM,SAAS,CAAC,GAAG,UAAU,YAAY,OAAO;AAAA,MAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAcA,YAAY,sBAAsB,GAAK,SAASA,oBAAA,eAAe,GAAG,EAAE,SAAS,CAAC,EAAE,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAUjF,oBAAoB,eAAe,GAAK,WAAW,EAAE,SAAS,EAAE,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MASjE,uBAAuB,eAAe,GAAK,UAAU,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,SAAS,EAAE,CAAC;AAAA,IAC1F;AAAA,IAEA,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAmEN,aAAa,QAAQ,GAAKA,oBAAA,uBAAuB,GAAK,eAAe,EAAE,WAAW,YAAY,WAAW,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAgB1G,YAAY;AAAA,QACR;AAAA,QACAA,oBAAA;AAAA,QACA;AAAA,QACAA,oBAAA;AAAA,QACA,EAAE,WAAW,YAAY,WAAW;AAAA,MACxC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAyBA,cAAc;AAAA,QACV;AAAA,QACAA,oBAAA;AAAA,QACA;AAAA,QACA;AAAA,QACA,EAAE,WAAW,YAAY,WAAW;AAAA,MACxC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAgBA,sBAAsB;AAAA,QAClB;AAAA,QACA;AAAA,QACA;AAAA,QACAA,oBAAA;AAAA,QACA,EAAE,WAAW,YAAY,WAAW;AAAA,MACxC;AAAA,IACJ;AAAA;AAAA;AAAA;AAAA;AAAA,IAMA,YAAY,eAAe,WAAW;AAAA,EAC1C,CAAC;AAKM,EAAMA,oBAAA,kBAAkB,eAAeA,oBAAA,IAAI;AAoB3C,EAAMA,oBAAA,UAAmBA,oBAAA;AACzB,EAAMA,oBAAA,WAAWA,oBAAA;AAAA,GAzhBX;AA6hBV,MAAM,4BAA4B,mBAAmB;AAC5D,gBAAgB,SAAS,mBAAmB,QAAQ;",
+  "names": ["GroupKeyManagement", "Feature", "GroupKeySecurityPolicy", "GroupKeyMulticastPolicy"]
+}