Merge pull request #29 from edoardottt/devel

v0.0.2

Author: edoardottt

README.md

@@ -75,6 +75,7 @@ OUTPUT:
    -o, -output string  File to write output results
    -v, -verbose        Verbose output
    -s, -silent         Silent output. Print only results
+   -j, -json           JSON output
 ```
 
 Examples 💡

pkg/input/flags.go

@@ -41,6 +41,7 @@ type Options struct {
 	RateLimit int
 	Silent    bool
 	Verbose   bool
+	JSON      bool
 }
 
 func (options *Options) configureOutput() {
@@ -88,6 +89,7 @@ func ParseOptions() *Options {
 		flagSet.StringVarP(&options.FileOutput, "output", "o", "", `File to write output results`),
 		flagSet.BoolVarP(&options.Verbose, "verbose", "v", false, `Verbose output`),
 		flagSet.BoolVarP(&options.Silent, "silent", "s", false, `Silent output. Print only results`),
+		flagSet.BoolVarP(&options.JSON, "json", "j", false, `JSON output`),
 	)
 
 	if help() || noArgs() {

pkg/output/banner.go

@@ -11,7 +11,7 @@ import "github.com/projectdiscovery/gologger"
 var printed = false
 
 const (
-	Version = "v0.0.1"
+	Version = "v0.0.2"
 	banner  = `                 __               __  
     ____  ____  / /_  ____ ______/ /__
    / __ \/ __ \/ __ \/ __ ` + "`" + `/ ___/ //_/

pkg/output/json.go

@@ -0,0 +1,32 @@
+/*
+pphack - The Most Advanced Client-Side Prototype Pollution Scanner
+
+This repository is under MIT License https://github.com/edoardottt/pphack/blob/main/LICENSE
+*/
+
+package output
+
+import "encoding/json"
+
+// JSONData.
+type JSONData struct {
+	URL          string `json:"URL,omitempty"`
+	JSEvaluation string `json:"JSEvaluation,omitempty"`
+	Error        string `json:"Error,omitempty"`
+}
+
+// FormatJSON returns the input as JSON string.
+func FormatJSON(url, jsEval, e string) ([]byte, error) {
+	input := &JSONData{
+		URL:          url,
+		JSEvaluation: jsEval,
+		Error:        e,
+	}
+
+	jsonOutput, err := json.Marshal(input)
+	if err != nil {
+		return nil, err
+	}
+
+	return jsonOutput, nil
+}

pkg/output/json_test.go

@@ -0,0 +1,58 @@
+/*
+pphack - The Most Advanced Client-Side Prototype Pollution Scanner
+
+This repository is under MIT License https://github.com/edoardottt/pphack/blob/main/LICENSE
+*/
+
+package output_test
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/edoardottt/pphack/pkg/output"
+)
+
+func TestFormatJSON(t *testing.T) {
+	tests := []struct {
+		name  string
+		input output.JSONData
+		want  string
+	}{
+		{name: "no error",
+			input: output.JSONData{
+				URL: "https://edoardottt.github.io/pp-test?constructor.prototype.oigczu=oigczu\u0026__proto__[oigczu]=" +
+					"oigczu\u0026constructor[prototype][oigczu]=oigczu\u0026__proto__.oigczu=oigczu\u0026__proto__." +
+					"oigczu=1|2|3\u0026__proto__[oigczu]={\"json\":\"value\"}#__proto__[oigczu]=oigczu",
+				JSEvaluation: "oigczu",
+				Error:        "",
+			},
+			want: `{"URL":"https://edoardottt.github.io/pp-test?constructor.prototype.oigczu=oigczu\u0026__proto__` +
+				`[oigczu]=oigczu\u0026constructor[prototype][oigczu]=oigczu\u0026__proto__.oigczu=oigczu\u0026__proto__.` +
+				`oigczu=1|2|3\u0026__proto__[oigczu]={\"json\":\"value\"}#__proto__[oigczu]=oigczu","JSEvaluation":"oigczu"}`,
+		},
+		{name: "error",
+			input: output.JSONData{
+				URL: "https://edoardottt.github.io/pp-tes?constructor.prototype.sqtiwx=sqtiwx\u0026__proto__[sqtiwx]" +
+					"=sqtiwx\u0026constructor[prototype][sqtiwx]=sqtiwx\u0026__proto__.sqtiwx=sqtiwx\u0026__proto__." +
+					"sqtiwx=1|2|3\u0026__proto__[sqtiwx]={\"json\":\"value\"}#__proto__[sqtiwx]=sqtiwx",
+				JSEvaluation: "",
+				Error:        "encountered an undefined value",
+			},
+			want: `{"URL":"https://edoardottt.github.io/pp-tes?constructor.prototype.sqtiwx=sqtiwx\u0026__proto__[sqtiwx]` +
+				`=sqtiwx\u0026constructor[prototype][sqtiwx]=sqtiwx\u0026__proto__.sqtiwx=sqtiwx\u0026__proto__.` +
+				`sqtiwx=1|2|3\u0026__proto__[sqtiwx]={\"json\":\"value\"}#__proto__[sqtiwx]=` +
+				`sqtiwx","Error":"encountered an undefined value"}`,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, _ := output.FormatJSON(tt.input.URL, tt.input.JSEvaluation, tt.input.Error)
+			if !reflect.DeepEqual(string(got), tt.want) {
+				t.Errorf("GetJSONString\n%v", string(got))
+				t.Errorf("want\n%v", tt.want)
+			}
+		})
+	}
+}

