Skip to main content

Learning CodeQL

If you tried the Github Secure Code Game I blogged about before, you got a first introduction on code scanning with CodeQL. In this post I want to share some other resources that can help you to get a deeper understanding in what CodeQL is and how it can help you to find security vulnerabilities in your code.

What is CodeQL?

CodeQL is a static analysis tool that can scan your code for vulnerabilities. CodeQL lets you query code as though it were data. By writing queries you can find  variants of a vulnerability.

Remark: CodeQL is free for research and open source.

How to run CodeQL?

The easiest way to try out CodeQL is by enabling the code scanning with CodeQL GitHub Action on a repository. Behind the scenes this will create a CodeQL database. This database is a relational representation of the code base, which contains information about the different source code elements, such as classes and functions, and puts each of those into a separate table of data. Each language has its own database schema, but generally there is a table for classes, a table for functions and so on, and relationships between these tables. For most programming languages CodeQL standard libraries provide wrappers and layers around that database schema.

A second option is to setup a local CodeQL database using the CodeQL command line tool. The easiest way to install the CodeQL CLI locally is as an extension to the gh CLI tool—GitHub’s official CLI tool.

The CodeQL CLI allows you to download an already created database (for a popular existing open source project) or you can create a new database yourself(which can take some time).

To create a new database use the following command:

codeql database create sqli-db --language csharp

I typically use the CodeQL plugin for Visual Studio Code. 



There you can directly download the database (if available) or select the database you have just created:



Now we can right click on a CodeQL file and choose ‘CodeQL: Run query on selected database’:



Running the query can take some time(it is possible to run the query on a set of files instead of the whole database), but once the query has completed you can browse through the results:



Learn more

If you want to learn more, I can recommend the following resources:

Labels:

Popular posts from this blog

Podman– Command execution failed with exit code 125

After updating WSL on one of the developer machines, Podman failed to work. When we took a look through Podman Desktop, we noticed that Podman had stopped running and returned the following error message: Error: Command execution failed with exit code 125 Here are the steps we tried to fix the issue: We started by running podman info to get some extra details on what could be wrong: >podman info OS: windows/amd64 provider: wsl version: 5.3.1 Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM Error: unable to connect to Podman socket: failed to connect: dial tcp 127.0.0.1:2655: connectex: No connection could be made because the target machine actively refused it. That makes sense as the podman VM was not running. Let’s check the VM: >podman machine list NAME         ...
Read more

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.
Read more

VS Code Planning mode

After the introduction of Plan mode in Visual Studio , it now also found its way into VS Code. Planning mode, or as I like to call it 'Hannibal mode', extends GitHub Copilot's Agent Mode capabilities to handle larger, multi-step coding tasks with a structured approach. Instead of jumping straight into code generation, Planning mode creates a detailed execution plan. If you want more details, have a look at my previous post . Putting plan mode into action VS Code takes a different approach compared to Visual Studio when using plan mode. Instead of a configuration setting that you can activate but have limited control over, planning is available as a separate chat mode/agent: I like this approach better than how Visual Studio does it as you have explicit control when plan mode is activated. Instead of immediately diving into execution, the plan agent creates a plan and asks some follow up questions: You can further edit the plan by clicking on ‘Open in Editor’: ...
Read more