1 /* 2 * Copyright (c) 2024, 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 CLI to DNS (client and resolver). 32 */ 33 34 #ifndef CLI_MDNS_HPP_ 35 #define CLI_MDNS_HPP_ 36 37 #include "openthread-core-config.h" 38 39 #include <openthread/mdns.h> 40 41 #include "cli/cli_config.h" 42 #include "cli/cli_utils.hpp" 43 44 #if OPENTHREAD_CONFIG_MULTICAST_DNS_ENABLE && OPENTHREAD_CONFIG_MULTICAST_DNS_PUBLIC_API_ENABLE 45 46 namespace ot { 47 namespace Cli { 48 49 /** 50 * Implements the mDNS CLI interpreter. 51 */ 52 class Mdns : private Utils 53 { 54 public: 55 /** 56 * Constructor. 57 * 58 * @param[in] aInstance The OpenThread Instance. 59 * @param[in] aOutputImplementer An `OutputImplementer`. 60 */ Mdns(otInstance * aInstance,OutputImplementer & aOutputImplementer)61 Mdns(otInstance *aInstance, OutputImplementer &aOutputImplementer) 62 : Utils(aInstance, aOutputImplementer) 63 , mInfraIfIndex(0) 64 , mRequestId(0) 65 , mWaitingForCallback(false) 66 { 67 } 68 69 /** 70 * Processes a CLI sub-command. 71 * 72 * @param[in] aArgs An array of command line arguments. 73 * 74 * @retval OT_ERROR_NONE Successfully executed the CLI command. 75 * @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending. 76 * @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command. 77 * @retval OT_ERROR_INVALID_ARGS Invalid arguments. 78 * @retval ... Error during execution of the CLI command. 79 */ 80 otError Process(Arg aArgs[]); 81 82 private: 83 using Command = CommandEntry<Mdns>; 84 85 static constexpr uint8_t kIndentSize = 4; 86 static constexpr uint16_t kMaxAddresses = 16; 87 static constexpr uint16_t kStringSize = 400; 88 static constexpr uint16_t kMaxSubTypes = 8; 89 static constexpr uint16_t kMaxTxtDataSize = 200; 90 static constexpr uint16_t kMaxKeyDataSize = 200; 91 92 enum IpAddressType : uint8_t 93 { 94 kIp6Address, 95 kIp4Address, 96 }; 97 98 struct Buffers // Used to populate `otMdnsService` field 99 { 100 char mString[kStringSize]; 101 const char *mSubTypeLabels[kMaxSubTypes]; 102 uint8_t mTxtData[kMaxTxtDataSize]; 103 }; 104 105 template <CommandId kCommandId> otError Process(Arg aArgs[]); 106 107 void OutputHost(const otMdnsHost &aHost); 108 void OutputService(const otMdnsService &aService); 109 void OutputKey(const otMdnsKey &aKey); 110 void OutputState(otMdnsEntryState aState); 111 void OutputCacheInfo(const otMdnsCacheInfo &aInfo); 112 otError ProcessRegisterHost(Arg aArgs[]); 113 otError ProcessRegisterService(Arg aArgs[]); 114 otError ProcessRegisterKey(Arg aArgs[]); 115 void HandleRegisterationDone(otMdnsRequestId aRequestId, otError aError); 116 void HandleBrowseResult(const otMdnsBrowseResult &aResult); 117 void HandleSrvResult(const otMdnsSrvResult &aResult); 118 void HandleTxtResult(const otMdnsTxtResult &aResult); 119 void HandleAddressResult(const otMdnsAddressResult &aResult, IpAddressType aType); 120 121 static otError ParseStartOrStop(const Arg &aArg, bool &aIsStart); 122 static void HandleRegisterationDone(otInstance *aInstance, otMdnsRequestId aRequestId, otError aError); 123 static void HandleBrowseResult(otInstance *aInstance, const otMdnsBrowseResult *aResult); 124 static void HandleSrvResult(otInstance *aInstance, const otMdnsSrvResult *aResult); 125 static void HandleTxtResult(otInstance *aInstance, const otMdnsTxtResult *aResult); 126 static void HandleIp6AddressResult(otInstance *aInstance, const otMdnsAddressResult *aResult); 127 static void HandleIp4AddressResult(otInstance *aInstance, const otMdnsAddressResult *aResult); 128 129 static otError ParseServiceArgs(Arg aArgs[], otMdnsService &aService, Buffers &aBuffers); 130 131 uint32_t mInfraIfIndex; 132 otMdnsRequestId mRequestId; 133 bool mWaitingForCallback; 134 }; 135 136 } // namespace Cli 137 } // namespace ot 138 139 #endif // OPENTHREAD_CONFIG_MULTICAST_DNS_ENABLE && OPENTHREAD_CONFIG_MULTICAST_DNS_PUBLIC_API_ENABLE 140 141 #endif // CLI_MDNS_HPP_ 142