Installing CxSAST (cn_安装 CxSAST (v8.2.0 及以上))

安装 CxSAST 之前请确认您理解系统架构,您的服务器主机符合服务器主机要求,且您已正确地准备好安装环境

安装权限

执行安装的用户必须拥有运行 CxSAST 服务的计算机/服务器的管理员网络权限(用户名和密码)。

SQL Server 数据库

如果数据库使用 Windows 域身份验证,则执行安装(集中式或 CxManager)的用户账户在安装过程中必须拥有数据库服务器的 SA 权限。如果没有 SA 权限,则安装前必须满足几个必要条件:

  • 使用以下名称建立两个 SQL 数据库:CxDB 和 CxActivity
  • 为 Windows 用户创建登录信息并将其与 CxDB 和 CxActivity 的 DB_Owner 权限关联。此用户应该是专用的 Service 用户并且必须使用此用户执行安装,有关额外信息,请见链接

如果数据库使用 SQL 服务器原生身份验证,请准备一个 SQL 服务器用户账户。此账户在安装过程中必须有 SA 权限。如果没有 SA 权限,则安装前必须满足几个必要条件:

  • 使用以下名称建立两个 SQL 数据库:CxDB 和 CxActivity
  • 为 SQL 用户创建登录信息并将其与对 CxDB 和 CxActivity 有 DB_Owner 权限的 DB_User 关联。在 CxSAST 安装中设置此用户。

升级时,所有之前定义的 SQL 连接参数将从现有配置载入。如果使用 Windows 身份验证,使用为 CxServices 设置的用户或任何其他对 CxDB 和 CxActivity 有 DB Owner 权限的 Windows 验证用户运行安装程序。

设置 CxSAST

许可证验证

如果您尚未拥有永久 CxSAST 许可证,请将您的硬件 ID(开始 > 所有程序 > Checkmarx > 硬件 ID)发送给 Checkmarx 销售代表或 Checkmarx 支持以获取生产许可证文件。

安装包

  1. 下载 CxSAST 安装包
  2. 在各个服务器组件主机上:
    1. 利用 Checkmarx 销售代表或 Checkmarx 支持提供的密码解压下载的压缩包。
    2. 运行 CxSetup.exe 并开始安装。

安装 CxSAST

要求和推荐

  • 安装程序需要服务器上安装.Net 4.5.1 Framework(如果缺失,则会由 CxSAST 安装程序安装)。
  • Checkmarx 需要的 Web 服务器是 IIS Server(如果缺失,则会由 CxSAST 安装程序安装,前提是可以访问 Windows 安装介质)。
  • CxSAST 安装程序自带 SQL 2012 Express,如果尚未安装其他版本的 SQL,则可设置将其安装到环境中。

安装

下载 CxSAST 安装包后,运行 CxSetup.exe显示 Checkmarx 欢迎窗口。

单击整体安装以继续,单击高级设置额外的设置选项,或单击 X 以退出。

如果您选择高级则还显示安装选项窗口。

指定 CxSAST 安装位置并选择是否在桌面上安装相关快捷方式。

升级和修改

升级时,将从现有配置中载入之前的安装位置和产品功能设置且无法更改。但您可使用修改功能来安装或移除产品功能。

从可用列表中为此次安装选择需要的产品功能。

