scanner

Documentation

Index

• Constants
• func GetTargetURL(reqURL *url.URL) string
• func NewDNSCache(logger *logrus.Logger) (*dnscache.Resolver, error)
• type GRPCConn
  • func NewGRPCConn(cfg *config.Config) (*GRPCConn, error)
  • func (g *GRPCConn) CheckAvailability(ctx context.Context) (bool, error)
  • func (g *GRPCConn) Close() error
  • func (g *GRPCConn) IsAvailable() bool
  • func (g *GRPCConn) Send(ctx context.Context, encoderName, payload string) (body string, statusCode int, err error)
• type HTTPClient
  • func NewHTTPClient(cfg *config.Config, dnsResolver *dnscache.Resolver) (*HTTPClient, error)
  • func (c *HTTPClient) SendPayload(ctx context.Context, targetURL string, payload string, encoderName string, ...) (responseMsgHeader string, responseBody string, statusCode int, err error)
  • func (c *HTTPClient) SendRequest(req *http.Request, testHeaderValue string) (respHeaders http.Header, responseMsgHeader string, body string, statusCode int, ...)
• type Scanner
  • func New(logger *logrus.Logger, cfg *config.Config, db *db.DB, ...) (*Scanner, error)
  • func (s *Scanner) CheckGRPCAvailability(ctx context.Context)
  • func (s *Scanner) Run(ctx context.Context) error
  • func (s *Scanner) WAFBlockCheck(ctx context.Context) error
  • func (s *Scanner) WAFwsBlockCheck(ctx context.Context)
• type WAFDetector
  • func NewDetector(cfg *config.Config, dnsResolver *dnscache.Resolver) (*WAFDetector, error)
  • func (w *WAFDetector) DetectWAF(ctx context.Context) (name, vendor string, err error)

Constants

const (
	GTWDebugHeader = "X-GoTestWAF-Test"
)

Functions

func GetTargetURL

func GetTargetURL(reqURL *url.URL) string

func NewDNSCache

func NewDNSCache(logger *logrus.Logger) (*dnscache.Resolver, error)

Types

type GRPCConn

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

func NewGRPCConn

func NewGRPCConn(cfg *config.Config) (*GRPCConn, error)

func (*GRPCConn) CheckAvailability

func (g *GRPCConn) CheckAvailability(ctx context.Context) (bool, error)

func (*GRPCConn) Close

func (g *GRPCConn) Close() error

func (*GRPCConn) IsAvailable

func (g *GRPCConn) IsAvailable() bool

func (*GRPCConn) Send

func (g *GRPCConn) Send(ctx context.Context, encoderName, payload string) (body string, statusCode int, err error)

type HTTPClient

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

func NewHTTPClient

func NewHTTPClient(cfg *config.Config, dnsResolver *dnscache.Resolver) (*HTTPClient, error)

func (*HTTPClient) SendPayload

func (c *HTTPClient) SendPayload(
	ctx context.Context,
	targetURL string,
	payload string,
	encoderName string,
	placeholderName string,
	placeholderConfig placeholder.PlaceholderConfig,
	testHeaderValue string,
) (responseMsgHeader string, responseBody string, statusCode int, err error)

func (*HTTPClient) SendRequest

func (c *HTTPClient) SendRequest(
	req *http.Request,
	testHeaderValue string,
) (
	respHeaders http.Header,
	responseMsgHeader string,
	body string,
	statusCode int,
	err error,
)

type Scanner

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

Scanner allows you to test WAF in various ways with given payloads.

func New

func New(
	logger *logrus.Logger,
	cfg *config.Config,
	db *db.DB,
	dnsResolver *dnscache.Resolver,
	requestTemplates openapi.Templates,
	router routers.Router,
	enableDebugHeader bool,
) (*Scanner, error)

New creates a new Scanner.

func (*Scanner) CheckGRPCAvailability

func (s *Scanner) CheckGRPCAvailability(ctx context.Context)

CheckGRPCAvailability checks if the gRPC server is available at the given URL.

func (*Scanner) Run

func (s *Scanner) Run(ctx context.Context) error

Run starts a host scan to check WAF security.

func (*Scanner) WAFBlockCheck

func (s *Scanner) WAFBlockCheck(ctx context.Context) error

WAFBlockCheck checks if WAF exists and blocks malicious requests.

func (*Scanner) WAFwsBlockCheck

func (s *Scanner) WAFwsBlockCheck(ctx context.Context)

WAFwsBlockCheck checks if WebSocket exists and is protected by WAF.

type WAFDetector

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

func NewDetector

func NewDetector(cfg *config.Config, dnsResolver *dnscache.Resolver) (*WAFDetector, error)

func (*WAFDetector) DetectWAF

func (w *WAFDetector) DetectWAF(ctx context.Context) (name, vendor string, err error)

DetectWAF performs WAF identification. Returns WAF name and vendor after the first positive match.