blob: bfb502b65d8d555b556b14a16e98145e8449d7d9 [file] [log] [blame]
/*
*
* Copyright (c) 2020-2022 Project CHIP Authors
* Copyright (c) 2013-2017 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.
*/
/**
* @file
* Declaration of Commissioner Discovery Controller,
* a common class that manages state and callbacks
* for handling the Commissioner Discovery
* and User Directed Commissioning workflow
*
*/
#include <controller/CommissionerDiscoveryController.h>
#include <platform/CHIPDeviceLayer.h>
#include <setup_payload/AdditionalDataPayloadGenerator.h>
#if CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY
using namespace ::chip;
using namespace chip::Protocols::UserDirectedCommissioning;
void CommissionerDiscoveryController::ResetState()
{
mCurrentInstance[0] = '\0';
mVendorId = 0;
mProductId = 0;
mNodeId = 0;
mReady = true;
}
void CommissionerDiscoveryController::OnUserDirectedCommissioningRequest(UDCClientState state)
{
if (!mReady)
{
ChipLogDetail(Controller, "CommissionerDiscoveryController not read. Current instance=%s", mCurrentInstance);
return;
}
mReady = false;
Platform::CopyString(mCurrentInstance, state.GetInstanceName());
mPendingConsent = true;
char rotatingDeviceIdHexBuffer[RotatingDeviceId::kHexMaxLength];
Encoding::BytesToUppercaseHexString(state.GetRotatingId(), state.GetRotatingIdLength(), rotatingDeviceIdHexBuffer,
RotatingDeviceId::kHexMaxLength);
ChipLogDetail(Controller,
"------PROMPT USER: %s is requesting permission to cast to this TV, approve? [" ChipLogFormatMEI
"," ChipLogFormatMEI ",%s,%s]",
state.GetDeviceName(), ChipLogValueMEI(state.GetVendorId()), ChipLogValueMEI(state.GetProductId()),
state.GetInstanceName(), rotatingDeviceIdHexBuffer);
if (mUserPrompter != nullptr)
{
mUserPrompter->PromptForCommissionOKPermission(state.GetVendorId(), state.GetProductId(), state.GetDeviceName());
}
ChipLogDetail(Controller, "------Via Shell Enter: controller ux ok|cancel");
}
void CommissionerDiscoveryController::Ok()
{
if (!mPendingConsent)
{
ChipLogError(AppServer, "UX Cancel: no current instance");
return;
}
if (mUdcServer == nullptr)
{
ChipLogError(AppServer, "UX Ok: no udc server");
return;
}
UDCClientState * client = mUdcServer->GetUDCClients().FindUDCClientState(mCurrentInstance);
if (client == nullptr)
{
ChipLogError(AppServer, "UX Ok: could not find instance=%s", mCurrentInstance);
return;
}
if (client->GetUDCClientProcessingState() != UDCClientProcessingState::kPromptingUser)
{
ChipLogError(AppServer, "UX Ok: invalid state for ok");
return;
}
client->SetUDCClientProcessingState(UDCClientProcessingState::kObtainingOnboardingPayload);
if (mPincodeService != nullptr)
{
char rotatingIdString[chip::Dnssd::kMaxRotatingIdLen * 2 + 1] = "";
Encoding::BytesToUppercaseHexString(client->GetRotatingId(), client->GetRotatingIdLength(), rotatingIdString,
sizeof(rotatingIdString));
// Encoding::BytesToUppercaseHexString(client->GetRotatingId(), chip::Dnssd::kMaxRotatingIdLen, rotatingIdString,
// sizeof(rotatingIdString));
CharSpan rotatingIdSpan = chip::CharSpan(rotatingIdString, sizeof(rotatingIdString));
uint32_t pincode =
mPincodeService->FetchCommissionPincodeFromContentApp(client->GetVendorId(), client->GetProductId(), rotatingIdSpan);
if (pincode != 0)
{
CommissionWithPincode(pincode);
return;
}
}
ChipLogDetail(Controller, "------PROMPT USER: please enter pin displayed in casting app ");
if (mUserPrompter != nullptr)
{
mUserPrompter->PromptForCommissionPincode(client->GetVendorId(), client->GetProductId(), client->GetDeviceName());
}
ChipLogDetail(Controller, "------Via Shell Enter: controller ux ok [pincode]");
}
void CommissionerDiscoveryController::CommissionWithPincode(uint32_t pincode)
{
if (!mPendingConsent)
{
ChipLogError(AppServer, "UX Cancel: no current instance");
return;
}
if (mUdcServer == nullptr)
{
ChipLogError(AppServer, "UX CommissionWithPincode: no udc server");
return;
}
UDCClientState * client = mUdcServer->GetUDCClients().FindUDCClientState(mCurrentInstance);
if (client == nullptr)
{
ChipLogError(AppServer, "UX Ok: could not find instance=%s", mCurrentInstance);
return;
}
// state needs to be either kPromptingUser or kObtainingOnboardingPayload
if (!(client->GetUDCClientProcessingState() == UDCClientProcessingState::kPromptingUser ||
client->GetUDCClientProcessingState() == UDCClientProcessingState::kObtainingOnboardingPayload))
{
ChipLogError(AppServer, "UX CommissionWithPincode: invalid state for CommissionWithPincode");
return;
}
Transport::PeerAddress peerAddress = client->GetPeerAddress();
client->SetUDCClientProcessingState(UDCClientProcessingState::kCommissioningNode);
if (mCommissionerCallback != nullptr)
{
mCommissionerCallback->ReadyForCommissioning(pincode, client->GetLongDiscriminator(), peerAddress);
}
}
void CommissionerDiscoveryController::Cancel()
{
if (!mPendingConsent)
{
ChipLogError(AppServer, "UX Cancel: no current instance");
return;
}
if (mUdcServer == nullptr)
{
ChipLogError(AppServer, "UX Cancel: no udc server");
return;
}
UDCClientState * client = mUdcServer->GetUDCClients().FindUDCClientState(mCurrentInstance);
if (client == nullptr || client->GetUDCClientProcessingState() != UDCClientProcessingState::kPromptingUser)
{
ChipLogError(AppServer, "UX Cancel: invalid state for cancel");
return;
}
client->SetUDCClientProcessingState(UDCClientProcessingState::kUserDeclined);
mPendingConsent = false;
}
void CommissionerDiscoveryController::CommissioningSucceeded(uint16_t vendorId, uint16_t productId, NodeId nodeId,
Messaging::ExchangeManager & exchangeMgr,
SessionHandle & sessionHandle)
{
mVendorId = vendorId;
mProductId = productId;
mNodeId = nodeId;
if (mPostCommissioningListener != nullptr)
{
ChipLogDetail(Controller, "CommissionerDiscoveryController calling listener");
mPostCommissioningListener->CommissioningCompleted(vendorId, productId, nodeId, exchangeMgr, sessionHandle);
}
else
{
PostCommissioningSucceeded();
}
}
void CommissionerDiscoveryController::CommissioningFailed(CHIP_ERROR error)
{
if (mUserPrompter != nullptr)
{
ChipLogDetail(Controller, "------PROMPT USER: commissioning failed ");
mUserPrompter->PromptCommissioningFailed(GetCommissioneeName(), error);
}
ResetState();
}
void CommissionerDiscoveryController::PostCommissioningSucceeded()
{
if (mUserPrompter != nullptr)
{
ChipLogDetail(Controller, "------PROMPT USER: commissioning success ");
mUserPrompter->PromptCommissioningSucceeded(mVendorId, mProductId, GetCommissioneeName());
}
ResetState();
}
void CommissionerDiscoveryController::PostCommissioningFailed(CHIP_ERROR error)
{
if (mUserPrompter != nullptr)
{
ChipLogDetail(Controller, "------PROMPT USER: post-commissioning failed ");
mUserPrompter->PromptCommissioningFailed(GetCommissioneeName(), error);
}
ResetState();
}
const char * CommissionerDiscoveryController::GetCommissioneeName()
{
if (mReady)
{
// no current commissionee
ChipLogError(AppServer, "CommissionerDiscoveryController no current commissionee");
return nullptr;
}
UDCClientState * client = mUdcServer->GetUDCClients().FindUDCClientState(mCurrentInstance);
if (client == nullptr)
{
ChipLogError(AppServer, "CommissionerDiscoveryController no UDCState for instance=%s", mCurrentInstance);
return nullptr;
}
return client->GetDeviceName();
}
UDCClientState * CommissionerDiscoveryController::GetUDCClientState()
{
if (mReady)
{
// no current commissionee
ChipLogError(AppServer, "CommissionerDiscoveryController no current commissionee");
return nullptr;
}
return mUdcServer->GetUDCClients().FindUDCClientState(mCurrentInstance);
}
#endif // CHIP_DEVICE_CONFIG_ENABLE_COMMISSIONER_DISCOVERY