产品功能选择

  • POC/评估 – 选择安装 Audit、Engine、Manager 和 WebPortal
  • 分布式架构 – 选择安装 Engine 或 Manager 和/或 WebPortal
  • 集中架构 – 选择安装 Engine、Manager 和 WebPortal(如果您计划在主机上创建和自定义查询,请选择 Audit
  • 仅 CxEngine 服务器 – 选择安装 Engine(见添加 CxEngine 服务器)。

单击下一步继续。显示 SQL 服务器配置窗口。

升级和 SQL 服务器

升级时从现有配置中载入 SQL 服务器参数且无法更改。但您可使用修改功能进行更改。

通过选择以下选项之一来设置到已安装 SQL 服务器或网络上任意其他 SQL 服务器的连接:

  • 使用集成 Windows 身份验证进行连接(不要求登录)
  • 使用 SQL 服务器身份验证进行连接(提供 SQL 用户名和密码以使用 SA 权限登录)。

单击测试连接。确认到 SQL 服务器的连接之后会显示一条“连接成功”的消息。

SQL 服务器连接失败

  • 如果连接 SQL 服务器失败,则会显示一条“连接失败”消息以及所需的操作。
  • 必须确认到 SQL 服务器的连接才能继续安装。

单击下一步继续。

如果系统中找到之前安装的 SQL Express 文件,则会显示一个额外的 SQL 服务器配置窗口。

现有 SQL Express 文件

通过选择以下选项之一来设置 SQL Express 安装类型:

  • 使用现有文件安装 SQL Server Express
  • 干净安装 SQL Server Express

完成后,显示许可证激活窗口。

升级和现有许可证

升级时会自动从现有配置中载入许可证信息(如果存在且有效)且不会显示“许可证激活”窗口。

通过选择以下选项之一来选择首选许可方式:

  • 导入新许可证:如果您已经有一个有效的许可证文件,请选择并单击导入许可证。浏览文件位置。
  • 请求新许可证:如果您尚未获取永久 CxSAST 许可证,请选择。单击复制到剪贴板并将硬件 ID 发送给 Checkmarx 销售代表或联系 Checkmarx 支持

单击下一步继续。

HID 不匹配

如果您的许可证与您当前的硬件 ID (HID) 不一致,则会显示一条警告消息。
请导入其他许可证或向您的 Checkmarx 销售代理请求新许可证或联系 Checkmarx 支持

如果默认端口 80 被占用,则会显示验证端口窗口。

默认端口 80 验证

端口 80 是 Checkmarx 应用程序的默认端口。在干净安装的情况下,仅发生以下情况之一时会显示“验证端口”窗口:

  • 端口 80 被非默认网站或应用程序占用
  • 默认网站不存在且端口 80 被另一个应用程序或网站占用
  • 默认网站存在(占用不同的端口)且端口 80 被另一个应用程序或网站占用。

如果需要,请单击另一个端口并单击验证端口

单击下一步继续。显示设置摘要窗口。

根据您的选择检查设置摘要。

单击安装以继续,单击返回以返回之前的窗口,或单击 X 退出。显示正在安装窗口。

安装完成后显示安装成功完成窗口。

设置失败

如果安装失败,会显示“安装失败”消息。更多信息请见安装日志。如果您需要更多帮助,请联系 Checkmarx 支持

单击关闭完成安装。

检查已安装服务

转到开始 > 控制面板 > 系统和安全 > 管理工具 > 服务

确认已启动以下已安装服务:

在集中式主机上:

  • CxJobsManager
  • CxScansManager
  • CxSystemManager
  • CxScanEngine
  • Web Server – IIS Admin Service & World Wide Web Publishing Service

CxEngine 主机上:

  • CxScanEngine

已安装应用程序池检查

转到开始 > 控制面板 > 所有控制面板项目 > 管理工具 > 网络信息服务 (IIS) 管理器

确认已启动以下已安装应用程序池:

在集中式主机上:

  • CxClientPool
  • CxPool
  • CxPoolRestAPI

登录 Web 界面

使用以下任意方式访问 CxSAST Web 界面

  • 使用桌面上的 Checkmarx Portal 快捷方式或导航至 Checkmarx 文件夹(开始 > 所有程序 > Checkmarx > Checkmarx Portal)本地访问 CxSAST(从服务器主机)。
  • 要从任意其他计算机访问 CxSAST,确认组织的路由和防火墙配置允许客户端计算机访问 CxSAST 服务器。将您的浏览器转向:http://<server>/cxwebclient/login.aspx 其中 <server> 是 CxSAST 服务器的 IP 地址或可解析主机名。

全新安装时需要创建一个管理员账户。

显示“设置管理员凭据”窗口后,添加以下凭据:

  • 管理员用户名
  • 密码
  • 确认口令

密码复杂度

要求的密码复杂度如下:9 到 400 个字符,至少 1 个大写字母,至少 1 个小写字母,至少 1 个特殊字符,至少 1 个数字。

单击确认完成。

之后您可更改管理员密码和添加 CxSAST 用户

在分布式架构中:

转到管理 > 应用程序设置 > 安装信息,然后单击添加引擎服务器

设置 CxEngine 的服务器名称,设置服务器 URL,使 CxManager 能够与 CxEngine 通信,然后可选择设置扫描 LOC 限制(允许的最大代码行数)。

URL 应为:
http://<Server_Name>/CxSourceAnalyzerEngineWCF/CxEngineWebServices.svc
其中 < Server_Name> 是 CxEngine 主机的 IP 地址或可解析名称。

URL 检查

建议在 CxManager 服务器上的浏览器中打开设置的 URL 进行验证。

单击创建

多个 CxEngine 服务器:

如果您有多个 CxEngine 服务器,请为各服务器重复上面的步骤。

转到管理 > 应用程序设置 > 常规

单击编辑。

如果您的 CxSAST 许可证允许,您可将所有 CxEngine 服务器的“并发扫描上限”更改为所需数值。

提供 SMTP 设置并单击更新。其他设置通常应保留原样。

安装验证

转到管理 > 应用程序设置 > 安装信息

验证是否您已成功安装正确的版本和/或热门补丁并检查所有 CxSAST 系统组件,确认它们都是相同的版本。