src/controller/python/OpCredsBinding.cpp - third_party/github/project-chip/connectedhomeip - Git at Google

 /*
  *
  *    Copyright (c) 2020-2022 Project CHIP Authors
  *    Copyright (c) 2019-2020 Google LLC.
  *    Copyright (c) 2013-2018 Nest Labs, Inc.
  *    All rights reserved.
  *
  *    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 <type_traits>

 #include "ChipDeviceController-ScriptDevicePairingDelegate.h"
 #include "ChipDeviceController-StorageDelegate.h"

 #include "controller/python/chip/interaction_model/Delegate.h"

 #include <controller/CHIPDeviceController.h>
 #include <controller/CHIPDeviceControllerFactory.h>
 #include <controller/ExampleOperationalCredentialsIssuer.h>
 #include <lib/support/BytesToHex.h>
 #include <lib/support/CHIPMem.h>
 #include <lib/support/CodeUtils.h>
 #include <lib/support/DLLUtil.h>
 #include <lib/support/ScopedBuffer.h>
 #include <lib/support/TestGroupData.h>
 #include <lib/support/logging/CHIPLogging.h>

 #include <credentials/GroupDataProviderImpl.h>
 #include <credentials/attestation_verifier/DefaultDeviceAttestationVerifier.h>
 #include <credentials/attestation_verifier/DeviceAttestationVerifier.h>
 #include <credentials/attestation_verifier/FileAttestationTrustStore.h>

 using namespace chip;

 static_assert(std::is_same<uint32_t, ChipError::StorageType>::value, "python assumes CHIP_ERROR maps to c_uint32");

 using Py_GenerateNOCChainFunc         = void (*)(void * pyContext, const char * csrElements, const char * attestationSignature,
                                          const char * dac, const char * pai, const char * paa,
                                          Controller::OnNOCChainGeneration onNocChainGenerationFunc);
 using Py_SetNodeIdForNextNOCRequest   = void (*)(void * pyContext, NodeId nodeId);
 using Py_SetFabricIdForNextNOCRequest = void (*)(void * pyContext, FabricId fabricId);

 namespace {
 const chip::Credentials::AttestationTrustStore * GetTestFileAttestationTrustStore(const char * paaTrustStorePath)
 {
     static chip::Credentials::FileAttestationTrustStore attestationTrustStore{ paaTrustStorePath };

     return &attestationTrustStore;
 }
 } // namespace

 namespace chip {
 namespace Controller {
 namespace Python {

 class OperationalCredentialsAdapter : public OperationalCredentialsDelegate
 {
 public:
     OperationalCredentialsAdapter(uint32_t fabricCredentialsIndex) : mExampleOpCredsIssuer(fabricCredentialsIndex) {}

     CHIP_ERROR Initialize(PersistentStorageDelegate & storageDelegate) { return mExampleOpCredsIssuer.Initialize(storageDelegate); }

     CHIP_ERROR GenerateNOCChain(NodeId nodeId, FabricId fabricId, const CATValues & cats, const Crypto::P256PublicKey & pubKey,
                                 MutableByteSpan & rcac, MutableByteSpan & icac, MutableByteSpan & noc)
     {
         return mExampleOpCredsIssuer.GenerateNOCChainAfterValidation(nodeId, fabricId, cats, pubKey, rcac, icac, noc);
     }

 private:
     CHIP_ERROR GenerateNOCChain(const ByteSpan & csrElements, const ByteSpan & csrNonce, const ByteSpan & attestationSignature,
                                 const ByteSpan & attestationChallenge, const ByteSpan & DAC, const ByteSpan & PAI,
                                 Callback::Callback<OnNOCChainGeneration> * onCompletion) override
     {
         return mExampleOpCredsIssuer.GenerateNOCChain(csrElements, csrNonce, attestationSignature, attestationChallenge, DAC, PAI,
                                                       onCompletion);
     }

     void SetNodeIdForNextNOCRequest(NodeId nodeId) override { mExampleOpCredsIssuer.SetNodeIdForNextNOCRequest(nodeId); }

     void SetFabricIdForNextNOCRequest(FabricId fabricId) override { mExampleOpCredsIssuer.SetFabricIdForNextNOCRequest(fabricId); }

     ExampleOperationalCredentialsIssuer mExampleOpCredsIssuer;
 };

 } // namespace Python
 } // namespace Controller
 } // namespace chip

 extern chip::Controller::Python::StorageAdapter * pychip_Storage_GetStorageAdapter();
 extern chip::Credentials::GroupDataProviderImpl sGroupDataProvider;
 extern chip::Controller::ScriptDevicePairingDelegate sPairingDelegate;

 class TestCommissioner : public chip::Controller::AutoCommissioner
 {
 public:
     TestCommissioner() { Reset(); }
     ~TestCommissioner() {}
     CHIP_ERROR SetCommissioningParameters(const chip::Controller::CommissioningParameters & params) override
     {
         mIsWifi   = false;
         mIsThread = false;
         if (params.GetWiFiCredentials().HasValue())
         {
             mIsWifi = true;
         }
         else if (params.GetThreadOperationalDataset().HasValue())
         {
             mIsThread = true;
         }
         return chip::Controller::AutoCommissioner::SetCommissioningParameters(params);
     }
     CHIP_ERROR CommissioningStepFinished(CHIP_ERROR err,
                                          chip::Controller::CommissioningDelegate::CommissioningReport report) override
     {
         mTestCommissionerUsed = true;
         if (mFailOnReportAfterStage == report.stageCompleted)
         {
             return CHIP_ERROR_INTERNAL;
         }
         if (mSimulateFailureOnStage == report.stageCompleted)
         {
             // Pretend we received an error from the device during this stage
             err = CHIP_ERROR_INTERNAL;
         }
         return chip::Controller::AutoCommissioner::CommissioningStepFinished(err, report);
     }
     // This will cause the COMMISSIONER to fail after the given stage. Setting this to kSecurePairing will cause the
     // StartCommissioning call to fail.
     bool SimulateFailAfter(chip::Controller::CommissioningStage stage)
     {
         ChipLogProgress(Controller, "setting simulate fail after stage %s", chip::Controller::StageToString(stage));
         if (!ValidStage(stage) && stage != chip::Controller::CommissioningStage::kError)
         {
             return false;
         }
         mSimulateFailureOnStage = stage;
         return true;
     }
     bool SimulateFailOnReport(chip::Controller::CommissioningStage stage)
     {
         if (!ValidStage(stage) && stage != chip::Controller::CommissioningStage::kError)
         {
             return false;
         }
         mFailOnReportAfterStage = stage;
         return true;
     }
     bool CheckCallbacks()
     {
         bool successFailureOk;
         bool updatesOk;
         if (mFailOnReportAfterStage != chip::Controller::CommissioningStage::kError)
         {
             successFailureOk = mReceivedCommissioningFailureStage == mFailOnReportAfterStage && !mReceivedCommissioningSuccess;
             updatesOk        = StatusUpdatesOk(mFailOnReportAfterStage);
         }
         else if (mSimulateFailureOnStage != chip::Controller::CommissioningStage::kError)
         {
             successFailureOk = mReceivedCommissioningFailureStage == mSimulateFailureOnStage && !mReceivedCommissioningSuccess;
             updatesOk        = StatusUpdatesOk(mSimulateFailureOnStage);
         }
         else
         {
             successFailureOk = mReceivedCommissioningSuccess;
             updatesOk        = StatusUpdatesOk(chip::Controller::CommissioningStage::kError);
         }
         ChipLogProgress(Controller, "Checking callbacks: success failure ok? %d updates ok? %d", successFailureOk, updatesOk);
         return successFailureOk && updatesOk;
     }
     bool CheckPaseConnection(NodeId nodeId)
     {
         bool paseShouldBeOpen = false;
         if (chip::to_underlying(mFailOnReportAfterStage) >=
                 chip::to_underlying(chip::Controller::CommissioningStage::kWiFiNetworkSetup) ||
             chip::to_underlying(mSimulateFailureOnStage) >=
                 chip::to_underlying(chip::Controller::CommissioningStage::kWiFiNetworkSetup))
         {
             // Pase should be open still
             paseShouldBeOpen = true;
         }
         CommissioneeDeviceProxy * proxy;
         bool paseIsOpen =
             (chip::Controller::AutoCommissioner::GetCommissioner()->GetDeviceBeingCommissioned(nodeId, &proxy) == CHIP_NO_ERROR);
         ChipLogProgress(Controller, "Checking pase connection state: Should be open? %d is open? %d", paseShouldBeOpen, paseIsOpen);

         return paseShouldBeOpen == paseIsOpen;
     }
     void Reset()
     {
         mTestCommissionerUsed              = false;
         mReceivedCommissioningSuccess      = false;
         mReceivedCommissioningFailureStage = chip::Controller::CommissioningStage::kError;
         for (size_t i = 0; i < kNumCommissioningStages; ++i)
         {
             mReceivedStageSuccess[i] = false;
             mReceivedStageFailure[i] = false;
         }
         mSimulateFailureOnStage = chip::Controller::CommissioningStage::kError;
         mFailOnReportAfterStage = chip::Controller::CommissioningStage::kError;
     }
     bool GetTestCommissionerUsed() { return mTestCommissionerUsed; }
     void OnCommissioningSuccess(chip::PeerId peerId) { mReceivedCommissioningSuccess = true; }
     void OnCommissioningFailure(chip::PeerId peerId, CHIP_ERROR error, chip::Controller::CommissioningStage stageFailed,
                                 chip::Optional<chip::Credentials::AttestationVerificationResult> additionalErrorInfo)
     {
         mReceivedCommissioningFailureStage = stageFailed;
     }
     void OnCommissioningStatusUpdate(chip::PeerId peerId, chip::Controller::CommissioningStage stageCompleted, CHIP_ERROR error)
     {
         if (error == CHIP_NO_ERROR)
         {
             mReceivedStageSuccess[chip::to_underlying(stageCompleted)] = true;
         }
         else
         {
             mReceivedStageFailure[chip::to_underlying(stageCompleted)] = true;
         }
     }

 private:
     static constexpr uint8_t kNumCommissioningStages = chip::to_underlying(chip::Controller::CommissioningStage::kCleanup) + 1;
     chip::Controller::CommissioningStage mSimulateFailureOnStage            = chip::Controller::CommissioningStage::kError;
     chip::Controller::CommissioningStage mFailOnReportAfterStage            = chip::Controller::CommissioningStage::kError;
     bool mTestCommissionerUsed                                              = false;
     bool mReceivedCommissioningSuccess                                      = false;
     chip::Controller::CommissioningStage mReceivedCommissioningFailureStage = chip::Controller::CommissioningStage::kError;
     bool mReceivedStageSuccess[kNumCommissioningStages];
     bool mReceivedStageFailure[kNumCommissioningStages];
     bool mIsWifi   = false;
     bool mIsThread = false;
     bool ValidStage(chip::Controller::CommissioningStage stage)
     {
         if (!mIsWifi &&
             (stage == chip::Controller::CommissioningStage::kWiFiNetworkEnable ||
              stage == chip::Controller::CommissioningStage::kWiFiNetworkSetup))
         {
             return false;
         }
         if (!mIsThread &&
             (stage == chip::Controller::CommissioningStage::kThreadNetworkEnable ||
              stage == chip::Controller::CommissioningStage::kThreadNetworkSetup))
         {
             return false;
         }
         if (stage == chip::Controller::CommissioningStage::kError || stage == chip::Controller::CommissioningStage::kSecurePairing)
         {
             return false;
         }
         return true;
     }
     bool StatusUpdatesOk(chip::Controller::CommissioningStage failedStage)
     {
         // Because we're just simulating a failure here, we will have received a success callback even for the failed stage.
         for (uint8_t i = 0; i < kNumCommissioningStages; ++i)
         {
             if (mReceivedStageFailure[i])
             {
                 return false;
             }
             if (!ValidStage(static_cast<chip::Controller::CommissioningStage>(i)))
             {
                 continue;
             }
             // Anything above our current stage we won't have received a callback for. We also expect that the "failed" stage will
             // have a success callback because we're just faking the failure here and overwriting error.
             if (i == chip::to_underlying(failedStage))
             {
                 break;
             }
         }
         return true;
     }
 };
 TestCommissioner sTestCommissioner;

 extern "C" {
 struct OpCredsContext
 {
     Platform::UniquePtr<Controller::Python::OperationalCredentialsAdapter> mAdapter;
     void * mPyContext;
 };

 void * pychip_OpCreds_InitializeDelegate(void * pyContext, uint32_t fabricCredentialsIndex)
 {
     auto context      = Platform::MakeUnique<OpCredsContext>();
     context->mAdapter = Platform::MakeUnique<Controller::Python::OperationalCredentialsAdapter>(fabricCredentialsIndex);

     if (pychip_Storage_GetStorageAdapter() == nullptr)
     {
         return nullptr;
     }

     if (context->mAdapter->Initialize(*pychip_Storage_GetStorageAdapter()) != CHIP_NO_ERROR)
     {
         return nullptr;
     }

     return context.release();
 }

 void pychip_OnCommissioningSuccess(PeerId peerId)
 {
     sTestCommissioner.OnCommissioningSuccess(peerId);
 }
 void pychip_OnCommissioningFailure(chip::PeerId peerId, CHIP_ERROR error, chip::Controller::CommissioningStage stageFailed,
                                    chip::Optional<chip::Credentials::AttestationVerificationResult> additionalErrorInfo)
 {
     sTestCommissioner.OnCommissioningFailure(peerId, error, stageFailed, additionalErrorInfo);
 }
 void pychip_OnCommissioningStatusUpdate(chip::PeerId peerId, chip::Controller::CommissioningStage stageCompleted, CHIP_ERROR err)
 {
     return sTestCommissioner.OnCommissioningStatusUpdate(peerId, stageCompleted, err);
 }

 ChipError::StorageType pychip_OpCreds_AllocateController(OpCredsContext * context,
                                                          chip::Controller::DeviceCommissioner ** outDevCtrl, uint8_t fabricIndex,
                                                          FabricId fabricId, chip::NodeId nodeId, const char * paaTrustStorePath,
                                                          bool useTestCommissioner)
 {
     ChipLogDetail(Controller, "Creating New Device Controller");

     VerifyOrReturnError(context != nullptr, CHIP_ERROR_INVALID_ARGUMENT.AsInteger());

     auto devCtrl = std::make_unique<chip::Controller::DeviceCommissioner>();
     VerifyOrReturnError(devCtrl != nullptr, CHIP_ERROR_NO_MEMORY.AsInteger());

     if (paaTrustStorePath == nullptr)
     {
         paaTrustStorePath = "./credentials/development/paa-root-certs";
     }
     ChipLogProgress(Support, "Using device attestation PAA trust store path %s.", paaTrustStorePath);

     // Initialize device attestation verifier
     const chip::Credentials::AttestationTrustStore * testingRootStore = GetTestFileAttestationTrustStore(paaTrustStorePath);
     SetDeviceAttestationVerifier(GetDefaultDACVerifier(testingRootStore));

     chip::Crypto::P256Keypair ephemeralKey;
     CHIP_ERROR err = ephemeralKey.Initialize();
     VerifyOrReturnError(err == CHIP_NO_ERROR, err.AsInteger());

     chip::Platform::ScopedMemoryBuffer<uint8_t> noc;
     ReturnErrorCodeIf(!noc.Alloc(Controller::kMaxCHIPDERCertLength), CHIP_ERROR_NO_MEMORY.AsInteger());
     MutableByteSpan nocSpan(noc.Get(), Controller::kMaxCHIPDERCertLength);

     chip::Platform::ScopedMemoryBuffer<uint8_t> icac;
     ReturnErrorCodeIf(!icac.Alloc(Controller::kMaxCHIPDERCertLength), CHIP_ERROR_NO_MEMORY.AsInteger());
     MutableByteSpan icacSpan(icac.Get(), Controller::kMaxCHIPDERCertLength);

     chip::Platform::ScopedMemoryBuffer<uint8_t> rcac;
     ReturnErrorCodeIf(!rcac.Alloc(Controller::kMaxCHIPDERCertLength), CHIP_ERROR_NO_MEMORY.AsInteger());
     MutableByteSpan rcacSpan(rcac.Get(), Controller::kMaxCHIPDERCertLength);

     err = context->mAdapter->GenerateNOCChain(nodeId, fabricId, chip::kUndefinedCATs, ephemeralKey.Pubkey(), rcacSpan, icacSpan,
                                               nocSpan);
     VerifyOrReturnError(err == CHIP_NO_ERROR, err.AsInteger());

     Controller::SetupParams initParams;
     initParams.pairingDelegate                = &sPairingDelegate;
     initParams.operationalCredentialsDelegate = context->mAdapter.get();
     initParams.operationalKeypair             = &ephemeralKey;
     initParams.controllerRCAC                 = rcacSpan;
     initParams.controllerICAC                 = icacSpan;
     initParams.controllerNOC                  = nocSpan;
     initParams.enableServerInteractions       = true;

     if (useTestCommissioner)
     {
         initParams.defaultCommissioner = &sTestCommissioner;
         sPairingDelegate.SetCommissioningSuccessCallback(pychip_OnCommissioningSuccess);
         sPairingDelegate.SetCommissioningFailureCallback(pychip_OnCommissioningFailure);
         sPairingDelegate.SetCommissioningStatusUpdateCallback(pychip_OnCommissioningStatusUpdate);
     }

     err = Controller::DeviceControllerFactory::GetInstance().SetupCommissioner(initParams, *devCtrl);
     VerifyOrReturnError(err == CHIP_NO_ERROR, err.AsInteger());

     // Setup IPK in Group Data Provider for controller after Commissioner init which sets-up the fabric table entry
     FabricInfo * fabricInfo = devCtrl->GetFabricInfo();
     VerifyOrReturnError(fabricInfo != nullptr, CHIP_ERROR_INTERNAL.AsInteger());

     uint8_t compressedFabricId[sizeof(uint64_t)] = { 0 };
     chip::MutableByteSpan compressedFabricIdSpan(compressedFabricId);

     err = fabricInfo->GetCompressedId(compressedFabricIdSpan);
     VerifyOrReturnError(err == CHIP_NO_ERROR, err.AsInteger());

     ChipLogProgress(Support, "Setting up group data for Fabric Index %u with Compressed Fabric ID:",
                     static_cast<unsigned>(fabricInfo->GetFabricIndex()));
     ChipLogByteSpan(Support, compressedFabricIdSpan);

     chip::ByteSpan defaultIpk = chip::GroupTesting::DefaultIpkValue::GetDefaultIpk();
     err = chip::Credentials::SetSingleIpkEpochKey(&sGroupDataProvider, fabricInfo->GetFabricIndex(), defaultIpk,
                                                   compressedFabricIdSpan);
     VerifyOrReturnError(err == CHIP_NO_ERROR, err.AsInteger());

     *outDevCtrl = devCtrl.release();

     return CHIP_NO_ERROR.AsInteger();
 }

 void pychip_OpCreds_FreeDelegate(OpCredsContext * context)
 {
     Platform::Delete(context);
 }

 ChipError::StorageType pychip_DeviceController_DeleteDeviceController(chip::Controller::DeviceCommissioner * devCtrl)
 {
     if (devCtrl != nullptr)
     {
         devCtrl->Shutdown();
         delete devCtrl;
     }

     return CHIP_NO_ERROR.AsInteger();
 }

 bool pychip_TestCommissionerUsed()
 {
     return sTestCommissioner.GetTestCommissionerUsed();
 }

 bool pychip_TestCommissioningCallbacks()
 {
     return sTestCommissioner.CheckCallbacks();
 }

 bool pychip_TestPaseConnection(NodeId nodeId)
 {
     return sTestCommissioner.CheckPaseConnection(nodeId);
 }

 void pychip_ResetCommissioningTests()
 {
     sTestCommissioner.Reset();
 }

 // Returns True if this is a valid test, false otherwise
 bool pychip_SetTestCommissionerSimulateFailureOnStage(uint8_t failStage)
 {
     return sTestCommissioner.SimulateFailAfter(static_cast<chip::Controller::CommissioningStage>(failStage));
 }
 bool pychip_SetTestCommissionerSimulateFailureOnReport(uint8_t failStage)
 {
     return sTestCommissioner.SimulateFailOnReport(static_cast<chip::Controller::CommissioningStage>(failStage));
 }

 } // extern "C"
	/*
	*
	* Copyright (c) 2020-2022 Project CHIP Authors
	* Copyright (c) 2019-2020 Google LLC.
	* Copyright (c) 2013-2018 Nest Labs, Inc.
	* All rights reserved.
	*
	* 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 <type_traits>

	#include "ChipDeviceController-ScriptDevicePairingDelegate.h"
	#include "ChipDeviceController-StorageDelegate.h"

	#include "controller/python/chip/interaction_model/Delegate.h"

	#include <controller/CHIPDeviceController.h>
	#include <controller/CHIPDeviceControllerFactory.h>
	#include <controller/ExampleOperationalCredentialsIssuer.h>
	#include <lib/support/BytesToHex.h>
	#include <lib/support/CHIPMem.h>
	#include <lib/support/CodeUtils.h>
	#include <lib/support/DLLUtil.h>
	#include <lib/support/ScopedBuffer.h>
	#include <lib/support/TestGroupData.h>
	#include <lib/support/logging/CHIPLogging.h>

	#include <credentials/GroupDataProviderImpl.h>
	#include <credentials/attestation_verifier/DefaultDeviceAttestationVerifier.h>
	#include <credentials/attestation_verifier/DeviceAttestationVerifier.h>
	#include <credentials/attestation_verifier/FileAttestationTrustStore.h>

	using namespace chip;

	static_assert(std::is_same<uint32_t, ChipError::StorageType>::value, "python assumes CHIP_ERROR maps to c_uint32");

	using Py_GenerateNOCChainFunc = void ()(void pyContext, const char * csrElements, const char * attestationSignature,
	const char * dac, const char * pai, const char * paa,
	Controller::OnNOCChainGeneration onNocChainGenerationFunc);
	using Py_SetNodeIdForNextNOCRequest = void ()(void pyContext, NodeId nodeId);
	using Py_SetFabricIdForNextNOCRequest = void ()(void pyContext, FabricId fabricId);

	namespace {
	const chip::Credentials::AttestationTrustStore * GetTestFileAttestationTrustStore(const char * paaTrustStorePath)
	{
	static chip::Credentials::FileAttestationTrustStore attestationTrustStore{ paaTrustStorePath };

	return &attestationTrustStore;
	}
	} // namespace

	namespace chip {
	namespace Controller {
	namespace Python {

	class OperationalCredentialsAdapter : public OperationalCredentialsDelegate
	{
	public:
	OperationalCredentialsAdapter(uint32_t fabricCredentialsIndex) : mExampleOpCredsIssuer(fabricCredentialsIndex) {}

	CHIP_ERROR Initialize(PersistentStorageDelegate & storageDelegate) { return mExampleOpCredsIssuer.Initialize(storageDelegate); }

	CHIP_ERROR GenerateNOCChain(NodeId nodeId, FabricId fabricId, const CATValues & cats, const Crypto::P256PublicKey & pubKey,
	MutableByteSpan & rcac, MutableByteSpan & icac, MutableByteSpan & noc)
	{
	return mExampleOpCredsIssuer.GenerateNOCChainAfterValidation(nodeId, fabricId, cats, pubKey, rcac, icac, noc);
	}

	private:
	CHIP_ERROR GenerateNOCChain(const ByteSpan & csrElements, const ByteSpan & csrNonce, const ByteSpan & attestationSignature,
	const ByteSpan & attestationChallenge, const ByteSpan & DAC, const ByteSpan & PAI,
	Callback::Callback<OnNOCChainGeneration> * onCompletion) override
	{
	return mExampleOpCredsIssuer.GenerateNOCChain(csrElements, csrNonce, attestationSignature, attestationChallenge, DAC, PAI,
	onCompletion);
	}

	void SetNodeIdForNextNOCRequest(NodeId nodeId) override { mExampleOpCredsIssuer.SetNodeIdForNextNOCRequest(nodeId); }

	void SetFabricIdForNextNOCRequest(FabricId fabricId) override { mExampleOpCredsIssuer.SetFabricIdForNextNOCRequest(fabricId); }

	ExampleOperationalCredentialsIssuer mExampleOpCredsIssuer;
	};

	} // namespace Python
	} // namespace Controller
	} // namespace chip

	extern chip::Controller::Python::StorageAdapter * pychip_Storage_GetStorageAdapter();
	extern chip::Credentials::GroupDataProviderImpl sGroupDataProvider;
	extern chip::Controller::ScriptDevicePairingDelegate sPairingDelegate;

	class TestCommissioner : public chip::Controller::AutoCommissioner
	{
	public:
	TestCommissioner() { Reset(); }
	~TestCommissioner() {}
	CHIP_ERROR SetCommissioningParameters(const chip::Controller::CommissioningParameters & params) override
	{
	mIsWifi = false;
	mIsThread = false;
	if (params.GetWiFiCredentials().HasValue())
	{
	mIsWifi = true;
	}
	else if (params.GetThreadOperationalDataset().HasValue())
	{
	mIsThread = true;
	}
	return chip::Controller::AutoCommissioner::SetCommissioningParameters(params);
	}
	CHIP_ERROR CommissioningStepFinished(CHIP_ERROR err,
	chip::Controller::CommissioningDelegate::CommissioningReport report) override
	{
	mTestCommissionerUsed = true;
	if (mFailOnReportAfterStage == report.stageCompleted)
	{
	return CHIP_ERROR_INTERNAL;
	}
	if (mSimulateFailureOnStage == report.stageCompleted)
	{
	// Pretend we received an error from the device during this stage
	err = CHIP_ERROR_INTERNAL;
	}
	return chip::Controller::AutoCommissioner::CommissioningStepFinished(err, report);
	}
	// This will cause the COMMISSIONER to fail after the given stage. Setting this to kSecurePairing will cause the
	// StartCommissioning call to fail.
	bool SimulateFailAfter(chip::Controller::CommissioningStage stage)
	{
	ChipLogProgress(Controller, "setting simulate fail after stage %s", chip::Controller::StageToString(stage));
	if (!ValidStage(stage) && stage != chip::Controller::CommissioningStage::kError)
	{
	return false;
	}
	mSimulateFailureOnStage = stage;
	return true;
	}
	bool SimulateFailOnReport(chip::Controller::CommissioningStage stage)
	{
	if (!ValidStage(stage) && stage != chip::Controller::CommissioningStage::kError)
	{
	return false;
	}
	mFailOnReportAfterStage = stage;
	return true;
	}
	bool CheckCallbacks()
	{
	bool successFailureOk;
	bool updatesOk;
	if (mFailOnReportAfterStage != chip::Controller::CommissioningStage::kError)
	{
	successFailureOk = mReceivedCommissioningFailureStage == mFailOnReportAfterStage && !mReceivedCommissioningSuccess;
	updatesOk = StatusUpdatesOk(mFailOnReportAfterStage);
	}
	else if (mSimulateFailureOnStage != chip::Controller::CommissioningStage::kError)
	{
	successFailureOk = mReceivedCommissioningFailureStage == mSimulateFailureOnStage && !mReceivedCommissioningSuccess;
	updatesOk = StatusUpdatesOk(mSimulateFailureOnStage);
	}
	else
	{
	successFailureOk = mReceivedCommissioningSuccess;
	updatesOk = StatusUpdatesOk(chip::Controller::CommissioningStage::kError);
	}
	ChipLogProgress(Controller, "Checking callbacks: success failure ok? %d updates ok? %d", successFailureOk, updatesOk);
	return successFailureOk && updatesOk;
	}
	bool CheckPaseConnection(NodeId nodeId)
	{
	bool paseShouldBeOpen = false;
	if (chip::to_underlying(mFailOnReportAfterStage) >=
	chip::to_underlying(chip::Controller::CommissioningStage::kWiFiNetworkSetup) \|\|
	chip::to_underlying(mSimulateFailureOnStage) >=
	chip::to_underlying(chip::Controller::CommissioningStage::kWiFiNetworkSetup))
	{
	// Pase should be open still
	paseShouldBeOpen = true;
	}
	CommissioneeDeviceProxy * proxy;
	bool paseIsOpen =
	(chip::Controller::AutoCommissioner::GetCommissioner()->GetDeviceBeingCommissioned(nodeId, &proxy) == CHIP_NO_ERROR);
	ChipLogProgress(Controller, "Checking pase connection state: Should be open? %d is open? %d", paseShouldBeOpen, paseIsOpen);

	return paseShouldBeOpen == paseIsOpen;
	}
	void Reset()
	{
	mTestCommissionerUsed = false;
	mReceivedCommissioningSuccess = false;
	mReceivedCommissioningFailureStage = chip::Controller::CommissioningStage::kError;
	for (size_t i = 0; i < kNumCommissioningStages; ++i)
	{
	mReceivedStageSuccess[i] = false;
	mReceivedStageFailure[i] = false;
	}
	mSimulateFailureOnStage = chip::Controller::CommissioningStage::kError;
	mFailOnReportAfterStage = chip::Controller::CommissioningStage::kError;
	}
	bool GetTestCommissionerUsed() { return mTestCommissionerUsed; }
	void OnCommissioningSuccess(chip::PeerId peerId) { mReceivedCommissioningSuccess = true; }
	void OnCommissioningFailure(chip::PeerId peerId, CHIP_ERROR error, chip::Controller::CommissioningStage stageFailed,
	chip::Optional<chip::Credentials::AttestationVerificationResult> additionalErrorInfo)
	{
	mReceivedCommissioningFailureStage = stageFailed;
	}
	void OnCommissioningStatusUpdate(chip::PeerId peerId, chip::Controller::CommissioningStage stageCompleted, CHIP_ERROR error)
	{
	if (error == CHIP_NO_ERROR)
	{
	mReceivedStageSuccess[chip::to_underlying(stageCompleted)] = true;
	}
	else
	{
	mReceivedStageFailure[chip::to_underlying(stageCompleted)] = true;
	}
	}

	private:
	static constexpr uint8_t kNumCommissioningStages = chip::to_underlying(chip::Controller::CommissioningStage::kCleanup) + 1;
	chip::Controller::CommissioningStage mSimulateFailureOnStage = chip::Controller::CommissioningStage::kError;
	chip::Controller::CommissioningStage mFailOnReportAfterStage = chip::Controller::CommissioningStage::kError;
	bool mTestCommissionerUsed = false;
	bool mReceivedCommissioningSuccess = false;
	chip::Controller::CommissioningStage mReceivedCommissioningFailureStage = chip::Controller::CommissioningStage::kError;
	bool mReceivedStageSuccess[kNumCommissioningStages];
	bool mReceivedStageFailure[kNumCommissioningStages];
	bool mIsWifi = false;
	bool mIsThread = false;
	bool ValidStage(chip::Controller::CommissioningStage stage)
	{
	if (!mIsWifi &&
	(stage == chip::Controller::CommissioningStage::kWiFiNetworkEnable \|\|
	stage == chip::Controller::CommissioningStage::kWiFiNetworkSetup))
	{
	return false;
	}
	if (!mIsThread &&
	(stage == chip::Controller::CommissioningStage::kThreadNetworkEnable \|\|
	stage == chip::Controller::CommissioningStage::kThreadNetworkSetup))
	{
	return false;
	}
	if (stage == chip::Controller::CommissioningStage::kError \|\| stage == chip::Controller::CommissioningStage::kSecurePairing)
	{
	return false;
	}
	return true;
	}
	bool StatusUpdatesOk(chip::Controller::CommissioningStage failedStage)
	{
	// Because we're just simulating a failure here, we will have received a success callback even for the failed stage.
	for (uint8_t i = 0; i < kNumCommissioningStages; ++i)
	{
	if (mReceivedStageFailure[i])
	{
	return false;
	}
	if (!ValidStage(static_cast<chip::Controller::CommissioningStage>(i)))
	{
	continue;
	}
	// Anything above our current stage we won't have received a callback for. We also expect that the "failed" stage will
	// have a success callback because we're just faking the failure here and overwriting error.
	if (i == chip::to_underlying(failedStage))
	{
	break;
	}
	}
	return true;
	}
	};
	TestCommissioner sTestCommissioner;

	extern "C" {
	struct OpCredsContext
	{
	Platform::UniquePtr<Controller::Python::OperationalCredentialsAdapter> mAdapter;
	void * mPyContext;
	};

	void * pychip_OpCreds_InitializeDelegate(void * pyContext, uint32_t fabricCredentialsIndex)
	{
	auto context = Platform::MakeUnique<OpCredsContext>();
	context->mAdapter = Platform::MakeUnique<Controller::Python::OperationalCredentialsAdapter>(fabricCredentialsIndex);

	if (pychip_Storage_GetStorageAdapter() == nullptr)
	{
	return nullptr;
	}

	if (context->mAdapter->Initialize(*pychip_Storage_GetStorageAdapter()) != CHIP_NO_ERROR)
	{
	return nullptr;
	}

	return context.release();
	}

	void pychip_OnCommissioningSuccess(PeerId peerId)
	{
	sTestCommissioner.OnCommissioningSuccess(peerId);
	}
	void pychip_OnCommissioningFailure(chip::PeerId peerId, CHIP_ERROR error, chip::Controller::CommissioningStage stageFailed,
	chip::Optional<chip::Credentials::AttestationVerificationResult> additionalErrorInfo)
	{
	sTestCommissioner.OnCommissioningFailure(peerId, error, stageFailed, additionalErrorInfo);
	}
	void pychip_OnCommissioningStatusUpdate(chip::PeerId peerId, chip::Controller::CommissioningStage stageCompleted, CHIP_ERROR err)
	{
	return sTestCommissioner.OnCommissioningStatusUpdate(peerId, stageCompleted, err);
	}

	ChipError::StorageType pychip_OpCreds_AllocateController(OpCredsContext * context,
	chip::Controller::DeviceCommissioner ** outDevCtrl, uint8_t fabricIndex,
	FabricId fabricId, chip::NodeId nodeId, const char * paaTrustStorePath,
	bool useTestCommissioner)
	{
	ChipLogDetail(Controller, "Creating New Device Controller");

	VerifyOrReturnError(context != nullptr, CHIP_ERROR_INVALID_ARGUMENT.AsInteger());

	auto devCtrl = std::make_unique<chip::Controller::DeviceCommissioner>();
	VerifyOrReturnError(devCtrl != nullptr, CHIP_ERROR_NO_MEMORY.AsInteger());

	if (paaTrustStorePath == nullptr)
	{
	paaTrustStorePath = "./credentials/development/paa-root-certs";
	}
	ChipLogProgress(Support, "Using device attestation PAA trust store path %s.", paaTrustStorePath);

	// Initialize device attestation verifier
	const chip::Credentials::AttestationTrustStore * testingRootStore = GetTestFileAttestationTrustStore(paaTrustStorePath);
	SetDeviceAttestationVerifier(GetDefaultDACVerifier(testingRootStore));

	chip::Crypto::P256Keypair ephemeralKey;
	CHIP_ERROR err = ephemeralKey.Initialize();
	VerifyOrReturnError(err == CHIP_NO_ERROR, err.AsInteger());

	chip::Platform::ScopedMemoryBuffer<uint8_t> noc;
	ReturnErrorCodeIf(!noc.Alloc(Controller::kMaxCHIPDERCertLength), CHIP_ERROR_NO_MEMORY.AsInteger());
	MutableByteSpan nocSpan(noc.Get(), Controller::kMaxCHIPDERCertLength);

	chip::Platform::ScopedMemoryBuffer<uint8_t> icac;
	ReturnErrorCodeIf(!icac.Alloc(Controller::kMaxCHIPDERCertLength), CHIP_ERROR_NO_MEMORY.AsInteger());
	MutableByteSpan icacSpan(icac.Get(), Controller::kMaxCHIPDERCertLength);

	chip::Platform::ScopedMemoryBuffer<uint8_t> rcac;
	ReturnErrorCodeIf(!rcac.Alloc(Controller::kMaxCHIPDERCertLength), CHIP_ERROR_NO_MEMORY.AsInteger());
	MutableByteSpan rcacSpan(rcac.Get(), Controller::kMaxCHIPDERCertLength);

	err = context->mAdapter->GenerateNOCChain(nodeId, fabricId, chip::kUndefinedCATs, ephemeralKey.Pubkey(), rcacSpan, icacSpan,
	nocSpan);
	VerifyOrReturnError(err == CHIP_NO_ERROR, err.AsInteger());

	Controller::SetupParams initParams;
	initParams.pairingDelegate = &sPairingDelegate;
	initParams.operationalCredentialsDelegate = context->mAdapter.get();
	initParams.operationalKeypair = &ephemeralKey;
	initParams.controllerRCAC = rcacSpan;
	initParams.controllerICAC = icacSpan;
	initParams.controllerNOC = nocSpan;
	initParams.enableServerInteractions = true;

	if (useTestCommissioner)
	{
	initParams.defaultCommissioner = &sTestCommissioner;
	sPairingDelegate.SetCommissioningSuccessCallback(pychip_OnCommissioningSuccess);
	sPairingDelegate.SetCommissioningFailureCallback(pychip_OnCommissioningFailure);
	sPairingDelegate.SetCommissioningStatusUpdateCallback(pychip_OnCommissioningStatusUpdate);
	}

	err = Controller::DeviceControllerFactory::GetInstance().SetupCommissioner(initParams, *devCtrl);
	VerifyOrReturnError(err == CHIP_NO_ERROR, err.AsInteger());

	// Setup IPK in Group Data Provider for controller after Commissioner init which sets-up the fabric table entry
	FabricInfo * fabricInfo = devCtrl->GetFabricInfo();
	VerifyOrReturnError(fabricInfo != nullptr, CHIP_ERROR_INTERNAL.AsInteger());

	uint8_t compressedFabricId[sizeof(uint64_t)] = { 0 };
	chip::MutableByteSpan compressedFabricIdSpan(compressedFabricId);

	err = fabricInfo->GetCompressedId(compressedFabricIdSpan);
	VerifyOrReturnError(err == CHIP_NO_ERROR, err.AsInteger());

	ChipLogProgress(Support, "Setting up group data for Fabric Index %u with Compressed Fabric ID:",
	static_cast<unsigned>(fabricInfo->GetFabricIndex()));
	ChipLogByteSpan(Support, compressedFabricIdSpan);

	chip::ByteSpan defaultIpk = chip::GroupTesting::DefaultIpkValue::GetDefaultIpk();
	err = chip::Credentials::SetSingleIpkEpochKey(&sGroupDataProvider, fabricInfo->GetFabricIndex(), defaultIpk,
	compressedFabricIdSpan);
	VerifyOrReturnError(err == CHIP_NO_ERROR, err.AsInteger());

	*outDevCtrl = devCtrl.release();

	return CHIP_NO_ERROR.AsInteger();
	}

	void pychip_OpCreds_FreeDelegate(OpCredsContext * context)
	{
	Platform::Delete(context);
	}

	ChipError::StorageType pychip_DeviceController_DeleteDeviceController(chip::Controller::DeviceCommissioner * devCtrl)
	{
	if (devCtrl != nullptr)
	{
	devCtrl->Shutdown();
	delete devCtrl;
	}

	return CHIP_NO_ERROR.AsInteger();
	}

	bool pychip_TestCommissionerUsed()
	{
	return sTestCommissioner.GetTestCommissionerUsed();
	}

	bool pychip_TestCommissioningCallbacks()
	{
	return sTestCommissioner.CheckCallbacks();
	}

	bool pychip_TestPaseConnection(NodeId nodeId)
	{
	return sTestCommissioner.CheckPaseConnection(nodeId);
	}

	void pychip_ResetCommissioningTests()
	{
	sTestCommissioner.Reset();
	}

	// Returns True if this is a valid test, false otherwise
	bool pychip_SetTestCommissionerSimulateFailureOnStage(uint8_t failStage)
	{
	return sTestCommissioner.SimulateFailAfter(static_cast<chip::Controller::CommissioningStage>(failStage));
	}
	bool pychip_SetTestCommissionerSimulateFailureOnReport(uint8_t failStage)
	{
	return sTestCommissioner.SimulateFailOnReport(static_cast<chip::Controller::CommissioningStage>(failStage));
	}

	} // extern "C"