1 /* 2 * Copyright (c) 2020, The OpenThread Authors. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /** 30 * @file 31 * This file contains definitions for a simple CLI to control the SRP server. 32 */ 33 34 #ifndef CLI_SRP_SERVER_HPP_ 35 #define CLI_SRP_SERVER_HPP_ 36 37 #include "openthread-core-config.h" 38 39 #include <openthread/srp_server.h> 40 41 #include "cli/cli_output.hpp" 42 43 #if OPENTHREAD_CONFIG_SRP_SERVER_ENABLE 44 45 namespace ot { 46 namespace Cli { 47 48 /** 49 * This class implements the SRP Server CLI interpreter. 50 * 51 */ 52 class SrpServer : private OutputWrapper 53 { 54 public: 55 typedef Utils::CmdLineParser::Arg Arg; 56 57 /** 58 * Constructor 59 * 60 * @param[in] aOutput The CLI console output context. 61 * 62 */ SrpServer(Output & aOutput)63 explicit SrpServer(Output &aOutput) 64 : OutputWrapper(aOutput) 65 { 66 } 67 68 /** 69 * This method interprets a list of CLI arguments. 70 * 71 * @param[in] aArgs A pointer to an array of command line arguments. 72 * 73 * @retval OT_ERROR_NONE Successfully executed the CLI command. 74 * @retval ... Failed to execute the CLI command. 75 * 76 */ 77 otError Process(Arg aArgs[]); 78 79 private: 80 static constexpr uint8_t kIndentSize = 4; 81 82 using Command = CommandEntry<SrpServer>; 83 84 otError ProcessAddrMode(Arg aArgs[]); 85 otError ProcessDomain(Arg aArgs[]); 86 otError ProcessState(Arg aArgs[]); 87 otError ProcessEnable(Arg aArgs[]); 88 otError ProcessDisable(Arg aArgs[]); 89 otError ProcessLease(Arg aArgs[]); 90 otError ProcessHost(Arg aArgs[]); 91 otError ProcessService(Arg aArgs[]); 92 otError ProcessSeqNum(Arg aArgs[]); 93 otError ProcessTtl(Arg aArgs[]); 94 otError ProcessHelp(Arg aArgs[]); 95 96 void OutputHostAddresses(const otSrpServerHost *aHost); 97 98 static constexpr Command sCommands[] = { 99 {"addrmode", &SrpServer::ProcessAddrMode}, {"disable", &SrpServer::ProcessDisable}, 100 {"domain", &SrpServer::ProcessDomain}, {"enable", &SrpServer::ProcessEnable}, 101 {"help", &SrpServer::ProcessHelp}, {"host", &SrpServer::ProcessHost}, 102 {"lease", &SrpServer::ProcessLease}, {"seqnum", &SrpServer::ProcessSeqNum}, 103 {"service", &SrpServer::ProcessService}, {"state", &SrpServer::ProcessState}, 104 {"ttl", &SrpServer::ProcessTtl}, 105 }; 106 107 static_assert(BinarySearch::IsSorted(sCommands), "Command Table is not sorted"); 108 }; 109 110 } // namespace Cli 111 } // namespace ot 112 113 #endif // OPENTHREAD_CONFIG_SRP_SERVER_ENABLE 114 115 #endif // CLI_SRP_SERVER_HPP_ 116