Checkmarx CxEnterprise 服务器安装手册

Checkmarx CxSuite 安装手册

2015年1月

设置CxSuite

目录

设置CxSuite .................................................................................................................3 1 2 3 4 5 6 7 8

Confidential

系统架构 ................................................................................................................4 服务器主机要求 ....................................................................................................6 准备环境 ................................................................................................................7

3.1 配置IIS6 .................................................................................................................. 8 3.2 在Windows服务器2008上配置IIS 7 ................................................................ 8 3.3 在Windows 7上配置IIS 7 ................................................................................... 9 3.4 在Windows服务器2012上配置IIS 8 .............................................................. 11 3.5 在Windows服务器2012 R2上配置IIS 8.5 ...................................................... 14 安装CxSuite .......................................................................................................15 升级CxSuite .......................................................................................................22 添加CxEngine服务器 ......................................................................................23 删除CxSuite .......................................................................................................24 更新Checkmarx License ................................................................................25

CheckMarx CxSuite User Manual Page 2

设置CxSuite

设置CxSuite

此设置指南包含为POC设置CxSuite与生产（production）环境中设置CxSuite的相关信息。

本节内容：

? 系统架构

? 服务器主机要求 ? 准备环境 ? 安装CxSuite ? 升级CxSuite

? 添加CxEngine服务器 ? 删除CxSuite

? 更新Checkmarx License

Confidential

CheckMarx CxSuite User Manual Page 3

设置CxSuite

1 系统架构

CxSuite包括以下组件：

?

服务器组件：

o CxEngine:执行代码扫描

o 数据库：存储扫描结果与系统设置。可以是一个现有的MS SQL SERVER（适用于产

品），或为CxSuite安装VistaDB（适用于POC）

o CxManager：管理系统与执行所有系统功能。集成系统组件。使用IIS web服务器

（适用于产品），或为CxSuite安装UltiDev（适用于POC）

客户端：用户界面，包括：

o CxSuite Web界面 o IDE插件 o CxAudit

o CxConsole: CxSuite CLI o CxSuite API

?

CxSuite支持集中式架构，即所有服务器组件安装在同一主机上，或分布式架构，即任何或所有服务器组件安装在各自专用主机上。

Confidential CheckMarx CxSuite User Manual Page 4

设置CxSuite

因为一个CxEngine服务器同时只能执行一个扫描，为了实现并发扫描您可以拥有多个CxEngine服务器。高扫描负载在CxEngine服务器间得到平衡；每个CxEngine服务器每小时可以处理大约100K行代码。

客户端与CxManager间的通信，以及CxManager与CxEngine间的通信都是通过HTTP。HTTPS也可以被配置。

Confidential

CheckMarx CxSuite User Manual Page 5

设置CxSuite

2 服务器主机要求

服务器主机要求依赖于安装是集中式的还是分布式的，还依赖于需要扫描的代码行数。除了下面表格中的要求，通常CPU时钟速度与磁盘速度也会影响扫描时间。

想要准确的测试版本，请查看CxSuite发布说明。 目的代码行数可用内存核心CPU速度磁盘操作系统Web 服务器其它软件150K1.5 GB集中式（POC）300K3 GB22 GhzWindows XP, 7 Windows 5 Server GB2003, 2008, 2012 （CxSuite可 安装Ultidev）200K6 GB集中式（产品）600K10 GB最低：2 GHz 建议：2.5 GHz 对于频繁扫描 最少：3 最低：2.3 GHz 250 建议：6建议：2.8 GHz GB? IIS 6/7/81.2M16 GB2M4MCxEngine (产品) 对于多个CxEngine服务器 （为实现并发扫描） 每个服务器应该满足此要求 24 GB44 GB最低：2.3 GHz 建议：2.8 GHz200K2 GB ? 最低：2 GHz 建议：2.5 GHz 对于频繁扫描 最低：2.3 GHz 最少：2 建议：2.8 GHz 50 GB建议：4600K6 GB1.2M12 GBWindows Server 2003, 2008, NA2012Windows Installer 3.1 or above (Run msiexec to check) .NET framework 3.5 SP1 or above 2M20 GB4.5M45 GB最低：2.3 GHz 建议：2.8 GHz 最低：2 GHz 建议：2.5 GHzCxManager (产品)数据库（产品） Minimum: 2 GB Recom2mended: 4 GB 250 GBIIS 6/7/8 50 GBNASQL Server (Express not recommended) 2005/2008/2012 对于CxSuite web界面，建议使用的显示分辨率至少为1280 x 1024。

