echspec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 942fd582bb741ca465bb5255b458ef3cbf3ff8cd09f20b45957df8c64d32f55a
+  data.tar.gz: e5748a921bc1ab45c053884690fe0e7f5718b8847c6376f87100f22173f8dd9c
+SHA512:
+  metadata.gz: a9597e9295d2b6a8d2b836a59a9ec1013edb42b2fc605e2dacd9ba274510ccb9982f1971d6aa4d092f1896da19a4d2317386d72f9d690639049e288e96fe1fe5
+  data.tar.gz: d104c73ca8124af91cbaeb172757d8353e3a328668c89a9d1b66f01281ac6d8e5bacd298ac96b05fa27d1b70dadceb9a216c8b873db9607286a7e0767f304c58

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: lint & test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.2', '3.3', '3.4']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: |
+          gem --version
+          gem install bundler
+          bundle --version
+          bundle install
+      - name: Run rubocop & rspec
+        run: bundle exec rake

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,36 @@
+AllCops:
+  TargetRubyVersion: 3.2
+
+Layout/LineLength:
+  Max: 200
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/*.rb'
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 30
+
+Naming/MethodParameterName:
+  MinNameLength: 1
+
+Naming/FileName:
+  Enabled: false
+
+Naming/ClassAndModuleCamelCase:
+  Enabled: false
+
+Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.6

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gem 'base64'
+gem 'resolv', '> 0.4.0'
+gem 'tttls1.3', github: 'thekuwayama/tttls1.3'
+
+group :development do
+  gem 'rake', '13.2.1'
+  gem 'rspec'
+  gem 'rubocop', '1.62.0'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 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,272 @@
+# echspec
+
+[![Gem Version](https://badge.fury.io/rb/echspec.svg)](https://badge.fury.io/rb/echspec)
+[![Actions Status](https://github.com/thekuwayama/echspec/actions/workflows/ci.yml/badge.svg)](https://github.com/thekuwayama/echspec/actions/workflows/ci.yml)
+[![license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE.txt)
+
+`echspec` is a conformance testing tool for ECH implementation.
+
+![echspec demo](docs/echspec-demo.png)
+
+- https://datatracker.ietf.org/doc/html/draft-ietf-tls-esni-22
+
+
+## Initial Setup
+
+The gem is available at [rubygems.org](https://rubygems.org/gems/echspec). You can install it the following:
+
+```sh-session
+$ gem install echspec
+```
+
+
+## Usage
+
+```sh-session
+$ echspec --help
+Usage: echspec [OPTIONS] <HOSTNAME>
+    -f, --file FILE                  path to ECHConfigs PEM file       (default resolve ECHConfigs via DNS)
+    -p, --port VALUE                 server port number                (default 443)
+    -n, --not-force-compliant-hpke   not force compliant ECHConfig HPKE cipher suite
+    -v, --verbose                    verbose mode; prints message stack if raised an error
+    -s, --sections SECTIONS          sections to test; by the default, test all sections
+```
+
+You can run it the following:
+
+```sh-session
+$ echspec research.cloudflare.com
+TLS Encrypted Client Hello Server
+        ✔ MUST implement the following HPKE cipher suite: KEM: DHKEM(X25519, HKDF-SHA256), KDF: HKDF-SHA256 and AEAD: AES-128-GCM. [9]
+        ✔ MUST abort with an "illegal_parameter" alert, if EncodedClientHelloInner is padded with non-zero values. [5.1-9]
+        ✔ MUST abort with an "illegal_parameter" alert, if any referenced extension is missing in ClientHelloOuter. [5.1-10]
+        ✔ MUST abort with an "illegal_parameter" alert, if any extension is referenced in OuterExtensions more than once. [5.1-10]
+        ✔ MUST abort with an "illegal_parameter" alert, if "encrypted_client_hello" is referenced in OuterExtensions. [5.1-10]
+        ✔ MUST abort with an "illegal_parameter" alert, if the extensions in ClientHelloOuter corresponding to those in OuterExtensions do not occur in the same order. [5.1-10]
+        ✔ MUST abort with an "illegal_parameter" alert, if ECHClientHello.type is not a valid ECHClientHelloType in ClientHelloInner. [7-5]
+        ✔ MUST abort with an "illegal_parameter" alert, if ECHClientHello.type is not a valid ECHClientHelloType in ClientHelloOuter. [7-5]
+        ✔ MUST abort with an "illegal_parameter" alert, if ClientHelloInner offers TLS 1.2 or below. [7.1-11]
+        ✔ MUST include the "encrypted_client_hello" extension in its EncryptedExtensions with the "retry_configs" field set to one or more ECHConfig. [7.1-14.2.1]
+        ✔ MUST abort with a "missing_extension" alert, if 2nd ClientHelloOuter does not contains the "encrypted_client_hello" extension. [7.1.1-2]
+        ✔ MUST abort with an "illegal_parameter" alert, if 2nd ClientHelloOuter "encrypted_client_hello" enc is empty. [7.1.1-2]
+        ✔ MUST abort with a "decrypt_error" alert, if fails to decrypt 2nd ClientHelloOuter. [7.1.1-5]
+```
+
+By default, `echspec` retrieves ECHConfigs via HTTPS records. By using the `-f, --file FILE` option, you can specify an ECHConfig pem file. If you need to test the server on localhost, you can run it the following:
+
+```sh-session
+$ echspec -f fixtures/echconfigs.pem -p 4433 localhost
+```
+
+By default, `echspec` uses the following HPKE cipher suite
+
+- KEM
+  - DHKEM(X25519, HKDF-SHA256)
+- KDF
+  - HKDF-SHA256
+- AEAD
+  - AES-128-GCM
+
+Using the `-n` or `--not-force-compliant-hpke`, you can not enforce the HPKE cipher suite.
+
+```sh-session
+$ echspec -f fixtures/echconfigs.pem -p 4433 -n localhost
+```
+
+If you specify the SECTIONS, you can run only SECTIONS the following:
+
+```sh-session
+$ echspec -f fixtures/echconfigs.pem -p 4433 -n -s 7.1.1-2,7.1.1-5 localhost
+TLS Encrypted Client Hello Server
+        ✔ MUST abort with a "missing_extension" alert, if 2nd ClientHelloOuter does not contains the "encrypted_client_hello" extension. [7.1.1-2]
+        ✔ MUST abort with an "illegal_parameter" alert, if 2nd ClientHelloOuter "encrypted_client_hello" enc is empty. [7.1.1-2]
+        ✔ MUST abort with a "decrypt_error" alert, if fails to decrypt 2nd ClientHelloOuter. [7.1.1-5]
+```
+
+Using the `-v` or `--verbose` option provides a message stack if an error occurs. The message stack is formatted as JSON.
+
+```sh-session
+$ echspec -s 7-5 -v research.cloudflare.com 2>&1 > /dev/null | jq .
+````
+
+<details>
+
+```json
+{
+  "Alert": {
+    "level": "0x02",
+    "description": "0x32"
+  },
+  "ClientHello": {
+    "msg_type": "0x01",
+    "legacy_version": "0x0303",
+    "random": "0x29142f95eb55066cdb496267d3154628685ad1dbbe5b877e66eda4af20df2c69",
+    "legacy_session_id": "0x9c557bc381f62d73ba3b99629f8fe6e347787be66c56fa99db4f6bc6fd06fd5f",
+    "cipher_suites": [
+      "0x1302",
+      "0x1303",
+      "0x1301"
+    ],
+    "legacy_compression_methods": [
+      "0x00"
+    ],
+    "extensions": {
+      "0x0000": {
+        "extension_type": "0x0000",
+        "server_name": "0x636c6f7564666c6172652d6563682e636f6d"
+      },
+      "0x002b": {
+        "extension_type": "0x002b",
+        "msg_type": "0x01",
+        "versions": [
+          "0x0304"
+        ]
+      },
+      "0x000d": {
+        "extension_type": "0x000d",
+        "supported_signature_algorithms": [
+          "0x0403",
+          "0x0503",
+          "0x0603",
+          "0x0804",
+          "0x0805",
+          "0x0806",
+          "0x0401",
+          "0x0501",
+          "0x0601"
+        ]
+      },
+      "0x000a": {
+        "extension_type": "0x000a",
+        "named_group_list": [
+          "0x0017",
+          "0x0018",
+          "0x0019"
+        ]
+      },
+      "0x0033": {
+        "extension_type": "0x0033",
+        "msg_type": "0x01",
+        "key_share_entry": [
+          {
+            "group": "0x0017",
+            "key_exchange": "0x0421747aa4234dbefc61906c165b8f1050b3346bb67f2c4ad8af9f58135888354a631b9b5c68f8ec1b6d6e67485a971bd3ff0ba6ab46da08f1524d7a4a3578c110"
+          },
+          {
+            "group": "0x0018",
+            "key_exchange": "0x046d374a61f2b75717b28b47b3fa227b51e09bb7a4ce0ea24b3cd3c946e9d4da2d54186b76812a74eb53adaa8a4451573201613b2f6301c05efb79bb6a782e88150dc3ac14aad702b8268aa8f3435d1a404166133216467aeb933247f994035fa0"
+          },
+          {
+            "group": "0x0019",
+            "key_exchange": "0x0401c90f95f64dc1e8d7d3f29f8a9103308835a2b56f5581ffc2837a1f9fcf6b23db824f01d6e4efccec78d6858aaad2fde8f02c2acc66a463c14b78e5e323b23d1b1301725b4f757811b7a31b4b5ee8016891ecb55b3fb997dd5738f6e610388f9bc85a4515efd04ab1d456e56d4e6e4a3a1e58a58ed6cf86f5dc9d7ace20afcd0af6b23b"
+          }
+        ]
+      },
+      "0xfe0d": {
+        "extension_type": "0xfe0d",
+        "type": "0x02",
+        "cipher_suite": {
+          "kdf_id": {
+            "uint16": 1
+          },
+          "aead_id": {
+            "uint16": 1
+          }
+        },
+        "config_id": 9,
+        "enc": "0xe951022abd85cc53f16c92378ba736ea9d28b3a4106a6f2865323ea04fdf4075",
+        "payload": "0xbeef20fb3063fd807f6327213a5c5e37a0d355fc67c4c3a10362f947c7b72f06514db0e6bf470efb87d0db30669331caa3723441fb2850190851a9179b8b42e1e7f78bd0d281daf631872d9f7008624e24baef48ac8e18951fed9ad7d80def0b1bec492d5c5c2c532c4c8ec32b6dd3a34522c70c64e21ca639c7f54d2c3ad72c65ffda0dc1f82df5abf0857586eb17f0df08a15770a91d5c3640cff59b49b0fb3d19cf77137cd27416470e19db21519751c3d0ae417a62641903731408b4b81e008fff641d22a3300f92c8b9330d260055677c545a8d561076ecc3a4de5639120f6c67736df87a464ca221373c3bbe8e74dfe795eb43593f1d03d8668d49c4a9a73ed6d3264d7126bcfc93a975c8848170c57322b7c1bef210235bc79fd58bb4ff202d9e75bec3d2251a2429e11e5c7876edcca0685d52e1b99f51b46d0e723975a7c9d894e5674ef8debf380e799d75bff93c13e4917296242e2cb7b99bfcb0fc7cd8f98f414ceb0ef3a63fa29efc722194b91beb354efff5215b1804b9c555d4aad36a85e6eb3536b0b66fea50c9b055fa8441a36fc61a2228e0d4cb3c5ecb1662c641adf30a70c3b1104fb9b0f9b2c3130dc52939e9695a470774bee6dabc2691d06f870d01fe249199d831258583"
+      }
+    }
+  },
+  "ClientHelloInner": {
+    "msg_type": "0x01",
+    "legacy_version": "0x0303",
+    "random": "0x99f21aebeff5838b88011e581ade4de4eb334e5528efaf223dfa33c55d7bc20b",
+    "legacy_session_id": "0x9c557bc381f62d73ba3b99629f8fe6e347787be66c56fa99db4f6bc6fd06fd5f",
+    "cipher_suites": [
+      "0x1302",
+      "0x1303",
+      "0x1301"
+    ],
+    "legacy_compression_methods": [
+      "0x00"
+    ],
+    "extensions": {
+      "0x0000": {
+        "extension_type": "0x0000",
+        "server_name": "0x72657365617263682e636c6f7564666c6172652e636f6d"
+      },
+      "0x002b": {
+        "extension_type": "0x002b",
+        "msg_type": "0x01",
+        "versions": [
+          "0x0304"
+        ]
+      },
+      "0x000d": {
+        "extension_type": "0x000d",
+        "supported_signature_algorithms": [
+          "0x0403",
+          "0x0503",
+          "0x0603",
+          "0x0804",
+          "0x0805",
+          "0x0806",
+          "0x0401",
+          "0x0501",
+          "0x0601"
+        ]
+      },
+      "0x000a": {
+        "extension_type": "0x000a",
+        "named_group_list": [
+          "0x0017",
+          "0x0018",
+          "0x0019"
+        ]
+      },
+      "0x0033": {
+        "extension_type": "0x0033",
+        "msg_type": "0x01",
+        "key_share_entry": [
+          {
+            "group": "0x0017",
+            "key_exchange": "0x0421747aa4234dbefc61906c165b8f1050b3346bb67f2c4ad8af9f58135888354a631b9b5c68f8ec1b6d6e67485a971bd3ff0ba6ab46da08f1524d7a4a3578c110"
+          },
+          {
+            "group": "0x0018",
+            "key_exchange": "0x046d374a61f2b75717b28b47b3fa227b51e09bb7a4ce0ea24b3cd3c946e9d4da2d54186b76812a74eb53adaa8a4451573201613b2f6301c05efb79bb6a782e88150dc3ac14aad702b8268aa8f3435d1a404166133216467aeb933247f994035fa0"
+          },
+          {
+            "group": "0x0019",
+            "key_exchange": "0x0401c90f95f64dc1e8d7d3f29f8a9103308835a2b56f5581ffc2837a1f9fcf6b23db824f01d6e4efccec78d6858aaad2fde8f02c2acc66a463c14b78e5e323b23d1b1301725b4f757811b7a31b4b5ee8016891ecb55b3fb997dd5738f6e610388f9bc85a4515efd04ab1d456e56d4e6e4a3a1e58a58ed6cf86f5dc9d7ace20afcd0af6b23b"
+          }
+        ]
+      },
+      "0xfe0d": {
+        "extension_type": "0xfe0d",
+        "type": "0x01",
+        "cipher_suite": null,
+        "config_id": null,
+        "enc": null,
+        "payload": null
+      }
+    }
+  }
+}
+```
+
+</details>
+
+
+## Note
+
+`echspec` is inspired by:
+
+- https://github.com/summerwind/h2spec
+
+
+## License
+
+`echspec` is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/echspec.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'echspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'echspec'
+  spec.version       = EchSpec::VERSION
+  spec.authors       = ['thekuwayama']
+  spec.email         = ['thekuwayama@gmail.com']
+  spec.summary       = 'A conformance testing tool for ECH implementation'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/thekuwayama/echspec'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>=3.2'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.bindir        = 'exe'
+  spec.executables   = ['echspec']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_dependency             'base64'
+  spec.add_dependency             'resolv', '> 0.4.0'
+  spec.add_dependency             'tttls1.3', '~> 0.3.4'
+end

data/exe/echspec

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << "#{__dir__}/../lib"
+
+require 'echspec'
+
+EchSpec::CLI.new.run

data/fixtures/echconfigs.pem

@@ -0,0 +1,7 @@
+-----BEGIN PRIVATE KEY-----
+MC4CAQAwBQYDK2VuBCIEICjd4yGRdsoP9gU7YT7My8DHx1Tjme8GYDXrOMCi8v1V
+-----END PRIVATE KEY-----
+-----BEGIN ECHCONFIG-----
+AD7+DQA65wAgACA8wVN2BtscOl3vQheUzHeIkVmKIiydUhDCliA4iyQRCwAEAAEA
+AQALZXhhbXBsZS5jb20AAA==
+-----END ECHCONFIG-----

data/fixtures/server.crt

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----
+MIIDOzCCAiOgAwIBAgIJAOOHBGEtaVlUMA0GCSqGSIb3DQEBCwUAMBwxGjAYBgNV
+BAMMEXRlc3QtaW50ZXJtZWRpYXRlMB4XDTI0MDUwMzIyNTgzOVoXDTI1MDUwMzIy
+NTgzOVowFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEFAAOC
+AQ8AMIIBCgKCAQEAyJ0/RY8esNtOCfdi3iR1VhPKpteACMybSZL+yvCr7HVWSIAF
+TK+sCN5ODdG+rnICvmmaLLF1aVwz9Jn0uW+MX3tejsDftw6CH7z/xblqPmEl2gTW
+vOdDSfJttaqSf1F+XQMadVov4YFweRAAI8uY4BTV4TLEfIK06xNNFqcMv5EmUyrv
+XEVW3ki7+7nOqMUH7nfNymR8ENU1YX8y4WpyfEyKw1Gk3PQH3iIQ5J7gqoDqlBYG
+083eLJau5qVDM/Q9Ro002tfmdpnJg+g59q9KstOQbTHKBYTP8YIotJhDOCl/fgoP
+g+r3gP6EAnMaE4XjsQTp7YDRiVnvF2lMqYC0QwIDAQABo4GHMIGEMAkGA1UdEwQC
+MAAwCwYDVR0PBAQDAgWgMBQGA1UdEQQNMAuCCWxvY2FsaG9zdDBUBggrBgEFBQcB
+AQRIMEYwIQYIKwYBBQUHMAKGFWh0dHA6Ly9sb2NhbGhvc3Q6ODA4MDAhBggrBgEF
+BQcwAYYVaHR0cDovL2xvY2FsaG9zdDo4MDgwMA0GCSqGSIb3DQEBCwUAA4IBAQA2
+ZuJuzDr3JARfqpi5C2yktW0Hiv0Dzx3g1vLeOGl6ZPPIxChxHKQ79BACM2FsVYcu
+ZGK7qGXpCMuzOuMjoCcfydXwjmoMlLtjAwXSKv5/ZT+SXWkO4weMKVQsovfBYDvr
+ktiHjJJV1ToPa1R4FsXIyNQDTByyT8D+8Fj3+et/I+JyxNrm65Rv6l+qapP6J5Fn
+oAVxoE7JFLcqvvRLH7/ggqMhUgftN4olzhUT2d6sThevsA9D6PWkcRuGvPWFMXkY
+R1ABD5sQynFvkcjjCcl+m7tOyqcmvwFFlS9X+ql4LLT8MHOOXhAGfxcD6qquVmvL
+Is1FlMw33rZEkugXwT0w
+-----END CERTIFICATE-----

data/fixtures/server.key

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEpAIBAAKCAQEAyJ0/RY8esNtOCfdi3iR1VhPKpteACMybSZL+yvCr7HVWSIAF
+TK+sCN5ODdG+rnICvmmaLLF1aVwz9Jn0uW+MX3tejsDftw6CH7z/xblqPmEl2gTW
+vOdDSfJttaqSf1F+XQMadVov4YFweRAAI8uY4BTV4TLEfIK06xNNFqcMv5EmUyrv
+XEVW3ki7+7nOqMUH7nfNymR8ENU1YX8y4WpyfEyKw1Gk3PQH3iIQ5J7gqoDqlBYG
+083eLJau5qVDM/Q9Ro002tfmdpnJg+g59q9KstOQbTHKBYTP8YIotJhDOCl/fgoP
+g+r3gP6EAnMaE4XjsQTp7YDRiVnvF2lMqYC0QwIDAQABAoIBAAzYZ2e9zUTyazcf
+fFjQVCRfKg0FeXDsIPlUtzR+tT4ebpg/0kG3HI3eJiNOYyY/rfChSbpDi/VjblQ4
+KL+tkSW//C2p0z6hEts+D9E07m+batVglUYNN3VxrMKtbv9F/uWtFYb0GmLBwKuP
+xw0uXoCNSlCcHpFWZofdeYR8zR0q7L64P8EsqjrYGOTeyQWKshHIxAAks6Xb19zW
+h4f3aBTZ3tWHCMAZj8LsGVG4O2Nx9esuKwybe0vBMkv/esyEVXEPm+RDjQtlKGqQ
+i4V03ykI6LbIwi8bk3H7jItGKX8fNK9CNMi0ZEyYgvVe5HQciJBtcaWUiBUEHhum
+N0Np7uECgYEA6jsG72P5GleyRIBAUNrN/a1yIc9b9RXZS63lCb5UMMW6rYuP8wRe
+1ARzCNhkzYoKxay3ZQHPW8deDasTXCPiIkJqRDfDRr464OQ29qBEWx4aWtVbAsuH
+8/SJK45YpvdCSxT3wBzTzzff4bAIF7yFYBJjVBEs948TrtGePlvpyBMCgYEA20Jl
+xpQUorhEXn4JOjC65FHj3hJgPus8JgPSLpjpuDs9WZBN3mRt7GIZ0Tb6gA/Yv2wn
+Ps0u2iCe7uGKC5XEQ84KrtcM+rk7mRGsdWxQqnJp6tbZbHqGqF0Y9uBqOgRiJJTm
+i9L1QiHnkrtlwMdlQRXQvPvwG4Z5OU/W4D7/SRECgYEAr/wZgdPDXZ92OTGDITzE
+eEzQ68Y4eTQpR0soQuHVr69gSvQI+7XU6cdOBt9PHX8SCON0B1gMzBBHAk3/BcOQ
+K91qqkabWZOj+UR+Z16S/ULo2kZjUv5I72pThX417XzpOjBO1PDT02VPuOnhqrPi
+IgSuzIL7HiVJzJeCJag5RjECgYBhAiuNhI7sv6JgPFtQx6aoxiKPaonyzJk8KIyh
+2T3vKSanrdUGBGEuKOlLS4vhhSFc8Dkc7CNClxQ6lMdDAOxpI4xOdw9jDvlzbAJl
+oZq/DwgVwyFHgZ56d1ZIRFo7eR0DGm42hwvESsPug8MtXAtMlJ5aPw2o4AJafRyQ
+8s54QQKBgQCnaQcbPdoNrnn1giz6s1XNKMayIfod8tPS+xnKJpGzjyDVQzEDWA05
+pEp1GFMaNXjUa8ICj/DeZ630ZfODDboTp3JVKLe+QW3U89H60AJz/0UnZ8k/fNwA
+39CfIk3ukQS4oAWpMua2s2e9Vf7zXHM/sm07R8BKo0wtoUEg3RtCYQ==
+-----END RSA PRIVATE KEY-----

data/lib/echspec/cli.rb

@@ -0,0 +1,97 @@
+module EchSpec
+  class CLI
+    # rubocop: disable Metrics/AbcSize
+    # rubocop: disable Metrics/MethodLength
+    def parse_options(argv = ARGV)
+      op = OptionParser.new
+
+      # default value
+      fpath = nil
+      port = 443
+      force_compliant = true
+      verbose = false
+      sections = nil
+
+      op.on(
+        '-f',
+        '--file FILE',
+        'path to ECHConfigs PEM file       (default resolve ECHConfigs via DNS)'
+      ) do |v|
+        fpath = v
+      end
+
+      op.on(
+        '-p',
+        '--port VALUE',
+        "server port number                (default #{port})"
+      ) do |v|
+        port = v
+      end
+
+      op.on(
+        '-n',
+        '--not-force-compliant-hpke',
+        'not force compliant ECHConfig HPKE cipher suite'
+      ) do
+        force_compliant = false
+      end
+
+      op.on(
+        '-v',
+        '--verbose',
+        'verbose mode; prints message stack if raised an error'
+      ) do
+        verbose = true
+      end
+
+      op.on(
+        '-s',
+        '--sections SECTIONS',
+        'sections to test; by the default, test all sections'
+      ) do |v|
+        sections = v.split(',')
+      end
+
+      op.banner = 'Usage: echspec [OPTIONS] <HOSTNAME>'
+      begin
+        args = op.parse(argv)
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+        warn op
+        warn "** #{e.message}"
+        exit 1
+      end
+
+      if !fpath.nil? && !File.exist?(fpath)
+        warn '** <FILE> is not found'
+        exit 1
+      end
+
+      unknowns = sections.nil? ? [] : sections - Spec.sections
+      unless unknowns.empty?
+        warn "** #{unknowns} are unknown sections"
+        exit 1
+      end
+
+      if args.length != 1
+        warn op
+        warn '** <HOSTNAME> argument is not specified'
+        exit 1
+      end
+      hostname = args[0]
+
+      [fpath, port, force_compliant, verbose, hostname, sections]
+    end
+    # rubocop: enable Metrics/AbcSize
+    # rubocop: enable Metrics/MethodLength
+
+    def run
+      fpath, port, force_compliant, verbose, hostname, sections = parse_options
+
+      if sections.nil?
+        Spec.run(fpath, port, hostname, force_compliant, verbose)
+      else
+        Spec.run_only(fpath, port, hostname, sections, verbose)
+      end
+    end
+  end
+end

data/lib/echspec/error.rb

@@ -0,0 +1,9 @@
+module EchSpec
+  module Error
+    # Generic error, common for all classes under EchSpec::Error module.
+    class Error < StandardError; end
+
+    # Raised if the server behaves unintended before the target situation.
+    class BeforeTargetSituationError < Error; end
+  end
+end