adding comments

Author: Mzack9999

cmd/simplehttpserver/simplehttpserver.go

@@ -8,11 +8,11 @@ import (
 func main() {
 	// Parse the command line flags and read config files
 	options := runner.ParseOptions()
-	runner, err := runner.New(options)
+	r, err := runner.New(options)
 	if err != nil {
 		gologger.Fatal().Msgf("Could not create runner: %s\n", err)
 	}
 
-	runner.Run()
-	runner.Close()
+	r.Run()
+	defer r.Close()
 }

internal/runner/options.go

@@ -93,6 +93,7 @@ func (options *Options) configureOutput() {
 	}
 }
 
+// FolderAbsPath of the fileserver folder
 func (o Options) FolderAbsPath() string {
 	abspath, err := filepath.Abs(o.Folder)
 	if err != nil {

internal/runner/runner.go

@@ -14,6 +14,7 @@ type Runner struct {
 	httpServer *httpserver.HTTPServer
 }
 
+// New instance of runner
 func New(options *Options) (*Runner, error) {
 	r := Runner{options: options}
 	// Check if the process can listen on the specified ip:port
@@ -65,6 +66,7 @@ func New(options *Options) (*Runner, error) {
 	return &r, nil
 }
 
+// Run logic
 func (r *Runner) Run() error {
 	if r.options.EnableTCP {
 		gologger.Print().Msgf("Serving TCP rule based server on tcp://%s", r.options.ListenAddress)
@@ -80,6 +82,7 @@ func (r *Runner) Run() error {
 	return r.httpServer.ListenAndServe()
 }
 
+// Close the listening services
 func (r *Runner) Close() error {
 	if r.serverTCP != nil {
 		r.serverTCP.Close()

pkg/binder/binder.go

@@ -7,6 +7,7 @@ import (
 	"github.com/phayes/freeport"
 )
 
+// CanListenOn the specified address
 func CanListenOn(address string) bool {
 	listener, err := net.Listen("tcp4", address)
 	if err != nil {
@@ -16,6 +17,7 @@ func CanListenOn(address string) bool {
 	return true
 }
 
+// GetRandomListenAddress from the specified one
 func GetRandomListenAddress(currentAddress string) (string, error) {
 	addrOrig, _, err := net.SplitHostPort(currentAddress)
 	if err != nil {

pkg/httpserver/httpserver.go

@@ -6,6 +6,7 @@ import (
 	"github.com/projectdiscovery/sslcert"
 )
 
+// Options of the http server
 type Options struct {
 	Folder            string
 	EnableUpload      bool
@@ -20,11 +21,13 @@ type Options struct {
 	Verbose           bool
 }
 
+// HTTPServer instance
 type HTTPServer struct {
 	options *Options
 	layers  http.Handler
 }
 
+// New http server instance with options
 func New(options *Options) (*HTTPServer, error) {
 	var h HTTPServer
 	EnableUpload = options.EnableUpload
@@ -37,10 +40,12 @@ func New(options *Options) (*HTTPServer, error) {
 	return &HTTPServer{options: options, layers: layers}, nil
 }
 
+// ListenAndServe requests over http
 func (t *HTTPServer) ListenAndServe() error {
 	return http.ListenAndServe(t.options.ListenAddress, t.layers)
 }
 
+// ListenAndServeTLS requests over https
 func (t *HTTPServer) ListenAndServeTLS() error {
 	if t.options.Certificate == "" || t.options.CertificateKey == "" {
 		tlsOptions := sslcert.DefaultOptions
@@ -59,6 +64,7 @@ func (t *HTTPServer) ListenAndServeTLS() error {
 	return http.ListenAndServeTLS(t.options.ListenAddress, t.options.Certificate, t.options.CertificateKey, t.layers)
 }
 
+// Close the service
 func (t *HTTPServer) Close() error {
 	return nil
 }

pkg/httpserver/loglayer.go

@@ -54,15 +54,18 @@ func newLoggingResponseWriter(w http.ResponseWriter) *loggingResponseWriter {
 	return &loggingResponseWriter{w, http.StatusOK, []byte{}}
 }
 
+// Write the data
 func (lrw *loggingResponseWriter) Write(data []byte) (int, error) {
 	lrw.Data = append(lrw.Data, data...)
 	return lrw.ResponseWriter.Write(data)
 }
 
+// Header of the response
 func (lrw *loggingResponseWriter) Header() http.Header {
 	return lrw.ResponseWriter.Header()
 }
 
+// WriteHeader status code
 func (lrw *loggingResponseWriter) WriteHeader(code int) {
 	lrw.statusCode = code
 	lrw.ResponseWriter.WriteHeader(code)

pkg/tcpserver/responseengine.go

@@ -4,12 +4,13 @@ import (
 	"errors"
 )
 
+// BuildResponse according to rules
 func (t *TCPServer) BuildResponse(data []byte) ([]byte, error) {
 	// Process all the rules
 	for _, rule := range t.options.rules {
 		if rule.matchRegex.Match(data) {
 			return []byte(rule.Response), nil
 		}
 	}
-	return nil, errors.New("No matched rule")
+	return nil, errors.New("no matched rule")
 }

pkg/tcpserver/rule.go

@@ -2,17 +2,20 @@ package tcpserver
 
 import "regexp"
 
+// RulesConfiguration from yaml
 type RulesConfiguration struct {
 	Rules []Rule `yaml:"rules"`
 }
 
+// Rule to apply to various requests
 type Rule struct {
 	Match      string `yaml:"match,omitempty"`
 	matchRegex *regexp.Regexp
 	Response   string `yaml:"response,omitempty"`
 }
 
-func NewRule(match string, response string) (*Rule, error) {
+// NewRule from model
+func NewRule(match, response string) (*Rule, error) {
 	regxp, err := regexp.Compile(match)
 	if err != nil {
 		return nil, err

pkg/tcpserver/tcpserver.go

@@ -11,6 +11,7 @@ import (
 	"gopkg.in/yaml.v2"
 )
 
+// Options of the tcp server
 type Options struct {
 	Listen      string
 	TLS         bool
@@ -21,20 +22,24 @@ type Options struct {
 	Verbose     bool
 }
 
+// TCPServer instance
 type TCPServer struct {
 	options  Options
 	listener net.Listener
 }
 
+// New tcp server instance with specified options
 func New(options Options) (*TCPServer, error) {
 	return &TCPServer{options: options}, nil
 }
 
+// AddRule to the server
 func (t *TCPServer) AddRule(rule Rule) error {
 	t.options.rules = append(t.options.rules, rule)
 	return nil
 }
 
+// ListenAndServe requests
 func (t *TCPServer) ListenAndServe() error {
 	listener, err := net.Listen("tcp4", t.options.Listen)
 	if err != nil {
@@ -68,6 +73,7 @@ func (t *TCPServer) handleConnection(conn net.Conn) error {
 	}
 }
 
+// ListenAndServe requests over tls
 func (t *TCPServer) ListenAndServeTLS() error {
 	var tlsConfig *tls.Config
 	if t.options.Certificate != "" && t.options.Key != "" {
@@ -108,6 +114,7 @@ func (t *TCPServer) Close() error {
 	return t.listener.Close()
 }
 
+// LoadTemplate from yaml
 func (t *TCPServer) LoadTemplate(templatePath string) error {
 	var config RulesConfiguration
 	yamlFile, err := ioutil.ReadFile(templatePath)