tls-map 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b443ebf598bbf3d9bdf2b8073a7bf6b0ed3e554c217a20129f5c1cf5e81e134e
-  data.tar.gz: a46ee605748e824d219103d2dce0a319ea7e6101f373dd5237459f3cfbc20e1c
+  metadata.gz: 38d19c493782c2c924f851de6042244682ce65fee3e84ceb96c799691d2dddc8
+  data.tar.gz: 845222c2d50a1371ea35a7921c56094d083e9837cb5c7527b235afb3898c2570
 SHA512:
-  metadata.gz: da54cb68f0964eb013a7425c870c94664cda381dc6486c9cc356c1b6ffe2a93471c7fb1f2d0bf49d0fe6e61c92d0e72f09e568bff4bce73daecf63bd1d04a46f
-  data.tar.gz: b5b726048d4173adc23f268a4e77aeaec744fb3261642613de961cc6d7d945593ea8b4945a00d2c7a5f5cbbdc9987d9d72ec8c6037cae126456de849b8a146f2
+  metadata.gz: 386e48f96fb817faef6edef0ca05ed1a62f2ea13d64b772f7b77fd56971b08e93488daffaa7a108b8582f444482b033a67e41175153d717673e25bc1d6dbbe42
+  data.tar.gz: 701dc705ad5ca0039554a46b846f1af83885afd5f5479d155a6daa550ebc128ec6c07c96946729b36419dfc3ef8c2e7949c8e8342f389718757ecbae2cf4d019

data/bin/tls-map

@@ -78,18 +78,20 @@ begin
       ext.each do |k, v|
         case k
         when 'vulns'
-          puts "#{Paint[dic[k], :magenta]}:"
+          puts "#{Paint[dic[k][:display], :magenta]}:"
           v.each do |vuln|
-            print "  - #{Paint[sev[vuln[:severity]][:title], sev[vuln[:severity]][:color]]} - "
+            print "  - #{Paint[vuln[:name], :magenta]} "
+            print "(#{Paint[sev[vuln[:severity]][:title], sev[vuln[:severity]][:color]]}): "
             puts Paint[vuln[:description], :white]
           end
         when 'tls_version'
-          puts "#{Paint[dic[k], :magenta]}: #{Paint[v.join(', '), :white]}"
+          puts "#{Paint[dic[k][:display], :magenta]}: #{Paint[v.join(', '), :white]}"
         when 'security'
-          puts "#{Paint[dic[k], :magenta]}: #{Paint[v, sec_lvl[v][:color]]}"
+          puts "#{Paint[dic[k][:display], :magenta]}: #{Paint[v, sec_lvl[v][:color]]}"
         else
-          print "#{Paint[dic[k], :magenta]}: #{Paint[v, :white]}"
-          print " (#{tmext_i.translate_acronym(v)})" if args['--acronym'] && !tmext_i.translate_acronym(v).nil?
+          print "#{Paint[dic[k][:display], :magenta]}: #{Paint[v, :white]}"
+          term = dic[k][:model] ? dic[k][:model] + v : nil # rubocop:disable Metrics/BlockNesting
+          print " (#{tmext_i.translate_acronym(term)})" if args['--acronym'] && !tmext_i.translate_acronym(term).nil?
           puts
         end
       end

data/lib/tls_map/app/extended/ciphersuiteinfo.rb

@@ -17,7 +17,7 @@ module TLSmap
     # - https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md
     # - https://ciphersuite.info/api/
     # - https://github.com/hcrudolph/ciphersuite.info
-    class Extended
+    class Extended # rubocop:disable Metrics/ClassLength
       # Root URL of Cipher Suite Info
       ROOT = 'https://ciphersuite.info/'
       # Root URL of Cipher Suite Info API
@@ -26,17 +26,32 @@ module TLSmap
       VULN_DATA = 'https://raw.githubusercontent.com/hcrudolph/ciphersuite.info/master/directory/fixtures/00_vulnerabilities.yaml'
       # URL of the data file containing technologies information
       TECH_DATA = 'https://raw.githubusercontent.com/hcrudolph/ciphersuite.info/master/directory/fixtures/01_technologies.yaml'
