| /* |
| * |
| * Copyright (c) 2023 Project CHIP Authors |
| * Copyright 2023 NXP |
| * |
| * 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. |
| */ |
| #pragma once |
| |
| #include <credentials/CHIPCert.h> |
| #include <credentials/DeviceAttestationCredsProvider.h> |
| #include <include/platform/CommissionableDataProvider.h> |
| #include <include/platform/ConfigurationManager.h> |
| #include <include/platform/DeviceInstanceInfoProvider.h> |
| |
| namespace chip { |
| namespace DeviceLayer { |
| |
| class FactoryDataProviderImpl; |
| |
| /** |
| * @brief This class provides Commissionable data and Device Attestation Credentials. |
| */ |
| |
| class FactoryDataProvider : public chip::Credentials::DeviceAttestationCredentialsProvider, |
| public CommissionableDataProvider, |
| public DeviceInstanceInfoProvider |
| { |
| using ImplClass = ::chip::DeviceLayer::FactoryDataProviderImpl; |
| |
| public: |
| enum EncryptionMode |
| { |
| encrypt_none = 0U, |
| encrypt_ecb = 1U, |
| encrypt_cbc = 2U |
| }; |
| |
| // Default factory data IDs |
| enum FactoryDataId |
| { |
| kVerifierId = 1, |
| kSaltId, |
| kIcId, |
| kDacPrivateKeyId, |
| kDacCertificateId, |
| kPaiCertificateId, |
| kDiscriminatorId, |
| kSetupPasscodeId, |
| kVidId, |
| kPidId, |
| kCertDeclarationId, |
| kVendorNameId, |
| kProductNameId, |
| kSerialNumberId, |
| kManufacturingDateId, |
| kHardwareVersionId, |
| kHardwareVersionStrId, |
| kUniqueId, |
| kPartNumber, |
| kProductURL, |
| kProductLabel, |
| kProductFinish, |
| kProductPrimaryColor, |
| kMaxId |
| }; |
| |
| CHIP_ERROR Init(void); |
| |
| // ===== Members functions that implement the DeviceAttestationCredentialsProvider |
| CHIP_ERROR GetCertificationDeclaration(MutableByteSpan & outBuffer) override; |
| CHIP_ERROR GetFirmwareInformation(MutableByteSpan & out_firmware_info_buffer) override; |
| CHIP_ERROR GetDeviceAttestationCert(MutableByteSpan & outBuffer) override; |
| CHIP_ERROR GetProductAttestationIntermediateCert(MutableByteSpan & outBuffer) override; |
| CHIP_ERROR SignWithDeviceAttestationKey(const ByteSpan & digestToSign, MutableByteSpan & outSignBuffer) override; |
| |
| // ===== Members functions that implement the CommissionableDataProvider |
| CHIP_ERROR GetSetupDiscriminator(uint16_t & setupDiscriminator) override; |
| CHIP_ERROR SetSetupDiscriminator(uint16_t setupDiscriminator) override; |
| CHIP_ERROR GetSpake2pIterationCount(uint32_t & iterationCount) override; |
| CHIP_ERROR GetSpake2pSalt(MutableByteSpan & saltBuf) override; |
| CHIP_ERROR GetSpake2pVerifier(MutableByteSpan & verifierBuf, size_t & verifierLen) override; |
| CHIP_ERROR GetSetupPasscode(uint32_t & setupPasscode) override; |
| CHIP_ERROR SetSetupPasscode(uint32_t setupPasscode) override; |
| |
| // ===== Members functions that implement the DeviceInstanceInfoProvider |
| CHIP_ERROR GetVendorName(char * buf, size_t bufSize) override; |
| CHIP_ERROR GetVendorId(uint16_t & vendorId) override; |
| CHIP_ERROR GetPartNumber(char * buf, size_t bufSize) override; |
| CHIP_ERROR GetProductURL(char * buf, size_t bufSize) override; |
| CHIP_ERROR GetProductLabel(char * buf, size_t bufSize) override; |
| |
| CHIP_ERROR GetProductName(char * buf, size_t bufSize) override; |
| CHIP_ERROR GetProductId(uint16_t & productId) override; |
| CHIP_ERROR GetSerialNumber(char * buf, size_t bufSize) override; |
| CHIP_ERROR GetManufacturingDate(uint16_t & year, uint8_t & month, uint8_t & day) override; |
| CHIP_ERROR GetHardwareVersion(uint16_t & hardwareVersion) override; |
| CHIP_ERROR GetHardwareVersionString(char * buf, size_t bufSize) override; |
| CHIP_ERROR GetRotatingDeviceIdUniqueId(MutableByteSpan & uniqueIdSpan) override; |
| CHIP_ERROR GetProductFinish(app::Clusters::BasicInformation::ProductFinishEnum * finish) override; |
| CHIP_ERROR GetProductPrimaryColor(app::Clusters::BasicInformation::ColorEnum * primaryColor) override; |
| |
| protected: |
| // Methods to be implemented by impl class delegate. |
| CHIP_ERROR SearchForId(uint8_t searchedType, uint8_t * pBuf, size_t bufLength, uint16_t & length, |
| uint32_t * contentAddr = NULL); |
| CHIP_ERROR SignWithDacKey(const ByteSpan & digestToSign, MutableByteSpan & outSignBuffer); |
| }; |
| |
| extern FactoryDataProvider & FactoryDataPrvd(); |
| |
| extern FactoryDataProviderImpl & FactoryDataPrvdImpl(); |
| |
| } // namespace DeviceLayer |
| } // namespace chip |
| |
| #include EXTERNAL_FACTORY_DATA_PROVIDER_IMPL_HEADER |