From 8b404f6bd07ebf06dd614ff1fc622fab30dbc10d Mon Sep 17 00:00:00 2001
From: Nivedita Sarkar <nivedita_sarkar@apple.com>
Date: Wed, 20 Dec 2023 11:52:21 -0800
Subject: [PATCH] Add support for Aliro credential provisioning in door locks

---
 .../zcl/data-model/chip/door-lock-cluster.xml | 100 +++++++++++++++++-
 1 file changed, 99 insertions(+), 1 deletion(-)

diff --git a/src/app/zap-templates/zcl/data-model/chip/door-lock-cluster.xml b/src/app/zap-templates/zcl/data-model/chip/door-lock-cluster.xml
index 6673d4644e3105..83109c083b9352 100644
--- a/src/app/zap-templates/zcl/data-model/chip/door-lock-cluster.xml
+++ b/src/app/zap-templates/zcl/data-model/chip/door-lock-cluster.xml
@@ -38,6 +38,7 @@ limitations under the License.
         <tag name="YDSCH" description="Year Day Access Schedules" />
         <tag name="HDSCH" description="Holiday Schedules" />
         <tag name="UBOLT" description="Unbolting" />
+        <tag name="ALIRO" description="Aliro credential provisioning" />
 
         <client tick="false" init="false">true</client>
         <server tick="false" init="false">true</server>
@@ -54,11 +55,13 @@ limitations under the License.
             <featureBit tag="DPS" bit="5">true</featureBit>
             <featureBit tag="FACE" bit="6">false</featureBit>
             <featureBit tag="COTA" bit="7">true</featureBit>
-            <featureBit tag="USR" bit="8">true</featureBit> <!-- TODO: Depend on PIN | RID | FGP | FACE -->
+            <featureBit tag="USR" bit="8">true</featureBit> <!-- TODO: Depend on ALIRO, [ PIN | RID | FGP | FACE ]-->
             <featureBit tag="NOT" bit="9">false</featureBit>
             <featureBit tag="YDSCH" bit="10">true</featureBit>
             <featureBit tag="HDSCH" bit="11">true</featureBit>
             <featureBit tag="UBOLT" bit="12">true</featureBit>
+            <featureBit tag="ALIRO" bit="13">true</featureBit>
+            <featureBit tag="ALBU" bit="14">true</featureBit> <!-- TODO: Depend on ALIRO -->
         </globalAttribute>
 
         <!-- The principle behind  mandatory/optional is the following:
@@ -199,6 +202,80 @@ limitations under the License.
             <access op="read" role="view" />
             <access op="write" role="administer" />
         </attribute>
+        <!-- Conformance feature [ALIRO] - optional -->
+        <attribute side="server" code="128" define="ALIRO_READER_VERIFICATION_KEY" type="&lt;&lt;ref_DataTypeOctstr&gt;&gt;" default="null">>
+            <description>AliroReaderVerificationKey</description>
+            <quality nullable="true"/>
+            <access op="read" privilege="administer" />
+            <mandatoryConform/>
+            <constraint type="max" value="65"/>
+        </attribute>
+        <!-- Conformance feature [ALIRO] - optional -->
+        <attribute side="server" code="129" define="ALIRO_READER_GROUP_IDENTIFIER" type="&lt;&lt;ref_DataTypeOctstr&gt;&gt;" default="null">>
+            <description>AliroReaderGroupIdentifier</description>
+            <quality nullable="true"/>
+            <access op="read" privilege="administer" />
+            <mandatoryConform/>
+            <constraint type="max" value="16"/>
+        </attribute>
+        <!-- Conformance feature [ALIRO] - optional -->
+        <attribute side="server" code="130" define="ALIRO_READER_GROUP_SUBIDENTIFIER" type="&lt;&lt;ref_DataTypeOctstr&gt;&gt;">>
+            <description>AliroReaderGroupSubIdentifier</description>
+            <quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
+            <access op="read" privilege="administer" />
+            <mandatoryConform/>
+            <constraint type="max" value="16"/>
+        </attribute>
+        <!-- Conformance feature [ALIRO] - optional -->
+        <attribute side="server" code="131" define="ALIRO_EXPEDITED_TRANSACTION_SUPPORTED_PROTOCOL_VERSIONS" type="list[&lt;&lt;ref_DataTypeOctstr&gt;&gt;]" default="empty">>
+            <description>AliroExpeditedTransactionSupportedProtocolVersions</description>
+            <quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
+            <access op="read" privilege="administer" />
+            <mandatoryConform/>
+            <constraint type="max" value="16"/>
+        </attribute>
+        <!-- Conformance feature [ALBU] - optional if ALIRO is supported -->
+        <attribute side="server" code="132" define="ALIRO_EXPEDITED_TRANSACTION_SUPPORTED_PROTOCOL_VERSIONS" type="list[&lt;&lt;ref_DataTypeOctstr&gt;&gt;]" default="empty">>
+            <description>AliroExpeditedTransactionSupportedProtocolVersions</description>
+            <quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
+            <access op="read" privilege="administer" />
+            <mandatoryConform/>
+            <constraint type="max" value="16"/>
+        </attribute>
+        <!-- Conformance feature [ALBU] - optional if ALIRO is supported -->
+        <attribute side="server" code="133" define="ALIRO_GROUP_RESOLVING_KEY" type="&lt;&lt;ref_DataTypeOctstr&gt;&gt;" default="null">>
+            <description>AliroGroupResolvingKey</description>
+            <quality nullable="true"/>
+            <access op="read" privilege="administer" />
+            <mandatoryConform/>
+            <constraint type="max" value="16"/>
+        </attribute>
+        <!-- Conformance feature [ALBU] - optional if ALIRO is supported -->
+        <attribute side="server" code="134" define="ALIRO_SUPPORTED_BLE_UWB_PROTOCOL_VERSIONS" type="list[&lt;&lt;ref_DataTypeOctstr&gt;&gt;]" default="empty">>
+            <description>AliroSupportedBLEUWBProtocolVersions</description>
+            <quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
+            <access op="read" privilege="administer" />
+            <mandatoryConform/>
+            <constraint type="max" value="16"/>
+        </attribute>
+        <!-- Conformance feature [ALBU] - optional if ALIRO is supported -->
+        <attribute side="server" code="135" define="ALIRO_BLE_ADVERTISING_VERSION" type="uint8" default="0">>
+            <description>AliroBLEAdvertisingVersion</description>
+            <quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
+            <access op="read" privilege="administer" />
+        </attribute>
+        <!-- Conformance feature [ALIRO] - optional -->
+        <attribute side="server" code="136" define="NUMBER_OF_ALIRO_CREDENTIAL_ISSUER_KEYS_SUPPORTED" type="uint16" default="0">>
+            <description>NumberOfAliroCredentialIssuerKeysSupported</description>
+            <quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
+            <access op="read" privilege="view" />
+        </attribute>
+        <!-- Conformance feature [ALIRO] - optional -->
+        <attribute side="server" code="137" define="NUMBER_OF_ALIRO_ENDPOINT_KEYS_SUPPORTED" type="uint16" default="0">>
+            <description>NumberOfAliroEndpointKeysSupported</description>
+            <quality changeOmitted="false" nullable="false" scene="false" persistence="fixed" reportable="false"/>
+            <access op="read" privilege="view" />
+        </attribute>
 
         <!-- Commands -->
         <command source="client" code="0" name="LockDoor" mustUseTimedInvoke="true">