Confidential CheckMarx CxSuite User Manual Page 6

设置CxSuite

3 准备环境

1. 对于.NET框架(net framework 3.5 sp1)，安装最新的补丁。查看详情请访问：

support.microsoft.com/kb/959209

2. 确保集中式或CxManager主机名不包含任何非字母数字字符，例如“_”。

3. 对于所有服务器与数据库组件，请确保服务器主机Windows 区域选项（ Regional

Options） >格式（ Formats）被设置为English (Unitied States)：

您了解了系统架构后，在安装CxSuite前，请确保服务器主机符合服务器要求，并准备以下内容：

4. 确保组织的防火墙允许：

o HTTP（TCP端口80空闲）

? 从客户端主机至集中式或CxManager主机

? CxManager与CxEngine间（在分布式架构中）

o 从CxManager至SQL Server（在分布式架构中，如果使用SQL SERVER）的SQL

Server端口空闲（默认，TCP端口1443）

5. 如果使用非专用主机（例如在POC中），请确保TCP端口80没有被其它应用程序占用，例如

Skype或其它web服务器。

6. 如果使用SQLServer，请确保以下服务正在运行：

o SQL Server o SQL Brower

7. 在服务器组件主机上，防止杀毒程序扫描checkmarx文件夹，通常为：

o C:\\CxSrc

o Checkmarx安装目录：C:\\Program Files(x86)\\Checkmarx\\ （64位系统上）

或 C:\\Program Files\\Checkmarx\\ （32位系统上）

8. 配置IIS（除了分布式部署中的数据库组件服务器不用配置）：

Confidential CheckMarx CxSuite User Manual Page 7

设置CxSuite

3.1 配置IIS6

1. 确保安装了ASP.NET

2. 以管理员身份打开一个命令提示符，并访问

C:\\WINDOWS\\Microsoft.NET\\Framework\\v2.0.50727 3. 运行

aspnet_regiis.exe –i

4. 打开IIS管理器（参见此处），访问Web服务扩展（Web Service Extensions），并确

保 ASP.NET v2状态为允许（Allowed）：

3.2 在Windows服务器2008上配置IIS 7

1. 通过右键单击计算机（Computer）并选择管理（Manage）来打开服务器管理器

2. 在左侧导航窗格选择角色（Roles），并单击添加角色服务（Add Role Services）：

Confidential CheckMarx CxSuite User Manual Page 8

设置CxSuite

3. 向下滚屏并选择以下内容：

o 静态内容

o 在管理工具（Management Tools）项下：

? IIS管理控制台

? IIS 6 管理兼容性与其所有子项目

o 应用程序开发特性> ASP.NET 3.5

4. 单击下一步（Next），并安装（Install）。 5. 关闭（Close）窗口。

6. 以管理员身份打开一个命令提示符，并访

问 C:\\Windows\\Microsoft.NET\\Framework\\v3.0\\Windows Communication Foundation 7. 运行

ServiceModelReg.exe –i

3.3 在Windows 7上配置IIS 7

1. 打开控制面板

2. 在程序（Programs）中，单击卸载程序（Uninstall a program）

Confidential CheckMarx CxSuite User Manual Page 9

设置CxSuite

3. 单击打开或关闭Windows特性（Turn Windows features on or off）：

4.

5. 6. 7.

在互联网信息服务（Internet Information Services）中，选择以下内容：

o 在Web管理工具中（Web Management Tools）：

? IIS 6管理兼容性与其所有子项目 ? IIS管理控制台

o 万维网Web服务（World Wide Web Services）>常用HTTP特性（Common HTTP

Features）>静态内容（Static Content）

o 应用程序开发特性（Application Development Features）>ASP.NET 3.5 单击OK

以管理员身份打开一个命令提示符，并访问

C:\\Windows\\Microsoft.NET\\Framework\\v3.0\\Windows Communication Foundation 运行

ServiceModelReg.exe –i

Confidential CheckMarx CxSuite User Manual Page 10

设置CxSuite

3.4 在Windows服务器2012上配置IIS 8

1. 打开服务器管理器并单击添加角色与特性（Add roles and features）：

2. 选择安装类型（ Installation Type），然后选择基于角色或基于特性安装（Role-based or

feature-based Installation）：

