1 /*
2  * Copyright (C) 2018 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #define LOG_TAG "resolv"
18 
19 #include "PrivateDnsConfiguration.h"
20 
21 #include <algorithm>
22 
23 #include <android-base/format.h>
24 #include <android-base/logging.h>
25 #include <android/binder_ibinder.h>
26 #include <netdutils/Slice.h>
27 #include <netdutils/ThreadUtil.h>
28 #include <sys/socket.h>
29 
30 #include "DnsTlsTransport.h"
31 #include "ResolverEventReporter.h"
32 #include "doh.h"
33 #include "netd_resolv/resolv.h"
34 #include "resolv_cache.h"
35 #include "resolv_private.h"
36 #include "util.h"
37 
38 using aidl::android::net::resolv::aidl::IDnsResolverUnsolicitedEventListener;
39 using aidl::android::net::resolv::aidl::PrivateDnsValidationEventParcel;
40 using android::netdutils::IPAddress;
41 using android::netdutils::IPSockAddr;
42 using android::netdutils::setThreadName;
43 using android::netdutils::Slice;
44 using std::chrono::milliseconds;
45 
46 namespace android {
47 namespace net {
48 
49 namespace {
50 
ensureNoInvalidIp(const std::vector<std::string> & servers)51 bool ensureNoInvalidIp(const std::vector<std::string>& servers) {
52     IPAddress ip;
53     for (const auto& s : servers) {
54         if (!IPAddress::forString(s, &ip)) {
55             LOG(WARNING) << "Invalid IP address: " << s;
56             return false;
57         }
58     }
59     return true;
60 }
61 
62 }  // namespace
63 
convertEnumType(PrivateDnsMode mode)64 PrivateDnsModes convertEnumType(PrivateDnsMode mode) {
65     switch (mode) {
66         case PrivateDnsMode::OFF:
67             return PrivateDnsModes::PDM_OFF;
68         case PrivateDnsMode::OPPORTUNISTIC:
69             return PrivateDnsModes::PDM_OPPORTUNISTIC;
70         case PrivateDnsMode::STRICT:
71             return PrivateDnsModes::PDM_STRICT;
72         default:
73             return PrivateDnsModes::PDM_UNKNOWN;
74     }
75 }
76 
set(int32_t netId,uint32_t mark,const std::vector<std::string> & unencryptedServers,const std::vector<std::string> & encryptedServers,const std::string & name,const std::string & caCert)77 int PrivateDnsConfiguration::set(int32_t netId, uint32_t mark,
78                                  const std::vector<std::string>& unencryptedServers,
79                                  const std::vector<std::string>& encryptedServers,
80                                  const std::string& name, const std::string& caCert) {
81     LOG(DEBUG) << "PrivateDnsConfiguration::set(" << netId << ", 0x" << std::hex << mark << std::dec
82                << ", " << encryptedServers.size() << ", " << name << ")";
83 
84     if (!ensureNoInvalidIp(encryptedServers)) return -EINVAL;
85 
86     std::lock_guard guard(mPrivateDnsLock);
87     mUnorderedDnsTracker[netId] = unencryptedServers;
88     mUnorderedDotTracker[netId] = encryptedServers;
89     mUnorderedDohTracker[netId] = encryptedServers;
90 
91     if (!name.empty()) {
92         mPrivateDnsModes[netId] = PrivateDnsMode::STRICT;
93     } else if (!encryptedServers.empty()) {
94         mPrivateDnsModes[netId] = PrivateDnsMode::OPPORTUNISTIC;
95     } else {
96         mPrivateDnsModes[netId] = PrivateDnsMode::OFF;
97         clearDot(netId);
98         clearDoh(netId);
99         return 0;
100         // TODO: signal validation threads to stop.
101     }
102 
103     if (int n = setDot(netId, mark, encryptedServers, name, caCert); n != 0) {
104         return n;
105     }
106     if (isDoHEnabled()) {
107         return setDoh(netId, mark, encryptedServers, name, caCert);
108     }
109 
110     return 0;
111 }
112 
setDot(int32_t netId,uint32_t mark,const std::vector<std::string> & servers,const std::string & name,const std::string & caCert)113 int PrivateDnsConfiguration::setDot(int32_t netId, uint32_t mark,
114                                     const std::vector<std::string>& servers,
115                                     const std::string& name, const std::string& caCert) {
116     // Parse the list of servers that has been passed in
117     std::map<ServerIdentity, DnsTlsServer> tmp;
118     for (const auto& s : servers) {
119         // The IP addresses are guaranteed to be valid.
120         DnsTlsServer server(IPAddress::forString(s));
121         server.name = name;
122         server.certificate = caCert;
123         server.mark = mark;
124         tmp[ServerIdentity(server)] = server;
125     }
126 
127     // Create the tracker if it was not present
128     auto& tracker = mDotTracker[netId];
129 
130     // Add the servers if not contained in tracker.
131     for (const auto& [identity, server] : tmp) {
132         if (tracker.find(identity) == tracker.end()) {
133             tracker[identity] = server;
134         }
135     }
136 
137     for (auto& [identity, server] : tracker) {
138         const bool active = tmp.find(identity) != tmp.end();
139         server.setActive(active);
140 
141         // For simplicity, deem the validation result of inactive servers as unreliable.
142         if (!server.active() && server.validationState() == Validation::success) {
143             updateServerState(identity, Validation::success_but_expired, netId);
144         }
145 
146         if (needsValidation(server)) {
147             updateServerState(identity, Validation::in_process, netId);
148             startDotValidation(identity, netId, false);
149         }
150     }
151 
152     return resolv_stats_set_addrs(netId, PROTO_DOT, servers, kDotPort);
153 }
154 
clearDot(int32_t netId)155 void PrivateDnsConfiguration::clearDot(int32_t netId) {
156     mDotTracker.erase(netId);
157     resolv_stats_set_addrs(netId, PROTO_DOT, {}, kDotPort);
158 }
159 
getStatus(unsigned netId) const160 PrivateDnsStatus PrivateDnsConfiguration::getStatus(unsigned netId) const {
161     std::lock_guard guard(mPrivateDnsLock);
162     return getStatusLocked(netId);
163 }
164 
getStatusLocked(unsigned netId) const165 PrivateDnsStatus PrivateDnsConfiguration::getStatusLocked(unsigned netId) const {
166     PrivateDnsStatus status{
167             .mode = PrivateDnsMode::OFF,
168             .dotServersMap = {},
169             .dohServersMap = {},
170     };
171 
172     const auto mode = mPrivateDnsModes.find(netId);
173     if (mode == mPrivateDnsModes.end()) return status;
174     status.mode = mode->second;
175 
176     const auto netPair = mDotTracker.find(netId);
177     if (netPair != mDotTracker.end()) {
178         for (const auto& [_, server] : netPair->second) {
179             if (server.active()) {
180                 status.dotServersMap.emplace(server, server.validationState());
181             }
182         }
183     }
184 
185     auto it = mDohTracker.find(netId);
186     if (it != mDohTracker.end()) {
187         status.dohServersMap.emplace(
188                 netdutils::IPSockAddr::toIPSockAddr(it->second.ipAddr, kDohPort),
189                 it->second.status);
190     }
191 
192     return status;
193 }
194 
getStatusForMetrics(unsigned netId) const195 NetworkDnsServerSupportReported PrivateDnsConfiguration::getStatusForMetrics(unsigned netId) const {
196     const auto networkType = resolv_get_network_types_for_net(netId);
197     std::lock_guard guard(mPrivateDnsLock);
198 
199     if (mPrivateDnsModes.find(netId) == mPrivateDnsModes.end()) {
200         // Return NetworkDnsServerSupportReported with private_dns_modes set to PDM_UNKNOWN.
201         return {};
202     }
203 
204     const PrivateDnsStatus status = getStatusLocked(netId);
205     NetworkDnsServerSupportReported event = {};
206     event.set_network_type(networkType);
207     event.set_private_dns_modes(convertEnumType(status.mode));
208 
209     if (const auto it = mUnorderedDnsTracker.find(netId); it != mUnorderedDnsTracker.end()) {
210         for (size_t i = 0; i < it->second.size(); i++) {
211             Server* server = event.mutable_servers()->add_server();
212             server->set_protocol(PROTO_UDP);
213             server->set_index(i);
214             server->set_validated(false);
215         }
216     }
217 
218     if (const auto it = mUnorderedDotTracker.find(netId); it != mUnorderedDotTracker.end()) {
219         int index = 0;
220         const std::list<DnsTlsServer> validatedServers = status.validatedServers();
221         for (const std::string& s : it->second) {
222             const IPSockAddr target = IPSockAddr::toIPSockAddr(s, kDotPort);
223             bool validated =
224                     std::any_of(validatedServers.begin(), validatedServers.end(),
225                                 [&target](DnsTlsServer server) { return server.addr() == target; });
226             Server* server = event.mutable_servers()->add_server();
227             server->set_protocol(PROTO_DOT);
228             server->set_index(index++);
229             server->set_validated(validated);
230         }
231     }
232 
233     if (const auto it = mUnorderedDohTracker.find(netId); it != mUnorderedDohTracker.end()) {
234         int index = 0;
235         for (const std::string& s : it->second) {
236             const IPSockAddr target = IPSockAddr::toIPSockAddr(s, kDohPort);
237             bool validated = std::any_of(status.dohServersMap.begin(), status.dohServersMap.end(),
238                                          [&target](const auto& entry) {
239                                              return entry.first == target &&
240                                                     entry.second == Validation::success;
241                                          });
242             Server* server = event.mutable_servers()->add_server();
243             server->set_protocol(PROTO_DOH);
244             server->set_index(index++);
245             server->set_validated(validated);
246         }
247     }
248 
249     return event;
250 }
251 
clear(unsigned netId)252 void PrivateDnsConfiguration::clear(unsigned netId) {
253     LOG(DEBUG) << "PrivateDnsConfiguration::clear(" << netId << ")";
254     std::lock_guard guard(mPrivateDnsLock);
255     mPrivateDnsModes.erase(netId);
256     mUnorderedDnsTracker.erase(netId);
257     mUnorderedDotTracker.erase(netId);
258     mUnorderedDohTracker.erase(netId);
259     clearDot(netId);
260     clearDoh(netId);
261 
262     // Notify the relevant private DNS validations, if they are waiting, to finish.
263     mCv.notify_all();
264 }
265 
requestDotValidation(unsigned netId,const ServerIdentity & identity,uint32_t mark)266 base::Result<void> PrivateDnsConfiguration::requestDotValidation(unsigned netId,
267                                                                  const ServerIdentity& identity,
268                                                                  uint32_t mark) {
269     std::lock_guard guard(mPrivateDnsLock);
270 
271     // Running revalidation requires to mark the server as in_process, which means the server
272     // won't be used until the validation passes. It's necessary and safe to run revalidation
273     // when in private DNS opportunistic mode, because there's a fallback mechanics even if
274     // all of the private DNS servers are in in_process state.
275     if (auto it = mPrivateDnsModes.find(netId); it == mPrivateDnsModes.end()) {
276         return Errorf("NetId not found in mPrivateDnsModes");
277     } else if (it->second != PrivateDnsMode::OPPORTUNISTIC) {
278         return Errorf("Private DNS setting is not opportunistic mode");
279     }
280 
281     auto result = getDotServerLocked(identity, netId);
282     if (!result.ok()) {
283         return result.error();
284     }
285 
286     const DnsTlsServer* target = result.value();
287 
288     if (!target->active()) return Errorf("Server is not active");
289 
290     if (target->validationState() != Validation::success) {
291         return Errorf("Server validation state mismatched");
292     }
293 
294     // Don't run the validation if |mark| (from android_net_context.dns_mark) is different.
295     // This is to protect validation from running on unexpected marks.
296     // Validation should be associated with a mark gotten by system permission.
297     if (target->validationMark() != mark) return Errorf("Socket mark mismatched");
298 
299     updateServerState(identity, Validation::in_process, netId);
300     startDotValidation(identity, netId, true);
301     return {};
302 }
303 
startDotValidation(const ServerIdentity & identity,unsigned netId,bool isRevalidation)304 void PrivateDnsConfiguration::startDotValidation(const ServerIdentity& identity, unsigned netId,
305                                                  bool isRevalidation) {
306     // This ensures that the thread sends probe at least once in case
307     // the server is removed before the thread starts running.
308     // TODO: consider moving these code to the thread.
309     const auto result = getDotServerLocked(identity, netId);
310     if (!result.ok()) return;
311     DnsTlsServer server = *result.value();
312 
313     std::thread validate_thread([this, identity, server, netId, isRevalidation] {
314         setThreadName(fmt::format("TlsVerify_{}", netId));
315 
316         // cat /proc/sys/net/ipv4/tcp_syn_retries yields "6".
317         //
318         // Start with a 1 minute delay and backoff to once per hour.
319         //
320         // Assumptions:
321         //     [1] Each TLS validation is ~10KB of certs+handshake+payload.
322         //     [2] Network typically provision clients with <=4 nameservers.
323         //     [3] Average month has 30 days.
324         //
325         // Each validation pass in a given hour is ~1.2MB of data. And 24
326         // such validation passes per day is about ~30MB per month, in the
327         // worst case. Otherwise, this will cost ~600 SYNs per month
328         // (6 SYNs per ip, 4 ips per validation pass, 24 passes per day).
329         auto backoff = mBackoffBuilder.build();
330 
331         while (true) {
332             // ::validate() is a blocking call that performs network operations.
333             // It can take milliseconds to minutes, up to the SYN retry limit.
334             LOG(WARNING) << "Validating DnsTlsServer " << server.toIpString() << " with mark 0x"
335                          << std::hex << server.validationMark();
336             const bool success = DnsTlsTransport::validate(server, server.validationMark());
337             LOG(WARNING) << "validateDnsTlsServer returned " << success << " for "
338                          << server.toIpString();
339 
340             const bool needs_reeval =
341                     this->recordDotValidation(identity, netId, success, isRevalidation);
342 
343             if (!needs_reeval || !backoff.hasNextTimeout()) {
344                 break;
345             }
346 
347             std::unique_lock<std::mutex> cvGuard(mPrivateDnsLock);
348             // If the timeout expired and the predicate still evaluates to false, wait_for returns
349             // false.
350             if (mCv.wait_for(cvGuard, backoff.getNextTimeout(),
351                              [this, netId]() REQUIRES(mPrivateDnsLock) {
352                                  return mPrivateDnsModes.find(netId) == mPrivateDnsModes.end();
353                              })) {
354                 break;
355             }
356         }
357     });
358     validate_thread.detach();
359 }
360 
sendPrivateDnsValidationEvent(const ServerIdentity & identity,unsigned netId,bool success) const361 void PrivateDnsConfiguration::sendPrivateDnsValidationEvent(const ServerIdentity& identity,
362                                                             unsigned netId, bool success) const {
363     LOG(DEBUG) << "Sending validation " << (success ? "success" : "failure") << " event on netId "
364                << netId << " for " << identity.sockaddr.toString() << " with hostname {"
365                << identity.provider << "}";
366     // Send a validation event to NetdEventListenerService.
367     const auto& listeners = ResolverEventReporter::getInstance().getListeners();
368     if (listeners.empty()) {
369         LOG(ERROR)
370                 << "Validation event not sent since no INetdEventListener receiver is available.";
371     }
372     for (const auto& it : listeners) {
373         it->onPrivateDnsValidationEvent(netId, identity.sockaddr.ip().toString(), identity.provider,
374                                         success);
375     }
376 
377     // Send a validation event to unsolicited event listeners.
378     const auto& unsolEventListeners = ResolverEventReporter::getInstance().getUnsolEventListeners();
379     const PrivateDnsValidationEventParcel validationEvent = {
380             .netId = static_cast<int32_t>(netId),
381             .ipAddress = identity.sockaddr.ip().toString(),
382             .hostname = identity.provider,
383             .validation = success ? IDnsResolverUnsolicitedEventListener::VALIDATION_RESULT_SUCCESS
384                                   : IDnsResolverUnsolicitedEventListener::VALIDATION_RESULT_FAILURE,
385             .protocol = (identity.sockaddr.port() == kDotPort)
386                                 ? IDnsResolverUnsolicitedEventListener::PROTOCOL_DOT
387                                 : IDnsResolverUnsolicitedEventListener::PROTOCOL_DOH,
388     };
389     for (const auto& it : unsolEventListeners) {
390         it->onPrivateDnsValidationEvent(validationEvent);
391     }
392 }
393 
recordDotValidation(const ServerIdentity & identity,unsigned netId,bool success,bool isRevalidation)394 bool PrivateDnsConfiguration::recordDotValidation(const ServerIdentity& identity, unsigned netId,
395                                                   bool success, bool isRevalidation) {
396     constexpr bool NEEDS_REEVALUATION = true;
397     constexpr bool DONT_REEVALUATE = false;
398 
399     std::lock_guard guard(mPrivateDnsLock);
400 
401     auto netPair = mDotTracker.find(netId);
402     if (netPair == mDotTracker.end()) {
403         LOG(WARNING) << "netId " << netId << " was erased during private DNS validation";
404         notifyValidationStateUpdate(identity.sockaddr, Validation::fail, netId);
405         return DONT_REEVALUATE;
406     }
407 
408     const auto mode = mPrivateDnsModes.find(netId);
409     if (mode == mPrivateDnsModes.end()) {
410         LOG(WARNING) << "netId " << netId << " has no private DNS validation mode";
411         notifyValidationStateUpdate(identity.sockaddr, Validation::fail, netId);
412         return DONT_REEVALUATE;
413     }
414 
415     bool reevaluationStatus = NEEDS_REEVALUATION;
416     if (success || (mode->second == PrivateDnsMode::OFF) ||
417         (mode->second == PrivateDnsMode::OPPORTUNISTIC && !isRevalidation)) {
418         reevaluationStatus = DONT_REEVALUATE;
419     }
420 
421     auto& tracker = netPair->second;
422     auto serverPair = tracker.find(identity);
423     if (serverPair == tracker.end()) {
424         LOG(WARNING) << "Server " << identity.sockaddr.ip().toString()
425                      << " was removed during private DNS validation";
426         success = false;
427         reevaluationStatus = DONT_REEVALUATE;
428     } else if (!serverPair->second.active()) {
429         LOG(WARNING) << "Server " << identity.sockaddr.ip().toString()
430                      << " was removed from the configuration";
431         success = false;
432         reevaluationStatus = DONT_REEVALUATE;
433     }
434 
435     // Send private dns validation result to listeners.
436     if (needReportEvent(netId, identity, success)) {
437         sendPrivateDnsValidationEvent(identity, netId, success);
438     }
439 
440     if (success) {
441         updateServerState(identity, Validation::success, netId);
442     } else {
443         // Validation failure is expected if a user is on a captive portal.
444         // TODO: Trigger a second validation attempt after captive portal login
445         // succeeds.
446         const auto result = (reevaluationStatus == NEEDS_REEVALUATION) ? Validation::in_process
447                                                                        : Validation::fail;
448         updateServerState(identity, result, netId);
449     }
450     LOG(WARNING) << "Validation " << (success ? "success" : "failed");
451 
452     return reevaluationStatus;
453 }
454 
updateServerState(const ServerIdentity & identity,Validation state,uint32_t netId)455 void PrivateDnsConfiguration::updateServerState(const ServerIdentity& identity, Validation state,
456                                                 uint32_t netId) {
457     const auto result = getDotServerLocked(identity, netId);
458     if (!result.ok()) {
459         notifyValidationStateUpdate(identity.sockaddr, Validation::fail, netId);
460         return;
461     }
462 
463     auto* server = result.value();
464 
465     server->setValidationState(state);
466     notifyValidationStateUpdate(identity.sockaddr, state, netId);
467 
468     RecordEntry record(netId, identity, state);
469     mPrivateDnsLog.push(std::move(record));
470 }
471 
needsValidation(const DnsTlsServer & server) const472 bool PrivateDnsConfiguration::needsValidation(const DnsTlsServer& server) const {
473     // The server is not expected to be used on the network.
474     if (!server.active()) return false;
475 
476     // The server is newly added.
477     if (server.validationState() == Validation::unknown_server) return true;
478 
479     // The server has failed at least one validation attempt. Give it another try.
480     if (server.validationState() == Validation::fail) return true;
481 
482     // The previous validation result might be unreliable.
483     if (server.validationState() == Validation::success_but_expired) return true;
484 
485     return false;
486 }
487 
getDotServer(const ServerIdentity & identity,unsigned netId)488 base::Result<DnsTlsServer*> PrivateDnsConfiguration::getDotServer(const ServerIdentity& identity,
489                                                                   unsigned netId) {
490     std::lock_guard guard(mPrivateDnsLock);
491     return getDotServerLocked(identity, netId);
492 }
493 
getDotServerLocked(const ServerIdentity & identity,unsigned netId)494 base::Result<DnsTlsServer*> PrivateDnsConfiguration::getDotServerLocked(
495         const ServerIdentity& identity, unsigned netId) {
496     auto netPair = mDotTracker.find(netId);
497     if (netPair == mDotTracker.end()) {
498         return Errorf("Failed to get private DNS: netId {} not found", netId);
499     }
500 
501     auto iter = netPair->second.find(identity);
502     if (iter == netPair->second.end()) {
503         return Errorf("Failed to get private DNS: server {{{}/{}}} not found", identity.sockaddr,
504                       identity.provider);
505     }
506 
507     return &iter->second;
508 }
509 
setObserver(PrivateDnsValidationObserver * observer)510 void PrivateDnsConfiguration::setObserver(PrivateDnsValidationObserver* observer) {
511     std::lock_guard guard(mPrivateDnsLock);
512     mObserver = observer;
513 }
514 
getDohServer(unsigned netId) const515 base::Result<netdutils::IPSockAddr> PrivateDnsConfiguration::getDohServer(unsigned netId) const {
516     std::lock_guard guard(mPrivateDnsLock);
517     auto it = mDohTracker.find(netId);
518     if (it != mDohTracker.end()) {
519         return netdutils::IPSockAddr::toIPSockAddr(it->second.ipAddr, kDohPort);
520     }
521 
522     return Errorf("Failed to get DoH Server: netId {} not found", netId);
523 }
524 
notifyValidationStateUpdate(const netdutils::IPSockAddr & sockaddr,Validation validation,uint32_t netId) const525 void PrivateDnsConfiguration::notifyValidationStateUpdate(const netdutils::IPSockAddr& sockaddr,
526                                                           Validation validation,
527                                                           uint32_t netId) const {
528     if (mObserver) {
529         mObserver->onValidationStateUpdate(sockaddr.ip().toString(), validation, netId);
530     }
531 }
532 
dump(netdutils::DumpWriter & dw) const533 void PrivateDnsConfiguration::dump(netdutils::DumpWriter& dw) const {
534     dw.println("PrivateDnsLog:");
535     netdutils::ScopedIndent indentStats(dw);
536 
537     for (const auto& record : mPrivateDnsLog.copy()) {
538         dw.println(fmt::format(
539                 "{} - netId={} PrivateDns={{{}/{}}} state={}", timestampToString(record.timestamp),
540                 record.netId, record.serverIdentity.sockaddr.toString(),
541                 record.serverIdentity.provider, validationStatusToString(record.state)));
542     }
543     dw.blankline();
544 }
545 
initDoh()546 void PrivateDnsConfiguration::initDoh() {
547     std::lock_guard guard(mPrivateDnsLock);
548     initDohLocked();
549 }
550 
initDohLocked()551 void PrivateDnsConfiguration::initDohLocked() {
552     if (mDohDispatcher != nullptr) return;
553     mDohDispatcher = doh_dispatcher_new(
554             [](uint32_t net_id, bool success, const char* ip_addr, const char* host) {
555                 android::net::PrivateDnsConfiguration::getInstance().onDohStatusUpdate(
556                         net_id, success, ip_addr, host);
557             },
558             [](int32_t sock) { resolv_tag_socket(sock, AID_DNS, NET_CONTEXT_INVALID_PID); });
559 }
560 
setDoh(int32_t netId,uint32_t mark,const std::vector<std::string> & servers,const std::string & name,const std::string & caCert)561 int PrivateDnsConfiguration::setDoh(int32_t netId, uint32_t mark,
562                                     const std::vector<std::string>& servers,
563                                     const std::string& name, const std::string& caCert) {
564     LOG(DEBUG) << "PrivateDnsConfiguration::setDoh(" << netId << ", 0x" << std::hex << mark
565                << std::dec << ", " << servers.size() << ", " << name << ")";
566     if (servers.empty()) {
567         clearDoh(netId);
568         return 0;
569     }
570 
571     const auto getTimeoutFromFlag = [&](const std::string_view key, int defaultValue) -> uint64_t {
572         static constexpr int kMinTimeoutMs = 1000;
573         uint64_t timeout = Experiments::getInstance()->getFlag(key, defaultValue);
574         if (timeout < kMinTimeoutMs) {
575             timeout = kMinTimeoutMs;
576         }
577         return timeout;
578     };
579 
580     // Sort the input servers to ensure that we could get the server vector at the same order.
581     std::vector<std::string> sortedServers = servers;
582     // Prefer ipv6.
583     std::sort(sortedServers.begin(), sortedServers.end(), [](std::string a, std::string b) {
584         IPAddress ipa = IPAddress::forString(a);
585         IPAddress ipb = IPAddress::forString(b);
586         return ipa > ipb;
587     });
588 
589     initDohLocked();
590 
591     // TODO: 1. Improve how to choose the server
592     // TODO: 2. Support multiple servers
593     for (const auto& entry : mAvailableDoHProviders) {
594         const auto& doh = entry.getDohIdentity(sortedServers, name);
595         if (!doh.ok()) continue;
596 
597         // Since the DnsResolver is expected to be configured by the system server, add the
598         // restriction to prevent ResolverTestProvider from being used other than testing.
599         if (entry.requireRootPermission && AIBinder_getCallingUid() != AID_ROOT) continue;
600 
601         auto it = mDohTracker.find(netId);
602         // Skip if the same server already exists and its status == success.
603         if (it != mDohTracker.end() && it->second == doh.value() &&
604             it->second.status == Validation::success) {
605             return 0;
606         }
607         const auto& [dohIt, _] = mDohTracker.insert_or_assign(netId, doh.value());
608         const auto& dohId = dohIt->second;
609 
610         RecordEntry record(netId,
611                            {netdutils::IPSockAddr::toIPSockAddr(dohId.ipAddr, kDohPort), name},
612                            dohId.status);
613         mPrivateDnsLog.push(std::move(record));
614         LOG(INFO) << __func__ << ": Upgrading server to DoH: " << name;
615         resolv_stats_set_addrs(netId, PROTO_DOH, {dohId.ipAddr}, kDohPort);
616 
617         const FeatureFlags flags = {
618                 .probe_timeout_ms =
619                         getTimeoutFromFlag("doh_probe_timeout_ms", kDohProbeDefaultTimeoutMs),
620                 .idle_timeout_ms =
621                         getTimeoutFromFlag("doh_idle_timeout_ms", kDohIdleDefaultTimeoutMs),
622                 .use_session_resumption =
623                         Experiments::getInstance()->getFlag("doh_session_resumption", 0) == 1,
624                 .enable_early_data = Experiments::getInstance()->getFlag("doh_early_data", 0) == 1,
625         };
626         LOG(DEBUG) << __func__ << ": probe_timeout_ms=" << flags.probe_timeout_ms
627                    << ", idle_timeout_ms=" << flags.idle_timeout_ms
628                    << ", use_session_resumption=" << flags.use_session_resumption
629                    << ", enable_early_data=" << flags.enable_early_data;
630 
631         return doh_net_new(mDohDispatcher, netId, dohId.httpsTemplate.c_str(), dohId.host.c_str(),
632                            dohId.ipAddr.c_str(), mark, caCert.c_str(), &flags);
633     }
634 
635     LOG(INFO) << __func__ << ": No suitable DoH server found";
636     clearDoh(netId);
637     return 0;
638 }
639 
clearDoh(unsigned netId)640 void PrivateDnsConfiguration::clearDoh(unsigned netId) {
641     LOG(DEBUG) << "PrivateDnsConfiguration::clearDoh (" << netId << ")";
642     if (mDohDispatcher != nullptr) doh_net_delete(mDohDispatcher, netId);
643     mDohTracker.erase(netId);
644     resolv_stats_set_addrs(netId, PROTO_DOH, {}, kDohPort);
645 }
646 
dohQuery(unsigned netId,const Slice query,const Slice answer,uint64_t timeoutMs)647 ssize_t PrivateDnsConfiguration::dohQuery(unsigned netId, const Slice query, const Slice answer,
648                                           uint64_t timeoutMs) {
649     {
650         std::lock_guard guard(mPrivateDnsLock);
651         // It's safe because mDohDispatcher won't be deleted after initializing.
652         if (mDohDispatcher == nullptr) return DOH_RESULT_CAN_NOT_SEND;
653     }
654     return doh_query(mDohDispatcher, netId, query.base(), query.size(), answer.base(),
655                      answer.size(), timeoutMs);
656 }
657 
onDohStatusUpdate(uint32_t netId,bool success,const char * ipAddr,const char * host)658 void PrivateDnsConfiguration::onDohStatusUpdate(uint32_t netId, bool success, const char* ipAddr,
659                                                 const char* host) {
660     LOG(INFO) << __func__ << ": " << netId << ", " << success << ", " << ipAddr << ", " << host;
661     std::lock_guard guard(mPrivateDnsLock);
662     // Update the server status.
663     auto it = mDohTracker.find(netId);
664     if (it == mDohTracker.end() || (it->second.ipAddr != ipAddr && it->second.host != host)) {
665         LOG(WARNING) << __func__ << ": Obsolete event";
666         return;
667     }
668     Validation status = success ? Validation::success : Validation::fail;
669     it->second.status = status;
670     // Send the events to registered listeners.
671     ServerIdentity identity = {netdutils::IPSockAddr::toIPSockAddr(ipAddr, kDohPort), host};
672     if (needReportEvent(netId, identity, success)) {
673         sendPrivateDnsValidationEvent(identity, netId, success);
674     }
675     // Add log.
676     RecordEntry record(netId, identity, status);
677     mPrivateDnsLog.push(std::move(record));
678 }
679 
needReportEvent(uint32_t netId,ServerIdentity identity,bool success) const680 bool PrivateDnsConfiguration::needReportEvent(uint32_t netId, ServerIdentity identity,
681                                               bool success) const {
682     // If the result is success or DoH is not enable, no concern to report the events.
683     if (success || !isDoHEnabled()) return true;
684     // If the result is failure, check another transport's status to determine if we should report
685     // the event.
686     switch (identity.sockaddr.port()) {
687         // DoH
688         case kDohPort: {
689             auto netPair = mDotTracker.find(netId);
690             if (netPair == mDotTracker.end()) return true;
691             for (const auto& [id, server] : netPair->second) {
692                 if ((identity.sockaddr.ip() == id.sockaddr.ip()) &&
693                     (identity.sockaddr.port() != id.sockaddr.port()) &&
694                     (server.validationState() == Validation::success)) {
695                     LOG(DEBUG) << __func__
696                                << ": Skip reporting DoH validation failure event, server addr: "
697                                << identity.sockaddr.ip().toString();
698                     return false;
699                 }
700             }
701             break;
702         }
703         // DoT
704         case kDotPort: {
705             auto it = mDohTracker.find(netId);
706             if (it == mDohTracker.end()) return true;
707             if (it->second == identity && it->second.status == Validation::success) {
708                 LOG(DEBUG) << __func__
709                            << ": Skip reporting DoT validation failure event, server addr: "
710                            << identity.sockaddr.ip().toString();
711                 return false;
712             }
713             break;
714         }
715     }
716     return true;
717 }
718 
719 }  // namespace net
720 }  // namespace android
721