Documentation
¶
Index ¶
- func RunDASTScan(ctx context.Context, dast *DAST, nullifyClient *client.NullifyClient, ...) error
- func RunLocalScan(ctx context.Context, nullifyClient *client.NullifyClient, githubOwner string, ...) error
- type DAST
- type DASTExternalScanInput
- type DASTExternalScanOutput
- type DockerPullOutput
- type DockerPullProgressDetail
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RunDASTScan ¶ added in v0.7.2
func RunLocalScan ¶ added in v0.7.2
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"`
AuthHeaders []string `arg:"--header" help:"List of headers for the DAST agent to authenticate with your API"`
GitHubOwner string `arg:"--github-owner" help:"The GitHub username or organisation"`
GitHubRepository string `arg:"--github-repo" help:"The repository name to create the Nullify issue dashboard in e.g. cli"`
// local scan settings
Local bool `arg:"--local" help:"Test the given app locally for bugs and vulnerabilities in private networks"`
ImageLabel string `arg:"--image-label" default:"latest" help:"Version of the DAST local image that is used for scanning"`
ForcePullImage bool `arg:"--force-pull" help:"Force a docker pull of the latest version of the DAST local image"`
UseHostNetwork bool `arg:"--use-host-network" help:"Use the host network for the DAST local scan"`
AuthConfig string `arg:"--auth-config" help:"The path to the auth config file"`
}
type DASTExternalScanInput ¶ added in v0.7.0
type DASTExternalScanInput struct {
AppName string `json:"appName"`
TargetHost string `json:"targetHost"`
OpenAPISpec map[string]interface{} `json:"openAPISpec"`
AuthConfig models.AuthConfig `json:"authConfig"`
}
type DASTExternalScanOutput ¶ added in v0.7.0
type DASTExternalScanOutput struct {
Findings []models.DASTFinding `json:"findings"`
}
type DockerPullOutput ¶ added in v0.8.0
type DockerPullOutput struct {
Status string `json:"status"`
ID string `json:"id"`
ProgressDetail *DockerPullProgressDetail `json:"progressDetail"`
}
type DockerPullProgressDetail ¶ added in v0.8.0
Click to show internal directories.
Click to hide internal directories.