Codeql初学

最新推荐文章于 2025-03-08 10:25:26 发布
最新推荐文章于 2025-03-08 10:25:26 发布
阅读量7.3k 收藏 9
点赞数 6
分类专栏： 代码审计 java 文章标签： 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_44689968/article/details/115561093
版权

CodeQl初学

做代码审计过程中也用过很多代码扫描工具，也分析过其扫描的原理。最近网上看到很多大佬在学习GitHub之前公布的一个新开源工具codeql，瞬间有了学习的兴趣，跟着大佬们的路线自己也跟着学习一下。通过参考大佬们的一些文章，自己也亲自实践下。

一丶QL&&CodeQL

QL是⼀种声明性的，⾯向对象的查询语⾔，经过优化可实现对分层数据结构的⾼效分析。支持对C++，C#，Java，JavaScript，Python，go等多种语言进行分析，可用于分析代码，查找代码中控制流等信息。

CodeQL 是一个语义代码分析引擎，它可以扫描发现代码库中的漏洞。使用 CodeQL，可以像对待数据一样查询代码。用户可以使用 ql 语言编写自定义规则识别软件中的漏洞，也可以使用ql自带的规则进行扫描。

Git链接：https://securitylab.github.com/tools/codeql/

TryCodeQL on LGTM.com:https://lgtm.com/query/rule:1823453799/lang:java/

在这里插入图片描述
CodeQL语句是这样的：
在这里插入图片描述

接下来我将开始在本地搭建环境，一起来体验CodeQL：

在这里插入图片描述

二、本地环境搭建

1.安装VsCode

下载地址：https://code.visualstudio.com/Download

2.下载CodeQL分析程序

下载地址：https://github.com/github/codeql-cli-binaries/releases/download/v2.7.3/codeql-win64.zip

在这里插入图片描述

3.下载相关的库文件

CodeQL仓库包含分析C/C++, C#, Java, JavaScript、python等所需的查询和库文件。

下载地址：https://github.com/github/codeql

4.下载最新版的VScode，安装CodeQL扩展程序：

**注意：**CodeQL 扩展至少需要 Visual Studio Code 1.39,不支持旧版本。

地址：https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-codeql
在这里插入图片描述填写下载的分析程序的路径，其他默认
在这里插入图片描述
将$HOME/codeql-home/codeql目录添加到环境变量

也可以使用如下方法离线安装 CodeQL 扩展：

  • 下载CodeQL VSIX 文件。然后，在“扩展”视图中，单击“更多操作” >“从 VSIX 安装”，然后选择 CodeQL VSIX 文件。

    链接：https://github.com/github/vscode-codeql/releases/download/v1.5.9/vscode-codeql-v1.5.9.vsix

为 CodeQL 更新现有工作区

可以通过直接创建 CodeQL 存储库的本地克隆将 CodeQL 库添加到现有工作区：https : //github.com/github/codeql。

要使标准库在您的工作区中可用：

1、选择File > Add Folder to Workspace，然后选择github/codeql存储库的本地检出。
2、使用“新建文件夹”或“将文件夹添加到工作区”选项为每种目标语言创建一个新文件夹，以保存自定义查询和库。
3、qlpack.yml在每个目标语言文件夹中创建一个文件。这会告诉 CodeQL CLI 该文件夹的目标语言及其依赖项。（的main分支github/codeql已经有这些文件。）CodeQL 将在所有打开的工作区文件夹中或在用户的搜索路径中查找依赖项。
例如，要创建一个名为my-custom-cpp-pack依赖于 C++ 的 CodeQL 标准库的自定义 CodeQL 文件夹，请创建一个qlpack.yml包含以下内容的文件：

name: my-custom-cpp-pack
version: 0.0.0
libraryPathDependencies: codeql/cpp-all

5.创建Codeql数据库

命令：

codeql database create <database> --language=<language-identifier>

参数说明：

：创建的数据库的路径，必须是不存在的文件夹

–language：如下

C/C++cpp
C#csharp
Gogo
Javajava
JavaScript/TypeScriptjavascript
Pythonpython

其它参数：