-      # Hash mapping API key and display name for CLI
+      # Hash mapping API key and display name for CLI (`:display`) and model name in `01_technologies.yaml` (`:model`)
       DICO = {
-        'tls_version' => 'TLS Version(s)',
-        'protocol_version' => 'Protocol',
-        'kex_algorithm' => 'Key Exchange',
-        'auth_algorithm' => 'Authentication',
-        'enc_algorithm' => 'Encryption',
-        'hash_algorithm' => 'Hash',
-        'security' => 'Security',
-        'url' => 'More info',
-        'vulns' => 'Vulnerabilities'
+        'tls_version' => { display: 'TLS Version(s)' },
+        'protocol_version' => {
+          display: 'Protocol',
+          model: 'ProtocolVersion'
+        },
+        'kex_algorithm' => {
+          display: 'Key Exchange',
+          model: 'KexAlgorithm'
+        },
+        'auth_algorithm' => {
+          display: 'Authentication',
+          model: 'AuthAlgorithm'
+        },
+        'enc_algorithm' => {
+          display: 'Encryption',
+          model: 'EncAlgorithm'
+        },
+        'hash_algorithm' => {
+          display: 'Hash',
+          model: 'HashAlgorithm'
+        },
+        'security' => { display: 'Security' },
+        'url' => { display: 'More info' },
+        'vulns' => { display: 'Vulnerabilities' }
       }.freeze
       # Hash mapping the severity number used by the API and the severity text and color for the CLI
       VULN_SEVERITY = {
@@ -91,7 +106,8 @@ module TLSmap
       # @param caching [Boolean] if true will fetch info for all cipher suites the 1st time and used the cached value
       #   for further requests
       # @return [Hash] Hash containing advanced information. The keys are the same as {DICO}. All values are string
-      #   except `vulns` which is an array of hashes containing two keys: `:severity` (integer) and `:description`
+      #   except `vulns` which is an array of hashes containing three keys: `:severity` (integer), `:name` and
+      #   `:description`.
       #   (string). Each hash in `vulns` correspond to a vulnerability.
       def extend(iana_name, caching = false) # rubocop:disable Metrics/MethodLength
         if caching
@@ -107,8 +123,12 @@ module TLSmap
         %w[openssl_name gnutls_name hex_byte_1 hex_byte_2].each do |key|
           out.delete(key)
         end
-        out.each_value do |v|
-          out['vulns'].push(find_vuln(v)) if @tech.keys.include?(v)
+        out.each do |k, v|
+          # '' fallback since out is not containing only algorithms
+          # else calling `:model` in DICO will return nil and make the concatenation fail
+          # this handling is more explicit that using interpolation that will silently handle nil
+          alg_index = DICO[k][:model] ? DICO[k][:model] + v : ''
+          out['vulns'].push(find_vuln(alg_index)) if @tech.keys.include?(alg_index)
         end
         out['vulns'].flatten!
         out['vulns'].uniq!
@@ -116,30 +136,35 @@ module TLSmap
         out
       end
 
-      # Extract data from the YAML file ({TECH_DATA}) to craft a simplified Ruby hash
+      # Extract data from the YAML file ({TECH_DATA}) to craft a simplified Ruby hash.
+      # Note: The index key changed in 3.4.0.
       def parse_tech
         data = Psych.load_file(@tech_file)
         out = {}
         data.each do |item|
-          out.store(item['pk'], { long_name: item['fields']['long_name'],
-                                  vulnerabilities: item['fields']['vulnerabilities'] })
+          index_key = item['model'].delete_prefix('directory.') + item['pk']
+          out.store(index_key, { long_name: item['fields']['long_name'],
+                                 vulnerabilities: item['fields']['vulnerabilities'] })
         end
         out
       end
 
       # Extract data from the YAML file ({VULN_DATA}) to craft a simplified Ruby hash
+      # Note: also store name even if equal to key because find_vuln() will return only the value hash
       def parse_vuln
         data = Psych.load_file(@vuln_file)
         out = {}
         data.each do |item|
-          out.store(item['pk'], { severity: item['fields']['severity'],
+          out.store(item['pk'], { name: item['pk'],
+                                  severity: item['fields']['severity'],
                                   description: item['fields']['description'] })
         end
         out
       end
 
       # Translate cipher related acronyms
-      # @param term [String] Acronym, eg. DSS
+      # @param term [String] Acronym, eg. DSS and algorithm type. Based on `01_technologies.yaml`,
+      #   this would be the last part of `model` + `pk`. The model value is mapped in {DICO} under the `:model` sub-key.
       # @return [String] The long name of the acronym, eg. Digital Signature Standard or `nil` if it's not found
       def translate_acronym(term)
         return @tech[term][:long_name] unless @tech[term].nil?
@@ -148,7 +173,8 @@ module TLSmap
       end
 
       # Find vulnerabilities related to a technology
-      # @param tech [String] The technology acronym, eg. CBC
+      # @param tech [String] The technology acronym, eg. CBC and algorithm type. Based on `01_technologies.yaml`,
+      #   this would be the last part of `model` + `pk`. The model value is mapped in {DICO} under the `:model` sub-key.
       # @return [Array<Hash>] Array of vulnerabilities as described for {extend} return value in the `vulns` key.
       def find_vuln(tech)
         return @tech[tech][:vulnerabilities].map { |vuln| @vuln[vuln] } unless @tech[tech][:vulnerabilities].nil?

data/lib/tls_map/app/extractor/extractor.rb

@@ -123,7 +123,7 @@ module TLSmap
           #   See {TLSmap::App::Extractor}
           # @return [Array<String>] Cipher array (IANA names)
           def parse(file)
-            data = Utils.json_load_file(file)
+            data = JSON.load_file(file)
             extract_cipher(data)
           end
 
@@ -155,7 +155,7 @@ module TLSmap
           #   See {TLSmap::App::Extractor}
           # @return [Array<String>] Cipher array (IANA names)
           def parse(file)
-            data = Utils.json_load_file(file)
+            data = JSON.load_file(file)
             extract_cipher(data)
           end
 
@@ -222,7 +222,7 @@ module TLSmap
           #   See {TLSmap::App::Extractor}
           # @return [Array<String>] Cipher array (IANA names)
           def parse(file)
-            data = Utils.json_load_file(file)
+            data = JSON.load_file(file)
             extract_cipher(data)
           end
 
@@ -276,7 +276,7 @@ module TLSmap
           #   See {TLSmap::App::Extractor}
           # @return [Array<String>] Cipher array (IANA names)
           def parse(file)
-            data = Utils.json_load_file(file)
+            data = JSON.load_file(file)
             extract_cipher(data)
           end
 
@@ -321,7 +321,7 @@ module TLSmap
           #   See {TLSmap::App::Extractor}
           # @return [Array<String>] Cipher array (IANA names)
           def parse(file)
-            data = Utils.json_load_file(file)
+            data = JSON.load_file(file)
             extract_cipher(data)
           end
 

data/lib/tls_map/cli/cli.rb

@@ -56,7 +56,7 @@ module TLSmap
 
     # Offline version of {App::Extended}
     class Extended < App::Extended
-      INTEGRITY = '5a1beef438f81b819ef3e3bba1baea9bfbccc665bde4308b87a9f155eebedbef' # sha2-256
+      INTEGRITY = '257e81b3b0565e1025b0e066ce7412812b062ad63125a7dce64d29f10a6c2e65' # sha2-256
 
       # Load and parse data from marshalized hash (`data/extended.marshal`).
       # It must match the integrity check for security purpose.

data/lib/tls_map/utils/utils.rb

@@ -15,15 +15,5 @@ module TLSmap
       tmp.close
       tmp
     end
-
-    # bring JSON.load_file before ruby 3.0.0
-    # https://ruby-doc.org/stdlib-3.0.0/libdoc/json/rdoc/JSON.html#method-i-load_file
-    def self.json_load_file(filespec, opts = {})
-      if RUBY_VERSION < '3.0.0'
-        JSON.parse(File.read(filespec), opts)
-      else
-        JSON.load_file(filespec, opts)
-      end
-    end
   end
 end

data/lib/tls_map/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TLSmap
-  VERSION = '3.3.0'
+  VERSION = '3.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tls-map
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Alexandre ZANNI
@@ -37,6 +37,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: paint
   requirement: !ruby/object:Gem::Requirement