gh-mrva

README

gh-mrva

This is an unofficial tool and is not officially supported by GitHub.

Configuration

A configuration file will be created in ~/.config/gh-mrva/config.yml. The following options are supported:

• codeql_path: Path to CodeQL distribution
• controller: NWO of the MRVA controller to use
• list_file: Path to the JSON file containing the target repos

Usage

Submit a new query

gh mrva submit [--codeql-path<path to CodeQL>] [--controller <controller>] --language <language> --session <session name> [--list-file <list file>] --list <list> [--query <query> | --query-suite <query suite> ]

Note: codeql-dist, controller and list-file are only optionals if defined in the configuration file

Download the results

gh mrva download --session <session name> --output-dir <output directory> [--download-dbs] [--nwo <owner/repo>]

List sessions

gh mrva list [--json]

Check scan status

gh mrva status --session <session name> [--json]

Contributing

gh-mrva is a work in progress. If you have ideas for new fixes or improvements, please open an issue or pull request.

If possible, tests should be added for any new fixes. We favour testing with real file systems or processes where possible.

Releasing

Releasing is currently done via tags. To release a new version, create a new tag and push it to the remote. The release workflow will automatically build and publish the new version.

e.g.

# Determine the latest tag
git tag -l | sort -V | tail -n 1

# Create a new tag
git tag -a v0.0.2 -m "Release v0.0.2"

# Push the tag to the remote
git push origin --tags

Documentation

Overview

Copyright © 2023 Alvaro Munoz pwntester@github.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.