ecluse
Safe HaskellNone
LanguageGHC2021

Ecluse.Pilot.Osv

Synopsis

Documentation

data OsvAdvisory Source #

Exact model of what osv.dev makes available

Constructors

OsvAdvisory 

Fields

Instances

Instances details
FromJSON OsvAdvisory Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

parseJSON :: Value -> Parser OsvAdvisory Source #

parseJSONList :: Value -> Parser [OsvAdvisory] Source #

omittedField :: Maybe OsvAdvisory Source #

Generic OsvAdvisory Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Associated Types

type Rep OsvAdvisory 
Instance details

Defined in Ecluse.Pilot.Osv

type Rep OsvAdvisory = D1 ('MetaData "OsvAdvisory" "Ecluse.Pilot.Osv" "ecluse-0.1.0-inplace" 'False) (C1 ('MetaCons "OsvAdvisory" 'PrefixI 'True) (S1 ('MetaSel ('Just "osvId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "osvAffected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OsvAffected])) :*: S1 ('MetaSel ('Just "osvDatabaseSpecific") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OsvDatabaseSpecific)))))

Methods

from :: OsvAdvisory -> Rep OsvAdvisory x #

to :: Rep OsvAdvisory x -> OsvAdvisory #

Show OsvAdvisory Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

showsPrec :: Int -> OsvAdvisory -> ShowS #

show :: OsvAdvisory -> String #

showList :: [OsvAdvisory] -> ShowS #

Eq OsvAdvisory Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

(==) :: OsvAdvisory -> OsvAdvisory -> Bool #

(/=) :: OsvAdvisory -> OsvAdvisory -> Bool #

type Rep OsvAdvisory Source # 
Instance details

Defined in Ecluse.Pilot.Osv

type Rep OsvAdvisory = D1 ('MetaData "OsvAdvisory" "Ecluse.Pilot.Osv" "ecluse-0.1.0-inplace" 'False) (C1 ('MetaCons "OsvAdvisory" 'PrefixI 'True) (S1 ('MetaSel ('Just "osvId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "osvAffected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OsvAffected])) :*: S1 ('MetaSel ('Just "osvDatabaseSpecific") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OsvDatabaseSpecific)))))

data OsvAffected Source #

Constructors

OsvAffected 

Fields

Instances

Instances details
FromJSON OsvAffected Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

parseJSON :: Value -> Parser OsvAffected Source #

parseJSONList :: Value -> Parser [OsvAffected] Source #

omittedField :: Maybe OsvAffected Source #

Generic OsvAffected Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Associated Types

type Rep OsvAffected 
Instance details

Defined in Ecluse.Pilot.Osv

type Rep OsvAffected = D1 ('MetaData "OsvAffected" "Ecluse.Pilot.Osv" "ecluse-0.1.0-inplace" 'False) (C1 ('MetaCons "OsvAffected" 'PrefixI 'True) (S1 ('MetaSel ('Just "affectedPackage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OsvPackage) :*: S1 ('MetaSel ('Just "affectedRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OsvRange]))))

Methods

from :: OsvAffected -> Rep OsvAffected x #

to :: Rep OsvAffected x -> OsvAffected #

Show OsvAffected Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

showsPrec :: Int -> OsvAffected -> ShowS #

show :: OsvAffected -> String #

showList :: [OsvAffected] -> ShowS #

Eq OsvAffected Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

(==) :: OsvAffected -> OsvAffected -> Bool #

(/=) :: OsvAffected -> OsvAffected -> Bool #

type Rep OsvAffected Source # 
Instance details

Defined in Ecluse.Pilot.Osv

type Rep OsvAffected = D1 ('MetaData "OsvAffected" "Ecluse.Pilot.Osv" "ecluse-0.1.0-inplace" 'False) (C1 ('MetaCons "OsvAffected" 'PrefixI 'True) (S1 ('MetaSel ('Just "affectedPackage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OsvPackage) :*: S1 ('MetaSel ('Just "affectedRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OsvRange]))))

data OsvPackage Source #

Constructors

OsvPackage 

Fields

Instances

Instances details
FromJSON OsvPackage Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

parseJSON :: Value -> Parser OsvPackage Source #

parseJSONList :: Value -> Parser [OsvPackage] Source #

omittedField :: Maybe OsvPackage Source #

Generic OsvPackage Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Associated Types

type Rep OsvPackage 
Instance details

Defined in Ecluse.Pilot.Osv

type Rep OsvPackage = D1 ('MetaData "OsvPackage" "Ecluse.Pilot.Osv" "ecluse-0.1.0-inplace" 'False) (C1 ('MetaCons "OsvPackage" 'PrefixI 'True) (S1 ('MetaSel ('Just "packageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "packageEcosystem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

Methods

from :: OsvPackage -> Rep OsvPackage x #

to :: Rep OsvPackage x -> OsvPackage #

Show OsvPackage Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

showsPrec :: Int -> OsvPackage -> ShowS #

show :: OsvPackage -> String #

showList :: [OsvPackage] -> ShowS #

Eq OsvPackage Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

(==) :: OsvPackage -> OsvPackage -> Bool #

(/=) :: OsvPackage -> OsvPackage -> Bool #

type Rep OsvPackage Source # 
Instance details

Defined in Ecluse.Pilot.Osv

type Rep OsvPackage = D1 ('MetaData "OsvPackage" "Ecluse.Pilot.Osv" "ecluse-0.1.0-inplace" 'False) (C1 ('MetaCons "OsvPackage" 'PrefixI 'True) (S1 ('MetaSel ('Just "packageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "packageEcosystem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

data OsvRange Source #

Constructors

OsvRange 

Fields

Instances

Instances details
FromJSON OsvRange Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

parseJSON :: Value -> Parser OsvRange Source #

parseJSONList :: Value -> Parser [OsvRange] Source #

omittedField :: Maybe OsvRange Source #

Generic OsvRange Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Associated Types

type Rep OsvRange 
Instance details

Defined in Ecluse.Pilot.Osv

type Rep OsvRange = D1 ('MetaData "OsvRange" "Ecluse.Pilot.Osv" "ecluse-0.1.0-inplace" 'False) (C1 ('MetaCons "OsvRange" 'PrefixI 'True) (S1 ('MetaSel ('Just "rangeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "rangeEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [OsvEvent])))

Methods

from :: OsvRange -> Rep OsvRange x #

to :: Rep OsvRange x -> OsvRange #

Show OsvRange Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

showsPrec :: Int -> OsvRange -> ShowS #

show :: OsvRange -> String #

showList :: [OsvRange] -> ShowS #

Eq OsvRange Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

(==) :: OsvRange -> OsvRange -> Bool #

(/=) :: OsvRange -> OsvRange -> Bool #

type Rep OsvRange Source # 
Instance details

Defined in Ecluse.Pilot.Osv

type Rep OsvRange = D1 ('MetaData "OsvRange" "Ecluse.Pilot.Osv" "ecluse-0.1.0-inplace" 'False) (C1 ('MetaCons "OsvRange" 'PrefixI 'True) (S1 ('MetaSel ('Just "rangeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "rangeEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [OsvEvent])))

data OsvEvent Source #

Constructors

OsvEvent 

Fields

Instances

Instances details
FromJSON OsvEvent Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

parseJSON :: Value -> Parser OsvEvent Source #

parseJSONList :: Value -> Parser [OsvEvent] Source #

omittedField :: Maybe OsvEvent Source #

Generic OsvEvent Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Associated Types

type Rep OsvEvent 
Instance details

Defined in Ecluse.Pilot.Osv

type Rep OsvEvent = D1 ('MetaData "OsvEvent" "Ecluse.Pilot.Osv" "ecluse-0.1.0-inplace" 'False) (C1 ('MetaCons "OsvEvent" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventIntroduced") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eventFixed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

Methods

from :: OsvEvent -> Rep OsvEvent x #

to :: Rep OsvEvent x -> OsvEvent #

Show OsvEvent Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

showsPrec :: Int -> OsvEvent -> ShowS #

show :: OsvEvent -> String #

showList :: [OsvEvent] -> ShowS #

Eq OsvEvent Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

(==) :: OsvEvent -> OsvEvent -> Bool #

(/=) :: OsvEvent -> OsvEvent -> Bool #

type Rep OsvEvent Source # 
Instance details

Defined in Ecluse.Pilot.Osv

type Rep OsvEvent = D1 ('MetaData "OsvEvent" "Ecluse.Pilot.Osv" "ecluse-0.1.0-inplace" 'False) (C1 ('MetaCons "OsvEvent" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventIntroduced") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eventFixed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newtype OsvDatabaseSpecific Source #

The subset of an advisory's database_specific block the pipeline consumes.

Constructors

OsvDatabaseSpecific 

Fields

  • dbsSeverity :: Maybe Text

    The source database's qualitative severity label (for GHSA-sourced npm advisories: LOW, MODERATE, HIGH, or CRITICAL).

Instances

Instances details
FromJSON OsvDatabaseSpecific Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

parseJSON :: Value -> Parser OsvDatabaseSpecific Source #

parseJSONList :: Value -> Parser [OsvDatabaseSpecific] Source #

omittedField :: Maybe OsvDatabaseSpecific Source #

Generic OsvDatabaseSpecific Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Associated Types

type Rep OsvDatabaseSpecific 
Instance details

Defined in Ecluse.Pilot.Osv

type Rep OsvDatabaseSpecific = D1 ('MetaData "OsvDatabaseSpecific" "Ecluse.Pilot.Osv" "ecluse-0.1.0-inplace" 'True) (C1 ('MetaCons "OsvDatabaseSpecific" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbsSeverity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

Methods

from :: OsvDatabaseSpecific -> Rep OsvDatabaseSpecific x #

to :: Rep OsvDatabaseSpecific x -> OsvDatabaseSpecific #

Show OsvDatabaseSpecific Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

showsPrec :: Int -> OsvDatabaseSpecific -> ShowS #

show :: OsvDatabaseSpecific -> String #

showList :: [OsvDatabaseSpecific] -> ShowS #

Eq OsvDatabaseSpecific Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

(==) :: OsvDatabaseSpecific -> OsvDatabaseSpecific -> Bool #

(/=) :: OsvDatabaseSpecific -> OsvDatabaseSpecific -> Bool #

type Rep OsvDatabaseSpecific Source # 
Instance details

Defined in Ecluse.Pilot.Osv

type Rep OsvDatabaseSpecific = D1 ('MetaData "OsvDatabaseSpecific" "Ecluse.Pilot.Osv" "ecluse-0.1.0-inplace" 'True) (C1 ('MetaCons "OsvDatabaseSpecific" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbsSeverity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

data ExtractedOsv Source #

The necessary subset of data requested by the goal: package names, ecosystem identifiers, cve_id, and remediation boundaries.

Constructors

ExtractedOsv 

Fields

Instances

Instances details
Show ExtractedOsv Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

showsPrec :: Int -> ExtractedOsv -> ShowS #

show :: ExtractedOsv -> String #

showList :: [ExtractedOsv] -> ShowS #

Eq ExtractedOsv Source # 
Instance details

Defined in Ecluse.Pilot.Osv

Methods

(==) :: ExtractedOsv -> ExtractedOsv -> Bool #

(/=) :: ExtractedOsv -> ExtractedOsv -> Bool #

extractFromAdvisory :: OsvAdvisory -> [ExtractedOsv] Source #

osvExportUrl :: Text -> Text -> String Source #

An ecosystem's advisory export under an OSV-layout base URL (<base>/<ecosystem>/all.zip): a zip archive of every advisory currently published for the ecosystem. The base comes from configuration (osvExportBaseUrl), so a moved or mirrored upstream never needs a new binary; a trailing slash on the base is tolerated.

>>> osvExportUrl "https://osv-vulnerabilities.storage.googleapis.com/" "npm"
"https://osv-vulnerabilities.storage.googleapis.com/npm/all.zip"