forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathaccess-control-cluster.xml
196 lines (174 loc) · 9.43 KB
/
access-control-cluster.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<?xml version="1.0"?>
<!--
Copyright (c) 2021 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.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
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>
<domain name="CHIP"/>
<enum name="AccessControlEntryPrivilegeEnum" type="enum8">
<cluster code="0x001F"/>
<item name="View" value="0x01"/>
<item name="ProxyView" value="0x02"/>
<item name="Operate" value="0x03"/>
<item name="Manage" value="0x04"/>
<item name="Administer" value="0x05"/>
</enum>
<enum name="AccessControlEntryAuthModeEnum" type="enum8">
<cluster code="0x001F"/>
<item name="PASE" value="0x01"/>
<item name="CASE" value="0x02"/>
<item name="Group" value="0x03"/>
</enum>
<enum name="AccessRestrictionTypeEnum" type="enum8">
<cluster code="0x001F"/>
<item name="AttributeAccessForbidden" value="0x00"/>
<item name="AttributeWriteForbidden" value="0x01"/>
<item name="CommandForbidden" value="0x02"/>
<item name="EventForbidden" value="0x03"/>
</enum>
<enum name="ChangeTypeEnum" type="enum8">
<cluster code="0x001F"/>
<item name="Changed" value="0x00"/>
<item name="Added" value="0x01"/>
<item name="Removed" value="0x02"/>
</enum>
<struct name="AccessControlTargetStruct">
<cluster code="0x001F"/>
<item fieldId="0" name="Cluster" type="cluster_id" isNullable="true"/>
<item fieldId="1" name="Endpoint" type="endpoint_no" isNullable="true"/>
<item fieldId="2" name="DeviceType" type="devtype_id" isNullable="true"/>
</struct>
<struct name="AccessControlEntryStruct" isFabricScoped="true">
<cluster code="0x001F"/>
<item fieldId="1" name="Privilege" type="AccessControlEntryPrivilegeEnum" isFabricSensitive="true" min="0x00" max="0x05"/>
<item fieldId="2" name="AuthMode" type="AccessControlEntryAuthModeEnum" isFabricSensitive="true" min="0x00" max="0x03"/>
<item fieldId="3" name="Subjects" type="int64u" isNullable="true" array="true" isFabricSensitive="true"/>
<item fieldId="4" name="Targets" type="AccessControlTargetStruct" isNullable="true" array="true" isFabricSensitive="true"/>
</struct>
<struct name="AccessControlExtensionStruct" isFabricScoped="true">
<cluster code="0x001F"/>
<item fieldId="1" name="Data" type="octet_string" length="128" isFabricSensitive="true"/>
</struct>
<struct name="AccessRestrictionEntryStruct" apiMaturity="provisional" isFabricScoped="true">
<cluster code="0x001F"/>
<item fieldId="0" name="Endpoint" type="endpoint_no" isFabricSensitive="true"/>
<item fieldId="1" name="Cluster" type="cluster_id" isFabricSensitive="true"/>
<item fieldId="2" name="Restrictions" array="true" type="AccessRestrictionStruct" minLength="1" isFabricSensitive="true"/>
</struct>
<struct name="AccessRestrictionStruct" apiMaturity="provisional">
<cluster code="0x001F"/>
<item fieldId="0" name="Type" type="AccessRestrictionTypeEnum" min="0x00" max="0x03"/>
<item fieldId="1" name="ID" type="int32u" isNullable="true"/>
</struct>
<struct name="CommissioningAccessRestrictionEntryStruct" apiMaturity="provisional">
<cluster code="0x001F"/>
<item fieldId="0" name="Endpoint" type="endpoint_no"/>
<item fieldId="1" name="Cluster" type="cluster_id"/>
<item fieldId="2" name="Restrictions" array="true" type="AccessRestrictionStruct" minLength="1"/>
</struct>
<cluster>
<domain>General</domain>
<name>Access Control</name>
<code>0x001F</code>
<define>ACCESS_CONTROL_CLUSTER</define>
<client init="false" tick="false">true</client>
<features>
<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>
</features>
<server init="false" tick="false">true</server>
<globalAttribute code="0xFFFD" side="either" value="2"/>
<description>The Access Control Cluster exposes a data model view of a
Node's Access Control List (ACL), which codifies the rules used to manage
and enforce Access Control for the Node'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 code="0x0005" side="server" name="CommissioningARL" define="COMMISSIONING_ARL" type="array" entryType="CommissioningAccessRestrictionEntryStruct" optional="true">
<mandatoryConform>
<feature name="MNGD"/>
</mandatoryConform>
</attribute>
<attribute code="0x0006" side="server" name="ARL" define="ARL" type="array" entryType="AccessRestrictionEntryStruct" optional="true">
<mandatoryConform>
<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"/>
<arg id="0" name="ARL" array="true" type="CommissioningAccessRestrictionEntryStruct"/>
<mandatoryConform>
<feature name="MNGD"/>
</mandatoryConform>
</command>
<command code="0x01" source="server" name="ReviewFabricRestrictionsResponse" optional="true" disableDefaultResponse="true">
<description>Returns the review token for the request, which can be used to correlate with a FabricRestrictionReviewUpdate event.</description>
<arg id="0" name="Token" type="int64u"/>
<mandatoryConform>
<feature name="MNGD"/>
</mandatoryConform>
</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>
<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>
<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="AccessControlExtensionStruct" isNullable="true"/>
<access op="read" privilege="administer"/>
<mandatoryConform>
<feature name="EXTS"/>
</mandatoryConform>
</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>
<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"/>
<access op="read" privilege="administer"/>
<mandatoryConform>
<feature name="MNGD"/>
</mandatoryConform>
</event>
</cluster>
</configurator>