Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luelueking/ClazzSearcher
一款使用Yaml定义搜索规则来搜索Class的工具
https://github.com/luelueking/ClazzSearcher
Last synced: 3 months ago
JSON representation
一款使用Yaml定义搜索规则来搜索Class的工具
- Host: GitHub
- URL: https://github.com/luelueking/ClazzSearcher
- Owner: luelueking
- Created: 2023-07-30T07:12:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-02T01:34:56.000Z (over 1 year ago)
- Last Synced: 2024-04-18T06:57:03.089Z (8 months ago)
- Language: Java
- Size: 85.9 KB
- Stars: 95
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-hacking-lists - luelueking/ClazzSearcher - 一款使用Yaml定义搜索规则来搜索Class的工具 (Java)
README
# ClazzSearcher
一款使用Yaml定义搜索规则来搜索Class的工具
### Quick Start(快速开始)
```shell
# 搜索jar包
java -jar ClazzSearcher.jar --f example.yml --boot d3forest-1.0-SNAPSHOT.jar
# 搜索目录
java -jar ClazzSearcher.jar --f example.yml --boot target/dir/lib
# 使用缓存
java -jar ClazzSearcher.jar --resume --f example.yml ....
```
下面是yml的规则搜索模版(如果不需要引入某条rule则不写)
```yaml
name: "targetName" # target的类名，支持正则，例如".*ServiceImpl$"
isInterface: false # target是不是接口，true:是
extendsList: # target继承的父类，有多个，因为接口可以有多个父接口
- java.lang.Object
implementsList: # target实现的接口，例如"java/io/Serializable"
- interface1
- interface2
annotations: # target上存在的注解，例如"Lorg/springframework/web/bind/annotation/RestController;"
- annotation1
- annotation2
fields: # target所有的field属性，field之间为与逻辑
- {
"name": "request", # field的name
"access": 2, # field的访问access
"type": "type1" # field的class类型，例如"org/springframework/http/server/reactive/ServerHttpRequest"
}
- {
"name": "field2",
"access": 1,
"type": "type2"
}
methods: # target所拥有的method方法
- {
"name": "m1", # method的name，例如"excludeMBeanIfNecessary"
"desc": "desc1", # method的描述符，例如"(Ljava/lang/Object;)V"
"access": "public", # method的访问修饰符
"isStatic": false, # method是否是静态方法
"calls": [ # method中调用了哪些方法, calls之间为或逻辑
{
"classRef": "org/springframework/jmx/export/MBeanExporter", # 被调用方法的类
"name": "addExcludedBean", # 被调用方法的名
"desc": "(Ljava/lang/String;)V" # 被调用方法的方法描述
}
]
}
- {
"name": "m2",
"desc": "(Ljava/io/Reader;)Ljava/lang/Object;",
"access": "private",
"call" : [
{ },{ },...
]
}
```
### Use Case(使用案例)
例如下面一段规则
```yaml
implementsList:
- org/springframework/beans/PropertyValues
- java/io/Serializable
extendsList:
- org/springframework/beans/MutablePropertyValues
```
运行`ClazzSearchApplication`加上参数`--f example.yml --boot d3forest-1.0-SNAPSHOT.jar`
```
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载所有方法信息完毕
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载所有类信息完毕
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载所有父子类、超类、实现类关系
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载方法调用信息完毕
[main] INFO org.vidar.discovery.ClazzDiscovery - 开始寻找目标类...
[main] INFO org.vidar.discovery.ClazzDiscovery - 你所寻找的class实现的接口有：
[main] INFO org.vidar.discovery.ClazzDiscovery - org/springframework/beans/PropertyValues
[main] INFO org.vidar.discovery.ClazzDiscovery - java/io/Serializable
[main] INFO org.vidar.discovery.ClazzDiscovery - 你所寻找的class继承的类有：
[main] INFO org.vidar.discovery.ClazzDiscovery - org/springframework/beans/MutablePropertyValues
找到一个类：ClassReference.Handle(name=org/springframework/web/bind/ServletRequestParameterPropertyValues)
找到一个类：ClassReference.Handle(name=org/springframework/web/filter/GenericFilterBean$FilterConfigPropertyValues)
找到一个类：ClassReference.Handle(name=org/springframework/web/servlet/HttpServletBean$ServletConfigPropertyValues)
```
如有下面这段规则
```yaml
methods:
- {
"name": "excludeMBeanIfNecessary",
"desc": "(Ljava/lang/Object;Ljava/lang/String;Lorg/springframework/context/ApplicationContext;)V",
"access": "private",
"isStatic": false,
"calls": [
{
"classRef": "org/springframework/jmx/export/MBeanExporter",
"name": "addExcludedBean",
"desc": "(Ljava/lang/String;)V"
}
]
}
```
运行`ClazzSearchApplication`加上参数`--f example.yml --boot d3forest-1.0-SNAPSHOT.jar`
```
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载所有方法信息完毕
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载所有类信息完毕
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载所有父子类、超类、实现类关系
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载方法调用信息完毕
[main] INFO org.vidar.discovery.ClazzDiscovery - 开始寻找目标类...
[main] INFO org.vidar.discovery.ClazzDiscovery - 你希望target中存在：ClazzRule.Method(clazz=null, name=excludeMBeanIfNecessary, desc=(Ljava/lang/Object;Ljava/lang/String;Lorg/springframework/context/ApplicationContext;)V, access=private, isStatic=false, calls=[ClazzRule.Call(classRef=org/springframework/jmx/export/MBeanExporter, name=addExcludedBean, desc=(Ljava/lang/String;)V)])方法
找到一个类：ClassReference.Handle(name=org/springframework/boot/autoconfigure/jdbc/JndiDataSourceAutoConfiguration)
```
### 实战例子
#### 寻找一些lookup的sink点
``` yaml
methods:
- {
"name": "connect",
"calls": [
{
"classRef": "javax/naming/Context",
"name": "lookup"
},
{
"classRef": "javax/naming/InitialContext",
"name": "lookup"
}
]
}
```
运行结果
```
______ __ ______ ______ ______ ______ ______ ______ ______ ______ __ __ ______ ______
/\ ___\/\ \ /\ __ \/\___ \/\___ \ /\ ___\/\ ___\/\ __ \/\ == \/\ ___\/\ \_\ \/\ ___\/\ == \
\ \ \___\ \ \___\ \ __ \/_/ /_\/_/ /__ \ \___ \ \ __\\ \ __ \ \ __<\ \ \___\ \ __ \ \ __\\ \ __<
\ \_____\ \_____\ \_\ \_\/\_____\/\_____\ \/\_____\ \_____\ \_\ \_\ \_\ \_\ \_____\ \_\ \_\ \_____\ \_\ \_\
\/_____/\/_____/\/_/\/_/\/_____/\/_____/ \/_____/\/_____/\/_/\/_/\/_/ /_/\/_____/\/_/\/_/\/_____/\/_/ /_/
[main] INFO org.vidar.ClazzSearchApplication - Using JAR classpath: /Users/zhchen/Downloads/github-workspace/d3forest/target/d3forest-1.0-SNAPSHOT.jar
[main] INFO org.vidar.ClazzSearchApplication - Running method discovery...
[main] INFO org.vidar.data.InheritanceDeriver - Calculating inheritance for 46001 classes...
[main] INFO org.vidar.ClazzSearchApplication - Searching target class for yml ...
ClazzRule(name=null, isInterface=null, extendsList=null, implementsList=null, annotations=null, fields=null, methods=[ClazzRule.Method(clazz=null, name=connect, desc=null, access=null, isStatic=null, calls=[ClazzRule.Call(classRef=javax/naming/Context, name=lookup, desc=null), ClazzRule.Call(classRef=javax/naming/InitialContext, name=lookup, desc=null)])])
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载所有方法信息完毕...
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载所有类信息完毕...
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载所有父子类、超类、实现类关系完毕...
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载方法调用信息完毕...
[main] INFO org.vidar.discovery.ClazzDiscovery - 开始寻找目标类...
[main] INFO org.vidar.discovery.ClazzDiscovery - 你希望target中存在：ClazzRule.Method(clazz=null, name=connect, desc=null, access=null, isStatic=null, calls=[ClazzRule.Call(claavax/naming/Context, name=lookup, desc=null), ClazzRule.Call(classRef=javax/naming/InitialContext, name=lookup, desc=null)])方法
以下是搜索结果：
ClassReference.Handle(name=com/sun/rowset/internal/CachedRowSetReader)
ClassReference.Handle(name=com/sun/rowset/JdbcRowSetImpl)
```
#### 利用注解来寻找jar中的一些路由
```yaml
annotations:
- "Lorg/springframework/web/bind/annotation/RestController;"
- "Lorg/springframework/stereotype/Controller;"
```
结果
```
______ __ ______ ______ ______ ______ ______ ______ ______ ______ __ __ ______ ______
/\ ___\/\ \ /\ __ \/\___ \/\___ \ /\ ___\/\ ___\/\ __ \/\ == \/\ ___\/\ \_\ \/\ ___\/\ == \
\ \ \___\ \ \___\ \ __ \/_/ /_\/_/ /__ \ \___ \ \ __\\ \ __ \ \ __<\ \ \___\ \ __ \ \ __\\ \ __<
\ \_____\ \_____\ \_\ \_\/\_____\/\_____\ \/\_____\ \_____\ \_\ \_\ \_\ \_\ \_____\ \_\ \_\ \_____\ \_\ \_\
\/_____/\/_____/\/_/\/_/\/_____/\/_____/ \/_____/\/_____/\/_/\/_/\/_/ /_/\/_____/\/_/\/_/\/_____/\/_/ /_/
[main] INFO org.vidar.ClazzSearchApplication - Using JAR classpath: /Users/zhchen/Downloads/github-workspace/d3forest/target/d3forest-1.0-SNAPSHOT.jar
[main] INFO org.vidar.ClazzSearchApplication - Running method discovery...
[main] INFO org.vidar.data.InheritanceDeriver - Calculating inheritance for 46001 classes...
[main] INFO org.vidar.ClazzSearchApplication - Searching target class for yml ...
ClazzRule(name=null, isInterface=null, extendsList=null, implementsList=null, annotations=[Lorg/springframework/web/bind/annotation/RestController;, Lorg/springframework/stereotype/Controller;], fields=null, methods=[ClazzRule.Method(clazz=null, name=hello, desc=null, access=null, isStatic=null, calls=null)])
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载所有方法信息完毕...
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载所有类信息完毕...
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载所有父子类、超类、实现类关系完毕...
[main] INFO org.vidar.discovery.ClazzDiscovery - 加载方法调用信息完毕...
[main] INFO org.vidar.discovery.ClazzDiscovery - 开始寻找目标类...
[main] INFO org.vidar.discovery.ClazzDiscovery - 你希望target中存在：ClazzRule.Method(clazz=null, name=hello, desc=null, access=null, isStatic=null, calls=null)方法
以下是搜索结果：
ClassReference.Handle(name=com/d3ctf/controller/HelloController)
```
### 参数说明
- --resume 是否使用已建立的数据缓存
- --f 指定配置yml
- --onlyJDK 是否只在jdk中筛选
- --boot 是否是springboot的jar
### 附录
#### field access计算表
| 访问修饰符 | 数值表示 |
| --------- | ------- |
| ACC_PUBLIC | 1 |
| ACC_PRIVATE | 2 |
| ACC_PROTECTED | 4 |
| ACC_STATIC | 8 |
| ACC_FINAL | 16 |
| ACC_VOLATILE | 64 |
| ACC_TRANSIENT | 128 |
| ACC_SYNTHETIC | 4096 |
### TODO List
- [x] 正则查询匹配
- [ ] 更友好的字符格式
- [ ] 交互式查询
- [ ] 指定输出路径
### 开发者说明
- `mvn clean install`即可以重新打包项目
- 如对搜索逻辑不满，可提issue或者直接在`ClazzDiscovery`中修改为你的逻辑，代码很通俗