CodeQL

Depending on the SAST tool used, we support different methods of consuming the SAST result for Mobb to generate automated remediations. In this example, we will see how Mobb works with GitHub CodeQL.

With CodeQL, we currently support "Upload Vulnerability Report"

First, select "Upload Vulnerability Report"

Next, you must upload a CodeQL report in .jsonformat. Once the report is uploaded, click “Continue”.

The next screen prompts you to connect to your code repository. Mobb currently supports GitHub and GitLab as SCM tools.

You can either use the “Pick a repository from your list” where Mobb will prompt you to connect to your repository, or use the second option - “Add a specific code repository” to supply the URL.

  • Pick a repository from your list - This option provides you the ability to look up your connected GitHub or GitLab accounts to pick a repository

  • Add a specific code repository - This option allows you to specify a public or private repository URL

    • Public repository - Mobb will instantly connect to the repository to extract the content required to generate the fix data

    • Private repository

      • Accessible repository: If GitHub or GitLab is already connected and the private repository is in these accounts, Mobb will instantly connect to the repository to extract the content required to generate the fix data

      • Inaccessible repository: If GitHub or GitLab are not connected OR the repository is not in already connected accounts, Mobb will allow you to connect another GitHub or GitLab account OR upload the source code in a zip file

Once you have connected your repository, you are ready to run the analysis. To do so, click on “Continue”.

Note that if you are getting a warning that says "The code provided has been updated after the vulnerabilities were detected. Some vulnerabilities might be missing." You may want to provide a more recent SAST report or adjust your Git branch to an earlier one.

After the analysis, you can review the available fixes on the project page. To access the fix page, click the “Link to fix” button next to the issue you wish to review.

Mobb provides an intuitive UI that allows you to influence the fix's direction through simple questions. Once you are satisfied with the fix recommendation, you can either commit the changes back to your source code repository, download the .diff file, or save fix data:

  • Commit Changes - This allows you to commit the fixes directly to your source code repository through a Pull Request.

  • Download the .diff file - This option allows you to download the .diff file and apply the fix manually to your branch.

  • Save fix data - This option allows you to save the fix data so you can work on other fixes in the project. After you're satisfied, you can commit the fixes back to the repository all at once.

This tutorial will use the “Commit Changes” button to initiate the commit immediately.

After using the “Commit Changes” button, you will be prompted with the name of the branch. In this example, the branch we will commit to is called “feature1”.

Once you are satisfied with the rest of the inputs, click “Commit Changes”. This will initiate a Pull Request in your Github or Gitlab repository.

Last updated