From 6eab896d646aee42fbbabaaaf32af926ce3cbc6c Mon Sep 17 00:00:00 2001 From: hendrik-buchwald-sonarsource Date: Mon, 6 Jan 2025 15:11:45 +0000 Subject: [PATCH 1/2] Create rule S7175 --- rules/S7175/metadata.json | 2 ++ rules/S7175/secrets/metadata.json | 56 +++++++++++++++++++++++++++++++ rules/S7175/secrets/rule.adoc | 50 +++++++++++++++++++++++++++ 3 files changed, 108 insertions(+) create mode 100644 rules/S7175/metadata.json create mode 100644 rules/S7175/secrets/metadata.json create mode 100644 rules/S7175/secrets/rule.adoc diff --git a/rules/S7175/metadata.json b/rules/S7175/metadata.json new file mode 100644 index 00000000000..2c63c085104 --- /dev/null +++ b/rules/S7175/metadata.json @@ -0,0 +1,2 @@ +{ +} diff --git a/rules/S7175/secrets/metadata.json b/rules/S7175/secrets/metadata.json new file mode 100644 index 00000000000..a3134d0dbb8 --- /dev/null +++ b/rules/S7175/secrets/metadata.json @@ -0,0 +1,56 @@ +{ + "title": "SECRET_TYPE should not be disclosed", + "type": "VULNERABILITY", + "code": { + "impacts": { + "SECURITY": "HIGH" + }, + "attribute": "TRUSTWORTHY" + }, + "status": "ready", + "remediation": { + "func": "Constant\/Issue", + "constantCost": "30min" + }, + "tags": [ + "cwe", + "cert" + ], + "defaultSeverity": "Blocker", + "ruleSpecification": "RSPEC-7175", + "sqKey": "S7175", + "scope": "All", + "securityStandards": { + "CWE": [ + 798, + 259 + ], + "OWASP": [ + "A3" + ], + "CERT": [ + "MSC03-J." + ], + "OWASP Top 10 2021": [ + "A7" + ], + "PCI DSS 3.2": [ + "6.5.10" + ], + "PCI DSS 4.0": [ + "6.2.4" + ], + "ASVS 4.0": [ + "2.10.4", + "3.5.2", + "6.4.1" + ], + "STIG ASD_V5R3": [ + "V-222642" + ] + }, + "defaultQualityProfiles": [ + "Sonar way" + ], + "quickfix": "unknown" +} diff --git a/rules/S7175/secrets/rule.adoc b/rules/S7175/secrets/rule.adoc new file mode 100644 index 00000000000..28f3a64def8 --- /dev/null +++ b/rules/S7175/secrets/rule.adoc @@ -0,0 +1,50 @@ + +include::../../../shared_content/secrets/description.adoc[] + +== Why is this an issue? + +include::../../../shared_content/secrets/rationale.adoc[] + +=== What is the potential impact? + +// Optional: Give a general description of the secret and what it's used for. + +Below are some real-world scenarios that illustrate some impacts of an attacker +exploiting the secret. + +// Set value that can be used to refer to the type of secret in, for example: +// "An attacker can use this {secret_type} to ..." +:secret_type: secret + +// Where possible, use predefined content for common impacts. This content can +// be found in the folder "shared_content/secrets/impact". +// When using predefined content, search for any required variables to be set and include them in this file. +// Not adding them will not trigger warnings. + +//include::../../../shared_content/secrets/impact/some_impact.adoc[] + +== How to fix it + +include::../../../shared_content/secrets/fix/revoke.adoc[] + +include::../../../shared_content/secrets/fix/vault.adoc[] + +=== Code examples + +:example_secret: example_secret_value +:example_name: java-property-name +:example_env: ENV_VAR_NAME + +include::../../../shared_content/secrets/examples.adoc[] + +//=== How does this work? + +//=== Pitfalls + +//=== Going the extra mile + +== Resources + +include::../../../shared_content/secrets/resources/standards.adoc[] + +//=== Benchmarks From 5379e5407b10295802bf06ffd340eaef3ee47e22 Mon Sep 17 00:00:00 2001 From: Hendrik Buchwald Date: Mon, 6 Jan 2025 16:17:51 +0100 Subject: [PATCH 2/2] Add content --- rules/S7175/secrets/metadata.json | 2 +- rules/S7175/secrets/rule.adoc | 27 +++++---------------------- 2 files changed, 6 insertions(+), 23 deletions(-) diff --git a/rules/S7175/secrets/metadata.json b/rules/S7175/secrets/metadata.json index a3134d0dbb8..ea29ca430eb 100644 --- a/rules/S7175/secrets/metadata.json +++ b/rules/S7175/secrets/metadata.json @@ -1,5 +1,5 @@ { - "title": "SECRET_TYPE should not be disclosed", + "title": "Linear API keys should not be disclosed", "type": "VULNERABILITY", "code": { "impacts": { diff --git a/rules/S7175/secrets/rule.adoc b/rules/S7175/secrets/rule.adoc index 28f3a64def8..4dedcca5827 100644 --- a/rules/S7175/secrets/rule.adoc +++ b/rules/S7175/secrets/rule.adoc @@ -7,21 +7,12 @@ include::../../../shared_content/secrets/rationale.adoc[] === What is the potential impact? -// Optional: Give a general description of the secret and what it's used for. - Below are some real-world scenarios that illustrate some impacts of an attacker exploiting the secret. -// Set value that can be used to refer to the type of secret in, for example: -// "An attacker can use this {secret_type} to ..." -:secret_type: secret - -// Where possible, use predefined content for common impacts. This content can -// be found in the folder "shared_content/secrets/impact". -// When using predefined content, search for any required variables to be set and include them in this file. -// Not adding them will not trigger warnings. +include::../../../shared_content/secrets/impact/financial_loss.adoc[] -//include::../../../shared_content/secrets/impact/some_impact.adoc[] +include::../../../shared_content/secrets/impact/data_compromise.adoc[] == How to fix it @@ -31,20 +22,12 @@ include::../../../shared_content/secrets/fix/vault.adoc[] === Code examples -:example_secret: example_secret_value -:example_name: java-property-name -:example_env: ENV_VAR_NAME +:example_secret: lin_oauth_1462cb9a9d462cab2d2992281cb8e94b972cdebe8a33e72067383fd1d4a6ea23 +:example_name: linear-key +:example_env: LINEAR_KEY include::../../../shared_content/secrets/examples.adoc[] -//=== How does this work? - -//=== Pitfalls - -//=== Going the extra mile - == Resources include::../../../shared_content/secrets/resources/standards.adoc[] - -//=== Benchmarks