ech_config 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5f6d7fc30ca60ee845fcc56eceadad14e4307fca0e95b5eb9274185410bedbc
-  data.tar.gz: 7c887ae00fce9af2a5d96bf2a27d9a163c999385d9fdcf57f36a0c6cab3c894e
+  metadata.gz: 0f6f2b4668e0fbb692d0db6c03b8a4a78320fa3147d8770310ab9428b6ece0bf
+  data.tar.gz: 41c4f5b773ce66afd9f2a72ef2b64779c3fc9817bdb7684ccbcd2b966667eda4
 SHA512:
-  metadata.gz: d64fae03b94b58435cc31aba2a22bc3f95c5d5676b9bffdb7ac8bd642cf9ba3ee88828c8039bbb33c737bf82ad516af05d3e378ccbb350c6bdfa28236c32ecfd
-  data.tar.gz: e0e133cab1b650e184e68bdae49357ccec39c87ab25fa5e5651e12bc158ecce9a3fe52cdb4c14e660e921c7ddb46253bfd210c5bc1e73785d7487600fa12cb03
+  metadata.gz: e9ebeb59a85b89e629cc18ec1a4c41f7edaa41584ab33ab470f2c3a5077ea329987772a77da3ad5794c1ad955d8e6716a45078e9ce6503eb167d2c79d30fb075
+  data.tar.gz: dd8a35d615ce762ae37bb3658e1ab9695992572bd36bf58af451e9e0ae48d96ac5ba6165b7f027635de0c2d9e5772a237365b63223604b5188ca97e219e21e31

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ech_config (0.0.5)
+    ech_config (0.1.0)
       base64
 
 GEM
@@ -172,7 +172,7 @@ CHECKSUMS
   csv (3.3.5) sha256=6e5134ac3383ef728b7f02725d9872934f523cb40b961479f69cf3afa6c8e73f
   diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
   drb (2.2.3) sha256=0b00d6fdb50995fe4a45dea13663493c841112e4068656854646f418fda13373
-  ech_config (0.0.5)
+  ech_config (0.1.0)
   ffi (1.17.3) sha256=0e9f39f7bb3934f77ad6feab49662be77e87eedcdeb2a3f5c0234c2938563d4c
   ffi (1.17.3-aarch64-linux-gnu) sha256=28ad573df26560f0aedd8a90c3371279a0b2bd0b4e834b16a2baa10bd7a97068
   ffi (1.17.3-aarch64-linux-musl) sha256=020b33b76775b1abacc3b7d86b287cef3251f66d747092deec592c7f5df764b2

data/README.md

