Tweak/separate host up func (#166)

* refactor: IsUp function for host

* tweak: more variations for should-skip-host func

* cicd: codeql fix

.github/workflows/codeql-analysis.yml

@@ -36,7 +36,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: ["go"]
+        include:
+          - language: go
+            build-mode: autobuild
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
         # Learn more:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed

formatter/formatter_csv.go

@@ -20,8 +20,8 @@ func (f *CSVFormatter) convert(td *TemplateData) (data [][]string) {
 	data = append(data, []string{"IP", "Port", "Protocol", "State", "Service", "Reason", "Product", "Version", "Extra info"})
 	for i := range td.NMAPRun.Host {
 		var host *Host = &td.NMAPRun.Host[i]
-		// Skipping hosts that are down
-		if td.OutputOptions.CSVOptions.SkipDownHosts && host.Status.State != "up" {
+		// shouldSkip := host.ShouldSkipHost(td.OutputOptions.CSVOptions.SkipDownHosts)
+		if host.ShouldSkipHost(td.OutputOptions.CSVOptions.SkipDownHosts) {
 			continue
 		}
 		address := fmt.Sprintf("%s (%s)", host.JoinedAddresses("/"), host.Status.State)

formatter/formatter_excel.go

@@ -75,22 +75,24 @@ func (f *ExcelFormatter) writeHostRows(h []Host, cd *CellData) error {
 	for i := range h {
 		host := h[i]
 
-		// Skipping hosts that are down
-		if f.config.OutputOptions.ExcelOptions.SkipDownHosts && host.Status.State != "up" {
+		if host.ShouldSkipHost(f.config.OutputOptions.ExcelOptions.SkipDownHosts) {
 			continue
 		}
 
 		joinedAddresses := host.JoinedAddresses("/")
 		joinedHostnames := host.JoinedHostNames("/")
+		addressFormat := "%s [%s]"
 		address := ""
 
 		if joinedHostnames == "" {
-			address = joinedAddresses
+			address = fmt.Sprintf(addressFormat, joinedAddresses, host.Status.State)
 		} else {
+			addressFormat = "%s (%s) [%s]"
 			address = fmt.Sprintf(
-				"%s (%s)",
+				addressFormat,
 				joinedAddresses,
 				joinedHostnames,
+				host.Status.State,
 			)
 		}
 
@@ -126,6 +128,19 @@ func (f *ExcelFormatter) writeHostRows(h []Host, cd *CellData) error {
 func (f *ExcelFormatter) writePorts(p []Port, cd *CellData, row *int) error {
 	var err error
 
+	// The case when there are no open ports
+	if len(p) == 0 {
+		err = cd.writeCell(
+			fmt.Sprintf("%c%d", 'B', *row),
+			"-",
+		)
+		if err != nil {
+			return err
+		}
+		*row++
+		return nil
+	}
+
 	for i := range p {
 		port := p[i]
 

formatter/nmap_host.go

@@ -50,6 +50,19 @@ func (h *Host) JoinedHostNames(delimiter string) string {
 	return hostAddr
 }
 
+// ShouldSkipHost returns true if host should be skipped in output
+// it's more convenient to use in loops, if we should skip the host
+// we use continue to the next host
+func (h *Host) ShouldSkipHost(skipDownHostsOption bool) bool {
+	return skipDownHostsOption && !h.Status.IsUp()
+}
+
+// ShouldNotSkipHost returns true if host should not be skipped in output
+// in some cases it's more convenient to write other way around (html, md templates)
+func (h *Host) ShouldNotSkipHost(skipDownHostsOption bool) bool {
+	return !h.ShouldSkipHost(skipDownHostsOption)
+}
+
 // TCPTSSequence describes all information related to `<tcptssequence>` node
 type TCPTSSequence struct {
 	Class  string `xml:"class,attr"`
@@ -86,6 +99,11 @@ type HostStatus struct {
 	Reason string `xml:"reason,attr"`
 }
 
+// IsUp returns true if the host is up and accessible
+func (hs *HostStatus) IsUp() bool {
+	return hs.State == "up"
+}
+
 // HostAddress struct contains the host address (IP) and type of it.
 type HostAddress struct {
 	Address     string `xml:"addr,attr"`

formatter/nmap_host_test.go

@@ -218,3 +218,43 @@ func TestHost_JoinedHostNames(t *testing.T) {
 		})
 	}
 }
+
+func TestHostStatus_IsUp(t *testing.T) {
+	type fields struct {
+		State  string
+		Reason string
+	}
+	tests := []struct {
+		name   string
+		fields fields
+		want   bool
+	}{
+		{
+			name: "Host is down",
+			fields: fields{
+				State:  "down",
+				Reason: "ping",
+			},
+			want: false,
+		},
+		{
+			name: "Host is up",
+			fields: fields{
+				State:  "up",
+				Reason: "no reason",
+			},
+			want: true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			hs := &HostStatus{
+				State:  tt.fields.State,
+				Reason: tt.fields.Reason,
+			}
+			if got := hs.IsUp(); got != tt.want {
+				t.Errorf("HostStatus.IsUp() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

formatter/resources/templates/graphviz.tmpl

@@ -12,7 +12,7 @@ strict digraph "Scan" {
     {{ end }}
 
     {{ range $key, $value := .NMAPRun.Host -}}
-    {{ if eq $value.Status.State "up" -}}
+    {{ if $value.Status.IsUp -}}
     srv{{ $key }} [label="{{ $value.JoinedAddresses "/" }}", tooltip="{{ $value.JoinedAddresses "/" }}", shape=hexagon, style=filled];
     {{ range $portKey, $portValue := $value.Port }}
     srv{{ $key }}_port_{{ $portValue.Protocol }}_{{ $portValue.PortID }} [label="{{ $portValue.Protocol }}/{{ $portValue.PortID }} ({{ $portValue.State.State }})", tooltip="{{ $portValue.Protocol }}/{{ $portValue.PortID }} ({{ $portValue.State.State }})", shape=underline, width=.12, height=.12, fontsize=8, color="{{ port_state_color $portValue }}"];

formatter/resources/templates/markdown.tmpl

@@ -1,6 +1,6 @@
 NMAP Scan Result: {{ .NMAPRun.StartStr }}
 ==========================================
-{{ $displayDownHosts := not .OutputOptions.MarkdownOptions.SkipDownHosts }}
+{{ $skipDownHosts := .OutputOptions.MarkdownOptions.SkipDownHosts }}
 {{ $skipSummary := .OutputOptions.MarkdownOptions.SkipSummary }}
 {{ $skipPortScripts := .OutputOptions.MarkdownOptions.SkipPortScripts }}
 {{ $skipMetrics := .OutputOptions.MarkdownOptions.SkipMetrics }}
@@ -12,9 +12,9 @@ NMAP Scan Result: {{ .NMAPRun.StartStr }}
 * [Scan Summary](#scan-summary)
 {{- end }}{{/* if $skipSummary */}}
 {{- range .NMAPRun.Host -}}
-{{- if or ($displayDownHosts) (eq .Status.State "up") }}
+{{- if .ShouldNotSkipHost $skipDownHosts }}
 * [{{ md_title . }}](#{{ md_link . }})
-{{- end -}}{{/* if or ($displayDownHosts) (eq .Status.State "up") */}}
+{{- end -}}{{/* .ShouldNotSkipHost $skipDownHosts */}}
 {{- end -}}{{/* range .Host */}}
 
 {{- if not $skipSummary }}
@@ -60,11 +60,11 @@ NMAP Scan Result: {{ .NMAPRun.StartStr }}
 ----
 
 {{ range .NMAPRun.Host -}}
-{{- if or ($displayDownHosts) (eq .Status.State "up") }}
+{{- if .ShouldNotSkipHost $skipDownHosts }}
 
 ## {{ md_title . }}
 
-{{- if eq .Status.State "up" }}
+{{- if .ShouldNotSkipHost $skipDownHosts }}
 ### Info:
 
 | Name | Value |
@@ -134,10 +134,10 @@ NMAP Scan Result: {{ .NMAPRun.StartStr }}
 {{- end -}}{{/* if .Script */}}
 {{ end -}}{{/* if not $skipPortScripts */}}
 {{ end -}}{{/* range .Port */}}
-{{- end -}}{{/* if eq .Status.State "up" */}}
+{{- end -}}{{/* if .ShouldNotSkipHost $skipDownHosts */}}
 
 ----
 
-{{- end -}}{{/* if or ($displayDownHosts) (eq .Status.State "up") */}}
+{{- end -}}{{/* if .ShouldNotSkipHost $skipDownHosts */}}
 
 {{- end -}}{{/* range .NMAPRun.Host */}}

formatter/resources/templates/simple-html.gohtml

@@ -104,7 +104,7 @@
 		</style>
 	</head>
 	<body>
-		{{ $displayDownHosts := not .OutputOptions.HTMLOptions.SkipDownHosts }}
+		{{ $skipDownHosts := .OutputOptions.HTMLOptions.SkipDownHosts }}
 		{{ $skipSummary := .OutputOptions.HTMLOptions.SkipSummary }}
 		{{ $skipTraceroute := .OutputOptions.HTMLOptions.SkipTraceroute }}
 		{{ $skipMetrics := .OutputOptions.HTMLOptions.SkipMetrics }}
@@ -116,9 +116,9 @@
 			<ul>
 				{{ if not $skipSummary }}<li><a href="#scan-summary">Scan Summary</a></li>{{ end }}
 				{{ range $index, $value := .NMAPRun.Host }}
-				{{ if or ($displayDownHosts) (eq .Status.State "up") }}
+				{{ if .ShouldNotSkipHost $skipDownHosts }}
 				<li><a href="#{{ $index }}">{{ .JoinedAddresses "/" }}{{ range .HostNames.HostName }} / {{ .Name }}{{ end }}</a> ({{ .Status.State }})</li>
-				{{ end }}{{/* if or ($displayDownHosts) (eq .Status.State "up") */}}
+				{{ end }}{{/* if .ShouldNotSkipHost $skipDownHosts */}}
 				{{ end }}{{/* range .Host */}}
 			</ul>
 			<hr>
@@ -215,10 +215,10 @@
 		{{ end }}{{/* if .CustomOptions */}}
 		<hr>
 		{{ range $index, $value := .NMAPRun.Host }}
-		{{ if or ($displayDownHosts) (eq .Status.State "up") }}
+		{{ if .ShouldNotSkipHost $skipDownHosts }}
 		<a id="{{ $index }}"></a>
-		<h2 class="host-address-header{{ if eq .Status.State "up" }} host-up{{ else }} host-down{{ end }}">
-		{{ .JoinedAddresses "/" }}{{ range .HostNames.HostName }} / {{ .Name }}{{ end }} {{ if eq .Status.State "up" }}(up){{ else }}(down){{ end }}
+		<h2 class="host-address-header{{ if .Status.IsUp }} host-up{{ else }} host-down{{ end }}">
+		{{ .JoinedAddresses "/" }}{{ range .HostNames.HostName }} / {{ .Name }}{{ end }} {{ if .Status.IsUp }}(up){{ else }}(down){{ end }}
 		</h2>
 		{{ if eq .Status.State "up" }}
 		<h3>Info:</h3>
@@ -376,7 +376,7 @@
 		{{ end }}{{/* if not $skipMetrics */}}
 		<hr>
 		{{ end }}{{/* if eq .Status.State "up" */}}
-		{{ end }}{{/* if or ($displayDownHosts) (eq .Status.State "up") */}}
+		{{ end }}{{/* if .ShouldNotSkipHost $skipDownHosts */}}
 		{{ end }}{{/* range .Host */}}
 	</body>
 </html>