CodeQL设计模式解析：构建可扩展且精确的查询模型-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00079/article/details/148440837

CodeQL设计模式解析：构建可扩展且精确的查询模型

codeql CodeQL: the libraries and queries that power security researchers around the world, as well as code scanning in GitHub Advanced Security 项目地址: https://gitcode.com/gh_mirrors/co/codeql

引言

在静态代码分析领域，CodeQL作为强大的语义代码分析引擎，其核心在于如何有效地建模代码结构。本文将深入探讨CodeQL中的关键设计模式，特别是::Range模式，帮助开发者构建既灵活又精确的查询模型。

理解`::Range`设计模式

模式背景

在CodeQL建模过程中，我们经常面临两个看似矛盾的需求：

可扩展性：允许用户添加新的模型实例
精确性：能够对现有模型进行细粒度控制

传统方法使用简单的抽象类只能满足其中一个需求，而::Range模式则完美解决了这一矛盾。

模式实现

::Range模式通过以下结构实现：

// 主类：用于模型精炼
class MySpecialExpr extends Expr instanceof MySpecialExpr::Range {
  int memberPredicate() { result = super.memberPredicate() }
}

module MySpecialExpr {
  // 范围类：用于模型扩展
  abstract class Range extends Expr {
    abstract int memberPredicate();
  }
}

这种结构实现了清晰的职责分离：

主类(MySpecialExpr)：用于覆盖和精炼现有行为
范围类(MySpecialExpr::Range)：用于扩展新的模型实例

实际应用示例

以Python库中的HTML转义函数建模为例：

class Escaping extends Expr instanceof Escaping::Range {
  string getKind() { result = super.getKind() }
}

module Escaping {
  abstract class Range extends Expr {
    abstract string getKind();
  }
}

// 扩展新API
class HtmlEscapeFunction extends Escaping::Range {
  override string getKind() { result = "html" }
}

// 精炼现有行为
class HtmlEscaping extends Escaping {
  override string getKind() { result = "html" }
}

这种模式使得：

可以轻松添加新的转义函数类型
能够统一修改所有HTML转义函数的行为

类继承的最佳实践

开放与封闭联合

在CodeQL中，抽象类可以表示两种不同类型的联合：

开放联合：预期会被扩展
- 典型应用：::Range模式中的范围类
- 特点：明确设计为扩展点
封闭联合：不预期被扩展
- 传统错误做法：使用抽象类
- 正确做法：使用非抽象类+明确的范围定义

封闭联合的正确实现

以二元表达式为例，正确做法应该是：

// 正确实现：非抽象类+明确范围
class BinaryExpr extends Expr {
  Expr getLhs() { result = this.getChild(0) }
  Expr getRight() { result = this.getChild(1) }
  
  // 明确指定范围
  BinaryExpr() { 
    this instanceof PlusExpr or 
    this instanceof MinusExpr or
    ...
  }
}

class PlusExpr extends BinaryExpr {}
class MinusExpr extends BinaryExpr {}

这种方式避免了用户意外扩展带来的问题，同时保持了模型的清晰性。