report

Documentation

Overview

Copyright 2023 WeFuzz Research and Development B.V.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• type Attachment
  • func (a *Attachment) Hash() []byte
• type Attribute
  • func (a *Attribute) Hash() []byte
• type Author
  • func (a *Author) Hash() []byte
• type Platform
• type VulnerabilityReport
  • func LoadReport(fileRef string) (VulnerabilityReport, error)

Variables

var (
	ErrInvalidVersion       = errors.New("invalid version")
	ErrorInvalidTitle       = errors.New("invalid title")
	ErrorInvalidDescription = errors.New("invalid description")
	ErrorInvalidAttributes  = errors.New("invalid attributes")
	ErrorInvalidAuthor      = errors.New("invalid author")
	ErrorInvalidPlatform    = errors.New("invalid platform")
	ErrorInvalidSeverity    = errors.New("invalid severity")
	ErrorInvalidAttachments = errors.New("invalid attachments")
	ErrorInvalidAuthorName  = errors.New("invalid author name")
	ErrorInvalidAuthorURL   = errors.New("invalid author url")
	ErrorInvalidAuthorEmail = errors.New("invalid author email")
)

Types

type Attachment

type Attachment struct {
	// Name of the attachment
	Name string `yaml:"name"`

	// Path of the attachment
	Path string `yaml:"path"`
}

func (*Attachment) Hash

func (a *Attachment) Hash() []byte

type Attribute

type Attribute struct {
	// Key of the attribute
	Name string `yaml:"name"`

	// Value of the attribute
	Value string `yaml:"value"`
}

func (*Attribute) Hash

func (a *Attribute) Hash() []byte

type Author

type Author struct {
	// Name of the author
	Name string `yaml:"name"`

	// URL of the author
	URL string `yaml:"url"`

	// Email of the author
	Email string `yaml:"email"`
}

func (*Author) Hash

func (a *Author) Hash() []byte

type Platform

type Platform string

const (
	// HackerOne is the HackerOne platform
	HackerOnePlatform Platform = "hackerone"

	// BugCrowd is the BugCrowd platform
	BugCrowdPlatform Platform = "bugcrowd"

	// Intigriti is the Intigriti platform
	IntigritiPlatform Platform = "intigriti"

	// YesWeHack is the YesWeHack platform
	YesWeHackPlatform Platform = "yeswehack"

	// Synack is the Synack platform
	SynackPlatform Platform = "synack"

	// OpenBugBounty is the OpenBugBounty platform
	OpenBugBountyPlatform Platform = "openbugbounty"

	// Yōkai is the Yōkai platform
	YōkaiPlatform Platform = "yokai"
)

type VulnerabilityReport

type VulnerabilityReport struct {
	// The version of the report file.
	Version string `yaml:"version"`

	// Title of the report
	Title string `yaml:"title"`

	// Description of the report
	Description string `yaml:"description"`

	// Attributes of the report: list of key value pairs: e.g. "CVE": "CVE-2021-1234"
	Attributes []Attribute `yaml:"attributes"`

	// Author of the report
	Author Author `yaml:"author"`

	// Platform of the report
	Platform Platform `yaml:"platform"`

	// Severity of the report
	Severity string `yaml:"severity"`

	// Attachments of the report
	Attachments []Attachment `yaml:"attachments"`
}

This is the vulnerability report structure YAML file passed as input to generate the Signature.

func LoadReport

func LoadReport(fileRef string) (VulnerabilityReport, error)