capitalize CWE, add warning block to docs

Signed-off-by: notfromstatefarm <86763948+notfromstatefarm@users.noreply.github.com>
argoproj · Aug 9, 2022 · 6ded9d3 · 6ded9d3
1 parent cace623
commit 6ded9d3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/common/common.go b/common/common.go
@@ -299,7 +299,7 @@ const (
 // Security severity logging
 const (
 	SecurityField     = "security"
-	SecurityCWEField  = "cwe"
+	SecurityCWEField  = "CWE"
 	SecurityEmergency = 5 // Indicates unmistakably malicious events that should NEVER occur accidentally and indicates an active attack (i.e. brute forcing, DoS)
 	SecurityCritical  = 4 // Indicates any malicious or exploitable event that had a side effect (i.e. secrets being left behind on the filesystem)
 	SecurityHigh      = 3 // Indicates likely malicious events but one that had no side effects or was blocked (i.e. out of bounds symlinks in repos)

diff --git a/docs/operator-manual/security.md b/docs/operator-manual/security.md
@@ -224,9 +224,10 @@ Security-related logs are tagged with a `security` field to make them easier to
 | 4     | Critical       | Any malicious or exploitable event that had a side effect                                         | Secrets being left behind on the filesystem |
 | 5     | Emergency      | Unmistakably malicious events that should NEVER occur accidentally and indicates an active attack | Brute forcing of accounts                   |
 
-Where applicable, a `cwe` field is also added specifying the [Common Weakness Enumeration](https://cwe.mitre.org/index.html) number.
+Where applicable, a `CWE` field is also added specifying the [Common Weakness Enumeration](https://cwe.mitre.org/index.html) number.
 
-Please be aware that all security logs are not comprehensively tagged yet and these examples are not necessarily implemented.
+!!! warning
+    Please be aware that not all security logs are comprehensively tagged yet and these examples are not necessarily implemented.
 
 ### API Logs