Skip to content

Commit

Permalink
Fix bad copy & paste in suppression instructions (#42)
Browse files Browse the repository at this point in the history
Co-authored-by: Daniel Beck <[email protected]>
  • Loading branch information
daniel-beck and daniel-beck authored Apr 23, 2024
1 parent 0c6dc33 commit a28fe5f
Show file tree
Hide file tree
Showing 8 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion src/BadRoleCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This code may allow agent processes to execute code on the Jenkins controller. A
2. Determine whether this finding is a false positive (see guidance below). This is an automated scan result, so that's always a possibility. In general, the rules err on the side of caution, so false positives are pretty common. If it is a false positive, do either of the following, and you're done!
* [Mark it as such on the GitHub UI](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#dismissing--alerts)
* Suppress the finding through a simple code change:
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/credentials-fill-without-permission-check]")` or add this comment just before: `// lgtm[jenkins/credentials-fill-without-permission-check]`.
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/callable-without-role-check]")` or add this comment just before: `// lgtm[jenkins/callable-without-role-check]`.
This is supported when using the Jenkins Security Scan workflow and in other CodeQL scans that support suppressing findings this way.
3. If this is a true positive finding, use the documentation below to resolve it.

Expand Down
2 changes: 1 addition & 1 deletion src/FileFromRestOfPath.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If your code is modifying or reading a file as specified in the URL, users able
2. Determine whether this finding is a false positive (see guidance below). This is an automated scan result, so that's always a possibility. In general, the rules err on the side of caution, so false positives are pretty common. If it is a false positive, do either of the following, and you're done!
* [Mark it as such on the GitHub UI](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#dismissing--alerts)
* Suppress the finding through a simple code change:
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/credentials-fill-without-permission-check]")` or add this comment just before: `// lgtm[jenkins/credentials-fill-without-permission-check]`.
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/file-from-rest-of-path]")` or add this comment just before: `// lgtm[jenkins/file-from-rest-of-path]`.
This is supported when using the Jenkins Security Scan workflow and in other CodeQL scans that support suppressing findings this way.
3. If this is a true positive finding, use the documentation below to resolve it.

Expand Down
2 changes: 1 addition & 1 deletion src/HasPermissionReturnIgnored.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This is indicative of a bug: Code intended to ensure the user accessing some fun
2. Determine whether this finding is a false positive (see guidance below). This is an automated scan result, so that's always a possibility. In general, the rules err on the side of caution, so false positives are pretty common. If it is a false positive, do either of the following, and you're done!
* [Mark it as such on the GitHub UI](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#dismissing--alerts)
* Suppress the finding through a simple code change:
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/credentials-fill-without-permission-check]")` or add this comment just before: `// lgtm[jenkins/credentials-fill-without-permission-check]`.
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/has-permission-return-value-ignored]")` or add this comment just before: `// lgtm[jenkins/has-permission-return-value-ignored]`.
This is supported when using the Jenkins Security Scan workflow and in other CodeQL scans that support suppressing findings this way.
3. If this is a true positive finding, use the documentation below to resolve it.

Expand Down
2 changes: 1 addition & 1 deletion src/PlaintextPasswordStorage.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Jenkins stores lots of credentials to other systems, like agent cloud providers,
2. Determine whether this finding is a false positive (see guidance below). This is an automated scan result, so that's always a possibility. In general, the rules err on the side of caution, so false positives are pretty common. If it is a false positive, do either of the following, and you're done!
* [Mark it as such on the GitHub UI](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#dismissing--alerts)
* Suppress the finding through a simple code change:
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/credentials-fill-without-permission-check]")` or add this comment just before: `// lgtm[jenkins/credentials-fill-without-permission-check]`.
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/plaintext-storage]")` or add this comment just before: `// lgtm[jenkins/plaintext-storage]`.
This is supported when using the Jenkins Security Scan workflow and in other CodeQL scans that support suppressing findings this way.
3. If this is a true positive finding, use the documentation below to resolve it.

Expand Down
2 changes: 1 addition & 1 deletion src/UnsafeCalls.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Incorrect use of APIs can result in a security vulnerability.
2. Determine whether this finding is a false positive (see guidance below). This is an automated scan result, so that's always a possibility. In general, the rules err on the side of caution, so false positives are pretty common. If it is a false positive, do either of the following, and you're done!
* [Mark it as such on the GitHub UI](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#dismissing--alerts)
* Suppress the finding through a simple code change:
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/credentials-fill-without-permission-check]")` or add this comment just before: `// lgtm[jenkins/credentials-fill-without-permission-check]`.
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/unsafe-calls]")` or add this comment just before: `// lgtm[jenkins/unsafe-calls]`.
This is supported when using the Jenkins Security Scan workflow and in other CodeQL scans that support suppressing findings this way.
3. If this is a true positive finding, use the documentation below to resolve it.

Expand Down
2 changes: 1 addition & 1 deletion src/UnsafeClassUses.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Incorrect use of APIs can result in a security vulnerability.
2. Determine whether this finding is a false positive (see guidance below). This is an automated scan result, so that's always a possibility. In general, the rules err on the side of caution, so false positives are pretty common. If it is a false positive, do either of the following, and you're done!
* [Mark it as such on the GitHub UI](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#dismissing--alerts)
* Suppress the finding through a simple code change:
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/credentials-fill-without-permission-check]")` or add this comment just before: `// lgtm[jenkins/credentials-fill-without-permission-check]`.
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/unsafe-classes]")` or add this comment just before: `// lgtm[jenkins/unsafe-classes]`.
This is supported when using the Jenkins Security Scan workflow and in other CodeQL scans that support suppressing findings this way.
3. If this is a true positive finding, use the documentation below to resolve it.

Expand Down
2 changes: 1 addition & 1 deletion src/WebMethodMissingPermissionCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This is problem if the method returns private information, or has side effects,
2. Determine whether this finding is a false positive (see guidance below). This is an automated scan result, so that's always a possibility. In general, the rules err on the side of caution, so false positives are pretty common. If it is a false positive, do either of the following, and you're done!
* [Mark it as such on the GitHub UI](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#dismissing--alerts)
* Suppress the finding through a simple code change:
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/credentials-fill-without-permission-check]")` or add this comment just before: `// lgtm[jenkins/credentials-fill-without-permission-check]`.
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/no-permission-check]")` or add this comment just before: `// lgtm[jenkins/no-permission-check]`.
This is supported when using the Jenkins Security Scan workflow and in other CodeQL scans that support suppressing findings this way.
3. If this is a true positive finding, use the documentation below to resolve it.

Expand Down
2 changes: 1 addition & 1 deletion src/WebMethodMissingPostAnnotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This is problem if the method has side effects, as legitimate Jenkins users' bro
2. Determine whether this finding is a false positive (see guidance below). This is an automated scan result, so that's always a possibility. In general, the rules err on the side of caution, so false positives are pretty common. If it is a false positive, do either of the following, and you're done!
* [Mark it as such on the GitHub UI](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository#dismissing--alerts)
* Suppress the finding through a simple code change:
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/credentials-fill-without-permission-check]")` or add this comment just before: `// lgtm[jenkins/credentials-fill-without-permission-check]`.
Annotate the code location with `@SuppressWarnings("lgtm[jenkins/csrf]")` or add this comment just before: `// lgtm[jenkins/csrf]`.
This is supported when using the Jenkins Security Scan workflow and in other CodeQL scans that support suppressing findings this way.
3. If this is a true positive finding, use the documentation below to resolve it.

Expand Down

0 comments on commit a28fe5f

Please sign in to comment.