pkg/scan/runner.go

@@ -113,9 +113,7 @@ func (r *Runner) Run() {
 			for value := range r.InputChan {
 				targetURL, err := PrepareURL(value, testPayload)
 				if err != nil {
-					if r.Options.Verbose {
-						gologger.Error().Msg(err.Error())
-					}
+					verboseOutput(r, value, err)
 				}
 
 				ctx, cancel := context.WithTimeout(pctx, time.Second*time.Duration(r.Options.Timeout))
@@ -125,13 +123,15 @@ func (r *Runner) Run() {
 
 				res, err := Scan(ctx, js, targetURL)
 				if err != nil {
-					if r.Options.Verbose {
-						gologger.Error().Msg(err.Error())
-					}
+					verboseOutput(r, targetURL, err)
 				}
 
 				if resTrimmed := strings.TrimSpace(res); resTrimmed != "" {
-					writeOutput(r, targetURL)
+					if err != nil {
+						writeOutput(r, targetURL, res, err.Error())
+					} else {
+						writeOutput(r, targetURL, res, "")
+					}
 				}
 
 				cancel()
@@ -146,13 +146,13 @@ func (r *Runner) Run() {
 	wg.Wait()
 }
 
-func writeOutput(r *Runner, targetURL string) {
-	if !r.Result.Printed(targetURL) {
-		write(r.OutMutex, &r.Options, targetURL)
+func writeOutput(r *Runner, url, jsEval, err string) {
+	if !r.Result.Printed(url) {
+		write(r.OutMutex, &r.Options, url, jsEval, err)
 	}
 }
 
-func write(m *sync.Mutex, options *input.Options, o string) {
+func write(m *sync.Mutex, options *input.Options, u, jse, e string) {
 	if options.FileOutput != "" && options.Output == nil {
 		file, err := os.OpenFile(options.FileOutput, os.O_CREATE|os.O_RDWR|os.O_APPEND, 0644)
 		if err != nil {
@@ -162,15 +162,44 @@ func write(m *sync.Mutex, options *input.Options, o string) {
 		options.Output = file
 	}
 
+	var (
+		o   []byte
+		err error
+	)
+
+	if options.JSON {
+		o, err = output.FormatJSON(u, jse, e)
+		if err != nil {
+			gologger.Fatal().Msg(err.Error())
+		}
+	} else {
+		o = []byte(u)
+	}
+
 	m.Lock()
 
 	if options.Output != nil {
-		if _, err := options.Output.Write([]byte(o + "\n")); err != nil && options.Verbose {
+		if _, err := options.Output.Write([]byte(string(o) + "\n")); err != nil && options.Verbose {
 			gologger.Fatal().Msg(err.Error())
 		}
 	}
 
 	m.Unlock()
 
-	fmt.Println(o)
+	fmt.Println(string(o))
+}
+
+func verboseOutput(r *Runner, value string, err error) {
+	if r.Options.Verbose {
+		if r.Options.JSON {
+			o, err := output.FormatJSON(value, "", err.Error())
+			if err != nil {
+				gologger.Error().Msg(err.Error())
+			}
+
+			fmt.Println(string(o))
+		} else {
+			gologger.Error().Msg(err.Error())
+		}
+	}
 }

snapcraft.yaml

@@ -2,7 +2,7 @@ name: pphack
 summary: The Most Advanced Client-Side Prototype Pollution Scanner
 description: |
       The Most Advanced Client-Side Prototype Pollution Scanner
-version: 0.0.1
+version: 0.0.2
 grade: stable
 base: core20