白盒代码审计工具—CodeQL安装教程【Liunx】

sudo unzip codeql-linux64.zip -d /opt/codeql-cli

export PATH="/opt/codeql-cli/codeql:$PATH"

保存文件并执行以下命令使其立即生效：

source /etc/profile

# CodeQL config  
export CODEQL_HOME="/opt/codeql-cli" # 这里改为包含codeql可执行文件的目录  
export PATH="$CODEQL_HOME:$PATH"

输入以下命令验证是否成功

codeql

./codeql database create <数据库名称> --language=java --command="mvn clean compile --file pom.xml" --source-root=<具体的项目地址> --overwrite

<database>：要创建的新数据库的路径。 执行命令时将创建此目录，无法指定现有目录。

--language：要为其创建数据库的语言的标识符

--command：在为一个或多个已编译语言创建数据库时使用，如果请求的唯一语言是 Python 和 JavaScript，则省略。 这指定调用编译器所需的生成命令。 从当前文件夹运行命令，如果指定，则从 --source-root 运行。 如果未包含 --command，CodeQL 将尝试使用内置的自动生成程序自动检测生成系统。

--source-root：创建数据库时使用的主要源文件的根文件夹。 默认情况下，命令假定当前目录是源根目录，使用此选项可指定其他位置。

--overwrite：目的是如果有重复文件则重新覆盖掉！

./codeql database analyze <刚才生成的数据库名称和地址> --threads 16 java-security-and-quality.qls --format=csv --output=/opt/vpaas_framework_db_result.csv

--threads：
--format：
java-security-and-quality.qls：CodeQL 查询套件
--output：

例如：

./codeql database analyze ./vpaas_framework_db --format=sarif-latest --output=./vpaas_framework_db_result.json

<query-specifiers>：如果省略，将使用已分析数据库语言的默认查询套件

    要对数据库运行的查询的空格分隔列表。 这是一个参数列表，其中每个参数可以是：

    查询文件的路径

    包含查询文件目录的路径

    查询套件文件的路径

    CodeQL 查询包的名称
        具有可选版本范围
        包含包中查询、目录或查询套件的可选路径

    例如

        ./codeql database analyze ./vpaas_framework_db --format=sarif-latest --output=./vpaas_framework_db_result.json <你所下载的规则地址，这里我用的官网规则套件>

1