Skip to content

Commit 9e06829

Browse files
bensonhomebensonhome
authored
Merge pull request #661 from yalechen-cyw/main
📝 Add front_end_framework_check doc
2 parents b05f682 + 5481e34 commit 9e06829

6 files changed

Lines changed: 216 additions & 0 deletions

File tree

‎doc/.vuepress/configs/sidebar/en.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ export const en: SidebarConfig = {
3939
'/en/guide/代码检查/规则包/enhanced_safety_java.md',
4040
'/en/guide/代码检查/规则包/test_case_verify_go.md',
4141
'/en/guide/代码检查/规则包/code_spec_oc.md',
42+
'/en/guide/代码检查/规则包/front_end_framework_check.md',
43+
'/en/guide/代码检查/规则包/dependency_vul.md',
4244
],
4345
},
4446
]

‎doc/.vuepress/configs/sidebar/zh.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ export const zh: SidebarConfig = {
3939
'/zh/guide/代码检查/规则包/enhanced_safety_java.md',
4040
'/zh/guide/代码检查/规则包/test_case_verify_go.md',
4141
'/zh/guide/代码检查/规则包/code_spec_oc.md',
42+
'/zh/guide/代码检查/规则包/front_end_framework_check.md',
43+
'/zh/guide/代码检查/规则包/dependency_vul.md',
4244
],
4345
},
4446
]

‎doc/en/guide/代码检查/规则包/dependency_vul.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# 依赖漏洞扫描规则包
2+
3+
## 概述
4+
该规则包可分析项目依赖组件，以及依赖组件中是否存在漏洞等问题。辅助开发者准确分析到依赖组件的安全性，选用安全可靠的依赖组件。
5+
6+
规则包中将漏洞规则分为“低危漏洞”、“中危漏洞”、“高危漏洞”三个等级，扫描出有漏洞的组件，TCA会提供问题组件名称和版本、漏洞情况介绍，以及可用的修复版本（如获取到）。
7+
8+
已支持语言：C/C++、C#、Go、Java、JavaScript、PHP、Python、Ruby、Scala、TypeScript等。
9+
10+
## 示例
11+
12+
```xml
13+
<?xml version="1.0" encoding="UTF-8"?>
14+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
15+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
16+
17+
<parent>
18+
<groupId>org.javaweb.vuln</groupId>
19+
<artifactId>javaweb-vuln</artifactId>
20+
<version>3.0.3</version>
21+
</parent>
22+
23+
<dependencies>
24+
25+
<dependency>
26+
<groupId>org.apache.struts</groupId>
27+
<artifactId>struts2-core</artifactId>
28+
<!-- 触发规则 -->
29+
<version>2.1.8</version>
30+
<exclusions>
31+
<exclusion>
32+
<groupId>org.freemarker</groupId>
33+
<artifactId>freemarker</artifactId>
34+
</exclusion>
35+
36+
<exclusion>
37+
<groupId>org.springframework</groupId>
38+
<artifactId>spring-test</artifactId>
39+
</exclusion>
40+
41+
<exclusion>
42+
<groupId>commons-fileupload</groupId>
43+
<artifactId>commons-fileupload</artifactId>
44+
</exclusion>
45+
</exclusions>
46+
</dependency>
47+
48+
</dependencies>
49+
50+
</project>
51+
```
52+
53+
## 快速体验
54+
TCA 现已支持前端框架检查规则包，可以在 TCA 分析方案中搜索勾选该规则包，快速体验。
55+
56+
### 启用规则包
57+
分析方案 -> 代码检查 ->【Objective-C】代码规范规则包 -> 启用/查看规则。
58+
59+
### 更多
60+
61+
更多场景支持，欢迎提 issue 进行咨询扩展。

‎doc/en/guide/代码检查/规则包/front_end_framework_check.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# 前端框架检查规则包
2+
3+
## 背景
4+
5+
前端项目在长期发展过程中，由于框架开源许可证变更、框架性能外观等不适用等因素，需要对前端框架进行平滑切换，而这就需要腾讯云代码分析 TCA 的介入，方便对企业内所有前端项目进行批量分析统计，方便管理。
6+
7+
## 需求
8+
9+
- 检查代码仓库中使用到指定前端框架的代码位置。
10+
11+
### 示例
12+
13+
```json
14+
{
15+
"name": "framework",
16+
"version": "1.0.0",
17+
"dependencies": {
18+
"react": "^17.0.2", // 触发规则
19+
"react-dom": "^17.0.2", // 触发规则
20+
"react-hotkeys-hook": "^3.4.3", // 触发规则
21+
"react-redux": "^7.2.5", // 触发规则
22+
"single-spa": "^5.9.3",
23+
"universal-cookie": "^4.0.4"
24+
},
25+
}
26+
```
27+
28+
## 快速体验
29+
30+
TCA 现已支持前端框架检查规则包，可以在 TCA 分析方案中搜索勾选以下规则包，快速体验。
31+
32+
### 启用规则包
33+
分析方案 -> 代码检查 -> 前端框架检查规则包 -> 启用/查看规则
34+
35+
### 支持框架
36+
37+
- TDesign
38+
- AntD
39+
- React
40+
- Vue
41+
42+
43+
### 更多
44+
45+
更多框架支持，欢迎提 issue 进行咨询扩展。

