1 /* 2 * Copyright (c) 2017-2021, 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 includes definition for DNS utilities. 32 */ 33 34 #ifndef OTBR_UTILS_DNS_UTILS_HPP_ 35 #define OTBR_UTILS_DNS_UTILS_HPP_ 36 37 #include "openthread-br/config.h" 38 39 #include <string> 40 41 namespace otbr { 42 43 namespace DnsUtils { 44 45 /** 46 * This function unescapes a DNS Service Instance name according to "DNS Name Escaping". 47 * 48 * @sa "Notes on DNS Name Escaping" at 49 * https://opensource.apple.com/source/mDNSResponder/mDNSResponder-1310.140.1/mDNSShared/dns_sd.h.auto.html. 50 * 51 * @param[in] aName The DNS Service Instance name to unescape. 52 * 53 * @returns The unescaped DNS Service Instance name. 54 * 55 */ 56 std::string UnescapeInstanceName(const std::string &aName); 57 58 /** 59 * This function checks a given host name for sanity. 60 * 61 * Check criteria: 62 * The host name must ends with dot. 63 * 64 * @param[in] aHostName The host name to check. 65 * 66 */ 67 void CheckHostnameSanity(const std::string &aHostName); 68 69 /** 70 * This function checks a given service name for sanity. 71 * 72 * Check criteria: 73 * The service name must contain exactly one dot. 74 * The service name must not end with dot. 75 * 76 * @param[in] aServiceName The service name to check. 77 * 78 */ 79 void CheckServiceNameSanity(const std::string &aServiceName); 80 81 } // namespace DnsUtils 82 } // namespace otbr 83 #endif // OTBR_UTILS_DNS_UTILS_HPP_ 84