Enhance Secret Descriptions (#1300)

* Enhance secret descriptions in gitleaks.toml

* adjust the rule configuration descriptions

* missing spaces in gitleaks.toml

cmd/generate/config/rules/adafruit.go

@@ -8,7 +8,7 @@ import (
 func AdafruitAPIKey() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Adafruit API Key",
+		Description: "Identified a potential Adafruit API Key, which could lead to unauthorized access to Adafruit services and sensitive data exposure.",
 		RuleID:      "adafruit-api-key",
 		Regex:       generateSemiGenericRegex([]string{"adafruit"}, alphaNumericExtendedShort("32"), true),
 		Keywords:    []string{"adafruit"},

cmd/generate/config/rules/adobe.go

@@ -8,7 +8,7 @@ import (
 func AdobeClientID() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Adobe Client ID (OAuth Web)",
+		Description: "Detected a pattern that resembles an Adobe OAuth Web Client ID, posing a risk of compromised Adobe integrations and data breaches.",
 		RuleID:      "adobe-client-id",
 		Regex:       generateSemiGenericRegex([]string{"adobe"}, hex("32"), true),
 		Keywords:    []string{"adobe"},
@@ -24,7 +24,7 @@ func AdobeClientID() *config.Rule {
 func AdobeClientSecret() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Adobe Client Secret",
+		Description: "Discovered a potential Adobe Client Secret, which, if exposed, could allow unauthorized Adobe service access and data manipulation.",
 		RuleID:      "adobe-client-secret",
 		Regex:       generateUniqueTokenRegex(`(p8e-)(?i)[a-z0-9]{32}`, true),
 		Keywords:    []string{"p8e-"},

cmd/generate/config/rules/age.go

@@ -9,7 +9,7 @@ import (
 func AgeSecretKey() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Age secret key",
+		Description: "Discovered a potential Age encryption tool secret key, risking data decryption and unauthorized access to sensitive information.",
 		RuleID:      "age secret key",
 		Regex:       regexp.MustCompile(`AGE-SECRET-KEY-1[QPZRY9X8GF2TVDW0S3JN54KHCE6MUA7L]{58}`),
 		Keywords:    []string{"AGE-SECRET-KEY-1"},

cmd/generate/config/rules/airtable.go

@@ -8,7 +8,7 @@ import (
 func Airtable() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Airtable API Key",
+		Description: "Uncovered a possible Airtable API Key, potentially compromising database access and leading to data leakage or alteration.",
 		RuleID:      "airtable-api-key",
 		Regex:       generateSemiGenericRegex([]string{"airtable"}, alphaNumeric("17"), true),
 		Keywords:    []string{"airtable"},

cmd/generate/config/rules/algolia.go

@@ -8,7 +8,7 @@ import (
 func AlgoliaApiKey() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Algolia API Key",
+		Description: "Identified an Algolia API Key, which could result in unauthorized search operations and data exposure on Algolia-managed platforms.",
 		RuleID:      "algolia-api-key",
 		Regex:       generateSemiGenericRegex([]string{"algolia"}, `[a-z0-9]{32}`, true),
 		Keywords:    []string{"algolia"},

cmd/generate/config/rules/alibaba.go

@@ -8,7 +8,7 @@ import (
 func AlibabaAccessKey() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Alibaba AccessKey ID",
+		Description: "Detected an Alibaba Cloud AccessKey ID, posing a risk of unauthorized cloud resource access and potential data compromise.",
 		RuleID:      "alibaba-access-key-id",
 		Regex:       generateUniqueTokenRegex(`(LTAI)(?i)[a-z0-9]{20}`, true),
 		Keywords:    []string{"LTAI"},
@@ -25,7 +25,7 @@ func AlibabaAccessKey() *config.Rule {
 func AlibabaSecretKey() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Alibaba Secret Key",
+		Description: "Discovered a potential Alibaba Cloud Secret Key, potentially allowing unauthorized operations and data access within Alibaba Cloud.",
 		RuleID:      "alibaba-secret-key",
 		Regex: generateSemiGenericRegex([]string{"alibaba"},
 			alphaNumeric("30"), true),

cmd/generate/config/rules/asana.go

@@ -8,7 +8,7 @@ import (
 func AsanaClientID() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Asana Client ID",
+		Description: "Discovered a potential Asana Client ID, risking unauthorized access to Asana projects and sensitive task information.",
 		RuleID:      "asana-client-id",
 		Regex:       generateSemiGenericRegex([]string{"asana"}, numeric("16"), true),
 		Keywords:    []string{"asana"},
@@ -24,7 +24,7 @@ func AsanaClientID() *config.Rule {
 func AsanaClientSecret() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Asana Client Secret",
+		Description: "Identified an Asana Client Secret, which could lead to compromised project management integrity and unauthorized access.",
 		RuleID:      "asana-client-secret",
 		Regex:       generateSemiGenericRegex([]string{"asana"}, alphaNumeric("32"), true),
 

cmd/generate/config/rules/atlassian.go

@@ -8,7 +8,7 @@ import (
 func Atlassian() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Atlassian API token",
+		Description: "Detected an Atlassian API token, posing a threat to project management and collaboration tool security and data confidentiality.",
 		RuleID:      "atlassian-api-token",
 		Regex: generateSemiGenericRegex([]string{
 			"atlassian", "confluence", "jira"}, alphaNumeric("24"), true),

cmd/generate/config/rules/authress.go

@@ -11,7 +11,7 @@ func Authress() *config.Rule {
 	// Rule Definition
 	// (Note: When changes are made to this, rerun `go generate ./...` and commit the config/gitleaks.toml file
 	r := config.Rule{
-		Description: "Authress Service Client Access Key",
+		Description: "Uncovered a possible Authress Service Client Access Key, which may compromise access control services and sensitive data.",
 		RuleID:      "authress-service-client-access-key",
 		Regex:       generateUniqueTokenRegex(`(?:sc|ext|scauth|authress)_[a-z0-9]{5,30}\.[a-z0-9]{4,6}\.acc[_-][a-z0-9-]{10,32}\.[a-z0-9+/_=-]{30,120}`, true),
 		Keywords:    []string{"sc_", "ext_", "scauth_", "authress_"},

cmd/generate/config/rules/aws.go

@@ -9,7 +9,7 @@ import (
 func AWS() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "AWS",
+		Description: "Identified a pattern that may indicate AWS credentials, risking unauthorized cloud resource access and data breaches on AWS platforms.",
 		RuleID:      "aws-access-token",
 		Regex: regexp.MustCompile(
 			"(?:A3T[A-Z0-9]|AKIA|AGPA|AIDA|AROA|AIPA|ANPA|ANVA|ASIA)[A-Z0-9]{16}"),

cmd/generate/config/rules/beamer.go

@@ -8,7 +8,7 @@ import (
 func Beamer() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Beamer API token",
+		Description: "Detected a Beamer API token, potentially compromising content management and exposing sensitive notifications and updates.",
 		RuleID:      "beamer-api-token",
 		Regex: generateSemiGenericRegex([]string{"beamer"},
 			`b_[a-z0-9=_\-]{44}`, true),

cmd/generate/config/rules/bitbucket.go

@@ -8,7 +8,7 @@ import (
 func BitBucketClientID() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Bitbucket Client ID",
+		Description: "Discovered a potential Bitbucket Client ID, risking unauthorized repository access and potential codebase exposure.",
 		RuleID:      "bitbucket-client-id",
 		Regex:       generateSemiGenericRegex([]string{"bitbucket"}, alphaNumeric("32"), true),
 		Keywords:    []string{"bitbucket"},
@@ -24,7 +24,7 @@ func BitBucketClientID() *config.Rule {
 func BitBucketClientSecret() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Bitbucket Client Secret",
+		Description: "Discovered a potential Bitbucket Client Secret, posing a risk of compromised code repositories and unauthorized access.",
 		RuleID:      "bitbucket-client-secret",
 		Regex:       generateSemiGenericRegex([]string{"bitbucket"}, alphaNumericExtended("64"), true),
 

cmd/generate/config/rules/bittrex.go

@@ -8,7 +8,7 @@ import (
 func BittrexAccessKey() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Bittrex Access Key",
+		Description: "Identified a Bittrex Access Key, which could lead to unauthorized access to cryptocurrency trading accounts and financial loss.",
 		RuleID:      "bittrex-access-key",
 		Regex:       generateSemiGenericRegex([]string{"bittrex"}, alphaNumeric("32"), true),
 		Keywords:    []string{"bittrex"},
@@ -24,7 +24,7 @@ func BittrexAccessKey() *config.Rule {
 func BittrexSecretKey() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Bittrex Secret Key",
+		Description: "Detected a Bittrex Secret Key, potentially compromising cryptocurrency transactions and financial security.",
 		RuleID:      "bittrex-secret-key",
 		Regex:       generateSemiGenericRegex([]string{"bittrex"}, alphaNumeric("32"), true),
 

cmd/generate/config/rules/clojars.go

@@ -10,7 +10,7 @@ import (
 func Clojars() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Clojars API token",
+		Description: "Uncovered a possible Clojars API token, risking unauthorized access to Clojure libraries and potential code manipulation.",
 		RuleID:      "clojars-api-token",
 		Regex:       regexp.MustCompile(`(?i)(CLOJARS_)[a-z0-9]{60}`),
 		Keywords:    []string{"clojars"},

cmd/generate/config/rules/codecov.go

@@ -9,7 +9,7 @@ func CodecovAccessToken() *config.Rule {
 	// define rule
 	r := config.Rule{
 		RuleID:      "codecov-access-token",
-		Description: "Codecov Access Token",
+		Description: "Found a pattern resembling a Codecov Access Token, posing a risk of unauthorized access to code coverage reports and sensitive data.",
 		Regex:       generateSemiGenericRegex([]string{"codecov"}, alphaNumeric("32"), true),
 		Keywords: []string{
 			"codecov",

cmd/generate/config/rules/coinbase.go

@@ -9,7 +9,7 @@ func CoinbaseAccessToken() *config.Rule {
 	// define rule
 	r := config.Rule{
 		RuleID:      "coinbase-access-token",
-		Description: "Coinbase Access Token",
+		Description: "Detected a Coinbase Access Token, posing a risk of unauthorized access to cryptocurrency accounts and financial transactions.",
 		Regex: generateSemiGenericRegex([]string{"coinbase"},
 			alphaNumericExtendedShort("64"), true),
 		Keywords: []string{

cmd/generate/config/rules/confluent.go

@@ -9,7 +9,7 @@ func ConfluentSecretKey() *config.Rule {
 	// define rule
 	r := config.Rule{
 		RuleID:      "confluent-secret-key",
-		Description: "Confluent Secret Key",
+		Description: "Found a Confluent Secret Key, potentially risking unauthorized operations and data access within Confluent services.",
 		Regex:       generateSemiGenericRegex([]string{"confluent"}, alphaNumeric("64"), true),
 		Keywords: []string{
 			"confluent",
@@ -27,7 +27,7 @@ func ConfluentAccessToken() *config.Rule {
 	// define rule
 	r := config.Rule{
 		RuleID:      "confluent-access-token",
-		Description: "Confluent Access Token",
+		Description: "Identified a Confluent Access Token, which could compromise access to streaming data platforms and sensitive data flow.",
 		Regex:       generateSemiGenericRegex([]string{"confluent"}, alphaNumeric("16"), true),
 
 		Keywords: []string{

cmd/generate/config/rules/contentful.go

@@ -8,7 +8,7 @@ import (
 func Contentful() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Contentful delivery API token",
+		Description: "Discovered a Contentful delivery API token, posing a risk to content management systems and data integrity.",
 		RuleID:      "contentful-delivery-api-token",
 		Regex: generateSemiGenericRegex([]string{"contentful"},
 			alphaNumericExtended("43"), true),

cmd/generate/config/rules/databricks.go

@@ -8,7 +8,7 @@ import (
 func Databricks() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Databricks API token",
+		Description: "Uncovered a Databricks API token, which may compromise big data analytics platforms and sensitive data processing.",
 		RuleID:      "databricks-api-token",
 		Regex:       generateUniqueTokenRegex(`dapi[a-h0-9]{32}`, true),
 		Keywords:    []string{"dapi"},

cmd/generate/config/rules/datadog.go

@@ -9,7 +9,7 @@ func DatadogtokenAccessToken() *config.Rule {
 	// define rule
 	r := config.Rule{
 		RuleID:      "datadog-access-token",
-		Description: "Datadog Access Token",
+		Description: "Detected a Datadog Access Token, potentially risking monitoring and analytics data exposure and manipulation.",
 		Regex: generateSemiGenericRegex([]string{"datadog"},
 			alphaNumeric("40"), true),
 		Keywords: []string{

cmd/generate/config/rules/definednetworking.go

@@ -9,7 +9,7 @@ func DefinedNetworkingAPIToken() *config.Rule {
 	// Define Rule
 	r := config.Rule{
 		// Human redable description of the rule
-		Description: "Defined Networking API token",
+		Description: "Identified a Defined Networking API token, which could lead to unauthorized network operations and data breaches.",
 
 		// Unique ID for the rule
 		RuleID: "defined-networking-api-token",

cmd/generate/config/rules/digitalocean.go

@@ -7,7 +7,7 @@ import (
 
 func DigitalOceanPAT() *config.Rule {
 	r := config.Rule{
-		Description: "DigitalOcean Personal Access Token",
+		Description: "Discovered a DigitalOcean Personal Access Token, posing a threat to cloud infrastructure security and data privacy.",
 		RuleID:      "digitalocean-pat",
 		Regex:       generateUniqueTokenRegex(`dop_v1_[a-f0-9]{64}`, true),
 		Keywords:    []string{"dop_v1_"},
@@ -21,7 +21,7 @@ func DigitalOceanPAT() *config.Rule {
 
 func DigitalOceanOAuthToken() *config.Rule {
 	r := config.Rule{
-		Description: "DigitalOcean OAuth Access Token",
+		Description: "Found a DigitalOcean OAuth Access Token, risking unauthorized cloud resource access and data compromise.",
 		RuleID:      "digitalocean-access-token",
 
 		Regex:    generateUniqueTokenRegex(`doo_v1_[a-f0-9]{64}`, true),
@@ -36,7 +36,7 @@ func DigitalOceanOAuthToken() *config.Rule {
 
 func DigitalOceanRefreshToken() *config.Rule {
 	r := config.Rule{
-		Description: "DigitalOcean OAuth Refresh Token",
+		Description: "Uncovered a DigitalOcean OAuth Refresh Token, which could allow prolonged unauthorized access and resource manipulation.",
 		RuleID:      "digitalocean-refresh-token",
 
 		Regex:    generateUniqueTokenRegex(`dor_v1_[a-f0-9]{64}`, true),

cmd/generate/config/rules/discord.go

@@ -8,7 +8,7 @@ import (
 func DiscordAPIToken() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Discord API key",
+		Description: "Detected a Discord API key, potentially compromising communication channels and user data privacy on Discord.",
 		RuleID:      "discord-api-token",
 		Regex:       generateSemiGenericRegex([]string{"discord"}, hex("64"), true),
 		Keywords:    []string{"discord"},
@@ -24,7 +24,7 @@ func DiscordAPIToken() *config.Rule {
 func DiscordClientID() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Discord client ID",
+		Description: "Identified a Discord client ID, which may lead to unauthorized integrations and data exposure in Discord applications.",
 		RuleID:      "discord-client-id",
 		Regex:       generateSemiGenericRegex([]string{"discord"}, numeric("18"), true),
 		Keywords:    []string{"discord"},
@@ -40,7 +40,7 @@ func DiscordClientID() *config.Rule {
 func DiscordClientSecret() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Discord client secret",
+		Description: "Discovered a potential Discord client secret, risking compromised Discord bot integrations and data leaks.",
 		RuleID:      "discord-client-secret",
 		Regex:       generateSemiGenericRegex([]string{"discord"}, alphaNumericExtended("32"), true),
 		Keywords:    []string{"discord"},

cmd/generate/config/rules/doppler.go

@@ -10,7 +10,7 @@ import (
 func Doppler() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Doppler API token",
+		Description: "Discovered a Doppler API token, posing a risk to environment and secrets management security.",
 		RuleID:      "doppler-api-token",
 		Regex:       regexp.MustCompile(`(dp\.pt\.)(?i)[a-z0-9]{43}`),
 		Keywords:    []string{"doppler"},

cmd/generate/config/rules/droneci.go

@@ -9,7 +9,7 @@ func DroneciAccessToken() *config.Rule {
 	// define rule
 	r := config.Rule{
 		RuleID:      "droneci-access-token",
-		Description: "Droneci Access Token",
+		Description: "Detected a Droneci Access Token, potentially compromising continuous integration and deployment workflows.",
 		Regex:       generateSemiGenericRegex([]string{"droneci"}, alphaNumeric("32"), true),
 
 		Keywords: []string{

cmd/generate/config/rules/dropbox.go

@@ -8,7 +8,7 @@ import (
 func DropBoxAPISecret() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Dropbox API secret",
+		Description: "Identified a Dropbox API secret, which could lead to unauthorized file access and data breaches in Dropbox storage.",
 		RuleID:      "dropbox-api-token",
 		Regex:       generateSemiGenericRegex([]string{"dropbox"}, alphaNumeric("15"), true),
 
@@ -26,7 +26,7 @@ func DropBoxShortLivedAPIToken() *config.Rule {
 	// define rule
 	r := config.Rule{
 		RuleID:      "dropbox-short-lived-api-token",
-		Description: "Dropbox short lived API token",
+		Description: "Discovered a Dropbox short-lived API token, posing a risk of temporary but potentially harmful data access and manipulation.",
 		Regex:       generateSemiGenericRegex([]string{"dropbox"}, `sl\.[a-z0-9\-=_]{135}`, true),
 		Keywords:    []string{"dropbox"},
 	}
@@ -39,7 +39,7 @@ func DropBoxLongLivedAPIToken() *config.Rule {
 	// define rule
 	r := config.Rule{
 		RuleID:      "dropbox-long-lived-api-token",
-		Description: "Dropbox long lived API token",
+		Description: "Found a Dropbox long-lived API token, risking prolonged unauthorized access to cloud storage and sensitive data.",
 		Regex:       generateSemiGenericRegex([]string{"dropbox"}, `[a-z0-9]{11}(AAAAAAAAAA)[a-z0-9\-_=]{43}`, true),
 		Keywords:    []string{"dropbox"},
 	}

cmd/generate/config/rules/duffel.go

@@ -11,7 +11,7 @@ func Duffel() *config.Rule {
 	// define rule
 	r := config.Rule{
 		RuleID:      "duffel-api-token",
-		Description: "Duffel API token",
+		Description: "Uncovered a Duffel API token, which may compromise travel platform integrations and sensitive customer data.",
 		Regex:       regexp.MustCompile(`duffel_(test|live)_(?i)[a-z0-9_\-=]{43}`),
 		Keywords:    []string{"duffel"},
 	}

cmd/generate/config/rules/dynatrace.go

@@ -10,7 +10,7 @@ import (
 func Dynatrace() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Dynatrace API token",
+		Description: "Detected a Dynatrace API token, potentially risking application performance monitoring and data exposure.",
 		RuleID:      "dynatrace-api-token",
 		Regex:       regexp.MustCompile(`dt0c01\.(?i)[a-z0-9]{24}\.[a-z0-9]{64}`),
 		Keywords:    []string{"dynatrace"},

cmd/generate/config/rules/easypost.go

@@ -10,7 +10,7 @@ import (
 func EasyPost() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "EasyPost API token",
+		Description: "Identified an EasyPost API token, which could lead to unauthorized postal and shipment service access and data exposure.",
 		RuleID:      "easypost-api-token",
 		Regex:       regexp.MustCompile(`\bEZAK(?i)[a-z0-9]{54}`),
 		Keywords:    []string{"EZAK"},
@@ -26,7 +26,7 @@ func EasyPost() *config.Rule {
 func EasyPostTestAPI() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "EasyPost test API token",
+		Description: "Detected an EasyPost test API token, risking exposure of test environments and potentially sensitive shipment data.",
 		RuleID:      "easypost-test-api-token",
 		Regex:       regexp.MustCompile(`\bEZTK(?i)[a-z0-9]{54}`),
 		Keywords:    []string{"EZTK"},

cmd/generate/config/rules/etsy.go

@@ -9,7 +9,7 @@ func EtsyAccessToken() *config.Rule {
 	// define rule
 	r := config.Rule{
 		RuleID:      "etsy-access-token",
-		Description: "Etsy Access Token",
+		Description: "Found an Etsy Access Token, potentially compromising Etsy shop management and customer data.",
 		Regex:       generateSemiGenericRegex([]string{"etsy"}, alphaNumeric("24"), true),
 
 		Keywords: []string{

cmd/generate/config/rules/facebook.go

@@ -8,7 +8,7 @@ import (
 func Facebook() *config.Rule {
 	// define rule
 	r := config.Rule{
-		Description: "Facebook Access Token",
+		Description: "Discovered a Facebook Access Token, posing a risk of unauthorized access to Facebook accounts and personal data exposure.",
 		RuleID:      "facebook",
 		Regex:       generateSemiGenericRegex([]string{"facebook"}, hex("32"), true),