add MissingCredentials field to Result

jreisinger · Jun 7, 2024 · 25193ea · 25193ea
1 parent ceeaaf8
commit 25193ea
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 4 deletions.
diff --git a/check/abuseipdb.go b/check/abuseipdb.go
@@ -47,6 +47,7 @@ func AbuseIPDB(ipaddr net.IP) (checkip.Result, error) {
 		return result, newCheckError(err)
 	}
 	if apiKey == "" { // we don't consider missing to be an error
+		result.MissingCredentials = "ABUSEIPDB_API_KEY"
 		return result, nil
 	}
 

diff --git a/check/maxmind.go b/check/maxmind.go
@@ -45,6 +45,7 @@ func MaxMind(ip net.IP) (checkip.Result, error) {
 		return result, newCheckError(err)
 	}
 	if licenseKey == "" {
+		result.MissingCredentials = "MAXMIND_LICENSE_KEY"
 		return result, nil
 	}
 

diff --git a/check/shodan.go b/check/shodan.go
@@ -39,6 +39,7 @@ func Shodan(ipaddr net.IP) (checkip.Result, error) {
 		return result, newCheckError(err)
 	}
 	if apiKey == "" {
+		result.MissingCredentials = "SHODAN_API_KEY"
 		return result, nil
 	}
 

diff --git a/check/urlscan.go b/check/urlscan.go
@@ -26,6 +26,7 @@ func UrlScan(ipaddr net.IP) (checkip.Result, error) {
 		return result, newCheckError(err)
 	}
 	if apiKey == "" {
+		result.MissingCredentials = "URLSCAN_API_KEY"
 		return result, nil
 	}
 

diff --git a/check/virustotal.go b/check/virustotal.go
@@ -52,6 +52,7 @@ func VirusTotal(ipaddr net.IP) (checkip.Result, error) {
 		return result, newCheckError(err)
 	}
 	if apiKey == "" {
+		result.MissingCredentials = "VIRUSTOTAL_API_KEY"
 		return result, nil
 	}
 

diff --git a/checkip.go b/checkip.go
@@ -39,10 +39,11 @@ type Check func(ipaddr net.IP) (Result, error)
 
 // Result is the information provided by a Check.
 type Result struct {
-	Name      string `json:"name"`      // check name, max 15 chars
-	Type      Type   `json:"type"`      // check type
-	Malicious bool   `json:"malicious"` // provided by TypeSec and TypeInfoSec check type
-	Info      Info   `json:"info"`
+	Name               string `json:"name"` // check name, max 15 chars
+	Type               Type   `json:"type"` // check type
+	MissingCredentials string `json:"missing_credentials,omitempty"`
+	Malicious          bool   `json:"malicious"` // provided by TypeSec and TypeInfoSec check type
+	Info               Info   `json:"info"`
 }
 
 // Info is generic information provided by a TypeInfo or TypeInfoSec Check.