单击下一步（Next）。

Confidential CheckMarx CxSuite User Manual Page 11

设置CxSuite

3. 选择服务器：

单击下一步（Next）。

4. 在应用程序服务器（已安装）（Application Server (Installed)）中选择Web服务器（IIS）支

持（ Web Server (IIS) Support）：

Confidential CheckMarx CxSuite User Manual Page 12

设置CxSuite

5. 继续浏览向导直至 Web 服务器角色（IIS）（Web Server Role (IIS) ）> 角色服务（Role

Services）页面：

6. 在应用程序开发（Application Development）中，选择ASP.NET 3.5：

Confidential CheckMarx CxSuite User Manual Page 13

设置CxSuite

7. 在管理工具（Management Tools）中，选择：

o IIS 管理控制台

o IIS 6 管理兼容性与其所有子项目

8. 选择静态内容（Static Content） 9. 结束向导，确认并安装（ Install）。

10. 以管理员身份打开一个命令提示符，并访问：

C:\\Windows\\Microsoft.NET\\Framework\\v3.0\\Windows Communication Foundation 11. 运行

ServiceModelReg.exe –i

3.5 在Windows服务器2012 R2上配置IIS 8.5

针对IIS 8.5，Checkmarx会提供一个配置文件，其可用于自动执行所有必要配置。或者，您可以手动安装IIS，在此您需要确保IIS包含基本认证，IIS管理控制台，ASP.NET 3.5与其相关内容、IIS 6 管理兼容性

为了使用Checkmarx配置文件配置IIS8.5：

1. 下载CxIISConfig.xml

2. 以管理员身份运行Windows PowerShell

3. 在PowerShell中，运行：

Install-WindowsFeature –ConfigurationFilePath \\CxIISConfig.xml 在此是您存放配置文件的目录路径

Confidential CheckMarx CxSuite User Manual Page 14

设置CxSuite

4 安装CxSuite

在安装CxSuite前，请确保您理解系统架构，您的服务器主机符合服务器主机要求，并且您已经正确准备了环境。

执行安装的用户必须拥有服务器的管理员权限。

如果使用一个SQL SERVER数据库：

?

如果数据库使用Windows域内认证，执行安装的用户账户（集中式的或CxManager）必须在安装的整个进程中对数据库拥有系统管理员权限，即使是在执行升级并且数据库已经存在的情况下也不例外。为了持续的CxSuite使用，NETWORK SERVICES必须拥有DB_OWNER权限。

如果数据库使用SQL SERVER本机认证，需要准备一个SQL SERVER用户账户。该账户必须在整个安装过程中拥有系统管理员权限，即使是在执行升级并且数据库已经存在的情况下也不例外。为了持续的CxSuite使用，该账户还必须拥有DB_OWNER权限。

?

为了设置CxSuite：

1. 如果您还没有license，为了CxSuite在安装后立即开始工作，请在安装前准备一个license：

o 对于POC，您可以从www.cxsupport.net/olg/licenserequest.aspx.中生成一个两天的评

估license来扫描至多50,000行代码。

o 永久CxSuite license会指定主机硬件ID，所以为了获取一个，请下载、解压并运行

CxSuite HID生成器，并将HID发送给您的Checkmarx销售代表

2. 下载CxSuite安装包。

3. 在每个服务器组件主机上：

a. 解压下载的ZIP归档文件，提交您的Checkmarx销售代表提供的密码

运行Setup.exe，并查阅向导：

Confidential CheckMarx CxSuite User Manual Page 15

设置CxSuite

b. 选择一个安装类型：

如果已经安装了CxSuite组件，会自动选择升级。POC 或 产品（PRODUCTION）定义了默认设置，这些设置可在接下来的页面进行修改。 c.

选择服务器组件：

Confidential CheckMarx CxSuite User Manual Page 16

设置CxSuite

?

?

?

组件选择：对于分布式架构，请选择CxManager与 Weg Portal，或

CxEngine。对于集中式架构，请选择前三个选项（如果您计划在此主机上自定义查询，那么也要勾选上CxAudit）.

数据库选择：（除了CxEngine-only安装）：对于POC，您可以选择安

装 Vista DB。对于MSSQL，在接下来的页面您将配置一个连接至现有的SQL SERVER上。

Web服务器选择：仅针对集中式或CxManager。对于POC，您可以选择安装UltiDev Web服务器；对于产品(production)，请使用准备好的微软IIS.

