mirror of
https://github.com/espressif/openthread.git
synced 2026-10-01 05:17:40 +00:00
Abtin Keshavarzian
f9aeacfd4d
This change introduces two new CLI commands to the Border Agent module for managing Thread Administration One-Time Passcodes (TAPs). The new commands are: - `ba ephemeralkey generate-tap`: This command generates and outputs a cryptographically secure random TAP string. Note that it does not start ephemeral key use with this TAP string. - `ba ephemeralkey validate-tap <keystring>`: This command validates a given TAP string by checking its length, character set, and the Verhoeff checksum. The change also includes documentation updates and a new test case to verify the functionality.
92 lines
3.3 KiB
Python
Executable File
92 lines
3.3 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
#
|
|
# Copyright (c) 2023, 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.
|
|
|
|
from cli import verify
|
|
from cli import verify_within
|
|
import cli
|
|
import time
|
|
|
|
# -----------------------------------------------------------------------------------------------------------------------
|
|
# Test description:
|
|
#
|
|
# Validate Border Agent ephemeral key APIs.
|
|
|
|
test_name = __file__[:-3] if __file__.endswith('.py') else __file__
|
|
print('-' * 120)
|
|
print('Starting \'{}\''.format(test_name))
|
|
|
|
# -----------------------------------------------------------------------------------------------------------------------
|
|
# Creating `cli.Node` instances
|
|
|
|
speedup = 20
|
|
cli.Node.set_time_speedup_factor(speedup)
|
|
|
|
leader = cli.Node()
|
|
|
|
# -----------------------------------------------------------------------------------------------------------------------
|
|
# Test Implementation
|
|
|
|
leader.form('ba-ephemeral')
|
|
|
|
verify(leader.get_state() == 'leader')
|
|
|
|
leader.ba_ephemeral_key_set_enabled(False)
|
|
verify(leader.ba_ephemeral_key_get_state() == 'Disabled')
|
|
leader.ba_ephemeral_key_set_enabled(True)
|
|
verify(leader.ba_ephemeral_key_get_state() == 'Stopped')
|
|
|
|
leader.ba_ephemeral_key_start('password', 10000, 1234)
|
|
|
|
time.sleep(0.1)
|
|
|
|
verify(leader.ba_ephemeral_key_get_state() == 'Started')
|
|
verify(int(leader.ba_ephemeral_key_get_port()) == 1234)
|
|
|
|
leader.ba_ephemeral_key_stop()
|
|
verify(leader.ba_ephemeral_key_get_state() == 'Stopped')
|
|
|
|
tap = leader.ba_ephemeral_key_generate_tap()
|
|
verify(leader.ba_ephemeral_key_validate_tap(tap) == 'validated')
|
|
|
|
errored = False
|
|
|
|
try:
|
|
leader.ba_ephemeral_key_validate_tap("123456789")
|
|
except cli.CliError as e:
|
|
verify(e.message == 'Failed')
|
|
errored = True
|
|
|
|
verify(errored)
|
|
|
|
# -----------------------------------------------------------------------------------------------------------------------
|
|
# Test finished
|
|
|
|
cli.Node.finalize_all_nodes()
|
|
|
|
print('\'{}\' passed.'.format(test_name))
|