esp-matter/components/esp_matter/esp_matter_providers.cpp

// Copyright 2023-2025 Espressif Systems (Shanghai) PTE LTD
//
// 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.

#include <credentials/examples/DeviceAttestationCredsExample.h>
#include <esp_log.h>
#include <esp_matter_providers.h>

#ifdef CONFIG_CHIP_ENABLE_EXTERNAL_PLATFORM

#ifndef EXTERNAL_ESP32DEVICEINFOPROVIDER_HEADER
#error "Please define EXTERNAL_ESP32DEVICEINFOPROVIDER_HEADER in your external platform gn/cmake file"
#endif // !EXTERNAL_ESP32DEVICEINFOPROVIDER_HEADER

#ifndef EXTERNAL_ESP32FACTORYDATAPROVIDER_HEADER
#error "Please define EXTERNAL_ESP32FACTORYDATAPROVIDER_HEADER in your external platform gn/cmake file"
#endif // !EXTERNAL_ESP32FACTORYDATAPROVIDER_HEADER

#ifndef EXTERNAL_ESP32SECURECERTDACPROVIDER_HEADER
#error "Please define EXTERNAL_ESP32SECURECERTDACPROVIDER_HEADER in your external platform gn/cmake file"
#endif // !EXTERNAL_ESP32DEVICEINFOPROVIDER_HEADER

#ifndef EXTERNAL_ESP32SECURECERTDATAPROVIDER_HEADER
#error "Please define EXTERNAL_ESP32SECURECERTDATAPROVIDER_HEADER in your external platform gn/cmake file"
#endif // !EXTERNAL_ESP32SECURECERTDATAPROVIDER_HEADER

#include EXTERNAL_ESP32DEVICEINFOPROVIDER_HEADER
#include EXTERNAL_ESP32FACTORYDATAPROVIDER_HEADER
#include EXTERNAL_ESP32SECURECERTDACPROVIDER_HEADER
#include EXTERNAL_ESP32SECURECERTDATAPROVIDER_HEADER

#else // CONFIG_CHIP_ENABLE_EXTERNAL_PLATFORM

#include <platform/ESP32/ESP32DeviceInfoProvider.h>
#include <platform/ESP32/ESP32FactoryDataProvider.h>
#include <platform/ESP32/ESP32SecureCertDACProvider.h>
#include <platform/ESP32/ESP32SecureCertDataProvider.h>
#endif // !CONFIG_CHIP_ENABLE_EXTERNAL_PLATFORM

using namespace chip::DeviceLayer;
using namespace chip::Credentials;

constexpr char TAG[] = "esp_matter_providers";