d. 如果您选择了MSSSQL，请配置一个连接至现有的SQL SERVER上：

? ? ?

在服务器名称（Server Name）处，提供至SQL SERVER数据库的URL。 选择使用Windows域内认证或SQL SERVER认证，并提供凭证 测试连接。在连接成功前您无法继续向导。

e. 先决条件验证页面测试此系统；如果不满足任何先决条件，就会出现一个建议。当测试成

功完成时，点击下一步（Next），然后点击安装（Install）。 前进直至完成安装。

Confidential CheckMarx CxSuite User Manual Page 17

设置CxSuite

f. 选择一个license选项：

? ? ?

使用当前安装的license:针对升级

导入新的license：如果您已经有一个license文件

请求新的license：如果您还没有获得一个永久license，复制您的硬件ID，您将会在从Checkmarx处获取license时用到。或者，您可以稍后通过使用Windows/开始菜单Checkmarx文件夹中的快捷键获取您的硬件ID。

g. 点击下一步（Next）并结束向导。如果获得许可，服务将会自动开始。

4. 如果您还没有获得一个永久license，请向您的Checkmarx销售代表发送您的硬件ID来获得一

个license文件；或者，对于POC，您可以从www.cxsupport.net/olg/licenserequest.aspx.中生成一个两天的评估license来扫描至多50,000行代码。

o 将license文件复制到C:\\Program Files (x86)\\Checkmarx\\Licenses（64位系统中）

或C:\\Program Files (x86)\\Checkmarx\\Licenses（32位系统中） o 正确使用开始/Windows菜单中位于All Programs >

Checkmarx > CxLicenseImporter.exe中的已安装license

5. 从www.checkmarx.com/instructions中下载、解压并运行最新的热补丁。 6. 确保开启以下服务（需要拥有一个有效的license）

o 在集中式或CxManager主机上：

? CxJobsManager ? CxScansManager ? CxSystemManager

Confidential CheckMarx CxSuite User Manual Page 18

设置CxSuite

Web服务器

? 如果使用IIS：万维网发布服务

? 如果使用UltiDev： UltiDev Web服务器内部公用程式

o 在CxEngine主机上：CxScanEngine

7. 访问CxSuite web界面（您可以使用集中式或CxManager主机上的链接，向导最后一页的链

接，或开始菜单Checkmarx文件夹中的快捷键），并用以下身份登录： 用户名：admin@cx 密码：admin

8. 在分布式架构中：

a. 在web界面中，访问管理（Management）>服务器设置（Server Settings）>安装信息

（Installation Information），并单击添加引擎服务器（Add Engine Server）：

?

Confidential CheckMarx CxSuite User Manual Page 19

设置CxSuite

b. 给CxEngine服务器命名，并提供其URL，这样CxManager将能够与CxEngine通信。

URL应该为：

http:///CxSourceAnalyzerEngineWCF/CxEngineWebServices.svc 在此为CxEngine主机的IP地址或可解析名称。

c. 单击创建（Create）

d. 如果您拥有多个CxEngine服务器（为实现并发扫描），请为每个服务器重复此步骤。

Confidential CheckMarx CxSuite User Manual Page 20

设置CxSuite

9. 在web界面，访问管理（ Management）>服务器设置（Server Settings）>常规设置

（General Settings），并单击页面底部的编辑（Edit）：

提供SMTP设置，并单击更新（Update）。其它设置通常保持默认状态。 10. 非强制性地，您可以配置邮件的From字段。如果您不进行配置，其将会为空。

Confidential CheckMarx CxSuite User Manual Page 21

设置CxSuite

5 升级CxSuite

此页面仅适用于全面升级（而不适用于热修复补丁）

在分布式部署中，您必须升级所有组件。在CxManager与其相应的每个CxEngine上执行以下操作： 为了更新CxSuite:

1. 在IIS管理器中，检索至应用程序库（Application Pools），检查以下两项的用户标识是否并

非默认的网络服务，在此确保您了解用户账户的完整凭证

o CxClientPool o CxPool

2. 在服务管理器中（services.msc），以用户账户登录以下每项进行检查。如果其中任何一项并

非默认网络服务，请确保您了解用户账户的完整凭证

o CxJobsManager o CxScanEngine o CxScansManager o CxSystemManager

3. 访问队列并确保当前没有扫描正在运行 4. 终止以下服务：

