Merge pull request #282 from openweave/feature/factory-prov-tool

Factory Provisioning Tool

Author: Jay Logue

build/esp32/components/openweave/Kconfig

@@ -416,15 +416,20 @@ menu "OpenWeave Device Layer"
                 The device product id (in hex).  This is a unique id assigned by the device vendor to identify the product or device type.
                 Defaults to a Nest-assigned id designating a non-production or test "product".
 
-        config DEVICE_PRODUCT_REVISION
-            int "Device Product Revision"
+        config DEFAULT_DEVICE_PRODUCT_REVISION
+            int "Default Device Product Revision"
             range 0 65535
             default 1
             help
-                The device product revision.  This number is assigned to device or product by the device vendor.  The number is
-                scoped to the device product id, and typically corresponds to a revision of the physical device, a change to its
-                packaging, and/or a change to its marketing presentation.  This value is generally *not* incremented for device
-                software revisions.
+                The default device product revision.  
+                
+                Product revisions are specific to a particular device vendor and product id, and typically
+                correspond to a revision of the physical device, a change to its packaging, and/or a change
+                to its marketing presentation. This value is generally *not* incremented for device software
+                revisions.
+
+                This is a default value which is used when a product revision has not been stored in device
+                persistent storage (e.g. by a factory provisioning process). 
 
         config DEVICE_FIRMWARE_REVISION
             string "Device Firmware Revision"

certs/development/device/test-dev-provisioning-data.csv

@@ -31,6 +31,10 @@
 #include <Weave/DeviceLayer/ESP32/ESP32Config.h>
 #include <Weave/DeviceLayer/internal/GenericConfigurationManagerImpl.ipp>
 
+#if WEAVE_DEVICE_CONFIG_ENABLE_FACTORY_PROVISIONING
+#include <Weave/DeviceLayer/internal/FactoryProvisioning.ipp>
+#endif // WEAVE_DEVICE_CONFIG_ENABLE_FACTORY_PROVISIONING
+
 #include "esp_wifi.h"
 #include "nvs_flash.h"
 #include "nvs.h"
@@ -89,6 +93,21 @@ WEAVE_ERROR ConfigurationManagerImpl::_Init()
     err = gGroupKeyStore.Init();
     SuccessOrExit(err);
 
