-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Secret bootstraping: Adding template metadata and rule description
- Loading branch information
1 parent
d11e44f
commit 9343f9a
Showing
2 changed files
with
96 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,59 @@ | ||
{ | ||
"title": "FIXME", | ||
"type": "CODE_SMELL", | ||
"status": "ready", | ||
"remediation": { | ||
"func": "Constant\/Issue", | ||
"constantCost": "5min" | ||
}, | ||
"tags": [ | ||
], | ||
"defaultSeverity": "Major", | ||
"ruleSpecification": "RSPEC-6782", | ||
"sqKey": "S6782", | ||
"scope": "All", | ||
"defaultQualityProfiles": ["Sonar way"], | ||
"quickfix": "unknown", | ||
"code": { | ||
"impacts": { | ||
"MAINTAINABILITY": "HIGH", | ||
"RELIABILITY": "MEDIUM", | ||
"SECURITY": "LOW" | ||
"title": "Docker Hub tokens should not be disclosed", | ||
"type": "VULNERABILITY", | ||
"code": { | ||
"impacts": { | ||
"SECURITY": "HIGH" | ||
}, | ||
"attribute": "TRUSTWORTHY" | ||
}, | ||
"attribute": "CONVENTIONAL" | ||
"status": "ready", | ||
"remediation": { | ||
"func": "Constant\/Issue", | ||
"constantCost": "30min" | ||
}, | ||
"tags": [ | ||
"cwe", | ||
"cert" | ||
], | ||
"extra": { | ||
"replacementRules": [ | ||
|
||
] | ||
}, | ||
"defaultSeverity": "Blocker", | ||
"ruleSpecification": "RSPEC-6782", | ||
"sqKey": "S6782", | ||
"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" | ||
] | ||
}, | ||
"defaultQualityProfiles": [ | ||
"Sonar way" | ||
], | ||
"quickfix": "unknown" | ||
} | ||
} | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,44 +1,60 @@ | ||
FIXME: add a description | ||
|
||
// If you want to factorize the description uncomment the following line and create the file. | ||
//include::../description.adoc[] | ||
include::../../../shared_content/secrets/description.adoc[] | ||
|
||
== Why is this an issue? | ||
|
||
FIXME: remove the unused optional headers (that are commented out) | ||
include::../../../shared_content/secrets/rationale.adoc[] | ||
|
||
=== What is the potential impact? | ||
|
||
The consequences vary greatly depending on the situation and the secret-exposed | ||
audience. Still, two main scenarios should be considered. | ||
|
||
include::../../../shared_content/secrets/impact/banking_financial_loss.adoc[] | ||
|
||
include::../../../shared_content/secrets/impact/blockchain_data_exposure.adoc[] | ||
|
||
include::../../../shared_content/secrets/impact/codeless_vulnerability_chaining.adoc[] | ||
|
||
include::../../../shared_content/secrets/impact/data_compromise.adoc[] | ||
|
||
include::../../../shared_content/secrets/impact/financial_loss.adoc[] | ||
|
||
include::../../../shared_content/secrets/impact/malware_distribution.adoc[] | ||
|
||
//=== What is the potential impact? | ||
include::../../../shared_content/secrets/impact/non_repudiation.adoc[] | ||
|
||
include::../../../shared_content/secrets/impact/personal_data_compromise.adoc[] | ||
|
||
include::../../../shared_content/secrets/impact/phishing.adoc[] | ||
|
||
include::../../../shared_content/secrets/impact/security_downgrade.adoc[] | ||
|
||
include::../../../shared_content/secrets/impact/suspicious_activities_termination.adoc[] | ||
|
||
== How to fix it | ||
//== How to fix it in FRAMEWORK NAME | ||
|
||
=== Code examples | ||
include::../../../shared_content/secrets/fix/revoke.adoc[] | ||
|
||
include::../../../shared_content/secrets/fix/recent_use.adoc[] | ||
|
||
==== Noncompliant code example | ||
include::../../../shared_content/secrets/fix/vault.adoc[] | ||
|
||
[source,text,diff-id=1,diff-type=noncompliant] | ||
---- | ||
FIXME | ||
---- | ||
=== Code examples | ||
|
||
==== Compliant solution | ||
:example_secret: ghp_xd8KRQmqM8eGCdegBLeO5AJ4oS0VN3yWXWcw | ||
:example_name: client_secret | ||
:example_env: CLIENT_SECRET | ||
|
||
[source,text,diff-id=1,diff-type=compliant] | ||
---- | ||
FIXME | ||
---- | ||
include::../../../shared_content/secrets/examples.adoc[] | ||
|
||
//=== How does this work? | ||
|
||
//=== Pitfalls | ||
|
||
//=== Going the extra mile | ||
|
||
== Resources | ||
|
||
include::../../../shared_content/secrets/resources/standards.adoc[] | ||
|
||
//== Resources | ||
//=== Documentation | ||
//=== Articles & blog posts | ||
//=== Conference presentations | ||
//=== Standards | ||
//=== External coding guidelines | ||
//=== Benchmarks |