Seperate out SimpleReport into it's own file + Refactor #18 - review fix.

main.go

@@ -3,6 +3,7 @@ package main
 import (
 	"flag"
 	"fmt"
+	"github.com/s-rah/onionscan/report"
 	"io/ioutil"
 	"log"
 	"os"
@@ -18,6 +19,7 @@ func main() {
 
 	torProxyAddress := flag.String("torProxyAddress", "127.0.0.1:9050", "the address of the tor proxy to use")
 	simpleReport := flag.Bool("simpleReport", true, "print out a simple report detailing what is wrong and how to fix it, true by default")
+	reportFile := flag.String("reportFile", "", "the file destination path for report file")
 	jsonReport := flag.Bool("jsonReport", false, "print out a json report providing a detailed report of the scan.")
 	verbose := flag.Bool("verbose", false, "print out a verbose log output of the scan")
 
@@ -38,115 +40,17 @@ func main() {
 	}
 
 	onionScan := Configure(*torProxyAddress)
-	report, err := onionScan.Scan(hiddenService)
+	scanReport, err := onionScan.Scan(hiddenService)
 
 	if err != nil {
 		log.Fatalf("Error running scanner: %s", err)
 	}
 
 	if *jsonReport {
-		jsonOut, _ := report.Serialize()
+		report.GenerateJsonReport(*reportFile, scanReport)
-		fmt.Printf("%s\n", jsonOut)
 	}
 
-	// FIXME: This needs refactoring, would be nice to put these into an external config files
 	if *simpleReport {
-
+		report.GenerateSimpleReport(*reportFile, scanReport)
-		highRisk := 0
-		mediumRisk := 0
-		lowRisk := 0
-
-		if report.FoundApacheModStatus {
-			highRisk += 1
-		}
-
-		if len(report.RelatedClearnetDomains) > 0 {
-			highRisk += 1
-		}
-
-		if len(report.RelatedOnionServices) > 0 {
-			mediumRisk += 1
-		}
-
-		if report.ExifImages != nil {
-			if len(report.ExifImages) > 10 {
-				highRisk += 1
-			} else {
-				mediumRisk += 1
-			}
-		}
-
-		if report.OpenDirectories != nil {
-			if len(report.OpenDirectories) > 3 {
-				mediumRisk += 1
-			} else {
-				lowRisk += 1
-			}
-		}
-
-		if report.InterestingFiles != nil {
-			if len(report.InterestingFiles) > 10 {
-				mediumRisk += 1
-			} else {
-				lowRisk += 1
-			}
-		}
-
-		fmt.Printf("--------------- OnionScan Report ---------------\n")
-		fmt.Printf("High Risk Issues: %d\n", highRisk)
-		fmt.Printf("Medium Risk Issues: %d\n", mediumRisk)
-		fmt.Printf("Low Risk Issues: %d\n", lowRisk)
-		fmt.Printf("\n")
-
-		if report.FoundApacheModStatus {
-			fmt.Printf("\033[091mHigh Risk:\033[0m Apache mod_status is enabled and accessible\n")
-			fmt.Printf("\t Why this is bad: An attacker can gain very valuable information\n\t from this internal status page including IP addresses, co-hosted services and user activity.\n")
-			fmt.Printf("\t To fix, disable mod_status or serve it on a different port than the configured hidden service\n\n")
-		}
-
-		if len(report.RelatedClearnetDomains) > 0 {
-			fmt.Printf("\033[091mHigh Risk:\033[0m You are hosting a clearnet site on the same server as this onion service!\n")
-			fmt.Printf("\t Why this is bad: This may be intentional, but often isn't.\n\t Services are best operated in isolation such that a compromise of one does not mean a compromise of the other.\n")
-			fmt.Printf("\t To fix, host all services on separate infrastructure\n\n")
-		}
-
-		if len(report.RelatedOnionServices) > 0 {
-			fmt.Printf("\033[091mMedium Risk:\033[0m You are hosting multiple onion services on the same server as this onion service!\n")
-			fmt.Printf("\t Why this is bad: This may be intentional, but often isn't.\n\t Hidden services are best operated in isolation such that a compromise of one does not mean a compromise of the other.\n")
-			fmt.Printf("\t To fix, host all services on separate infrastructure\n\n")
-		}
-
-		if len(report.ExifImages) > 0 {
-			if len(report.ExifImages) > 10 {
-				fmt.Printf("\033[091mHigh Risk:\033[0m Large number of images with EXIF metadata were discovered!\n")
-			} else {
-				fmt.Printf("\033[091mMedium Risk:\033[0m Small number of images with EXIF metadata were discovered!\n")
-			}
-
-			fmt.Printf("\t Why this is bad: EXIF metadata can itself deanonymize a user or\n\t service operator (e.g. GPS location, Name etc.). Or, when combined, can be used to link anonymous identities together.\n")
-			fmt.Printf("\t To fix, re-encode all images to strip EXIF and other metadata.\n")
-			fmt.Printf("\t Images Identified:\n")
-			for _, image := range report.ExifImages {
-				fmt.Printf("\t\t%s\n", image.Location)
-			}
-			fmt.Printf("\n")
-		}
-
-		if len(report.OpenDirectories) > 0 {
-			if len(report.OpenDirectories) > 10 {
-				fmt.Printf("\033[091mMedium Risk:\033[0m Large number of open directories were discovered!\n")
-			} else {
-				fmt.Printf("\033[091mLow Risk:\033[0m Small number of open directories were discovered!\n")
-			}
-
-			fmt.Printf("\t Why this is bad: Open directories can reveal the existence of files\n\t not linked from the sites source code. Most of the time this is benign, but sometimes operators forget to clean up more sensitive folders.\n")
-			fmt.Printf("\t To fix, use .htaccess rules or equivalent to make reading directories listings forbidden.\n")
-			fmt.Printf("\t Directories Identified:\n")
-			for _, dir := range report.OpenDirectories {
-				fmt.Printf("\t\t%s\n", dir)
-			}
-			fmt.Printf("\n")
-		}
-
 	}
 }

protocol/http_scanner.go

@@ -8,6 +8,7 @@ import (
 	"io/ioutil"
 	"log"
 	"net/http"
+	"strings"
 )
 
 type HTTPProtocolScanner struct {
@@ -50,8 +51,9 @@ func (hps *HTTPProtocolScanner) ScanProtocol(hiddenService string, proxyAddress
 		responseHeaders := response.Header
 		for key := range responseHeaders {
 			value := responseHeaders.Get(key)
-			report.AddResponseHeader(key, value)
+			// normalize by strings.ToUpper(key) to avoid case sensitive checking
-			log.Printf("\t%s : %s\n", key, value)
+			report.AddResponseHeader(strings.ToUpper(key), value)
+			log.Printf("\t%s : %s\n", strings.ToUpper(key), value)
 		}
 
 		report.ServerVersion = responseHeaders.Get("Server")

report/onionscanreport.go

@@ -2,7 +2,6 @@ package report
 
 import (
 	"encoding/json"
-	"fmt"
 	"github.com/s-rah/onionscan/utils"
 	"io/ioutil"
 )
@@ -40,11 +39,11 @@ type OnionScanReport struct {
 	InterestingFiles          []string    `json:"interestingFiles"`
 	PageReferencedDirectories []string    `json:"pageReferencedDirectories"`
 
-	Hashes          []string `json:"hashes"`
+	Hashes          []string          `json:"hashes"`
-	SSHKey          string   `json:"sshKey"`
+	SSHKey          string            `json:"sshKey"`
-	Snapshot        string   `json:"snapshot"`
+	Snapshot        string            `json:"snapshot"`
-	PageTitle       string   `json:"pageTitle"`
+	PageTitle       string            `json:"pageTitle"`
-	ResponseHeaders []string `json:"responseHeaders"`
+	ResponseHeaders map[string]string `json:"responseHeaders"`
 }
 
 func LoadReportFromFile(filename string) (OnionScanReport, error) {
@@ -58,7 +57,7 @@ func LoadReportFromFile(filename string) (OnionScanReport, error) {
 }
 
 func NewOnionScanReport(hiddenService string) *OnionScanReport {
-	return &OnionScanReport{HiddenService: hiddenService}
+	return &OnionScanReport{HiddenService: hiddenService, ResponseHeaders: make(map[string]string)}
 }
 
 func (osr *OnionScanReport) AddOpenDirectory(dir string) {
@@ -87,8 +86,7 @@ func (osr *OnionScanReport) AddLinkedSite(site string) {
 }
 
 func (osr *OnionScanReport) AddResponseHeader(name string, value string) {
-	header := fmt.Sprintf("%s : %s ", name, value)
+	osr.ResponseHeaders[name] = value
-	osr.ResponseHeaders = append(osr.ResponseHeaders, header)
 }
 
 func (osr *OnionScanReport) Serialize() (string, error) {

report/report_generator.go

@@ -0,0 +1,184 @@
+package report
+
+import (
+	"bytes"
+	"fmt"
+	"log"
+	"os"
+)
+
+func GenerateJsonReport(reportFile string, report *OnionScanReport) {
+	jsonOut, _ := report.Serialize()
+	var buffer bytes.Buffer
+
+	buffer.WriteString(fmt.Sprintf("%s\n", jsonOut))
+
+	if len(reportFile) > 0 {
+		f, err := os.Create(reportFile)
+		if err != nil {
+			log.Fatalf("Cannot create report file: %s", err)
+			panic(err)
+		}
+
+		defer f.Close()
+
+		f.WriteString(buffer.String())
+	} else {
+		fmt.Print(buffer.String())
+	}
+}
+
+func GenerateSimpleReport(reportFile string, report *OnionScanReport) {
+	highRisk := 0
+	mediumRisk := 0
+	lowRisk := 0
+	info := 0
+
+	if report.FoundApacheModStatus {
+		highRisk += 1
+	}
+
+	if len(report.RelatedClearnetDomains) > 0 {
+		highRisk += 1
+	}
+
+	if len(report.RelatedOnionServices) > 0 {
+		mediumRisk += 1
+	}
+
+	if report.ExifImages != nil {
+		if len(report.ExifImages) > 10 {
+			highRisk += 1
+		} else {
+			mediumRisk += 1
+		}
+	}
+
+	if report.OpenDirectories != nil {
+		if len(report.OpenDirectories) > 3 {
+			mediumRisk += 1
+		} else {
+			lowRisk += 1
+		}
+	}
+
+	if report.InterestingFiles != nil {
+		if len(report.InterestingFiles) > 10 {
+			mediumRisk += 1
+		} else {
+			lowRisk += 1
+		}
+	}
+
+	if _, ok := report.ResponseHeaders["X-FRAME-OPTIONS"]; !ok {
+		info += 1
+	}
+
+	if _, ok := report.ResponseHeaders["X-XSS-PROTECTION"]; !ok {
+		info += 1
+	}
+
+	if _, ok := report.ResponseHeaders["X-CONTENT-TYPE-OPTIONS"]; !ok {
+		info += 1
+	}
+
+	if _, ok := report.ResponseHeaders["CONTENT-SECURITY-POLICY"]; !ok {
+		info += 1
+	}
+
+	buffer := bytes.NewBuffer(nil)
+	buffer.WriteString("--------------- OnionScan Report ---------------\n")
+	buffer.WriteString(fmt.Sprintf("High Risk Issues: %d\n", highRisk))
+	buffer.WriteString(fmt.Sprintf("Medium Risk Issues: %d\n", mediumRisk))
+	buffer.WriteString(fmt.Sprintf("Low Risk Issues: %d\n", lowRisk))
+	buffer.WriteString(fmt.Sprintf("Informational Issues: %d\n", info))
+	buffer.WriteString("\n")
+
+	if report.FoundApacheModStatus {
+		buffer.WriteString("\033[091mHigh Risk:\033[0m Apache mod_status is enabled and accessible\n")
+		buffer.WriteString("\t Why this is bad: An attacker can gain very valuable information\n\t from this internal status page including IP addresses, co-hosted services and user activity.\n")
+		buffer.WriteString("\t To fix, disable mod_status or serve it on a different port than the configured hidden service\n\n")
+	}
+
+	if len(report.RelatedClearnetDomains) > 0 {
+		buffer.WriteString("\033[091mHigh Risk:\033[0m You are hosting a clearnet site on the same server as this onion service!\n")
+		buffer.WriteString("\t Why this is bad: This may be intentional, but often isn't.\n\t Services are best operated in isolation such that a compromise of one does not mean a compromise of the other.\n")
+		buffer.WriteString("\t To fix, host all services on separate infrastructure\n\n")
+	}
+
+	if len(report.RelatedOnionServices) > 0 {
+		buffer.WriteString("\033[091mMedium Risk:\033[0m You are hosting multiple onion services on the same server as this onion service!\n")
+		buffer.WriteString("\t Why this is bad: This may be intentional, but often isn't.\n\t Hidden services are best operated in isolation such that a compromise of one does not mean a compromise of the other.\n")
+		buffer.WriteString("\t To fix, host all services on separate infrastructure\n\n")
+	}
+
+	if len(report.ExifImages) > 0 {
+		if len(report.ExifImages) > 10 {
+			buffer.WriteString("\033[091mHigh Risk:\033[0m Large number of images with EXIF metadata were discovered!\n")
+		} else {
+			buffer.WriteString("\033[091mMedium Risk:\033[0m Small number of images with EXIF metadata were discovered!\n")
+		}
+
+		buffer.WriteString("\t Why this is bad: EXIF metadata can itself deanonymize a user or\n\t service operator (e.g. GPS location, Name etc.). Or, when combined, can be used to link anonymous identities together.\n")
+		buffer.WriteString("\t To fix, re-encode all images to strip EXIF and other metadata.\n")
+		buffer.WriteString("\t Images Identified:\n")
+		for _, image := range report.ExifImages {
+			buffer.WriteString(fmt.Sprintf("\t\t%s\n", image.Location))
+		}
+		buffer.WriteString("\n")
+	}
+
+	if len(report.OpenDirectories) > 0 {
+		if len(report.OpenDirectories) > 10 {
+			buffer.WriteString("\033[091mMedium Risk:\033[0m Large number of open directories were discovered!\n")
+		} else {
+			buffer.WriteString("\033[091mLow Risk:\033[0m Small number of open directories were discovered!\n")
+		}
+
+		buffer.WriteString("\t Why this is bad: Open directories can reveal the existence of files\n\t not linked from the sites source code. Most of the time this is benign, but sometimes operators forget to clean up more sensitive folders.\n")
+		buffer.WriteString("\t To fix, use .htaccess rules or equivalent to make reading directories listings forbidden.\n")
+		buffer.WriteString("\t Directories Identified:\n")
+		for _, dir := range report.OpenDirectories {
+			buffer.WriteString(fmt.Sprintf("\t\t%s\n", dir))
+		}
+		buffer.WriteString("\n")
+	}
+
+	if report.ResponseHeaders != nil {
+		if _, ok := report.ResponseHeaders["X-FRAME-OPTIONS"]; !ok {
+			buffer.WriteString("Info: Missing X-Frame-Options HTTP header discovered!\n")
+			buffer.WriteString("\t Why this is bad: Provides Clickjacking protection. Values: deny - no rendering within a frame, sameorigin\n\t - no rendering if origin mismatch, allow-from: DOMAIN - allow rendering if framed by frame loaded from DOMAIN\n")
+			buffer.WriteString("\t To fix, use X-Frame-Options: deny\n")
+		}
+		if _, ok := report.ResponseHeaders["X-XSS-PROTECTION"]; !ok {
+			buffer.WriteString("Info: Missing X-XSS-Protection HTTP header discovered!\n")
+			buffer.WriteString("\t Why this is bad: This header enables the Cross-site scripting (XSS) filter built\n\t into most recent web browsers. It's usually enabled by default anyway,\n\t so the role of this header is to re-enable the filter for this particular website if it was disabled by the user.\n")
+			buffer.WriteString("\t To fix, use X-XSS-Protection: 1; mode=block\n")
+		}
+		if _, ok := report.ResponseHeaders["X-CONTENT-TYPE-OPTIONS"]; !ok {
+			buffer.WriteString("Info:  Missing X-Content-Type-Options HTTP header discovered!\n")
+			buffer.WriteString("\t Why this is bad: The only defined value, \"nosniff\", prevents browsers\n\t from MIME-sniffing a response away from the declared content-type.\n\t This reduces exposure to drive-by download attacks and sites serving user\n\t uploaded content that, by clever naming, could be treated as executable or dynamic HTML files.\n")
+			buffer.WriteString("\t To fix, use  X-Content-Type-Options: nosniff\n")
+		}
+		if _, ok := report.ResponseHeaders["CONTENT-SECURITY-POLICY"]; !ok {
+			buffer.WriteString("Info: Missing X-Content-Type-Options HTTP header discovered!\n")
+			buffer.WriteString("\t Why this is bad: Content Security Policy requires careful tuning and precise definition of the policy.\n\t If enabled, CSP has significant impact on the way browser renders pages (e.g., inline\n\t JavaScript disabled by default and must be explicitly allowed in policy).\n\t CSP prevents a wide range of attacks, including Cross-site scripting and other cross-site injections.\n")
+			buffer.WriteString("\t To fix, use  Content-Security-Policy: default-src 'self'\n")
+		}
+
+	}
+
+	if len(reportFile) > 0 {
+		f, err := os.Create(reportFile)
+		if err != nil {
+			log.Fatalf("Cannot create report file: %s", err)
+			panic(err)
+		}
+
+		defer f.Close()
+
+		f.WriteString(buffer.String())
+	} else {
+		fmt.Print(buffer.String())
+	}
+}