增强分析模块部署

TCA 除开集成业界知名的分析工具之外，也有自主研发的独立工具，作为 TCA 的增强分析模块。

TCA 增强分析模块，需要用户额外部署 License 鉴权微服务，并邮件申请 License 。

提示

1. License申请完全免费！ 2. 优先企业或高校申请License。

概念

独立工具：TCA 自主研发的代码分析工具；
CLS(Common License Server)： TCA 独立工具的 License 鉴权微服务。

模块功能

支持Objective-C/C++代码规范检查；
支持分析项目的依赖组件；
支持分析依赖组件是否存在漏洞等问题；
支持Java/Kotlin API和函数调用链分析；
支持代码安全、空指针检查、内存泄漏等规则。

持续更新中……

TCA 官网版增强能力申请

如果用户平常使用的是 TCA 官网版公共服务在新窗口打开，并想在官网版上体验到增强分析模块的分析能力，可以按照这篇帮助文档在新窗口打开进行申请配置。

TCA 私有化部署增强能力申请

如果用户是在企业内网环境内使用 TCA，并想在内网体验 TCA 的增强分析模块能力，可以参考下面步骤申请。

准备

一台 CLS 微服务专属机器，CLS 微服务需要跟该机器绑定

注意

注意：不能随意删除CLS目录

步骤

在 TCA 源码中server/cls在新窗口打开目录下执行以下命令，获取 Server ID 和 Client License

注意

注意：需要在 CLS 目录下执行命令

# 如果在该目录下没有找到 cls 二进制文件，可以执行以下命令进行同步
$ bash ./scripts/base/install_bin.sh
$ cd server/cls
$ ./cls server
2022-04-13 18:35:29.356510559 +0800 CST [INFO] Version: 20220328.1
2022-04-13 18:35:29.44083463 +0800 CST [INFO] The client license is:
xxx
2022-04-13 18:35:29.454552966 +0800 CST [INFO] License Server ID: xxx

Server ID: 机器码，用于向 TCA 团队申请 License 授权
Client License: 提供给 TCA Client，方便 TCA Client 进行工具鉴权（重要，建议备份留底）

在 TCA Client目录的 config.ini在新窗口打开中配置 CLS 微服务信息，比如

[LICENSE_CONFIG]
; [可选]使用独立工具时，需要填写，默认不需要
; License服务的域名和端口
URL=http://<IP或者域名>:<port>
BASE_PATH=
LICENSE=<Client License>

注意

注意：URL对应值的最后不需要跟斜杆/.

注意

不同的部署方式可以根据下面方法修改config.ini配置

源码部署：
- 修改源码目录下的client/config.ini
- 重启客户端：./quick_install.sh local start client
Docker部署：
- 方式1: 修改源码目录下的.docker_temp/configs/client/config.ini，并重启tca-services容器
- 方式2: 进入tca-service容器后，修改/CodeAnalysis/client/config.ini，并退出重启tca-services容器
- 重启容器方式：docker restart tca-service
Docker-Compose部署:
- 修改源码目录下的client/config.ini，并重启client容器
- 重启容器方式：docker-compose restart client

向 TCA 团队邮件申请 License

收件邮箱：

v_cocohwang@tencent.com
v_xiohuang@tencent.com
yalechen@tencent.com
tommyzhang@tencent.com

申请邮件格式如下：

主题：TCA 独立工具 License 申请

正文：


申请人名称	xxx
申请人所在组织名称	xxx
申请人所在组织类型	可选选项：公司/学校/个人
申请人邮箱	xxx
申请人手机号码	xxx
是否私有化部署	是
首次登记的机器码	xxx
体验申请用途	xxx
Client License	xxx

首次登记的机器码: 步骤一中输出的Server ID
Client License: 步骤一中输出的Client License

收到 TCA 团队回复邮件之后，在 CLS 目录下的 config.yaml在新窗口打开文件中填写License

注意

注意：遵从 yaml 格式，比如：

键值对中，冒号 : 后面跟一个空白字符，示例 key: value。

执行以下命令启动 CLS

./cls server -d

验证 CLS 进程正常启动

# 查找是否存在CLS进程
ps aux|grep cls

注意

注意：如果以上命令没有发现 CLS 的进程，则说明 CLS 没有正常启动。
请尝试更改 config.yaml在新窗口打开文件中的 port 为其他 port，比如8080，目前默认是80端口，然后重新执行步骤5的命令。

启动 TCA 分析任务在 TCA 平台的分析方案里面勾选独立工具相关的规则包，比如依赖组件分析规则包，然后启动一次分析任务，执行正常则表明设置生效。

CLS 运维

自动重启

# 查找CLS进程ID
ps aux|grep cls
# 重启微服务
kill -USR2 <pid>

网络异常

如果以上部署步骤已经完成，但是增强功能还是出现 License check failed! Please check the license. License Server is not available! 异常。可以按照以下步骤进行排查：

进入任务页面，点击异常工具，下载该工具的执行日志。如果日志中出现以下日志，则表明网络访问CLS异常；

method(head) call fails on error: <urlopen error [Errno 111] Connection refused>

继续验证。如果是 Docker 或者 Docker-Compose 部署方式的话，进入 TCA Client 所在容器中。如果是源码部署，则来到 TCA Client 所在机器上。执行以下命令确认网络是否通路：

ping <config.ini中填写的 CLS IP或者域名>
telnet <config.ini中填写的 CLS IP或者域名> <对应端口>

如果网络不通，请排查：
- 防火墙是否开启对应端口；
- CLS 对应域名是否在host中设置；
- 是否IP设置错误。

案例分享

背景：小明以 Docker 方式部署 TCA，并在相同宿主机上部署 CLS 服务，然后在 config.ini 中设置的 URL 中的 IP 为 127.0.0.1, 重启后启动增强功能任务遇到上述网络不通异常。
原因：原因是此时的 127.0.0.1 指向的是 TCA Client 容器自身，而不是部署在宿主机上的 CLS 服务。
解决方案：将 127.0.0.1 改成宿主机自身IP即可。

CLS 更新

使用以下命令查找 cls 进程并杀掉进程

# 查找CLS进程ID
ps aux|grep cls
# 重启微服务
kill -9 <pid>

下载最新版的 cls 并覆盖掉其中的 cls 二进制文件

注意

注意：不能删除原来的 cls 目录，只需要替换其中的 cls 二进制文件即可。

使用以下命令重启 cls 服务

./cls server -d

# 增强分析模块部署

# 概念

# 模块功能

# TCA 官网版增强能力申请

# TCA 私有化部署增强能力申请

# 准备

# 步骤

# CLS 运维

# 自动重启

# 网络异常

# 案例分享

# CLS 更新