restapi

type ApiToken struct {
	Key string `json:"key"`

	// An enumeration for the authorization type parameter.
	Type  AuthorizationTypeEnum `json:"type"`
	Value string                `json:"value"`
}

type AuthorizationScheme struct {
	// contains filtered or unexported fields
}

type AuthorizationSchemeBase struct {
	// An enumeration for the authorization type parameter.
	Type AuthorizationTypeEnum `json:"type"`
}

type AuthorizationTypeEnum string

type BasicAuth struct {
	Password string `json:"password"`

	// An enumeration for the authorization type parameter.
	Type     AuthorizationTypeEnum `json:"type"`
	Username string                `json:"username"`
}

type BearerToken struct {
	Token string `json:"token"`

	// An enumeration for the authorization type parameter.
	Type AuthorizationTypeEnum `json:"type"`
}

type ChiServerOptions struct {
	BaseURL          string
	BaseRouter       chi.Router
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type Finding struct {
	// description of the finding
	Description *string `json:"description,omitempty"`

	// Name of the finding
	Name *string `json:"name,omitempty"`

	// risk of the finding
	Risk *string `json:"risk,omitempty"`
}

type Findings struct {
	Items *[]Finding `json:"items,omitempty"`

	// Nb of items, used for pagination
	Total *int `json:"total,omitempty"`
}

type FuzzingReportItem struct {
	Description *string `json:"description,omitempty"`

	// List of paths that has been fuzzed
	Findings *[]RawFindings `json:"findings,omitempty"`
	Name     *string        `json:"name,omitempty"`

	// List of paths that has been fuzzed
	Paths    *[]FuzzingReportPath `json:"paths,omitempty"`
	Source   *string              `json:"source,omitempty"`
	Status   *string              `json:"status,omitempty"`
	TestType *string              `json:"testType,omitempty"`
}

type FuzzingReportOperation struct {
	Findings *[]externalRef0.APIFinding `json:"findings,omitempty"`

	// Severity of a finding
	HighestSeverity *externalRef0.Severity     `json:"highestSeverity,omitempty"`
	Operation       externalRef0.MethodAndPath `json:"operation"`

	// Request count to this operation item during the test
	RequestsCount int32 `json:"requestsCount"`
}

type FuzzingReportPath struct {
	Payload  *string `json:"payload,omitempty"`
	Response *string `json:"response,omitempty"`
	Result   *int    `json:"result,omitempty"`
	Uri      *string `json:"uri,omitempty"`
	Verb     *string `json:"verb,omitempty"`
}

type FuzzingReportTag struct {
	// Severity of a finding
	HighestSeverity *externalRef0.Severity `json:"highestSeverity,omitempty"`

	// Tag name
	Name       string                   `json:"name"`
	Operations []FuzzingReportOperation `json:"operations"`
}

type FuzzingStatusAndReport struct {
	Progress int `json:"progress"`

	// List of report item
	Report map[string]FuzzingReportItem `json:"report"`

	// An enumeration.
	Status FuzzingStatusEnum `json:"status"`
}

type FuzzingStatusEnum string

type GetAPIFindingsParams struct {
	// Should findings include sensitive data ?
	Sensitive *externalRef0.Sensitive `form:"sensitive,omitempty" json:"sensitive,omitempty"`
}

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

type MiddlewareFunc func(http.Handler) http.Handler

type PostUpdateStatusJSONBody = FuzzingStatusAndReport

type PostUpdateStatusJSONRequestBody = PostUpdateStatusJSONBody

type RawFindings struct {
	AdditionalInfo *string `json:"additionalInfo,omitempty"`
	Description    *string `json:"description,omitempty"`

	// location string token
	Location  *[]string            `json:"location,omitempty"`
	Namespace *string              `json:"namespace,omitempty"`
	Request   *RawFindingsSeverity `json:"request,omitempty"`
	Type      *string              `json:"type,omitempty"`
}

type RawFindingsBundle struct {
	// Opaque data structure for the raw finding
	Data string `json:"data"`

	// An enumeration.
	Source RawFindingsSourceEnum `json:"source"`

	// An enumeration.
	Status ScoreExitStatusEnum `json:"status"`

	// Message giving details about the exist status
	StatusMessage *string `json:"status_message,omitempty"`

	// Raw finding timestamp format= date-time
	Timestamp string `json:"timestamp"`
}

type RawFindingsSeverity struct {
	Severity *string `json:"severity,omitempty"`
}

type RawFindingsSourceEnum string

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

type RequiredParamError struct {
	ParamName string
}

type ScoreExitStatusEnum string

type ServerInterface interface {
	// Retreive the annotated spec for an API
	// (GET /annotatedspec/{apiID})
	GetAnnotatedSpec(w http.ResponseWriter, r *http.Request, apiID externalRef0.ApiID)
	// Get findings for an API and module
	// (GET /apiFindings/{apiID})
	GetAPIFindings(w http.ResponseWriter, r *http.Request, apiID externalRef0.ApiID, params GetAPIFindingsParams)
	// Start a test for an API
	// (GET /fuzz/{apiID}/progress)
	GetTestProgress(w http.ResponseWriter, r *http.Request, apiID externalRef0.ApiID)
	// Start a test for an API
	// (GET /fuzz/{apiID}/report)
	GetTestReport(w http.ResponseWriter, r *http.Request, apiID externalRef0.ApiID)
	// Start a test for an API
	// (POST /fuzz/{apiID}/start)
	StartTest(w http.ResponseWriter, r *http.Request, apiID externalRef0.ApiID)
	// Stop (cancel) a running test for an API
	// (POST /fuzz/{apiID}/stop)
	StopTest(w http.ResponseWriter, r *http.Request, apiID externalRef0.ApiID)
	// Retreive a report for an API
	// (GET /report/{apiID}/{timestamp})
	GetReport(w http.ResponseWriter, r *http.Request, apiID externalRef0.ApiID, timestamp int64)
	// Retrieve a report for an API for a specific test
	// (GET /report/{apiID}/{timestamp}/short)
	GetShortReportByTimestamp(w http.ResponseWriter, r *http.Request, apiID externalRef0.ApiID, timestamp int64)
	// Get the current running state of this module
	// (GET /state)
	GetState(w http.ResponseWriter, r *http.Request)
	// Retreieve the list of tests for an API
	// (GET /tests/{apiID})
	GetTests(w http.ResponseWriter, r *http.Request, apiID externalRef0.ApiID)
	// Retreive last update status for an API under fuzzing
	// (GET /updateStatus/{apiID})
	GetUpdateStatus(w http.ResponseWriter, r *http.Request, apiID externalRef0.ApiID)
	// Update status for an API under fuzzing
	// (POST /updateStatus/{apiID})
	PostUpdateStatus(w http.ResponseWriter, r *http.Request, apiID externalRef0.ApiID)
	// Get the version of this Module
	// (GET /version)
	GetVersion(w http.ResponseWriter, r *http.Request)
}

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

type ShortTestProgress struct {
	ApiID *externalRef0.ApiID `json:"apiID,omitempty"`

	// Progress of the test
	Progress int `json:"progress"`

	// Timestamp of the start of the test
	Starttime int64 `json:"starttime"`
}

type ShortTestReport struct {
	ApiID *externalRef0.ApiID `json:"apiID,omitempty"`

	// Severity of a finding
	HighestSeverity *externalRef0.Severity `json:"highestSeverity,omitempty"`

	// Timestamp of the start of the test
	Starttime int64 `json:"starttime"`

	// An enumeration.
	Status FuzzingStatusEnum `json:"status"`

	// Message for status details, if any
	StatusMessage *string             `json:"statusMessage,omitempty"`
	Tags          *[]FuzzingReportTag `json:"tags,omitempty"`
}

type StartTestJSONBody = TestInput

type StartTestJSONRequestBody = StartTestJSONBody

type Test struct {
	// A message in case of error
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// Progress of the test
	Progress *int `json:"progress,omitempty"`

	// Timestamp of the start of the test
	Starttime *int64 `json:"starttime,omitempty"`

	// risk of the finding
	Vulnerabilities *Vulnerabilities `json:"vulnerabilities,omitempty"`
}

type TestHandle struct {
	ApiID     *externalRef0.ApiID `json:"apiID,omitempty"`
	Timestamp *int64              `json:"timestamp,omitempty"`
}

type TestInput struct {
	Auth *AuthorizationScheme `json:"auth,omitempty"`

	// An enumeration for input depth parameter.
	Depth TestInputDepthEnum `json:"depth"`
}

type TestInputDepthEnum string

type TestProgressNotification struct {
	ApiID            *externalRef0.ApiID `json:"apiID,omitempty"`
	NotificationType string              `json:"notificationType"`

	// Progress of the test
	Progress int `json:"progress"`

	// Timestamp of the start of the test
	Starttime int64 `json:"starttime"`
}

type TestReportNotification struct {
	ApiID *externalRef0.ApiID `json:"apiID,omitempty"`

	// Severity of a finding
	HighestSeverity  *externalRef0.Severity `json:"highestSeverity,omitempty"`
	NotificationType string                 `json:"notificationType"`

	// Timestamp of the start of the test
	Starttime int64 `json:"starttime"`

	// An enumeration.
	Status FuzzingStatusEnum `json:"status"`

	// Message for status details, if any
	StatusMessage *string             `json:"statusMessage,omitempty"`
	Tags          *[]FuzzingReportTag `json:"tags,omitempty"`
}

type TestWithReport struct {
	// A message in case of error
	ErrorMessage *string `json:"errorMessage,omitempty"`

	// Timestamp of the last report received for the test
	LastReportTime *int64 `json:"lastReportTime,omitempty"`

	// Progress of the test
	Progress *int `json:"progress,omitempty"`

	// fuzzing status and reporting
	Report *FuzzingStatusAndReport `json:"report,omitempty"`

	// Timestamp of the start of the test
	Starttime *int64 `json:"starttime,omitempty"`

	// risk of the finding
	Vulnerabilities *Vulnerabilities `json:"vulnerabilities,omitempty"`
}

type TestingModuleState struct {
	APIsInCache int    `json:"APIsInCache"`
	Version     string `json:"version"`
}

type Tests struct {
	Items *[]Test `json:"items,omitempty"`

	// Nb of items, used for pagination
	Total *int `json:"total,omitempty"`
}

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

type Version struct {
	Version string `json:"version"`
}

type Vulnerabilities struct {
	// Total of vuln
	Critical *int `json:"critical,omitempty"`

	// Total of vuln
	High *int `json:"high,omitempty"`

	// Total of vuln
	Low *int `json:"low,omitempty"`

	// Total of vuln
	Medium *int `json:"medium,omitempty"`

	// Total of vuln
	Total *int `json:"total,omitempty"`
}