From 5cac7617ee61bc6405d24663ede50cf1c384c3c7 Mon Sep 17 00:00:00 2001 From: gaetan-ferry-sonarsource Date: Wed, 26 Jun 2024 12:43:15 +0000 Subject: [PATCH 1/3] Create rule S6990 --- rules/S6990/metadata.json | 2 ++ rules/S6990/secrets/metadata.json | 56 +++++++++++++++++++++++++++++++ rules/S6990/secrets/rule.adoc | 48 ++++++++++++++++++++++++++ 3 files changed, 106 insertions(+) create mode 100644 rules/S6990/metadata.json create mode 100644 rules/S6990/secrets/metadata.json create mode 100644 rules/S6990/secrets/rule.adoc diff --git a/rules/S6990/metadata.json b/rules/S6990/metadata.json new file mode 100644 index 00000000000..2c63c085104 --- /dev/null +++ b/rules/S6990/metadata.json @@ -0,0 +1,2 @@ +{ +} diff --git a/rules/S6990/secrets/metadata.json b/rules/S6990/secrets/metadata.json new file mode 100644 index 00000000000..a0b861ad171 --- /dev/null +++ b/rules/S6990/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-6990", + "sqKey": "S6990", + "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 2023-06-08": [ + "V-222642" + ] + }, + "defaultQualityProfiles": [ + "Sonar way" + ], + "quickfix": "unknown" +} diff --git a/rules/S6990/secrets/rule.adoc b/rules/S6990/secrets/rule.adoc new file mode 100644 index 00000000000..bae2119bf94 --- /dev/null +++ b/rules/S6990/secrets/rule.adoc @@ -0,0 +1,48 @@ + +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". + +//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 6a99c769f9b5d37f9138af07247d2fa8cd7028fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABtan=20Ferry?= Date: Wed, 26 Jun 2024 14:53:58 +0200 Subject: [PATCH 2/3] Adding a rspec description for ubidots tokens --- rules/S6990/secrets/rule.adoc | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/rules/S6990/secrets/rule.adoc b/rules/S6990/secrets/rule.adoc index bae2119bf94..0dc80bd781f 100644 --- a/rules/S6990/secrets/rule.adoc +++ b/rules/S6990/secrets/rule.adoc @@ -7,19 +7,16 @@ 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. +Ubidots API keys and tokens are used to programmatically access the Ubidots API. +A compromised key can be able to access the API on behalf of a legitimate user +and affect the confidentiality and integrity of the data stored on the service. 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 +:secret_type: token -// Where possible, use predefined content for common impacts. This content can -// be found in the folder "shared_content/secrets/impact". - -//include::../../../shared_content/secrets/impact/some_impact.adoc[] +include::../../../shared_content/secrets/impact/data_compromise.adoc[] == How to fix it @@ -29,9 +26,9 @@ 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: BBFF-I6yfPQkcRB2JgSzzmPd0VO75YFJwHL +:example_name: Ubidots-api-key +:example_env: UBIDOTS-KEY include::../../../shared_content/secrets/examples.adoc[] @@ -43,6 +40,10 @@ include::../../../shared_content/secrets/examples.adoc[] == Resources +=== Documentation + +* Ubidots documentation - https://help.ubidots.com/en/articles/570026-api-authentication[API Authentication] + include::../../../shared_content/secrets/resources/standards.adoc[] //=== Benchmarks From 05df4c8fd31e291e27353faa5798bd8537fd5141 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABtan=20Ferry?= Date: Wed, 26 Jun 2024 14:54:44 +0200 Subject: [PATCH 3/3] Update metadata --- rules/S6990/secrets/metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rules/S6990/secrets/metadata.json b/rules/S6990/secrets/metadata.json index a0b861ad171..cd524a80ef2 100644 --- a/rules/S6990/secrets/metadata.json +++ b/rules/S6990/secrets/metadata.json @@ -1,5 +1,5 @@ { - "title": "SECRET_TYPE should not be disclosed", + "title": "Ubidots API secrets should not be disclosed", "type": "VULNERABILITY", "code": { "impacts": {