svcb_rr_patch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe01826cf1fe78d4b2d6db7d53bb474234121dceba9f7cd8dc26b25ca2d3e00a
+  data.tar.gz: 7acaffe658b58b44b2d22c66fafe904acacf15d1b68a5a1288db11dfacad886c
+SHA512:
+  metadata.gz: eea644f426005af15be66fc9dbdcb9d60530e6ce77014a8345ebb52c561a71b2d352a2e29f373311724074a53c72d399007406348b8f421b1e9658a31c1b0c93
+  data.tar.gz: 8b60ace84e7fe2ab8c67ee7aea3cf412d1926740de83a60f5fd5820f06bad4e7202ea64349d74aa623c3475b0ccc74a4dd0de65eefe7266b851a24623923be06

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7.x', '3.0.x']
+    steps:
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+      - uses: actions/checkout@v1
+      - name: Install dependencies
+        run: |
+          gem --version
+          gem install bundler
+          bundle --version
+          bundle install
+      - name: Run test
+        run: |
+          bundle exec rake

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+Gemfile.lock
+.config
+.rvmrc
+/.bundle/
+/vendor/
+/lib/bundler/man/
+/pkg/
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+/coverage/
+/spec/reports/
+/tmp/
+*.rdb

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/MethodLength:
+  Max: 30
+
+Naming/MethodParameterName:
+  MinNameLength: 1
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/*.rb'

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'rake'
+
+group :test do
+  gem 'byebug'
+  gem 'rspec', '3.9.0'
+  gem 'rubocop', '0.78.0'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Tomoya Kuwayama
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# svcb_rr_patch
+
+[![Gem Version](https://badge.fury.io/rb/svcb_rr_patch.svg)](https://badge.fury.io/rb/svcb_rr_patch)
+[![CI](https://github.com/thekuwayama/svcb_rr_patch/workflows/CI/badge.svg)](https://github.com/thekuwayama/svcb_rr_patch/actions?workflow=CI)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a1e5224a552014f2d4d5/maintainability)](https://codeclimate.com/github/thekuwayama/svcb_rr_patch/maintainability)
+
+`svcb_rr_patch` is the patch that adds SVCB Resource Record and HTTPS Resource Record.
+
+- https://tools.ietf.org/html/draft-ietf-dnsop-svcb-https-06
+
+`svcb_rr_patch` supports "ech" SvcParamKey that ECHConfig.version is 0xfe0a.
+
+- https://datatracker.ietf.org/doc/html/draft-ietf-tls-esni-10#section-4
+
+
+## Installation
+
+he gem is available at [rubygems.org](https://rubygems.org/gems/svcb_rr_patch). You can install it the following.
+
+```bash
+$ gem install svcb_rr_patch
+```
+
+
+## Usage
+
+You can resolve HTTPS resources.
+
+```bash
+$ irb
+irb(main):001:0> require 'svcb_rr_patch'
+=> true
+irb(main):002:1* Resolv::DNS.new.getresources(
+irb(main):003:1*   "blog.cloudflare.com",
+irb(main):004:1*   Resolv::DNS::Resource::IN::HTTPS
+irb(main):005:0> ) { |rr| pp rr }
+=> [#<Resolv::DNS::Resource::IN::HTTPS:0x0000000000000001 @svc_priority=1, @svc_domain_name="", @svc_field_value={"alpn"=>#<SvcbRrPatch::SvcParams::Alpn:0x0000000000000002 @protocols=["h3-29", "h3-28", "h3-27", "h2"]>, "ipv4hint"=>#<SvcbRrPatch::SvcParams::Ipv4hint:0x0000000000000003 @addresses=[#<Resolv::IPv4 104.18.26.46>, #<Resolv::IPv4 104.18.27.46>]>, "ipv6hint"=>#<SvcbRrPatch::SvcParams::Ipv6hint:0x0000000000000004 @addresses=[#<Resolv::IPv6 2606:4700::6812:1a2e>, #<Resolv::IPv6 2606:4700::6812:1b2e>]>}, @ttl=300>]
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/lib/svcb_rr_patch.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'resolv'
+
+require 'svcb_rr_patch/version'
+require 'svcb_rr_patch/svc_params'
+require 'svcb_rr_patch/svcb'
+require 'svcb_rr_patch/https'

data/lib/svcb_rr_patch/https.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+##
+# The HTTPS DNS Resource Record
+
+class Resolv::DNS::Resource::IN::HTTPS < Resolv::DNS::Resource::IN::SVCB
+  TypeValue = 65 # rubocop:disable Naming/ConstantName
+  ClassValue = IN::ClassValue
+  ClassHash[[TypeValue, ClassValue]] = self
+
+  def initialize(svc_priority, target_name, svc_params)
+    # https://tools.ietf.org/html/draft-ietf-dnsop-svcb-https-06
+    super(svc_priority, target_name, svc_params)
+  end
+
+  class << self
+    # :nodoc:
+    def decode_rdata(msg)
+      svc_priority = msg.get_bytes(2).unpack1('n')
+      target_name = msg.get_string
+      return new(svc_priority, target_name, {}) if svc_priority.zero?
+
+      # the SvcParams, consuming the remainder of the record
+      svc_params = ::SvcbRrPatch::SvcParams.decode(msg.get_bytes)
+      new(svc_priority, target_name, svc_params)
+    end
+  end
+end

data/lib/svcb_rr_patch/svc_params.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module SvcbRrPatch::SvcParams
+  PARAMETER_REGISTRY = lambda {
+    registry = %w[
+      mandatory
+      alpn
+      no-default-alpn
+      port
+      ipv4hint
+      ech
+      ipv6hint
+    ]
+    # rubocop:disable Security/Eval
+    (65280..65535).each do |nnnn|
+      eval "registry[nnnn] = \"key#{nnnn}\"", binding, __FILE__, __LINE__
+    end
+    # rubocop:enable Security/Eval
+    registry
+  }.call.freeze
+end
+
+Dir[File.dirname(__FILE__) + '/svc_params/*.rb'].sort.each { |f| require f }
+
+module SvcbRrPatch::SvcParams
+  # @return [String]
+  def self.encode(svc_params)
+    h = Hash[(0..PARAMETER_REGISTRY.size - 1).zip(PARAMETER_REGISTRY)].invert
+
+    svc_params
+      .map { |k, v| [h[k], v] }
+      .sort { |lh, rh| lh.first <=> rh.first }
+      .map do |k, v|
+        [k].pack('n') + v.encode.then { |s| [s.length].pack('n') + s }
+      end
+      .join
+  end
+
+  # @param octet [String]
+  #
+  # @return [Hash] Integer => SvcbRrPatch::$Object
+  # rubocop:disable Metrics/AbcSize
+  def self.decode(octet)
+    svc_params = {}
+    i = 0
+    h = Hash[(0..PARAMETER_REGISTRY.size - 1).zip(PARAMETER_REGISTRY)].invert
+    while i < octet.length
+      raise ::Resolv::DNS::DecodeError if i + 4 > octet.length
+
+      k = octet.slice(i, 2).unpack1('n')
+      # SvcParamKeys SHALL appear in increasing numeric order.
+      raise ::Resolv::DNS::DecodeError \
+        unless svc_params.keys.find { |already| h[already] >= k }.nil?
+
+      i += 2
+      vlen = octet.slice(i, 2).unpack1('n')
+      i += 2
+      raise ::Resolv::DNS::DecodeError if i + vlen > octet.length
+
+      v = octet.slice(i, vlen)
+      i += vlen
+      # Values are in a format specific to the SvcParamKey.
+      svc_param_key = PARAMETER_REGISTRY[k]
+      svc_param_values = decode_svc_params(svc_param_key, v)
+      svc_params.store(svc_param_key, svc_param_values)
+    end
+    raise ::Resolv::DNS::DecodeError if i != octet.length
+
+    svc_params
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  # :nodoc:
+  # rubocop:disable Metrics/CyclomaticComplexity
+  def self.decode_svc_params(key, octet)
+    case key
+    when 'no name'
+      NoName.decode(octet)
+    when 'alpn'
+      Alpn.decode(octet)
+    when 'no-default-alpn'
+      NoDefaultAlpn.decode(octet)
+    when 'port'
+      Port.decode(octet)
+    when 'ipv4hint'
+      Ipv4hint.decode(octet)
+    when 'ech'
+      Ech.decode(octet)
+    when 'ipv6hint'
+      Ipv6hint.decode(octet)
+    else
+      octet
+    end
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity
+end

data/lib/svcb_rr_patch/svc_params/alpn.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::Alpn
+  attr_reader :protocols
+
+  # @param protocols [Array of String]
+  def initialize(protocols)
+    @protocols = protocols
+  end
+
+  # @return [String]
+  def encode
+    @protocols.map { |p| [p.length].pack('C') + p }.join
+  end
+
+  # :nodoc:
+  def self.decode_protocols(octet)
+    protocols = []
+    i = 0
+    while i < octet.length
+      raise ::Resolv::DNS::DecodeError if i + 1 > octet.length
+
+      id_len = octet.slice(i, 1).unpack1('C1')
+      i += 1
+      protocols << octet.slice(i, id_len)
+      i += id_len
+    end
+    raise ::Resolv::DNS::DecodeError if i != octet.length
+
+    protocols
+  end
+
+  # :nodec:
+  def self.decode(octet)
+    protocols = decode_protocols(octet)
+    new(protocols)
+  end
+end

data/lib/svcb_rr_patch/svc_params/ech.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::Ech
+  attr_reader :echconfigs
+
+  # @param echconfiglist [Array of ECHConfig]
+  def initialize(echconfiglist)
+    @echconfiglist = echconfiglist
+  end
+
+  # @return [String]
+  def encode
+    @echconfiglist.map(&:encode).join.then { |s| [s.length].pack('n') + s }
+  end
+
+  # :nodoc:
+  def self.decode(octet)
+    raise ::Resolv::DNS::DecodeError \
+      unless octet.length == octet.slice(0, 2).unpack1('n') + 2
+
+    echconfiglist = ECHConfig.decode_vectors(octet.slice(2..))
+    new(echconfiglist)
+  end
+end
+
+require_relative 'ech/echconfig_contents'
+
+class SvcbRrPatch::SvcParams::Ech::ECHConfig
+  attr_reader :version
+  attr_reader :echconfigcontents
+
+  ECHConfigContents = ::SvcbRrPatch::SvcParams::Ech::ECHConfigContents
+
+  # @param version [String]
+  # @param echconfig_contents [ECHConfigContents]
+  def initialize(version, echconfig_contents)
+    @version = version
+    @echconfig_contents = echconfig_contents
+  end
+
+  # @return [String]
+  def encode
+    @version + @echconfig_contents.encode.then { |s| [s.length].pack('n') + s }
+  end
+
+  # @return [Array of ECHConfig]
+  def self.decode_vectors(octet)
+    i = 0
+    echconfigs = []
+    while i < octet.length
+      raise ::Resolv::DNS::DecodeError if i + 4 > octet.length
+
+      version = octet.slice(i, 2)
+      length = octet.slice(i + 2, 2).unpack1('n')
+      i += 4
+      raise ::Resolv::DNS::DecodeError if i + length > octet.length
+
+      echconfig_contents = ECHConfigContents.decode(octet.slice(i, length))
+      i += length
+      echconfigs << new(version, echconfig_contents)
+    end
+    raise ::Resolv::DNS::DecodeError if i != octet.length
+
+    echconfigs
+  end
+end

data/lib/svcb_rr_patch/svc_params/ech/echconfig_contents.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::Ech::ECHConfigContents
+  # define class
+end
+
+Dir[File.dirname(__FILE__) + '/echconfig_contents/*.rb']
+  .sort.each { |f| require f }
+
+class SvcbRrPatch::SvcParams::Ech::ECHConfigContents
+  attr_reader :key_config
+  attr_reader :maximum_name_length
+  attr_reader :public_name
+  attr_reader :extensions
+
+  # @param key_config [HpkeKeyConfig]
+  # @param maximum_name_length [Integer]
+  # @param public_name [String]
+  # @param extensions [Array of Extension]
+  def initialize(key_config,
+                 maximum_name_length,
+                 public_name,
+                 extensions)
+    @key_config = key_config
+    @maximum_name_length = maximum_name_length
+    @public_name = public_name
+    @extensions = extensions
+  end
+
+  # @return [String]
+  def encode
+    @key_config.encode \
+    + [@maximum_name_length].pack('n') \
+    + @public_name.then { |s| [s.length].pack('n') + s } \
+    + @extensions.map(&:encode).join.then { |s| [s.length].pack('n') + s }
+  end
+
+  # :nodoc
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/CyclomaticComplexity
+  def self.decode(octet)
+    key_config, octet = HpkeKeyConfig.decode(octet)
+    raise ::Resolv::DNS::DecodeError if octet.length < 2
+
+    maximum_name_length = octet.slice(0, 2).unpack1('n')
+    i = 2
+    raise ::Resolv::DNS::DecodeError if i + 2 > octet.length
+
+    pn_len = octet.slice(i, 2).unpack1('n')
+    i += 2
+    raise ::Resolv::DNS::DecodeError if i + pn_len > octet.length
+
+    public_name = octet.slice(i, pn_len)
+    i += pn_len
+    raise ::Resolv::DNS::DecodeError if i + 2 > octet.length
+
+    ex_len = octet.slice(i, 2).unpack1('n')
+    i += 2
+    raise ::Resolv::DNS::DecodeError if i + ex_len > octet.length
+
+    extensions = Extension.decode_vectors(octet.slice(i, ex_len))
+    i += ex_len
+    raise ::Resolv::DNS::DecodeError if i != octet.length
+
+    new(
+      key_config,
+      maximum_name_length,
+      public_name,
+      extensions
+    )
+  end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/CyclomaticComplexity
+end

data/lib/svcb_rr_patch/svc_params/ech/echconfig_contents/extension.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::Ech::ECHConfigContents::Extension
+  attr_reader :octet
+
+  # @param octet [String]
+  def initialize(octet)
+    @octet = octet # TODO
+  end
+
+  # @return [String]
+  def encode
+    @octet # TODO
+  end
+
+  # @return [Array of Extension]
+  def self.decode_vectors(octet)
+    i = 0
+    extensions = []
+    while i < octet.length
+      raise ::Resolv::DNS::DecodeError if i + 4 > octet.length
+
+      ex_len = octet.slice(i + 2, 2)
+      i += 4
+      raise ::Resolv::DNS::DecodeError if i + ex_len > octet.length
+
+      extensions << new(octet.slice(i, ex_len)) # TODO
+      i += ex_len
+    end
+    raise ::Resolv::DNS::DecodeError if i != octet.length
+
+    extensions
+  end
+end

data/lib/svcb_rr_patch/svc_params/ech/echconfig_contents/hpke_key_config.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::Ech::ECHConfigContents::HpkeKeyConfig
+  # define class
+end
+
+Dir[File.dirname(__FILE__) + '/hpke_key_config/*.rb']
+  .sort.each { |f| require f }
+
+class SvcbRrPatch::SvcParams::Ech::ECHConfigContents::HpkeKeyConfig
+  attr_reader :config_id
+  attr_reader :kem_id
+  attr_reader :public_key
+  attr_reader :cipher_suites
+
+  # @param config_id [Integer]
+  # @param kem_id [HpkeKemId]
+  # @param public_key [HpkePublicKey]
+  # @param cipher_suites [Array of HpkeSymmetricCipherSuite]
+  def initialize(config_id,
+                 kem_id,
+                 public_key,
+                 cipher_suites)
+    @config_id = config_id
+    @kem_id = kem_id
+    @public_key = public_key
+    @cipher_suites = cipher_suites
+  end
+
+  # @return [String]
+  def encode
+    [@config_id].pack('C') \
+    + @kem_id.encode \
+    + @public_key.encode \
+    + @cipher_suites.map(&:encode).join.then { |s| [s.length].pack('n') + s }
+  end
+
+  # :nodoc
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/CyclomaticComplexity
+  def self.decode(octet)
+    raise ::Resolv::DNS::DecodeError if octet.empty?
+
+    config_id = octet.slice(0, 1).unpack1('C')
+    i = 1
+    raise ::Resolv::DNS::DecodeError if i + 2 > octet.length
+
+    kem_id = HpkeKemId.decode(octet.slice(i, 2))
+    i += 2
+    raise ::Resolv::DNS::DecodeError if i + 2 > octet.length
+
+    pk_len = octet.slice(i, 2).unpack1('n')
+    i += 2
+    raise ::Resolv::DNS::DecodeError if i + pk_len > octet.length
+
+    public_key = HpkePublicKey.decode(octet.slice(i, pk_len))
+    i += pk_len
+    raise ::Resolv::DNS::DecodeError if i + 2 > octet.length
+
+    cs_len = octet.slice(i, 2).unpack1('n')
+    i += 2
+    raise ::Resolv::DNS::DecodeError if i + 2 > octet.length
+
+    cs_bin = octet.slice(i, cs_len)
+    i += cs_len
+    cipher_suites = HpkeSymmetricCipherSuite.decode_vectors(cs_bin)
+    hpke_key_config = new(
+      config_id,
+      kem_id,
+      public_key,
+      cipher_suites
+    )
+    [hpke_key_config, octet[i..]]
+  end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/CyclomaticComplexity
+end

data/lib/svcb_rr_patch/svc_params/ech/echconfig_contents/hpke_key_config/hpke_kem_id.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::Ech::ECHConfigContents::HpkeKeyConfig::HpkeKemId
+  attr_reader :uint16
+
+  # @param uint16 [Integer]
+  def initialize(uint16)
+    @uint16 = uint16
+  end
+
+  # @return [String]
+  def encode
+    [@uint16].pack('n')
+  end
+
+  # :nodoc
+  def self.decode(octet)
+    raise ::Resolv::DNS::DecodeError if octet.length != 2
+
+    new(octet.unpack1('n'))
+  end
+end

data/lib/svcb_rr_patch/svc_params/ech/echconfig_contents/hpke_key_config/hpke_public_key.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::Ech::ECHConfigContents::HpkeKeyConfig::HpkePublicKey # rubocop:disable Layout/LineLength
+  attr_reader :opaque
+
+  # @param opaque [String]
+  def initialize(opaque)
+    @opaque = opaque
+  end
+
+  # @return [String]
+  def encode
+    @opaque.then { |s| [s.length].pack('n') + s }
+  end
+
+  # :nodoc
+  def self.decode(octet)
+    new(octet)
+  end
+end

data/lib/svcb_rr_patch/svc_params/ech/echconfig_contents/hpke_key_config/hpke_symmetric_cipher_suite.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::Ech::ECHConfigContents::HpkeKeyConfig::HpkeSymmetricCipherSuite # rubocop:disable Layout/LineLength
+  # define class
+end
+
+Dir[File.dirname(__FILE__) + '/hpke_symmetric_cipher_suite/*.rb']
+  .sort.each { |f| require f }
+
+class SvcbRrPatch::SvcParams::Ech::ECHConfigContents::HpkeKeyConfig::HpkeSymmetricCipherSuite # rubocop:disable Layout/LineLength
+  attr_reader :kdf_id
+  attr_reader :aead_id
+
+  # @param kdf_id [HpkeKdfId]
+  # @param aead_id [HpkeAeadId]
+  def initialize(kdf_id, aead_id)
+    @kdf_id = kdf_id
+    @aead_id = aead_id
+  end
+
+  # @return [String]
+  def encode
+    @kdf_id.encode + @aead_id.encode
+  end
+
+  # @return [Array of HpkeSymmetricCipherSuite]
+  def self.decode_vectors(octet)
+    i = 0
+    cipher_suites = []
+    while i < octet.length
+      raise ::Resolv::DNS::DecodeError if i + 4 > octet.length
+
+      kdf_id = HpkeKdfId.decode(octet.slice(i, 2))
+      aead_id = HpkeAeadId.decode(octet.slice(i + 2, 2))
+      i += 4
+      cipher_suites << new(kdf_id, aead_id)
+    end
+
+    cipher_suites
+  end
+end

data/lib/svcb_rr_patch/svc_params/ech/echconfig_contents/hpke_key_config/hpke_symmetric_cipher_suite/hpke_aead_id.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::Ech::ECHConfigContents::HpkeKeyConfig::HpkeSymmetricCipherSuite::HpkeAeadId # rubocop:disable Layout/LineLength
+  attr_reader :uint16
+
+  # @param uint16 [Integer]
+  def initialize(uint16)
+    @uint16 = uint16
+  end
+
+  # @return [String]
+  def encode
+    [@uint16].pack('n')
+  end
+
+  # :nodoc
+  def self.decode(octet)
+    raise ::Resolv::DNS::DecodeError if octet.length != 2
+
+    new(octet.unpack1('n'))
+  end
+end

data/lib/svcb_rr_patch/svc_params/ech/echconfig_contents/hpke_key_config/hpke_symmetric_cipher_suite/hpke_kdf_id.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::Ech::ECHConfigContents::HpkeKeyConfig::HpkeSymmetricCipherSuite::HpkeKdfId # rubocop:disable Layout/LineLength
+  attr_reader :uint16
+
+  # @param uint16 [Integer]
+  def initialize(uint16)
+    @uint16 = uint16
+  end
+
+  # @return [String]
+  def encode
+    [@uint16].pack('n')
+  end
+
+  # :nodoc
+  def self.decode(octet)
+    raise ::Resolv::DNS::DecodeError if octet.length != 2
+
+    new(octet.unpack1('n'))
+  end
+end

data/lib/svcb_rr_patch/svc_params/ipv4hint.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::Ipv4hint
+  attr_reader :addresses
+
+  # @param addresses [Array of Resolv::IPv4]
+  def initialize(addresses)
+    @addresses = addresses
+  end
+
+  # @return [String]
+  def encode
+    @addresses.map(&:address).join
+  end
+
+  # :nodoc:
+  def self.decode(octet)
+    addresses = octet.scan(/.{1,4}/).map { |s| Resolv::IPv4.new(s) }
+    new(addresses)
+  end
+end

data/lib/svcb_rr_patch/svc_params/ipv6hint.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::Ipv6hint
+  attr_reader :addresses
+
+  # @param addresses [Array of Resolv::IPv6]
+  def initialize(addresses)
+    @addresses = addresses
+  end
+
+  # @return [String]
+  def encode
+    @addresses.map(&:address).join
+  end
+
+  # :nodoc:
+  def self.decode(octet)
+    addresses = octet.scan(/.{1,16}/).map { |s| Resolv::IPv6.new(s) }
+    new(addresses)
+  end
+end

data/lib/svcb_rr_patch/svc_params/mandatory.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::Mandatory
+  attr_reader :keys
+
+  # @param keys [Array of Integer]]
+  def initialize(keys)
+    @keys = keys
+  end
+
+  # @return [String]
+  def encode
+    @keys.sort.map { |k| [k].pack('n') }.join
+  end
+
+  # :nodoc:
+  def self.decode(octet)
+    keys = octet.scan(/.{1,2}/).map { |s| s.unpack1('n') }
+    new(keys)
+  end
+end

data/lib/svcb_rr_patch/svc_params/no_default_alpn.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::NoDefaultAlpn <
+      SvcbRrPatch::SvcParams::Alpn
+  # :nodec:
+  def self.decode(octet)
+    protocols = decode_protocols(octet)
+    new(protocols)
+  end
+end

data/lib/svcb_rr_patch/svc_params/port.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class SvcbRrPatch::SvcParams::Port
+  attr_reader :port
+
+  # @param port [Integer]
+  def initialize(port)
+    @port = port
+  end
+
+  # @return [String]
+  def encode
+    [@port].pack('n')
+  end
+
+  # :nodoc:
+  def self.decode(octet)
+    port = octet.unpack1('n')
+    new(port)
+  end
+end

data/lib/svcb_rr_patch/svcb.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+##
+# The SVCB(contraction of "service binding") DNS Resource Record
+
+class Resolv::DNS::Resource::IN::SVCB < Resolv::DNS::Resource
+  TypeValue = 64 # rubocop: disable Naming/ConstantName
+  ClassValue = IN::ClassValue
+  ClassHash[[TypeValue, ClassValue]] = self
+
+  # @param svc_priority [Integer]
+  # @param target_name [String]
+  # @param svc_params [Map]
+  def initialize(svc_priority, target_name, svc_params)
+    # https://tools.ietf.org/html/draft-ietf-dnsop-svcb-https-06
+    @svc_priority = svc_priority
+    @target_name = target_name
+    @svc_params = svc_params
+  end
+
+  ##
+  # SvcPriority
+
+  attr_reader :svc_priority
+
+  ##
+  # TargetName
+
+  attr_reader :target_name
+
+  ##
+  # SvcParams
+
+  attr_reader :svc_params
+
+  # :nodoc:
+  def encode_rdata(msg)
+    msg.put_bytes([@svc_priority].pack('n'))
+    msg.put_string(@target_name)
+    msg.put_string(::SvcbRrPatch::SvcParams.encode(@svc_params))
+  end
+
+  class << self
+    # :nodoc:
+    def decode_rdata(msg)
+      svc_priority = msg.get_bytes(2).unpack1('n')
+      target_name = msg.get_string
+      return new(svc_priority, target_name, {}) if svc_priority.zero?
+
+      # the SvcParams, consuming the remainder of the record
+      svc_params = ::SvcbRrPatch::SvcParams.decode(msg.get_bytes)
+      new(svc_priority, target_name, svc_params)
+    end
+  end
+end

data/lib/svcb_rr_patch/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SvcbRrPatch
+  VERSION = '0.0.1'
+end

data/spec/alpn_spec.rb

@@ -0,0 +1,30 @@
+# encoding: ascii-8bit
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+RSpec.describe SvcbRrPatch::SvcParams::Alpn do
+  let(:octet) do
+    "\x05h3-29\x05h3-28\x05h3-27\x02h2"
+  end
+
+  context '#decode' do
+    let(:alpn) do
+      SvcbRrPatch::SvcParams::Alpn.decode(octet)
+    end
+
+    it 'could decode' do
+      expect(alpn.protocols).to eq %w[h3-29 h3-28 h3-27 h2]
+    end
+  end
+
+  context '#encode' do
+    let(:alpn) do
+      SvcbRrPatch::SvcParams::Alpn.new(%w[h3-29 h3-28 h3-27 h2])
+    end
+
+    it 'could encode' do
+      expect(alpn.encode).to eq octet
+    end
+  end
+end

data/spec/ipv4hint_spec.rb

@@ -0,0 +1,38 @@
+# encoding: ascii-8bit
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+RSpec.describe SvcbRrPatch::SvcParams::Ipv4hint do
+  let(:octet) do
+    "\xc0\xa8\x00\x01\xc0\xa8\x00\x02"
+  end
+
+  context '#decode' do
+    let(:ipv4hint) do
+      SvcbRrPatch::SvcParams::Ipv4hint.decode(octet)
+    end
+
+    it 'could decode' do
+      expect(ipv4hint.addresses).to eq [
+        Resolv::IPv4.create('192.168.0.1'),
+        Resolv::IPv4.create('192.168.0.2')
+      ]
+    end
+  end
+
+  context '#encode' do
+    let(:ipv4hint) do
+      SvcbRrPatch::SvcParams::Ipv4hint.new(
+        [
+          Resolv::IPv4.create('192.168.0.1'),
+          Resolv::IPv4.create('192.168.0.2')
+        ]
+      )
+    end
+
+    it 'could encode' do
+      expect(ipv4hint.encode).to eq octet
+    end
+  end
+end

data/spec/ipv6hint_spec.rb

@@ -0,0 +1,33 @@
+# encoding: ascii-8bit
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+RSpec.describe SvcbRrPatch::SvcParams::Ipv6hint do
+  let(:octet) do
+    "\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01\x01"
+  end
+
+  context '#decode' do
+    let(:ipv6hint) do
+      SvcbRrPatch::SvcParams::Ipv6hint.decode(octet)
+    end
+
+    it 'could decode' do
+      expect(ipv6hint.addresses)
+        .to eq [Resolv::IPv6.create('101:101:101:101:101:101:101:101')]
+    end
+  end
+
+  context '#encode' do
+    let(:ipv6hint) do
+      SvcbRrPatch::SvcParams::Ipv6hint.new(
+        [Resolv::IPv6.create('101:101:101:101:101:101:101:101')]
+      )
+    end
+
+    it 'could encode' do
+      expect(ipv6hint.encode).to eq octet
+    end
+  end
+end

data/spec/mandatory_spec.rb

@@ -0,0 +1,39 @@
+# encoding: ascii-8bit
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+RSpec.describe SvcbRrPatch::SvcParams::Mandatory do
+  let(:octet) do
+    "\x00\x05\xff\xa4"
+  end
+
+  let(:keys) do
+    h = Hash[
+      (0..SvcbRrPatch::SvcParams::PARAMETER_REGISTRY.size - 1)
+        .zip(SvcbRrPatch::SvcParams::PARAMETER_REGISTRY)
+    ].invert
+
+    [h['ech'], h['key65444']]
+  end
+
+  context '#decode' do
+    let(:mandatory) do
+      SvcbRrPatch::SvcParams::Mandatory.decode(octet)
+    end
+
+    it 'could decode' do
+      expect(mandatory.keys).to eq keys
+    end
+  end
+
+  context '#encode' do
+    let(:mandatory) do
+      SvcbRrPatch::SvcParams::Mandatory.new(keys)
+    end
+
+    it 'could encode' do
+      expect(mandatory.encode).to eq octet
+    end
+  end
+end

data/spec/no_default_alpn_spec.rb

@@ -0,0 +1,35 @@
+# encoding: ascii-8bit
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+RSpec.describe SvcbRrPatch::SvcParams::NoDefaultAlpn do
+  let(:octet) do
+    "\x05h3-29\x05h3-28\x05h3-27\x02h2"
+  end
+
+  context '#decode' do
+    let(:no_default_alpn) do
+      SvcbRrPatch::SvcParams::NoDefaultAlpn
+        .decode(octet)
+    end
+
+    it 'could decode' do
+      expect(no_default_alpn.protocols).to eq %w[h3-29 h3-28 h3-27 h2]
+      expect(no_default_alpn)
+        .to be_a(SvcbRrPatch::SvcParams::NoDefaultAlpn)
+    end
+  end
+
+  context '#encode' do
+    let(:no_default_alpn) do
+      SvcbRrPatch::SvcParams::NoDefaultAlpn.new(%w[h3-29 h3-28 h3-27 h2])
+    end
+
+    it 'could encode' do
+      expect(no_default_alpn)
+        .to be_a(SvcbRrPatch::SvcParams::NoDefaultAlpn)
+      expect(no_default_alpn.encode).to eq octet
+    end
+  end
+end

data/spec/port_spec.rb

@@ -0,0 +1,30 @@
+# encoding: ascii-8bit
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+RSpec.describe SvcbRrPatch::SvcParams::Port do
+  let(:octet) do
+    "\x01\xbb"
+  end
+
+  context '#decode' do
+    let(:port) do
+      SvcbRrPatch::SvcParams::Port.decode(octet)
+    end
+
+    it 'could decode' do
+      expect(port.port).to eq 443
+    end
+  end
+
+  context '#encode' do
+    let(:port) do
+      SvcbRrPatch::SvcParams::Port.new(443)
+    end
+
+    it 'could encode' do
+      expect(port.encode).to eq octet
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.configure(&:disable_monkey_patching!)
+
+require 'svcb_rr_patch'

data/spec/svc_params_spec.rb

@@ -0,0 +1,75 @@
+# encoding: ascii-8bit
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+RSpec.describe SvcbRrPatch::SvcParams do
+  let(:octet) do
+    <<-BIN.split.map(&:hex).map(&:chr).join
+      00 01 00 15 05 68 33 2d     32 39 05 68 33 2d 32 38
+      05 68 33 2d 32 37 02 68     32 00 04 00 08 c0 a8 00
+      01 c0 a8 00 02 00 06 00     10 01 01 01 01 01 01 01
+      01 01 01 01 01 01 01 01     01 ff 35 00 03 01 02 03
+    BIN
+  end
+
+  let(:alpn) do
+    SvcbRrPatch::SvcParams::Alpn.new(%w[h3-29 h3-28 h3-27 h2])
+  end
+
+  let(:ipv4hint) do
+    SvcbRrPatch::SvcParams::Ipv4hint.new(
+      [
+        Resolv::IPv4.create('192.168.0.1'),
+        Resolv::IPv4.create('192.168.0.2')
+      ]
+    )
+  end
+
+  let(:ipv6hint) do
+    SvcbRrPatch::SvcParams::Ipv6hint.new(
+      [Resolv::IPv6.create('101:101:101:101:101:101:101:101')]
+    )
+  end
+
+  let(:key65333) do
+    "\x01\x02\x03"
+  end
+
+  context '#keyNNNNN' do
+    it 'could be defined' do
+      expect(SvcbRrPatch::SvcParams::PARAMETER_REGISTRY[65333])
+        .to eq 'key65333'
+    end
+  end
+
+  context '#decode' do
+    let(:svc_params) do
+      SvcbRrPatch::SvcParams.decode(octet)
+    end
+
+    it 'could decode' do
+      expect(svc_params.keys).to eq %w[alpn ipv4hint ipv6hint key65333]
+
+      expect(svc_params['alpn'].protocols).to eq alpn.protocols
+      expect(svc_params['ipv4hint'].addresses).to eq ipv4hint.addresses
+      expect(svc_params['ipv6hint'].addresses).to eq ipv6hint.addresses
+      expect(svc_params['key65333']).to eq key65333
+    end
+  end
+
+  context '#encode' do
+    let(:svc_params) do
+      {
+        'alpn' => alpn,
+        'ipv4hint' => ipv4hint,
+        'ipv6hint' => ipv6hint,
+        'key65333' => key65333
+      }
+    end
+
+    it 'could encode' do
+      expect(SvcbRrPatch::SvcParams.encode(svc_params)).to eq octet
+    end
+  end
+end

data/svcb_rr_patch.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'svcb_rr_patch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'svcb_rr_patch'
+  spec.version       = SvcbRrPatch::VERSION
+  spec.authors       = ['thekuwayama']
+  spec.email         = ['thekuwayama@gmail.com']
+  spec.summary       = 'the patch that adds SVCB Resource Record' \
+                       ' and HTTPS Resource Record'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/thekuwayama/svcb_rr_patch'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>=2.6.0'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: svcb_rr_patch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- thekuwayama
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: the patch that adds SVCB Resource Record and HTTPS Resource Record
+email:
+- thekuwayama@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/svcb_rr_patch.rb
+- lib/svcb_rr_patch/https.rb
+- lib/svcb_rr_patch/svc_params.rb
+- lib/svcb_rr_patch/svc_params/alpn.rb
+- lib/svcb_rr_patch/svc_params/ech.rb
+- lib/svcb_rr_patch/svc_params/ech/echconfig_contents.rb
+- lib/svcb_rr_patch/svc_params/ech/echconfig_contents/extension.rb
+- lib/svcb_rr_patch/svc_params/ech/echconfig_contents/hpke_key_config.rb
+- lib/svcb_rr_patch/svc_params/ech/echconfig_contents/hpke_key_config/hpke_kem_id.rb
+- lib/svcb_rr_patch/svc_params/ech/echconfig_contents/hpke_key_config/hpke_public_key.rb
+- lib/svcb_rr_patch/svc_params/ech/echconfig_contents/hpke_key_config/hpke_symmetric_cipher_suite.rb
+- lib/svcb_rr_patch/svc_params/ech/echconfig_contents/hpke_key_config/hpke_symmetric_cipher_suite/hpke_aead_id.rb
+- lib/svcb_rr_patch/svc_params/ech/echconfig_contents/hpke_key_config/hpke_symmetric_cipher_suite/hpke_kdf_id.rb
+- lib/svcb_rr_patch/svc_params/ipv4hint.rb
+- lib/svcb_rr_patch/svc_params/ipv6hint.rb
+- lib/svcb_rr_patch/svc_params/mandatory.rb
+- lib/svcb_rr_patch/svc_params/no_default_alpn.rb
+- lib/svcb_rr_patch/svc_params/port.rb
+- lib/svcb_rr_patch/svcb.rb
+- lib/svcb_rr_patch/version.rb
+- spec/alpn_spec.rb
+- spec/ipv4hint_spec.rb
+- spec/ipv6hint_spec.rb
+- spec/mandatory_spec.rb
+- spec/no_default_alpn_spec.rb
+- spec/port_spec.rb
+- spec/spec_helper.rb
+- spec/svc_params_spec.rb
+- svcb_rr_patch.gemspec
+homepage: https://github.com/thekuwayama/svcb_rr_patch
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: the patch that adds SVCB Resource Record and HTTPS Resource Record
+test_files:
+- spec/alpn_spec.rb
+- spec/ipv4hint_spec.rb
+- spec/ipv6hint_spec.rb
+- spec/mandatory_spec.rb
+- spec/no_default_alpn_spec.rb
+- spec/port_spec.rb
+- spec/spec_helper.rb
+- spec/svc_params_spec.rb