namespace esp_matter {

#ifdef CONFIG_ENABLE_ESP32_FACTORY_DATA_PROVIDER
static ESP32FactoryDataProvider factory_data_provider;
#endif // CONFIG_ENABLE_ESP32_FACTORY_DATA_PROVIDER

#ifdef CONFIG_ENABLE_ESP32_DEVICE_INFO_PROVIDER
static ESP32DeviceInfoProvider device_info_provider;
#endif // CONFIG_ENABLE_ESP32_DEVICE_INFO_PROVIDER

#ifdef CONFIG_SEC_CERT_DAC_PROVIDER
static ESP32SecureCertDACProvider sec_cert_dac_provider;
#endif // CONFIG_SEC_CERT_DAC_PROVIDER

#if defined(CONFIG_SEC_CERT_COMMISSIONABLE_DATA_PROVIDER) || defined(CONFIG_SEC_CERT_DEVICE_INSTANCE_INFO_PROVIDER)
static ESP32SecureCertDataProvider secure_cert_data_provider;
#endif // CONFIG_SEC_CERT_COMMISSIONABLE_DATA_PROVIDER || CONFIG_SEC_CERT_DEVICE_INSTANCE_INFO_PROVIDER

#ifdef CONFIG_CUSTOM_DAC_PROVIDER
static DeviceAttestationCredentialsProvider *s_custom_dac_provider = NULL;
void set_custom_dac_provider(DeviceAttestationCredentialsProvider *provider)
{
    s_custom_dac_provider = provider;
}
#endif // CONFIG_CUSTOM_DAC_PROVIDER

#ifdef CONFIG_CUSTOM_COMMISSIONABLE_DATA_PROVIDER
static CommissionableDataProvider *s_custom_commissionable_data_provider = NULL;
void set_custom_commissionable_data_provider(CommissionableDataProvider *provider)
{
    s_custom_commissionable_data_provider = provider;
}
#endif // CONFIG_CUSTOM_COMMISSIONABLE_DATA_PROVIDER

#ifdef CONFIG_CUSTOM_DEVICE_INSTANCE_INFO_PROVIDER
static DeviceInstanceInfoProvider *s_custom_device_instance_info_provider = NULL;
void set_custom_device_instance_info_provider(DeviceInstanceInfoProvider *provider)
{
    s_custom_device_instance_info_provider = provider;
}
#endif // CONFIG_CUSTOM_DEVICE_INSTANCE_INFO_PROVIDER

#ifdef CONFIG_CUSTOM_DEVICE_INFO_PROVIDER
static DeviceInfoProvider *s_custom_device_info_provider = NULL;
void set_custom_device_info_provider(DeviceInfoProvider *provider)
{
    s_custom_device_info_provider = provider;
}
#endif // CONFIG_CUSTOM_DEVICE_INFO_PROVIDER

DeviceAttestationCredentialsProvider *get_dac_provider(void)
{
#ifdef CONFIG_CUSTOM_DAC_PROVIDER
    if (s_custom_dac_provider) {
        return s_custom_dac_provider;
    } else {
        ESP_LOGE(TAG, "custom_dac_provider cannot be NULL");
    }
#elif defined(CONFIG_EXAMPLE_DAC_PROVIDER)
    return chip::Credentials::Examples::GetExampleDACProvider();
#elif defined(CONFIG_SEC_CERT_DAC_PROVIDER)
    return &sec_cert_dac_provider;
#elif defined(CONFIG_FACTORY_PARTITION_DAC_PROVIDER)
    return &factory_data_provider;
#endif
    return NULL;
}

// helper function to set the commissionable data provider based on the config option
static void set_commissionable_data_provider(void)
{
    CommissionableDataProvider *provider = NULL;
#ifdef CONFIG_FACTORY_COMMISSIONABLE_DATA_PROVIDER
    provider = &factory_data_provider;
#elif defined(CONFIG_SEC_CERT_COMMISSIONABLE_DATA_PROVIDER)
    provider = &secure_cert_data_provider;
#elif defined(CONFIG_CUSTOM_COMMISSIONABLE_DATA_PROVIDER)
    provider = s_custom_commissionable_data_provider;
#endif

    // We should do nothing if CONFIG_EXAMPLE_COMMISSIONABLE_DATA_PROVIDER is enabled as
    // LegacyTemporaryCommissionableDataProvider is set in GenericConfigurationManagerImpl<ConfigClass>::Init()
    if (provider) {
        SetCommissionableDataProvider(provider);
    }
}

// helper function to set the device instance info provider based on the config option
static void set_device_instance_info_provider(void)
{
    DeviceInstanceInfoProvider *provider = NULL;
#ifdef CONFIG_FACTORY_DEVICE_INSTANCE_INFO_PROVIDER
    provider = &factory_data_provider;
#elif defined(CONFIG_SEC_CERT_DEVICE_INSTANCE_INFO_PROVIDER)
    provider = &secure_cert_data_provider;
#elif defined(CONFIG_CUSTOM_DEVICE_INSTANCE_INFO_PROVIDER)
    provider = s_custom_device_instance_info_provider;
#endif

    // We should do nothing if CONFIG_EXAMPLE_DEVICE_INSTANCE_INFO_PROVIDER is enabled as
    // GenericDeviceInstanceInfoProvider is set in GenericConfigurationManagerImpl<ConfigClass>::Init()
    if (provider) {
        SetDeviceInstanceInfoProvider(provider);
    }
}

// helper function to set the device info provider based on the config option
static void set_device_info_provider(void)
{
    DeviceInfoProvider *provider = NULL;
#ifdef CONFIG_FACTORY_DEVICE_INFO_PROVIDER
    provider = &device_info_provider;
#elif defined(CONFIG_CUSTOM_DEVICE_INFO_PROVIDER)
    provider = s_custom_device_info_provider;
#endif

    if (provider) {
        SetDeviceInfoProvider(provider);
    }
}

void setup_providers()
{
    set_commissionable_data_provider();
    set_device_instance_info_provider();
    set_device_info_provider();
    SetDeviceAttestationCredentialsProvider(get_dac_provider());
}

} // namespace esp_matter