Documentation
¶
Index ¶
- type SwaggerBenchAPI
- func (o *SwaggerBenchAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
- func (o *SwaggerBenchAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *SwaggerBenchAPI) Authorizer() runtime.Authorizer
- func (o *SwaggerBenchAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *SwaggerBenchAPI) Context() *middleware.Context
- func (o *SwaggerBenchAPI) DefaultConsumes() string
- func (o *SwaggerBenchAPI) DefaultProduces() string
- func (o *SwaggerBenchAPI) Formats() strfmt.Registry
- func (o *SwaggerBenchAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *SwaggerBenchAPI) Init()
- func (o *SwaggerBenchAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *SwaggerBenchAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *SwaggerBenchAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *SwaggerBenchAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *SwaggerBenchAPI) Serve(builder middleware.Builder) http.Handler
- func (o *SwaggerBenchAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *SwaggerBenchAPI) SetDefaultConsumes(mediaType string)
- func (o *SwaggerBenchAPI) SetDefaultProduces(mediaType string)
- func (o *SwaggerBenchAPI) SetSpec(spec *loads.Document)
- func (o *SwaggerBenchAPI) UseRedoc()
- func (o *SwaggerBenchAPI) UseSwaggerUI()
- func (o *SwaggerBenchAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SwaggerBenchAPI ¶
type SwaggerBenchAPI struct {
Middleware func(middleware.Builder) http.Handler
// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
// It has a default implementation in the security package, however you can replace it for your particular usage.
BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator
// APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function.
// It has a default implementation in the security package, however you can replace it for your particular usage.
APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator
// BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function.
// It has a default implementation in the security package, however you can replace it for your particular usage.
BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator
// JSONConsumer registers a consumer for the following mime types:
// - application/io.goswagger.go-test-bench.v1+json
JSONConsumer runtime.Consumer
// HTMLProducer registers a producer for the following mime types:
// - text/html
HTMLProducer runtime.Producer
// JSONProducer registers a producer for the following mime types:
// - application/io.goswagger.go-test-bench.v1+json
JSONProducer runtime.Producer
// TxtProducer registers a producer for the following mime types:
// - text/plain
TxtProducer runtime.Producer
// CmdInjectionCmdInjectionFrontHandler sets the operation handler for the cmd injection front operation
CmdInjectionCmdInjectionFrontHandler cmd_injection.CmdInjectionFrontHandler
// CmdInjectionCmdInjectionGetQueryCommandHandler sets the operation handler for the cmd injection get query command operation
CmdInjectionCmdInjectionGetQueryCommandHandler cmd_injection.CmdInjectionGetQueryCommandHandler
// CmdInjectionCmdInjectionGetQueryCommandContextHandler sets the operation handler for the cmd injection get query command context operation
CmdInjectionCmdInjectionGetQueryCommandContextHandler cmd_injection.CmdInjectionGetQueryCommandContextHandler
// PathTraversalPathTraversalFrontHandler sets the operation handler for the path traversal front operation
PathTraversalPathTraversalFrontHandler path_traversal.PathTraversalFrontHandler
// PathTraversalPathTraversalGetBufferedQueryCreateHandler sets the operation handler for the path traversal get buffered query create operation
PathTraversalPathTraversalGetBufferedQueryCreateHandler path_traversal.PathTraversalGetBufferedQueryCreateHandler
// PathTraversalPathTraversalGetBufferedQueryOpenHandler sets the operation handler for the path traversal get buffered query open operation
PathTraversalPathTraversalGetBufferedQueryOpenHandler path_traversal.PathTraversalGetBufferedQueryOpenHandler
// PathTraversalPathTraversalGetBufferedQueryReadFileHandler sets the operation handler for the path traversal get buffered query read file operation
PathTraversalPathTraversalGetBufferedQueryReadFileHandler path_traversal.PathTraversalGetBufferedQueryReadFileHandler
// PathTraversalPathTraversalGetBufferedQueryWriteFileHandler sets the operation handler for the path traversal get buffered query write file operation
PathTraversalPathTraversalGetBufferedQueryWriteFileHandler path_traversal.PathTraversalGetBufferedQueryWriteFileHandler
// PathTraversalPathTraversalGetQueryCreateHandler sets the operation handler for the path traversal get query create operation
PathTraversalPathTraversalGetQueryCreateHandler path_traversal.PathTraversalGetQueryCreateHandler
// PathTraversalPathTraversalGetQueryOpenHandler sets the operation handler for the path traversal get query open operation
PathTraversalPathTraversalGetQueryOpenHandler path_traversal.PathTraversalGetQueryOpenHandler
// PathTraversalPathTraversalGetQueryReadFileHandler sets the operation handler for the path traversal get query read file operation
PathTraversalPathTraversalGetQueryReadFileHandler path_traversal.PathTraversalGetQueryReadFileHandler
// PathTraversalPathTraversalGetQueryWriteFileHandler sets the operation handler for the path traversal get query write file operation
PathTraversalPathTraversalGetQueryWriteFileHandler path_traversal.PathTraversalGetQueryWriteFileHandler
// SQLInjectionSQLInjectionFrontHandler sets the operation handler for the SQL injection front operation
SQLInjectionSQLInjectionFrontHandler sql_injection.SQLInjectionFrontHandler
// SQLInjectionSQLInjectionGetQueryExecHandler sets the operation handler for the SQL injection get query exec operation
SQLInjectionSQLInjectionGetQueryExecHandler sql_injection.SQLInjectionGetQueryExecHandler
// SsrfSsrfFrontHandler sets the operation handler for the ssrf front operation
SsrfSsrfFrontHandler ssrf.SsrfFrontHandler
// SsrfSsrfGetQueryHTTPHandler sets the operation handler for the ssrf get query HTTP operation
SsrfSsrfGetQueryHTTPHandler ssrf.SsrfGetQueryHTTPHandler
// XSSXSSFrontHandler sets the operation handler for the XSS front operation
XSSXSSFrontHandler xss.XSSFrontHandler
// XSSXSSGetBufferedQueryReflectedXSSHandler sets the operation handler for the XSS get buffered query reflected XSS operation
XSSXSSGetBufferedQueryReflectedXSSHandler xss.XSSGetBufferedQueryReflectedXSSHandler
// XSSXSSGetQueryReflectedXSSHandler sets the operation handler for the XSS get query reflected XSS operation
XSSXSSGetQueryReflectedXSSHandler xss.XSSGetQueryReflectedXSSHandler
// SwaggerServerRootHandler sets the operation handler for the root operation
SwaggerServerRootHandler swagger_server.RootHandler
// ServeError is called when an error is received, there is a default handler
// but you can set your own with this
ServeError func(http.ResponseWriter, *http.Request, error)
// PreServerShutdown is called before the HTTP(S) server is shutdown
// This allows for custom functions to get executed before the HTTP(S) server stops accepting traffic
PreServerShutdown func()
// ServerShutdown is called when the HTTP(S) server is shut down and done
// handling all active connections and does not accept connections any more
ServerShutdown func()
// Custom command line argument groups with their descriptions
CommandLineOptionsGroups []swag.CommandLineOptionsGroup
// User defined logger function.
Logger func(string, ...interface{})
// contains filtered or unexported fields
}
SwaggerBenchAPI An API built with go-swagger to generate intentionally vulnerable endpoints
func NewSwaggerBenchAPI ¶
func NewSwaggerBenchAPI(spec *loads.Document) *SwaggerBenchAPI
NewSwaggerBenchAPI creates a new SwaggerBench instance
func (*SwaggerBenchAPI) AddMiddlewareFor ¶
func (o *SwaggerBenchAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*SwaggerBenchAPI) AuthenticatorsFor ¶
func (o *SwaggerBenchAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*SwaggerBenchAPI) Authorizer ¶
func (o *SwaggerBenchAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*SwaggerBenchAPI) ConsumersFor ¶
func (o *SwaggerBenchAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (*SwaggerBenchAPI) Context ¶
func (o *SwaggerBenchAPI) Context() *middleware.Context
Context returns the middleware context for the swagger bench API
func (*SwaggerBenchAPI) DefaultConsumes ¶
func (o *SwaggerBenchAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*SwaggerBenchAPI) DefaultProduces ¶
func (o *SwaggerBenchAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*SwaggerBenchAPI) Formats ¶
func (o *SwaggerBenchAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*SwaggerBenchAPI) HandlerFor ¶
func (o *SwaggerBenchAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*SwaggerBenchAPI) Init ¶
func (o *SwaggerBenchAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*SwaggerBenchAPI) ProducersFor ¶
func (o *SwaggerBenchAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (*SwaggerBenchAPI) RegisterConsumer ¶
func (o *SwaggerBenchAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*SwaggerBenchAPI) RegisterFormat ¶
func (o *SwaggerBenchAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
RegisterFormat registers a custom format validator
func (*SwaggerBenchAPI) RegisterProducer ¶
func (o *SwaggerBenchAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (*SwaggerBenchAPI) Serve ¶
func (o *SwaggerBenchAPI) Serve(builder middleware.Builder) http.Handler
Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))
func (*SwaggerBenchAPI) ServeErrorFor ¶
func (o *SwaggerBenchAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*SwaggerBenchAPI) SetDefaultConsumes ¶
func (o *SwaggerBenchAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*SwaggerBenchAPI) SetDefaultProduces ¶
func (o *SwaggerBenchAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*SwaggerBenchAPI) SetSpec ¶
func (o *SwaggerBenchAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*SwaggerBenchAPI) UseRedoc ¶
func (o *SwaggerBenchAPI) UseRedoc()
UseRedoc for documentation at /docs
func (*SwaggerBenchAPI) UseSwaggerUI ¶
func (o *SwaggerBenchAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs
func (*SwaggerBenchAPI) Validate ¶
func (o *SwaggerBenchAPI) Validate() error
Validate validates the registrations in the SwaggerBenchAPI