Skip to content

Generate AccessControl cluster with Alchemy #38249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 22, 2025
Merged

Generate AccessControl cluster with Alchemy #38249

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bccfb2e
Generate AccessControl cluster with Alchemy
tersal Apr 3, 2025
29df324
Merge branch 'master' into generate-AccessControl-cluster-with-Alchemy
tersal Apr 4, 2025
c5ebe5e
Add matter files generated by ZAP
tersal Apr 4, 2025
3f384c8
Merge branch 'master' into generate-AccessControl-cluster-with-Alchemy
tersal Apr 17, 2025
b9bb9f9
Update generated files
tersal Apr 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 18 additions & 24 deletions src/app/zap-templates/zcl/data-model/chip/access-control-cluster.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<!--
Copyright (c) 2021 Project CHIP Authors
Copyright (c) 2021-2025 Project CHIP Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand All @@ -14,9 +14,14 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<configurator>
<!--
XML generated by Alchemy; DO NOT EDIT.
Source: src/data_model/ACL-Cluster.adoc
Parameters: in-progress
Git:
-->
<configurator xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../zcl.xsd">
<domain name="CHIP"/>

<enum name="AccessControlEntryPrivilegeEnum" type="enum8">
<cluster code="0x001F"/>
<item name="View" value="0x01"/>
Expand Down Expand Up @@ -98,8 +103,8 @@ limitations under the License.
<feature bit="0" code="EXTS" name="Extension" summary="Device provides ACL Extension attribute">
<optionalConform/>
</feature>
<feature bit="1" code="MNGD" name="Managed Device" summary="Device is managed">
<optionalConform/>
<feature bit="1" code="MNGD" name="ManagedDevice" summary="Device is managed">
<describedConform/>
</feature>
</features>
<server init="false" tick="false">true</server>
Expand All @@ -108,30 +113,20 @@ limitations under the License.
Node&apos;s Access Control List (ACL), which codifies the rules used to manage
and enforce Access Control for the Node&apos;s endpoints and their associated
cluster instances.</description>

<attribute side="server" code="0x0000" name="ACL" define="ACL" type="array" entryType="AccessControlEntryStruct" writable="true">
<access op="read" privilege="administer"/>
<access op="write" privilege="administer"/>
<mandatoryConform/>
</attribute>

<attribute side="server" code="0x0001" name="Extension" define="EXTENSION" type="array" entryType="AccessControlExtensionStruct" writable="true" optional="true">
<access op="read" privilege="administer"/>
<access op="write" privilege="administer"/>
<mandatoryConform>
<feature name="EXTS"/>
</mandatoryConform>
</attribute>

<attribute side="server" code="0x0002" name="SubjectsPerAccessControlEntry" define="SUBJECTS_PER_ACCESS_CONTROL_ENTRY" type="int16u" min="4" default="4">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x0003" name="TargetsPerAccessControlEntry" define="TARGETS_PER_ACCESS_CONTROL_ENTRY" type="int16u" min="3" default="3">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x0004" name="AccessControlEntriesPerFabric" define="ACCESS_CONTROL_ENTRIES_PER_FABRIC" type="int16u" min="4" default="4">
<mandatoryConform/>
</attribute>
<attribute side="server" code="0x0002" name="SubjectsPerAccessControlEntry" define="SUBJECTS_PER_ACCESS_CONTROL_ENTRY" type="int16u" min="4" default="4"/>
<attribute side="server" code="0x0003" name="TargetsPerAccessControlEntry" define="TARGETS_PER_ACCESS_CONTROL_ENTRY" type="int16u" min="3" default="3"/>
<attribute side="server" code="0x0004" name="AccessControlEntriesPerFabric" define="ACCESS_CONTROL_ENTRIES_PER_FABRIC" type="int16u" min="4" default="4"/>
<attribute code="0x0005" side="server" name="CommissioningARL" define="COMMISSIONING_ARL" type="array" entryType="CommissioningAccessRestrictionEntryStruct" optional="true">
<mandatoryConform>
<feature name="MNGD"/>
Expand All @@ -142,10 +137,9 @@ limitations under the License.
<feature name="MNGD"/>
</mandatoryConform>
</attribute>

<command code="0x00" source="client" name="ReviewFabricRestrictions" isFabricScoped="true" optional="true" response="ReviewFabricRestrictionsResponse">
<description>This command signals to the service associated with the device vendor that the fabric administrator would like a review of the current restrictions on the accessing fabric.</description>
<access op="invoke" privilege="administer"/>
<access op="invoke" privilege="administer"/>
<arg id="0" name="ARL" array="true" type="CommissioningAccessRestrictionEntryStruct"/>
<mandatoryConform>
<feature name="MNGD"/>
Expand All @@ -161,17 +155,16 @@ limitations under the License.
</command>

<event side="server" code="0x0000" name="AccessControlEntryChanged" priority="info" isFabricSensitive="true">
<description>The cluster SHALL send AccessControlEntryChanged events whenever its ACL attribute data is changed by an Administrator.</description>
<description>The cluster SHALL generate AccessControlEntryChanged events whenever its ACL attribute data is changed by an Administrator.</description>
<field id="1" name="AdminNodeID" type="node_id" isNullable="true"/>
<field id="2" name="AdminPasscodeID" type="int16u" isNullable="true"/>
<field id="3" name="ChangeType" type="ChangeTypeEnum" min="0x00" max="0x02"/>
<field id="4" name="LatestValue" type="AccessControlEntryStruct" isNullable="true"/>
<access op="read" privilege="administer"/>
<mandatoryConform/>
</event>

<event side="server" code="0x0001" name="AccessControlExtensionChanged" priority="info" isFabricSensitive="true" optional="true">
<description>The cluster SHALL send AccessControlExtensionChanged events whenever its extension attribute data is changed by an Administrator.</description>
<description>The cluster SHALL generate AccessControlExtensionChanged events whenever its extension attribute data is changed by an Administrator.</description>
<field id="1" name="AdminNodeID" type="node_id" isNullable="true"/>
<field id="2" name="AdminPasscodeID" type="int16u" isNullable="true"/>
<field id="3" name="ChangeType" type="ChangeTypeEnum" min="0x00" max="0x02"/>
Expand All @@ -183,7 +176,7 @@ limitations under the License.
</event>

<event side="server" code="0x0002" name="FabricRestrictionReviewUpdate" priority="info" isFabricSensitive="true" optional="true">
<description>The cluster SHALL send FabricRestrictionReviewUpdate events to indicate completion of a fabric restriction review.</description>
<description>The cluster SHALL generate a FabricRestrictionReviewUpdate event to indicate completion of a fabric restriction review.</description>
<field id="0" name="Token" type="int64u"/>
<field id="1" name="Instruction" type="long_char_string" optional="true" length="512"/>
<field id="2" name="ARLRequestFlowUrl" type="long_char_string" optional="true" length="256"/>
Expand All @@ -192,5 +185,6 @@ limitations under the License.
<feature name="MNGD"/>
</mandatoryConform>
</event>

</cluster>
</configurator>
Loading