@@ -5,7 +5,7 @@
 
 `ech_config` is Ruby implementation of [Encrypted ClientHello Configuration](https://datatracker.ietf.org/doc/html/rfc9849.html).
 
-`ech_config` supports `0xfe0b` ~ `0xfe0f` ECHConfig.version.
+`ech_config` supports `0xfe0b` ~ `0xfe0d` ECHConfig.version.
 
 
 ## Installation
@@ -17,6 +17,40 @@ $ gem install ech_config
 ```
 
 
+## Usage
+
+```ruby
+require 'ech_config'
+
+echconfigs = ECHConfig.decode_vectors(octet)
+```
+
+Clients MUST ignore an ECHConfig that carries an unsupported mandatory ECHConfig extension ([RFC 9849 4.2](https://datatracker.ietf.org/doc/html/rfc9849.html#section-4.2-2)). This gem decodes every extension it does not know as `UnknownExtension`, so:
+
+```ruby
+echconfigs.reject do |echconfig|
+  echconfig.echconfig_contents.extensions.any_unsupported_mandatory?
+end
+```
+
+`ech_authinfo` and `ech_auth` ([draft-sullivan-tls-signed-ech-updates-02](https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1)) are decoded as `ECHAuthInfo` / `ECHAuth`. `ECHConfig#to_be_signed` returns the bytes an `ech_auth` signature is computed over; validating `not_after`, `trusted_keys` and the signature itself is left to the caller.
+
+```ruby
+ech_auth = echconfig
+           .echconfig_contents
+           .extensions[ECHConfig::ECHConfigContents::Extensions::ECHAuth::TYPE]
+OpenSSL::PKey.read(ech_auth.spki)
+             .verify(nil, ech_auth.signature, echconfig.to_be_signed)
+```
+
+The draft leaves both extension types unassigned (TBD1 / TBD2), so `ech_config` uses placeholder codepoints until IANA assigns them.
+
+| Extension | Draft | Placeholder |
+| --- | --- | --- |
+| `ech_authinfo` | TBD1 | `0xfe0e` |
+| `ech_auth` | TBD2 | `0xfe0d` |
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/ech_config/ech_config_contents/extensions/ech_auth.rb

@@ -0,0 +1,123 @@
+# encoding: ascii-8bit
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+# https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1
+class ECHConfig::ECHConfigContents::Extensions::ECHAuth
+  include ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension
+
+  # Value: TBD2 (assigned with the high-order bit set)
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-9.1-5.1.1
+  #
+  # TODO: placeholder until IANA assigns TBD2. 0xfe0d is the codepoint
+  # ech-auth-interop uses for ech_auth.
+  # https://github.com/grittygrease/ech-auth-interop
+  TYPE = 0xfe0d
+
+  # context_label = "TLS-ECH-AUTH-v1"
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1.1-2
+  CONTEXT_LABEL = 'TLS-ECH-AUTH-v1'
+
+  # uint64 not_after, uint8 disable and the length prefix of spki
+  FIXED_LENGTH = 8 + 1 + 2
+
+  attr_reader :not_after, :spki, :algorithm, :signature
+
+  # @rbs not_after: Integer
+  # @rbs disable: Integer
+  # @rbs spki: String
+  # @rbs algorithm: Integer
+  # @rbs signature: String
+  # @rbs return: void
+  def initialize(not_after, disable, spki, algorithm, signature)
+    # Senders MUST encode disable as 0 or 1; clients MUST reject any other
+    # value.
+    # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1-7
+    raise ArgumentError unless [0, 1].include?(disable)
+
+    # opaque spki<1..2^16-1>;
+    raise ArgumentError if spki.empty? || spki.length > 2**16 - 1
+
+    # opaque signature<0..2^16-1>;
+    raise ArgumentError if signature.length > 2**16 - 1
+
+    @not_after = not_after
+    @disable = disable
+    @spki = spki
+    @algorithm = algorithm
+    @signature = signature
+  end
+
+  # @rbs return: Integer
+  def type
+    TYPE
+  end
+
+  # When set to 1, the client MUST NOT attempt ECH on the retry.
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1-7
+  #
+  # @rbs return: bool
+  def disable?
+    @disable == 1
+  end
+
+  # @rbs return: String
+  def encode
+    [TYPE].pack('n') \
+    + ([@not_after].pack('Q>') \
+       + [@disable].pack('C') \
+       + @spki.then { |s| [s.length].pack('n') + s } \
+       + [@algorithm].pack('n') \
+       + @signature.then { |s| [s.length].pack('n') + s })
+      .then { |s| [s.length].pack('n') + s } # ECHConfigExtension.data
+  end
+
+  # The two-byte length prefix of the signature field is encoded as 0x0000 and
+  # no signature bytes follow.
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1.1-4.1
+  #
+  # @rbs return: ECHConfig::ECHConfigContents::Extensions::ECHAuth
+  def without_signature
+    self.class.new(@not_after, @disable, @spki, @algorithm, '')
+  end
+
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/PerceivedComplexity
+  # @rbs octet: String
+  # @rbs return: ECHConfig::ECHConfigContents::Extensions::ECHAuth
+  def self.decode(octet)
+    raise ::ECHConfig::DecodeError if octet.length < FIXED_LENGTH
+
+    not_after = octet.slice(0, 8)&.unpack1('Q>') #: Integer
+    disable = octet.slice(8, 1)&.unpack1('C') #: Integer
+    # Senders MUST encode disable as 0 or 1; clients MUST reject any other
+    # value.
+    # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1-7
+    raise ::ECHConfig::DecodeError unless [0, 1].include?(disable)
+
+    spki_len = octet.slice(9, 2)&.unpack1('n') #: Integer
+    i = 11
+    # opaque spki<1..2^16-1>;
+    raise ::ECHConfig::DecodeError \
+      if spki_len.zero? || i + spki_len + 4 > octet.length
+
+    spki = octet.slice(i, spki_len) #: String
+    i += spki_len
+    algorithm = octet.slice(i, 2)&.unpack1('n') #: Integer
+    i += 2
+    sig_len = octet.slice(i, 2)&.unpack1('n') #: Integer
+    i += 2
+    raise ::ECHConfig::DecodeError if i + sig_len != octet.length
+    # The signature field in a wire ECHAuth MUST be non-empty. The zero-length
+    # form is used only when constructing ECHConfigTBS.
+    # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1-6
+    raise ::ECHConfig::DecodeError if sig_len.zero?
+
+    new(not_after, disable, spki, algorithm, octet.slice(i, sig_len) || '')
+  end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/CyclomaticComplexity
+  # rubocop:enable Metrics/PerceivedComplexity
+end

data/lib/ech_config/ech_config_contents/extensions/ech_authinfo.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+# https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1
+class ECHConfig::ECHConfigContents::Extensions::ECHAuthInfo
+  include ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension
+
+  # Value: TBD1 (assigned with the high-order bit set)
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-9.1-3.1.1
+  #
+  # TODO: placeholder until IANA assigns TBD1, NOT interoperable.
+  TYPE = 0xfe0e
+
+  # opaque SPKIHash[32];
+  SPKI_HASH_LENGTH = 32
+
+  attr_reader :trusted_keys
+
+  # @rbs trusted_keys: Array[String]
+  # @rbs return: void
+  def initialize(trusted_keys)
+    # SPKIHash trusted_keys<32..2^16-32>;
+    raise ArgumentError unless trusted_keys.all? { |k| k.length == SPKI_HASH_LENGTH }
+    raise ArgumentError \
+      if trusted_keys.empty? ||
+         trusted_keys.length * SPKI_HASH_LENGTH > 2**16 - SPKI_HASH_LENGTH
+
+    @trusted_keys = trusted_keys
+  end
+
+  # @rbs return: Integer
+  def type
+    TYPE
+  end
+
+  # @rbs return: String
+  def encode
+    [TYPE].pack('n') \
+    + @trusted_keys.join
+                   .then { |s| [s.length].pack('n') + s } # ECHAuthInfo.trusted_keys
+                   .then { |s| [s.length].pack('n') + s } # ECHConfigExtension.data
+  end
+
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/PerceivedComplexity
+  # @rbs octet: String
+  # @rbs return: ECHConfig::ECHConfigContents::Extensions::ECHAuthInfo
+  def self.decode(octet)
+    raise ::ECHConfig::DecodeError if octet.length < 2
+
+    # SPKIHash trusted_keys<32..2^16-32>;
+    tk_len = octet.slice(0, 2)&.unpack1('n') #: Integer
+    raise ::ECHConfig::DecodeError if tk_len + 2 != octet.length
+    raise ::ECHConfig::DecodeError \
+      if tk_len < SPKI_HASH_LENGTH || tk_len > 2**16 - SPKI_HASH_LENGTH
+    raise ::ECHConfig::DecodeError unless (tk_len % SPKI_HASH_LENGTH).zero?
+
+    trusted_keys = (0...(tk_len / SPKI_HASH_LENGTH)).map do |i|
+      octet.slice(2 + i * SPKI_HASH_LENGTH, SPKI_HASH_LENGTH) || ''
+    end
+    new(trusted_keys)
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity
+  # rubocop:enable Metrics/PerceivedComplexity
+end

data/lib/ech_config/ech_config_contents/extensions/ech_config_extension.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+# @rbs module-self _ECHConfigExtension
+#
+# https://datatracker.ietf.org/doc/html/rfc9849.html#section-4.2
+module ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension
+  # @rbs!
+  #   interface _ECHConfigExtension
+  #     def type: () -> Integer
+  #
+  #     def encode: () -> String
+  #   end
+
+  # an extension can be tagged as mandatory by using an extension type
+  # codepoint with the high order bit set to 1.
+  # https://datatracker.ietf.org/doc/html/rfc9849.html#section-4.2-2
+  MANDATORY_BIT = 0x8000
+
+  # @rbs return: bool
+  def mandatory?
+    !(type & MANDATORY_BIT).zero?
+  end
+
+  # @rbs return: bool
+  def supported?
+    true
+  end
+end

data/lib/ech_config/ech_config_contents/extensions/unknown_extension.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+class ECHConfig::ECHConfigContents::Extensions::UnknownExtension
+  include ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension
+
+  attr_reader :type, :data
+
+  # @rbs type: Integer
+  # @rbs data: String
+  # @rbs return: void
+  def initialize(type, data = '')
+    @type = type
+    @data = data
+  end
+
+  # @rbs return: String
+  def encode
+    [@type].pack('n') + @data.then { |s| [s.length].pack('n') + s }
+  end
+
+  # @rbs return: bool
+  def supported?
+    false
+  end
+
+  # @rbs octet: String
+  # @rbs type: Integer
+  # @rbs return: ECHConfig::ECHConfigContents::Extensions::UnknownExtension
+  def self.decode(octet, type)
+    new(type, octet)
+  end
+end

data/lib/ech_config/ech_config_contents/extensions.rb

@@ -2,25 +2,103 @@
 
 # rbs_inline: enabled
 
-class ECHConfig::ECHConfigContents::Extensions
-  attr_reader :octet
+# @rbs inherits Hash[Integer, ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension]
+class ECHConfig::ECHConfigContents::Extensions < Hash
+  # define class
+end
 
-  # @rbs octet: String
+# ech_config_extension.rb needs to be loaded first so that each extension can
+# include it
+require_relative 'extensions/ech_config_extension'
+
+Dir["#{File.dirname(__FILE__)}/extensions/*.rb"]
+  .sort.each { |f| require f }
+
+# https://datatracker.ietf.org/doc/html/rfc9849.html#section-4.2
+class ECHConfig::ECHConfigContents::Extensions
+  # @rbs extensions: Array[ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension]
   # @rbs return: void
-  def initialize(octet)
-    # Note taht ECHConfig::ECHConfigContents::Extension only has octets.
-    # If you need, deserialize octets to get TLS Extension objects.
-    @octet = octet
+  def initialize(extensions = [])
+    super()
+    extensions.each { |ex| self << ex }
   end
 
   # @rbs return: String
-  def load
-    @octet
+  def encode
+    values.map(&:encode).join
   end
 
+  # @rbs ex: ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension
+  # @rbs return: self
+  def <<(ex)
+    raise ArgumentError unless self.class.valid_ech_auth?(keys | [ex.type])
+
+    store(ex.type, ex)
+    self
+  end
+
+  # A single ECHConfig MUST NOT carry both extensions.
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1-2
+  #
+  # The ech_auth extension MUST be the last extension in the ECHConfig's
+  # extension list.
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1-3
+  #
+  # @rbs types: Array[Integer]
+  # @rbs return: bool
+  def self.valid_ech_auth?(types)
+    return true unless types.include?(ECHAuth::TYPE)
+
+    !types.include?(ECHAuthInfo::TYPE) && types.last == ECHAuth::TYPE
+  end
+
+  # Clients MUST parse the extension list and check for unsupported mandatory extensions.
+  # If an unsupported mandatory extension is present, clients MUST ignore the ECHConfig.
+  # https://datatracker.ietf.org/doc/html/rfc9849.html#section-4.2-2
+  #
+  # @rbs return: bool
+  def any_unsupported_mandatory?
+    values.any? { |ex| ex.mandatory? && !ex.supported? }
+  end
+
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/PerceivedComplexity
   # @rbs octet: String
   # @rbs return: ECHConfig::ECHConfigContents::Extensions
-  def self.store(octet)
-    new(octet)
+  def self.decode(octet)
+    i = 0
+    extensions = new
+    while i < octet.length
+      raise ::ECHConfig::DecodeError if i + 4 > octet.length
+
+      type = octet.slice(i, 2)&.unpack1('n') #: Integer
+      ex_len = octet.slice(i + 2, 2)&.unpack1('n') #: Integer
+      raise ::ECHConfig::DecodeError if i + 4 + ex_len > octet.length
+
+      # There MUST NOT be more than one extension of the same type.
+      raise ::ECHConfig::DecodeError if extensions.include?(type)
+
+      ex = decode_extension(octet.slice(i + 4, ex_len) || '', type)
+      extensions.store(type, ex)
+      i += 4 + ex_len
+    end
+    raise ::ECHConfig::DecodeError if i != octet.length
+    raise ::ECHConfig::DecodeError unless valid_ech_auth?(extensions.keys)
+
+    extensions
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity
+  # rubocop:enable Metrics/PerceivedComplexity
+
+  # @rbs octet: String
+  # @rbs type: Integer
+  # @rbs return: ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension
+  def self.decode_extension(octet, type)
+    case type
+    when ECHAuth::TYPE then ECHAuth.decode(octet)
+    when ECHAuthInfo::TYPE then ECHAuthInfo.decode(octet)
+    else UnknownExtension.decode(octet, type)
+    end
   end
+  private_class_method :decode_extension
 end

data/lib/ech_config/ech_config_contents.rb

@@ -32,7 +32,7 @@ class ECHConfig::ECHConfigContents
     @key_config.encode \
     + [@maximum_name_length].pack('C') \
     + @public_name.then { |s| [s.length].pack('C') + s } \
-    + @extensions.load.then { |s| [s.length].pack('n') + s }
+    + @extensions.encode.then { |s| [s.length].pack('n') + s }
   end
 
   # rubocop:disable Metrics/AbcSize
@@ -62,7 +62,7 @@ class ECHConfig::ECHConfigContents
     i += 2
     raise ::ECHConfig::DecodeError if i + ex_len != octet.length
 
-    extensions = Extensions.store(octet.slice(i, ex_len) || '')
+    extensions = Extensions.decode(octet.slice(i, ex_len) || '')
     new(
       key_config,
       maximum_name_length,

data/lib/ech_config/version.rb

@@ -3,5 +3,5 @@
 # rbs_inline: enabled
 
 class ECHConfig
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/lib/ech_config.rb

@@ -34,6 +34,39 @@ class ECHConfig
     @version + @echconfig_contents.encode.then { |s| [s.length].pack('n') + s }
   end
 
+  # to_be_signed = context_label || ECHConfigTBS
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1.1-2
+  #
+  # ECHConfigTBS (To-Be-Signed) is a fresh serialization of the ECHConfig
+  # structure including the ech_auth extension, but with the signature field
+  # within ech_auth set to zero-length. The ech_auth extension data length,
+  # ECHConfig extensions vector length, and ECHConfig length field are
+  # recomputed for that serialization.
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1.1-4.1
+  #
+  # @rbs return: String
+  def to_be_signed
+    ech_auth = @echconfig_contents.extensions[ECHConfigContents::Extensions::ECHAuth::TYPE]
+    raise ::ECHConfig::Error \
+      unless ech_auth.is_a?(ECHConfigContents::Extensions::ECHAuth)
+
+    extensions = ECHConfigContents::Extensions.new(
+      @echconfig_contents.extensions.values.map do |ex|
+        ex.equal?(ech_auth) ? ech_auth.without_signature : ex
+      end
+    )
+    ECHConfigContents::Extensions::ECHAuth::CONTEXT_LABEL \
+    + self.class.new(
+      @version,
+      ECHConfigContents.new(
+        @echconfig_contents.key_config,
+        @echconfig_contents.maximum_name_length,
+        @echconfig_contents.public_name,
+        extensions
+      )
+    ).encode
+  end
+
   # rubocop:disable Metrics/CyclomaticComplexity
   # @rbs octet: String
   # @rbs return: Array[ECHConfig]

data/sig/generated/ech_config/ech_config_contents/extensions/ech_auth.rbs

@@ -0,0 +1,63 @@
+# Generated from lib/ech_config/ech_config_contents/extensions/ech_auth.rb with RBS::Inline
+
+# https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1
+class ECHConfig::ECHConfigContents::Extensions::ECHAuth
+  include ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension
+
+  # Value: TBD2 (assigned with the high-order bit set)
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-9.1-5.1.1
+  #
+  # TODO: placeholder until IANA assigns TBD2. 0xfe0d is the codepoint
+  # ech-auth-interop uses for ech_auth.
+  # https://github.com/grittygrease/ech-auth-interop
+  TYPE: ::Integer
+
+  # context_label = "TLS-ECH-AUTH-v1"
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1.1-2
+  CONTEXT_LABEL: ::String
+
+  # uint64 not_after, uint8 disable and the length prefix of spki
+  FIXED_LENGTH: untyped
+
+  attr_reader not_after: untyped
+
+  attr_reader spki: untyped
+
+  attr_reader algorithm: untyped
+
+  attr_reader signature: untyped
+
+  # @rbs not_after: Integer
+  # @rbs disable: Integer
+  # @rbs spki: String
+  # @rbs algorithm: Integer
+  # @rbs signature: String
+  # @rbs return: void
+  def initialize: (Integer not_after, Integer disable, String spki, Integer algorithm, String signature) -> void
+
+  # @rbs return: Integer
+  def type: () -> Integer
+
+  # When set to 1, the client MUST NOT attempt ECH on the retry.
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1-7
+  #
+  # @rbs return: bool
+  def disable?: () -> bool
+
+  # @rbs return: String
+  def encode: () -> String
+
+  # The two-byte length prefix of the signature field is encoded as 0x0000 and
+  # no signature bytes follow.
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1.1-4.1
+  #
+  # @rbs return: ECHConfig::ECHConfigContents::Extensions::ECHAuth
+  def without_signature: () -> ECHConfig::ECHConfigContents::Extensions::ECHAuth
+
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/PerceivedComplexity
+  # @rbs octet: String
+  # @rbs return: ECHConfig::ECHConfigContents::Extensions::ECHAuth
+  def self.decode: (String octet) -> ECHConfig::ECHConfigContents::Extensions::ECHAuth
+end

data/sig/generated/ech_config/ech_config_contents/extensions/ech_authinfo.rbs

@@ -0,0 +1,33 @@
+# Generated from lib/ech_config/ech_config_contents/extensions/ech_authinfo.rb with RBS::Inline
+
+# https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1
+class ECHConfig::ECHConfigContents::Extensions::ECHAuthInfo
+  include ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension
+
+  # Value: TBD1 (assigned with the high-order bit set)
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-9.1-3.1.1
+  #
+  # TODO: placeholder until IANA assigns TBD1, NOT interoperable.
+  TYPE: ::Integer
+
+  # opaque SPKIHash[32];
+  SPKI_HASH_LENGTH: ::Integer
+
+  attr_reader trusted_keys: untyped
+
+  # @rbs trusted_keys: Array[String]
+  # @rbs return: void
+  def initialize: (Array[String] trusted_keys) -> void
+
+  # @rbs return: Integer
+  def type: () -> Integer
+
+  # @rbs return: String
+  def encode: () -> String
+
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/PerceivedComplexity
+  # @rbs octet: String
+  # @rbs return: ECHConfig::ECHConfigContents::Extensions::ECHAuthInfo
+  def self.decode: (String octet) -> ECHConfig::ECHConfigContents::Extensions::ECHAuthInfo
+end

data/sig/generated/ech_config/ech_config_contents/extensions/ech_config_extension.rbs

@@ -0,0 +1,23 @@
+# Generated from lib/ech_config/ech_config_contents/extensions/ech_config_extension.rb with RBS::Inline
+
+# @rbs module-self _ECHConfigExtension
+#
+# https://datatracker.ietf.org/doc/html/rfc9849.html#section-4.2
+module ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension : _ECHConfigExtension
+  interface _ECHConfigExtension
+    def type: () -> Integer
+
+    def encode: () -> String
+  end
+
+  # an extension can be tagged as mandatory by using an extension type
+  # codepoint with the high order bit set to 1.
+  # https://datatracker.ietf.org/doc/html/rfc9849.html#section-4.2-2
+  MANDATORY_BIT: ::Integer
+
+  # @rbs return: bool
+  def mandatory?: () -> bool
+
+  # @rbs return: bool
+  def supported?: () -> bool
+end

data/sig/generated/ech_config/ech_config_contents/extensions/unknown_extension.rbs

@@ -0,0 +1,25 @@
+# Generated from lib/ech_config/ech_config_contents/extensions/unknown_extension.rb with RBS::Inline
+
+class ECHConfig::ECHConfigContents::Extensions::UnknownExtension
+  include ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension
+
+  attr_reader type: untyped
+
+  attr_reader data: untyped
+
+  # @rbs type: Integer
+  # @rbs data: String
+  # @rbs return: void
+  def initialize: (Integer type, ?String data) -> void
+
+  # @rbs return: String
+  def encode: () -> String
+
+  # @rbs return: bool
+  def supported?: () -> bool
+
+  # @rbs octet: String
+  # @rbs type: Integer
+  # @rbs return: ECHConfig::ECHConfigContents::Extensions::UnknownExtension
+  def self.decode: (String octet, Integer type) -> ECHConfig::ECHConfigContents::Extensions::UnknownExtension
+end

data/sig/generated/ech_config/ech_config_contents/extensions.rbs

@@ -1,16 +1,48 @@
 # Generated from lib/ech_config/ech_config_contents/extensions.rb with RBS::Inline
 
-class ECHConfig::ECHConfigContents::Extensions
-  attr_reader octet: untyped
+# @rbs inherits Hash[Integer, ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension]
+class ECHConfig::ECHConfigContents::Extensions < Hash[Integer, ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension]
+end
 
-  # @rbs octet: String
+# https://datatracker.ietf.org/doc/html/rfc9849.html#section-4.2
+class ECHConfig::ECHConfigContents::Extensions
+  # @rbs extensions: Array[ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension]
   # @rbs return: void
-  def initialize: (String octet) -> void
+  def initialize: (?Array[ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension] extensions) -> void
 
   # @rbs return: String
-  def load: () -> String
+  def encode: () -> String
+
+  # @rbs ex: ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension
+  # @rbs return: self
+  def <<: (ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension ex) -> self
 
+  # A single ECHConfig MUST NOT carry both extensions.
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1-2
+  #
+  # The ech_auth extension MUST be the last extension in the ECHConfig's
+  # extension list.
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1-3
+  #
+  # @rbs types: Array[Integer]
+  # @rbs return: bool
+  def self.valid_ech_auth?: (Array[Integer] types) -> bool
+
+  # Clients MUST parse the extension list and check for unsupported mandatory extensions.
+  # If an unsupported mandatory extension is present, clients MUST ignore the ECHConfig.
+  # https://datatracker.ietf.org/doc/html/rfc9849.html#section-4.2-2
+  #
+  # @rbs return: bool
+  def any_unsupported_mandatory?: () -> bool
+
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/PerceivedComplexity
   # @rbs octet: String
   # @rbs return: ECHConfig::ECHConfigContents::Extensions
-  def self.store: (String octet) -> ECHConfig::ECHConfigContents::Extensions
+  def self.decode: (String octet) -> ECHConfig::ECHConfigContents::Extensions
+
+  # @rbs octet: String
+  # @rbs type: Integer
+  # @rbs return: ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension
+  def self.decode_extension: (String octet, Integer type) -> ECHConfig::ECHConfigContents::Extensions::ECHConfigExtension
 end

data/sig/generated/ech_config.rbs

@@ -16,6 +16,19 @@ class ECHConfig
   # @rbs return: String
   def encode: () -> String
 
+  # to_be_signed = context_label || ECHConfigTBS
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1.1-2
+  #
+  # ECHConfigTBS (To-Be-Signed) is a fresh serialization of the ECHConfig
+  # structure including the ech_auth extension, but with the signature field
+  # within ech_auth set to zero-length. The ech_auth extension data length,
+  # ECHConfig extensions vector length, and ECHConfig length field are
+  # recomputed for that serialization.
+  # https://datatracker.ietf.org/doc/html/draft-sullivan-tls-signed-ech-updates-02#section-5.1.1-4.1
+  #
+  # @rbs return: String
+  def to_be_signed: () -> String
+
   # rubocop:disable Metrics/CyclomaticComplexity
   # @rbs octet: String
   # @rbs return: Array[ECHConfig]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ech_config
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - thekuwayama
@@ -58,6 +58,10 @@ files:
 - lib/ech_config.rb
 - lib/ech_config/ech_config_contents.rb
 - lib/ech_config/ech_config_contents/extensions.rb
+- lib/ech_config/ech_config_contents/extensions/ech_auth.rb
+- lib/ech_config/ech_config_contents/extensions/ech_authinfo.rb
+- lib/ech_config/ech_config_contents/extensions/ech_config_extension.rb
+- lib/ech_config/ech_config_contents/extensions/unknown_extension.rb
 - lib/ech_config/ech_config_contents/hpke_key_config.rb
 - lib/ech_config/ech_config_contents/hpke_key_config/hpke_kem_id.rb
 - lib/ech_config/ech_config_contents/hpke_key_config/hpke_public_key.rb
@@ -69,6 +73,10 @@ files:
 - sig/generated/ech_config.rbs
 - sig/generated/ech_config/ech_config_contents.rbs
 - sig/generated/ech_config/ech_config_contents/extensions.rbs
+- sig/generated/ech_config/ech_config_contents/extensions/ech_auth.rbs
+- sig/generated/ech_config/ech_config_contents/extensions/ech_authinfo.rbs
+- sig/generated/ech_config/ech_config_contents/extensions/ech_config_extension.rbs
+- sig/generated/ech_config/ech_config_contents/extensions/unknown_extension.rbs
 - sig/generated/ech_config/ech_config_contents/hpke_key_config.rbs
 - sig/generated/ech_config/ech_config_contents/hpke_key_config/hpke_kem_id.rbs
 - sig/generated/ech_config/ech_config_contents/hpke_key_config/hpke_public_key.rbs