o CxScansManager o Web服务器：

? 如果使用IIS:万维网发布服务

? 如果使用UltiDev： UltiDev Web服务器内部公用程式

5. 备份以下文件：

o \\CheckmarxWebPortal\\Web\\Web.Config o \\Configuration\\DBConnectionData.config

6. 预防起见，使用标准SQL SERVER工具备份两个Cx 数据库。请确保文件命名唯一并包

含.bak。

7. 安装CxSuite。

8. 如果在1-2步骤中您发现任何非默认用户账户，按如下步骤对其进行重新配置：

o 对于应用程序库账户，在IIS管理器中，检索至应用程序库（Application Pools），

对于每个CxPool与CxClientPool：

a. 选择库

b. 访问操作（Actions） >高级设置（ Advanced Settings） > 进程模型（Process

Model） > 标识（Identity） c. 将标识值改修改正确

o 对于服务账户，在服务管理器中，对步骤2中列出的每种服务：

a. 右键单击服务并选择属性（Properties） b. 在登录选项卡中，配置正确账户 c. 单击OK。

9. 请确保后面文件中的数据库设置与原始的相匹配，即备份的DBConnectionData.config文件

（在第5步中备份的）。

Confidential CheckMarx CxSuite User Manual Page 22

设置CxSuite

6 添加CxEngine服务器

1. 准备新的CxEngine主机

2. 执行服务器安装。在组件选项中，仅选择CxEngine

3. 登录CxSuite web界面，访问管理（Management）> 服务器设置（Server Settings ）>安装

信息（ Installation Information），并单击添加引擎服务器（Add Engine Server）

4. 给该CxEngine服务器命名，并提供其URL，这样CxManager将能够与CxEngine通信。其

URL应该为：

http:///CxSourceAnalyzerEngineWCF/CxEngineWebServices.svc 在此为CxEngine主机的IP地址或可解析名称 5. 点击创建

如果发现您的扫描加载需要一个额外的CxEngine服务器，您可以按以下步骤进行添加：

Confidential CheckMarx CxSuite User Manual Page 23

设置CxSuite

7 删除CxSuite

1. 将license文件复制到一个安全位置 2. 终止以下服务：

o 在集中式或CxManager主机上：

? CxJobsManager ? CxScansManager ? CxSystemManager

o 在集中式或CxEngine主机上：CxScanEngine o Web服务器：

? 如果使用IIS：万维网发布服务

? 如果使用UltiDev： UltiDev Web服务器内部公用程式

3. 在Windows程序管理器中，删除所有Checkmarx程序包。

4. 打开Windows注册表编辑器（运行regedit），并删除以下密钥：

o Hkey_Local_Macine > Software > Checkmarx

o Hkey_Local_Macine > Software > Wow6432Node > Checkmarx

5. 如果数据库为SQL SERVER，从中删除以下数据库：

o CxDB

o CxActivity

6. 删除Checkmarx安装文件夹（通常为C:\\Program Files (x86)\\Checkmarx\\），并从驱动器的

根部删除以下文件夹：

o CxCache o CxReports o CxSrc o ExtSrc

为了将CxSuite从主机上删除：

Confidential CheckMarx CxSuite User Manual Page 24

设置CxSuite

8 更新Checkmarx License

1. 为了获取一个新的或更新后的license文件，在Windows/开始菜单中访问All

Programs > Checkmarx > HID.exe，复制已生成的硬件ID，并将其发送给您的Checkmarx销售代表来获取一个更新过的license。

2. 使用安装的License导入器公用程式导入license文件：

a. 关闭所有Checkmarx应用程序窗口

b. 访问开始/Windows菜单> All Programs > Checkmarx > CxLicenseImporter.exe，

导入license文件

3. 如果上一步导入失败，请手动导入license:

a. 必要情况下将文件重命名为license.cxl

b. 将license文件复制到\\Licenses （在64位系统上

默认安装目录为C:\\Program Files (x86)\\Checkmarx\\ ）

4. 终止并重启以下服务：

o CxJobsManager o CxScansManager o CxSystemManager o CxScanEngine o Web服务器：

? 如果使用IIS:万维网发布服务

? 如果使用UltiDev： UltiDev Web服务器内部公用程式

为CxSuite更新您的Checkmarx license：

Confidential CheckMarx CxSuite User Manual Page 25

本文来源：https://www.bwwdw.com/article/py5w.html