Adding Descriptions (#3258)

* adding AI generated descriptions of the key types and their capabilities

* removing empty file

* Update abbysale.go

* update to interface

* fixes

* fix

* small cleanup

---------

Co-authored-by: Dylan Ayrey <[email protected]>
Co-authored-by: Dustin Decker <[email protected]>

Author: 3 people

go.sum

@@ -254,3 +254,12 @@ func permutateMatches(regexMatches map[string][][]string) []map[string][]string
 func (c *CustomRegexWebhook) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_CustomRegex
 }
+
+const defaultDescription = "This is a customer-defined detector with no description provided."
+
+func (c *CustomRegexWebhook) Description() string {
+	if c.GetDescription() == "" {
+		return defaultDescription
+	}
+	return c.GetDescription()
+}

pkg/custom_detectors/custom_detectors.go

@@ -98,3 +98,7 @@ func verifyAbbysale(ctx context.Context, client *http.Client, resMatch string) (
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Abbysale
 }
+
+func (s Scanner) Description() string {
+	return "Abbysale is a service offering various API functionalities for marketing automation and services such as images and ad campaigns. Abbysale API keys can be used to access and interact with this data."
+}

pkg/detectors/abbysale/abbysale.go

@@ -98,3 +98,7 @@ func verifyAbstract(ctx context.Context, client *http.Client, resMatch string) (
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Abstract
 }
+
+func (s Scanner) Description() string {
+	return "Abstract API provides various services including exchange rates. The API keys can be used to access these services and retrieve data."
+}

pkg/detectors/abstract/abstract.go

@@ -109,3 +109,7 @@ func verifyAbuseIPDB(ctx context.Context, client *http.Client, resMatch string)
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_AbuseIPDB
 }
+
+func (s Scanner) Description() string {
+	return "AbuseIPDB is a project dedicated to helping combat the spread of hackers, spammers, and abusive activity on the internet. AbuseIPDB API keys can be used to report and check IP addresses for abusive activities."
+}

pkg/detectors/abuseipdb/abuseipdb.go

@@ -98,3 +98,7 @@ func verifyAccuweather(ctx context.Context, client *http.Client, resMatch string
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Accuweather
 }
+
+func (s Scanner) Description() string {
+	return "Accuweather is a weather forecasting service. Accuweather API keys can be used to access weather data and forecasts."
+}

pkg/detectors/accuweather/accuweather.go

@@ -97,3 +97,7 @@ func verifyAdafruitIO(ctx context.Context, client *http.Client, resMatch string)
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_AdafruitIO
 }
+
+func (s Scanner) Description() string {
+	return "Adafruit IO is a cloud service used for IoT applications. Adafruit IO keys can be used to access and control data and devices connected to the platform."
+}

pkg/detectors/adafruitio/adafruitio.go

@@ -83,3 +83,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_AdobeIO
 }
+
+func (s Scanner) Description() string {
+	return "AdobeIO provides APIs for integrating with Adobe services. These credentials can be used to access Adobe services and data."
+}

pkg/detectors/adobeio/adobeio.go

@@ -108,3 +108,7 @@ func verifyAdzuna(ctx context.Context, client *http.Client, resMatch, resIdMatch
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Adzuna
 }
+
+func (s Scanner) Description() string {
+	return "Adzuna is a job search engine used to find job listings. Adzuna API keys can be used to access job listing data."
+}

pkg/detectors/adzuna/adzuna.go

@@ -113,3 +113,7 @@ func verifyAeroworkflow(ctx context.Context, client *http.Client, resMatch, resI
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Aeroworkflow
 }
+
+func (s Scanner) Description() string {
+	return "Aeroworkflow is a service for managing workflows. Aeroworkflow API keys and Account IDs can be used to access and manage workflows."
+}