Skip to content

Commit

Permalink
[tcat] Implement decommissioning in tcat_agent.
Browse files Browse the repository at this point in the history
Commits adds handling of TCAT TLV 0x60 `kTlvDecommission`.
  • Loading branch information
canisLupus1313 committed Jun 20, 2024
1 parent 215c23f commit 8a33f4b
Show file tree
Hide file tree
Showing 6 changed files with 109 additions and 3 deletions.
24 changes: 23 additions & 1 deletion src/core/meshcop/tcat_agent.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,9 @@ Error TcatAgent::HandleSingleTlv(const Message &aIncommingMessage, Message &aOut
response = true;
error = kErrorNone;
break;

case kTlvDecommission:
error = HandleDecomission();
break;
default:
error = kErrorInvalidCommand;
}
Expand Down Expand Up @@ -481,6 +483,26 @@ Error TcatAgent::HandleSetActiveOperationalDataset(const Message &aIncommingMess
return error;
}

Error TcatAgent::HandleDecomission(void)
{
Error error = kErrorNone;

IgnoreReturnValue(otThreadSetEnabled(&GetInstance(), false));
Get<ActiveDatasetManager>().Clear();
Get<PendingDatasetManager>().Clear();
Get<Settings>().Wipe();
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
Get<KeyManager>().DestroyTemporaryKeys();
Get<KeyManager>().DestroyPersistentKeys();
#else
NetworkKey networkKey;
networkKey.Clear();
Get<KeyManager>().SetNetworkKey(networkKey);
#endif

return error;
}

Error TcatAgent::HandleStartThreadInterface(void)
{
Error error;
Expand Down
1 change: 1 addition & 0 deletions src/core/meshcop/tcat_agent.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ class TcatAgent : public InstanceLocator, private NonCopyable

Error HandleSingleTlv(const Message &aIncommingMessage, Message &aOutgoingMessage);
Error HandleSetActiveOperationalDataset(const Message &aIncommingMessage, uint16_t aOffset, uint16_t aLength);
Error HandleDecomission(void);
Error HandleStartThreadInterface(void);

bool CheckCommandClassAuthorizationFlags(CommandClassFlags aCommissionerCommandClassFlags,
Expand Down
64 changes: 64 additions & 0 deletions tests/scripts/expect/cli-tcat-decommission.exp
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
#!/usr/bin/expect -f
#
# Copyright (c) 2022, The OpenThread Authors.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# 3. Neither the name of the copyright holder nor the
# names of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#

source "tests/scripts/expect/_common.exp"

spawn_node 1 "cli"

switch_node 1
send "tcat start\n"
expect_line "Done"

spawn python "tools/tcat_ble_client/bbtc.py" --simulation 1 --cert_path "tools/tcat_ble_client/auth"
set py_client "$spawn_id"
expect_line "Done"
send "commission\n"
expect_line "\tTYPE:\tRESPONSE_W_STATUS"
expect_line "\tVALUE:\t0x00"

send "thread start\n"
expect_line "\tTYPE:\tRESPONSE_W_STATUS"
expect_line "\tVALUE:\t0x00"

send "decommission\n"
expect_line "\tTYPE:\tRESPONSE_W_STATUS"

send "exit\n"
expect eof

switch_node 1
send "tcat stop\n"
expect_line "Done"

send "dataset active\n"
expect_line "Error 23: NotFound"

send "networkkey\n"
expect_line "00000000000000000000000000000000"
expect_line "Done"
3 changes: 2 additions & 1 deletion tools/tcat_ble_client/bbtc.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,8 @@ async def get_device_by_args(args):
elif args.scan:
tcat_devices = await ble_scanner.scan_tcat_devices()
device = select_device_by_user_input(tcat_devices)
device = await BleStream.create(device.address, BBTC_SERVICE_UUID, BBTC_TX_CHAR_UUID, BBTC_RX_CHAR_UUID)
if device:
device = await BleStream.create(device.address, BBTC_SERVICE_UUID, BBTC_TX_CHAR_UUID, BBTC_RX_CHAR_UUID)
elif args.simulation:
device = UdpStream("127.0.0.1", int(args.simulation))

Expand Down
16 changes: 16 additions & 0 deletions tools/tcat_ble_client/cli/base_commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,22 @@ async def execute_default(self, args, context):
return CommandResultTLV(tlv_response)


class DecommissionCommand(Command):

def get_help_string(self) -> str:
return 'Stop Thread interface and decommission device from current network.'

async def execute_default(self, args, context):
bless: BleStreamSecure = context['ble_sstream']
print('Disabling Thread and decommissioning device...')
data = (TLV(TcatTLVType.DECOMMISSION.value, bytes()).to_bytes())
response = await bless.send_with_resp(data)
if not response:
return
tlv_response = TLV.from_bytes(response)
return CommandResultTLV(tlv_response)


class ThreadStartCommand(Command):

def get_help_string(self) -> str:
Expand Down
4 changes: 3 additions & 1 deletion tools/tcat_ble_client/cli/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@
import readline
import shlex
from ble.ble_stream_secure import BleStreamSecure
from cli.base_commands import (HelpCommand, HelloCommand, CommissionCommand, ThreadStateCommand, ScanCommand)
from cli.base_commands import (HelpCommand, HelloCommand, CommissionCommand, DecommissionCommand, ThreadStateCommand,
ScanCommand)
from cli.dataset_commands import (DatasetCommand)
from dataset.dataset import ThreadDataset
from typing import Optional
Expand All @@ -42,6 +43,7 @@ def __init__(self, dataset: ThreadDataset, ble_sstream: Optional[BleStreamSecure
'help': HelpCommand(),
'hello': HelloCommand(),
'commission': CommissionCommand(),
'decommission': DecommissionCommand(),
'dataset': DatasetCommand(),
'thread': ThreadStateCommand(),
'scan': ScanCommand(),
Expand Down

0 comments on commit 8a33f4b

Please sign in to comment.