Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nealfennimore/codeql-docker

CodeQL Docker wrapper
https://github.com/nealfennimore/codeql-docker

codeql codeql-cli codeql-command codeql-container codeql-docker

Last synced: 6 days ago
JSON representation

CodeQL Docker wrapper

Awesome Lists containing this project

README

        

# Docker CodeQL

Versioned [CodeQL](https://github.com/github/codeql) and [CodeQL CLI](https://github.com/github/codeql-cli-binaries) container.

See [CodeQL CLI Manual](https://codeql.github.com/docs/codeql-cli/manual/) for commands.

## Installation

```sh
# Using uncompiled base
docker pull ghcr.io/nealfennimore/codeql:latest

# Using compiled language (cpp, csharp, csv, go, html, java, javascript, properties, python, xml supported)
docker pull ghcr.io/nealfennimore/codeql:javascript
docker pull ghcr.io/nealfennimore/codeql:go
docker pull ghcr.io/nealfennimore/codeql:cpp
```

### Building Locally
If you prefer to build locally instead of using a precompiled image
```sh
docker build . \
--build-arg CLI_VERSION=2.7.0 \
--build-arg CODE_LANGUAGE=$CODE_LANGUAGE \
--tag ghcr.io/nealfennimore/codeql:$CODE_LANGUAGE
```
## Usage

### Shell

To drop to shell to work with codeql directly

```sh
docker run --rm -it \
-v ~/code/db:/tmp/db \
-v ~/code/src:/tmp/src \
-v ~/code/output:/tmp/output \
ghcr.io/nealfennimore/codeql:$CODE_LANGUAGE bash

# Then proceed to create database for the language:
codeql database create --language=$CODE_LANGUAGE --source-root /tmp/src /tmp/db

# Analyze source code and generate report:
codeql database analyze /tmp/db $CODE_LANGUAGE-lgtm.qls --format=sarif-latest --output=/tmp/output/results.sarif
```

### Database

#### Creation
```sh
docker run --rm -it \
-v ~/code/db:/tmp/db \
-v ~/code/src:/tmp/src \
ghcr.io/nealfennimore/codeql:$CODE_LANGUAGE \
codeql database create --language=$CODE_LANGUAGE --source-root /tmp/src /tmp/db
```

#### Analyzing Source Code
```sh
docker run --rm -it \
-v ~/code/db:/tmp/db \
-v ~/code/src:/tmp/src \
-v ~/code/output:/tmp/output \
ghcr.io/nealfennimore/codeql:$CODE_LANGUAGE \
codeql database analyze /tmp/db $CODE_LANGUAGE-lgtm.qls \ # Analyze with default query suites
--format=sarif-latest \
--output=/tmp/output/results.sarif
```