xref: /aosp_15_r20/external/ot-br-posix/src/utils/dns_utils.hpp (revision 4a64e381480ef79f0532b2421e44e6ee336b8e0d)
1*4a64e381SAndroid Build Coastguard Worker /*
2*4a64e381SAndroid Build Coastguard Worker  *  Copyright (c) 2017-2021, The OpenThread Authors.
3*4a64e381SAndroid Build Coastguard Worker  *  All rights reserved.
4*4a64e381SAndroid Build Coastguard Worker  *
5*4a64e381SAndroid Build Coastguard Worker  *  Redistribution and use in source and binary forms, with or without
6*4a64e381SAndroid Build Coastguard Worker  *  modification, are permitted provided that the following conditions are met:
7*4a64e381SAndroid Build Coastguard Worker  *  1. Redistributions of source code must retain the above copyright
8*4a64e381SAndroid Build Coastguard Worker  *     notice, this list of conditions and the following disclaimer.
9*4a64e381SAndroid Build Coastguard Worker  *  2. Redistributions in binary form must reproduce the above copyright
10*4a64e381SAndroid Build Coastguard Worker  *     notice, this list of conditions and the following disclaimer in the
11*4a64e381SAndroid Build Coastguard Worker  *     documentation and/or other materials provided with the distribution.
12*4a64e381SAndroid Build Coastguard Worker  *  3. Neither the name of the copyright holder nor the
13*4a64e381SAndroid Build Coastguard Worker  *     names of its contributors may be used to endorse or promote products
14*4a64e381SAndroid Build Coastguard Worker  *     derived from this software without specific prior written permission.
15*4a64e381SAndroid Build Coastguard Worker  *
16*4a64e381SAndroid Build Coastguard Worker  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17*4a64e381SAndroid Build Coastguard Worker  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18*4a64e381SAndroid Build Coastguard Worker  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19*4a64e381SAndroid Build Coastguard Worker  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20*4a64e381SAndroid Build Coastguard Worker  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21*4a64e381SAndroid Build Coastguard Worker  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22*4a64e381SAndroid Build Coastguard Worker  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23*4a64e381SAndroid Build Coastguard Worker  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24*4a64e381SAndroid Build Coastguard Worker  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25*4a64e381SAndroid Build Coastguard Worker  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26*4a64e381SAndroid Build Coastguard Worker  *  POSSIBILITY OF SUCH DAMAGE.
27*4a64e381SAndroid Build Coastguard Worker  */
28*4a64e381SAndroid Build Coastguard Worker 
29*4a64e381SAndroid Build Coastguard Worker /**
30*4a64e381SAndroid Build Coastguard Worker  * @file
31*4a64e381SAndroid Build Coastguard Worker  * This file includes definition for DNS utilities.
32*4a64e381SAndroid Build Coastguard Worker  */
33*4a64e381SAndroid Build Coastguard Worker 
34*4a64e381SAndroid Build Coastguard Worker #ifndef OTBR_UTILS_DNS_UTILS_HPP_
35*4a64e381SAndroid Build Coastguard Worker #define OTBR_UTILS_DNS_UTILS_HPP_
36*4a64e381SAndroid Build Coastguard Worker 
37*4a64e381SAndroid Build Coastguard Worker #include "openthread-br/config.h"
38*4a64e381SAndroid Build Coastguard Worker 
39*4a64e381SAndroid Build Coastguard Worker #include <string>
40*4a64e381SAndroid Build Coastguard Worker 
41*4a64e381SAndroid Build Coastguard Worker namespace otbr {
42*4a64e381SAndroid Build Coastguard Worker 
43*4a64e381SAndroid Build Coastguard Worker namespace DnsUtils {
44*4a64e381SAndroid Build Coastguard Worker 
45*4a64e381SAndroid Build Coastguard Worker /**
46*4a64e381SAndroid Build Coastguard Worker  * This function unescapes a DNS Service Instance name according to "DNS Name Escaping".
47*4a64e381SAndroid Build Coastguard Worker  *
48*4a64e381SAndroid Build Coastguard Worker  * @sa  "Notes on DNS Name Escaping" at
49*4a64e381SAndroid Build Coastguard Worker  *      https://opensource.apple.com/source/mDNSResponder/mDNSResponder-1310.140.1/mDNSShared/dns_sd.h.auto.html.
50*4a64e381SAndroid Build Coastguard Worker  *
51*4a64e381SAndroid Build Coastguard Worker  * @param[in] aName  The DNS Service Instance name to unescape.
52*4a64e381SAndroid Build Coastguard Worker  *
53*4a64e381SAndroid Build Coastguard Worker  * @returns  The unescaped DNS Service Instance name.
54*4a64e381SAndroid Build Coastguard Worker  */
55*4a64e381SAndroid Build Coastguard Worker std::string UnescapeInstanceName(const std::string &aName);
56*4a64e381SAndroid Build Coastguard Worker 
57*4a64e381SAndroid Build Coastguard Worker /**
58*4a64e381SAndroid Build Coastguard Worker  * This function checks a given host name for sanity.
59*4a64e381SAndroid Build Coastguard Worker  *
60*4a64e381SAndroid Build Coastguard Worker  * Check criteria:
61*4a64e381SAndroid Build Coastguard Worker  *      The host name must ends with dot.
62*4a64e381SAndroid Build Coastguard Worker  *
63*4a64e381SAndroid Build Coastguard Worker  * @param[in] aHostName  The host name to check.
64*4a64e381SAndroid Build Coastguard Worker  */
65*4a64e381SAndroid Build Coastguard Worker void CheckHostnameSanity(const std::string &aHostName);
66*4a64e381SAndroid Build Coastguard Worker 
67*4a64e381SAndroid Build Coastguard Worker /**
68*4a64e381SAndroid Build Coastguard Worker  * This function checks a given service name for sanity.
69*4a64e381SAndroid Build Coastguard Worker  *
70*4a64e381SAndroid Build Coastguard Worker  * Check criteria:
71*4a64e381SAndroid Build Coastguard Worker  *      The service name must contain exactly one dot.
72*4a64e381SAndroid Build Coastguard Worker  *      The service name must not end with dot.
73*4a64e381SAndroid Build Coastguard Worker  *
74*4a64e381SAndroid Build Coastguard Worker  * @param[in] aServiceName  The service name to check.
75*4a64e381SAndroid Build Coastguard Worker  */
76*4a64e381SAndroid Build Coastguard Worker void CheckServiceNameSanity(const std::string &aServiceName);
77*4a64e381SAndroid Build Coastguard Worker 
78*4a64e381SAndroid Build Coastguard Worker } // namespace DnsUtils
79*4a64e381SAndroid Build Coastguard Worker } // namespace otbr
80*4a64e381SAndroid Build Coastguard Worker #endif // OTBR_UTILS_DNS_UTILS_HPP_
81