‎doc/zh/guide/代码检查/规则包/dependency_vul.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# 依赖漏洞扫描规则包
2+
3+
## 概述
4+
该规则包可分析项目依赖组件，以及依赖组件中是否存在漏洞等问题。辅助开发者准确分析到依赖组件的安全性，选用安全可靠的依赖组件。
5+
6+
规则包中将漏洞规则分为“低危漏洞”、“中危漏洞”、“高危漏洞”三个等级，扫描出有漏洞的组件，TCA会提供问题组件名称和版本、漏洞情况介绍，以及可用的修复版本（如获取到）。
7+
8+
已支持语言：C/C++、C#、Go、Java、JavaScript、PHP、Python、Ruby、Scala、TypeScript等。
9+
10+
## 示例
11+
12+
```xml
13+
<?xml version="1.0" encoding="UTF-8"?>
14+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
15+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
16+
17+
<parent>
18+
<groupId>org.javaweb.vuln</groupId>
19+
<artifactId>javaweb-vuln</artifactId>
20+
<version>3.0.3</version>
21+
</parent>
22+
23+
<dependencies>
24+
25+
<dependency>
26+
<groupId>org.apache.struts</groupId>
27+
<artifactId>struts2-core</artifactId>
28+
<!-- 触发规则 -->
29+
<version>2.1.8</version>
30+
<exclusions>
31+
<exclusion>
32+
<groupId>org.freemarker</groupId>
33+
<artifactId>freemarker</artifactId>
34+
</exclusion>
35+
36+
<exclusion>
37+
<groupId>org.springframework</groupId>
38+
<artifactId>spring-test</artifactId>
39+
</exclusion>
40+
41+
<exclusion>
42+
<groupId>commons-fileupload</groupId>
43+
<artifactId>commons-fileupload</artifactId>
44+
</exclusion>
45+
</exclusions>
46+
</dependency>
47+
48+
</dependencies>
49+
50+
</project>
51+
```
52+
53+
## 快速体验
54+
TCA 现已支持前端框架检查规则包，可以在 TCA 分析方案中搜索勾选该规则包，快速体验。
55+
56+
### 启用规则包
57+
分析方案 -> 代码检查 ->【Objective-C】代码规范规则包 -> 启用/查看规则。
58+
59+
### 更多
60+
61+
更多场景支持，欢迎提 issue 进行咨询扩展。

‎doc/zh/guide/代码检查/规则包/front_end_framework_check.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# 前端框架检查规则包
2+
3+
## 背景
4+
5+
前端项目在长期发展过程中，由于框架开源许可证变更、框架性能外观等不适用等因素，需要对前端框架进行平滑切换，而这就需要腾讯云代码分析 TCA 的介入，方便对企业内所有前端项目进行批量分析统计，方便管理。
6+
7+
## 需求
8+
9+
- 检查代码仓库中使用到指定前端框架的代码位置。
10+
11+
### 示例
12+
13+
```json
14+
{
15+
"name": "framework",
16+
"version": "1.0.0",
17+
"dependencies": {
18+
"react": "^17.0.2", // 触发规则
19+
"react-dom": "^17.0.2", // 触发规则
20+
"react-hotkeys-hook": "^3.4.3", // 触发规则
21+
"react-redux": "^7.2.5", // 触发规则
22+
"single-spa": "^5.9.3",
23+
"universal-cookie": "^4.0.4"
24+
},
25+
}
26+
```
27+
28+
## 快速体验
29+
30+
TCA 现已支持前端框架检查规则包，可以在 TCA 分析方案中搜索勾选以下规则包，快速体验。
31+
32+
### 启用规则包
33+
分析方案 -> 代码检查 -> 前端框架检查规则包 -> 启用/查看规则
34+
35+
### 支持框架
36+
37+
- TDesign
38+
- AntD
39+
- React
40+
- Vue
41+
42+
43+
### 更多
44+
45+
更多框架支持，欢迎提 issue 进行咨询扩展。

0 commit comments

Comments
 (0)