client

Documentation

Index

• Constants
• func GetGitHubID(ctx context.Context, githubOwner string) (string, error)
• func HandleError(resp *http.Response) error
• func Int(value int) *int
• func String(value string) *string
• type DASTCreateExternalScanInput
• type DASTCreateExternalScanOutput
• type DASTStartCloudScanInput
• type DASTStartCloudScanOutput
• type DASTUpdateExternalScanInput
• type NullifyClient
  • func NewNullifyClient(nullifyHost string, token string) *NullifyClient
  • func (c *NullifyClient) DASTCreateExternalScan(ctx context.Context, githubOwner string, input *DASTCreateExternalScanInput) (*DASTCreateExternalScanOutput, error)
  • func (c *NullifyClient) DASTStartCloudScan(ctx context.Context, githubOwner string, input *DASTStartCloudScanInput) (*DASTStartCloudScanOutput, error)
  • func (c *NullifyClient) DASTUpdateExternalScan(ctx context.Context, githubOwner string, githubRepository string, ...) error

Constants

const (
	StatusQueued     = "queued"
	StatusInProgress = "in progress"
	StatusCompleted  = "completed"
	StatusCancelled  = "cancelled"
	StatusFailed     = "failed"
)

Functions

func GetGitHubID

func GetGitHubID(ctx context.Context, githubOwner string) (string, error)

func HandleError

func HandleError(resp *http.Response) error

func Int

func Int(value int) *int

func String

func String(value string) *string

Types

type DASTCreateExternalScanInput

type DASTCreateExternalScanInput struct {
	AppName string `json:"appName"`

	Progress  *int       `json:"progress"`
	Status    *string    `json:"status"`
	StartTime *time.Time `json:"startTime"`
	EndTime   *time.Time `json:"endTime"`

	models.RequestProvider
	models.RequestDashboardTarget
}

type DASTCreateExternalScanOutput

type DASTCreateExternalScanOutput struct {
	ScanID string `json:"scanId"`
}

type DASTStartCloudScanInput

type DASTStartCloudScanInput struct {
	AppName     string            `json:"appName"`
	TargetHost  string            `json:"targetHost"`
	OpenAPISpec map[string]any    `json:"openAPISpec"`
	AuthConfig  models.AuthConfig `json:"authConfig"`

	// TODO deprecate
	Host string `json:"host"`

	models.RequestProvider
	models.RequestDashboardTarget
}

type DASTStartCloudScanOutput

type DASTStartCloudScanOutput struct {
	ScanID string `json:"scanId"`
}

type DASTUpdateExternalScanInput

type DASTUpdateExternalScanInput struct {
	Progress *int                 `json:"progress"`
	Status   *string              `json:"status"`
	Findings []models.DASTFinding `json:"findings"`

	*models.RequestDashboardTarget
}

type NullifyClient

type NullifyClient struct {
	Host       string
	BaseURL    string
	Token      string
	HttpClient *http.Client
}

func NewNullifyClient

func NewNullifyClient(nullifyHost string, token string) *NullifyClient

func (*NullifyClient) DASTCreateExternalScan

func (c *NullifyClient) DASTCreateExternalScan(
	ctx context.Context,
	githubOwner string,
	input *DASTCreateExternalScanInput,
) (*DASTCreateExternalScanOutput, error)

func (*NullifyClient) DASTStartCloudScan

func (c *NullifyClient) DASTStartCloudScan(
	ctx context.Context,
	githubOwner string,
	input *DASTStartCloudScanInput,
) (*DASTStartCloudScanOutput, error)

func (*NullifyClient) DASTUpdateExternalScan

func (c *NullifyClient) DASTUpdateExternalScan(
	ctx context.Context,
	githubOwner string,
	githubRepository string,
	scanID string,
	input *DASTUpdateExternalScanInput,
) error