ghsa

Documentation

Index

• type Advisory
• type Config
  • func NewConfig(client GithubClient) Config
  • func (c Config) Update() error
• type FirstPatchedVersion
• type GetVulnerabilitiesQuery
• type GitHubClient
• type GithubCVSS
• type GithubClient
• type GithubSecurityAdvisory
• type GithubSecurityAdvisoryJson
• type Identifier
• type Package
• type PageInfo
• type Reference
• type SecurityAdvisoryEcosystem
• type SecurityVulnerabilities
• type Version

Types

type Advisory

type Advisory struct {
	DatabaseId  int
	Id          string
	GhsaId      string
	References  []Reference
	Identifiers []Identifier
	Description string
	Origin      string
	PublishedAt string
	Severity    string
	Summary     string
	UpdatedAt   string
	WithdrawnAt string
	CVSS        GithubCVSS
}

type Config

type Config struct {
	// contains filtered or unexported fields
}

func NewConfig

func NewConfig(client GithubClient) Config

func (Config) Update

func (c Config) Update() error

type FirstPatchedVersion

type FirstPatchedVersion struct {
	Identifier string
}

type GetVulnerabilitiesQuery

type GetVulnerabilitiesQuery struct {
	SecurityVulnerabilities `graphql:"securityVulnerabilities(ecosystem: $ecosystem, first: $total, after: $cursor)"`
}

type GitHubClient

type GitHubClient struct {
	ApiKey string
}

type GithubCVSS

type GithubCVSS struct {
	Score        float32
	VectorString string
}

type GithubClient

type GithubClient interface {
	Query(ctx context.Context, q interface{}, variables map[string]interface{}) error
}

type GithubSecurityAdvisory

type GithubSecurityAdvisory struct {
	Severity               string
	UpdatedAt              string
	Package                Package
	Advisory               Advisory
	FirstPatchedVersion    FirstPatchedVersion
	VulnerableVersionRange string
}

type GithubSecurityAdvisoryJson

type GithubSecurityAdvisoryJson struct {
	Severity  string
	UpdatedAt string
	Package   Package
	Advisory  Advisory
	Versions  []Version
}

type Identifier

type Identifier struct {
	Type  string
	Value string
}

type Package

type Package struct {
	Ecosystem string
	Name      string
}

type PageInfo

type PageInfo struct {
	EndCursor   githubql.String
	HasNextPage bool
}

type Reference

type Reference struct {
	Url string
}

type SecurityAdvisoryEcosystem

type SecurityAdvisoryEcosystem string

https://developer.github.com/v4/enum/securityadvisoryecosystem/

var (
	Composer   SecurityAdvisoryEcosystem = "COMPOSER"
	Maven      SecurityAdvisoryEcosystem = "MAVEN"
	Npm        SecurityAdvisoryEcosystem = "NPM"
	Nuget      SecurityAdvisoryEcosystem = "NUGET"
	Pip        SecurityAdvisoryEcosystem = "PIP"
	Rubygems   SecurityAdvisoryEcosystem = "RUBYGEMS"
	Go         SecurityAdvisoryEcosystem = "GO"
	Rust       SecurityAdvisoryEcosystem = "RUST"
	Erlang     SecurityAdvisoryEcosystem = "ERLANG"
	Ecosystems                           = []SecurityAdvisoryEcosystem{Composer, Maven, Npm, Nuget, Pip, Rubygems, Go, Erlang, Rust}
)

type SecurityVulnerabilities

type SecurityVulnerabilities struct {
	Nodes    []GithubSecurityAdvisory
	PageInfo PageInfo
}

type Version

type Version struct {
	FirstPatchedVersion    FirstPatchedVersion
	VulnerableVersionRange string
}