ncvs

Documentation

Index

• Constants
• type Client
  • func NewClient(endpoint string, ignoreSSLCertsErrors bool) Client
• type CreateScanTemplateParams
• type DeleteScanTemplateParams
• type DescribeRulePackageAttributesParams
• type DescribeRulePackagesParams
• type DescribeScanHistoriesParams
• type DescribeScanResultsParams
• type DescribeScanTemplatesParams
• type DownloadScanResultsParams
• type ExecuteScanParams
• type Rule
• type RulePackage
• type ScanHistory
• type ScanResult
• type ScanResultTarget
• type ScanTarget
• type ScanTemplate
• type UpdateScanTemplateParams

Constants

const (
	// DefaultAPIEndPoint is https://vss.api.cloud.nifty.com
	DefaultAPIEndPoint = "https://vss.api.cloud.nifty.com"
	// DefaultAPIVersion is 2017-02-23
	DefaultAPIVersion = "2017-02-23"
)

Types

type Client

type Client interface {
	CreateScanTemplate(params CreateScanTemplateParams) (res string, err error)
	DeleteScanTemplate(params DeleteScanTemplateParams) (res string, err error)
	DescribeRulePackages(params DescribeRulePackagesParams) (res string, err error)
	DescribeRulePackageAttributes(params DescribeRulePackageAttributesParams) (res string, err error)
	DescribeScanHistories(params DescribeScanHistoriesParams) (res string, err error)
	DescribeScanResults(params DescribeScanResultsParams) (res string, err error)
	DescribeScanTemplates(params DescribeScanTemplatesParams) (res string, err error)
	DownloadScanResults(params DownloadScanResultsParams) (res string, err error)
	ExecuteScan(params ExecuteScanParams) (res string, err error)
	UpdateScanTemplate(params UpdateScanTemplateParams) (res string, err error)
}

Client interface

func NewClient

func NewClient(endpoint string, ignoreSSLCertsErrors bool) Client

NewClient returns a new API client

type CreateScanTemplateParams

type CreateScanTemplateParams struct {
	ScanTemplateName      string
	UseCustomRulePackages bool
	RulePackageNames      []string
	ScanTargets           []ScanTarget
	Description           string
	SSHPort               string
}

CreateScanTemplateParams struct

type DeleteScanTemplateParams

type DeleteScanTemplateParams struct {
	ScanTemplateName string
}

DeleteScanTemplateParams struct

type DescribeRulePackageAttributesParams

type DescribeRulePackageAttributesParams struct {
	RulePackageName string
	Marker          string
	MaxResults      int
}

DescribeRulePackageAttributesParams struct

type DescribeRulePackagesParams

type DescribeRulePackagesParams struct{}

DescribeRulePackagesParams struct

type DescribeScanHistoriesParams

type DescribeScanHistoriesParams struct {
	ScanTemplateName string
	StartTime        *time.Time
	EndTime          *time.Time
}

DescribeScanHistoriesParams struct

type DescribeScanResultsParams

type DescribeScanResultsParams struct {
	ScanHistoryUUID string
}

DescribeScanResultsParams struct

type DescribeScanTemplatesParams

type DescribeScanTemplatesParams struct {
	ScanTemplateName string
}

DescribeScanTemplatesParams struct

type DownloadScanResultsParams

type DownloadScanResultsParams struct {
	ScanHistoryUUID string
}

DownloadScanResultsParams struct

type ExecuteScanParams

type ExecuteScanParams struct {
	ScanTemplateName string
}

ExecuteScanParams struct

type Rule

type Rule struct {
	RuleName      string
	Synopsis      string
	Description   string
	Solution      string
	RiskFactor    string
	CVSSBaseScore string
}

Rule struct

type RulePackage

type RulePackage struct {
	RulePackageName string
	RuleCount       int
}

RulePackage struct

type ScanHistory

type ScanHistory struct {
	ScanHistoryUUID      string
	StartTime            string
	EndTime              string
	Status               string
	ScannedScanTargets   []ScanTarget
	UnScannedScanTargets []ScanTarget
	ScanTemplateName     string
}

ScanHistory struct

type ScanResult

type ScanResult struct {
	Rule              Rule
	Severity          int
	Count             int
	ScanResultTargets []ScanResultTarget
	ScanHistoryUUID   string
}

ScanResult struct

type ScanResultTarget

type ScanResultTarget struct {
	IPAddress string
	Port      string
}

ScanResultTarget struct

type ScanTarget

type ScanTarget struct {
	Type             string
	IPAddress        string
	Region           string
	InstanceUniqueID string `json:"InstanceUniqueId"`
}

ScanTarget struct

type ScanTemplate

type ScanTemplate struct {
	ScanTemplateName string
	RulePackageNames []string
	ScanTargets      []ScanTarget
	Description      string
	SSHPort          string
	CreatedTime      string
}

ScanTemplate struct

type UpdateScanTemplateParams

type UpdateScanTemplateParams struct {
	ScanTemplateName       string
	UpdateScanTemplateName string
	RulePackageNames       []string
	ScanTargets            []ScanTarget
	Description            string
	SSHPort                string
}

UpdateScanTemplateParams struct