Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[thread] GenericNetworkCommissioningThreadDriver error handling fixes #17006

Merged
merged 1 commit into from
Apr 5, 2022
Merged

[thread] GenericNetworkCommissioningThreadDriver error handling fixes #17006

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 34 additions & 45 deletions src/platform/OpenThread/GenericNetworkCommissioningThreadDriver.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,22 +73,18 @@ CHIP_ERROR GenericThreadDriver::RevertConfiguration()
Status GenericThreadDriver::AddOrUpdateNetwork(ByteSpan operationalDataset, MutableCharSpan & outDebugText,
uint8_t & outNetworkIndex)
{
uint8_t extpanid[kSizeExtendedPanId];
uint8_t newExtpanid[kSizeExtendedPanId];
ByteSpan newExtpanid;
Thread::OperationalDataset newDataset;

outDebugText.reduce_size(0);
outNetworkIndex = 0;

newDataset.Init(operationalDataset);
VerifyOrReturnError(newDataset.IsCommissioned(), Status::kOutOfRange);

newDataset.GetExtendedPanId(newExtpanid);
mStagingNetwork.GetExtendedPanId(extpanid);
VerifyOrReturnError(newDataset.Init(operationalDataset) == CHIP_NO_ERROR && newDataset.IsCommissioned(), Status::kOutOfRange);
newDataset.GetExtendedPanIdAsByteSpan(newExtpanid);

// We only support one active operational dataset. Add/Update based on either:
// Staging network not commissioned yet (active) or we are updating the dataset with same Extended Pan ID.
VerifyOrReturnError(!mStagingNetwork.IsCommissioned() || memcmp(extpanid, newExtpanid, kSizeExtendedPanId) == 0,
VerifyOrReturnError(!mStagingNetwork.IsCommissioned() || MatchesNetworkId(mStagingNetwork, newExtpanid) == Status::kSuccess,
Status::kBoundsExceeded);

mStagingNetwork = newDataset;
Expand All @@ -99,61 +95,37 @@ Status GenericThreadDriver::RemoveNetwork(ByteSpan networkId, MutableCharSpan &
{
outDebugText.reduce_size(0);
outNetworkIndex = 0;
uint8_t extpanid[kSizeExtendedPanId];
if (!mStagingNetwork.IsCommissioned())
{
return Status::kNetworkNotFound;
}
else if (mStagingNetwork.GetExtendedPanId(extpanid) != CHIP_NO_ERROR)
{
return Status::kUnknownError;
}

VerifyOrReturnError(networkId.size() == kSizeExtendedPanId && memcmp(networkId.data(), extpanid, kSizeExtendedPanId) == 0,
Status::kNetworkNotFound);
NetworkCommissioning::Status status = MatchesNetworkId(mStagingNetwork, networkId);

VerifyOrReturnError(status == Status::kSuccess, status);
mStagingNetwork.Clear();

return Status::kSuccess;
}

Status GenericThreadDriver::ReorderNetwork(ByteSpan networkId, uint8_t index, MutableCharSpan & outDebugText)
{
outDebugText.reduce_size(0);
uint8_t extpanid[kSizeExtendedPanId];
if (!mStagingNetwork.IsCommissioned())
{
return Status::kNetworkNotFound;
}
else if (mStagingNetwork.GetExtendedPanId(extpanid) != CHIP_NO_ERROR)
{
return Status::kUnknownError;
}

VerifyOrReturnError(networkId.size() == kSizeExtendedPanId && memcmp(networkId.data(), extpanid, kSizeExtendedPanId) == 0,
Status::kNetworkNotFound);
NetworkCommissioning::Status status = MatchesNetworkId(mStagingNetwork, networkId);

VerifyOrReturnError(status == Status::kSuccess, status);
VerifyOrReturnError(index == 0, Status::kOutOfRange);

return Status::kSuccess;
}

void GenericThreadDriver::ConnectNetwork(ByteSpan networkId, ConnectCallback * callback)
{
NetworkCommissioning::Status status = Status::kSuccess;
uint8_t extpanid[kSizeExtendedPanId];
if (!mStagingNetwork.IsCommissioned())
{
ExitNow(status = Status::kNetworkNotFound);
}
else if (mStagingNetwork.GetExtendedPanId(extpanid) != CHIP_NO_ERROR)
NetworkCommissioning::Status status = MatchesNetworkId(mStagingNetwork, networkId);

if (status == Status::kSuccess &&
DeviceLayer::ThreadStackMgrImpl().AttachToThreadNetwork(mStagingNetwork.AsByteSpan(), callback) != CHIP_NO_ERROR)
{
ExitNow(status = Status::kUnknownError);
status = Status::kUnknownError;
}

VerifyOrExit((networkId.size() == kSizeExtendedPanId && memcmp(networkId.data(), extpanid, kSizeExtendedPanId) == 0),
status = Status::kNetworkNotFound);

VerifyOrExit(DeviceLayer::ThreadStackMgrImpl().AttachToThreadNetwork(mStagingNetwork.AsByteSpan(), callback) == CHIP_NO_ERROR,
status = Status::kUnknownError);

exit:
if (status != Status::kSuccess)
{
callback->OnResult(status, CharSpan(), 0);
Expand All @@ -175,6 +147,23 @@ void GenericThreadDriver::ScanNetworks(ThreadDriver::ScanCallback * callback)
}
}

Status GenericThreadDriver::MatchesNetworkId(const Thread::OperationalDataset & dataset, const ByteSpan & networkId) const
{
ByteSpan extpanid;

if (!dataset.IsCommissioned())
{
return Status::kNetworkIDNotFound;
}

if (dataset.GetExtendedPanIdAsByteSpan(extpanid) != CHIP_NO_ERROR)
{
return Status::kUnknownError;
}

return networkId.data_equal(extpanid) ? Status::kSuccess : Status::kNetworkIDNotFound;
}

size_t GenericThreadDriver::ThreadNetworkIterator::Count()
{
return driver->mStagingNetwork.IsCommissioned() ? 1 : 0;
Expand Down
2 changes: 2 additions & 0 deletions src/platform/OpenThread/GenericNetworkCommissioningThreadDriver.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ class GenericThreadDriver final : public ThreadDriver
void ScanNetworks(ThreadDriver::ScanCallback * callback) override;

private:
Status MatchesNetworkId(const Thread::OperationalDataset & dataset, const ByteSpan & networkId) const;

ThreadNetworkIterator mThreadIterator = ThreadNetworkIterator(this);
Thread::OperationalDataset mSavedNetwork = {};
Thread::OperationalDataset mStagingNetwork = {};
Expand Down