]> source.dussan.org Git - sonarqube.git/commitdiff
Documentation Security Reports
authoragigleux <gigleux_alexandre@yahoo.fr>
Mon, 16 Jul 2018 09:21:16 +0000 (11:21 +0200)
committerSonarTech <sonartech@sonarsource.com>
Tue, 17 Jul 2018 18:21:26 +0000 (20:21 +0200)
server/sonar-docs/src/pages/security-reports.md

index cf88af609db8a5f4231d626097f6540b90925408..5c22e9cccf0bc0272947921ea92180f3f0c111e2 100644 (file)
@@ -3,11 +3,12 @@ title: Security Reports
 ---
 
 ## What do the Security Reports show?
-The Security Reports are designed to quickly give you the big picture on your application's security, with breakdowns of just where you stand in regard to each of the the [OWASP Top 10](https://www.owasp.org/index.php/Top_10-2017_Top_10), and [SANS Top 25 categories](https://www.sans.org/top25-software-errors), and [CWE](http://cwe.mitre.org/)-specific details. 
+The Security Reports are designed to quickly give you the big picture on your application's security, with breakdowns of just where you stand in regard to each of the [OWASP Top 10](https://www.owasp.org/index.php/Top_10-2017_Top_10), and [SANS Top 25 categories](https://www.sans.org/top25-software-errors), and [CWE](http://cwe.mitre.org/)-specific details. 
 
 ## What's the difference between a Hotspot and a Vulnerability?
 Vulnerabilities are points in the code which are open to attack.
-Hotspot are sensitive API calls which, if misused, could easily result in Vulnerabilities. Having a Hotspot in your application does not mean there is a problem. What it does mean is that a human should look over the code to see if the sensitive API is being used in the safest manner.
+Security Hotspots are security-sensitive pieces of code that deserve to be carefully reviewed by a security auditor. The main goal of those Security Hotspots is to drive the effort of security auditors in charge of manually review the source code of an application. The second goal is to educate developers and to increase their security-awareness. 
+Having a Hotspot in your application does not mean there is a problem. What it does mean is that a human, preferably a security auditor/expert should look over the code to see if the sensitive piece of code is being used in the safest manner.
 
 ## I'm a developer. Should I care about Hotspots?
 Probably not. Hotspots, as such, aren't really actionable. They simply mark *potential* problems, so there's really nothing to do. That's why you don't receive notficiations when Hotspot issues are raised, and why Hotspots aren't shown in the Issues page by default. 
@@ -19,4 +20,8 @@ If you look at the code where a Hotspot is raised and realize that there really
 Once you've *Detect*ed that there really is a problem at a Hotspot location, it will be assigned to the appropriate developer, who will make a fix, and must then `Request Review` *via the UI*. That request moves the issue from Vulnerability back to Hotspot. From there, it's up to the security auditor to either *Accept* or *Reject* the fix. Accepting the fix will mark it "Won't Fix", and rejecting it will turn it back into a Vulnerability, putting it back in the developer's queue.
 
 ## What does it mean for a Hotspot to be marked "Won't Fix".
-The Won't Fix designation is used to indicate that a Hotspot has been reviewed and found okay. 
+The Won't Fix designation is used to indicate that a Hotspot has been reviewed and there is no way, as of now, to exploit this piece of code to create an attack.
+
+## Why don't I see any Hotspot?
+It is possible you really have no Hotspot because your code is safe in itself and you used no security-sensitive API.
+Also, only SonarC#, SonarJava, SonarPHP implement the concept of Security Hotspot.