mdns_cache_unittest.cc 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454
  1. // Copyright (c) 2013 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #include "net/dns/mdns_cache.h"
  5. #include <algorithm>
  6. #include <utility>
  7. #include "base/bind.h"
  8. #include "base/time/time.h"
  9. #include "net/dns/dns_response.h"
  10. #include "net/dns/dns_test_util.h"
  11. #include "net/dns/record_parsed.h"
  12. #include "net/dns/record_rdata.h"
  13. #include "testing/gmock/include/gmock/gmock.h"
  14. #include "testing/gtest/include/gtest/gtest.h"
  15. using ::testing::Return;
  16. using ::testing::StrictMock;
  17. namespace net {
  18. static const uint8_t kTestResponsesDifferentAnswers[] = {
  19. // Answer 1
  20. // ghs.l.google.com in DNS format.
  21. 3, 'g', 'h', 's', 1, 'l', 6, 'g', 'o', 'o', 'g', 'l', 'e', 3, 'c', 'o', 'm',
  22. 0x00, 0x00, 0x01, // TYPE is A.
  23. 0x00, 0x01, // CLASS is IN.
  24. 0, 0, 0, 53, // TTL (4 bytes) is 53 seconds.
  25. 0, 4, // RDLENGTH is 4 bytes.
  26. 74, 125, 95, 121, // RDATA is the IP: 74.125.95.121
  27. // Answer 2
  28. // Pointer to answer 1
  29. 0xc0, 0x00, 0x00, 0x01, // TYPE is A.
  30. 0x00, 0x01, // CLASS is IN.
  31. 0, 0, 0, 53, // TTL (4 bytes) is 53 seconds.
  32. 0, 4, // RDLENGTH is 4 bytes.
  33. 74, 125, 95, 122, // RDATA is the IP: 74.125.95.122
  34. };
  35. static const uint8_t kTestResponsesSameAnswers[] = {
  36. // Answer 1
  37. // ghs.l.google.com in DNS format.
  38. 3, 'g', 'h', 's', 1, 'l', 6, 'g', 'o', 'o', 'g', 'l', 'e', 3, 'c', 'o', 'm',
  39. 0x00, 0x00, 0x01, // TYPE is A.
  40. 0x00, 0x01, // CLASS is IN.
  41. 0, 0, 0, 53, // TTL (4 bytes) is 53 seconds.
  42. 0, 4, // RDLENGTH is 4 bytes.
  43. 74, 125, 95, 121, // RDATA is the IP: 74.125.95.121
  44. // Answer 2
  45. // Pointer to answer 1
  46. 0xc0, 0x00, 0x00, 0x01, // TYPE is A.
  47. 0x00, 0x01, // CLASS is IN.
  48. 0, 0, 0, 112, // TTL (4 bytes) is 112 seconds.
  49. 0, 4, // RDLENGTH is 4 bytes.
  50. 74, 125, 95, 121, // RDATA is the IP: 74.125.95.121
  51. };
  52. static const uint8_t kTestResponseTwoRecords[] = {
  53. // Answer 1
  54. // ghs.l.google.com in DNS format. (A)
  55. 3, 'g', 'h', 's', 1, 'l', 6, 'g', 'o', 'o', 'g', 'l', 'e', 3, 'c', 'o', 'm',
  56. 0x00, 0x00, 0x01, // TYPE is A.
  57. 0x00, 0x01, // CLASS is IN.
  58. 0, 0, 0, 53, // TTL (4 bytes) is 53 seconds.
  59. 0, 4, // RDLENGTH is 4 bytes.
  60. 74, 125, 95, 121, // RDATA is the IP: 74.125.95.121
  61. // Answer 2
  62. // ghs.l.google.com in DNS format. (AAAA)
  63. 3, 'g', 'h', 's', 1, 'l', 6, 'g', 'o', 'o', 'g', 'l', 'e', 3, 'c', 'o', 'm',
  64. 0x00, 0x00, 0x1c, // TYPE is AAA.
  65. 0x00, 0x01, // CLASS is IN.
  66. 0, 0, 0, 53, // TTL (4 bytes) is 53 seconds.
  67. 0, 16, // RDLENGTH is 16 bytes.
  68. 0x4a, 0x7d, 0x4a, 0x7d, 0x5f, 0x79, 0x5f, 0x79, 0x5f, 0x79, 0x5f, 0x79,
  69. 0x5f, 0x79, 0x5f, 0x79,
  70. };
  71. static const uint8_t kTestResponsesGoodbyePacket[] = {
  72. // Answer 1
  73. // ghs.l.google.com in DNS format. (Goodbye packet)
  74. 3, 'g', 'h', 's', 1, 'l', 6, 'g', 'o', 'o', 'g', 'l', 'e', 3, 'c', 'o', 'm',
  75. 0x00, 0x00, 0x01, // TYPE is A.
  76. 0x00, 0x01, // CLASS is IN.
  77. 0, 0, 0, 0, // TTL (4 bytes) is zero.
  78. 0, 4, // RDLENGTH is 4 bytes.
  79. 74, 125, 95, 121, // RDATA is the IP: 74.125.95.121
  80. // Answer 2
  81. // ghs.l.google.com in DNS format.
  82. 3, 'g', 'h', 's', 1, 'l', 6, 'g', 'o', 'o', 'g', 'l', 'e', 3, 'c', 'o', 'm',
  83. 0x00, 0x00, 0x01, // TYPE is A.
  84. 0x00, 0x01, // CLASS is IN.
  85. 0, 0, 0, 53, // TTL (4 bytes) is 53 seconds.
  86. 0, 4, // RDLENGTH is 4 bytes.
  87. 74, 125, 95, 121, // RDATA is the IP: 74.125.95.121
  88. };
  89. static const uint8_t kTestResponsesDifferentCapitalization[] = {
  90. // Answer 1
  91. // GHS.l.google.com in DNS format.
  92. 3, 'G', 'H', 'S', 1, 'l', 6, 'g', 'o', 'o', 'g', 'l', 'e', 3, 'c', 'o', 'm',
  93. 0x00, 0x00, 0x01, // TYPE is A.
  94. 0x00, 0x01, // CLASS is IN.
  95. 0, 0, 0, 53, // TTL (4 bytes) is 53 seconds.
  96. 0, 4, // RDLENGTH is 4 bytes.
  97. 74, 125, 95, 121, // RDATA is the IP: 74.125.95.121
  98. // Answer 2
  99. // ghs.l.GOOGLE.com in DNS format.
  100. 3, 'g', 'h', 's', 1, 'l', 6, 'G', 'O', 'O', 'G', 'L', 'E', 3, 'c', 'o', 'm',
  101. 0x00, 0x00, 0x01, // TYPE is A.
  102. 0x00, 0x01, // CLASS is IN.
  103. 0, 0, 0, 53, // TTL (4 bytes) is 53 seconds.
  104. 0, 4, // RDLENGTH is 4 bytes.
  105. 74, 125, 95, 122, // RDATA is the IP: 74.125.95.122
  106. };
  107. class RecordRemovalMock {
  108. public:
  109. MOCK_METHOD1(OnRecordRemoved, void(const RecordParsed*));
  110. };
  111. class MDnsCacheTest : public ::testing::Test {
  112. public:
  113. MDnsCacheTest()
  114. : default_time_(base::Time::FromDoubleT(1234.0)) {}
  115. ~MDnsCacheTest() override = default;
  116. protected:
  117. base::Time default_time_;
  118. StrictMock<RecordRemovalMock> record_removal_;
  119. MDnsCache cache_;
  120. };
  121. // Test a single insert, corresponding lookup, and unsuccessful lookup.
  122. TEST_F(MDnsCacheTest, InsertLookupSingle) {
  123. DnsRecordParser parser(kT1ResponseDatagram, sizeof(kT1ResponseDatagram),
  124. sizeof(dns_protocol::Header), kT1RecordCount);
  125. std::string dotted_qname;
  126. uint16_t qtype;
  127. parser.ReadQuestion(dotted_qname, qtype);
  128. std::unique_ptr<const RecordParsed> record1;
  129. std::unique_ptr<const RecordParsed> record2;
  130. std::vector<const RecordParsed*> results;
  131. record1 = RecordParsed::CreateFrom(&parser, default_time_);
  132. record2 = RecordParsed::CreateFrom(&parser, default_time_);
  133. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record1)));
  134. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record2)));
  135. cache_.FindDnsRecords(ARecordRdata::kType, "ghs.l.google.com", &results,
  136. default_time_);
  137. EXPECT_EQ(1u, results.size());
  138. EXPECT_EQ(default_time_, results.front()->time_created());
  139. EXPECT_EQ("ghs.l.google.com", results.front()->name());
  140. results.clear();
  141. cache_.FindDnsRecords(PtrRecordRdata::kType, "ghs.l.google.com", &results,
  142. default_time_);
  143. EXPECT_EQ(0u, results.size());
  144. }
  145. // Test that records expire when their ttl has passed.
  146. TEST_F(MDnsCacheTest, Expiration) {
  147. DnsRecordParser parser(kT1ResponseDatagram, sizeof(kT1ResponseDatagram),
  148. sizeof(dns_protocol::Header), kT1RecordCount);
  149. std::string dotted_qname;
  150. uint16_t qtype;
  151. parser.ReadQuestion(dotted_qname, qtype);
  152. std::unique_ptr<const RecordParsed> record1;
  153. std::unique_ptr<const RecordParsed> record2;
  154. std::vector<const RecordParsed*> results;
  155. const RecordParsed* record_to_be_deleted;
  156. record1 = RecordParsed::CreateFrom(&parser, default_time_);
  157. base::TimeDelta ttl1 = base::Seconds(record1->ttl());
  158. record2 = RecordParsed::CreateFrom(&parser, default_time_);
  159. base::TimeDelta ttl2 = base::Seconds(record2->ttl());
  160. record_to_be_deleted = record2.get();
  161. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record1)));
  162. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record2)));
  163. cache_.FindDnsRecords(ARecordRdata::kType, "ghs.l.google.com", &results,
  164. default_time_);
  165. EXPECT_EQ(1u, results.size());
  166. EXPECT_EQ(default_time_ + ttl2, cache_.next_expiration());
  167. cache_.FindDnsRecords(ARecordRdata::kType, "ghs.l.google.com", &results,
  168. default_time_ + ttl2);
  169. EXPECT_EQ(0u, results.size());
  170. EXPECT_CALL(record_removal_, OnRecordRemoved(record_to_be_deleted));
  171. cache_.CleanupRecords(
  172. default_time_ + ttl2,
  173. base::BindRepeating(&RecordRemovalMock::OnRecordRemoved,
  174. base::Unretained(&record_removal_)));
  175. // To make sure that we've indeed removed them from the map, check no funny
  176. // business happens once they're deleted for good.
  177. EXPECT_EQ(default_time_ + ttl1, cache_.next_expiration());
  178. cache_.FindDnsRecords(ARecordRdata::kType, "ghs.l.google.com", &results,
  179. default_time_ + ttl2);
  180. EXPECT_EQ(0u, results.size());
  181. }
  182. // Test that a new record replacing one with the same identity (name/rrtype for
  183. // unique records) causes the cache to output a "record changed" event.
  184. TEST_F(MDnsCacheTest, RecordChange) {
  185. DnsRecordParser parser(kTestResponsesDifferentAnswers,
  186. sizeof(kTestResponsesDifferentAnswers), 0,
  187. /*num_records=*/2);
  188. std::unique_ptr<const RecordParsed> record1;
  189. std::unique_ptr<const RecordParsed> record2;
  190. std::vector<const RecordParsed*> results;
  191. record1 = RecordParsed::CreateFrom(&parser, default_time_);
  192. record2 = RecordParsed::CreateFrom(&parser, default_time_);
  193. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record1)));
  194. EXPECT_EQ(MDnsCache::RecordChanged,
  195. cache_.UpdateDnsRecord(std::move(record2)));
  196. }
  197. // Test that a new record replacing an otherwise identical one already in the
  198. // cache causes the cache to output a "no change" event.
  199. TEST_F(MDnsCacheTest, RecordNoChange) {
  200. DnsRecordParser parser(kTestResponsesSameAnswers,
  201. sizeof(kTestResponsesSameAnswers), 0,
  202. /*num_records=*/2);
  203. std::unique_ptr<const RecordParsed> record1;
  204. std::unique_ptr<const RecordParsed> record2;
  205. std::vector<const RecordParsed*> results;
  206. record1 = RecordParsed::CreateFrom(&parser, default_time_);
  207. record2 = RecordParsed::CreateFrom(&parser, default_time_ + base::Seconds(1));
  208. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record1)));
  209. EXPECT_EQ(MDnsCache::NoChange, cache_.UpdateDnsRecord(std::move(record2)));
  210. }
  211. // Test that the next expiration time of the cache is updated properly on record
  212. // insertion.
  213. TEST_F(MDnsCacheTest, RecordPreemptExpirationTime) {
  214. DnsRecordParser parser(kTestResponsesSameAnswers,
  215. sizeof(kTestResponsesSameAnswers), 0,
  216. /*num_records=*/2);
  217. std::unique_ptr<const RecordParsed> record1;
  218. std::unique_ptr<const RecordParsed> record2;
  219. std::vector<const RecordParsed*> results;
  220. record1 = RecordParsed::CreateFrom(&parser, default_time_);
  221. record2 = RecordParsed::CreateFrom(&parser, default_time_);
  222. base::TimeDelta ttl1 = base::Seconds(record1->ttl());
  223. base::TimeDelta ttl2 = base::Seconds(record2->ttl());
  224. EXPECT_EQ(base::Time(), cache_.next_expiration());
  225. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record2)));
  226. EXPECT_EQ(default_time_ + ttl2, cache_.next_expiration());
  227. EXPECT_EQ(MDnsCache::NoChange, cache_.UpdateDnsRecord(std::move(record1)));
  228. EXPECT_EQ(default_time_ + ttl1, cache_.next_expiration());
  229. }
  230. // Test that the cache handles mDNS "goodbye" packets correctly, not adding the
  231. // records to the cache if they are not already there, and eventually removing
  232. // records from the cache if they are.
  233. TEST_F(MDnsCacheTest, GoodbyePacket) {
  234. DnsRecordParser parser(kTestResponsesGoodbyePacket,
  235. sizeof(kTestResponsesGoodbyePacket), 0,
  236. /*num_records=*/2);
  237. std::unique_ptr<const RecordParsed> record_goodbye;
  238. std::unique_ptr<const RecordParsed> record_hello;
  239. std::unique_ptr<const RecordParsed> record_goodbye2;
  240. std::vector<const RecordParsed*> results;
  241. record_goodbye = RecordParsed::CreateFrom(&parser, default_time_);
  242. record_hello = RecordParsed::CreateFrom(&parser, default_time_);
  243. parser = DnsRecordParser(kTestResponsesGoodbyePacket,
  244. sizeof(kTestResponsesGoodbyePacket), 0,
  245. /*num_records=*/2);
  246. record_goodbye2 = RecordParsed::CreateFrom(&parser, default_time_);
  247. base::TimeDelta ttl = base::Seconds(record_hello->ttl());
  248. EXPECT_EQ(base::Time(), cache_.next_expiration());
  249. EXPECT_EQ(MDnsCache::NoChange,
  250. cache_.UpdateDnsRecord(std::move(record_goodbye)));
  251. EXPECT_EQ(base::Time(), cache_.next_expiration());
  252. EXPECT_EQ(MDnsCache::RecordAdded,
  253. cache_.UpdateDnsRecord(std::move(record_hello)));
  254. EXPECT_EQ(default_time_ + ttl, cache_.next_expiration());
  255. EXPECT_EQ(MDnsCache::NoChange,
  256. cache_.UpdateDnsRecord(std::move(record_goodbye2)));
  257. EXPECT_EQ(default_time_ + base::Seconds(1), cache_.next_expiration());
  258. }
  259. TEST_F(MDnsCacheTest, AnyRRType) {
  260. DnsRecordParser parser(kTestResponseTwoRecords,
  261. sizeof(kTestResponseTwoRecords), 0, /*num_records=*/2);
  262. std::unique_ptr<const RecordParsed> record1;
  263. std::unique_ptr<const RecordParsed> record2;
  264. std::vector<const RecordParsed*> results;
  265. record1 = RecordParsed::CreateFrom(&parser, default_time_);
  266. record2 = RecordParsed::CreateFrom(&parser, default_time_);
  267. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record1)));
  268. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record2)));
  269. cache_.FindDnsRecords(0, "ghs.l.google.com", &results, default_time_);
  270. EXPECT_EQ(2u, results.size());
  271. EXPECT_EQ(default_time_, results.front()->time_created());
  272. EXPECT_EQ("ghs.l.google.com", results[0]->name());
  273. EXPECT_EQ("ghs.l.google.com", results[1]->name());
  274. EXPECT_EQ(dns_protocol::kTypeA,
  275. std::min(results[0]->type(), results[1]->type()));
  276. EXPECT_EQ(dns_protocol::kTypeAAAA,
  277. std::max(results[0]->type(), results[1]->type()));
  278. }
  279. TEST_F(MDnsCacheTest, RemoveRecord) {
  280. DnsRecordParser parser(kT1ResponseDatagram, sizeof(kT1ResponseDatagram),
  281. sizeof(dns_protocol::Header), kT1RecordCount);
  282. std::string dotted_qname;
  283. uint16_t qtype;
  284. parser.ReadQuestion(dotted_qname, qtype);
  285. std::unique_ptr<const RecordParsed> record1;
  286. std::vector<const RecordParsed*> results;
  287. record1 = RecordParsed::CreateFrom(&parser, default_time_);
  288. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record1)));
  289. cache_.FindDnsRecords(dns_protocol::kTypeCNAME, "codereview.chromium.org",
  290. &results, default_time_);
  291. EXPECT_EQ(1u, results.size());
  292. std::unique_ptr<const RecordParsed> record_out =
  293. cache_.RemoveRecord(results.front());
  294. EXPECT_EQ(record_out.get(), results.front());
  295. cache_.FindDnsRecords(dns_protocol::kTypeCNAME, "codereview.chromium.org",
  296. &results, default_time_);
  297. EXPECT_EQ(0u, results.size());
  298. }
  299. TEST_F(MDnsCacheTest, IsCacheOverfilled) {
  300. DnsRecordParser parser(kTestResponseTwoRecords,
  301. sizeof(kTestResponseTwoRecords), 0, /*num_records=*/2);
  302. std::unique_ptr<const RecordParsed> record1 =
  303. RecordParsed::CreateFrom(&parser, default_time_);
  304. const RecordParsed* record1_ptr = record1.get();
  305. std::unique_ptr<const RecordParsed> record2 =
  306. RecordParsed::CreateFrom(&parser, default_time_);
  307. cache_.set_entry_limit_for_testing(1);
  308. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record1)));
  309. EXPECT_FALSE(cache_.IsCacheOverfilled());
  310. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record2)));
  311. EXPECT_TRUE(cache_.IsCacheOverfilled());
  312. record1 = cache_.RemoveRecord(record1_ptr);
  313. EXPECT_TRUE(record1);
  314. EXPECT_FALSE(cache_.IsCacheOverfilled());
  315. }
  316. TEST_F(MDnsCacheTest, ClearOnOverfilledCleanup) {
  317. DnsRecordParser parser(kTestResponseTwoRecords,
  318. sizeof(kTestResponseTwoRecords), 0, /*num_records=*/2);
  319. std::unique_ptr<const RecordParsed> record1 =
  320. RecordParsed::CreateFrom(&parser, default_time_);
  321. const RecordParsed* record1_ptr = record1.get();
  322. std::unique_ptr<const RecordParsed> record2 =
  323. RecordParsed::CreateFrom(&parser, default_time_);
  324. const RecordParsed* record2_ptr = record2.get();
  325. cache_.set_entry_limit_for_testing(1);
  326. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record1)));
  327. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record2)));
  328. ASSERT_TRUE(cache_.IsCacheOverfilled());
  329. // Expect everything to be removed on CleanupRecords() with overfilled cache.
  330. EXPECT_CALL(record_removal_, OnRecordRemoved(record1_ptr));
  331. EXPECT_CALL(record_removal_, OnRecordRemoved(record2_ptr));
  332. cache_.CleanupRecords(
  333. default_time_, base::BindRepeating(&RecordRemovalMock::OnRecordRemoved,
  334. base::Unretained(&record_removal_)));
  335. EXPECT_FALSE(cache_.IsCacheOverfilled());
  336. std::vector<const RecordParsed*> results;
  337. cache_.FindDnsRecords(dns_protocol::kTypeA, "ghs.l.google.com", &results,
  338. default_time_);
  339. EXPECT_TRUE(results.empty());
  340. cache_.FindDnsRecords(dns_protocol::kTypeAAAA, "ghs.l.google.com", &results,
  341. default_time_);
  342. EXPECT_TRUE(results.empty());
  343. }
  344. TEST_F(MDnsCacheTest, CaseInsensitive) {
  345. DnsRecordParser parser(kTestResponsesDifferentCapitalization,
  346. sizeof(kTestResponsesDifferentCapitalization), 0,
  347. /*num_records=*/2);
  348. std::unique_ptr<const RecordParsed> record1;
  349. std::unique_ptr<const RecordParsed> record2;
  350. std::vector<const RecordParsed*> results;
  351. record1 = RecordParsed::CreateFrom(&parser, default_time_);
  352. record2 = RecordParsed::CreateFrom(&parser, default_time_);
  353. EXPECT_EQ(MDnsCache::RecordAdded, cache_.UpdateDnsRecord(std::move(record1)));
  354. EXPECT_EQ(MDnsCache::RecordChanged,
  355. cache_.UpdateDnsRecord(std::move(record2)));
  356. cache_.FindDnsRecords(0, "ghs.l.google.com", &results, default_time_);
  357. EXPECT_EQ(1u, results.size());
  358. EXPECT_EQ("ghs.l.GOOGLE.com", results[0]->name());
  359. std::vector<const RecordParsed*> results2;
  360. cache_.FindDnsRecords(0, "GHS.L.google.COM", &results2, default_time_);
  361. EXPECT_EQ(results, results2);
  362. }
  363. } // namespace net