–source-root 指定数据库创建时的源文件根目录，默认为当前目录。

–command 指定语言的编译命令，不要给python和JavaScript指定该命令。

非编译型语言创建数据库

codeql database create --language=javascript --source-root <folder-to-extract> <output-folder>/javascript-database

６、创建QL包，编写CodeQl脚本

创建 CodeQL 数据库后，将对其执行一个或多个查询。CodeQL 查询是用一种专门设计的面向对象的查询语言编写的，称为 QL。

7、执行查询

最后一步将查询执行期间产生的结果转换为在源代码上下文中更有意义的形式。也就是说，结果的解释方式突出了查询旨在发现的潜在问题。

查询包含指示应如何解释结果的元数据属性。例如，某些查询在代码中的单个位置显示一条简单的消息。其他的则显示一系列代表数据流或控制流路径上的步骤的位置，以及解释结果重要性的消息。没有元数据的查询不会被解释——它们的结果作为表格输出，而不显示在源代码中。

在解释之后，结果被输出用于代码审查和分类。在 CodeQL for Visual Studio Code 中，解释的查询结果会自动显示在源代码中。CodeQL CLI 生成的结果可以输出为多种不同格式，以供不同工具使用。

三、案例演示（WebGoat）

1、下载webgoat8.0版本:

https://github.com/WebGoat/WebGoat/archive/refs/tags/v8.0.0.M21.zip

2、创建Codeql数据库（本地需要已经安装maven,webgoat是基于maven构建的）

在webgoat根目录D:\CodeQlTest\WebGoat-8.0.0.M26下运行命令：

codeql database create java-database --language=java
在这里插入图片描述查看webgoat根目录，数据库已新建成功
在这里插入图片描述

3、Vscode增加CodeQl标准库

点击文件–>选择将文件夹添加到工作区–>选中本地CodeQl库
在这里插入图片描述

4、通过VsCode的QL插件添加CodeQL数据库在这里插入图片描述选择之前创建的webgoat的数据库java-database在这里插入图片描述## 5、创建QL包，编写CodeQl脚本

QL 包必须包含qlpack.yml在其根目录中调用的文件。

在codeql-repository\java\ql\examples目录下新建webgoatquery.ql"文件。
在这里插入图片描述

6、编写查询语句

在webgoatquery.ql中编写如下语句

import java
from Class B
where B.getName()="WebGoat"
select B

右键点击：RunQuery
在这里插入图片描述执行成功，会查询到WebGoat这个类
在这里插入图片描述修改代码，查询一个方法
在这里插入图片描述点击lessonPage,跳转到代码
在这里插入图片描述

