1 /* 2 * Copyright (c) 2023, 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_DNS_HPP_ 35 #define CLI_DNS_HPP_ 36 37 #include "openthread-core-config.h" 38 39 #ifdef OPENTHREAD_CLI_DNS_ENABLE 40 #error "OPENTHREAD_CLI_DNS_ENABLE MUST not be defined directly, it is derived from `OPENTHREAD_CONFIG_*` configs". 41 #endif 42 43 #if OPENTHREAD_CONFIG_DNS_CLIENT_ENABLE || OPENTHREAD_CONFIG_DNSSD_SERVER_ENABLE || \ 44 OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE 45 #define OPENTHREAD_CLI_DNS_ENABLE 1 46 #else 47 #define OPENTHREAD_CLI_DNS_ENABLE 0 48 #endif 49 50 #if OPENTHREAD_CLI_DNS_ENABLE 51 52 #include <openthread/dns.h> 53 #include <openthread/dns_client.h> 54 #include <openthread/dnssd_server.h> 55 56 #include "cli/cli_config.h" 57 #include "cli/cli_utils.hpp" 58 59 namespace ot { 60 namespace Cli { 61 62 /** 63 * Implements the DNS CLI interpreter. 64 */ 65 class Dns : private Utils 66 { 67 public: 68 /** 69 * Constructor. 70 * 71 * @param[in] aInstance The OpenThread Instance. 72 * @param[in] aOutputImplementer An `OutputImplementer`. 73 */ Dns(otInstance * aInstance,OutputImplementer & aOutputImplementer)74 Dns(otInstance *aInstance, OutputImplementer &aOutputImplementer) 75 : Utils(aInstance, aOutputImplementer) 76 { 77 } 78 79 /** 80 * Processes a CLI sub-command. 81 * 82 * @param[in] aArgs An array of command line arguments. 83 * 84 * @retval OT_ERROR_NONE Successfully executed the CLI command. 85 * @retval OT_ERROR_PENDING The CLI command was successfully started but final result is pending. 86 * @retval OT_ERROR_INVALID_COMMAND Invalid or unknown CLI command. 87 * @retval OT_ERROR_INVALID_ARGS Invalid arguments. 88 * @retval ... Error during execution of the CLI command. 89 */ 90 otError Process(Arg aArgs[]); 91 92 private: 93 static constexpr uint8_t kIndentSize = 4; 94 static constexpr uint16_t kMaxTxtDataSize = OPENTHREAD_CONFIG_CLI_TXT_RECORD_MAX_SIZE; 95 96 using Command = CommandEntry<Dns>; 97 98 template <CommandId kCommandId> otError Process(Arg aArgs[]); 99 100 #if OPENTHREAD_CONFIG_DNS_CLIENT_ENABLE 101 void OutputResult(otError aError); 102 otError GetDnsConfig(Arg aArgs[], otDnsQueryConfig *&aConfig); 103 const char *DnsConfigServiceModeToString(otDnsServiceMode aMode) const; 104 otError ParseDnsServiceMode(const Arg &aArg, otDnsServiceMode &aMode) const; 105 static void HandleDnsAddressResponse(otError aError, const otDnsAddressResponse *aResponse, void *aContext); 106 void HandleDnsAddressResponse(otError aError, const otDnsAddressResponse *aResponse); 107 #if OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE 108 static const char *const kServiceModeStrings[]; 109 110 typedef otError (&ResolveServiceFn)(otInstance *, 111 const char *, 112 const char *, 113 otDnsServiceCallback, 114 void *, 115 const otDnsQueryConfig *); 116 117 otError ProcessService(Arg aArgs[], ResolveServiceFn aResolveServiceFn); 118 void OutputDnsServiceInfo(uint8_t aIndentSize, const otDnsServiceInfo &aServiceInfo); 119 static void HandleDnsBrowseResponse(otError aError, const otDnsBrowseResponse *aResponse, void *aContext); 120 void HandleDnsBrowseResponse(otError aError, const otDnsBrowseResponse *aResponse); 121 static void HandleDnsServiceResponse(otError aError, const otDnsServiceResponse *aResponse, void *aContext); 122 void HandleDnsServiceResponse(otError aError, const otDnsServiceResponse *aResponse); 123 #endif 124 #endif 125 }; 126 127 } // namespace Cli 128 } // namespace ot 129 130 #endif // OPENTHREAD_CLI_DNS_ENABLE 131 132 #endif // CLI_DNS_HPP_ 133