Struct CodeQL

pub struct CodeQL { /* private fields */ }

CodeQL CLI Wrapper to make it easier to run CodeQL commands

Implementations

impl CodeQL

pub async fn new() -> Self

Create a new CodeQL instance

pub fn path(&self) -> &PathBuf

Get the CodeQL CLI path

pub fn init() -> CodeQLBuilder

Initialize a new CodeQL Builder instance

pub fn append_search_path(&mut self, path: impl Into<PathBuf>)

Append a search path to the CodeQL CLI

pub fn default_suite(&self) -> String

Get the default suite for the CodeQL CLI

pub fn add_extractor(&mut self, extractor: &CodeQLExtractor)

Add an external extractor to the CodeQL CLI (search path)

pub async fn find_codeql() -> Option<PathBuf>

Find CodeQL CLI on the system (asynchronous)

pub async fn load_extractor( &mut self, path: impl Into<PathBuf>, ) -> Result<CodeQLExtractor, GHASError>

Load a CodeQL extractor from a path

pub async fn run(&self, args: Vec<impl AsRef<str>>) -> Result<String, GHASError>

Run a CodeQL command asynchronously

This function will run the CodeQL command with the given arguments and return the output.

It will also set the CODEQL_REGISTRIES_AUTH environment variable if a token is provided.

pub fn database<'a>( &'a self, db: &'a CodeQLDatabase, ) -> CodeQLDatabaseHandler<'_, '_>

Pass a CodeQLDatabase to the CodeQL CLI to return a CodeQLDatabaseHandler. This handler can be used to run queries and other operations on the database.

pub fn pack<'a>(&'a self, pack: &'a CodeQLPack) -> CodeQLPackHandler<'_, '_>

Pass a CodeQLPack to the CodeQL CLI to return a CodeQLPackHandler.

This handler can be used to run queries and other operations on the pack.

pub async fn scan<'a>( &'a self, db: &'a mut CodeQLDatabase, queries: impl Into<String>, ) -> Result<Sarif, GHASError>

An async function to run a CodeQL scan on a database.

This includes the following steps:

• Creating the database
• Running the analysis

Example

use ghastoolkit::codeql::{CodeQL, CodeQLDatabase};

let codeql = CodeQL::new().await;

let mut db = CodeQLDatabase::init()
    .source("./")
    .language("python")
    .build()
    .expect("Failed to create database");

let sarif = codeql.scan(&mut db, "codeql/python-queries").await
    .expect("Failed to run scan");
// ... do something with the sarif

pub fn sarif(&self, path: impl Into<PathBuf>) -> Result<Sarif, GHASError>

Get the SARIF file from the CodeQL CLI

pub fn version(&self) -> Option<String>

Get the version of the loaded CodeQL CLI

pub async fn is_installed(&self) -> bool

Check to see if the CodeQL CLI is installed

pub async fn get_version(path: &Path) -> Result<String, GHASError>

Get the version of the CodeQL CLI

pub async fn get_languages(&self) -> Result<Vec<CodeQLLanguage>, GHASError>

Get the programming languages supported by the CodeQL CLI. This function will return the primary languages supported by the CodeQL and exclude any secondary languages (checkout get_secondary_languages()).

Example

use ghastoolkit::CodeQL;

let codeql = CodeQL::default();

let languages = codeql.get_languages()
    .await
    .expect("Failed to get languages");

for language in languages {
   println!("Language: {}", language.pretty());
   // Do something with the language
}

pub async fn get_secondary_languages( &self, ) -> Result<Vec<CodeQLLanguage>, GHASError>

Get the secondary languages supported by the CodeQL CLI

pub async fn get_all_languages(&self) -> Result<CodeQLLanguages, GHASError>

Get all languages supported by the CodeQL CLI

Trait Implementations

impl Clone for CodeQL

fn clone(&self) -> CodeQL

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CodeQL

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CodeQL

fn default() -> Self

Returns the “default value” for a type.

impl Display for CodeQL

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.