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]>

pkg/custom_detectors/custom_detectors.go

@@ -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/detectors/abbysale/abbysale.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/abstract/abstract.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/abuseipdb/abuseipdb.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/accuweather/accuweather.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/adafruitio/adafruitio.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/adobeio/adobeio.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/adzuna/adzuna.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/aeroworkflow/aeroworkflow.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."
+}

pkg/detectors/agora/agora.go

@@ -111,3 +111,7 @@ func verifyAgora(ctx context.Context, client *http.Client, resMatch, resSecret s
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Agora
 }
+
+func (s Scanner) Description() string {
+	return "Agora is a real-time engagement platform providing APIs for voice, video, and messaging. Agora API keys can be used to access and manage these services."
+}

pkg/detectors/aha/aha.go

@@ -108,3 +108,7 @@ func verifyAha(ctx context.Context, client *http.Client, resMatch, resURLMatch s
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Aha
 }
+
+func (s Scanner) Description() string {
+	return "Aha is a product management software suite. Aha API keys can be used to access and modify product data and workflows."
+}

pkg/detectors/airbrakeprojectkey/airbrakeprojectkey.go

@@ -90,3 +90,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_AirbrakeProjectKey
 }
+
+func (s Scanner) Description() string {
+	return "Airbrake is an error and performance monitoring service for web applications. Airbrake project keys can be used to report and track errors in applications."
+}

pkg/detectors/airbrakeuserkey/airbrakeuserkey.go

@@ -44,9 +44,9 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 		s1 := detectors.Result{
 			DetectorType: detectorspb.DetectorType_AirbrakeUserKey,
 			Raw:          []byte(resMatch),
-		}
-		s1.ExtraData = map[string]string{
-			"rotation_guide": "https://howtorotate.com/docs/tutorials/airbrake/",
+			ExtraData: map[string]string{
+				"rotation_guide": "https://howtorotate.com/docs/tutorials/airbrake/",
+			},
 		}
 
 		if verify {
@@ -72,3 +72,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_AirbrakeUserKey
 }
+
+func (s Scanner) Description() string {
+	return "Airbrake is an error and performance monitoring service. Airbrake User Keys can be used to access and manage error reports and performance data."
+}

pkg/detectors/airship/airship.go

@@ -72,3 +72,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Airship
 }
+
+func (s Scanner) Description() string {
+	return "Airship is a customer engagement platform that provides tools for mobile app messaging, in-app messaging, and web notifications. Airship API keys can be used to access and manage these messaging services."
+}

pkg/detectors/airtableapikey/airtableapikey.go

@@ -108,3 +108,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_AirtableApiKey
 }
+
+func (s Scanner) Description() string {
+	return "Airtable is a cloud collaboration service that offers database-like features. Airtable API keys can be used to access and modify data within Airtable bases."
+}

pkg/detectors/airvisual/airvisual.go

@@ -72,3 +72,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_AirVisual
 }
+
+func (s Scanner) Description() string {
+	return "AirVisual provides air quality information and monitoring. The API key allows access to various air quality data and services."
+}

pkg/detectors/aiven/aiven.go

@@ -71,3 +71,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Aiven
 }
+
+func (s Scanner) Description() string {
+	return "Aiven is a managed cloud service that provides various open-source data infrastructure services. Aiven API keys can be used to access and manage these services."
+}

pkg/detectors/alchemy/alchemy.go

@@ -95,3 +95,7 @@ func verifyMatch(ctx context.Context, client *http.Client, token string) (bool,
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Alchemy
 }
+
+func (s Scanner) Description() string {
+	return "Alchemy is a blockchain development platform that provides a suite of tools and services for building and scaling decentralized applications. Alchemy API keys can be used to access these services."
+}

pkg/detectors/alconost/alconost.go

@@ -75,3 +75,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Alconost
 }
+
+func (s Scanner) Description() string {
+	return "Alconost is a translation and localization service. Alconost API keys can be used to access and modify translation data."
+}

pkg/detectors/alegra/alegra.go

@@ -84,3 +84,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Alegra
 }
