Skip to content

📝 update tools readme #558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aaaa-j merged 4 commits into from
Aug 23, 2022
Merged

📝 update tools readme #558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb4bdaf
Merge branch 'main' of https://github.com/yalechen-cyw/CodeAnalysis
cyw3 Aug 19, 2022
e6e0e28
:memo: update cls doc
cyw3 Aug 19, 2022
61f4ccb
:memo: update tools readme
cyw3 Aug 19, 2022
860b0bb
:memo: update tools doc
cyw3 Aug 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions doc/en/quickStarted/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| 官方工具 | 第三方工具 |
| :--------: | :-------: |
|[0daychecker](https://github.com/Tencent/CodeAnalysis/tree/main/tools/codedog_0Day_checker)| androidlint |
|[TCA-0Day_Checker(测试版)](https://github.com/TCATools/codedog_0Day_checker)| androidlint |
|clangwarning| checkstyle |
|codecount| clang |
|customfilescan| cobra |
Expand All @@ -13,11 +13,11 @@
|javawarning| cpplint |
|regexfilescan| dart_code_metrics |
|regexscan| dartanalyzer |
|[tca_ql_php_beta](https://github.com/Tencent/CodeAnalysis/tree/main/tools/Hades_Beta)| detekt |
|unusedresource| eslint |
|[collie](https://github.com/Tencent/CodeAnalysis/tree/main/tools/collie/)| eslint_typescript |
|[compass](https://github.com/Tencent/CodeAnalysis/tree/main/tools/compass)| eslint_vue |
|| findbugs |
|[TCA-Armory(测试版)](https://github.com/TCATools/TCA-Armory.git)| detekt |
|[TCA-Loong_Beta龙(测试版)](https://github.com/TCATools/loong_beta)| eslint |
|[TCA-Zeus_Beta(测试版)](https://github.com/TCATools/Zeus_Beta)| eslint_typescript |
|[TCA-Hades_Beta(测试版)](https://github.com/TCATools/Hades_Beta)| eslint_vue |
|unusedresource| findbugs |
|| flake8 |
|| [flawfinder](https://github.com/TCATools/flawfinder) |
|| flow |
Expand Down Expand Up @@ -45,3 +45,4 @@
|| [sonarqube](https://github.com/GabrielLegend/tca_plugin_sonarqube/blob/main/src/sq.py) |
|| [sonarqube_java](https://github.com/GabrielLegend/tca_plugin_sonarqube/blob/main/src/sq_java.py) |
|| [sonarqube_cs](https://github.com/GabrielLegend/tca_plugin_sonarqube/blob/main/src/sq_cs.py) |
|| [tca_plugin_sqlcheck](https://github.com/TCATools/tca_plugin_sqlcheck) |
47 changes: 0 additions & 47 deletions doc/old/tools.md
View file
Open in desktop

This file was deleted.

13 changes: 7 additions & 6 deletions doc/zh/quickStarted/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| 官方工具 | 第三方工具 |
| :--------: | :-------: |
|[0daychecker](https://github.com/Tencent/CodeAnalysis/tree/main/tools/codedog_0Day_checker)| androidlint |
|[TCA-0Day_Checker(测试版)](https://github.com/TCATools/codedog_0Day_checker)| androidlint |
|clangwarning| checkstyle |
|codecount| clang |
|customfilescan| cobra |
Expand All @@ -13,11 +13,11 @@
|javawarning| cpplint |
|regexfilescan| dart_code_metrics |
|regexscan| dartanalyzer |
|[tca_ql_php_beta](https://github.com/Tencent/CodeAnalysis/tree/main/tools/Hades_Beta)| detekt |
|unusedresource| eslint |
|[collie](https://github.com/Tencent/CodeAnalysis/tree/main/tools/collie/)| eslint_typescript |
|[compass](https://github.com/Tencent/CodeAnalysis/tree/main/tools/compass)| eslint_vue |
|| findbugs |
|[TCA-Armory(测试版)](https://github.com/TCATools/TCA-Armory.git)| detekt |
|[TCA-Loong_Beta龙(测试版)](https://github.com/TCATools/loong_beta)| eslint |
|[TCA-Zeus_Beta(测试版)](https://github.com/TCATools/Zeus_Beta)| eslint_typescript |
|[TCA-Hades_Beta(测试版)](https://github.com/TCATools/Hades_Beta)| eslint_vue |
|unusedresource| findbugs |
|| flake8 |
|| [flawfinder](https://github.com/TCATools/flawfinder) |
|| flow |
Expand Down Expand Up @@ -45,3 +45,4 @@
|| [sonarqube](https://github.com/GabrielLegend/tca_plugin_sonarqube/blob/main/src/sq.py) |
|| [sonarqube_java](https://github.com/GabrielLegend/tca_plugin_sonarqube/blob/main/src/sq_java.py) |
|| [sonarqube_cs](https://github.com/GabrielLegend/tca_plugin_sonarqube/blob/main/src/sq_cs.py) |
|| [tca_plugin_sqlcheck](https://github.com/TCATools/tca_plugin_sqlcheck) |
3 changes: 2 additions & 1 deletion server/cls/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ TCA独立工具License申请邮件
| | |
| :----: | :----: |
| 申请人名称 | xxx |
| 申请人所在公司/学校名称 | xxx |
| 申请人所在组织名称 | xxx |
| 申请人所在组织类型 | 可选选项：公司/学校/个人 |
| 申请人邮箱 | xxx |
| 申请人手机号码 | xxx |
| 首次登记的机器码 | xxx |
Expand Down
44 changes: 9 additions & 35 deletions tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,17 @@
## **注意**
以下部分独立工具需要申请授权，具体操作可以参考[CLS使用文档](../server/cls/README.md).

## [TCA-Collie(测试版)](https://github.com/TCATools/collie)
一款多语言非编译型静态代码分析工具，支持C/C++/ObjectiveC/C#/CSS/Dart/Java/JavaScript/TypeScript/Kotlin/Lua/PHP/Python/Go/Ruby/Scala/Swift等17门语言，需要申请License。

## [TCA-Compass罗盘(测试版)](https://github.com/TCATools/compass)
一款依赖组件分析工具，支持：
- 分析项目的依赖组件；
- 分析依赖组件是否存在漏洞等问题。

需要申请License。

## TCA-Loong龙(测试版)
Java/Kotlin API和函数调用链分析工具，需要申请License。
## [TCA-Armory(测试版)](https://github.com/TCATools/TCA-Armory)
一款多功能的多语言静态代码分析工具，需申请License。
## 功能
- 支持Objective-C/C++代码规范检查；
- 支持分析项目的依赖组件；
- 支持分析依赖组件是否存在漏洞等问题；
- 支持Java/Kotlin API和函数调用链分析；
- 支持代码安全、空指针检查、内存泄漏等规则。

### 如何在TCA上使用
在TCA上勾选以下工具规则：
- [JAAF](../server/projects/main/apps/scan_conf/management/commands/open_source/jaaf.json#L4)
- [JAFC](../server/projects/main/apps/scan_conf/management/commands/open_source/jafc.json#L4)
- [JAFF](../server/projects/main/apps/scan_conf/management/commands/open_source/jaff.json#L4)

### 底层命令行工具
涉及到的底层命令行工具有：
- [TCA-Loong龙(测试版)](https://github.com/TCATools/loong)
在TCA上勾选名称以 `TCA-Armory` 开头的工具的规则。

## TCA-Loong_Beta龙(测试版)
Java/Kotlin API和函数调用链分析工具，无需申请License。
Expand All @@ -38,21 +27,6 @@ Java/Kotlin API和函数调用链分析工具，无需申请License。
涉及到的底层命令行工具有：
- [TCA-Loong_Beta龙(测试版)](https://github.com/TCATools/loong_beta)

## TCA-QL(测试版)
一款静态代码分析的解析端，开源测试版仅开放在linux上运行，需要申请License。

### 如何在TCA上使用
在TCA上勾选以下工具规则：
- [TCA_QL_CPP](../server/projects/main/apps/scan_conf/management/commands/open_source/tca_ql_cpp.json#L4)
- [TCA_QL_Go](../server/projects/main/apps/scan_conf/management/commands/open_source/tca_ql_go.json#L4)
- [TCA_QL_PHP](../server/projects/main/apps/scan_conf/management/commands/open_source/tca_ql_php.json#L4)
- [TCA_QL_Python](../server/projects/main/apps/scan_conf/management/commands/open_source/tca_ql_python.json#L4)

### 底层命令行工具
涉及到的底层命令行工具有：
- [TCA-Zeus(测试版)](https://github.com/TCATools/TCA-Zeus-linux)
- [TCA-Hades(测试版)](https://github.com/TCATools/TCA-Hades-linux)

## TCA-QL_Beta(测试版)
一款静态代码分析的解析端，开源测试版仅支持PHP语言，开源测试版仅开放在linux上运行，无需申请License。

Expand Down