Skip to content

Commit 0f49a54

Browse files
Update security-best-practices-for-your-project.md
update to format Signed-off-by: Kenyatta <[email protected]>
1 parent 4a479fe commit 0f49a54

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

_articles/security-best-practices-for-your-project.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,18 @@ It's like having a skilled expert look over your code repository, helping you fi
3030
How to choose your SAST tool?
3131
Check the license: Some tools are free for open source projects. For example GitHub CodeQL or SemGrep.
3232
Check the coverage for your language(s)
33+
3334
* Select one that easily integrates with the tools you already use, with your existing process. For example, it's better if the alerts are available as part of your existing code review process and tool, rather than going to another tool to see them.
3435
* Beware of False Positives! You don't want the tool to slow you down for no reason!
3536
* Check the features: some tools are very powerful and can do taint tracking (example: GitHub CodeQL), some propose AI-generated fix suggestions, some make it easier to write custom queries (example: SemGrep).
3637

37-
## Dont share your secrets
38+
## Don't share your secrets
3839

3940
### Sensitive data, such as API keys, tokens, and passwords, can sometimes accidentally get committed to your repository.
4041

4142
Imagine this scenario: You are the maintainer of a popular open-source project with contributions from developers worldwide. One day, a contributor unknowingly commits to the repository some API keys of a third-party service. Days later, someone finds these keys and uses them to get into the service without permission. The service is compromised, users of your project experience downtime, and your project's reputation takes a hit. As the maintainer, you're now faced with the daunting tasks of revoking compromised secrets, investigating what malicious actions the attacker could have performed with this secret, notifying affected users, and implementing fixes.
4243

43-
To prevent such incidents, secret scanning solutions exist to help you detect those secrets in your code. Some tools like GitHub Secret Scanning, and Trufflehog by Truffle Security can prevent you from pushing them to remote branches in the first place, and some tools will automatically revoke some secrets for you.
44+
To prevent such incidents, "secret scanning" solutions exist to help you detect those secrets in your code. Some tools like GitHub Secret Scanning, and Trufflehog by Truffle Security can prevent you from pushing them to remote branches in the first place, and some tools will automatically revoke some secrets for you.
4445

4546
## Check and update your dependencies
4647

@@ -64,9 +65,10 @@ Picture this: A security researcher discovers a vulnerability in your project bu
6465

6566
### Security Policy
6667

67-
To avoid this, publish a security policy. A security policy, defined in a `SECURITY.md` file, details the steps for reporting security concerns, creating a transparent process for coordinated disclosure, and establishing the project team's responsibilities for addressing reported issues. This security policy can be as simple as Please don't publish details in a public issue or PR, send us a private email at [email protected], but can also contain other details such as when they should expect to receive an answer from you. Anything that can help the effectiveness and the efficiency of the disclosure process.
68+
To avoid this, publish a security policy. A security policy, defined in a `SECURITY.md` file, details the steps for reporting security concerns, creating a transparent process for coordinated disclosure, and establishing the project team's responsibilities for addressing reported issues. This security policy can be as simple as "Please don't publish details in a public issue or PR, send us a private email at [email protected]", but can also contain other details such as when they should expect to receive an answer from you. Anything that can help the effectiveness and the efficiency of the disclosure process.
6869

6970
### Private Vulnerability Reporting
71+
7072
On some platforms, you can streamline and strengthen your vulnerability management process, from intake to broadcast, with private issues. On GitLab, this can be done with private issues. On GitHub, this is called private vulnerability reporting (PVR). PVR enables maintainers to receive and address vulnerability reports, all within the GitHub platform. GitHub will automatically create a private fork to write the fixes, and a draft security advisory. All of this remains confidential until you decide to disclose the issues and release the fixes. To close the loop, security advisories will be published, and will inform and protect all your users through their SCA tool.
7173

7274
## Conclusion: A few steps for you, a huge improvement for your users

0 commit comments

Comments
 (0)