+#if WEAVE_DEVICE_CONFIG_ENABLE_FACTORY_PROVISIONING
+
+    {
+        FactoryProvisioning factoryProv;
+        uint8_t * const kInternalSRAM12Start = (uint8_t *)0x3FFAE000;
+        uint8_t * const kInternalSRAM12End = kInternalSRAM12Start + (328 * 1024) - 1;
+
+        // Scan ESP32 Internal SRAM regions 1 and 2 for injected provisioning data and save
+        // to persistent storage if found.
+        err = factoryProv.ProvisionDeviceFromRAM(kInternalSRAM12Start, kInternalSRAM12End);
+        SuccessOrExit(err);
+    }
+
+#endif // WEAVE_DEVICE_CONFIG_ENABLE_FACTORY_PROVISIONING
+
     // If the fail-safe was armed when the device last shutdown, initiate a factory reset.
     if (_GetFailSafeArmed(failSafeArmed) == WEAVE_NO_ERROR && failSafeArmed)
     {

src/adaptations/device-layer/ESP32/ConfigurationManagerImpl.cpp

@@ -32,6 +32,8 @@ namespace Weave {
 namespace DeviceLayer {
 namespace Internal {
 
+// *** CAUTION ***: Changing the names or namespaces of these values will *break* existing devices.
+
 // NVS namespaces used to store device configuration information.
 const char ESP32Config::kConfigNamespace_WeaveFactory[]                    = "weave-factory";
 const char ESP32Config::kConfigNamespace_WeaveConfig[]                     = "weave-config";
@@ -42,6 +44,7 @@ const ESP32Config::Key ESP32Config::kConfigKey_SerialNum               = { kConf
 const ESP32Config::Key ESP32Config::kConfigKey_DeviceId                = { kConfigNamespace_WeaveFactory, "device-id"          };
 const ESP32Config::Key ESP32Config::kConfigKey_DeviceCert              = { kConfigNamespace_WeaveFactory, "device-cert"        };
 const ESP32Config::Key ESP32Config::kConfigKey_DevicePrivateKey        = { kConfigNamespace_WeaveFactory, "device-key"         };
+const ESP32Config::Key ESP32Config::kConfigKey_ProductRevision         = { kConfigNamespace_WeaveFactory, "product-rev"        };
 const ESP32Config::Key ESP32Config::kConfigKey_ManufacturingDate       = { kConfigNamespace_WeaveFactory, "mfg-date"           };
 const ESP32Config::Key ESP32Config::kConfigKey_PairingCode             = { kConfigNamespace_WeaveFactory, "pairing-code"       };
 

src/adaptations/device-layer/ESP32/ESP32Config.cpp

@@ -73,6 +73,8 @@ noinst_HEADERS                          = \
     include/Weave/DeviceLayer/internal/EchoServer.h \
     include/Weave/DeviceLayer/internal/EventLogging.h \
     include/Weave/DeviceLayer/internal/FabricProvisioningServer.h \
+    include/Weave/DeviceLayer/internal/FactoryProvisioning.h \
+    include/Weave/DeviceLayer/internal/FactoryProvisioning.ipp \
     include/Weave/DeviceLayer/internal/GenericConfigurationManagerImpl.h \
     include/Weave/DeviceLayer/internal/GenericConfigurationManagerImpl.ipp \
     include/Weave/DeviceLayer/internal/GenericNetworkProvisioningServerImpl.h \

src/adaptations/device-layer/Makefile.am

@@ -694,6 +694,8 @@ noinst_HEADERS = \
     include/Weave/DeviceLayer/internal/EchoServer.h \
     include/Weave/DeviceLayer/internal/EventLogging.h \
     include/Weave/DeviceLayer/internal/FabricProvisioningServer.h \
+    include/Weave/DeviceLayer/internal/FactoryProvisioning.h \
+    include/Weave/DeviceLayer/internal/FactoryProvisioning.ipp \
     include/Weave/DeviceLayer/internal/GenericConfigurationManagerImpl.h \
     include/Weave/DeviceLayer/internal/GenericConfigurationManagerImpl.ipp \
     include/Weave/DeviceLayer/internal/GenericNetworkProvisioningServerImpl.h \

src/adaptations/device-layer/Makefile.in

@@ -85,14 +85,15 @@ class ConfigurationManager
     WEAVE_ERROR GetPairedAccountId(char * buf, size_t bufSize, size_t & accountIdLen);
 
     WEAVE_ERROR StoreDeviceId(uint64_t deviceId);
-    WEAVE_ERROR StoreSerialNumber(const char * serialNum);
+    WEAVE_ERROR StoreSerialNumber(const char * serialNum, size_t serialNumLen);
     WEAVE_ERROR StorePrimaryWiFiMACAddress(const uint8_t * buf);
     WEAVE_ERROR StorePrimary802154MACAddress(const uint8_t * buf);
-    WEAVE_ERROR StoreManufacturingDate(const char * mfgDate);
+    WEAVE_ERROR StoreManufacturingDate(const char * mfgDate, size_t mfgDateLen);
+    WEAVE_ERROR StoreProductRevision(uint16_t productRev);
     WEAVE_ERROR StoreFabricId(uint64_t fabricId);
     WEAVE_ERROR StoreDeviceCertificate(const uint8_t * cert, size_t certLen);
     WEAVE_ERROR StoreDevicePrivateKey(const uint8_t * key, size_t keyLen);
-    WEAVE_ERROR StorePairingCode(const char * pairingCode);
+    WEAVE_ERROR StorePairingCode(const char * pairingCode, size_t pairingCodeLen);
     WEAVE_ERROR StoreServiceProvisioningData(uint64_t serviceId, const uint8_t * serviceConfig, size_t serviceConfigLen, const char * accountId, size_t accountIdLen);
     WEAVE_ERROR ClearServiceProvisioningData();
     WEAVE_ERROR StoreServiceConfig(const uint8_t * serviceConfig, size_t serviceConfigLen);
@@ -280,9 +281,9 @@ inline WEAVE_ERROR ConfigurationManager::StoreDeviceId(uint64_t deviceId)
     return static_cast<ImplClass*>(this)->_StoreDeviceId(deviceId);
 }
 
-inline WEAVE_ERROR ConfigurationManager::StoreSerialNumber(const char * serialNum)
+inline WEAVE_ERROR ConfigurationManager::StoreSerialNumber(const char * serialNum, size_t serialNumLen)
 {
-    return static_cast<ImplClass*>(this)->_StoreSerialNumber(serialNum);
+    return static_cast<ImplClass*>(this)->_StoreSerialNumber(serialNum, serialNumLen);
 }
 
 inline WEAVE_ERROR ConfigurationManager::StorePrimaryWiFiMACAddress(const uint8_t * buf)
@@ -295,9 +296,14 @@ inline WEAVE_ERROR ConfigurationManager::StorePrimary802154MACAddress(const uint
     return static_cast<ImplClass*>(this)->_StorePrimary802154MACAddress(buf);
 }
 
-inline WEAVE_ERROR ConfigurationManager::StoreManufacturingDate(const char * mfgDate)
+inline WEAVE_ERROR ConfigurationManager::StoreManufacturingDate(const char * mfgDate, size_t mfgDateLen)
 {
-    return static_cast<ImplClass*>(this)->_StoreManufacturingDate(mfgDate);
+    return static_cast<ImplClass*>(this)->_StoreManufacturingDate(mfgDate, mfgDateLen);
+}
+
+inline WEAVE_ERROR ConfigurationManager::StoreProductRevision(uint16_t productRev)
+{
+    return static_cast<ImplClass*>(this)->_StoreProductRevision(productRev);
 }
 
 inline WEAVE_ERROR ConfigurationManager::StoreFabricId(uint64_t fabricId)
@@ -315,9 +321,9 @@ inline WEAVE_ERROR ConfigurationManager::StoreDevicePrivateKey(const uint8_t * k
     return static_cast<ImplClass*>(this)->_StoreDevicePrivateKey(key, keyLen);
 }
 
-inline WEAVE_ERROR ConfigurationManager::StorePairingCode(const char * pairingCode)
+inline WEAVE_ERROR ConfigurationManager::StorePairingCode(const char * pairingCode, size_t pairingCodeLen)
 {
-    return static_cast<ImplClass*>(this)->_StorePairingCode(pairingCode);
+    return static_cast<ImplClass*>(this)->_StorePairingCode(pairingCode, pairingCodeLen);
 }
 
 inline WEAVE_ERROR ConfigurationManager::StoreServiceProvisioningData(uint64_t serviceId, const uint8_t * serviceConfig, size_t serviceConfigLen, const char * accountId, size_t accountIdLen)

src/adaptations/device-layer/include/Weave/DeviceLayer/ConfigurationManager.h

@@ -56,6 +56,7 @@ class ESP32Config
     static const Key kConfigKey_DeviceId;
     static const Key kConfigKey_DeviceCert;
     static const Key kConfigKey_DevicePrivateKey;
+    static const Key kConfigKey_ProductRevision;
     static const Key kConfigKey_ManufacturingDate;
     static const Key kConfigKey_PairingCode;
     static const Key kConfigKey_FabricId;

src/adaptations/device-layer/include/Weave/DeviceLayer/ESP32/ESP32Config.h

@@ -39,7 +39,7 @@
 #define WEAVE_DEVICE_CONFIG_SERVICE_DIRECTORY_CACHE_SIZE CONFIG_SERVICE_DIRECTORY_CACHE_SIZE
 #define WEAVE_DEVICE_CONFIG_DEVICE_VENDOR_ID CONFIG_DEVICE_VENDOR_ID
 #define WEAVE_DEVICE_CONFIG_DEVICE_PRODUCT_ID CONFIG_DEVICE_PRODUCT_ID
-#define WEAVE_DEVICE_CONFIG_DEVICE_PRODUCT_REVISION CONFIG_DEVICE_PRODUCT_REVISION
+#define WEAVE_DEVICE_CONFIG_DEFAULT_DEVICE_PRODUCT_REVISION CONFIG_DEFAULT_DEVICE_PRODUCT_REVISION
 #define WEAVE_DEVICE_CONFIG_DEVICE_FIRMWARE_REVISION CONFIG_DEVICE_FIRMWARE_REVISION
 #define WEAVE_DEVICE_CONFIG_WIFI_STATION_RECONNECT_INTERVAL CONFIG_WIFI_STATION_RECONNECT_INTERVAL
 #define WEAVE_DEVICE_CONFIG_MAX_SCAN_NETWORKS_RESULTS CONFIG_MAX_SCAN_NETWORKS_RESULTS

src/adaptations/device-layer/include/Weave/DeviceLayer/ESP32/WeaveDevicePlatformConfig.h

@@ -105,6 +105,18 @@
 #define WEAVE_DEVICE_CONFIG_LOG_MESSAGE_MAX_SIZE 256
 #endif
 
+/**
+ * WEAVE_DEVICE_CONFIG_ENABLE_FACTORY_PROVISIONING
+ *
+ * Enable the device factory provisioning feature.
+ *
+ * The factory provisioning feature allows factory or developer-supplied provisioning information
+ * to be injected into a device at boot time and automatically stored in persistent storage.
+ */
+#ifndef WEAVE_DEVICE_CONFIG_ENABLE_FACTORY_PROVISIONING
+#define WEAVE_DEVICE_CONFIG_ENABLE_FACTORY_PROVISIONING 1
+#endif
+
 // -------------------- Device Identification Configuration --------------------
 
 /**
@@ -127,15 +139,20 @@
 #endif
 
 /**
- * WEAVE_DEVICE_CONFIG_DEVICE_PRODUCT_REVISION
+ * WEAVE_DEVICE_CONFIG_DEFAULT_DEVICE_PRODUCT_REVISION
+ *
+ * The default product revision number assigned to the device or product by the device vendor.
+ *
+ * Product revisions are specific to a particular device vendor and product id, and typically
+ * correspond to a revision of the physical device, a change to its packaging, and/or a change
+ * to its marketing presentation. This value is generally *not* incremented for device software
+ * revisions.
  *
- * The product revision number assigned to device or product by the device vendor.  This
- * number is scoped to the device product id, and typically corresponds to a revision of the
- * physical device, a change to its packaging, and/or a change to its marketing presentation.
- * This value is generally *not* incremented for device software revisions.
+ * This is a default value which is used when a product revision has not been stored in device
+ * persistent storage (e.g. by a factory provisioning process).
  */
-#ifndef WEAVE_DEVICE_CONFIG_DEVICE_PRODUCT_REVISION
-#define WEAVE_DEVICE_CONFIG_DEVICE_PRODUCT_REVISION 1
+#ifndef WEAVE_DEVICE_CONFIG_DEFAULT_DEVICE_PRODUCT_REVISION
+#define WEAVE_DEVICE_CONFIG_DEFAULT_DEVICE_PRODUCT_REVISION 1
 #endif
 
 /**