+
+func (s Scanner) Description() string {
+	return "Alegra is a cloud-based accounting software. Alegra API keys can be used to access and modify accounting data and user information."
+}

pkg/detectors/aletheiaapi/aletheiaapi.go

@@ -74,3 +74,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_AletheiaApi
 }
+
+func (s Scanner) Description() string {
+	return "AletheiaApi is a service providing financial data. AletheiaApi keys can be used to access this data."
+}

pkg/detectors/algoliaadminkey/algoliaadminkey.go

@@ -81,3 +81,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_AlgoliaAdminKey
 }
+
+func (s Scanner) Description() string {
+	return "Algolia is a search-as-a-service platform. Algolia Admin Keys can be used to manage indices and API keys, and perform administrative tasks."
+}

pkg/detectors/alibaba/alibaba.go

@@ -53,6 +53,10 @@ func (s Scanner) Keywords() []string {
 	return []string{"LTAI"}
 }
 
+func (s Scanner) Description() string {
+	return "Alibaba Cloud is a cloud computing service that provides a suite of cloud computing services including data storage, relational databases, big-data processing, and content delivery networks (CDNs). Alibaba Cloud API keys can be used to access and manage these services."
+}
+
 func randString(n int) string {
 	const alphanum = "0123456789abcdefghijklmnopqrstuvwxyz"
 	var bytes = make([]byte, n)

pkg/detectors/alienvault/alienvault.go

@@ -70,3 +70,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_AlienVault
 }
+
+func (s Scanner) Description() string {
+	return "AlienVault is a threat intelligence platform providing real-time data on emerging threats. AlienVault API keys can be used to access threat data and other services."
+}

pkg/detectors/allsports/allsports.go

@@ -77,3 +77,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Allsports
 }
+
+func (s Scanner) Description() string {
+	return "Allsports API keys can be used to access and interact with the Allsports API, allowing retrieval of sports data and other related operations."
+}

pkg/detectors/amadeus/amadeus.go

@@ -89,3 +89,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Amadeus
 }
+
+func (s Scanner) Description() string {
+	return "Amadeus provides travel technology solutions. Amadeus API keys can be used to access and modify travel-related data and services."
+}

pkg/detectors/ambee/ambee.go

@@ -71,3 +71,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Ambee
 }
+
+func (s Scanner) Description() string {
+	return "Ambee provides environmental and climate data APIs. Ambee API keys can be used to access this data for various applications such as weather forecasting, air quality monitoring, and more."
+}

pkg/detectors/amplitudeapikey/amplitudeapikey.go

@@ -82,3 +82,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_AmplitudeApiKey
 }
+
+func (s Scanner) Description() string {
+	return "Amplitude is a product analytics service that helps companies track and analyze user behavior within web and mobile applications. Amplitude API keys can be used to access and modify this data."
+}

pkg/detectors/anthropic/anthropic.go

@@ -124,3 +124,7 @@ func verifyToken(ctx context.Context, client *http.Client, apiKey string) (bool,
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Anthropic
 }
+
+func (s Scanner) Description() string {
+	return "Anthropic is an AI research company. The API keys can be used to access their AI models and services."
+}

pkg/detectors/anypoint/anypoint.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_Anypoint
 }
+
+func (s Scanner) Description() string {
+	return "Anypoint is a unified platform that allows organizations to build and manage APIs and integrations. Anypoint credentials can be used to access and manipulate these integrations and API data."
+}

pkg/detectors/apacta/apacta.go

@@ -70,3 +70,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Apacta
 }
+
+func (s Scanner) Description() string {
+	return "Apacta is a project management tool designed for the construction industry. Apacta API keys can be used to access and manage project data within the Apacta platform."
+}

pkg/detectors/api2cart/api2cart.go

@@ -4,11 +4,12 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	regexp "github.com/wasilibs/go-re2"
 	"io"
 	"net/http"
 	"strings"
 
+	regexp "github.com/wasilibs/go-re2"
+
 	"github.com/trufflesecurity/trufflehog/v3/pkg/common"
 	"github.com/trufflesecurity/trufflehog/v3/pkg/detectors"
 	"github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb"
