Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func StartDASTScan ¶ added in v0.4.0
func StartDASTScan(dast *DAST, nullifyClient *client.NullifyClient) error
func StartLocalScan ¶ added in v0.2.0
func StartLocalScan(nullifyClient *client.NullifyClient, input *StartLocalScanInput) error
Types ¶
type DAST ¶ added in v0.4.0
type DAST struct {
AppName string `arg:"--app-name" help:"The unique name of the app to be scanned, you can set this to anything e.g. Core API"`
Path string `arg:"--spec-path" help:"The file path to the OpenAPI file (both yaml and json are supported) e.g. ./openapi.yaml"`
TargetHost string `arg:"--target-host" help:"The base URL of the API to be scanned e.g. https://api.nullify.ai"`
GitHubOwner string `` /* 126-byte string literal not displayed */
GitHubRepository string `arg:"--github-repo" help:"The repository name to create the Nullify issue dashboard in e.g. cli"`
AuthHeaders []string `arg:"--header" help:"List of headers for the DAST agent to authenticate with your API"`
Local bool `arg:"--local" help:"Test the given app locally for bugs and vulnerabilities in private networks"`
Version string `arg:"--version" default:"latest" help:"Version of the DAST local image that is used for scanning"`
}
type StartLocalScanInput ¶ added in v0.2.0
type StartLocalScanInput struct {
AppName string `json:"appName"`
TargetHost string `json:"targetHost"`
Version string `json:"version"`
OpenAPISpec map[string]any `json:"openAPISpec"`
AuthConfig models.AuthConfig `json:"authConfig"`
NullifyToken string `json:"nullifyToken"`
models.RequestProvider
models.RequestDashboardTarget
}
type StartLocalScanOutput ¶ added in v0.2.0
type StartLocalScanOutput struct {
ScanID string `json:"scanId"`
}
Click to show internal directories.
Click to hide internal directories.