whitesource

Documentation

Index

• type Alert
• type Library
• type Product
• type Project
• type Request
• type System
  • func NewSystem(serverURL, orgToken, userToken string) *System
  • func (s *System) GetMetaInfoForProduct(productName string) (Product, error)
  • func (s *System) GetOrganizationProductVitals() ([]Product, error)
  • func (s *System) GetProductByName(productName string) (*Product, error)
  • func (s *System) GetProductName(productToken string) (string, error)
  • func (s *System) GetProductsMetaInfo() ([]Product, error)
  • func (s *System) GetProjectAlerts(projectToken string) ([]Alert, error)
  • func (s *System) GetProjectByName(productToken, projectName string) (*Project, error)
  • func (s *System) GetProjectLibraryLocations(projectToken string) ([]Library, error)
  • func (s *System) GetProjectRiskReport(projectToken string) ([]byte, error)
  • func (s *System) GetProjectToken(productToken, projectName string) (string, error)
  • func (s *System) GetProjectTokens(productToken string, projectNames []string) ([]string, error)
  • func (s *System) GetProjectVitals(projectToken string) (*Project, error)
  • func (s *System) GetProjectVulnerabilityReport(projectToken string, format string) ([]byte, error)
  • func (s *System) GetProjectsByIDs(productToken string, projectIDs []int64) ([]Project, error)
  • func (s *System) GetProjectsMetaInfo(productToken string) ([]Project, error)
• type Vulnerability

Types

type Alert

type Alert struct {
	Vulnerability Vulnerability `json:"vulnerability"`
	Library       Library       `json:"library,omitempty"`
	Project       string        `json:"project,omitempty"`
	CreationDate  string        `json:"creation_date,omitempty"`
}

Alert

type Library

type Library struct {
	Name     string `json:"name,omitempty"`
	Filename string `json:"filename,omitempty"`
	Version  string `json:"version,omitempty"`
	Project  string `json:"project,omitempty"`
}

Library

type Product

type Product struct {
	Name           string `json:"name"`
	Token          string `json:"token"`
	CreationDate   string `json:"creationDate,omitempty"`
	LastUpdateDate string `json:"lastUpdatedDate,omitempty"`
}

Product defines a WhiteSource product with name and token

type Project

type Project struct {
	ID             int64  `json:"id"`
	Name           string `json:"name"`
	PluginName     string `json:"pluginName"`
	Token          string `json:"token"`
	UploadedBy     string `json:"uploadedBy"`
	CreationDate   string `json:"creationDate,omitempty"`
	LastUpdateDate string `json:"lastUpdatedDate,omitempty"`
}

Project defines a WhiteSource project with name and token

type Request

type Request struct {
	RequestType  string `json:"requestType,omitempty"`
	UserKey      string `json:"userKey,omitempty"`
	ProductToken string `json:"productToken,omitempty"`
	ProductName  string `json:"productName,omitempty"`
	ProjectToken string `json:"projectToken,omitempty"`
	OrgToken     string `json:"orgToken,omitempty"`
	Format       string `json:"format,omitempty"`
}

Request defines a request object to be sent to the WhiteSource system

type System

type System struct {
	HTTPClient piperhttp.Sender
	OrgToken   string
	ServerURL  string
	UserToken  string
}

System defines a WhiteSource system including respective tokens (e.g. org token, user token)

func NewSystem

func NewSystem(serverURL, orgToken, userToken string) *System

NewSystem constructs a new system instance

func (*System) GetMetaInfoForProduct

func (s *System) GetMetaInfoForProduct(productName string) (Product, error)

GetMetaInfoForProduct retrieves meta information for a specific WhiteSource product

func (*System) GetOrganizationProductVitals

func (s *System) GetOrganizationProductVitals() ([]Product, error)

GetOrganizationProductVitals

func (*System) GetProductByName

func (s *System) GetProductByName(productName string) (*Product, error)

GetProductByName

func (*System) GetProductName

func (s *System) GetProductName(productToken string) (string, error)

GetProductName returns the product name for a given product token

func (*System) GetProductsMetaInfo

func (s *System) GetProductsMetaInfo() ([]Product, error)

GetProductsMetaInfo retrieves meta information for all WhiteSource products a user has access to

func (*System) GetProjectAlerts

func (s *System) GetProjectAlerts(projectToken string) ([]Alert, error)

GetProjectAlerts

func (*System) GetProjectByName

func (s *System) GetProjectByName(productToken, projectName string) (*Project, error)

GetProjectByName returns the finds and returns a project by name

func (*System) GetProjectLibraryLocations

func (s *System) GetProjectLibraryLocations(projectToken string) ([]Library, error)

GetProjectLibraryLocations

func (*System) GetProjectRiskReport

func (s *System) GetProjectRiskReport(projectToken string) ([]byte, error)

GetProjectRiskReport

func (*System) GetProjectToken

func (s *System) GetProjectToken(productToken, projectName string) (string, error)

GetProjectToken returns the project token for a project with a given name

func (*System) GetProjectTokens

func (s *System) GetProjectTokens(productToken string, projectNames []string) ([]string, error)

GetProjectTokens returns the project tokens matching a given a slice of project names

func (*System) GetProjectVitals

func (s *System) GetProjectVitals(projectToken string) (*Project, error)

GetProjectVitals returns project meta info given a project token

func (*System) GetProjectVulnerabilityReport

func (s *System) GetProjectVulnerabilityReport(projectToken string, format string) ([]byte, error)

GetProjectVulnerabilityReport

func (*System) GetProjectsByIDs

func (s *System) GetProjectsByIDs(productToken string, projectIDs []int64) ([]Project, error)

GetProjectsByIDs: get all project tokens given a list of project ids

func (*System) GetProjectsMetaInfo

func (s *System) GetProjectsMetaInfo(productToken string) ([]Project, error)

GetProjectsMetaInfo retrieves meta information for a specific WhiteSource product

type Vulnerability

type Vulnerability struct {
	Name              string  `json:"name,omitempty"`
	Type              string  `json:"type,omitempty"`
	Level             string  `json:"level,omitempty"`
	Description       string  `json:"description,omitempty"`
	Severity          string  `json:"severity,omitempty"`
	CVSS3Severity     string  `json:"cvss3_severity,omitempty"`
	CVSS3Score        float64 `json:"cvss3_score,omitempty"`
	Score             float64 `json:"score,omitempty"`
	FixResolutionText string  `json:"fixResolutionText,omitempty"`
	PublishDate       string  `json:"publishDate,omitempty"`
}

Vulnerability