Security.CVSS

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

Type

data CVSS

Parsed CVSS string obtained with parseCVSS.

Instances

Show CVSS

Defined in Security.CVSS

Methods

showsPrec :: Int -> CVSS -> ShowS

show :: CVSS -> String

showList :: [CVSS] -> ShowS

data CVSSVersion

The CVSS version.

Constructors

CVSS31

Version 3.1: https://www.first.org/cvss/v3-1/

CVSS30

Version 3.0: https://www.first.org/cvss/v3.0/

CVSS20

Version 2.0: https://www.first.org/cvss/v2/

Instances

Eq CVSSVersion

Defined in Security.CVSS

Methods

(==) :: CVSSVersion -> CVSSVersion -> Bool

(/=) :: CVSSVersion -> CVSSVersion -> Bool

data Rating

CVSS Rating obtained with cvssScore

Constructors

None

Low

Medium

High

Critical

Instances

Enum Rating

Defined in Security.CVSS

Methods

succ :: Rating -> Rating

pred :: Rating -> Rating

toEnum :: Int -> Rating

fromEnum :: Rating -> Int

enumFrom :: Rating -> [Rating]

enumFromThen :: Rating -> Rating -> [Rating]

enumFromTo :: Rating -> Rating -> [Rating]

enumFromThenTo :: Rating -> Rating -> Rating -> [Rating]

Show Rating

Defined in Security.CVSS

Methods

showsPrec :: Int -> Rating -> ShowS

show :: Rating -> String

showList :: [Rating] -> ShowS

Eq Rating

Defined in Security.CVSS

Methods

(==) :: Rating -> Rating -> Bool

(/=) :: Rating -> Rating -> Bool

Ord Rating

Defined in Security.CVSS

Methods

compare :: Rating -> Rating -> Ordering

(<) :: Rating -> Rating -> Bool

(<=) :: Rating -> Rating -> Bool

(>) :: Rating -> Rating -> Bool

(>=) :: Rating -> Rating -> Bool

max :: Rating -> Rating -> Rating

min :: Rating -> Rating -> Rating

Parser

parseCVSS :: Text -> Either CVSSError CVSS

Parse a CVSS string.

data CVSSError

Constructors

UnknownVersion

EmptyComponent

MissingValue Text

DuplicateMetric Text

MissingRequiredMetric Text

UnknownMetric Text

UnknownValue Text Char

Instances

Show CVSSError

Defined in Security.CVSS

Methods

showsPrec :: Int -> CVSSError -> ShowS

show :: CVSSError -> String

showList :: [CVSSError] -> ShowS

Helpers

cvssVectorString :: CVSS -> Text

Format the CVSS back to its original string.

cvssVectorStringOrdered :: CVSS -> Text

Format the CVSS to the prefered ordered vector string.

cvssScore :: CVSS -> (Rating, Float)

Compute the base score.

cvssInfo :: CVSS -> [Text]

Explain the CVSS metrics.