如何在本地环境使用 CodeQL 扫描出代码中的安全漏洞？

CodeQL 是什么？

CodeQL 是用于自动执行安全检查的分析引擎。在 CodeQL 中，代码被视为数据。 安全漏洞、bug 和其他错误被建模为可针对从代码中提取的数据库执行的查询。可以运行由 Github 研究人员和社区参与者编写的标准 CodeQL 查询，也可以自己编写查询用于自定义分析。

接下来以 Golang 项目为例来看下如何下载安装和使用 CodeQL。

下载安装 CodeQL

1、下载 codeql-cli-binaries

到 codeql-cli-binaries 的 release 页面（https://github.com/github/codeql-cli-binaries/releases）下载最新版的即可，下载完成后解压到 $GOPATH/src/github.com/github/codeql-cli-binaries，并将 $GOPATH/src/github.com/github/codeql-cli-binaries 目录添加到环境变量。

2、下载代码库 codeql

切换到 $GOPATH/src/github.com/github 目录，执行如下命令

git clone https://github.com/github/codeql.git

运行 CodeQL 扫描代码

切换到要扫描的 Golang 项目的根目录，首先设置如下环境变量，表示在构建 CodeQL 数据库时启用跟踪：

CODEQL_EXTRACTOR_GO_BUILD_TRACING=on

构建 CodeQL 数据库：

codeql database create go-database --language=go

执行代码扫描并输出 csv 类型的报告：

codeql database analyze go-database  --format=csv --output=result.csv

完成扫描后输出信息如下（这里只是截取了输出的信息最后的部分，前面还有很多，这里为举例使用省略掉了）

......
Interpreting results for go
Analysis produced the following diagnostic data:

|         Diagnostic          |   Summary   |
+-----------------------------+-------------+
| Successfully analyzed files | 124 results |

Analysis produced the following metric data:

|                 Metric                 | Value |
+----------------------------------------+-------+
| Total lines of Go code in the database |  8383 |

可以打开 result.csv 文件查看扫描出来的漏洞情况及说明。

小结

本文简单介绍了如何在本地环境使用 CodeQL 扫描出代码中的安全漏洞的方法，接下来的文章会详细介绍 CodeQL 的使用方法。