banner

Documentation

Index

• Constants
• func CheckSetup() error
• func Setup(logger utils.Logger) error
• type Result
• type ResultData
• type Scanner
  • func NewScanner(logger utils.Logger, target string, port int, protocol string, ...) (*Scanner, error)
  • func (s *Scanner) Run() (res *Result)

Constants

const Label = "Banner"

Functions

func CheckSetup

func CheckSetup() error

CheckSetup checks whether Setup() executed accordingly. Scan arguments should be checked by the scanner.

func Setup

func Setup(logger utils.Logger) error

Setup configures the environment accordingly, if the scan module has some special requirements. A successful setup is required before a scan can be started.

Types

type Result

type Result struct {
	Data      *ResultData // Bytes array, to be converted by consumer as required
	Status    string      // Final scan status (success or graceful error). Should be stored along with the scan results.
	Exception bool        // Indicates if something went wrong badly and results shall be discarded. This should never be

}

type ResultData

type ResultData struct {
	Plain  []byte
	Ssl    []byte
	Telnet []byte
	Http   []byte
	Https  []byte
}

type Scanner

type Scanner struct {
	Label    string
	Started  time.Time
	Finished time.Time
	// contains filtered or unexported fields
}

func NewScanner

func NewScanner(
	logger utils.Logger,
	target string,
	port int,
	protocol string,
	dialTimeout time.Duration,
	receiveTimeout time.Duration,
) (*Scanner, error)

func (*Scanner) Run

func (s *Scanner) Run() (res *Result)

Run starts scan execution. This must either be executed as a goroutine, or another thread must be active listening on the scan's result channel, in order to avoid a deadlock situation.