https_record_rdata.h 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  1. // Copyright 2020 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. #ifndef NET_DNS_HTTPS_RECORD_RDATA_H_
  5. #define NET_DNS_HTTPS_RECORD_RDATA_H_
  6. #include <stdint.h>
  7. #include <map>
  8. #include <memory>
  9. #include <set>
  10. #include <string>
  11. #include <vector>
  12. #include "base/strings/string_piece.h"
  13. #include "net/base/ip_address.h"
  14. #include "net/base/net_export.h"
  15. #include "net/dns/public/dns_protocol.h"
  16. #include "net/dns/record_rdata.h"
  17. #include "third_party/abseil-cpp/absl/types/optional.h"
  18. namespace net {
  19. using HttpsRecordPriority = uint16_t;
  20. class AliasFormHttpsRecordRdata;
  21. class ServiceFormHttpsRecordRdata;
  22. class NET_EXPORT_PRIVATE HttpsRecordRdata : public RecordRdata {
  23. public:
  24. static const uint16_t kType = dns_protocol::kTypeHttps;
  25. // Returns `nullptr` on malformed input.
  26. static std::unique_ptr<HttpsRecordRdata> Parse(base::StringPiece data);
  27. HttpsRecordRdata(const HttpsRecordRdata& rdata) = delete;
  28. HttpsRecordRdata& operator=(const HttpsRecordRdata& rdata) = delete;
  29. ~HttpsRecordRdata() override;
  30. bool IsEqual(const RecordRdata* other) const override;
  31. virtual bool IsEqual(const HttpsRecordRdata* other) const = 0;
  32. uint16_t Type() const override;
  33. virtual bool IsAlias() const = 0;
  34. AliasFormHttpsRecordRdata* AsAliasForm();
  35. const AliasFormHttpsRecordRdata* AsAliasForm() const;
  36. ServiceFormHttpsRecordRdata* AsServiceForm();
  37. const ServiceFormHttpsRecordRdata* AsServiceForm() const;
  38. protected:
  39. HttpsRecordRdata() = default;
  40. };
  41. class NET_EXPORT_PRIVATE AliasFormHttpsRecordRdata : public HttpsRecordRdata {
  42. public:
  43. explicit AliasFormHttpsRecordRdata(std::string alias_name);
  44. static std::unique_ptr<AliasFormHttpsRecordRdata> Parse(
  45. base::StringPiece data);
  46. bool IsEqual(const HttpsRecordRdata* other) const override;
  47. bool IsAlias() const override;
  48. base::StringPiece alias_name() const { return alias_name_; }
  49. private:
  50. AliasFormHttpsRecordRdata() = default;
  51. const std::string alias_name_;
  52. };
  53. class NET_EXPORT_PRIVATE ServiceFormHttpsRecordRdata : public HttpsRecordRdata {
  54. public:
  55. static constexpr uint16_t kSupportedKeys[] = {
  56. dns_protocol::kHttpsServiceParamKeyMandatory,
  57. dns_protocol::kHttpsServiceParamKeyAlpn,
  58. dns_protocol::kHttpsServiceParamKeyNoDefaultAlpn,
  59. dns_protocol::kHttpsServiceParamKeyPort,
  60. dns_protocol::kHttpsServiceParamKeyIpv4Hint,
  61. dns_protocol::kHttpsServiceParamKeyEchConfig,
  62. dns_protocol::kHttpsServiceParamKeyIpv6Hint};
  63. ServiceFormHttpsRecordRdata(uint16_t priority,
  64. std::string service_name,
  65. std::set<uint16_t> mandatory_keys,
  66. std::vector<std::string> alpn_ids,
  67. bool default_alpn,
  68. absl::optional<uint16_t> port,
  69. std::vector<IPAddress> ipv4_hint,
  70. std::string ech_config,
  71. std::vector<IPAddress> ipv6_hint,
  72. std::map<uint16_t, std::string> unparsed_params);
  73. static std::unique_ptr<ServiceFormHttpsRecordRdata> Parse(
  74. base::StringPiece data);
  75. ~ServiceFormHttpsRecordRdata() override;
  76. bool IsEqual(const HttpsRecordRdata* other) const override;
  77. bool IsAlias() const override;
  78. HttpsRecordPriority priority() const { return priority_; }
  79. base::StringPiece service_name() const { return service_name_; }
  80. const std::set<uint16_t>& mandatory_keys() const { return mandatory_keys_; }
  81. const std::vector<std::string>& alpn_ids() const { return alpn_ids_; }
  82. bool default_alpn() const { return default_alpn_; }
  83. absl::optional<uint16_t> port() const { return port_; }
  84. const std::vector<IPAddress>& ipv4_hint() const { return ipv4_hint_; }
  85. base::StringPiece ech_config() const { return ech_config_; }
  86. const std::vector<IPAddress>& ipv6_hint() const { return ipv6_hint_; }
  87. const std::map<uint16_t, std::string>& unparsed_params() const {
  88. return unparsed_params_;
  89. }
  90. // Returns whether or not this rdata parser is considered "compatible" with
  91. // the parsed rdata. That is that all keys listed by mandatory_keys() (and all
  92. // keys considered default mandatory for HTTPS records) are parsable by this
  93. // parser.
  94. bool IsCompatible() const;
  95. private:
  96. static bool IsSupportedKey(uint16_t key);
  97. const HttpsRecordPriority priority_;
  98. const std::string service_name_;
  99. // Supported service parameters.
  100. const std::set<uint16_t> mandatory_keys_;
  101. const std::vector<std::string> alpn_ids_;
  102. const bool default_alpn_;
  103. const absl::optional<uint16_t> port_;
  104. const std::vector<IPAddress> ipv4_hint_;
  105. const std::string ech_config_;
  106. const std::vector<IPAddress> ipv6_hint_;
  107. const std::map<uint16_t, std::string> unparsed_params_;
  108. };
  109. } // namespace net
  110. #endif // NET_DNS_HTTPS_RECORD_RDATA_H_