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  */
66 class Dns : private Utils
67 {
68 public:
69     /**
70      * Constructor.
71      *
72      * @param[in]  aInstance            The OpenThread Instance.
73      * @param[in]  aOutputImplementer   An `OutputImplementer`.
74      *
75      */
Dns(otInstance * aInstance,OutputImplementer & aOutputImplementer)76     Dns(otInstance *aInstance, OutputImplementer &aOutputImplementer)
77         : Utils(aInstance, aOutputImplementer)
78     {
79     }
80 
81     /**
82      * Processes a CLI sub-command.
83      *
84      * @param[in]  aArgs     An array of command line arguments.
85      *
86      * @retval OT_ERROR_NONE              Successfully executed the CLI command.
87      * @retval OT_ERROR_PENDING           The CLI command was successfully started but final result is pending.
88      * @retval OT_ERROR_INVALID_COMMAND   Invalid or unknown CLI command.
89      * @retval OT_ERROR_INVALID_ARGS      Invalid arguments.
90      * @retval ...                        Error during execution of the CLI command.
91      *
92      */
93     otError Process(Arg aArgs[]);
94 
95 private:
96     static constexpr uint8_t  kIndentSize     = 4;
97     static constexpr uint16_t kMaxTxtDataSize = OPENTHREAD_CONFIG_CLI_TXT_RECORD_MAX_SIZE;
98 
99     using Command = CommandEntry<Dns>;
100 
101     template <CommandId kCommandId> otError Process(Arg aArgs[]);
102 
103 #if OPENTHREAD_CONFIG_DNS_CLIENT_ENABLE
104     void        OutputResult(otError aError);
105     otError     GetDnsConfig(Arg aArgs[], otDnsQueryConfig *&aConfig);
106     const char *DnsConfigServiceModeToString(otDnsServiceMode aMode) const;
107     otError     ParseDnsServiceMode(const Arg &aArg, otDnsServiceMode &aMode) const;
108     static void HandleDnsAddressResponse(otError aError, const otDnsAddressResponse *aResponse, void *aContext);
109     void        HandleDnsAddressResponse(otError aError, const otDnsAddressResponse *aResponse);
110 #if OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE
111     static const char *const kServiceModeStrings[];
112 
113     typedef otError (&ResolveServiceFn)(otInstance *,
114                                         const char *,
115                                         const char *,
116                                         otDnsServiceCallback,
117                                         void *,
118                                         const otDnsQueryConfig *);
119 
120     otError     ProcessService(Arg aArgs[], ResolveServiceFn aResolveServiceFn);
121     void        OutputDnsServiceInfo(uint8_t aIndentSize, const otDnsServiceInfo &aServiceInfo);
122     static void HandleDnsBrowseResponse(otError aError, const otDnsBrowseResponse *aResponse, void *aContext);
123     void        HandleDnsBrowseResponse(otError aError, const otDnsBrowseResponse *aResponse);
124     static void HandleDnsServiceResponse(otError aError, const otDnsServiceResponse *aResponse, void *aContext);
125     void        HandleDnsServiceResponse(otError aError, const otDnsServiceResponse *aResponse);
126 #endif
127 #endif
128 };
129 
130 } // namespace Cli
131 } // namespace ot
132 
133 #endif // OPENTHREAD_CLI_DNS_ENABLE
134 
135 #endif // CLI_DNS_HPP_
136