#8: Add new skip output options (#32)

* #8: Add skip options to OutputOptions struct

* #8: Add skip option flags for command line

* #8: Add new output options to the README

* #8: Add new output options to HTML template

* #8: Add new output options to Markdown template

Author: vdjagilev

README.md

@@ -49,6 +49,18 @@ nmap-formatter [path-to-nmap.xml] md > some-markdown.md
 * `--skip-down-hosts` skips hosts that are down
   * Applicable in: `html`, `md`, `csv`
   * Default: `true`
+* `--skip-summary` skips summary table
+  * Applicable in: `html`, `md`
+  * Default: `false`
+* `--skip-traceroute` skips traceroute information
+  * Applicable in: `html`
+  * Default: `false`
+* `--skip-metrics` skips metrics information
+  * Applicable in: `html`
+  * Default: `false`
+* `--skip-port-scripts` skips port scripts information in ports table
+  * Applicable in: `html`, `md`
+  * Default: `false`
 * `--json-pretty` pretty-prints JSON
   * Applicable in: `json`
   * Default: `true`

cmd/root.go

@@ -64,6 +64,10 @@ func init() {
 
 	// Some options related to the output
 	rootCmd.Flags().BoolVar(&config.OutputOptions.SkipDownHosts, "skip-down-hosts", true, "--skip-down-hosts=false")
+	rootCmd.Flags().BoolVar(&config.OutputOptions.SkipSummary, "skip-summary", false, "--skip-summary=true, skips summary in HTML/Markdown output")
+	rootCmd.Flags().BoolVar(&config.OutputOptions.SkipTraceroute, "skip-traceroute", false, "--skip-traceroute=true, skips traceroute information in HTML/Markdown output")
+	rootCmd.Flags().BoolVar(&config.OutputOptions.SkipMetrics, "skip-metrics", false, "--skip-metrics=true, skips metrics information in HTML/Markdown output")
+	rootCmd.Flags().BoolVar(&config.OutputOptions.SkipPortScripts, "skip-port-scripts", false, "--skip-port-scripts=true, skips port scripts information in HTML/Markdown output")
 	rootCmd.Flags().BoolVar(&config.OutputOptions.JSONPrettyPrint, "json-pretty", true, "--json-pretty=false (pretty prints JSON output)")
 
 	workflow = &formatter.MainWorkflow{}

formatter/output_options.go

@@ -6,4 +6,12 @@ type OutputOptions struct {
 	SkipDownHosts bool
 	// JSONPrettyPrint defines if JSON output would be pretty-printed (human-readable) or not (machine readable)
 	JSONPrettyPrint bool
+	// SkipSummary skips general summary for HTML & Markdown
+	SkipSummary bool
+	// SkipTraceroute skips traceroute information for HTML & Markdown
+	SkipTraceroute bool
+	// SkipMetrics skips metrics related data for HTML
+	SkipMetrics bool
+	// SkipPortScripts skips port scripts information for HTML
+	SkipPortScripts bool
 }

formatter/resources/templates/markdown.tmpl

@@ -1,23 +1,29 @@
 NMAP Scan Result: {{ .NMAPRun.StartStr }}
 ==========================================
 {{- $displayDownHosts := not .OutputOptions.SkipDownHosts }}
+{{- $skipSummary := .OutputOptions.SkipSummary }}
+{{- $skipPortScripts := .OutputOptions.SkipPortScripts }}
 
 ## TOC
 
+{{- if not $skipSummary }}
 * [Scan Summary](#scan-summary)
+{{- end }}{{/* if $skipSummary */}}
 {{- range .NMAPRun.Host -}}
 {{- if or ($displayDownHosts) (eq .Status.State "up") }}
 * [{{ .HostAddress.Address }}{{ range .HostNames.HostName }} / {{ .Name }}{{ end }} ({{ .Status.State }})](#{{ md_toc .HostAddress.Address }})
 {{- if eq .Status.State "up" }}
 	* [Info](#{{ md_toc .HostAddress.Address }}-info)
 	* [Ports](#{{ md_toc .HostAddress.Address }}-ports)
+	{{- if not $skipPortScripts }}
 	* [Scripts](#{{ md_toc .HostAddress.Address }}-scripts)
-{{ end }}
+	{{- end -}}{{/* if not $skipPortScripts */}}
+{{- end }}
 {{- end -}}{{/* if or ($displayDownHosts) (eq .Status.State "up") */}}
 {{- end -}}{{/* range .Host */}}
 
+{{- if not $skipSummary }}
 ----
-
 ## Scan Summary
 
 | Name | Value |
@@ -37,7 +43,7 @@ NMAP Scan Result: {{ .NMAPRun.StartStr }}
 | Exit (success) | {{ .NMAPRun.RunStats.Finished.Exit }} |
 | Summary | {{ .NMAPRun.RunStats.Finished.Summary }} |
 | Hosts | Up: {{ .NMAPRun.RunStats.Hosts.Up }}, Down: {{ .NMAPRun.RunStats.Hosts.Down }}, Total: {{ .NMAPRun.RunStats.Hosts.Total }} |
-
+{{ end }}{{/* if not $skipSummary */}}
 ----
 
 {{ range .NMAPRun.Host -}}
@@ -75,6 +81,7 @@ NMAP Scan Result: {{ .NMAPRun.StartStr }}
 {{ range .Ports.Port -}}
 | {{ .PortID }} | {{ .Protocol }} | {{ .State.State }} | {{ .Service.Name }} | {{ .State.Reason }} | {{ .Service.Product }} | {{ .Service.Version }} | {{ .Service.ExtraInfo }} |
 {{ end }}{{/* range .Ports.Port */}}
+{{ if not $skipPortScripts }}
 <a id="{{ md_toc .HostAddress.Address }}-scripts"></a>
 
 ### Scripts:
@@ -90,6 +97,7 @@ NMAP Scan Result: {{ .NMAPRun.StartStr }}
 
 {{- end -}}{{/* range .Script */}}
 {{- end -}}{{/* if .Script */}}
+{{ end -}}{{/* if not $skipPortScripts */}}
 {{ end -}}{{/* range .Ports.Port */}}
 {{- end -}}{{/* if eq .Status.State "up" */}}
 

formatter/resources/templates/simple-html.gohtml

@@ -78,18 +78,23 @@
 	</head>
 	<body>
 		{{ $displayDownHosts := not .OutputOptions.SkipDownHosts }}
+		{{ $skipSummary := .OutputOptions.SkipSummary }}
+		{{ $skipTraceroute := .OutputOptions.SkipTraceroute }}
+		{{ $skipMetrics := .OutputOptions.SkipMetrics }}
+		{{ $skipPortScripts := .OutputOptions.SkipPortScripts }}
 		<h1>NMAP Scan Result: {{ .NMAPRun.StartStr }}</h1>
 		<hr />
 		<h2>TOC:</h2>
 		<ul>
-			<li><a href="#scan-summary">Scan Summary</a></li>
+			{{ if not $skipSummary }}<li><a href="#scan-summary">Scan Summary</a></li>{{ end }}
 			{{ range .NMAPRun.Host }}
 			{{ if or ($displayDownHosts) (eq .Status.State "up") }}
 			<li><a href="#{{ .HostAddress.Address }}">{{ .HostAddress.Address }}{{ range .HostNames.HostName }} / {{ .Name }}{{ end }}</a> ({{ .Status.State }})</li>
 			{{ end }}{{/* if or ($displayDownHosts) (eq .Status.State "up") */}}
 			{{ end }}{{/* range .Host */}}
 		</ul>
 		<hr />
+		{{ if not $skipSummary }}
 		<a name="scan-summary"></a>
 		<h2>Scan Summary:</h2>
 		<table id="summary-table">
@@ -162,6 +167,7 @@
 			</tbody>
 		</table>
 		<hr />
+		{{ end }}{{/* if not $skipSummary */}}
 		{{ range .NMAPRun.Host }}
 		{{ if or ($displayDownHosts) (eq .Status.State "up") }}
 		<a name="{{ .HostAddress.Address }}"></a>
@@ -234,19 +240,19 @@
 					<td>{{ .Service.Version }}</td>
 					<td>{{ .Service.ExtraInfo }}</td>
 				</tr>
-				{{ if .Script }}
+				{{ if and (.Script) (not $skipPortScripts) }}
 				{{ range .Script }}
 				<tr>
 					<td></td>
 					<td>{{ .ID }}</td>
 					<td colspan="6"><pre>{{- .Output -}}</pre></td>
 				</tr>
 				{{ end }}{{/* range .Script */}}
-				{{ end }}{{/* if .Script */}}
+				{{ end }}{{/* if and (.Script) (not $skipPortScripts) */}}
 				{{ end }}{{/* range .Ports.Port */}}
 			</tbody>
 		</table>
-		{{ if .Trace }}
+		{{ if and (.Trace) (not $skipTraceroute) }}
 		<h3>Traceroute Information</h3>
 		{{ if .Trace.Hops }}
 		<details>
@@ -275,7 +281,8 @@
 		{{ else }}
 		No traceroute information.
 		{{ end }}{{/* if .Trace.Hops */}}
-		{{ end }}{{/* if .Trace */}}
+		{{ end }}{{/* if and (.Trace) (not $skipTraceroute) */}}
+		{{ if not $skipMetrics }}
 		<h3>Misc Metrics</h3>
 		<details>
 			<summary>(open)</summary>
@@ -314,6 +321,7 @@
 				</tbody>
 			</table>
 		</details>
+		{{ end }}{{/* if not $skipMetrics */}}
 		<hr />
 		{{ end }}{{/* if eq .Status.State "up" */}}
 		{{ end }}{{/* if or ($displayDownHosts) (eq .Status.State "up") */}}