| /* |
| * |
| * Copyright (c) 2021 Project CHIP Authors |
| * 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. |
| */ |
| |
| /** |
| * @file |
| * This file implements unit tests for the CASESession implementation. |
| */ |
| |
| #include <credentials/CHIPCert.h> |
| #include <credentials/GroupDataProviderImpl.h> |
| #include <credentials/PersistentStorageOpCertStore.h> |
| #include <crypto/DefaultSessionKeystore.h> |
| #include <errno.h> |
| #include <lib/core/CHIPCore.h> |
| #include <lib/core/CHIPSafeCasts.h> |
| #include <lib/core/DataModelTypes.h> |
| #include <lib/core/ScopedNodeId.h> |
| #include <lib/support/CHIPMem.h> |
| #include <lib/support/CodeUtils.h> |
| #include <lib/support/ScopedBuffer.h> |
| #include <lib/support/TestPersistentStorageDelegate.h> |
| #include <lib/support/UnitTestContext.h> |
| #include <lib/support/UnitTestRegistration.h> |
| #include <messaging/tests/MessagingContext.h> |
| #include <nlunit-test.h> |
| #include <protocols/secure_channel/CASEServer.h> |
| #include <protocols/secure_channel/CASESession.h> |
| #include <stdarg.h> |
| |
| #include "credentials/tests/CHIPCert_test_vectors.h" |
| |
| using namespace chip; |
| using namespace Credentials; |
| using namespace TestCerts; |
| |
| using namespace chip::Inet; |
| using namespace chip::Transport; |
| using namespace chip::Messaging; |
| using namespace chip::Protocols; |
| using namespace chip::Crypto; |
| |
| namespace chip { |
| namespace { |
| |
| class TestContext : public Test::LoopbackMessagingContext |
| { |
| public: |
| // Performs shared setup for all tests in the test suite |
| static void SetUpTestSuite(); |
| // Performs shared teardown for all tests in the test suite |
| static void TearDownTestSuite(); |
| }; |
| |
| void ServiceEvents(TestContext & ctx) |
| { |
| // Takes a few rounds of this because handling IO messages may schedule work, |
| // and scheduled work may queue messages for sending... |
| for (int i = 0; i < 3; ++i) |
| { |
| ctx.DrainAndServiceIO(); |
| |
| chip::DeviceLayer::PlatformMgr().ScheduleWork( |
| [](intptr_t) -> void { chip::DeviceLayer::PlatformMgr().StopEventLoopTask(); }, (intptr_t) nullptr); |
| chip::DeviceLayer::PlatformMgr().RunEventLoop(); |
| } |
| } |
| |
| class TemporarySessionManager |
| { |
| public: |
| TemporarySessionManager(nlTestSuite * suite, TestContext & ctx) : mCtx(ctx) |
| { |
| NL_TEST_ASSERT(suite, |
| CHIP_NO_ERROR == |
| mSessionManager.Init(&ctx.GetSystemLayer(), &ctx.GetTransportMgr(), &ctx.GetMessageCounterManager(), |
| &mStorage, &ctx.GetFabricTable(), ctx.GetSessionKeystore())); |
| // The setup here is really weird: we are using one session manager for |
| // the actual messages we send (the PASE handshake, so the |
| // unauthenticated sessions) and a different one for allocating the PASE |
| // sessions. Since our Init() set us up as the thing to handle messages |
| // on the transport manager, undo that. |
| mCtx.GetTransportMgr().SetSessionManager(&mCtx.GetSecureSessionManager()); |
| } |
| |
| ~TemporarySessionManager() |
| { |
| mSessionManager.Shutdown(); |
| // Reset the session manager on the transport again, just in case |
| // shutdown messed with it. |
| mCtx.GetTransportMgr().SetSessionManager(&mCtx.GetSecureSessionManager()); |
| } |
| |
| operator SessionManager &() { return mSessionManager; } |
| |
| private: |
| TestContext & mCtx; |
| TestPersistentStorageDelegate mStorage; |
| SessionManager mSessionManager; |
| }; |
| |
| CHIP_ERROR InitFabricTable(chip::FabricTable & fabricTable, chip::TestPersistentStorageDelegate * testStorage, |
| chip::Crypto::OperationalKeystore * opKeyStore, |
| chip::Credentials::PersistentStorageOpCertStore * opCertStore) |
| { |
| ReturnErrorOnFailure(opCertStore->Init(testStorage)); |
| |
| chip::FabricTable::InitParams initParams; |
| initParams.storage = testStorage; |
| initParams.operationalKeystore = opKeyStore; |
| initParams.opCertStore = opCertStore; |
| |
| return fabricTable.Init(initParams); |
| } |
| |
| class TestCASESecurePairingDelegate : public SessionEstablishmentDelegate |
| { |
| public: |
| void OnSessionEstablishmentError(CHIP_ERROR error) override |
| { |
| mNumPairingErrors++; |
| if (error == CHIP_ERROR_BUSY) |
| { |
| mNumBusyResponses++; |
| } |
| } |
| |
| void OnSessionEstablished(const SessionHandle & session) override |
| { |
| mSession.Grab(session); |
| mNumPairingComplete++; |
| } |
| |
| SessionHolder & GetSessionHolder() { return mSession; } |
| |
| SessionHolder mSession; |
| |
| // TODO: Rename mNumPairing* to mNumEstablishment* |
| uint32_t mNumPairingErrors = 0; |
| uint32_t mNumPairingComplete = 0; |
| uint32_t mNumBusyResponses = 0; |
| }; |
| |
| class TestOperationalKeystore : public chip::Crypto::OperationalKeystore |
| { |
| public: |
| void Init(FabricIndex fabricIndex, Platform::UniquePtr<P256Keypair> keypair) |
| { |
| mSingleFabricIndex = fabricIndex; |
| mKeypair = std::move(keypair); |
| } |
| void Shutdown() |
| { |
| mSingleFabricIndex = kUndefinedFabricIndex; |
| mKeypair = nullptr; |
| } |
| |
| bool HasPendingOpKeypair() const override { return false; } |
| bool HasOpKeypairForFabric(FabricIndex fabricIndex) const override { return mSingleFabricIndex != kUndefinedFabricIndex; } |
| |
| CHIP_ERROR NewOpKeypairForFabric(FabricIndex fabricIndex, MutableByteSpan & outCertificateSigningRequest) override |
| { |
| return CHIP_ERROR_NOT_IMPLEMENTED; |
| } |
| |
| CHIP_ERROR ActivateOpKeypairForFabric(FabricIndex fabricIndex, const Crypto::P256PublicKey & nocPublicKey) override |
| { |
| return CHIP_NO_ERROR; |
| } |
| |
| CHIP_ERROR CommitOpKeypairForFabric(FabricIndex fabricIndex) override { return CHIP_ERROR_NOT_IMPLEMENTED; } |
| CHIP_ERROR RemoveOpKeypairForFabric(FabricIndex fabricIndex) override { return CHIP_ERROR_NOT_IMPLEMENTED; } |
| |
| void RevertPendingKeypair() override {} |
| |
| CHIP_ERROR SignWithOpKeypair(FabricIndex fabricIndex, const ByteSpan & message, |
| Crypto::P256ECDSASignature & outSignature) const override |
| { |
| VerifyOrReturnError(mKeypair != nullptr, CHIP_ERROR_INCORRECT_STATE); |
| VerifyOrReturnError(fabricIndex == mSingleFabricIndex, CHIP_ERROR_INVALID_FABRIC_INDEX); |
| return mKeypair->ECDSA_sign_msg(message.data(), message.size(), outSignature); |
| } |
| |
| Crypto::P256Keypair * AllocateEphemeralKeypairForCASE() override { return Platform::New<Crypto::P256Keypair>(); } |
| |
| void ReleaseEphemeralKeypair(Crypto::P256Keypair * keypair) override { Platform::Delete<Crypto::P256Keypair>(keypair); } |
| |
| protected: |
| Platform::UniquePtr<P256Keypair> mKeypair; |
| FabricIndex mSingleFabricIndex = kUndefinedFabricIndex; |
| }; |
| |
| #if CHIP_CONFIG_SLOW_CRYPTO |
| constexpr uint32_t sTestCaseMessageCount = 8; |
| constexpr uint32_t sTestCaseResumptionMessageCount = 6; |
| #else // CHIP_CONFIG_SLOW_CRYPTO |
| constexpr uint32_t sTestCaseMessageCount = 5; |
| constexpr uint32_t sTestCaseResumptionMessageCount = 4; |
| #endif // CHIP_CONFIG_SLOW_CRYPTO |
| |
| FabricTable gCommissionerFabrics; |
| FabricIndex gCommissionerFabricIndex; |
| GroupDataProviderImpl gCommissionerGroupDataProvider; |
| TestPersistentStorageDelegate gCommissionerStorageDelegate; |
| Crypto::DefaultSessionKeystore gCommissionerSessionKeystore; |
| |
| FabricTable gDeviceFabrics; |
| FabricIndex gDeviceFabricIndex; |
| GroupDataProviderImpl gDeviceGroupDataProvider; |
| TestPersistentStorageDelegate gDeviceStorageDelegate; |
| TestOperationalKeystore gDeviceOperationalKeystore; |
| Crypto::DefaultSessionKeystore gDeviceSessionKeystore; |
| |
| Credentials::PersistentStorageOpCertStore gCommissionerOpCertStore; |
| Credentials::PersistentStorageOpCertStore gDeviceOpCertStore; |
| |
| CASEServer gPairingServer; |
| |
| NodeId Node01_01 = 0xDEDEDEDE00010001; |
| NodeId Node01_02 = 0xDEDEDEDE00010002; |
| |
| CHIP_ERROR InitTestIpk(GroupDataProvider & groupDataProvider, const FabricInfo & fabricInfo, size_t numIpks) |
| { |
| VerifyOrReturnError((numIpks > 0) && (numIpks <= 3), CHIP_ERROR_INVALID_ARGUMENT); |
| using KeySet = chip::Credentials::GroupDataProvider::KeySet; |
| using SecurityPolicy = chip::Credentials::GroupDataProvider::SecurityPolicy; |
| |
| KeySet ipkKeySet(GroupDataProvider::kIdentityProtectionKeySetId, SecurityPolicy::kTrustFirst, static_cast<uint8_t>(numIpks)); |
| |
| for (size_t ipkIndex = 0; ipkIndex < numIpks; ++ipkIndex) |
| { |
| // Set start time to 0, 1000, 2000, etc |
| ipkKeySet.epoch_keys[ipkIndex].start_time = static_cast<uint64_t>(ipkIndex * 1000); |
| // Set IPK Epoch key to 00.....00, 01....01, 02.....02, etc |
| memset(&ipkKeySet.epoch_keys[ipkIndex].key, static_cast<int>(ipkIndex), sizeof(ipkKeySet.epoch_keys[ipkIndex].key)); |
| } |
| |
| uint8_t compressedId[sizeof(uint64_t)]; |
| MutableByteSpan compressedIdSpan(compressedId); |
| ReturnErrorOnFailure(fabricInfo.GetCompressedFabricIdBytes(compressedIdSpan)); |
| return groupDataProvider.SetKeySet(fabricInfo.GetFabricIndex(), compressedIdSpan, ipkKeySet); |
| } |
| |
| CHIP_ERROR InitCredentialSets() |
| { |
| gCommissionerStorageDelegate.ClearStorage(); |
| gCommissionerGroupDataProvider.SetStorageDelegate(&gCommissionerStorageDelegate); |
| gCommissionerGroupDataProvider.SetSessionKeystore(&gCommissionerSessionKeystore); |
| ReturnErrorOnFailure(gCommissionerGroupDataProvider.Init()); |
| |
| FabricInfo commissionerFabric; |
| { |
| P256SerializedKeypair opKeysSerialized; |
| |
| // TODO: Rename gCommissioner* to gInitiator* |
| memcpy(opKeysSerialized.Bytes(), sTestCert_Node01_02_PublicKey.data(), sTestCert_Node01_02_PublicKey.size()); |
| memcpy(opKeysSerialized.Bytes() + sTestCert_Node01_02_PublicKey.size(), sTestCert_Node01_02_PrivateKey.data(), |
| sTestCert_Node01_02_PrivateKey.size()); |
| |
| ReturnErrorOnFailure( |
| opKeysSerialized.SetLength(sTestCert_Node01_02_PublicKey.size() + sTestCert_Node01_02_PrivateKey.size())); |
| |
| chip::ByteSpan rcacSpan(sTestCert_Root01_Chip); |
| chip::ByteSpan icacSpan(sTestCert_ICA01_Chip); |
| chip::ByteSpan nocSpan(sTestCert_Node01_02_Chip); |
| chip::ByteSpan opKeySpan(opKeysSerialized.ConstBytes(), opKeysSerialized.Length()); |
| |
| ReturnErrorOnFailure( |
| gCommissionerFabrics.AddNewFabricForTest(rcacSpan, icacSpan, nocSpan, opKeySpan, &gCommissionerFabricIndex)); |
| } |
| |
| const FabricInfo * newFabric = gCommissionerFabrics.FindFabricWithIndex(gCommissionerFabricIndex); |
| VerifyOrReturnError(newFabric != nullptr, CHIP_ERROR_INTERNAL); |
| ReturnErrorOnFailure(InitTestIpk(gCommissionerGroupDataProvider, *newFabric, /* numIpks= */ 1)); |
| |
| gDeviceStorageDelegate.ClearStorage(); |
| gDeviceGroupDataProvider.SetStorageDelegate(&gDeviceStorageDelegate); |
| gDeviceGroupDataProvider.SetSessionKeystore(&gDeviceSessionKeystore); |
| ReturnErrorOnFailure(gDeviceGroupDataProvider.Init()); |
| FabricInfo deviceFabric; |
| |
| { |
| P256SerializedKeypair opKeysSerialized; |
| |
| auto deviceOpKey = Platform::MakeUnique<Crypto::P256Keypair>(); |
| memcpy(opKeysSerialized.Bytes(), sTestCert_Node01_01_PublicKey.data(), sTestCert_Node01_01_PublicKey.size()); |
| memcpy(opKeysSerialized.Bytes() + sTestCert_Node01_01_PublicKey.size(), sTestCert_Node01_01_PrivateKey.data(), |
| sTestCert_Node01_01_PrivateKey.size()); |
| |
| ReturnErrorOnFailure( |
| opKeysSerialized.SetLength(sTestCert_Node01_01_PublicKey.size() + sTestCert_Node01_01_PrivateKey.size())); |
| |
| ReturnErrorOnFailure(deviceOpKey->Deserialize(opKeysSerialized)); |
| |
| // Use an injected operational key for device |
| gDeviceOperationalKeystore.Init(1, std::move(deviceOpKey)); |
| |
| ReturnErrorOnFailure( |
| InitFabricTable(gDeviceFabrics, &gDeviceStorageDelegate, &gDeviceOperationalKeystore, &gDeviceOpCertStore)); |
| |
| chip::ByteSpan rcacSpan(sTestCert_Root01_Chip); |
| chip::ByteSpan icacSpan(sTestCert_ICA01_Chip); |
| chip::ByteSpan nocSpan(sTestCert_Node01_01_Chip); |
| |
| ReturnErrorOnFailure(gDeviceFabrics.AddNewFabricForTest(rcacSpan, icacSpan, nocSpan, ByteSpan{}, &gDeviceFabricIndex)); |
| } |
| |
| // TODO: Validate more cases of number of IPKs on both sides |
| newFabric = gDeviceFabrics.FindFabricWithIndex(gDeviceFabricIndex); |
| VerifyOrReturnError(newFabric != nullptr, CHIP_ERROR_INTERNAL); |
| ReturnErrorOnFailure(InitTestIpk(gDeviceGroupDataProvider, *newFabric, /* numIpks= */ 1)); |
| |
| return CHIP_NO_ERROR; |
| } |
| |
| void TestContext::SetUpTestSuite() |
| { |
| ConfigInitializeNodes(false); |
| CHIP_ERROR err = CHIP_NO_ERROR; |
| LoopbackMessagingContext::SetUpTestSuite(); |
| // TODO: use ASSERT_EQ, once transition to pw_unit_test is complete |
| VerifyOrDieWithMsg((err = chip::DeviceLayer::PlatformMgr().InitChipStack()) == CHIP_NO_ERROR, AppServer, |
| "Init CHIP stack failed: %" CHIP_ERROR_FORMAT, err.Format()); |
| VerifyOrDieWithMsg((err = InitFabricTable(gCommissionerFabrics, &gCommissionerStorageDelegate, /* opKeyStore = */ nullptr, |
| &gCommissionerOpCertStore)) == CHIP_NO_ERROR, |
| AppServer, "InitFabricTable failed: %" CHIP_ERROR_FORMAT, err.Format()); |
| VerifyOrDieWithMsg((err = InitCredentialSets()) == CHIP_NO_ERROR, AppServer, "InitCredentialSets failed: %" CHIP_ERROR_FORMAT, |
| err.Format()); |
| chip::DeviceLayer::SetSystemLayerForTesting(&GetSystemLayer()); |
| } |
| |
| void TestContext::TearDownTestSuite() |
| { |
| chip::DeviceLayer::SetSystemLayerForTesting(nullptr); |
| gDeviceOperationalKeystore.Shutdown(); |
| gPairingServer.Shutdown(); |
| gCommissionerStorageDelegate.ClearStorage(); |
| gDeviceStorageDelegate.ClearStorage(); |
| gCommissionerFabrics.DeleteAllFabrics(); |
| gDeviceFabrics.DeleteAllFabrics(); |
| chip::DeviceLayer::PlatformMgr().Shutdown(); |
| LoopbackMessagingContext::TearDownTestSuite(); |
| } |
| |
| } // anonymous namespace |
| |
| // Specifically for SimulateUpdateNOCInvalidatePendingEstablishment, we need it to be static so that the class below can |
| // be a friend to CASESession so that test can get access to CASESession::State and test method that are not public. To |
| // keep the rest of this file consistent we brought all other tests into this class. |
| class TestCASESession |
| { |
| public: |
| static void SecurePairingWaitTest(nlTestSuite * inSuite, void * inContext); |
| static void SecurePairingStartTest(nlTestSuite * inSuite, void * inContext); |
| static void SecurePairingHandshakeTest(nlTestSuite * inSuite, void * inContext); |
| static void SecurePairingHandshakeServerTest(nlTestSuite * inSuite, void * inContext); |
| static void ClientReceivesBusyTest(nlTestSuite * inSuite, void * inContext); |
| static void Sigma1ParsingTest(nlTestSuite * inSuite, void * inContext); |
| static void DestinationIdTest(nlTestSuite * inSuite, void * inContext); |
| static void SessionResumptionStorage(nlTestSuite * inSuite, void * inContext); |
| #if CONFIG_BUILD_FOR_HOST_UNIT_TEST |
| static void SimulateUpdateNOCInvalidatePendingEstablishment(nlTestSuite * inSuite, void * inContext); |
| #endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST |
| static void Sigma1BadDestinationIdTest(nlTestSuite * inSuite, void * inContext); |
| }; |
| |
| void TestCASESession::SecurePairingWaitTest(nlTestSuite * inSuite, void * inContext) |
| { |
| TestContext & ctx = *reinterpret_cast<TestContext *>(inContext); |
| TemporarySessionManager sessionManager(inSuite, ctx); |
| |
| // Test all combinations of invalid parameters |
| TestCASESecurePairingDelegate delegate; |
| FabricTable fabrics; |
| CASESession caseSession; |
| |
| NL_TEST_ASSERT(inSuite, caseSession.GetSecureSessionType() == SecureSession::Type::kCASE); |
| |
| caseSession.SetGroupDataProvider(&gDeviceGroupDataProvider); |
| NL_TEST_ASSERT(inSuite, |
| caseSession.PrepareForSessionEstablishment(sessionManager, nullptr, nullptr, nullptr, nullptr, ScopedNodeId(), |
| Optional<ReliableMessageProtocolConfig>::Missing()) == |
| CHIP_ERROR_INVALID_ARGUMENT); |
| NL_TEST_ASSERT(inSuite, |
| caseSession.PrepareForSessionEstablishment(sessionManager, nullptr, nullptr, nullptr, &delegate, ScopedNodeId(), |
| Optional<ReliableMessageProtocolConfig>::Missing()) == |
| CHIP_ERROR_INVALID_ARGUMENT); |
| NL_TEST_ASSERT(inSuite, |
| caseSession.PrepareForSessionEstablishment(sessionManager, &fabrics, nullptr, nullptr, &delegate, ScopedNodeId(), |
| Optional<ReliableMessageProtocolConfig>::Missing()) == CHIP_NO_ERROR); |
| |
| // Calling Clear() here since ASAN will have an issue if FabricTable destructor is called before CASESession's |
| // destructor. We could reorder FabricTable and CaseSession, but this makes it a little more clear what we are |
| // doing here. |
| caseSession.Clear(); |
| } |
| |
| void TestCASESession::SecurePairingStartTest(nlTestSuite * inSuite, void * inContext) |
| { |
| TestContext & ctx = *reinterpret_cast<TestContext *>(inContext); |
| TemporarySessionManager sessionManager(inSuite, ctx); |
| |
| // Test all combinations of invalid parameters |
| TestCASESecurePairingDelegate delegate; |
| CASESession pairing; |
| pairing.SetGroupDataProvider(&gCommissionerGroupDataProvider); |
| |
| ExchangeContext * context = ctx.NewUnauthenticatedExchangeToBob(&pairing); |
| |
| NL_TEST_ASSERT(inSuite, |
| pairing.EstablishSession(sessionManager, nullptr, ScopedNodeId{ Node01_01, gCommissionerFabricIndex }, nullptr, |
| nullptr, nullptr, nullptr, |
| Optional<ReliableMessageProtocolConfig>::Missing()) != CHIP_NO_ERROR); |
| ServiceEvents(ctx); |
| |
| NL_TEST_ASSERT(inSuite, |
| pairing.EstablishSession(sessionManager, &gCommissionerFabrics, |
| ScopedNodeId{ Node01_01, gCommissionerFabricIndex }, nullptr, nullptr, nullptr, nullptr, |
| Optional<ReliableMessageProtocolConfig>::Missing()) != CHIP_NO_ERROR); |
| ServiceEvents(ctx); |
| |
| NL_TEST_ASSERT(inSuite, |
| pairing.EstablishSession(sessionManager, &gCommissionerFabrics, |
| ScopedNodeId{ Node01_01, gCommissionerFabricIndex }, context, nullptr, nullptr, |
| &delegate, Optional<ReliableMessageProtocolConfig>::Missing()) == CHIP_NO_ERROR); |
| ServiceEvents(ctx); |
| |
| auto & loopback = ctx.GetLoopback(); |
| // There should have been two message sent: Sigma1 and an ack. |
| NL_TEST_ASSERT(inSuite, loopback.mSentMessageCount == 2); |
| |
| ReliableMessageMgr * rm = ctx.GetExchangeManager().GetReliableMessageMgr(); |
| NL_TEST_ASSERT(inSuite, rm->TestGetCountRetransTable() == 0); |
| |
| loopback.mMessageSendError = CHIP_ERROR_BAD_REQUEST; |
| |
| CASESession pairing1; |
| pairing1.SetGroupDataProvider(&gCommissionerGroupDataProvider); |
| |
| loopback.mSentMessageCount = 0; |
| loopback.mMessageSendError = CHIP_ERROR_BAD_REQUEST; |
| ExchangeContext * context1 = ctx.NewUnauthenticatedExchangeToBob(&pairing1); |
| |
| NL_TEST_ASSERT(inSuite, |
| pairing1.EstablishSession( |
| sessionManager, &gCommissionerFabrics, ScopedNodeId{ Node01_01, gCommissionerFabricIndex }, context1, |
| nullptr, nullptr, &delegate, Optional<ReliableMessageProtocolConfig>::Missing()) == CHIP_ERROR_BAD_REQUEST); |
| ServiceEvents(ctx); |
| |
| loopback.mMessageSendError = CHIP_NO_ERROR; |
| } |
| |
| void SecurePairingHandshakeTestCommon(nlTestSuite * inSuite, void * inContext, SessionManager & sessionManager, |
| CASESession & pairingCommissioner, TestCASESecurePairingDelegate & delegateCommissioner) |
| { |
| TestContext & ctx = *reinterpret_cast<TestContext *>(inContext); |
| |
| // Test all combinations of invalid parameters |
| TestCASESecurePairingDelegate delegateAccessory; |
| CASESession pairingAccessory; |
| ReliableMessageProtocolConfig verySleepyAccessoryRmpConfig( |
| System::Clock::Milliseconds32(360000), System::Clock::Milliseconds32(100000), System::Clock::Milliseconds16(300)); |
| ReliableMessageProtocolConfig nonSleepyCommissionerRmpConfig( |
| System::Clock::Milliseconds32(5000), System::Clock::Milliseconds32(300), System::Clock::Milliseconds16(4000)); |
| |
| auto & loopback = ctx.GetLoopback(); |
| loopback.mSentMessageCount = 0; |
| |
| NL_TEST_ASSERT(inSuite, |
| ctx.GetExchangeManager().RegisterUnsolicitedMessageHandlerForType(Protocols::SecureChannel::MsgType::CASE_Sigma1, |
| &pairingAccessory) == CHIP_NO_ERROR); |
| |
| ExchangeContext * contextCommissioner = ctx.NewUnauthenticatedExchangeToBob(&pairingCommissioner); |
| |
| pairingAccessory.SetGroupDataProvider(&gDeviceGroupDataProvider); |
| NL_TEST_ASSERT(inSuite, |
| pairingAccessory.PrepareForSessionEstablishment(sessionManager, &gDeviceFabrics, nullptr, nullptr, |
| &delegateAccessory, ScopedNodeId(), |
| MakeOptional(verySleepyAccessoryRmpConfig)) == CHIP_NO_ERROR); |
| NL_TEST_ASSERT(inSuite, |
| pairingCommissioner.EstablishSession(sessionManager, &gCommissionerFabrics, |
| ScopedNodeId{ Node01_01, gCommissionerFabricIndex }, contextCommissioner, |
| nullptr, nullptr, &delegateCommissioner, |
| MakeOptional(nonSleepyCommissionerRmpConfig)) == CHIP_NO_ERROR); |
| ServiceEvents(ctx); |
| |
| NL_TEST_ASSERT(inSuite, loopback.mSentMessageCount == sTestCaseMessageCount); |
| NL_TEST_ASSERT(inSuite, delegateAccessory.mNumPairingComplete == 1); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner.mNumPairingComplete == 1); |
| NL_TEST_ASSERT(inSuite, delegateAccessory.mNumPairingErrors == 0); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner.mNumPairingErrors == 0); |
| NL_TEST_ASSERT(inSuite, pairingAccessory.GetRemoteMRPConfig().mIdleRetransTimeout == System::Clock::Milliseconds32(5000)); |
| NL_TEST_ASSERT(inSuite, pairingAccessory.GetRemoteMRPConfig().mActiveRetransTimeout == System::Clock::Milliseconds32(300)); |
| NL_TEST_ASSERT(inSuite, pairingAccessory.GetRemoteMRPConfig().mActiveThresholdTime == System::Clock::Milliseconds16(4000)); |
| NL_TEST_ASSERT(inSuite, pairingCommissioner.GetRemoteMRPConfig().mIdleRetransTimeout == System::Clock::Milliseconds32(360000)); |
| NL_TEST_ASSERT(inSuite, |
| pairingCommissioner.GetRemoteMRPConfig().mActiveRetransTimeout == System::Clock::Milliseconds32(100000)); |
| NL_TEST_ASSERT(inSuite, pairingCommissioner.GetRemoteMRPConfig().mActiveThresholdTime == System::Clock::Milliseconds16(300)); |
| #if CONFIG_BUILD_FOR_HOST_UNIT_TEST |
| // Confirming that FabricTable sending a notification that fabric was updated doesn't affect |
| // already established connections. |
| // |
| // This is compiled for host tests which is enough test coverage |
| gCommissionerFabrics.SendUpdateFabricNotificationForTest(gCommissionerFabricIndex); |
| gDeviceFabrics.SendUpdateFabricNotificationForTest(gDeviceFabricIndex); |
| NL_TEST_ASSERT(inSuite, loopback.mSentMessageCount == sTestCaseMessageCount); |
| NL_TEST_ASSERT(inSuite, delegateAccessory.mNumPairingComplete == 1); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner.mNumPairingComplete == 1); |
| NL_TEST_ASSERT(inSuite, delegateAccessory.mNumPairingErrors == 0); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner.mNumPairingErrors == 0); |
| #endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST |
| } |
| |
| void TestCASESession::SecurePairingHandshakeTest(nlTestSuite * inSuite, void * inContext) |
| { |
| TestContext & ctx = *reinterpret_cast<TestContext *>(inContext); |
| TemporarySessionManager sessionManager(inSuite, ctx); |
| |
| TestCASESecurePairingDelegate delegateCommissioner; |
| CASESession pairingCommissioner; |
| pairingCommissioner.SetGroupDataProvider(&gCommissionerGroupDataProvider); |
| SecurePairingHandshakeTestCommon(inSuite, inContext, sessionManager, pairingCommissioner, delegateCommissioner); |
| } |
| |
| void TestCASESession::SecurePairingHandshakeServerTest(nlTestSuite * inSuite, void * inContext) |
| { |
| // TODO: Add cases for mismatching IPK config between initiator/responder |
| |
| TestCASESecurePairingDelegate delegateCommissioner; |
| |
| auto * pairingCommissioner = chip::Platform::New<CASESession>(); |
| pairingCommissioner->SetGroupDataProvider(&gCommissionerGroupDataProvider); |
| |
| TestContext & ctx = *reinterpret_cast<TestContext *>(inContext); |
| |
| auto & loopback = ctx.GetLoopback(); |
| loopback.mSentMessageCount = 0; |
| |
| // Use the same session manager on both CASE client and server sides to validate that both |
| // components may work simultaneously on a single device. |
| NL_TEST_ASSERT(inSuite, |
| gPairingServer.ListenForSessionEstablishment(&ctx.GetExchangeManager(), &ctx.GetSecureSessionManager(), |
| &gDeviceFabrics, nullptr, nullptr, |
| &gDeviceGroupDataProvider) == CHIP_NO_ERROR); |
| |
| ExchangeContext * contextCommissioner = ctx.NewUnauthenticatedExchangeToBob(pairingCommissioner); |
| |
| NL_TEST_ASSERT(inSuite, |
| pairingCommissioner->EstablishSession(ctx.GetSecureSessionManager(), &gCommissionerFabrics, |
| ScopedNodeId{ Node01_01, gCommissionerFabricIndex }, contextCommissioner, |
| nullptr, nullptr, &delegateCommissioner, |
| Optional<ReliableMessageProtocolConfig>::Missing()) == CHIP_NO_ERROR); |
| ServiceEvents(ctx); |
| |
| NL_TEST_ASSERT(inSuite, loopback.mSentMessageCount == sTestCaseMessageCount); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner.mNumPairingComplete == 1); |
| |
| // Validate that secure session is created |
| SessionHolder & holder = delegateCommissioner.GetSessionHolder(); |
| NL_TEST_ASSERT(inSuite, bool(holder)); |
| |
| NL_TEST_ASSERT(inSuite, (holder->GetPeer() == chip::ScopedNodeId{ Node01_01, gCommissionerFabricIndex })); |
| |
| auto * pairingCommissioner1 = chip::Platform::New<CASESession>(); |
| pairingCommissioner1->SetGroupDataProvider(&gCommissionerGroupDataProvider); |
| ExchangeContext * contextCommissioner1 = ctx.NewUnauthenticatedExchangeToBob(pairingCommissioner1); |
| |
| NL_TEST_ASSERT(inSuite, |
| pairingCommissioner1->EstablishSession(ctx.GetSecureSessionManager(), &gCommissionerFabrics, |
| ScopedNodeId{ Node01_01, gCommissionerFabricIndex }, contextCommissioner1, |
| nullptr, nullptr, &delegateCommissioner, |
| Optional<ReliableMessageProtocolConfig>::Missing()) == CHIP_NO_ERROR); |
| |
| ServiceEvents(ctx); |
| |
| chip::Platform::Delete(pairingCommissioner); |
| chip::Platform::Delete(pairingCommissioner1); |
| |
| gPairingServer.Shutdown(); |
| } |
| |
| void TestCASESession::ClientReceivesBusyTest(nlTestSuite * inSuite, void * inContext) |
| { |
| TestContext & ctx = *reinterpret_cast<TestContext *>(inContext); |
| TemporarySessionManager sessionManager(inSuite, ctx); |
| |
| TestCASESecurePairingDelegate delegateCommissioner1, delegateCommissioner2; |
| CASESession pairingCommissioner1, pairingCommissioner2; |
| |
| pairingCommissioner1.SetGroupDataProvider(&gCommissionerGroupDataProvider); |
| pairingCommissioner2.SetGroupDataProvider(&gCommissionerGroupDataProvider); |
| |
| auto & loopback = ctx.GetLoopback(); |
| loopback.mSentMessageCount = 0; |
| |
| NL_TEST_ASSERT(inSuite, |
| gPairingServer.ListenForSessionEstablishment(&ctx.GetExchangeManager(), &ctx.GetSecureSessionManager(), |
| &gDeviceFabrics, nullptr, nullptr, |
| &gDeviceGroupDataProvider) == CHIP_NO_ERROR); |
| |
| ExchangeContext * contextCommissioner1 = ctx.NewUnauthenticatedExchangeToBob(&pairingCommissioner1); |
| ExchangeContext * contextCommissioner2 = ctx.NewUnauthenticatedExchangeToBob(&pairingCommissioner2); |
| |
| NL_TEST_ASSERT(inSuite, |
| pairingCommissioner1.EstablishSession(sessionManager, &gCommissionerFabrics, |
| ScopedNodeId{ Node01_01, gCommissionerFabricIndex }, contextCommissioner1, |
| nullptr, nullptr, &delegateCommissioner1, NullOptional) == CHIP_NO_ERROR); |
| NL_TEST_ASSERT(inSuite, |
| pairingCommissioner2.EstablishSession(sessionManager, &gCommissionerFabrics, |
| ScopedNodeId{ Node01_01, gCommissionerFabricIndex }, contextCommissioner2, |
| nullptr, nullptr, &delegateCommissioner2, NullOptional) == CHIP_NO_ERROR); |
| |
| ServiceEvents(ctx); |
| |
| // We should have one full handshake and one Sigma1 + Busy + ack. If that |
| // ever changes (e.g. because our server starts supporting multiple parallel |
| // handshakes), this test needs to be fixed so that the server is still |
| // responding BUSY to the client. |
| NL_TEST_ASSERT(inSuite, loopback.mSentMessageCount == sTestCaseMessageCount + 3); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner1.mNumPairingComplete == 1); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner2.mNumPairingComplete == 0); |
| |
| NL_TEST_ASSERT(inSuite, delegateCommissioner1.mNumPairingErrors == 0); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner2.mNumPairingErrors == 1); |
| |
| NL_TEST_ASSERT(inSuite, delegateCommissioner1.mNumBusyResponses == 0); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner2.mNumBusyResponses == 1); |
| |
| gPairingServer.Shutdown(); |
| } |
| |
| struct Sigma1Params |
| { |
| // Purposefully not using constants like kSigmaParamRandomNumberSize that |
| // the code uses, so we have a cross-check. |
| static constexpr size_t initiatorRandomLen = 32; |
| static constexpr uint16_t initiatorSessionId = 0; |
| static constexpr size_t destinationIdLen = 32; |
| static constexpr size_t initiatorEphPubKeyLen = 65; |
| static constexpr size_t resumptionIdLen = 0; // Nonzero means include it. |
| static constexpr size_t initiatorResumeMICLen = 0; // Nonzero means include it. |
| |
| static constexpr uint8_t initiatorRandomTag = 1; |
| static constexpr uint8_t initiatorSessionIdTag = 2; |
| static constexpr uint8_t destinationIdTag = 3; |
| static constexpr uint8_t initiatorEphPubKeyTag = 4; |
| static constexpr uint8_t resumptionIdTag = 6; |
| static constexpr uint8_t initiatorResumeMICTag = 7; |
| static constexpr TLV::Tag NumToTag(uint8_t num) { return TLV::ContextTag(num); } |
| |
| static constexpr bool includeStructEnd = true; |
| |
| static constexpr bool expectSuccess = true; |
| }; |
| |
| void TestCASESession::DestinationIdTest(nlTestSuite * inSuite, void * inContext) |
| { |
| // Validate example test vector from CASE section of spec |
| |
| const uint8_t kRootPubKeyFromSpec[Crypto::CHIP_CRYPTO_PUBLIC_KEY_SIZE_BYTES] = { |
| 0x04, 0x4a, 0x9f, 0x42, 0xb1, 0xca, 0x48, 0x40, 0xd3, 0x72, 0x92, 0xbb, 0xc7, 0xf6, 0xa7, 0xe1, 0x1e, |
| 0x22, 0x20, 0x0c, 0x97, 0x6f, 0xc9, 0x00, 0xdb, 0xc9, 0x8a, 0x7a, 0x38, 0x3a, 0x64, 0x1c, 0xb8, 0x25, |
| 0x4a, 0x2e, 0x56, 0xd4, 0xe2, 0x95, 0xa8, 0x47, 0x94, 0x3b, 0x4e, 0x38, 0x97, 0xc4, 0xa7, 0x73, 0xe9, |
| 0x30, 0x27, 0x7b, 0x4d, 0x9f, 0xbe, 0xde, 0x8a, 0x05, 0x26, 0x86, 0xbf, 0xac, 0xfa |
| }; |
| |
| const uint8_t kIpkOperationalGroupKeyFromSpec[Crypto::CHIP_CRYPTO_SYMMETRIC_KEY_LENGTH_BYTES] = { |
| 0x9b, 0xc6, 0x1c, 0xd9, 0xc6, 0x2a, 0x2d, 0xf6, 0xd6, 0x4d, 0xfc, 0xaa, 0x9d, 0xc4, 0x72, 0xd4 |
| }; |
| |
| const uint8_t kInitiatorRandomFromSpec[Sigma1Params::initiatorRandomLen] = { 0x7e, 0x17, 0x12, 0x31, 0x56, 0x8d, 0xfa, 0x17, |
| 0x20, 0x6b, 0x3a, 0xcc, 0xf8, 0xfa, 0xec, 0x2f, |
| 0x4d, 0x21, 0xb5, 0x80, 0x11, 0x31, 0x96, 0xf4, |
| 0x7c, 0x7c, 0x4d, 0xeb, 0x81, 0x0a, 0x73, 0xdc }; |
| |
| const uint8_t kExpectedDestinationIdFromSpec[Crypto::kSHA256_Hash_Length] = { 0xdc, 0x35, 0xdd, 0x5f, 0xc9, 0x13, 0x4c, 0xc5, |
| 0x54, 0x45, 0x38, 0xc9, 0xc3, 0xfc, 0x42, 0x97, |
| 0xc1, 0xec, 0x33, 0x70, 0xc8, 0x39, 0x13, 0x6a, |
| 0x80, 0xe1, 0x07, 0x96, 0x45, 0x1d, 0x4c, 0x53 }; |
| |
| const FabricId kFabricIdFromSpec = 0x2906C908D115D362; |
| const NodeId kNodeIdFromSpec = 0xCD5544AA7B13EF14; |
| |
| uint8_t destinationIdBuf[Crypto::kSHA256_Hash_Length] = { 0 }; |
| MutableByteSpan destinationIdSpan(destinationIdBuf); |
| |
| // Test exact example |
| CHIP_ERROR err = |
| GenerateCaseDestinationId(ByteSpan(kIpkOperationalGroupKeyFromSpec), ByteSpan(kInitiatorRandomFromSpec), |
| ByteSpan(kRootPubKeyFromSpec), kFabricIdFromSpec, kNodeIdFromSpec, destinationIdSpan); |
| NL_TEST_ASSERT(inSuite, CHIP_NO_ERROR == err); |
| NL_TEST_ASSERT(inSuite, destinationIdSpan.size() == sizeof(destinationIdBuf)); |
| NL_TEST_ASSERT(inSuite, destinationIdSpan.data_equal(ByteSpan(kExpectedDestinationIdFromSpec))); |
| |
| memset(destinationIdSpan.data(), 0, destinationIdSpan.size()); |
| |
| // Test changing input: should yield different |
| err = GenerateCaseDestinationId(ByteSpan(kIpkOperationalGroupKeyFromSpec), ByteSpan(kInitiatorRandomFromSpec), |
| ByteSpan(kRootPubKeyFromSpec), kFabricIdFromSpec, |
| kNodeIdFromSpec + 1, // <--- Change node ID |
| destinationIdSpan); |
| NL_TEST_ASSERT(inSuite, CHIP_NO_ERROR == err); |
| NL_TEST_ASSERT(inSuite, destinationIdSpan.size() == sizeof(destinationIdBuf)); |
| NL_TEST_ASSERT(inSuite, !destinationIdSpan.data_equal(ByteSpan(kExpectedDestinationIdFromSpec))); |
| } |
| |
| template <typename Params> |
| static CHIP_ERROR EncodeSigma1(MutableByteSpan & buf) |
| { |
| using namespace TLV; |
| |
| TLVWriter writer; |
| writer.Init(buf); |
| |
| TLVType containerType; |
| ReturnErrorOnFailure(writer.StartContainer(AnonymousTag(), kTLVType_Structure, containerType)); |
| uint8_t initiatorRandom[Params::initiatorRandomLen] = { 1 }; |
| ReturnErrorOnFailure(writer.Put(Params::NumToTag(Params::initiatorRandomTag), ByteSpan(initiatorRandom))); |
| |
| ReturnErrorOnFailure(writer.Put(Params::NumToTag(Params::initiatorSessionIdTag), Params::initiatorSessionId)); |
| |
| uint8_t destinationId[Params::destinationIdLen] = { 2 }; |
| ReturnErrorOnFailure(writer.Put(Params::NumToTag(Params::destinationIdTag), ByteSpan(destinationId))); |
| |
| uint8_t initiatorEphPubKey[Params::initiatorEphPubKeyLen] = { 3 }; |
| ReturnErrorOnFailure(writer.Put(Params::NumToTag(Params::initiatorEphPubKeyTag), ByteSpan(initiatorEphPubKey))); |
| |
| // I wish we had "if constexpr" support here, so the compiler would know |
| // resumptionIdLen is nonzero inside the block.... |
| if (Params::resumptionIdLen != 0) |
| { |
| uint8_t resumptionId[Params::resumptionIdLen]; |
| |
| // to fix _FORTIFY_SOURCE issue, _FORTIFY_SOURCE=2 by default on Android |
| (&memset)(resumptionId, 4, Params::resumptionIdLen); |
| ReturnErrorOnFailure( |
| writer.Put(Params::NumToTag(Params::resumptionIdTag), ByteSpan(resumptionId, Params::resumptionIdLen))); |
| } |
| |
| if (Params::initiatorResumeMICLen != 0) |
| { |
| uint8_t initiatorResumeMIC[Params::initiatorResumeMICLen]; |
| // to fix _FORTIFY_SOURCE issue, _FORTIFY_SOURCE=2 by default on Android |
| (&memset)(initiatorResumeMIC, 5, Params::initiatorResumeMICLen); |
| ReturnErrorOnFailure(writer.Put(Params::NumToTag(Params::initiatorResumeMICTag), |
| ByteSpan(initiatorResumeMIC, Params::initiatorResumeMICLen))); |
| } |
| |
| if (Params::includeStructEnd) |
| { |
| ReturnErrorOnFailure(writer.EndContainer(containerType)); |
| } |
| |
| buf.reduce_size(writer.GetLengthWritten()); |
| return CHIP_NO_ERROR; |
| } |
| |
| // A macro, so we can tell which test failed based on line number. |
| #define TestSigma1Parsing(inSuite, mem, bufferSize, params) \ |
| do \ |
| { \ |
| MutableByteSpan buf(mem.Get(), bufferSize); \ |
| CHIP_ERROR err = EncodeSigma1<params>(buf); \ |
| NL_TEST_ASSERT(inSuite, err == CHIP_NO_ERROR); \ |
| \ |
| TLV::ContiguousBufferTLVReader reader; \ |
| reader.Init(buf); \ |
| \ |
| ByteSpan initiatorRandom; \ |
| uint16_t initiatorSessionId; \ |
| ByteSpan destinationId; \ |
| ByteSpan initiatorEphPubKey; \ |
| bool resumptionRequested; \ |
| ByteSpan resumptionId; \ |
| ByteSpan initiatorResumeMIC; \ |
| CASESession session; \ |
| err = session.ParseSigma1(reader, initiatorRandom, initiatorSessionId, destinationId, initiatorEphPubKey, \ |
| resumptionRequested, resumptionId, initiatorResumeMIC); \ |
| NL_TEST_ASSERT(inSuite, (err == CHIP_NO_ERROR) == params::expectSuccess); \ |
| if (params::expectSuccess) \ |
| { \ |
| NL_TEST_ASSERT(inSuite, resumptionRequested == (params::resumptionIdLen != 0 && params::initiatorResumeMICLen != 0)); \ |
| /* Add other verification tests here as desired */ \ |
| } \ |
| } while (0) |
| |
| struct BadSigma1ParamsBase : public Sigma1Params |
| { |
| static constexpr bool expectSuccess = false; |
| }; |
| |
| struct Sigma1NoStructEnd : public BadSigma1ParamsBase |
| { |
| static constexpr bool includeStructEnd = false; |
| }; |
| |
| struct Sigma1WrongTags : public BadSigma1ParamsBase |
| { |
| static constexpr TLV::Tag NumToTag(uint8_t num) { return TLV::ProfileTag(0, num); } |
| }; |
| |
| struct Sigma1TooLongRandom : public BadSigma1ParamsBase |
| { |
| static constexpr size_t initiatorRandomLen = 33; |
| }; |
| |
| struct Sigma1TooShortRandom : public BadSigma1ParamsBase |
| { |
| static constexpr size_t initiatorRandomLen = 31; |
| }; |
| |
| struct Sigma1TooLongDest : public BadSigma1ParamsBase |
| { |
| static constexpr size_t destinationIdLen = 33; |
| }; |
| |
| struct Sigma1TooShortDest : public BadSigma1ParamsBase |
| { |
| static constexpr size_t destinationIdLen = 31; |
| }; |
| |
| struct Sigma1TooLongPubkey : public BadSigma1ParamsBase |
| { |
| static constexpr size_t initiatorEphPubKeyLen = 66; |
| }; |
| |
| struct Sigma1TooShortPubkey : public BadSigma1ParamsBase |
| { |
| static constexpr size_t initiatorEphPubKeyLen = 64; |
| }; |
| |
| struct Sigma1WithResumption : public Sigma1Params |
| { |
| static constexpr size_t resumptionIdLen = 16; |
| static constexpr size_t initiatorResumeMICLen = 16; |
| }; |
| |
| struct Sigma1TooLongResumptionId : public Sigma1WithResumption |
| { |
| static constexpr size_t resumptionIdLen = 17; |
| static constexpr bool expectSuccess = false; |
| }; |
| |
| struct Sigma1TooShortResumptionId : public BadSigma1ParamsBase |
| { |
| static constexpr size_t resumptionIdLen = 15; |
| static constexpr bool expectSuccess = false; |
| }; |
| |
| struct Sigma1TooLongResumeMIC : public Sigma1WithResumption |
| { |
| static constexpr size_t resumptionIdLen = 17; |
| static constexpr bool expectSuccess = false; |
| }; |
| |
| struct Sigma1TooShortResumeMIC : public Sigma1WithResumption |
| { |
| static constexpr size_t initiatorResumeMICLen = 15; |
| static constexpr bool expectSuccess = false; |
| }; |
| |
| struct Sigma1SessionIdMax : public Sigma1Params |
| { |
| static constexpr uint32_t initiatorSessionId = UINT16_MAX; |
| }; |
| |
| struct Sigma1SessionIdTooBig : public BadSigma1ParamsBase |
| { |
| static constexpr uint32_t initiatorSessionId = UINT16_MAX + 1; |
| }; |
| |
| void TestCASESession::Sigma1ParsingTest(nlTestSuite * inSuite, void * inContext) |
| { |
| // 1280 bytes must be enough by definition. |
| constexpr size_t bufferSize = 1280; |
| chip::Platform::ScopedMemoryBuffer<uint8_t> mem; |
| NL_TEST_ASSERT(inSuite, mem.Calloc(bufferSize)); |
| |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1Params); |
| |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1NoStructEnd); |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1WrongTags); |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1TooLongRandom); |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1TooShortRandom); |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1TooLongDest); |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1TooShortDest); |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1TooLongPubkey); |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1TooShortPubkey); |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1WithResumption); |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1TooLongResumptionId); |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1TooShortResumptionId); |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1TooLongResumeMIC); |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1TooShortResumeMIC); |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1SessionIdMax); |
| TestSigma1Parsing(inSuite, mem, bufferSize, Sigma1SessionIdTooBig); |
| } |
| |
| struct SessionResumptionTestStorage : SessionResumptionStorage |
| { |
| SessionResumptionTestStorage(CHIP_ERROR findMethodReturnCode, ScopedNodeId peerNodeId, ResumptionIdStorage * resumptionId, |
| Crypto::P256ECDHDerivedSecret * sharedSecret) : |
| mFindMethodReturnCode(findMethodReturnCode), |
| mPeerNodeId(peerNodeId), mResumptionId(resumptionId), mSharedSecret(sharedSecret) |
| {} |
| SessionResumptionTestStorage(CHIP_ERROR findMethodReturnCode) : mFindMethodReturnCode(findMethodReturnCode) {} |
| CHIP_ERROR FindByScopedNodeId(const ScopedNodeId & node, ResumptionIdStorage & resumptionId, |
| Crypto::P256ECDHDerivedSecret & sharedSecret, CATValues & peerCATs) override |
| { |
| if (mResumptionId != nullptr) |
| { |
| memcpy(resumptionId.data(), mResumptionId->data(), mResumptionId->size()); |
| } |
| if (mSharedSecret != nullptr) |
| { |
| memcpy(sharedSecret.Bytes(), mSharedSecret->Bytes(), mSharedSecret->Length()); |
| sharedSecret.SetLength(mSharedSecret->Length()); |
| } |
| peerCATs = CATValues{}; |
| return mFindMethodReturnCode; |
| } |
| CHIP_ERROR FindByResumptionId(ConstResumptionIdView resumptionId, ScopedNodeId & node, |
| Crypto::P256ECDHDerivedSecret & sharedSecret, CATValues & peerCATs) override |
| { |
| node = mPeerNodeId; |
| if (mSharedSecret != nullptr) |
| { |
| memcpy(sharedSecret.Bytes(), mSharedSecret->Bytes(), mSharedSecret->Length()); |
| sharedSecret.SetLength(mSharedSecret->Length()); |
| } |
| peerCATs = CATValues{}; |
| return mFindMethodReturnCode; |
| } |
| CHIP_ERROR Save(const ScopedNodeId & node, ConstResumptionIdView resumptionId, |
| const Crypto::P256ECDHDerivedSecret & sharedSecret, const CATValues & peerCATs) override |
| { |
| return CHIP_NO_ERROR; |
| } |
| CHIP_ERROR DeleteAll(const FabricIndex fabricIndex) override { return CHIP_NO_ERROR; } |
| CHIP_ERROR mFindMethodReturnCode; |
| ScopedNodeId mPeerNodeId; |
| ResumptionIdStorage * mResumptionId = nullptr; |
| Crypto::P256ECDHDerivedSecret * mSharedSecret = nullptr; |
| }; |
| |
| void TestCASESession::SessionResumptionStorage(nlTestSuite * inSuite, void * inContext) |
| { |
| // Test the SessionResumptionStorage external interface. |
| // |
| // Our build should accept any storage delegate injected that implements |
| // this. And if our delegate provides usable session resumption |
| // information, session resumption should succeed. In the case that the |
| // delegate cannot provide the information needed for session resumption, or |
| // if the peers have mismatched session resumption information, we should |
| // fall back to CASE. |
| |
| TestContext & ctx = *reinterpret_cast<TestContext *>(inContext); |
| TestCASESecurePairingDelegate delegateCommissioner; |
| chip::SessionResumptionStorage::ResumptionIdStorage resumptionIdA; |
| chip::SessionResumptionStorage::ResumptionIdStorage resumptionIdB; |
| chip::Crypto::P256ECDHDerivedSecret sharedSecretA; |
| chip::Crypto::P256ECDHDerivedSecret sharedSecretB; |
| |
| // Create our fabric-scoped node IDs. |
| const FabricInfo * fabricInfo = gCommissionerFabrics.FindFabricWithIndex(gCommissionerFabricIndex); |
| NL_TEST_ASSERT(inSuite, fabricInfo != nullptr); |
| ScopedNodeId initiator = fabricInfo->GetScopedNodeIdForNode(Node01_02); |
| ScopedNodeId responder = fabricInfo->GetScopedNodeIdForNode(Node01_01); |
| |
| // Generate a resumption IDs. |
| NL_TEST_ASSERT(inSuite, CHIP_NO_ERROR == chip::Crypto::DRBG_get_bytes(resumptionIdA.data(), resumptionIdA.size())); |
| NL_TEST_ASSERT(inSuite, CHIP_NO_ERROR == chip::Crypto::DRBG_get_bytes(resumptionIdB.data(), resumptionIdB.size())); |
| |
| // Generate a shared secrets. |
| sharedSecretA.SetLength(sharedSecretA.Capacity()); |
| NL_TEST_ASSERT(inSuite, CHIP_NO_ERROR == chip::Crypto::DRBG_get_bytes(sharedSecretA.Bytes(), sharedSecretA.Length())); |
| sharedSecretB.SetLength(sharedSecretB.Capacity()); |
| NL_TEST_ASSERT(inSuite, CHIP_NO_ERROR == chip::Crypto::DRBG_get_bytes(sharedSecretB.Bytes(), sharedSecretB.Length())); |
| |
| struct |
| { |
| SessionResumptionTestStorage initiatorStorage; |
| SessionResumptionTestStorage responderStorage; |
| uint32_t expectedSentMessageCount; |
| } testVectors[] = { |
| // Both peers have a matching session resumption record. |
| // This should succeed. |
| { |
| .initiatorStorage = SessionResumptionTestStorage(CHIP_NO_ERROR, responder, &resumptionIdA, &sharedSecretA), |
| .responderStorage = SessionResumptionTestStorage(CHIP_NO_ERROR, initiator, &resumptionIdA, &sharedSecretA), |
| .expectedSentMessageCount = |
| sTestCaseResumptionMessageCount, // we expect this number of sent messages with successful session resumption |
| }, |
| // Peers have mismatched session resumption records. |
| // This should succeed with fall back to CASE. |
| { |
| .initiatorStorage = SessionResumptionTestStorage(CHIP_NO_ERROR, responder, &resumptionIdA, &sharedSecretA), |
| .responderStorage = SessionResumptionTestStorage(CHIP_ERROR_KEY_NOT_FOUND), |
| .expectedSentMessageCount = sTestCaseMessageCount, // we expect this number of sent message when we fall back to CASE |
| }, |
| // Peers both have record of the same resumption ID, but a different shared secret. |
| // This should succeed with fall back to CASE. |
| { |
| .initiatorStorage = SessionResumptionTestStorage(CHIP_NO_ERROR, responder, &resumptionIdA, &sharedSecretA), |
| .responderStorage = SessionResumptionTestStorage(CHIP_NO_ERROR, initiator, &resumptionIdA, &sharedSecretB), |
| .expectedSentMessageCount = sTestCaseMessageCount, // we expect this number of sent message when we fall back to CASE |
| }, |
| // Neither peer has a session resumption record. |
| // This should succeed - no attempt at session resumption will be made. |
| { |
| .initiatorStorage = SessionResumptionTestStorage(CHIP_ERROR_KEY_NOT_FOUND), |
| .responderStorage = SessionResumptionTestStorage(CHIP_ERROR_KEY_NOT_FOUND), |
| .expectedSentMessageCount = |
| sTestCaseMessageCount, // we expect this number of sent messages if we do not attempt session resumption |
| }, |
| }; |
| |
| auto & loopback = ctx.GetLoopback(); |
| for (size_t i = 0; i < sizeof(testVectors) / sizeof(testVectors[0]); ++i) |
| { |
| auto * pairingCommissioner = chip::Platform::New<CASESession>(); |
| pairingCommissioner->SetGroupDataProvider(&gCommissionerGroupDataProvider); |
| loopback.mSentMessageCount = 0; |
| NL_TEST_ASSERT(inSuite, |
| gPairingServer.ListenForSessionEstablishment(&ctx.GetExchangeManager(), &ctx.GetSecureSessionManager(), |
| &gDeviceFabrics, &testVectors[i].responderStorage, nullptr, |
| &gDeviceGroupDataProvider) == CHIP_NO_ERROR); |
| ExchangeContext * contextCommissioner = ctx.NewUnauthenticatedExchangeToBob(pairingCommissioner); |
| auto establishmentReturnVal = pairingCommissioner->EstablishSession( |
| ctx.GetSecureSessionManager(), &gCommissionerFabrics, ScopedNodeId{ Node01_01, gCommissionerFabricIndex }, |
| contextCommissioner, &testVectors[i].initiatorStorage, nullptr, &delegateCommissioner, |
| Optional<ReliableMessageProtocolConfig>::Missing()); |
| ServiceEvents(ctx); |
| NL_TEST_ASSERT(inSuite, establishmentReturnVal == CHIP_NO_ERROR); |
| NL_TEST_ASSERT(inSuite, loopback.mSentMessageCount == testVectors[i].expectedSentMessageCount); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner.mNumPairingComplete == i + 1); |
| SessionHolder & holder = delegateCommissioner.GetSessionHolder(); |
| NL_TEST_ASSERT(inSuite, bool(holder)); |
| NL_TEST_ASSERT(inSuite, holder->GetPeer() == fabricInfo->GetScopedNodeIdForNode(Node01_01)); |
| chip::Platform::Delete(pairingCommissioner); |
| } |
| } |
| |
| #if CONFIG_BUILD_FOR_HOST_UNIT_TEST |
| void TestCASESession::SimulateUpdateNOCInvalidatePendingEstablishment(nlTestSuite * inSuite, void * inContext) |
| { |
| TestContext & ctx = *reinterpret_cast<TestContext *>(inContext); |
| TemporarySessionManager sessionManager(inSuite, ctx); |
| |
| TestCASESecurePairingDelegate delegateCommissioner; |
| CASESession pairingCommissioner; |
| pairingCommissioner.SetGroupDataProvider(&gCommissionerGroupDataProvider); |
| |
| TestCASESecurePairingDelegate delegateAccessory; |
| CASESession pairingAccessory; |
| |
| auto & loopback = ctx.GetLoopback(); |
| loopback.mSentMessageCount = 0; |
| |
| NL_TEST_ASSERT(inSuite, |
| ctx.GetExchangeManager().RegisterUnsolicitedMessageHandlerForType(Protocols::SecureChannel::MsgType::CASE_Sigma1, |
| &pairingAccessory) == CHIP_NO_ERROR); |
| |
| // In order for all the test iterations below, we need to stop the CASE sigma handshake in the middle such |
| // that the CASE session is in the process of being established. |
| pairingCommissioner.SetStopSigmaHandshakeAt(MakeOptional(CASESession::State::kSentSigma1)); |
| |
| ExchangeContext * contextCommissioner = ctx.NewUnauthenticatedExchangeToBob(&pairingCommissioner); |
| |
| pairingAccessory.SetGroupDataProvider(&gDeviceGroupDataProvider); |
| NL_TEST_ASSERT(inSuite, |
| pairingAccessory.PrepareForSessionEstablishment( |
| sessionManager, &gDeviceFabrics, nullptr, nullptr, &delegateAccessory, ScopedNodeId(), |
| Optional<ReliableMessageProtocolConfig>::Missing()) == CHIP_NO_ERROR); |
| |
| gDeviceFabrics.SendUpdateFabricNotificationForTest(gDeviceFabricIndex); |
| ServiceEvents(ctx); |
| NL_TEST_ASSERT(inSuite, delegateAccessory.mNumPairingErrors == 0); |
| |
| NL_TEST_ASSERT(inSuite, |
| pairingCommissioner.EstablishSession(sessionManager, &gCommissionerFabrics, |
| ScopedNodeId{ Node01_01, gCommissionerFabricIndex }, contextCommissioner, |
| nullptr, nullptr, &delegateCommissioner, |
| Optional<ReliableMessageProtocolConfig>::Missing()) == CHIP_NO_ERROR); |
| ServiceEvents(ctx); |
| |
| // At this point the CASESession is in the process of establishing. Confirm that there are no errors and there are session |
| // has not been established. |
| NL_TEST_ASSERT(inSuite, delegateAccessory.mNumPairingComplete == 0); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner.mNumPairingComplete == 0); |
| NL_TEST_ASSERT(inSuite, delegateAccessory.mNumPairingErrors == 0); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner.mNumPairingErrors == 0); |
| |
| // Simulating an update to the Fabric NOC for gCommissionerFabrics fabric table. |
| // Confirm that CASESession on commisioner side has reported an error. |
| gCommissionerFabrics.SendUpdateFabricNotificationForTest(gCommissionerFabricIndex); |
| ServiceEvents(ctx); |
| NL_TEST_ASSERT(inSuite, delegateAccessory.mNumPairingErrors == 0); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner.mNumPairingErrors == 1); |
| |
| // Simulating an update to the Fabric NOC for gDeviceFabrics fabric table. |
| // Confirm that CASESession on accessory side has reported an error. |
| gDeviceFabrics.SendUpdateFabricNotificationForTest(gDeviceFabricIndex); |
| ServiceEvents(ctx); |
| NL_TEST_ASSERT(inSuite, delegateAccessory.mNumPairingErrors == 1); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner.mNumPairingErrors == 1); |
| |
| // Sanity check that pairing did not complete. |
| NL_TEST_ASSERT(inSuite, delegateAccessory.mNumPairingComplete == 0); |
| NL_TEST_ASSERT(inSuite, delegateCommissioner.mNumPairingComplete == 0); |
| } |
| #endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST |
| |
| namespace { |
| class ExpectErrorExchangeDelegate : public ExchangeDelegate |
| { |
| public: |
| ExpectErrorExchangeDelegate(nlTestSuite * suite, uint16_t expectedProtocolCode) : |
| mSuite(suite), mExpectedProtocolCode(expectedProtocolCode) |
| {} |
| |
| private: |
| CHIP_ERROR OnMessageReceived(ExchangeContext * ec, const PayloadHeader & payloadHeader, |
| System::PacketBufferHandle && buf) override |
| { |
| using namespace SecureChannel; |
| |
| NL_TEST_ASSERT(mSuite, payloadHeader.HasMessageType(MsgType::StatusReport)); |
| |
| SecureChannel::StatusReport statusReport; |
| CHIP_ERROR err = statusReport.Parse(std::move(buf)); |
| NL_TEST_ASSERT(mSuite, err == CHIP_NO_ERROR); |
| |
| NL_TEST_ASSERT(mSuite, statusReport.GetProtocolId() == SecureChannel::Id); |
| NL_TEST_ASSERT(mSuite, statusReport.GetGeneralCode() == GeneralStatusCode::kFailure); |
| NL_TEST_ASSERT(mSuite, statusReport.GetProtocolCode() == mExpectedProtocolCode); |
| return CHIP_NO_ERROR; |
| } |
| |
| void OnResponseTimeout(ExchangeContext * ec) override {} |
| |
| Messaging::ExchangeMessageDispatch & GetMessageDispatch() override { return SessionEstablishmentExchangeDispatch::Instance(); } |
| |
| nlTestSuite * mSuite; |
| uint16_t mExpectedProtocolCode; |
| }; |
| } // anonymous namespace |
| |
| void TestCASESession::Sigma1BadDestinationIdTest(nlTestSuite * inSuite, void * inContext) |
| { |
| using SecureChannel::MsgType; |
| |
| TestContext & ctx = *reinterpret_cast<TestContext *>(inContext); |
| |
| SessionManager & sessionManager = ctx.GetSecureSessionManager(); |
| |
| constexpr size_t bufferSize = 600; |
| System::PacketBufferHandle data = chip::System::PacketBufferHandle::New(bufferSize); |
| NL_TEST_ASSERT(inSuite, !data.IsNull()); |
| |
| MutableByteSpan buf(data->Start(), data->AvailableDataLength()); |
| // This uses a bogus destination id that is not going to match anything in practice. |
| CHIP_ERROR err = EncodeSigma1<Sigma1Params>(buf); |
| NL_TEST_ASSERT(inSuite, err == CHIP_NO_ERROR); |
| data->SetDataLength(static_cast<uint16_t>(buf.size())); |
| |
| Optional<SessionHandle> session = sessionManager.CreateUnauthenticatedSession(ctx.GetAliceAddress(), GetDefaultMRPConfig()); |
| NL_TEST_ASSERT(inSuite, session.HasValue()); |
| |
| TestCASESecurePairingDelegate caseDelegate; |
| CASESession caseSession; |
| caseSession.SetGroupDataProvider(&gDeviceGroupDataProvider); |
| err = caseSession.PrepareForSessionEstablishment(sessionManager, &gDeviceFabrics, nullptr, nullptr, &caseDelegate, |
| ScopedNodeId(), NullOptional); |
| NL_TEST_ASSERT(inSuite, err == CHIP_NO_ERROR); |
| |
| err = ctx.GetExchangeManager().RegisterUnsolicitedMessageHandlerForType(MsgType::CASE_Sigma1, &caseSession); |
| NL_TEST_ASSERT(inSuite, err == CHIP_NO_ERROR); |
| |
| ExpectErrorExchangeDelegate delegate(inSuite, SecureChannel::kProtocolCodeNoSharedRoot); |
| ExchangeContext * exchange = ctx.GetExchangeManager().NewContext(session.Value(), &delegate); |
| NL_TEST_ASSERT(inSuite, exchange != nullptr); |
| |
| err = exchange->SendMessage(MsgType::CASE_Sigma1, std::move(data), SendMessageFlags::kExpectResponse); |
| NL_TEST_ASSERT(inSuite, err == CHIP_NO_ERROR); |
| |
| ServiceEvents(ctx); |
| |
| NL_TEST_ASSERT(inSuite, caseDelegate.mNumPairingErrors == 1); |
| NL_TEST_ASSERT(inSuite, caseDelegate.mNumPairingComplete == 0); |
| |
| ctx.GetExchangeManager().UnregisterUnsolicitedMessageHandlerForType(MsgType::CASE_Sigma1); |
| caseSession.Clear(); |
| } |
| |
| } // namespace chip |
| |
| // Test Suite |
| |
| /** |
| * Test Suite that lists all the test functions. |
| */ |
| // clang-format off |
| static const nlTest sTests[] = |
| { |
| NL_TEST_DEF("WaitInit", chip::TestCASESession::SecurePairingWaitTest), |
| NL_TEST_DEF("Start", chip::TestCASESession::SecurePairingStartTest), |
| NL_TEST_DEF("Handshake", chip::TestCASESession::SecurePairingHandshakeTest), |
| NL_TEST_DEF("ServerHandshake", chip::TestCASESession::SecurePairingHandshakeServerTest), |
| NL_TEST_DEF("ClientReceivesBusy", chip::TestCASESession::ClientReceivesBusyTest), |
| NL_TEST_DEF("Sigma1Parsing", chip::TestCASESession::Sigma1ParsingTest), |
| NL_TEST_DEF("DestinationId", chip::TestCASESession::DestinationIdTest), |
| NL_TEST_DEF("SessionResumptionStorage", chip::TestCASESession::SessionResumptionStorage), |
| #if CONFIG_BUILD_FOR_HOST_UNIT_TEST |
| // This is compiled for host tests which is enough test coverage to ensure updating NOC invalidates |
| // CASESession that are in the process of establishing. |
| NL_TEST_DEF("InvalidatePendingSessionEstablishment", chip::TestCASESession::SimulateUpdateNOCInvalidatePendingEstablishment), |
| #endif // CONFIG_BUILD_FOR_HOST_UNIT_TEST |
| NL_TEST_DEF("Sigma1BadDestinationId", chip::TestCASESession::Sigma1BadDestinationIdTest), |
| |
| NL_TEST_SENTINEL() |
| }; |
| // clang-format on |
| |
| // clang-format off |
| static nlTestSuite sSuite = |
| { |
| "Test-CHIP-SecurePairing-CASE", |
| &sTests[0], |
| NL_TEST_WRAP_FUNCTION(TestContext::SetUpTestSuite), |
| NL_TEST_WRAP_FUNCTION(TestContext::TearDownTestSuite), |
| NL_TEST_WRAP_METHOD(TestContext, SetUp), |
| NL_TEST_WRAP_METHOD(TestContext, TearDown), |
| }; |
| // clang-format on |
| |
| /** |
| * Main |
| */ |
| int TestCASESessionTest() |
| { |
| return chip::ExecuteTestsWithContext<TestContext>(&sSuite); |
| } |
| |
| CHIP_REGISTER_TEST_SUITE(TestCASESessionTest) |
