diff options
| author | Mark Wilkie <public@wilkiefamily.net> | 2017-08-01 10:18:16 -0700 |
|---|---|---|
| committer | Mark Wilkie <public@wilkiefamily.net> | 2017-08-01 10:18:16 -0700 |
| commit | b7436f8b8456b24c5b18c6d21ed18ebbdd6513ef (patch) | |
| tree | 832eef6c28d33338839739305307cb6b8475dcf6 /Documentation/project-docs | |
| parent | 6fa07359f0c66b7e3520d0c14b4d46b599934f50 (diff) | |
| download | coreclr-b7436f8b8456b24c5b18c6d21ed18ebbdd6513ef.tar.gz coreclr-b7436f8b8456b24c5b18c6d21ed18ebbdd6513ef.tar.bz2 coreclr-b7436f8b8456b24c5b18c6d21ed18ebbdd6513ef.zip | |
Updated guidance based on PR feedback
Diffstat (limited to 'Documentation/project-docs')
| -rw-r--r-- | Documentation/project-docs/contributing.md | 4 | ||||
| -rw-r--r-- | Documentation/project-docs/cross.md | 15 |
2 files changed, 2 insertions, 17 deletions
diff --git a/Documentation/project-docs/contributing.md b/Documentation/project-docs/contributing.md index 6e84c5050f..8d477f1616 100644 --- a/Documentation/project-docs/contributing.md +++ b/Documentation/project-docs/contributing.md @@ -28,10 +28,10 @@ Maintainers will not merge changes that have narrowly-defined benefits, due to c Contributions must also satisfy the other published guidelines defined in this document. -Automatic Security Assessment +Automated Code Review Assistance ------------------ -We deeply care about security issues in our code and we thoroughly review each PR. However, humans aren’t perfect and will make mistakes. To aid our code reviews, we run a tool called [CROSS](cross.md) that inspects the PR to find interesting areas that need further inspection. If the tool finds such areas, it will add a comment to the PR letting everyone know about this. If you’re interested to learn more, take a look at [CROSS](cross.md). +CROSS is a tool developed my Microsoft that we use to highlight areas of higher risk in a code change in order to help code reviewers do a more effective job DOs and DON'Ts -------------- diff --git a/Documentation/project-docs/cross.md b/Documentation/project-docs/cross.md deleted file mode 100644 index c16e0e8eb1..0000000000 --- a/Documentation/project-docs/cross.md +++ /dev/null @@ -1,15 +0,0 @@ -# Automatic Security Assessment with CROSS - -CROSS is a security code review tool we are now using for the .NET Core GitHub repos and stands for “Code Review for Open Source Software.” - -## The Genesis of CROSS - -As the .NET Core team threat modeled our OSS development process we discovered that many threats relating to malicious code and accidentally introduced security bugs are mitigated by code reviews. Since the volume of code changes to .NET Core and related projects is quite high, counting on busy developers to always catch subtle security issues can be problematic. We decided that some automation was in order to help developers quickly spot potentially risky changes. We wanted something that would mesh well with the current workflow for reviewing GitHub PRs. CROSS is the result! - -## How CROSS Works - -CROSS is invoked from the Jenkins continuous integration server whenever a PR gets submitted to GitHub. It uses GitHub APIs to access the PR data and then it scans the changed files. CROSS flags potentially risky changes for inspection based on a set of configurable security rules. Specific findings along with explanations and suggested fixes are posted as inline PR diff comments on github.com. This enables developers to inspect potentially risky changes as part of their normal GitHub PR code review workflow. - -## Interpreting the Results - -The findings are designed to help developers by flagging potential security issues for closer inspection but it is still up to the reviewer to determine if a real security issue is present. CROSS reduces the likelihood that security problems will be introduced and go unnoticed, especially for large change sets. Where possible, CROSS suggests more secure alternatives (e.g. safe vs. banned API methods or approved vs. deprecated crypto algorithms). |