@@ -400,6 +477,18 @@ limitations under the License.
             <!-- Conformance feature [COTA & PIN] - for now optional -->
             <arg name="PINCode" type="octet_string" optional="true" />
         </command>
+        <command source="client" code="40" name="SetAliroReaderConfig" mustUseTimedInvoke="true" optional="true">
+            <description>This command communicates an Aliro Reader configuration to the lock.</description>
+            <access op="invoke" role="administer" />
+            <arg name="SigningKey" type="octet_string" length="32" />
+            <arg name="VerificationKey" type="octet_string" length="65" />
+            <arg name="GroupIdentifier" type="octet_string" length="16" />
+            <arg name="GroupResolvingKey" type="octet_string" length="16" optional="true" />
+        </command>
+        <command source="client" code="41" name="ClearAliroReaderConfig" mustUseTimedInvoke="true" optional="true">
+            <description>This command clears an existing Aliro Reader configuration for the lock.</description>
+            <access op="invoke" role="administer" />
+        </command>
 
 
         <!-- Events -->
@@ -487,6 +576,9 @@ limitations under the License.
         <item value="3" name="Fingerprint" />
         <item value="4" name="FingerVein" />
         <item value="5" name="Face" />
+        <item value="6" name="AliroCredentialIssuerKey" />
+        <item value="7" name="AliroEvictableEndpointKey" />
+        <item value="8" name="AliroNonEvictableEndpointKey" />
     </enum>
 
     <enum name="DataOperationTypeEnum" type="enum8">
@@ -530,6 +622,9 @@ limitations under the License.
         <item value="8" name="Fingerprint" />
         <item value="9" name="FingerVein" />
         <item value="10" name="Face" />
+        <item value="11" name="AliroCredentialIssuerKey" />
+        <item value="12" name="AliroEvictableEndpointKey" />
+        <item value="13" name="AliroNonEvictableEndpointKey" />
     </enum>
 
     <enum name="LockOperationTypeEnum" type="enum8">
@@ -571,6 +666,7 @@ limitations under the License.
         <item value="7" name="Remote" />
         <item value="8" name="RFID" />
         <item value="9" name="Biometric" />
+        <item value="10" name="Aliro" />
     </enum>
 
     <enum name="UserStatusEnum" type="enum8">
@@ -769,6 +865,8 @@ limitations under the License.
         <field name="Year Day Access Schedules" mask="0x400" />
         <field name="Holiday Schedules" mask="0x800" />
         <field name="Unbolt" mask="0x1000" />
+        <field name="ALIRO" mask="0x2000" />
+        <field name="ALBU" mask="0x4000" />
     </bitmap>
 
     <enum name="DoorLockSetPinOrIdStatus" type="enum8">