[漏洞挖掘与防护] 01.漏洞利用之CVE-2019-0708复现及防御详解（含学习路线）
杨秀璋的专栏
07-10 1314
这是作者新开的一个专栏——“漏洞挖掘与防护”。第一篇文章将详细介绍Windows远程桌面服务漏洞（CVE-2019-0708），该高危漏洞利用方式是通过远程桌面端口3389，RDP协议进行攻击，堪比WannaCry。希望对入门的同学有帮助。您的点赞、评论、收藏将是对我最大的支持，感恩安全路上一路前行，如果有写得不好的地方，可以联系我修改。基础性文章，希望对您有所帮助！
【LangChain编程：从入门到实践】LangChain初体验
AI天才研究院
07-23 1128
【LangChain编程：从入门到实践】LangChain初体验 作者：禅与计算机程序设计艺术 / Zen and the Art of Computer Programming 关键词：LangChain, Prompt Engineering, 大型语言模型, 代码生成, 自动化开
CodeQL：探索代码安全的利器
INSBUG的博客
07-15 1121
4、对于从github获取的CodeQL数据库，这些数据库可能是使用新版本的CodeQL去编译创建的，但我们本地的CodeQL引擎很可能是之前的版本，那当你使用本地的CodeQL去分析这个数据库文件时就会有如下报错，提示这个CodeQL数据库与您尝试运行的查询引用的QL库不兼容，这时只需要重新在本地下载新版本的CodeQL规则库、新版本的CodeQL分析引擎，再重新执行查询即可。可以在下载的QL规则文件的\开发语言\ql\src\Security\CWE找到这些规则，不同的CWE文件对应了不同的安全风险。
CodeQL数据库构建原理分析
Chenhui98的博客
08-19 1166
是一个帮助开发者自动完成安全检查、帮助安全研究者进行变异分析的分析引擎。它由代码数据库和代码语义分析引擎组成，通过将代码抽象为数据查询表保存到代码数据库中，可以方便地运行代码查询。本文的关注点在于CodeQL是如何生成代码数据库。这里以java作为示例语言进行分析在配置好CodeQL以后，用户目录下的文件夹保存了CodeQL的CLI部分，它的目录结构如下，这里省略了部分无关文件CodeQL的入口文件为codeql，这是一个shell脚本，主要目的就是为调用codeql.jar。...
CodeQL漏洞挖掘实战，零基础入门到精通，收藏这一篇就够了
2402_84205067的博客
03-08 977
网络安全产业就像一个江湖，各色人等聚集。相对于欧美国家基础扎实（懂加密、会防护、能挖洞、擅工程）的众多名门正派，我国的人才更多的属于旁门左道（很多白帽子可能会不服气），因此在未来的人才培养和建设上，需要调整结构，鼓励更多的人去做“正向”的、结合“业务”与“数据”、“自动化”的“体系、建设”，才能解人才之渴，真正的为社会全面互联网化提供安全保障。
CodeQL学习笔记(1)-QL语法（逻辑连接词、量词、聚合词、谓词和类）
qq_35664104的博客
10-25 793
最近在学习CodeQL，对于CodeQL就不介绍了，目前网上一搜一大把。本系列是学习CodeQL的个人学习笔记，根据个人知识库笔记修改整理而来的，分享出来共同学习。个人觉得QL的语法比较反人类，至少与目前主流的这些OOP语言相比，还是有一定难度的。与现在网上的大多数所谓CodeQL教程不同，本系列基于和，包含大量的个人理解、思考和延伸，直入主题，只切要害，几乎没有废话，并且坚持用从每一个实例中学习总结归纳，再到实例中验证。希望能给各位一点不一样的见解和思路。
codeql语法简介
xhdxhdxhd的博客
08-11 983
codeql语法简介 QL Language Reference CodeQL for 编程语言 QL的语法来自于Datalog，Datalog来源于Prolog。 参考资料： http://www.lsv.fr/~segoufin/Papers/Mypapers/DB-chapter.pd 值 表达式 字符串: "abc\"" 范围: [3 .. 7] 集合: [1,2,3] this:QL可以通过class来定义类，类是结构化的逻辑表达 result: 在predict中，result用于绑定结果 su
CodeQL自动化代码审计工具
weixin_50464560的博客
08-19 9756
为什么要写这篇文章？自从Github宣布推出CodeQL，国外越来越多安全人员使用这个项目做代码安全评估工作，截止到此刻，CodeQL在Github上已经有超过3100个Star。但是国内了解CodeQL的安全人员并不多，能google到的关于codeql的中文文章比较少。大部分中文文章，都是介绍CodeQL是什么之后，用简单的代码片段说明CodeQL的某个功能，很少有非常全面的介绍使用CodeQL对一个项目做漏洞分析的文章。这让想学习的读者一头雾水，还是不知道该如何在自己的项目上使用CodeQL。所以我想
「 CodeQL从入门到精通系列 」01.CodeQL简介
所有成功的背后，都是痛苦的坚持，所有的痛苦，都是傻瓜般的不放弃!
03-24 4108
CodeQL是业界领先的语义代码分析引擎，可发现代码中的漏洞。CodeQL像查询数据一样查询代码安全缺陷及漏洞，从而消除。比如CodeQL默认集成的Java类安全检查规则"不安全的反序列化"，规则实现如下/**以上规则采用的编写语言为QL，QL是一种声明性、面向对象的查询语言，经过优化，可实现对分层数据结构（尤其是表示软件项目的数据库）的高效分析。
深入解析CodeQL在代码审计中的应用
由于文件信息提供的内容有限，以上知识点为CodeQL的一般性介绍，但可以为初学者提供一个关于CodeQL的基本概念框架，以及它在代码分析和安全审计中的应用。如果需要更深入的知识点解析，可以提供具体的CodeQL查询示例...
[漏洞挖掘与防护] 03.漏洞利用之WinRAR安全缺陷复现（CVE-2018-20250）及软件自启动分析
杨秀璋的专栏
08-26 608
上一篇文章将详细介绍MS08-067远程代码执行漏洞（CVE-2008-4250）及防御过程，它是Windows Server服务RPC请求缓冲区溢出漏洞，利用445端口，并通过Metasploit工具获取shell及进行深入的操作。这篇文章将详细讲解WinRAR漏洞（CVE-2018-20250），并复现了该漏洞和讲解了恶意软件自启动劫持原理。基础性文章，希望对入门的同学有帮助。
codeql：CodeQL：为世界各地的安全研究人员提供支持的库和查询，以及GitHub Advanced Security（代码扫描），LGTM.com和LGTM Enterprise中的代码扫描
02-13
CodeQL 这个开源存储库包含标准的CodeQL库和查询，这些查询和查询为向其全球客户提供的和其他CodeQL产品提供了支持。 有关支持Go分析的查询，库和提取器，请访问。 如何学习CodeQL并运行查询？ 关于编写CodeQL的入门，有。 您可以使用LGTM.com上的或扩展的来尝试对当前正在分析的任何开源项目进行查询。 贡献 我们欢迎为我们的标准库和标准检查做出贡献。 您是否有进行新检查的想法，或如何改善现有查询？ 然后，请继续并打开请求请求！ 不过，在您这样做之前，请花点时间阅读我们的。 您还可以查阅我们的以了解如何设置代码格式以保持一致性和清晰度，如何编写查询元数据以及如何为查询编写查询帮助文档。 执照 该存储库中的代码已获得的。 Visual Studio代码集成 如果使用Visual Studio Code在此存储库中工作，则有一些集成功能可以使开发更加容易。 Visua
codeql_chinese:CodeQL中文资料和常见使用解释。Chinese version of Codeql documents
04-13
CodeQL_Chinese 机器翻译(逐行校阅过，无阅读障碍)，部分阅读可能不是很舒服，不喜勿star 定期更新中，后期计划更新javascript , python等语言的文档，便于大家阅读. 欢迎大家一起来贡献！或者提issue! 我会把我知道尽可能回复给大家 以便快速入门。 毕竟codeQL官方文档真的是……无力吐槽 2020.08.06更新翻译 当前版本都是Java的 codeQL中文教程(重新翻译版).pdf -> 讲解codeQL的语法。就是官网的tutorial codeql_中文文档.pdf -> 讲解codeQL java下的语法(codeQL对每个语言的类定义范围是不一样的) 可以加我微信txsser 交流更多的codeQL技术 2020.10.20 更新一些编写codeQL规则的小技巧 additionalTaintStep(过程间调用).pdf RemoteFl
[漏洞挖掘与防护] 02.漏洞利用之MS08-067远程代码执行漏洞复现及深度防御
杨秀璋的专栏
07-14 1079
上一篇文章将详细介绍Windows远程桌面服务漏洞（CVE-2019-0708），该高危漏洞利用方式是通过远程桌面端口3389，RDP协议进行攻击。这篇文章将详细讲解MS08-067远程代码执行漏洞（CVE-2008-4250）及防御过程，它是Windows Server服务RPC请求缓冲区溢出漏洞，利用445端口，并通过Metasploit工具获取shell及进行深入的操作。希望对入门的同学有帮助。
CodeQL教程
DVK
08-11 1800
CodeQL学习笔记 0x00 前言 近期在学习静态代码审计的部分内容，找到了一个强大的神器CodeQL。 CodeQL是一款帮助开发者自动化安全检查的分析引擎，同时也能够帮助安全研究人员进行变种函数分析。 在CodeQL的世界，所有的代卖都被视作数据来处理。安全漏洞、bugs、以及其他错误都可以生成查询模型来针对性的从代码提取出的数据库进行查询。 0x01 已有资源分析 每次在学习一个新鲜的东西，第一时间都是去找各位师傅的博客和分享。所以第一部分先把国内各位大师傅的博文都撸一遍，站在巨人的肩膀上再去啃官
深入codeql
xhdxhdxhd的博客
08-04 728
介绍 关于Codeql，参考之前的文章：placeholder 这里将会基于codeql-go的源码来探索codeql的原理。 准备工作 extractor trap文件
CodeQL从入门到放弃（转载）
晓川吖的专栏
09-09 1776
为什么要写这篇文章？ 自从Github宣布推出CodeQL，国外越来越多安全人员使用这个项目做代码安全评估工作，截止到此刻，CodeQL在Github上已经有超过3100个Star。 但是国内了解CodeQL的安全人员并不多，能google到的关于codeql的中文文章比较少。大部分中文文章，都是介绍CodeQL是什么之后，用简单的代码片段说明CodeQL的某个功能，很少有非常全面的介绍使用CodeQL对一个项目做漏洞分析的文章。这让想学习的读者一头雾水，还是不知道该如何在自己的项目上使用CodeQL。
codeql 代码分析工具
xhdxhdxhd的博客
08-04 558
介绍 vscode安装和使用 如果你想分析自己的代码仓库，你需要安装完整的codeql CLI， 推荐使用vscode扩展。 整体工具组成如下： ~/codeql-home | | -- codeql | | | ---codeql codeql可执行文件 | -- codeql-repo code的代码仓库 git clone https://github.com/github/codeql codeql-repo |
初见CodeQL
Love&Share
01-25 1414
CodeQL 的核心引擎是不开源的，这个核心引擎的作用之一是帮助我们把要审计的代码文件转换成CodeQL能识别的中间层 AST 数据库，然后我们需要编写 QL 查询语句来获取我们想要的数据，由于 CodeQL 开源了所有的规则和规则库部分，所以我们能够做的就是编写符合我们业务逻辑的 QL 规则，然后使用 CodeQL 引擎去跑我们的规则，发现靶场的安全漏洞。在代码自动化安全审计的理论当中，有一个最核心的三元组概念，就是(source，sink和sanitizer)运行之后，会在最后提示下一步要执行的命令。
codeQL starter
最新发布
03-25
### CodeQL 入门教程 CodeQL 是一种强大的查询语言，用于分析和理解源代码中的安全漏洞和其他质量问题。它允许开发者编写复杂的查询来检测潜在的安全隐患并改进软件质量。 #### 什么是 CodeQL？ CodeQL 是由 Semmle 开发的一种静态分析技术，现在已成为 GitHub 的一部分。它可以用来扫描代码库以查找已知的漏洞模式以及自定义逻辑错误[^5]。通过学习 CodeQL，开发人员可以更有效地识别代码中的安全隐患，并提高整体安全性。 #### 安装与配置 要开始使用 CodeQL，首先需要安装必要的工具链。可以通过以下链接下载官方支持的 CodeQL CLI 工具包： - **GitHub CodeQL**: [https://github.com/github/codeql](https://github.com/github/codeql) 完成安装后，还需要设置环境变量以便命令行能够访问这些工具。具体步骤如下所示： ```bash export PATH=$PATH:/path/to/your/codeql-cli/bin ``` #### 编写第一个 Query 下面是一个简单的例子，展示如何利用 CodeQL 查找 C++ 中未初始化指针的情况： ```codeql import cpp from Pointer p where not exists(p.initializer) select p, "This pointer is never initialized." ``` 此脚本会遍历整个项目文件树结构寻找那些声明之后从未被赋予初始值的指针变量[^6]。 #### 运行 Queries 一旦创建好 query 文件 (通常扩展名为 .ql)，就可以借助 `codeql` 命令执行它们: ```bash codeql database analyze --format=csv mydb UninitializedPointers.ql > results.csv ``` 上述指令将会把查询结果导出到 CSV 文件当中便于后续处理或者报告生成[^7]。 --- ###
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值