Merge pull request #62 from sagar-apple/generic_config_manager

Add Configuration Manager Impl

src/include/platform/internal/GenericConfigurationManagerImpl.h

@@ -0,0 +1,165 @@
+/*
+ *
+ *    <COPYRIGHT>
+ *
+ *    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.
+ */
+
+/**
+ *    @file
+ *          Provides an generic implementation of ConfigurationManager features
+ *          for use on various platforms.
+ */
+
+#ifndef GENERIC_CONFIGURATION_MANAGER_IMPL_H
+#define GENERIC_CONFIGURATION_MANAGER_IMPL_H
+
+namespace chip {
+namespace DeviceLayer {
+
+class ProvisioningDataSet;
+
+namespace Internal {
+
+/**
+ * Provides a generic implementation of ConfigurationManager features that works on multiple platforms.
+ *
+ * This template contains implementations of select features from the ConfigurationManager abstract
+ * interface that are suitable for use on all platforms.  It is intended to be inherited (directly
+ * or indirectly) by the ConfigurationManagerImpl class, which also appears as the template's ImplClass
+ * parameter.
+ */
+template<class ImplClass>
+class GenericConfigurationManagerImpl
+{
+public:
+
+    // ===== Methods that implement the ConfigurationManager abstract interface.
+
+    CHIP_ERROR _Init();
+    CHIP_ERROR _ConfigureChiptack();
+    CHIP_ERROR _GetVendorId(uint16_t & vendorId);
+    CHIP_ERROR _GetProductId(uint16_t & productId);
+    CHIP_ERROR _GetProductRevision(uint16_t & productRev);
+    CHIP_ERROR _StoreProductRevision(uint16_t productRev);
+    CHIP_ERROR _GetFirmwareRevision(char * buf, size_t bufSize, size_t & outLen);
+    CHIP_ERROR _GetFirmwareBuildTime(uint16_t & year, uint8_t & month, uint8_t & dayOfMonth,
+            uint8_t & hour, uint8_t & minute, uint8_t & second);
+    CHIP_ERROR _GetSerialNumber(char * buf, size_t bufSize, size_t & serialNumLen);
+    CHIP_ERROR _StoreSerialNumber(const char * serialNum, size_t serialNumLen);
+    CHIP_ERROR _GetPrimaryWiFiMACAddress(uint8_t * buf);
+    CHIP_ERROR _StorePrimaryWiFiMACAddress(const uint8_t * buf);
+    CHIP_ERROR _GetPrimary802154MACAddress(uint8_t * buf);
+    CHIP_ERROR _StorePrimary802154MACAddress(const uint8_t * buf);
+    CHIP_ERROR _GetManufacturingDate(uint16_t & year, uint8_t & month, uint8_t & dayOfMonth);
+    CHIP_ERROR _StoreManufacturingDate(const char * mfgDate, size_t mfgDateLen);
+    CHIP_ERROR _GetDeviceId(uint64_t & deviceId);
+    CHIP_ERROR _GetDeviceCertificate(uint8_t * buf, size_t bufSize, size_t & certLen);
+    CHIP_ERROR _GetDeviceIntermediateCACerts(uint8_t * buf, size_t bufSize, size_t & certsLen);
+    CHIP_ERROR _GetDevicePrivateKey(uint8_t * buf, size_t bufSize, size_t & keyLen);
+#if CHIP_DEVICE_CONFIG_ENABLE_JUST_IN_TIME_PROVISIONING
+    CHIP_ERROR _StoreDeviceId(uint64_t deviceId);
+    CHIP_ERROR _StoreDeviceCertificate(const uint8_t * cert, size_t certLen);
+    CHIP_ERROR _StoreDeviceIntermediateCACerts(const uint8_t * certs, size_t certsLen);
+    CHIP_ERROR _StoreDevicePrivateKey(const uint8_t * key, size_t keyLen);
+    CHIP_ERROR _ClearOperationalDeviceCredentials(void);
+#endif
+    CHIP_ERROR _GetManufacturerDeviceId(uint64_t & deviceId);
+    CHIP_ERROR _StoreManufacturerDeviceId(uint64_t deviceId);
+    CHIP_ERROR _GetManufacturerDeviceCertificate(uint8_t * buf, size_t bufSize, size_t & certLen);
+    CHIP_ERROR _StoreManufacturerDeviceCertificate(const uint8_t * cert, size_t certLen);
+    CHIP_ERROR _GetManufacturerDeviceIntermediateCACerts(uint8_t * buf, size_t bufSize, size_t & certsLen);
+    CHIP_ERROR _StoreManufacturerDeviceIntermediateCACerts(const uint8_t * certs, size_t certsLen);
+    CHIP_ERROR _GetManufacturerDevicePrivateKey(uint8_t * buf, size_t bufSize, size_t & keyLen);
+    CHIP_ERROR _StoreManufacturerDevicePrivateKey(const uint8_t * key, size_t keyLen);
+    CHIP_ERROR _GetPairingCode(char * buf, size_t bufSize, size_t & pairingCodeLen);
+    CHIP_ERROR _StorePairingCode(const char * pairingCode, size_t pairingCodeLen);
+    CHIP_ERROR _GetFabricId(uint64_t & fabricId);
+    CHIP_ERROR _StoreFabricId(uint64_t fabricId);
+    CHIP_ERROR _GetServiceId(uint64_t & serviceId);
+    CHIP_ERROR _GetServiceConfig(uint8_t * buf, size_t bufSize, size_t & serviceConfigLen);
+    CHIP_ERROR _StoreServiceConfig(const uint8_t * serviceConfig, size_t serviceConfigLen);
+    CHIP_ERROR _GetPairedAccountId(char * buf, size_t bufSize, size_t & accountIdLen);
+    CHIP_ERROR _StorePairedAccountId(const char * accountId, size_t accountIdLen);
+    CHIP_ERROR _StoreServiceProvisioningData(uint64_t serviceId, const uint8_t * serviceConfig,
+            size_t serviceConfigLen, const char * accountId, size_t accountIdLen);
+    CHIP_ERROR _ClearServiceProvisioningData();
+    CHIP_ERROR _GetFailSafeArmed(bool & val);
+    CHIP_ERROR _SetFailSafeArmed(bool val);
+    CHIP_ERROR _GetDeviceDescriptor(::chip::Profiles::DeviceDescription::ChipeviceDescriptor & deviceDesc);
+    CHIP_ERROR _GetDeviceDescriptorTLV(uint8_t * buf, size_t bufSize, size_t & encodedLen);
+    CHIP_ERROR _GetQRCodeString(char * buf, size_t bufSize);
+    CHIP_ERROR _GetWiFiAPSSID(char * buf, size_t bufSize);
+    CHIP_ERROR _GetBLEDeviceIdentificationInfo(Ble::ChipBLEDeviceIdentificationInfo & deviceIdInfo);
+    bool _IsServiceProvisioned();
+    bool _IsMemberOfFabric();
+    bool _IsPairedToAccount();
+    bool _IsFullyProvisioned();
+    CHIP_ERROR _ComputeProvisioningHash(uint8_t * hashBuf, size_t hashBufSize);
+#if CHIP_DEVICE_CONFIG_ENABLE_JUST_IN_TIME_PROVISIONING
+    bool _OperationalDeviceCredentialsProvisioned();
+    void _UseManufacturerCredentialsAsOperational(bool val);
+#endif
+
+protected:
+
+    enum
+    {
+        kFlag_IsServiceProvisioned                    = 0x01,
+        kFlag_IsMemberOfFabric                        = 0x02,
+        kFlag_IsPairedToAccount                       = 0x04,
+        kFlag_OperationalDeviceCredentialsProvisioned = 0x08,
+        kFlag_UseManufacturerCredentialsAsOperational = 0x10,
+    };
+
+    uint8_t mFlags;
+
+    void LogDeviceConfig();
+    CHIP_ERROR PersistProvisioningData(ProvisioningDataSet & provData);
+
+private:
+
+    ImplClass * Impl() { return static_cast<ImplClass *>(this); }
+
+    static void HashLengthAndBase64Value(Platform::Security::SHA256 & hash, const uint8_t * val, uint16_t valLen);
+
+#if CHIP_DEVICE_CONFIG_ENABLE_JUST_IN_TIME_PROVISIONING
+    bool UseManufacturerCredentialsAsOperational();
+#endif
+};
+
+// Instruct the compiler to instantiate the template only when explicitly told to do so.
+extern template class Internal::GenericConfigurationManagerImpl<ConfigurationManagerImpl>;
+
+template<class ImplClass>
+inline CHIP_ERROR GenericConfigurationManagerImpl<ImplClass>::_GetVendorId(uint16_t & vendorId)
+{
+    vendorId = (uint16_t)CHIP_DEVICE_CONFIG_DEVICE_VENDOR_ID;
+    return CHIP_NO_ERROR;
+}
+
+template<class ImplClass>
+inline CHIP_ERROR GenericConfigurationManagerImpl<ImplClass>::_GetProductId(uint16_t & productId)
+{
+    productId = (uint16_t)CHIP_DEVICE_CONFIG_DEVICE_PRODUCT_ID;
+    return CHIP_NO_ERROR;
+}
+
+
+
+
+} // namespace Internal
+} // namespace DeviceLayer
+} // namespace chip
+
+#endif // GENERIC_CONFIGURATION_MANAGER_IMPL_H