-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Common Vulnerability Scoring System.
--   
--   Use this library to parse CVSS string and compute its score.
@package cvss
@version 0.1


-- | This module provides a CVSS parser and utility functions adapted from
--   <a>https://www.first.org/cvss/v3.1/specification-document</a>
module Security.CVSS

-- | Parsed CVSS string obtained with <a>parseCVSS</a>.
data CVSS

-- | The CVSS version.
data CVSSVersion

-- | Version 3.1: <a>https://www.first.org/cvss/v3-1/</a>
CVSS31 :: CVSSVersion

-- | Version 3.0: <a>https://www.first.org/cvss/v3.0/</a>
CVSS30 :: CVSSVersion

-- | Version 2.0: <a>https://www.first.org/cvss/v2/</a>
CVSS20 :: CVSSVersion

-- | CVSS Rating obtained with <a>cvssScore</a>
data Rating
None :: Rating
Low :: Rating
Medium :: Rating
High :: Rating
Critical :: Rating

-- | Parse a CVSS string.
parseCVSS :: Text -> Either CVSSError CVSS
data CVSSError
UnknownVersion :: CVSSError
EmptyComponent :: CVSSError
MissingValue :: Text -> CVSSError
DuplicateMetric :: Text -> CVSSError
MissingRequiredMetric :: Text -> CVSSError
UnknownMetric :: Text -> CVSSError
UnknownValue :: Text -> Char -> CVSSError

-- | Format the CVSS back to its original string.
cvssVectorString :: CVSS -> Text

-- | Format the CVSS to the prefered ordered vector string.
cvssVectorStringOrdered :: CVSS -> Text

-- | Compute the base score.
cvssScore :: CVSS -> (Rating, Float)

-- | Explain the CVSS metrics.
cvssInfo :: CVSS -> [Text]
instance GHC.Classes.Eq Security.CVSS.CVSSVersion
instance GHC.Show.Show Security.CVSS.Rating
instance GHC.Classes.Ord Security.CVSS.Rating
instance GHC.Classes.Eq Security.CVSS.Rating
instance GHC.Enum.Enum Security.CVSS.Rating
instance GHC.Show.Show Security.CVSS.MetricShortName
instance GHC.Classes.Ord Security.CVSS.MetricShortName
instance Data.String.IsString Security.CVSS.MetricShortName
instance GHC.Classes.Eq Security.CVSS.MetricShortName
instance GHC.Show.Show Security.CVSS.MetricValueChar
instance GHC.Classes.Ord Security.CVSS.MetricValueChar
instance GHC.Classes.Eq Security.CVSS.MetricValueChar
instance GHC.Show.Show Security.CVSS.Metric
instance GHC.Show.Show Security.CVSS.CVSS
instance GHC.Show.Show Security.CVSS.CVSSError