-
Notifications
You must be signed in to change notification settings - Fork 4
/
PrivateDnsConfiguration.h
281 lines (226 loc) · 11 KB
/
PrivateDnsConfiguration.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
/*
* Copyright (C) 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#include <array>
#include <list>
#include <map>
#include <mutex>
#include <vector>
#include <android-base/format.h>
#include <android-base/logging.h>
#include <android-base/result.h>
#include <android-base/thread_annotations.h>
#include <netdutils/BackoffSequence.h>
#include <netdutils/DumpWriter.h>
#include <netdutils/InternetAddresses.h>
#include <netdutils/Slice.h>
#include "DnsTlsServer.h"
#include "LockedQueue.h"
#include "PrivateDnsValidationObserver.h"
#include "doh.h"
namespace android {
namespace net {
// TODO: decouple the dependency of DnsTlsServer.
struct PrivateDnsStatus {
PrivateDnsMode mode;
// TODO: change the type to std::vector<DnsTlsServer>.
std::map<DnsTlsServer, Validation, AddressComparator> dotServersMap;
std::map<netdutils::IPSockAddr, Validation> dohServersMap;
std::list<DnsTlsServer> validatedServers() const {
std::list<DnsTlsServer> servers;
for (const auto& pair : dotServersMap) {
if (pair.second == Validation::success) {
servers.push_back(pair.first);
}
}
return servers;
}
bool hasValidatedDohServers() const {
for (const auto& [_, status] : dohServersMap) {
if (status == Validation::success) {
return true;
}
}
return false;
}
};
class PrivateDnsConfiguration {
public:
static constexpr int kDohQueryDefaultTimeoutMs = 30000;
static constexpr int kDohProbeDefaultTimeoutMs = 60000;
// The default value for QUIC max_idle_timeout.
static constexpr int kDohIdleDefaultTimeoutMs = 55000;
struct ServerIdentity {
const netdutils::IPSockAddr sockaddr;
const std::string provider;
explicit ServerIdentity(const IPrivateDnsServer& server)
: sockaddr(server.addr()), provider(server.provider()) {}
ServerIdentity(const netdutils::IPSockAddr& addr, const std::string& host)
: sockaddr(addr), provider(host) {}
bool operator<(const ServerIdentity& other) const {
return std::tie(sockaddr, provider) < std::tie(other.sockaddr, other.provider);
}
bool operator==(const ServerIdentity& other) const {
return std::tie(sockaddr, provider) == std::tie(other.sockaddr, other.provider);
}
};
// The only instance of PrivateDnsConfiguration.
static PrivateDnsConfiguration& getInstance() {
static PrivateDnsConfiguration instance;
return instance;
}
int set(int32_t netId, uint32_t mark, const std::vector<std::string>& servers,
const std::string& name, const std::string& caCert) EXCLUDES(mPrivateDnsLock);
void initDoh() EXCLUDES(mPrivateDnsLock);
int setDoh(int32_t netId, uint32_t mark, const std::vector<std::string>& servers,
const std::string& name, const std::string& caCert) EXCLUDES(mPrivateDnsLock);
PrivateDnsStatus getStatus(unsigned netId) const EXCLUDES(mPrivateDnsLock);
void clear(unsigned netId) EXCLUDES(mPrivateDnsLock);
void clearDoh(unsigned netId) EXCLUDES(mPrivateDnsLock);
ssize_t dohQuery(unsigned netId, const netdutils::Slice query, const netdutils::Slice answer,
uint64_t timeoutMs) EXCLUDES(mPrivateDnsLock);
// Request the server to be revalidated on a connection tagged with |mark|.
// Returns a Result to indicate if the request is accepted.
base::Result<void> requestValidation(unsigned netId, const ServerIdentity& identity,
uint32_t mark) EXCLUDES(mPrivateDnsLock);
void setObserver(PrivateDnsValidationObserver* observer);
void dump(netdutils::DumpWriter& dw) const;
void onDohStatusUpdate(uint32_t netId, bool success, const char* ipAddr, const char* host)
EXCLUDES(mPrivateDnsLock);
base::Result<netdutils::IPSockAddr> getDohServer(unsigned netId) const
EXCLUDES(mPrivateDnsLock);
private:
typedef std::map<ServerIdentity, std::unique_ptr<IPrivateDnsServer>> PrivateDnsTracker;
PrivateDnsConfiguration() = default;
// Launchs a thread to run the validation for |server| on the network |netId|.
// |isRevalidation| is true if this call is due to a revalidation request.
void startValidation(const ServerIdentity& identity, unsigned netId, bool isRevalidation)
REQUIRES(mPrivateDnsLock);
bool recordPrivateDnsValidation(const ServerIdentity& identity, unsigned netId, bool success,
bool isRevalidation) EXCLUDES(mPrivateDnsLock);
void sendPrivateDnsValidationEvent(const ServerIdentity& identity, unsigned netId,
bool success) const REQUIRES(mPrivateDnsLock);
// Decide if a validation for |server| is needed. Note that servers that have failed
// multiple validation attempts but for which there is still a validating
// thread running are marked as being Validation::in_process.
bool needsValidation(const IPrivateDnsServer& server) const REQUIRES(mPrivateDnsLock);
void updateServerState(const ServerIdentity& identity, Validation state, uint32_t netId)
REQUIRES(mPrivateDnsLock);
// For testing.
base::Result<IPrivateDnsServer*> getPrivateDns(const ServerIdentity& identity, unsigned netId)
EXCLUDES(mPrivateDnsLock);
base::Result<IPrivateDnsServer*> getPrivateDnsLocked(const ServerIdentity& identity,
unsigned netId) REQUIRES(mPrivateDnsLock);
void initDohLocked() REQUIRES(mPrivateDnsLock);
void clearDohLocked(unsigned netId) REQUIRES(mPrivateDnsLock);
mutable std::mutex mPrivateDnsLock;
std::map<unsigned, PrivateDnsMode> mPrivateDnsModes GUARDED_BY(mPrivateDnsLock);
// Contains all servers for a network, along with their current validation status.
// In case a server is removed due to a configuration change, it remains in this map,
// but is marked inactive.
// Any pending validation threads will continue running because we have no way to cancel them.
std::map<unsigned, PrivateDnsTracker> mPrivateDnsTransports GUARDED_BY(mPrivateDnsLock);
void notifyValidationStateUpdate(const netdutils::IPSockAddr& sockaddr, Validation validation,
uint32_t netId) const REQUIRES(mPrivateDnsLock);
bool needReportEvent(uint32_t netId, ServerIdentity identity, bool success) const
REQUIRES(mPrivateDnsLock);
// TODO: fix the reentrancy problem.
PrivateDnsValidationObserver* mObserver GUARDED_BY(mPrivateDnsLock);
DohDispatcher* mDohDispatcher;
friend class PrivateDnsConfigurationTest;
// It's not const because PrivateDnsConfigurationTest needs to override it.
// TODO: make it const by dependency injection.
netdutils::BackoffSequence<>::Builder mBackoffBuilder =
netdutils::BackoffSequence<>::Builder()
.withInitialRetransmissionTime(std::chrono::seconds(60))
.withMaximumRetransmissionTime(std::chrono::seconds(3600));
struct DohIdentity {
std::string httpsTemplate;
std::string ipAddr;
std::string host;
Validation status;
bool operator<(const DohIdentity& other) const {
return std::tie(ipAddr, host) < std::tie(other.ipAddr, other.host);
}
bool operator==(const DohIdentity& other) const {
return std::tie(ipAddr, host) == std::tie(other.ipAddr, other.host);
}
bool operator<(const ServerIdentity& other) const {
std::string otherIp = other.sockaddr.ip().toString();
return std::tie(ipAddr, host) < std::tie(otherIp, other.provider);
}
bool operator==(const ServerIdentity& other) const {
std::string otherIp = other.sockaddr.ip().toString();
return std::tie(ipAddr, host) == std::tie(otherIp, other.provider);
}
};
struct DohProviderEntry {
std::string provider;
std::set<std::string> ips;
std::string host;
std::string httpsTemplate;
bool requireRootPermission;
base::Result<DohIdentity> getDohIdentity(const std::vector<std::string>& ips,
const std::string& host) const {
if (!host.empty() && this->host != host) return Errorf("host {} not matched", host);
for (const auto& ip : ips) {
if (this->ips.find(ip) == this->ips.end()) continue;
LOG(INFO) << fmt::format("getDohIdentity: {} {}", ip, host);
// Only pick the first one for now.
return DohIdentity{httpsTemplate, ip, host, Validation::in_process};
}
return Errorf("server not matched");
};
};
// TODO: Move below DoH relevant stuff into Rust implementation.
std::map<unsigned, DohIdentity> mDohTracker GUARDED_BY(mPrivateDnsLock);
std::array<DohProviderEntry, 4> mAvailableDoHProviders = {{
{"Google",
{"2001:4860:4860::8888", "2001:4860:4860::8844", "8.8.8.8", "8.8.4.4"},
"dns.google",
"https://dns.google/dns-query",
false},
{"Cloudflare",
{"2606:4700::6810:f8f9", "2606:4700::6810:f9f9", "104.16.248.249", "104.16.249.249"},
"cloudflare-dns.com",
"https://cloudflare-dns.com/dns-query",
false},
// The DoH providers for testing only.
// Using ResolverTestProvider requires that the DnsResolver is configured by someone
// who has root permission, which should be run by tests only.
{"ResolverTestProvider",
{"127.0.0.3", "::1"},
"example.com",
"https://example.com/dns-query",
true},
{"AndroidTesting",
{"192.0.2.100"},
"dns.androidtesting.org",
"https://dns.androidtesting.org/dns-query",
false},
}};
struct RecordEntry {
RecordEntry(uint32_t netId, const ServerIdentity& identity, Validation state)
: netId(netId), serverIdentity(identity), state(state) {}
const uint32_t netId;
const ServerIdentity serverIdentity;
const Validation state;
const std::chrono::system_clock::time_point timestamp = std::chrono::system_clock::now();
};
LockedRingBuffer<RecordEntry> mPrivateDnsLog{100};
};
} // namespace net
} // namespace android