cvss-suite 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56e51a86060e36e855fabc461a0abb4db0478c7b
+  data.tar.gz: 3349fc1c4abc3f562a77cfa097d7b827a896f6b4
+SHA512:
+  metadata.gz: 407662ee0aa7805864cab3708227fcfd1895e3416404b1101454a8c6c7c8488bdf6fc0024aea215729ce9eadf25f2828387c3511dbd752c2e75adcd086e44423
+  data.tar.gz: 9bde83899d17518f19337fc0788392dd7edbc906322b9b522d1089456037db482b15f9e8294c5207cbc7d489a6390a8d29366575bd09457d541c47e983f1bfb5

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cvss_suite.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Hamboerger, Oliver
+
+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,88 @@
+# CvssSuite
+
+[![Gem Version](http://img.shields.io/gem/v/cvss-suite.svg)](https://rubygems.org/gems/cvss-suite)
+[![Ruby Version](https://img.shields.io/badge/Ruby-2.x-brightgreen.svg)](https://rubygems.org/gems/cvss-suite)
+[![Cvss Support](https://img.shields.io/badge/CVSS-v2-brightgreen.svg)](https://www.first.org/cvss/cvss-v2-guide.pdf)
+[![Cvss Support](https://img.shields.io/badge/CVSS-v3.0-brightgreen.svg)](https://www.first.org/cvss/cvss-v3-guide.pdf)
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cvss-suite'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cvss-suite
+
+## 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!
+```
+
+## Notable Features
+
+Properties (Access Vector, Remediation Level, etc) do have a position attribute, with this they can be ordered the same way they appear in the vector.
+
+## Known Issues
+
+Currently it is not possible to leave a attribute blank instead of ND/X. If you don't have a value for a attribute, please use ND/X instead.
+
+Because the documentation isn't clear on how to calculate the score if Modified Scope (CVSS 3.0 Environmental) is not defined, Modified Scope has to have a valid value (S/U).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cvss_suite. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cvss_suite"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cvss_suite.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cvss_suite/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cvss-suite'
+  spec.version       = CvssSuite::VERSION
+  spec.license       = 'MIT'
+  spec.authors       = ["Oliver Hamboerger"]
+  spec.email         = ["oliver.hamboerger@siemens.com"]
+
+  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.}
+  spec.homepage      = "https://github.com/siemens/cvss-suite"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
+  spec.add_development_dependency "rdoc", "~> 4.2"
+  spec.add_development_dependency "simplecov", "~> 0.11.2"
+  spec.add_development_dependency "badgerbadgerbadger", "~> 0.14.0"
+end

data/lib/cvss_suite.rb

@@ -0,0 +1,37 @@
+require 'cvss_suite/cvss2/cvss2'
+require 'cvss_suite/cvss3/cvss3'
+require 'cvss_suite/version'
+require 'cvss_suite/helpers/extensions'
+
+##
+# Module of this gem.
+
+module CvssSuite
+  CVSS_VECTOR_BEGINNINGS = [{:string => 'AV:', :version => 2}, {:string => 'CVSS:3.0/', :version => 3}]
+
+  ##
+  # Returns a CVSS class by a +vector+.
+
+  def self.new(vector)
+    @vector = vector
+    case self.version
+      when 2
+        Cvss2.new(@vector, self.version)
+      when 3
+        Cvss3.new(@vector, self.version)
+      else
+        raise 'Vector is not valid!'
+    end
+  end
+
+  private
+
+  def self.version
+    CVSS_VECTOR_BEGINNINGS.each do |beginning|
+      if @vector.start_with? beginning[:string]
+        return beginning[:version]
+      end
+    end
+  end
+
+end

data/lib/cvss_suite/cvss.rb

@@ -0,0 +1,88 @@
+
+##
+# This class represents any CVSS vector. Do not instantiate this class!
+
+class Cvss
+
+  ##
+  # Metric of a CVSS vector.
+
+  attr_reader :base, :temporal, :environmental
+
+  ##
+  # Returns version of current CVSS vector.
+
+  attr_reader :version
+
+  ##
+  # Return the vector itself
+
+  attr_reader :vector
+
+  ##
+  # Creates a new CVSS vector by a +vector+ and a +version+.
+  #
+  # 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 = vector
+    @properties = []
+    extract_metrics
+    init_metrics
+  end
+
+  ##
+  # Returns if CVSS vector is valid.
+
+  def valid?
+    if @amount_of_properties == required_amount_of_properties
+        base = @base.valid?
+        temporal = @base.valid? && @temporal.valid?
+        environmental = @base.valid? && @environmental.valid?
+        full = @base.valid? && @temporal.valid? && @environmental.valid?
+        base || temporal || environmental || full
+    else
+      false
+    end
+  end
+
+  ##
+  # Returns the Overall Score of the CVSS vector.
+
+  def overall_score
+    check_valid
+    return temporal_score if @temporal.valid? && !@environmental.valid?
+    return environmental_score if @environmental.valid?
+    base_score
+  end
+
+  private
+
+  def extract_metrics
+    properties = prepared_vector.split('/')
+    @amount_of_properties = properties.size
+    properties.each_with_index do |property, index|
+      property = property.split(':')
+      @properties.push({ name: property[0], selected: property[1], position: index })
+    end
+  end
+
+  def check_valid
+    raise 'Vector is not valid!' unless valid?
+  end
+
+  def prepared_vector
+    start_of_vector = @vector.index('AV')
+    @vector[start_of_vector..-1]
+  end
+
+  def required_amount_of_properties
+    total = @base.count if @base.valid?
+    total += @temporal.count if @temporal.valid?
+    total += @environmental.count if @environmental.valid?
+    total ||= 0
+  end
+
+end

data/lib/cvss_suite/cvss2/cvss2.rb

@@ -0,0 +1,42 @@
+require_relative '../../../lib/cvss_suite/cvss'
+require_relative 'cvss2_base'
+require_relative 'cvss2_temporal'
+require_relative 'cvss2_environmental'
+
+##
+# This class represents a CVSS vector in version 2.
+
+class Cvss2 < Cvss
+
+  ##
+  # Returns the Base Score of the CVSS vector.
+
+  def base_score
+    check_valid
+    @base.score.round(1)
+  end
+
+  ##
+  # Returns the Temporal Score of the CVSS vector.
+
+  def temporal_score
+    (base_score * @temporal.score).round(1)
+  end
+
+  ##
+  # Returns the Environmental Score of the CVSS vector.
+
+  def environmental_score
+    return temporal_score unless @environmental.valid?
+    (@environmental.score @base, @temporal.score).round(1)
+  end
+
+  private
+
+  def init_metrics
+    @base = Cvss2Base.new(@properties)
+    @temporal = Cvss2Temporal.new(@properties)
+    @environmental = Cvss2Environmental.new(@properties)
+  end
+
+end

data/lib/cvss_suite/cvss2/cvss2_base.rb

@@ -0,0 +1,81 @@
+require_relative '../cvss_property'
+require_relative '../cvss_metric'
+
+##
+# This class represents a CVSS Base metric in version 2.
+
+class Cvss2Base < CvssMetric
+
+  ##
+  # Property of this metric
+
+  attr_reader :access_vector, :access_complexity, :authentication,
+              :confidentiality_impact, :integrity_impact, :availability_impact
+
+  ##
+  # Returns the base score of the CVSS vector. The calculation is based on formula version 2.10 .
+  # See CVSS documentation for further information https://www.first.org/cvss/v2/guide#i3.2.1 .
+  #
+  # Takes +Security+ +Requirement+ +Impacts+ for calculating environmental score.
+
+  def score(sr_cr_score = 1, sr_ir_score = 1, sr_ar_score = 1)
+
+    impact = calc_impact sr_cr_score, sr_ir_score, sr_ar_score
+
+    exploitability = calc_exploitability
+
+    additional_impact = (impact == 0 ? 0 : 1.176)
+
+    ((0.6 * impact) + (0.4 * exploitability) - 1.5) * additional_impact
+
+  end
+
+  private
+
+  def init_properties
+    @properties.push(@access_vector =
+                      CvssProperty.new(name: 'Access Vector', abbreviation: 'AV', position: [0],
+                                       choices: [{ name: 'Network', abbreviation: 'N', weight: 1.0 },
+                                                 { name: 'Adjacent Network', abbreviation: 'A', weight: 0.646 },
+                                                 { name: 'Local', abbreviation: 'L', weight: 0.395 }]))
+    @properties.push(@access_complexity =
+                      CvssProperty.new(name: 'Access Complexity', abbreviation: 'AC', position: [1],
+                                       choices: [{ name: 'Low', abbreviation: 'L', weight: 0.71 },
+                                                 { name: 'Medium', abbreviation: 'M', weight: 0.61 },
+                                                 { name: 'High', abbreviation: 'H', weight: 0.35 }]))
+    @properties.push(@authentication =
+                      CvssProperty.new(name: 'Authentication', abbreviation: 'Au', position: [2],
+                                       choices: [{ name: 'None', abbreviation: 'N', weight: 0.704 },
+                                                 { name: 'Single', abbreviation: 'S', weight: 0.56 },
+                                                 { name: 'Multiple', abbreviation: 'M', weight: 0.45 }]))
+    @properties.push(@confidentiality_impact =
+                      CvssProperty.new(name: 'Confidentiality Impact', abbreviation: 'C', position: [3],
+                                       choices: [{ name: 'None', abbreviation: 'N', weight: 0.0 },
+                                                 { name: 'Partial', abbreviation: 'P', weight: 0.275 },
+                                                 { name: 'Complete', abbreviation: 'C', weight: 0.66 }]))
+    @properties.push(@integrity_impact =
+                      CvssProperty.new(name: 'Integrity Impact', abbreviation: 'I', position: [4],
+                                       choices: [{ name: 'None', abbreviation: 'N', weight: 0.0 },
+                                                 { name: 'Partial', abbreviation: 'P', weight: 0.275 },
+                                                 { name: 'Complete', abbreviation: 'C', weight: 0.66 }]))
+    @properties.push(@availability_impact =
+                      CvssProperty.new(name: 'Availability Impact', abbreviation: 'A', position: [5],
+                                       choices: [{ name: 'None', abbreviation: 'N', weight: 0.0},
+                                                 { name: 'Partial', abbreviation: 'P', weight: 0.275},
+                                                 { name: 'Complete', abbreviation: 'C', weight: 0.66}]))
+  end
+
+  def calc_impact(sr_cr_score, sr_ir_score, sr_ar_score)
+    confidentiality_score = 1 - @confidentiality_impact.score * sr_cr_score
+    integrity_score = 1 - @integrity_impact.score * sr_ir_score
+    availability_score = 1 - @availability_impact.score * sr_ar_score
+
+    [10, 10.41 * (1-confidentiality_score*integrity_score*availability_score)].min
+  end
+
+  def calc_exploitability
+    20 * @access_vector.score * @access_complexity.score * @authentication.score
+  end
+
+end
+