@@ -18,25 +18,25 @@ limitations under the License.
18
18
XML generated by Alchemy; DO NOT EDIT.
19
19
Source: src/tls/TLSCertificateManagement.adoc
20
20
Parameters: in-progress
21
- Git: 1.4-534-g3214b3502
21
+ Git: 0.7-summer-2025-308-g2f23be841
22
22
-->
23
23
<configurator xmlns : xsi =" http://www.w3.org/2001/XMLSchema-instance" xsi : noNamespaceSchemaLocation =" ../../zcl.xsd" >
24
24
<domain name =" General" />
25
- <struct name =" TLSCertStruct" apiMaturity =" provisional" >
25
+ <struct name =" TLSCertStruct" apiMaturity =" provisional" isFabricScoped = " true " >
26
26
<cluster code =" 0x0801" />
27
27
<item fieldId =" 0" name =" CAID" type =" int16u" />
28
- <item fieldId =" 1" name =" Certificate" type =" long_octet_string" length =" 3000" />
28
+ <item fieldId =" 1" name =" Certificate" type =" long_octet_string" length =" 3000" optional = " true " />
29
29
</struct >
30
30
31
- <struct name =" TLSClientCertificateDetailStruct" apiMaturity =" provisional" >
31
+ <struct name =" TLSClientCertificateDetailStruct" apiMaturity =" provisional" isFabricScoped = " true " >
32
32
<cluster code =" 0x0801" />
33
33
<item fieldId =" 0" name =" CCDID" type =" int16u" />
34
- <item fieldId =" 1" name =" ClientCertificate" type =" long_octet_string" length =" 3000" />
35
- <item fieldId =" 2" name =" IntermediateCertificates" array =" true" type =" octet_string" />
34
+ <item fieldId =" 1" name =" ClientCertificate" type =" long_octet_string" length =" 3000" optional = " true " />
35
+ <item fieldId =" 2" name =" IntermediateCertificates" array =" true" type =" octet_string" optional = " true " length = " 10 " />
36
36
</struct >
37
37
38
38
<cluster apiMaturity =" provisional" >
39
- <domain name =" General" / >
39
+ <domain name =" General" >General</ domain >
40
40
<name >TLS Certificate Management</name >
41
41
<code >0x0801</code >
42
42
<define >TLS_CERTIFICATE_MANAGEMENT_CLUSTER</define >
@@ -45,96 +45,106 @@ Git: 1.4-534-g3214b3502
45
45
<client init =" false" tick =" false" >true</client >
46
46
<server init =" false" tick =" false" >true</server >
47
47
<globalAttribute code =" 0xFFFD" side =" either" value =" 1" />
48
- <attribute code =" 0x0000" side =" server" define =" MAX_ROOT_CERTIFICATES" type =" int8u" >MaxRootCertificates</attribute >
49
- <attribute code =" 0x0001" side =" server" define =" CURRENT_ROOT_CERTIFICATES " type =" int8u " >CurrentRootCertificates </attribute >
50
- <attribute code =" 0x0002" side =" server" define =" MAX_CLIENT_CERTIFICATES" type =" int8u" >MaxClientCertificates</attribute >
51
- <attribute code =" 0x0003" side =" server" define =" CURRENT_CLIENT_CERTIFICATES " type =" int8u " >CurrentClientCertificates </attribute >
52
- <command code =" 0x00" source =" client" name =" ProvisionRootCertificate" optional =" false" response =" ProvisionRootCertificateResponse" >
53
- <description >This command SHALL provision the provided certificate for the passed in CAID.</description >
48
+ <attribute code =" 0x0000" side =" server" define =" MAX_ROOT_CERTIFICATES" type =" int8u" min = " 5 " max = " 254 " default = " 5 " >MaxRootCertificates</attribute >
49
+ <attribute code =" 0x0001" side =" server" define =" PROVISIONED_ROOT_CERTIFICATES " type =" array " entryType = " TLSCertStruct " >ProvisionedRootCertificates </attribute >
50
+ <attribute code =" 0x0002" side =" server" define =" MAX_CLIENT_CERTIFICATES" type =" int8u" min = " 5 " max = " 254 " default = " 5 " >MaxClientCertificates</attribute >
51
+ <attribute code =" 0x0003" side =" server" define =" PROVISIONED_CLIENT_CERTIFICATES " type =" array " entryType = " TLSClientCertificateDetailStruct " >ProvisionedClientCertificates </attribute >
52
+ <command code =" 0x00" source =" client" name =" ProvisionRootCertificate" optional =" false" response =" ProvisionRootCertificateResponse" isFabricScoped = " true " >
53
+ <description >This command SHALL provision a newly provided certificate, or rotate an existing one, based on the contents of the CAID field .</description >
54
54
<access op =" invoke" privilege =" administer" />
55
+ <quality largeMessage =" true" />
55
56
<arg id =" 0" name =" Certificate" type =" long_octet_string" length =" 3000" />
56
57
<arg id =" 1" name =" CAID" type =" int16u" isNullable =" true" />
57
58
</command >
58
59
59
60
<command code =" 0x01" source =" server" name =" ProvisionRootCertificateResponse" optional =" false" disableDefaultResponse =" true" >
60
61
<description >This command SHALL be generated in response to a ProvisionRootCertificate command.</description >
62
+ <quality largeMessage =" true" />
61
63
<arg id =" 0" name =" CAID" type =" int16u" />
62
64
</command >
63
65
64
- <command code =" 0x02" source =" client" name =" FindRootCertificate" optional =" false" response =" FindRootCertificateResponse" >
65
- <description >This command SHALL return the TLSCertStruct for the passed in CAID.</description >
66
+ <command code =" 0x02" source =" client" name =" FindRootCertificate" optional =" false" response =" FindRootCertificateResponse" isFabricScoped =" true" >
67
+ <description >This command SHALL return the specified TLS root certificate, or all TLS provisioned root certificates, based on the contents of the CAID field.</description >
68
+ <quality largeMessage =" true" />
66
69
<arg id =" 0" name =" CAID" type =" int16u" isNullable =" true" />
67
70
</command >
68
71
69
72
<command code =" 0x03" source =" server" name =" FindRootCertificateResponse" optional =" false" disableDefaultResponse =" true" >
70
73
<description >This command SHALL be generated in response to a FindRootCertificate command.</description >
71
- <arg id =" 0" name =" CertificateDetails" array =" true" type =" TLSCertStruct" />
74
+ <quality largeMessage =" true" />
75
+ <arg id =" 0" name =" CertificateDetails" array =" true" type =" TLSCertStruct" minLength =" 1" />
72
76
</command >
73
77
74
- <command code =" 0x04" source =" client" name =" LookupRootCertificate" optional =" false" response =" LookupRootCertificateResponse" >
78
+ <command code =" 0x04" source =" client" name =" LookupRootCertificate" optional =" false" response =" LookupRootCertificateResponse" isFabricScoped = " true " >
75
79
<description >This command SHALL return the CAID for the passed in fingerprint.</description >
80
+ <quality largeMessage =" true" />
76
81
<arg id =" 0" name =" Fingerprint" type =" octet_string" length =" 64" />
77
82
</command >
78
83
79
84
<command code =" 0x05" source =" server" name =" LookupRootCertificateResponse" optional =" false" disableDefaultResponse =" true" >
80
85
<description >This command SHALL be generated in response to a LookupRootCertificate command.</description >
86
+ <quality largeMessage =" true" />
81
87
<arg id =" 0" name =" CAID" type =" int16u" />
82
88
</command >
83
89
84
- <command code =" 0x06" source =" client" name =" RemoveRootCertificate" optional =" false" >
90
+ <command code =" 0x06" source =" client" name =" RemoveRootCertificate" optional =" false" isFabricScoped = " true " >
85
91
<description >This command SHALL be generated to request the server removes the certificate provisioned to the provided Certificate Authority ID.</description >
86
92
<access op =" invoke" privilege =" administer" />
93
+ <quality largeMessage =" true" />
87
94
<arg id =" 0" name =" CAID" type =" int16u" />
88
95
</command >
89
96
90
- <command code =" 0x07" source =" client" name =" TLSClientCSR" optional =" false" response =" TLSClientCSRResponse" >
97
+ <command code =" 0x07" source =" client" name =" TLSClientCSR" optional =" false" response =" TLSClientCSRResponse" isFabricScoped = " true " >
91
98
<description >This command SHALL be generated to request the Node generates a Certificate Signing Request.</description >
92
99
<access op =" invoke" privilege =" administer" />
100
+ <quality largeMessage =" true" />
93
101
<arg id =" 1" name =" Nonce" type =" octet_string" />
94
102
</command >
95
103
96
104
<command code =" 0x08" source =" server" name =" TLSClientCSRResponse" optional =" false" disableDefaultResponse =" true" >
97
105
<description >This command SHALL be generated in response to a TLSClientCSR command.</description >
106
+ <quality largeMessage =" true" />
98
107
<arg id =" 0" name =" CCDID" type =" int16u" />
99
108
<arg id =" 1" name =" CSR" type =" octet_string" />
100
109
<arg id =" 2" name =" Nonce" type =" octet_string" />
101
110
</command >
102
111
103
- <command code =" 0x09" source =" client" name =" ProvisionClientCertificate" optional =" false" response = " ProvisionClientCertificateResponse " >
104
- <description >This command SHALL be generated to request the Node provisions the provided Client Certificate Details.</description >
112
+ <command code =" 0x09" source =" client" name =" ProvisionClientCertificate" optional =" false" isFabricScoped = " true " >
113
+ <description >This command SHALL be generated to request the Node provisions newly provided Client Certificate Details, or rotate an existing client certificate .</description >
105
114
<access op =" invoke" privilege =" administer" />
115
+ <quality largeMessage =" true" />
106
116
<arg id =" 0" name =" CCDID" type =" int16u" />
107
117
<arg id =" 1" name =" ClientCertificateDetails" type =" TLSClientCertificateDetailStruct" />
108
118
</command >
109
119
110
- <command code =" 0x0A" source =" server" name =" ProvisionClientCertificateResponse" optional =" false" disableDefaultResponse =" true" >
111
- <description >This command SHALL be generated in response to a ProvisionClientCertificate command.</description >
112
- <arg id =" 0" name =" CCDID" type =" int16u" />
113
- </command >
114
-
115
- <command code =" 0x0B" source =" client" name =" FindClientCertificate" optional =" false" response =" FindClientCertificateResponse" >
116
- <description >This command SHALL return the TLSClientCertificateDetailStruct for the passed in CCDID.</description >
117
- <arg id =" 0" name =" CCDID" type =" int16u" />
120
+ <command code =" 0x0A" source =" client" name =" FindClientCertificate" isFabricScoped =" true" optional =" false" response =" FindClientCertificateResponse" >
121
+ <description >This command SHALL return the TLSClientCertificateDetailStruct for the passed in CCDID, or all TLS client certificates, based on the contents of the CCDID field.</description >
122
+ <quality largeMessage =" true" />
123
+ <arg id =" 0" name =" CCDID" type =" int16u" isNullable =" true" />
118
124
</command >
119
125
120
- <command code =" 0x0C " source =" server" name =" FindClientCertificateResponse" optional =" false" disableDefaultResponse =" true" >
126
+ <command code =" 0x0B " source =" server" name =" FindClientCertificateResponse" optional =" false" disableDefaultResponse =" true" >
121
127
<description >This command SHALL be generated in response to a FindClientCertificate command.</description >
122
- <arg id =" 0" name =" CertificateDetails" array =" true" type =" TLSClientCertificateDetailStruct" />
128
+ <quality largeMessage =" true" />
129
+ <arg id =" 0" name =" CertificateDetails" array =" true" type =" TLSClientCertificateDetailStruct" minLength =" 1" />
123
130
</command >
124
131
125
- <command code =" 0x0D " source =" client" name =" LookupClientCertificate" optional =" false" response =" LookupClientCertificateResponse" >
132
+ <command code =" 0x0C " source =" client" name =" LookupClientCertificate" isFabricScoped = " true " optional =" false" response =" LookupClientCertificateResponse" >
126
133
<description >This command SHALL return the CCDID for the passed in Fingerprint.</description >
134
+ <quality largeMessage =" true" />
127
135
<arg id =" 0" name =" Fingerprint" type =" octet_string" length =" 64" />
128
136
</command >
129
137
130
- <command code =" 0x0E " source =" server" name =" LookupClientCertificateResponse" optional =" false" disableDefaultResponse =" true" >
138
+ <command code =" 0x0D " source =" server" name =" LookupClientCertificateResponse" optional =" false" disableDefaultResponse =" true" >
131
139
<description >This command SHALL be generated in response to a LookupClientCertificate command.</description >
140
+ <quality largeMessage =" true" />
132
141
<arg id =" 0" name =" CCDID" type =" int16u" />
133
142
</command >
134
143
135
- <command code =" 0x0F " source =" client" name =" RemoveClientCertificate" optional =" false" >
136
- <description >This command SHALL be generated to request the Node removes the certificate provisioned to the provided Client Certificate Details ID .</description >
144
+ <command code =" 0x0E " source =" client" name =" RemoveClientCertificate" isFabricScoped = " true " optional =" false" >
145
+ <description >This command SHALL be used to request the Node removes all stored information for the provided CCDID .</description >
137
146
<access op =" invoke" privilege =" administer" />
147
+ <quality largeMessage =" true" />
138
148
<arg id =" 0" name =" CCDID" type =" int16u" />
139
149
</command >
140
150
0 commit comments