sdk

Documentation

Index

• Constants
• func EvaluateVulnerability(vuln *model.Vulnerability) *finding.RiskenTriage
• func StructToQueryParams(data interface{}) (string, error)
• type APIError
  • func (a APIError) Error() string
• type Client
  • func NewClient(apiEndpoint string, options ...ClientOptions) *Client
  • func (c *Client) Do(r *http.Request) (*http.Response, error)
  • func (c *Client) GetVulnerability(ctx context.Context, req *model.GetVulnerabilityRequest) (*model.GetVulnerabilityResponse, error)
  • func (c *Client) Import(ctx context.Context, req *model.ImportRequest) (*model.ImportResponse, error)
  • func (c *Client) ListProductVulnerability(ctx context.Context, req *model.ListProductVulnerabilityRequest) (*model.ListProductVulnerabilityResponse, error)
  • func (c *Client) ListVulnerability(ctx context.Context, req *model.ListVulnerabilityRequest) (*model.ListVulnerabilityResponse, error)
  • func (c *Client) NewRequest(ctx context.Context, method, path string, param string) (*http.Request, error)
• type ClientOptions
  • func WithApiKey(apiKey string) ClientOptions
• type HTTPClient

Constants

const (
	VERSION             = "0.0.1"
	USER_AGENT          = "go-vulnerability/" + VERSION
	ACCEPT_HEADER       = "application/json"
	CONTENT_TYPE_HEADER = "application/json"
)

Functions

func EvaluateVulnerability

func EvaluateVulnerability(vuln *model.Vulnerability) *finding.RiskenTriage

func StructToQueryParams

func StructToQueryParams(data interface{}) (string, error)

Types

type APIError

type APIError struct {
	// StatusCode is the HTTP response status code
	Status  int    `json:"status"`
	Message string `json:"error"`
}

func (APIError) Error

func (a APIError) Error() string

Error satisfies the error interface, and should contain the StatusCode, APIErrorObject.Message, and APIErrorObject.Code.

type Client

type Client struct {
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func NewClient

func NewClient(apiEndpoint string, options ...ClientOptions) *Client

func (*Client) Do

func (c *Client) Do(r *http.Request) (*http.Response, error)

Do sets some headers on the request, before actioning it using the internal HTTPClient. This also assumes any request body is in JSON format and sets the Content-Type to application/json.

func (*Client) GetVulnerability

func (c *Client) GetVulnerability(ctx context.Context, req *model.GetVulnerabilityRequest) (*model.GetVulnerabilityResponse, error)

func (*Client) Import

func (c *Client) Import(ctx context.Context, req *model.ImportRequest) (*model.ImportResponse, error)

func (*Client) ListProductVulnerability

func (c *Client) ListProductVulnerability(ctx context.Context, req *model.ListProductVulnerabilityRequest) (*model.ListProductVulnerabilityResponse, error)

func (*Client) ListVulnerability

func (c *Client) ListVulnerability(ctx context.Context, req *model.ListVulnerabilityRequest) (*model.ListVulnerabilityResponse, error)

func (*Client) NewRequest

func (c *Client) NewRequest(ctx context.Context, method, path string, param string) (*http.Request, error)

type ClientOptions

type ClientOptions func(*Client)

func WithApiKey

func WithApiKey(apiKey string) ClientOptions

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}