Skip to content

Commit

Permalink
adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
nahsra committed Aug 22, 2024
1 parent c82c08f commit 0693aa3
Show file tree
Hide file tree
Showing 161 changed files with 119 additions and 5,793 deletions.
2 changes: 1 addition & 1 deletion docs/code-scanning-tools/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Code Scanning Tool Fixes",
"label": "Code scanning tool remediation",
"position": 4,
"link": {
"type": "doc",
Expand Down
15 changes: 2 additions & 13 deletions docs/code-scanning-tools/codeql.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,6 @@ sidebar_position: 4

# CodeQL

Pixeebot can automatically fix issues detected by [CodeQL](https://codeql.github.com/).
Pixee can automatically fix issues detected by [CodeQL](https://codeql.github.com/).

No setup is required. The codemods listed below support the matching [prebuilt queries](https://docs.github.com/en/code-security/code-scanning/managing-your-code-scanning-configuration/java-kotlin-built-in-queries) for Java analysis

## Codemods

- [Database Resource Leak](https://docs.pixee.ai/codemods/java/codeql_java_database-resource-leak/)
- [Input Resource Leak](https://docs.pixee.ai/codemods/java/codeql_java_input-resource-leak/)
- [Insecure Cookie](https://docs.pixee.ai/codemods/java/codeql_java_insecure-cookie/)
- [Expression Language Injection](https://docs.pixee.ai/codemods/java/codeql_java_jexl-expression-injection/)
- [Maven Non-HTTPS URL](https://docs.pixee.ai/codemods/java/codeql_java_maven_non-https-url/)
- [Missing JWT Signature Check](https://docs.pixee.ai/codemods/java/codeql_java_missing-jwt-signature-check/)
- [Output Resource Leak](https://docs.pixee.ai/codemods/java/codeql_java_output-resource-leak/)
- [Stack Trace Exposure](https://docs.pixee.ai/codemods/java/codeql_java_stack-trace-exposure/)
No setup is required for GitHub Advanced Security users to receive fixes from CodeQL results that are uploaded as Code Scanning alerts.
21 changes: 10 additions & 11 deletions docs/code-scanning-tools/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Pixeebot automatically triages and fixes issues detected by code scanning tools

# Supported Languages

Pixeebot can fix issues in Java and Python repositories "out of the box". But you'll get the most value out of Pixeebot by connecting it to your existing code scanning tools and services. This will allow Pixeebot to provide more accurate and relevant fixes for your codebase and to triage findings from those tools.
Pixeebot can fix issues in Java and Python repositories "out of the box" without a code scanner integration. But, you'll get the most value out of Pixeebot by connecting it to your existing code scanning tools and services. This will allow Pixeebot to provide more accurate and relevant fixes for your codebase and to triage findings from those tools.

When triaging and fixing issues detected by code scanning tools, Pixeebot supports the following languages:

Expand All @@ -17,42 +17,41 @@ When triaging and fixing issues detected by code scanning tools, Pixeebot suppor
- C#/.NET
- JavaScript
- TypeScript
- Go (alpha support)

We are continuously working on expanding our language support. If you need support for a language not listed here, please [contact us](https://pixee.ai/demo-landing-page).

For a list of core codemods that work without code scanning tool integration, see the [Codemods](/codemods/overview) page.

# Supported Tools

- [Sonar, SonarSource, SonarQube](/code-scanning-tools/sonar)
- [Sonar, SonarCloud, SonarQube](/code-scanning-tools/sonar)
- [Semgrep](/code-scanning-tools/semgrep)
- [CodeQL](/code-scanning-tools/codeql)
- Snyk
- Contrast Security
- HCL AppScan
- Checkmarx
- Veracode
- Checkmarx (beta)

# Supported Rules

Pixeebot can triage and fix a wide range of security issues detected by code scanning tools. Many of these issues are common across tools and languages, such as:
Pixee can triage and fix a wide range of security issues detected by code scanning tools. Many of these issues are common across tools and languages, such as:

- SQL Injection
- Cross-Site Scripting (XSS)
- Insecure Deserialization
- Insecure Randomness
- Unsafe XML Parsing
- XML External Entity (XXE)
- Insecure Cookie Handling
- Command Injection
- Insecure Configuration
- Sensitive Data Logging
- Detailed Error Messages
- ... and many more

In addition, Pixeebot can triage and fix a variety of language-specific code issues.
In addition, Pixee can triage and fix a variety of language-specific code issues.

For detailed information about supported rules, or to request additional rule coverage, please [contact us](https://pixee.ai/demo-landing-page).

# GitHub Action

Pixee provides a [GitHub Action](https://github.com/marketplace/actions/upload-tool-results-to-pixeebot) that can be used to upload the results of code scanning tools to Pixeebot.
Pixee provides a [GitHub Action](https://github.com/marketplace/actions/upload-tool-results-to-pixeebot) that can be used to upload the results of code scanning tools to Pixee.

We are also working to support "native" integrations with code scanning tools. If you need support for a tool not listed here, please [contact us](https://pixee.ai/demo-landing-page).
8 changes: 2 additions & 6 deletions docs/code-scanning-tools/semgrep.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ sidebar_position: 3

# Semgrep

Pixeebot can automatically fix issues detected by [Semgrep](https://semgrep.dev/).
Pixee can automatically triage and fix issues detected by [Semgrep](https://semgrep.dev/).

No setup is required. The codemods listed below support the matching [prebuilt rules](https://semgrep.dev/r/).

## Codemods

- [Overly Permissive File Permissions](https://docs.pixee.ai/codemods/java/semgrep_java_java.lang.security.audit.overly-permissive-file-permission.overly-permissive-file-permission)
No setup is required for GitHub Advanced Security users to receive fixes from Semgrep results that are uploaded as Code Scanning alerts.
12 changes: 6 additions & 6 deletions docs/code-scanning-tools/sonar.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,25 @@ sidebar_position: 1

# SonarCloud

Pixeebot can automatically fix issues detected by [SonarCloud](https://www.sonarsource.com/products/sonarcloud/). This page explains how to integrate your SonarCloud results with Pixeebot.
Pixee can automatically fix issues detected by [SonarCloud](https://www.sonarsource.com/products/sonarcloud/). This page explains how to integrate your SonarCloud results with Pixee.

:::info
Looking to fix [SonarQube](https://www.sonarsource.com/products/sonarqube/) issues? See [SonarQube](./sonarqube.md)
:::

## How to Get Started

1. Install [Pixeebot GitHub Application](https://github.com/marketplace/pixeebot-automated-code-fixes)
1. Install [Pixee GitHub Application](https://github.com/marketplace/pixeebot-automated-code-fixes)
2. Install [Sonar GitHub Application](https://github.com/marketplace/sonarcloud)
3. Add [Upload Tool Results GitHub Action](https://github.com/marketplace/actions/upload-tool-results-to-pixeebot)
4. Start receiving Pull Requests from Pixeebot that address Sonar findings.
4. Start receiving Pull Requests from Pixee that address Sonar findings.

## More Information

Pixeebot fixes issues detected by SonarCloud when repositories have both the Pixeebot and SonarCloud GitHub Apps installed.
Pixee fixes issues detected by SonarCloud when repositories have both the Pixee and SonarCloud GitHub Apps installed.

For public repositories using SonarCloud, Pixeebot retrieves results from sonarcloud.io automatically with no further configuration required from the user.
For public repositories using SonarCloud, Pixee retrieves results from sonarcloud.io automatically with no further configuration required from the user.

For private repositories using SonarCloud, use the [pixee/upload-tool-results-action](https://github.com/pixee/upload-tool-results-action) GitHub Action to synchronize SonarCloud findings with Pixeebot.
For private repositories using SonarCloud, use the [pixee/upload-tool-results-action](https://github.com/pixee/upload-tool-results-action) GitHub Action to synchronize SonarCloud findings with Pixee.

<iframe width="100%" height="315" src="https://www.youtube.com/embed/-Rx5NrZ8zDw?si=B3ktZrOH19fWNLTg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
10 changes: 5 additions & 5 deletions docs/code-scanning-tools/sonarqube.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ sidebar_position: 2

# SonarQube

Pixeebot can automatically fix issues detected by [SonarQube](https://www.sonarsource.com/products/sonarqube/).
Pixee can automatically fix issues detected by [SonarQube](https://www.sonarsource.com/products/sonarqube/).

For a given Sonar rule, Pixeebot's fixes are the same, regardless of whether the issue was detected by either SonarCloud or SonarQube. However, the steps required to integrate Pixeebot with these systems is different.
For a given Sonar rule, Pixee's fixes are the same, regardless of whether the issue was detected by either SonarCloud or SonarQube. However, the steps required to integrate Pixee with these systems is different.

## How to Get Started

1. Install [Pixeebot GitHub Application](https://github.com/marketplace/pixeebot-automated-code-fixes)
1. Install [Pixee GitHub Application](https://github.com/marketplace/pixeebot-automated-code-fixes)
2. Add [Upload Tool Results GitHub Action](https://github.com/marketplace/actions/upload-tool-results-to-pixeebot) to workflows that run SonarQube analysis.
3. Start receiving Pull Requests from Pixeebot that address Sonar findings.
3. Start receiving Pull Requests from Pixee that address Sonar findings.

## More Information

Pixee offers an on premises solution that can be deployed alongside your SonarQube instance. Please contact us at [email protected] for detailed setup instructions.

SonarQube Community Edition lacks the features necessary to integrate with Pixeebot's PR experience.
SonarQube Community Edition lacks the features necessary to integrate with Pixee's PR experience.

<iframe width="100%" height="315" src="https://www.youtube.com/embed/-Rx5NrZ8zDw?si=B3ktZrOH19fWNLTg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
8 changes: 0 additions & 8 deletions docs/codemods/_category_.json

This file was deleted.

Binary file removed docs/codemods/img/docsVersionDropdown.png
Binary file not shown.
Binary file removed docs/codemods/img/localeDropdown.png
Binary file not shown.
7 changes: 0 additions & 7 deletions docs/codemods/java/_category_.json

This file was deleted.

36 changes: 0 additions & 36 deletions docs/codemods/java/codeql_java_database-resource-leak.md

This file was deleted.

34 changes: 0 additions & 34 deletions docs/codemods/java/codeql_java_input-resource-leak.md

This file was deleted.

35 changes: 0 additions & 35 deletions docs/codemods/java/codeql_java_insecure-cookie.md

This file was deleted.

37 changes: 0 additions & 37 deletions docs/codemods/java/codeql_java_jexl-expression-injection.md

This file was deleted.

37 changes: 0 additions & 37 deletions docs/codemods/java/codeql_java_maven_non-https-url.md

This file was deleted.

28 changes: 0 additions & 28 deletions docs/codemods/java/codeql_java_missing-jwt-signature-check.md

This file was deleted.

Loading

0 comments on commit 0693aa3

Please sign in to comment.