codeql/go

Go analysis support for CodeQL

This sub-folder contains the extractor, CodeQL libraries, and queries that power Go support for CodeQL.

It contains two major components:

• an extractor, itself written in Go, that parses Go source code and converts it into a database that can be queried using CodeQL.
• static analysis libraries and queries written in CodeQL that can be used to analyze such a database to find coding mistakes or security vulnerabilities.

Installation

Clone this repository.

Run scripts/install-deps.sh. This will ensure that the necessary external CodeQL packs are downloaded to your machine. You will need to re-run this script whenever you pull new commits from the repo.

If you want to use the CodeQL extension for Visual Studio Code, import this repository into your VS Code workspace.

Usage

To analyze a Go codebase, either use the CodeQL command-line interface to create a database yourself, or download a pre-built database from GitHub.com. You can then run any of the queries contained in this repository either on the command line or using the VS Code extension.

Contributions

Contributions are welcome! Please see our contribution guidelines and our code of conduct for details on how to participate in our community.

Licensing

The code in this repository is licensed under the MIT license.

Resources

• Writing CodeQL queries
• Learning CodeQL