Add PrivateDnsConfigurationTest (0ee1dc96) · Commits · e / os / android_packages_modules_DnsResolver

Android.bp

+1 −0

Original line number	Diff line number	Diff line
		@@ -259,6 +259,7 @@ cc_test {
		"DnsQueryLogTest.cpp",
		"DnsStatsTest.cpp",
		"ExperimentsTest.cpp",
		"PrivateDnsConfigurationTest.cpp",
		],
		shared_libs: [
		"libcrypto",

PrivateDnsConfiguration.cpp

+21 −0

Original line number	Diff line number	Diff line
		@@ -166,6 +166,8 @@ void PrivateDnsConfiguration::validatePrivateDnsProvider(const DnsTlsServer& ser
		return;
		}

		maybeNotifyObserver(server, Validation::in_process, netId);

		// Note that capturing \|server\| and \|netId\| in this lambda create copies.
		std::thread validate_thread([this, server, netId, mark] {
		setThreadName(StringPrintf("TlsVerify_%u", netId).c_str());
		@@ -222,12 +224,14 @@ bool PrivateDnsConfiguration::recordPrivateDnsValidation(const DnsTlsServer& ser
		auto netPair = mPrivateDnsTransports.find(netId);
		if (netPair == mPrivateDnsTransports.end()) {
		LOG(WARNING) << "netId " << netId << " was erased during private DNS validation";
		maybeNotifyObserver(server, Validation::fail, netId);
		return DONT_REEVALUATE;
		}

		const auto mode = mPrivateDnsModes.find(netId);
		if (mode == mPrivateDnsModes.end()) {
		LOG(WARNING) << "netId " << netId << " has no private DNS validation mode";
		maybeNotifyObserver(server, Validation::fail, netId);
		return DONT_REEVALUATE;
		}
		const bool modeDoesReevaluation = (mode->second == PrivateDnsMode::STRICT);
		@@ -270,12 +274,17 @@ bool PrivateDnsConfiguration::recordPrivateDnsValidation(const DnsTlsServer& ser

		if (success) {
		tracker[server] = Validation::success;
		maybeNotifyObserver(server, Validation::success, netId);
		} else {
		// Validation failure is expected if a user is on a captive portal.
		// TODO: Trigger a second validation attempt after captive portal login
		// succeeds.
		tracker[server] = (reevaluationStatus == NEEDS_REEVALUATION) ? Validation::in_process
		: Validation::fail;
		maybeNotifyObserver(server,
		(reevaluationStatus == NEEDS_REEVALUATION) ? Validation::in_process
		: Validation::fail,
		netId);
		}
		LOG(WARNING) << "Validation " << (success ? "success" : "failed");

		@@ -336,5 +345,17 @@ bool PrivateDnsConfiguration::needsValidation(const PrivateDnsTracker& tracker,
		return (iter == tracker.end()) \|\| (iter->second == Validation::fail);
		}

		void PrivateDnsConfiguration::setObserver(Observer* observer) {
		std::lock_guard guard(mPrivateDnsLock);
		mObserver = observer;
		}

		void PrivateDnsConfiguration::maybeNotifyObserver(const DnsTlsServer& server, Validation validation,
		uint32_t netId) const {
		if (mObserver) {
		mObserver->onValidationStateUpdate(addrToString(&server.ss), validation, netId);
		}
		}

		} // namespace net
		} // namespace android

PrivateDnsConfiguration.h

+17 −0

Original line number	Diff line number	Diff line
		@@ -91,6 +91,23 @@ class PrivateDnsConfiguration {
		// Using the AddressComparator ensures at most one entry per IP address.
		std::map<unsigned, PrivateDnsTracker> mPrivateDnsTransports GUARDED_BY(mPrivateDnsLock);
		std::map<unsigned, ThreadTracker> mPrivateDnsValidateThreads GUARDED_BY(mPrivateDnsLock);

		// For testing. The observer is notified of onValidationStateUpdate 1) when a validation is
		// about to begin or 2) when a validation finishes.
		class Observer {
		public:
		virtual ~Observer(){};
		virtual void onValidationStateUpdate(const std::string& server, Validation validation,
		uint32_t netId) = 0;
		};

		void setObserver(Observer* observer);
		void maybeNotifyObserver(const DnsTlsServer& server, Validation validation,
		uint32_t netId) const REQUIRES(mPrivateDnsLock);

		Observer* mObserver GUARDED_BY(mPrivateDnsLock);

		friend class PrivateDnsConfigurationTest;
		};

		} // namespace net

PrivateDnsConfigurationTest.cpp

0 → 100644

+223 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2020 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.
		*/

		#include <gmock/gmock.h>
		#include <gtest/gtest.h>

		#include "PrivateDnsConfiguration.h"
		#include "tests/dns_responder/dns_responder.h"
		#include "tests/dns_responder/dns_tls_frontend.h"
		#include "tests/resolv_test_utils.h"

		namespace android::net {

		using namespace std::chrono_literals;

		class PrivateDnsConfigurationTest : public ::testing::Test {
		public:
		static void SetUpTestSuite() {
		// stopServer() will be called in their destructor.
		ASSERT_TRUE(tls1.startServer());
		ASSERT_TRUE(tls2.startServer());
		ASSERT_TRUE(backend.startServer());
		}

		void SetUp() {
		mPdc.setObserver(&mObserver);

		// The default and sole action when the observer is notified of onValidationStateUpdate.
		// Don't override the action. In other words, don't use WillOnce() or WillRepeatedly()
		// when mObserver.onValidationStateUpdate is expected to be called, like:
		//
		// EXPECT_CALL(mObserver, onValidationStateUpdate).WillOnce(Return());
		//
		// This is to ensure that tests can monitor how many validation threads are running. Tests
		// must wait until every validation thread finishes.
		ON_CALL(mObserver, onValidationStateUpdate)
		.WillByDefault([&](const std::string& server, Validation validation, uint32_t) {
		if (validation == Validation::in_process) {
		mObserver.runningThreads++;
		} else if (validation == Validation::success \|\|
		validation == Validation::fail) {
		mObserver.runningThreads--;
		}
		std::lock_guard guard(mObserver.lock);
		mObserver.serverStateMap[server] = validation;
		});
		}

		protected:
		class MockObserver : public PrivateDnsConfiguration::Observer {
		public:
		MOCK_METHOD(void, onValidationStateUpdate,
		(const std::string& server, Validation validation, uint32_t netId), (override));

		std::map<std::string, Validation> getServerStateMap() const {
		std::lock_guard guard(lock);
		return serverStateMap;
		}

		void removeFromServerStateMap(const std::string& server) {
		std::lock_guard guard(lock);
		if (const auto it = serverStateMap.find(server); it != serverStateMap.end())
		serverStateMap.erase(it);
		}

		// The current number of validation threads running.
		std::atomic<int> runningThreads = 0;

		mutable std::mutex lock;
		std::map<std::string, Validation> serverStateMap GUARDED_BY(lock);
		};

		void expectPrivateDnsStatus(PrivateDnsMode mode) {
		const PrivateDnsStatus status = mPdc.getStatus(kNetId);
		EXPECT_EQ(status.mode, mode);

		std::map<std::string, Validation> serverStateMap;
		for (const auto& [server, validation] : status.serversMap) {
		serverStateMap[ToString(&server.ss)] = validation;
		}
		EXPECT_EQ(serverStateMap, mObserver.getServerStateMap());
		}

		static constexpr uint32_t kNetId = 30;
		static constexpr uint32_t kMark = 30;
		static constexpr char kBackend[] = "127.0.2.1";
		static constexpr char kServer1[] = "127.0.2.2";
		static constexpr char kServer2[] = "127.0.2.3";

		MockObserver mObserver;
		PrivateDnsConfiguration mPdc;

		// TODO: Because incorrect CAs result in validation failed in strict mode, have
		// PrivateDnsConfiguration run mocked code rather than DnsTlsTransport::validate().
		inline static test::DnsTlsFrontend tls1{kServer1, "853", kBackend, "53"};
		inline static test::DnsTlsFrontend tls2{kServer2, "853", kBackend, "53"};
		inline static test::DNSResponder backend{kBackend, "53"};
		};

		TEST_F(PrivateDnsConfigurationTest, ValidationSuccess) {
		testing::InSequence seq;
		EXPECT_CALL(mObserver, onValidationStateUpdate(kServer1, Validation::in_process, kNetId));
		EXPECT_CALL(mObserver, onValidationStateUpdate(kServer1, Validation::success, kNetId));

		EXPECT_EQ(mPdc.set(kNetId, kMark, {kServer1}, {}, {}), 0);
		expectPrivateDnsStatus(PrivateDnsMode::OPPORTUNISTIC);

		ASSERT_TRUE(PollForCondition([&]() { return mObserver.runningThreads == 0; }));
		}

		TEST_F(PrivateDnsConfigurationTest, ValidationFail_Opportunistic) {
		ASSERT_TRUE(backend.stopServer());

		testing::InSequence seq;
		EXPECT_CALL(mObserver, onValidationStateUpdate(kServer1, Validation::in_process, kNetId));
		EXPECT_CALL(mObserver, onValidationStateUpdate(kServer1, Validation::fail, kNetId));

		EXPECT_EQ(mPdc.set(kNetId, kMark, {kServer1}, {}, {}), 0);
		expectPrivateDnsStatus(PrivateDnsMode::OPPORTUNISTIC);

		// Strictly wait for all of the validation finish; otherwise, the test can crash somehow.
		ASSERT_TRUE(PollForCondition([&]() { return mObserver.runningThreads == 0; }));
		ASSERT_TRUE(backend.startServer());
		}

		TEST_F(PrivateDnsConfigurationTest, ValidationBlock) {
		backend.setDeferredResp(true);

		// onValidationStateUpdate() is called in sequence.
		{
		testing::InSequence seq;
		EXPECT_CALL(mObserver, onValidationStateUpdate(kServer1, Validation::in_process, kNetId));
		EXPECT_EQ(mPdc.set(kNetId, kMark, {kServer1}, {}, {}), 0);
		ASSERT_TRUE(PollForCondition([&]() { return mObserver.runningThreads == 1; }));
		expectPrivateDnsStatus(PrivateDnsMode::OPPORTUNISTIC);

		EXPECT_CALL(mObserver, onValidationStateUpdate(kServer2, Validation::in_process, kNetId));
		EXPECT_EQ(mPdc.set(kNetId, kMark, {kServer2}, {}, {}), 0);
		ASSERT_TRUE(PollForCondition([&]() { return mObserver.runningThreads == 2; }));
		mObserver.removeFromServerStateMap(kServer1);
		expectPrivateDnsStatus(PrivateDnsMode::OPPORTUNISTIC);

		// No duplicate validation as long as not in OFF mode; otherwise, an unexpected
		// onValidationStateUpdate() will be caught.
		EXPECT_EQ(mPdc.set(kNetId, kMark, {kServer1}, {}, {}), 0);
		EXPECT_EQ(mPdc.set(kNetId, kMark, {kServer1, kServer2}, {}, {}), 0);
		EXPECT_EQ(mPdc.set(kNetId, kMark, {kServer2}, {}, {}), 0);
		expectPrivateDnsStatus(PrivateDnsMode::OPPORTUNISTIC);

		// The status keeps unchanged if pass invalid arguments.
		EXPECT_EQ(mPdc.set(kNetId, kMark, {"invalid_addr"}, {}, {}), -EINVAL);
		expectPrivateDnsStatus(PrivateDnsMode::OPPORTUNISTIC);
		}

		// The update for \|kServer1\| will be Validation::fail because \|kServer1\| is not an expected
		// server for the network.
		EXPECT_CALL(mObserver, onValidationStateUpdate(kServer1, Validation::fail, kNetId));
		EXPECT_CALL(mObserver, onValidationStateUpdate(kServer2, Validation::success, kNetId));
		backend.setDeferredResp(false);

		ASSERT_TRUE(PollForCondition([&]() { return mObserver.runningThreads == 0; }));
		expectPrivateDnsStatus(PrivateDnsMode::OPPORTUNISTIC);
		}

		TEST_F(PrivateDnsConfigurationTest, Validation_NetworkDestroyedOrOffMode) {
		for (const std::string_view config : {"OFF", "NETWORK_DESTROYED"}) {
		SCOPED_TRACE(config);
		backend.setDeferredResp(true);

		testing::InSequence seq;
		EXPECT_CALL(mObserver, onValidationStateUpdate(kServer1, Validation::in_process, kNetId));
		EXPECT_EQ(mPdc.set(kNetId, kMark, {kServer1}, {}, {}), 0);
		ASSERT_TRUE(PollForCondition([&]() { return mObserver.runningThreads == 1; }));
		expectPrivateDnsStatus(PrivateDnsMode::OPPORTUNISTIC);

		if (config == "OFF") {
		EXPECT_EQ(mPdc.set(kNetId, kMark, {}, {}, {}), 0);
		} else if (config == "NETWORK_DESTROYED") {
		mPdc.clear(kNetId);
		}

		EXPECT_CALL(mObserver, onValidationStateUpdate(kServer1, Validation::fail, kNetId));
		backend.setDeferredResp(false);

		ASSERT_TRUE(PollForCondition([&]() { return mObserver.runningThreads == 0; }));
		mObserver.removeFromServerStateMap(kServer1);
		expectPrivateDnsStatus(PrivateDnsMode::OFF);
		}
		}

		TEST_F(PrivateDnsConfigurationTest, NoValidation) {
		// If onValidationStateUpdate() is called, the test will fail with uninteresting mock
		// function calls in the end of the test.

		const auto expectStatus = [&]() {
		const PrivateDnsStatus status = mPdc.getStatus(kNetId);
		EXPECT_EQ(status.mode, PrivateDnsMode::OFF);
		EXPECT_THAT(status.serversMap, testing::IsEmpty());
		};

		EXPECT_EQ(mPdc.set(kNetId, kMark, {"invalid_addr"}, {}, {}), -EINVAL);
		expectStatus();

		EXPECT_EQ(mPdc.set(kNetId, kMark, {}, {}, {}), 0);
		expectStatus();
		}

		// TODO: add ValidationFail_Strict test.

		} // namespace android::net