cvss-suite 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f393d3a6ec25cde0bab5b7b0a17cb54ccc28a5a
-  data.tar.gz: 7a340cc225225fa840779f93ab4058cae4b6ad6d
+  metadata.gz: 9ea284092d41dfe479cb616872fe7ec5a21df942
+  data.tar.gz: ad6f1417558619068e54d1e310d1b3f7a496bad7
 SHA512:
-  metadata.gz: b5a13cc9d130292d4c12da6627ba29bcb0e8778272375adf02a230588a26d992fc8c44b67a911e016459eaa38058543297a69ce96987a182f5d02e3c6a9dc68d
-  data.tar.gz: 288a07186dc165f4740599fbd52fc3db098f0b5289b2a030f31f1121b555c2f7c13f671911607ffc2079c0e1adb25b094b4056e2d478bf097c7d926e4ed9fe6f
+  metadata.gz: 89b23a2086ef76bf0e5858dac1bea67a3f0f5d3fb37cfc7e134bfbdd9e949faecdb7126e5191a0d74c1408f19d3d07db5b8ada00fc40bbe89f417911e952a9ae
+  data.tar.gz: 0cf55d0f5e3dbee3fccecdffdeef10b6668c644f5105e3338ce7c9100a726632103928be666bad16169e1d621ef59331c73e548681310934dd95172fe648da32

data/cvss_suite.gemspec

@@ -12,7 +12,51 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Ruby gem for processing cvss vectors.}
   spec.description   = %q{This Ruby gem helps you to process the vector of the Common Vulnerability Scoring System (https://www.first.org/cvss/specification-document).
-Besides calculating the Base, Temporal and Environmental Score, you are able to extract the selected option.}
+Besides calculating the Base, Temporal and Environmental Score, you are able to extract the selected option.
+
+Homepage is still in progress and will be published soon (along with full documentation).
+
+## Usage
+
+```ruby
+require 'cvss_suite'
+
+cvss = CvssSuite.new('AV:A/AC:M/Au:S/C:P/I:P/A:P/E:POC/RL:TF/RC:UC/CDP:L/TD:M/CR:M/IR:M/AR:M')
+
+vector = cvss.vector    # 'AV:A/AC:M/Au:S/C:P/I:P/A:P/E:POC/RL:TF/RC:UC/CDP:L/TD:M/CR:M/IR:M/AR:M'
+version = cvss.version  # 2
+
+# Scores
+base_score = cvss.base_score                        # 4.9
+temporal_score = cvss.temporal_score                # 3.6
+environmental_score = cvss.environmental_score      # 3.2
+overall_score = cvss.overall_score                  # 3.2
+
+# Available options
+access_vector = cvss.base.access_vector.name                # 'Access Vector'
+remediation_level = cvss.temporal.remediation_level.name    # 'Remediation Level'
+
+access_vector.choices.each do |choice|
+    choice[:name]           # 'Local', 'Adjacent Network', 'Network'
+    choice[:abbreviation]   # 'L', 'A', 'N'
+    choice[:selected]       # false, true, false
+end
+
+# Selected options
+cvss.base.access_vector.selected_choice[:name]          # Adjacent Network
+cvss.temporal.remediation_level.selected_choice[:name]  # Temporary Fix
+
+# Exceptions
+
+CvssSuite.new('random_string')  # will throw a RuntimeError: Vector is not valid!
+CvssSuite.new()                 # will throw a ArgumentError
+
+cvss = CvssSuite.new('AV:N/AC:P/C:P/AV:U/RL:OF/RC:C')   # invalid vector, authentication is missing
+
+version = cvss.version  # 2
+
+cvss.base_score         # will throw a RuntimeError: Vector is not valid!
+```}
   spec.homepage      = "https://github.com/siemens/cvss-suite"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or

data/lib/cvss_suite/cvss.rb

@@ -15,19 +15,19 @@ class Cvss
   attr_reader :version
 
   ##
-  # Returns the vector itself
+  # Returns the vector itself.
 
-  attr_reader :vector_string
+  attr_reader :vector
 
   ##
   # Creates a new CVSS vector by a +vector+ and a +version+.
   #
-  # Raises an exception if it is called on Cvss class
+  # Raises an exception if it is called on Cvss class.
 
   def initialize(vector, version)
     raise 'Do not instantiate this class!' if self.class == Cvss
     @version = version
-    @vector_string = vector
+    @vector = vector
     @properties = []
     extract_metrics
     init_metrics
@@ -75,7 +75,7 @@ class Cvss
 
   def prepared_vector
     start_of_vector = @vector_string.index('AV')
-    @vector_string[start_of_vector..-1]
+    @vector[start_of_vector..-1]
   end
 
   def required_amount_of_properties

data/lib/cvss_suite/version.rb

@@ -1,3 +1,3 @@
 module CvssSuite
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cvss-suite
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Oliver Hamboerger
@@ -111,6 +111,50 @@ dependencies:
 description: |-
   This Ruby gem helps you to process the vector of the Common Vulnerability Scoring System (https://www.first.org/cvss/specification-document).
   Besides calculating the Base, Temporal and Environmental Score, you are able to extract the selected option.
+
+  Homepage is still in progress and will be published soon (along with full documentation).
+
+  ## Usage
+
+  ```ruby
+  require 'cvss_suite'
+
+  cvss = CvssSuite.new('AV:A/AC:M/Au:S/C:P/I:P/A:P/E:POC/RL:TF/RC:UC/CDP:L/TD:M/CR:M/IR:M/AR:M')
+
+  vector = cvss.vector    # 'AV:A/AC:M/Au:S/C:P/I:P/A:P/E:POC/RL:TF/RC:UC/CDP:L/TD:M/CR:M/IR:M/AR:M'
+  version = cvss.version  # 2
+
+  # Scores
+  base_score = cvss.base_score                        # 4.9
+  temporal_score = cvss.temporal_score                # 3.6
+  environmental_score = cvss.environmental_score      # 3.2
+  overall_score = cvss.overall_score                  # 3.2
+
+  # Available options
+  access_vector = cvss.base.access_vector.name                # 'Access Vector'
+  remediation_level = cvss.temporal.remediation_level.name    # 'Remediation Level'
+
+  access_vector.choices.each do |choice|
+      choice[:name]           # 'Local', 'Adjacent Network', 'Network'
+      choice[:abbreviation]   # 'L', 'A', 'N'
+      choice[:selected]       # false, true, false
+  end
+
+  # Selected options
+  cvss.base.access_vector.selected_choice[:name]          # Adjacent Network
+  cvss.temporal.remediation_level.selected_choice[:name]  # Temporary Fix
+
+  # Exceptions
+
+  CvssSuite.new('random_string')  # will throw a RuntimeError: Vector is not valid!
+  CvssSuite.new()                 # will throw a ArgumentError
+
+  cvss = CvssSuite.new('AV:N/AC:P/C:P/AV:U/RL:OF/RC:C')   # invalid vector, authentication is missing
+
+  version = cvss.version  # 2
+
+  cvss.base_score         # will throw a RuntimeError: Vector is not valid!
+  ```
 email:
 - oliver.hamboerger@siemens.com
 executables: []