feat: options to remove header and toc for html/mdd

vdjagilev · Apr 20, 2024 · ee7f568 · ee7f568
1 parent f938530
commit ee7f568
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 6 deletions.
diff --git a/cmd/root.go b/cmd/root.go
@@ -87,6 +87,14 @@ func init() {
 	rootCmd.Flags().BoolVar(&config.OutputOptions.CSVOptions.SkipDownHosts, "csv-skip-down-hosts", true, "--csv-skip-down-hosts=false, would print all hosts that are offline in CSV output")
 	rootCmd.Flags().BoolVar(&config.OutputOptions.ExcelOptions.SkipDownHosts, "excel-skip-down-hosts", true, "--excel-skip-down-hosts=false, would print all hosts that are offline in Excel file")
 
+	// Skip header information (overall meta information from the scan)
+	rootCmd.Flags().BoolVar(&config.OutputOptions.HTMLOptions.SkipHeader, "html-skip-header", false, "--html-skip-header, skips header in HTML output")
+	rootCmd.Flags().BoolVar(&config.OutputOptions.MarkdownOptions.SkipHeader, "md-skip-header", false, "--md-skip-header, skips header in Markdown output")
+
+	// Skip table of contents (TOC) information
+	rootCmd.Flags().BoolVar(&config.OutputOptions.HTMLOptions.SkipTOC, "html-skip-toc", false, "--html-skip-toc, skips table of contents in HTML output")
+	rootCmd.Flags().BoolVar(&config.OutputOptions.MarkdownOptions.SkipTOC, "md-skip-toc", false, "--md-skip-toc, skips table of contents in Markdown output")
+
 	// Skip summary (overall meta information from the scan)
 	rootCmd.Flags().BoolVar(&config.OutputOptions.HTMLOptions.SkipSummary, "html-skip-summary", false, "--html-skip-summary=true, skips summary in HTML output")
 	rootCmd.Flags().BoolVar(&config.OutputOptions.MarkdownOptions.SkipSummary, "md-skip-summary", false, "--md-skip-summary=true, skips summary in Markdown output")

diff --git a/formatter/output_options.go b/formatter/output_options.go
@@ -13,6 +13,10 @@ type OutputOptions struct {
 
 // HTMLOutputOptions stores options related only to HTML conversion/formatting
 type HTMLOutputOptions struct {
+	// SkipHeader skips the header of the HTML output
+	SkipHeader bool
+	// SkipTOC skips the table of contents in the HTML output
+	SkipTOC bool
 	// SkipDownHosts skips hosts that are down (including TOC)
 	SkipDownHosts bool
 	// SkipSummary skips general summary for HTML
@@ -31,6 +35,10 @@ type HTMLOutputOptions struct {
 
 // MarkdownOutputOptions stores options related only to Markdown conversion/formatting
 type MarkdownOutputOptions struct {
+	// SkipHeader skips the header
+	SkipHeader bool
+	// SkipTOC skips the table of contents
+	SkipTOC bool
 	// SkipDownHosts skips hosts that are down (including TOC)
 	SkipDownHosts bool
 	// SkipSummary skips general summary for Markdown

diff --git a/formatter/resources/templates/markdown.tmpl b/formatter/resources/templates/markdown.tmpl
@@ -1,11 +1,14 @@
+{{- if not .OutputOptions.MarkdownOptions.SkipHeader -}}
 NMAP Scan Result: {{ .NMAPRun.StartStr }}
 ==========================================
-{{ $skipDownHosts := .OutputOptions.MarkdownOptions.SkipDownHosts }}
-{{ $skipSummary := .OutputOptions.MarkdownOptions.SkipSummary }}
-{{ $skipPortScripts := .OutputOptions.MarkdownOptions.SkipPortScripts }}
-{{ $skipMetrics := .OutputOptions.MarkdownOptions.SkipMetrics }}
-{{ $skipTraceroute := .OutputOptions.MarkdownOptions.SkipTraceroute }}
-
+{{ end }}
+{{- $skipTOC := .OutputOptions.MarkdownOptions.SkipTOC -}}
+{{- $skipDownHosts := .OutputOptions.MarkdownOptions.SkipDownHosts -}}
+{{- $skipSummary := .OutputOptions.MarkdownOptions.SkipSummary -}}
+{{- $skipPortScripts := .OutputOptions.MarkdownOptions.SkipPortScripts -}}
+{{- $skipMetrics := .OutputOptions.MarkdownOptions.SkipMetrics -}}
+{{- $skipTraceroute := .OutputOptions.MarkdownOptions.SkipTraceroute -}}
+{{ if not $skipTOC -}}
 ## TOC
 
 {{ if not $skipSummary }}
@@ -16,6 +19,7 @@ NMAP Scan Result: {{ .NMAPRun.StartStr }}
 * [{{ md_title . }}](#{{ md_link . }})
 {{- end -}}{{/* .ShouldNotSkipHost $skipDownHosts */}}
 {{- end -}}{{/* range .Host */}}
+{{- end -}}{{/* if not $skipTOC */}}
 
 {{- if not $skipSummary }}
 ----

diff --git a/formatter/resources/templates/simple-html.gohtml b/formatter/resources/templates/simple-html.gohtml
@@ -104,13 +104,18 @@
 		</style>
 	</head>
 	<body>
+		{{ $skipTOC := .OutputOptions.HTMLOptions.SkipTOC }}
+		{{ $skipHeader := .OutputOptions.HTMLOptions.SkipHeader }}
 		{{ $skipDownHosts := .OutputOptions.HTMLOptions.SkipDownHosts }}
 		{{ $skipSummary := .OutputOptions.HTMLOptions.SkipSummary }}
 		{{ $skipTraceroute := .OutputOptions.HTMLOptions.SkipTraceroute }}
 		{{ $skipMetrics := .OutputOptions.HTMLOptions.SkipMetrics }}
 		{{ $skipPortScripts := .OutputOptions.HTMLOptions.SkipPortScripts }}
+		{{- if not $skipHeader }}
 		<h1>NMAP Scan Result: {{ .NMAPRun.StartStr }}</h1>
 		<hr>
+		{{- end }}{{/* if not $skipHeader */}}
+		{{ if not $skipTOC }}
 		<div id="toc">
 			<h2>Table of contents:</h2>
 			<ul>
@@ -123,6 +128,7 @@
 			</ul>
 			<hr>
 		</div>
+		{{ end }}{{/* if not $skipTOC */}}
 		{{ if not $skipSummary }}
 		<a id="scan-summary"></a>
 		<h2>Scan Summary:</h2>