org.sonar.l10n.secrets.rules.secrets.S7013.html Maven / Gradle / Ivy
Secret leaks often occur when a sensitive piece of authentication data is stored with the source code of an application. Considering the source
code is intended to be deployed across multiple assets, including source code repositories or application hosting servers, the secrets might get
exposed to an unintended audience.
Why is this an issue?
In most cases, trust boundaries are violated when a secret is exposed in a source code repository or an uncontrolled deployment environment.
Unintended people who don’t need to know the secret might get access to it. They might then be able to use it to gain unwanted access to associated
services or resources.
The trust issue can be more or less severe depending on the people’s role and entitlement.
What is the potential impact?
Below are some real-world scenarios that illustrate some impacts of an attacker exploiting the secret.
Compromise of sensitive personal data
This kind of service is often used to exchange information that could include personal information, chat logs, and other private data that users
have shared on the platform. This is called Personally Identifiable Information.
The leaked app key could provide a gateway for unauthorized individuals to access and misuse this data, compromising the privacy and safety of the
application users.
In many industries and locations, there are legal and compliance requirements to protect sensitive data. If this kind of sensitive personal data
gets leaked, companies face legal consequences, penalties, or violations of privacy laws.
Financial loss
Financial losses can occur when a secret is used to access a paid third-party-provided service and is disclosed as part of the source code of
client applications. Having the secret, each user of the application will be able to use it without limit to use the third party service to their own
need, including in a way that was not expected.
This additional use of the secret will lead to added costs with the service provider.
Moreover, when rate or volume limiting is set up on the provider side, this additional use can prevent the regular operation of the affected
application. This might result in a partial denial of service for all the application’s users.
How to fix it
Revoke the secret
Revoke any leaked secrets and remove them from the application source code.
Before revoking the secret, ensure that no other applications or processes are using it. Other usages of the secret will also be impacted when the
secret is revoked.
Use a secret vault
A secret vault should be used to generate and store the new secret. This will ensure the secret’s security and prevent any further unexpected
disclosure.
Depending on the development platform and the leaked secret type, multiple solutions are currently available.
Code examples
Noncompliant code example
props.set("openai-api-key", "sk-proj-HjexYIWYuDkZotTHif0eT3BlbkFJy9hISv8XIq6QmG1DMUJ9") // Noncompliant
Compliant solution
props.set("openai-api-key", System.getenv("OPENAI_API_KEY"))
Resources
Standards
- OWASP - Top 10 2021 Category A7 - Identification and
Authentication Failures
- OWASP - Top 10 2017 Category A3 - Sensitive Data
Exposure
- CWE - CWE-798 - Use of Hard-coded Credentials
- CWE - CWE-259 - Use of Hard-coded Password
- STIG Viewer - Application Security and
Development: V-222642 - The application must not contain embedded authentication data.