echspec 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9da986ad5207e26d816ebe08d7f8620981836c13d0dd9d695447269276a13453
-  data.tar.gz: ad7effc41c7349b011fc386ec4195d1d2dd86d51af68317d4034ad9538a9d31f
+  metadata.gz: bce9c266ff5ece6660c7adab52de934378be099778a00520e5f758acf3052aae
+  data.tar.gz: 5675044be1620e08f228fbb3b8067ababb0764522b462456d7c3534cf974c2a0
 SHA512:
-  metadata.gz: 53a725b8f4e8404f579b4b87b7d434c6146fa054f80a67147a2df2477102ecd3f7ca32db9b8827a5f00bfd1c51c0c70ec2c1575747c8a53716f682111a6d1c23
-  data.tar.gz: a0c8940990d04ff038e1ecdc4f1505a8b27f4ca87232daf08daecc9263f0a34c0cb8f14fee896d254a729102cc01d1cb7bb127f754c3ad9119b6bfb39c1487e7
+  metadata.gz: 91cb45ce9eb4672aa3c8352f21969d1cc442cce7cf4ef924e9fd9c038a9b1e29e43880428a7b6539c16eb4a6eda4527ac1b3052b85e69466f710a24e0df1517b
+  data.tar.gz: 5fed5c9dc669ad9ea2766097e1f473cbb8bc834d0f8ce5be81cd81428f6b914d5b25b55b10744e77824f03b96c5fc4b0d0dd734148dcdb8fe03b732fa95c97bc

data/.ruby-version

@@ -1 +1 @@
-4.0.1
+4.0.2

data/README.md

@@ -13,7 +13,7 @@
 
 ## Installation
 
-The gem is available at [rubygems.org](https://rubygems.org/gems/echspec). You can install it the following:
+The gem is available at [rubygems.org](https://rubygems.org/gems/echspec). You can install it with the following:
 
 ```sh-session
 $ gem install echspec
@@ -31,6 +31,15 @@ Available subcommands: run, gen_configs, version, help.
 ```sh-session
 $ echspec run --help
 Usage: echspec run [OPTIONS...] {HOSTNAME}
+
+Run ECH conformance tests for a server.
+
+Examples:
+
+  $ echspec run localhost
+  $ echspec run -f echconfigs.pem -p 4433 localhost
+
+Options:
     -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
@@ -38,7 +47,7 @@ Usage: echspec run [OPTIONS...] {HOSTNAME}
     -s, --sections SECTIONS          sections to test; by the default, test all sections
 ```
 
-You can run it the following:
+Example output:
 
 ```sh-session
 $ echspec run research.cloudflare.com
@@ -66,13 +75,13 @@ Failures:
 1 failure
 ```
 
-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:
+By default, `echspec` retrieves ECHConfigs via DNS HTTPS records. You can specify a local PEM file using the `-f, --file FILE` option. To test a server on localhost:
 
 ```sh-session
 $ echspec run -f fixtures/echconfigs.pem -p 4433 localhost
 ```
 
-By default, `echspec` uses the following HPKE cipher suite
+By default, `echspec` enforces the following mandatory HPKE cipher suite:
 
 - KEM
   - DHKEM(X25519, HKDF-SHA256)
@@ -81,13 +90,13 @@ By default, `echspec` uses the following HPKE cipher suite
 - AEAD
   - AES-128-GCM
 
-Using the `-n` or `--not-force-compliant-hpke`, you can not enforce the HPKE cipher suite.
+Use the `-n` or `--not-force-compliant-hpke` option to disable this enforcement and use the cipher suite provided in the ECHConfig.
 
 ```sh-session
 $ echspec run -f fixtures/echconfigs.pem -p 4433 -n localhost
 ```
 
-If you specify the SECTIONS, you can run only SECTIONS the following:
+To run only specific test SECTIONS, use the `-s` option:
 
 ```sh-session
 $ echspec run -f fixtures/echconfigs.pem -p 4433 -n -s 7.1.1-2,7.1.1-5 localhost
@@ -273,6 +282,21 @@ $ echspec run -s 7-5 -v research.cloudflare.com 2>&1 > /dev/null | jq .
 
 </details>
 
+You can generate an ECHConfig PEM file the following:
+
+```sh-session
+$ echspec gen_configs echconfigs.pem
+```
+```
+-----BEGIN PRIVATE KEY-----
+MC4CAQAwBQYDK2VuBCIEICjd4yGRdsoP9gU7YT7My8DHx1Tjme8GYDXrOMCi8v1V
+-----END PRIVATE KEY-----
+-----BEGIN ECHCONFIG-----
+AD7+DQA65wAgACA8wVN2BtscOl3vQheUzHeIkVmKIiydUhDCliA4iyQRCwAEAAEA
+AQALZXhhbXBsZS5jb20AAA==
+-----END ECHCONFIG-----
+```
+
 
 ## Note
 

data/lib/echspec/cli/gen_configs.rb

@@ -9,7 +9,15 @@ module EchSpec
       def parse_options(argv)
         op = OptionParser.new
 
-        op.banner = 'Usage: echspec gen_configs {FILE}'
+        op.banner = <<~USAGE
+          Usage: echspec gen_configs {FILE}
+
+          Generate an ECHConfig PEM file.
+
+          Examples:
+
+            $ echspec gen_configs echconfigs.pem
+        USAGE
 
         begin
           args = op.parse(argv)

data/lib/echspec/cli/run.rb

@@ -63,7 +63,18 @@ module EchSpec
           sections = v.split(',')
         end
 
-        op.banner = 'Usage: echspec run [OPTIONS...] {HOSTNAME}'
+        op.banner = <<~USAGE
+          Usage: echspec run [OPTIONS...] {HOSTNAME}
+
+          Run ECH conformance tests for a server.
+
+          Examples:
+
+            $ echspec run localhost
+            $ echspec run -f echconfigs.pem -p 4433 localhost
+
+          Options:
+        USAGE
 
         begin
           args = op.parse(argv)

data/lib/echspec/version.rb

@@ -1,3 +1,3 @@
 module EchSpec
-  VERSION = '0.0.4'.freeze
+  VERSION = '0.0.5'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: echspec
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - thekuwayama
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.7
+rubygems_version: 4.0.8
 specification_version: 4
 summary: A conformance testing tool for ECH implementation
 test_files: []