Documentation
      ¶
    
    
  
    
  
    Index ¶
- Variables
 - func ValidateURL(s string) error
 - func WrapConnectionError(err error) error
 - type API
 - type APIClient
 - func (client *APIClient) CreateCampaignRun(project string, token string, fuzzTarget string, ...) (string, string, error)
 - func (client *APIClient) CreateProject(name string, token string) (*Project, error)
 - func (client *APIClient) GetErrorDetails(token string) ([]finding.ErrorDetails, error)
 - func (client *APIClient) IsTokenValid(token string) (bool, error)
 - func (client *APIClient) ListProjects(token string) ([]*Project, error)
 - func (client *APIClient) StartRemoteFuzzingRun(artifact *Artifact, token string) (string, error)
 - func (client *APIClient) UploadBundle(path string, projectName string, token string) (*Artifact, error)
 - func (client *APIClient) UploadFinding(project string, fuzzTarget string, campaignRunName string, ...) error
 
- type APIError
 - type Artifact
 - type BreakPoint
 - type CAPI
 - type Campaign
 - type CampaignRun
 - type CampaignRunBody
 - type ConnectionError
 - type DebuggingInfo
 - type Environment
 - type ErrorReport
 - type Finding
 - type FindingLocation
 - type Findings
 - type FuzzTargetConfig
 - type FuzzerRunConfigurations
 - type FuzzingRun
 - type GitPath
 - type Location
 - type Metrics
 - type Project
 - type ProjectBody
 - type ProjectResponse
 - type Response
 - type Severity
 
Constants ¶
This section is empty.
Variables ¶
      View Source
      
  
var FeaturedProjectsOrganization = "organizations/1"
    Functions ¶
func ValidateURL ¶
func WrapConnectionError ¶ added in v0.24.0
WrapConnectionError wraps an error returned by the API client in a ConnectionError to avoid having the error message printed when the error is handled.
Types ¶
type APIClient ¶
type APIClient struct {
	Server string
}
    func (*APIClient) CreateCampaignRun ¶ added in v0.16.0
func (client *APIClient) CreateCampaignRun(project string, token string, fuzzTarget string, firstMetrics *report.FuzzingMetric, lastMetrics *report.FuzzingMetric, numBuildJobs uint) (string, string, error)
CreateCampaignRun creates a new campaign run for the given project and returns the name of the campaign and fuzzing run. The campaign and fuzzing run name is used to identify the campaign run in the API for consecutive calls.
func (*APIClient) CreateProject ¶ added in v0.16.0
func (*APIClient) GetErrorDetails ¶ added in v0.20.0
func (client *APIClient) GetErrorDetails(token string) ([]finding.ErrorDetails, error)
GetErrorDetails gets the error details from the API
func (*APIClient) ListProjects ¶
func (*APIClient) StartRemoteFuzzingRun ¶
func (*APIClient) UploadBundle ¶
type APIError ¶
type APIError struct {
	StatusCode int
	// contains filtered or unexported fields
}
    APIError is returned when a REST request returns a status code other than 200 OK
type BreakPoint ¶ added in v0.16.0
type BreakPoint struct {
	SourceFilePath string           `json:"source_file_path,omitempty"`
	Location       *FindingLocation `json:"location,omitempty"`
	Function       string           `json:"function,omitempty"`
}
    type CampaignRun ¶ added in v0.16.0
type CampaignRunBody ¶ added in v0.16.0
type CampaignRunBody struct {
	CampaignRun CampaignRun `json:"campaign_run"`
}
    type ConnectionError ¶ added in v0.24.0
type ConnectionError struct {
	// contains filtered or unexported fields
}
    ConnectionError is returned when a REST request fails to connect to the API
func (ConnectionError) Error ¶ added in v0.24.0
func (e ConnectionError) Error() string
func (ConnectionError) Unwrap ¶ added in v0.24.0
func (e ConnectionError) Unwrap() error
type DebuggingInfo ¶ added in v0.16.0
type DebuggingInfo struct {
	ExecutablePath string        `json:"executable_path,omitempty"`
	RunArguments   []string      `json:"run_arguments,omitempty"`
	BreakPoints    []BreakPoint  `json:"break_points,omitempty"`
	Environment    []Environment `json:"environment,omitempty"`
}
    type Environment ¶ added in v0.16.0
type ErrorReport ¶ added in v0.16.0
type ErrorReport struct {
	Logs      []string `json:"logs"`
	Details   string   `json:"details"`
	Type      string   `json:"type,omitempty"`
	InputData []byte   `json:"input_data,omitempty"`
	DebuggingInfo      *DebuggingInfo        `json:"debugging_info,omitempty"`
	HumanReadableInput string                `json:"human_readable_input,omitempty"`
	MoreDetails        *finding.ErrorDetails `json:"more_details,omitempty"`
	Tag                string                `json:"tag,omitempty"`
	ShortDescription   string                `json:"short_description,omitempty"`
}
    type FindingLocation ¶ added in v0.16.0
type FuzzTargetConfig ¶ added in v0.16.0
type FuzzerRunConfigurations ¶ added in v0.16.0
type FuzzingRun ¶ added in v0.16.0
type FuzzingRun struct {
	Name                    string                  `json:"name"`
	DisplayName             string                  `json:"display_name"`
	Status                  string                  `json:"status"`
	Metrics                 []*Metrics              `json:"metrics,omitempty"`
	FuzzerRunConfigurations FuzzerRunConfigurations `json:"fuzzer_run_configurations"`
	FuzzTargetConfig        FuzzTargetConfig        `json:"fuzz_target_config"`
}
    type Metrics ¶ added in v0.21.0
type Metrics struct {
	Timestamp                string `json:"timestamp"`
	ExecutionsPerSecond      int32  `json:"executions_per_second"`
	Features                 int32  `json:"features"`
	CorpusSize               int32  `json:"corpus_size"`
	SecondsSinceLastCoverage string `json:"seconds_since_last_coverage"`
	TotalExecutions          string `json:"total_executions"`
	Edges                    int32  `json:"edges"`
	SecondsSinceLastEdge     string `json:"seconds_since_last_edge"`
}
    type ProjectBody ¶ added in v0.16.0
type ProjectBody struct {
	Project Project `json:"project"`
}
    type ProjectResponse ¶ added in v0.16.0
 Click to show internal directories. 
   Click to hide internal directories.