@@ -85,3 +86,7 @@ type Response struct {
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Api2Cart
 }
+
+func (s Scanner) Description() string {
+	return "Api2Cart is a unified shopping cart data interface that allows interaction with multiple shopping cart platforms. Api2Cart API keys can be used to access and manipulate shopping cart data."
+}

pkg/detectors/apideck/apideck.go

@@ -85,3 +85,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_ApiDeck
 }
+
+func (s Scanner) Description() string {
+	return "ApiDeck is a platform that provides a unified API to connect multiple services. ApiDeck keys can be used to access and manage these services."
+}

pkg/detectors/apiflash/apiflash.go

@@ -81,3 +81,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Apiflash
 }
+
+func (s Scanner) Description() string {
+	return "Apiflash is a screenshot API service. Apiflash keys can be used to access and utilize the screenshot API service."
+}

pkg/detectors/apifonica/apifonica.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_ApiFonica
 }
+
+func (s Scanner) Description() string {
+	return "Apifonica is a cloud communication platform that provides APIs for messaging, voice, and other communication services. Apifonica keys can be used to access and manage these services."
+}

pkg/detectors/apify/apify.go

@@ -69,3 +69,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Apify
 }
+
+func (s Scanner) Description() string {
+	return "Apify is a platform for web scraping and automation. Apify API keys can be used to access and control Apify actors and tasks."
+}

pkg/detectors/apilayer/apilayer.go

@@ -70,3 +70,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Apilayer
 }
+
+func (s Scanner) Description() string {
+	return "Apilayer is a service providing various APIs for data verification and other utilities. Apilayer API keys can be used to access these services and perform operations such as number verification."
+}

pkg/detectors/apimatic/apimatic.go

@@ -85,3 +85,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_APIMatic
 }
+
+func (s Scanner) Description() string {
+	return "APIMatic provides tools for generating SDKs, API documentation, and code snippets. APIMatic credentials can be used to access and manage these tools and services."
+}

pkg/detectors/apiscience/apiscience.go

@@ -71,3 +71,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_ApiScience
 }
+
+func (s Scanner) Description() string {
+	return "ApiScience is a tool for monitoring the performance of APIs. ApiScience keys can be used to access and manage API monitors."
+}

pkg/detectors/apitemplate/apitemplate.go

@@ -71,3 +71,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_APITemplate
 }
+
+func (s Scanner) Description() string {
+	return "APITemplate is a service used to generate documents and images from templates. APITemplate API keys can be used to access and generate these documents and images."
+}

pkg/detectors/apollo/apollo.go

@@ -70,3 +70,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Apollo
 }
+
+func (s Scanner) Description() string {
+	return "Apollo is a sales intelligence platform. Apollo API keys can be used to access and modify data within the Apollo platform."
+}

pkg/detectors/appcues/appcues.go

@@ -93,3 +93,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Appcues
 }
+
+func (s Scanner) Description() string {
+	return "Appcues is a user engagement platform that helps create personalized user experiences. The detected credentials can be used to access and manage user engagement flows and data."
+}

pkg/detectors/appfollow/appfollow.go

@@ -71,3 +71,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Appfollow
 }
+
+func (s Scanner) Description() string {
+	return "Appfollow is a service used for app monitoring and analytics. Appfollow API tokens can be used to access and manage app data and analytics."
+}

pkg/detectors/appointedd/appointedd.go

@@ -76,3 +76,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_Appointedd
 }
+
+func (s Scanner) Description() string {
+	return "Appointedd provides online booking and scheduling services. The API key can be used to access and manage booking data."
+}

pkg/detectors/appoptics/appoptics.go

@@ -90,3 +90,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 func (s Scanner) Type() detectorspb.DetectorType {
 	return detectorspb.DetectorType_AppOptics
 }
+
+func (s Scanner) Description() string {
+	return "AppOptics is a cloud-based infrastructure monitoring service. AppOptics API keys can be used to access and manage monitoring data and configurations."
+}