tls_test_kit 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9e86fe670defe8dcef4e4bf3f6b8b3ce5735cbf16e4f310af4c184f5296820e
-  data.tar.gz: 57bfbbaf77019e48772fc630a38c06d132cd657473da98ba3c9ad2b76ac3a717
+  metadata.gz: 42d0044850c2fe830f8eb8414ff15e50067ec4ff941b16ac6a61ce14a3a38866
+  data.tar.gz: bbf4fd286f2c64e1aeb2062ad869b0cc4d45435e3d0f1f14e9f09080cfa78079
 SHA512:
-  metadata.gz: 0cb474ee952738a914e1cb92710ca1647d71193c26d090c8f9152faefbbbf067109cb62455222f39797fa993522fe0867346b7a4ed241a510c5f415ee1fa9a40
-  data.tar.gz: 257f0f11a10809e8da3d7ca0ad35e5317159a64a5336e52b21ab478d324511be0b375e21bbee0e2bf0d6ee2b47179b8cb0e8718bfdacd74a089ccafe45a36064
+  metadata.gz: 808eaf09babb6f5b8d99f297de81a083f5abe14791891ccc07abb56a822480a603ea3edac1ac8fac4be283c6028067e89b672ea6e0b20a8179fe1829a9699508
+  data.tar.gz: ca72092347adf71c0076d492b9040616fbe46ab23f2c136a2b68345188c7431802e3a96b2539509ee89300e085eaaa99cbce011c78bb0a3934446adbe51ed62a

data/lib/tls_test_kit/metadata.rb

@@ -0,0 +1,36 @@
+# metadata.rb
+
+require_relative 'version'
+
+module TLSTestKit
+  # Although the TLS Test Kit is not hosted on the deployment platform,
+  # let's have it conform to the platform_deployable_test_kit spec anyways
+  # since its a dependency.
+  class Metadata < Inferno::TestKit
+    id :tls_test_kit
+    title 'TLS Test Kit'
+    suite_ids ['tls']
+    tags []
+    last_updated TLSTestKit::LAST_UPDATED
+    version TLSTestKit::VERSION
+    maturity 'Medium'
+    authors ['Stephen MacVicar']
+    repo 'https://github.com/inferno-framework/tls-test-kit'
+    description <<~DESCRIPTION
+      This is an [Inferno](https://inferno-framework.github.io/) Test Kit for 
+      TLS connections.
+      <!-- break -->
+      ## Repository
+
+      The TLS Test Kit GitHub repository can be
+      [found here](https://github.com/inferno-framework/tls-test-kit).
+
+      ## Providing Feedback and Reporting Issues
+
+      We welcome feedback on the Test Kit. Please report any issues with this 
+      set of tests in the 
+      [issues section](https://github.com/inferno-framework/tls-test-kit/issues)
+      of the repository.
+    DESCRIPTION
+  end
+end

data/lib/tls_test_kit/tls_test_suite.rb

@@ -0,0 +1,43 @@
+require_relative 'tls_version_test'
+
+module TLSTestKit
+  class TLSTestSuite < Inferno::TestSuite
+    title 'TLS Tests'
+    id :tls
+
+    group do
+      title 'TLS Tests'
+
+      test from: :tls_version_test,
+           title: 'Server only supports secure versions of TLS',
+           description: %(
+             This test verifies that a server supports at least one version of
+             TLS >= 1.2. TLS versions below 1.2 were [deprecated in RFC
+             8666](https://datatracker.ietf.org/doc/html/rfc8996).
+           ),
+           config: {
+             options: {
+               minimum_allowed_version: OpenSSL::SSL::TLS1_2_VERSION
+             }
+           }
+    end
+
+    links [
+      {
+        type: 'report_issue',
+        label: 'Report Issue',
+        url: 'https://github.com/inferno-framework/tls-test-kit/issues/'
+      },
+      {
+        type: 'source_code',
+        label: 'Open Source',
+        url: 'https://github.com/inferno-framework/tls-test-kit/'
+      },
+      {
+        type: 'download',
+        label: 'Download', 
+        url: 'https://github.com/inferno-framework/tls-test-kit/releases/'
+      }
+    ]
+  end
+end

data/lib/tls_test_kit/tls_version_test.rb

@@ -1,4 +1,22 @@
 module TLSTestKit
+  # @example
+  #   require 'tls_test_kit'
+  #   
+  #   test from: :tls_version_test do
+  #     config(
+  #       inputs: {
+  #         url: {
+  #           title: 'URL whose TLS connections will be tested'
+  #         }
+  #       },
+  #       options: {
+  #         minimum_allowed_version: OpenSSL::SSL::TLS1_1_VERSION,
+  #         maximum_allowed_version: OpenSSL::SSL::TLS1_2_VERSION,
+  #         required_versions: [OpenSSL::SSL::TLS1_2_VERSION],
+  #         incorrectly_permitted_tls_version_message_type: 'warning'
+  #       }
+  #     )
+  #   end
   class TLSVersionTest < Inferno::Test
     title 'Server supports TLS'
     description %(

data/lib/tls_test_kit/version.rb

@@ -0,0 +1,6 @@
+# version.rb
+
+module TLSTestKit
+  VERSION = '0.3.0'.freeze
+  LAST_UPDATED = '2025-02-10'.freeze # TODO update next release
+end

data/lib/tls_test_kit.rb

@@ -1,25 +1,5 @@
-require_relative './tls_test_kit/tls_version_test'
+require_relative './tls_test_kit/metadata'
+require_relative './tls_test_kit/tls_test_suite'
 
 module TLSTestKit
-  class TLSTestSuite < Inferno::TestSuite
-    title 'TLS Tests'
-    id :tls
-
-    group do
-      title 'TLS Tests'
-
-      test from: :tls_version_test,
-           title: 'Server only supports secure versions of TLS',
-           description: %(
-             This test verifies that a server supports at least one version of
-             TLS >= 1.2. TLS versions below 1.2 were [deprecated in RFC
-             8666](https://datatracker.ietf.org/doc/html/rfc8996).
-           ),
-           config: {
-             options: {
-               minimum_allowed_version: OpenSSL::SSL::TLS1_2_VERSION
-             }
-           }
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tls_test_kit
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Stephen MacVicar
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-29 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inferno_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: database_cleaner-sequel
   requirement: !ruby/object:Gem::Requirement
@@ -89,13 +89,17 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - lib/tls_test_kit.rb
+- lib/tls_test_kit/metadata.rb
+- lib/tls_test_kit/tls_test_suite.rb
 - lib/tls_test_kit/tls_version_test.rb
+- lib/tls_test_kit/version.rb
 homepage: https://github.com/inferno-framework/tls-test-kit
 licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://github.com/inferno-framework/tls-test-kit
   source_code_uri: https://github.com/inferno-framework/tls-test-kit
+  inferno_test_kit: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -104,14 +108,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.2
+      version: 3.3.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Inferno tests for server TLS support