CxEnterprise Installation Guide 712

Download as pdf or txt
Download as pdf or txt
You are on page 1of 28

CxSuite

Enterprise Edition
Installation Guide
Version 7.1.2

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES | WWW.CHECKMARX.COM


TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

Introduction ...................................................................................................................... 3
Installation Process .......................................................................................................... 5
Upgrade Process............................................................................................................... 5
CxEnterprise Prerequisites ............................................................................................. 6
CxEnterprise Installation ................................................................................................ 8
Appendix A .................................................................................................................... 21
IIS 7.0 requirements in Windows 2008 Server ........................................................... 21
Appendix B ..................................................................................................................... 23
IIS 7.0 requirements in Windows 7 .............................................................................. 23
Appendix C ..................................................................................................................... 26
IIS 8.0 requirements in Windows 2012 Server ........................................................... 26

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

I NTRODUCTION
Thank you for using Checkmarx to perform security source code analysis testing. This document describes
how to install CxSuite Enterprise Edition as a distributed system in production. Any issues, questions or
comments may be addressed to [email protected].
CxSuite Enterprise Edition is comprised of 8 main components:
CxEngine

Performs the scans. Interfaces CxManager.

CxJobsManager

Handles a synchronic tasks: unzipping, source retrieval, emails, reports etc..

CxScansManager

Pulls scan requests from queue and invokes scan on engine upon load
balancer business rules

CxSystemManager

System monitoring, scheduled tasks invocation etc..

WebServices

Retrieves data from DB and updates DB upon clients requests, deploys


sources to file system

Database

Stores scan results and system settings. Interfaces CxManager.

CxWebPortal

A web interface of CxManager that replaces CxClient.

CxAudit

A windows client for creating and editing Checkmarx queries.

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

The diagram above demonstrates the distributed deployment of the system. If required, all the
components can be deployed (one or more) on the same machine.
CxSuite Enterprise Edition can work with MS SQL database. If the organization already has an MS SQL
Server in place, CxManager can integrate with it. The installation also includes a VistaDB embedded
installation if no MSSQL server is available.

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

I NSTALLATION P ROCESS
CxSuite Enterprise Edition installation process is as follow:
1.
2.

Comply with CxEnterprise prerequisites.


Install all components.

U PGRADE P ROCESS
CxSuite Enterprise Edition installation process is as follow:
1.
2.
3.
4.
5.

Stop CxScanManager and CxScanEngine services.


Stop web server.
Install relevant components.
Start CxJobsManager, CxScansManager, CxSystemManager and CxScanEngine services.
Start web server.

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

C X E NTERPRISE P REREQUISITES
Prerequisites

Comments

Done

Server name

The server name for the Portal machine must use only
alphanumeric characters. Using non-alphanumeric characters
(such as _) in sot compatible with Microsoft Internet Explorer
Security Patch MS01-055.

To read more: http://support.microsoft.com/kb/316112


Ports

By default port 80 is used by the web servers (IIS or UltiDev) for


internal and external communication. Verify that it is not
occupied by other programs.

In order to connect from a remote machine to the server please


verify that TCP communication is enabled for port 80.
Invoke Installation as
administrator.

Installation must be invoked by a user who is an administrator of


the machine.

Windows Installer 3.1 or


later

Windows Installer must be installed.

IIS web server

With IIS 6 make sure ASP.NET component is installed as well.

With IIS 7 \ 8 make sure ASP.NET and IIS 6 Management


Compatibility roles are added.
See Appendix A : how to install IIS on Window 2008
See Appendix B : how to install IIS on Window 7
See Appendix C : how to install IIS on Window 2012
.Net 3.5 SP1 framework

should be installed after IIS

Please install latest fix. For details please refer to


http://support.microsoft.com/kb/959209.
Post .Net installation IIS
adjustments

With IIS 6 Open a command prompt as administrator, go to the


folder C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727
and run aspnet_regiis.exe -i and afterwards make sure that
ASP.NET 2 status is allowed in the Web Services Extension

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

column of the IIS manager screen .


With IIS 7 \ 8 Open a command prompt as administrator, go to
the folder
C:\Windows\Microsoft.NET\Framework\v3.0\Windows
Communication Foundation and run servicemodelreg.exe -i.
Database

MS SQL database is recommended. It can also be replaced by


embedded installation of VistaDB.
In case of a local installation of MS SQL Express, please make sure
it is in place before starting the installation of CxSuite enterprise
Edition.
Please make sure both SQL Server and SQL Browser services are
running on the MS SQL Server to be connected by CxSuite
Enterprise Edition.

MS SQL uses port 1433 by default.


Antivirus

Stop the antivirus from scanning the Checkmarx folders:

X:\CxSrc
X:\Program Files (x86)\Checkmarx\ Or X:\Program Files\Checkmarx\

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

C X E NTERPRISE I NSTALLATION
1.

Invoke the installation using EntInstallation.exe.

2.

Click next in the informative window.

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

3.

Select the requested installation type and click next.


POC: Proof of Concept installation type By default will select to install substitutes for IIS and
SQL server.
PRODUCTION: Production installation type. By default will select to use IIS and SQL server.
UPGRADE: Upgrade an existing project. Will be selected if relevant.

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

4.

Specify the components you wish to install, the installation folder, select the database type and
the Web Server you wish to use. Then click Next to continue.
Default for Windows 32-bit - C:\Program Files\Checkmarx
Default for Windows 64-bit - C:\Program Files (x86)\Checkmarx
Two type of Database are supported: VistaDB or Microsoft SQL Server.
If you have selected Microsoft SQL Server then you will be requested to enter the MS SQL
Specific database connection parameters. Enter the server name, select authentication type and
provide logon credentials (if required).
If connection to MS SQL done via Windows Authentication, the user running the installer must
have DDL permissions for the duration of the installation process and NETWORK SERVICES must
have DML permissions for the ongoing operation of CxSuite Enterprise Edition.
If connection to MS SQL done via SQL Authentication, the user whose credentials are specified in
the installer must have DDL permissions for the duration of the installation process and DML
permissions for the ongoing operation of Checkmarx Application Server.
There is also an option to select between two web servers:
UltiDev Web Server a light web server for POC
Microsoft IIS to be used in production

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

5.

Only if you have selected to use MSSQL then in the next page enter MSSQL the connection
information. Only after a successful test the Next button will be enabled.

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

6.

Check if all prerequisites are installed properly and click next.


If one of the prerequisites is not green the system will display an option to try and automatically
fix the problem.

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

7.

Verify the summary and click on the Install button.

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

8.

The installation will start.

9.

Wait until install finishes.

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

10. License activation:


.

a.Use currently installed license: Use this option in upgrade when a license already installed on
the machine.
b.Import new license: Use this option if you have already issued a license.
c. Request new license: Follow the registration instructions to receive a license file.
Send the hardware ID to [email protected] or to your Checkmarx contact, directly.
After installation is finished the hardware ID can be found at StartAll
ProgramsCheckmarxHardware ID.

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

Once receiving the license file, copy it to the licenses folder.


Default for Windows 32-bit - C:\Program Files\Checkmarx\Licenses
Default for Windows 64-bit - C:\Program Files (x86)\Checkmarx\Licenses

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

11. Click next.


12. Checkmarx automatically starts services (This action will be performed if a license is installed).

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

13. In the last page you can find a link to the web client page. Click finish.

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

14. When a new license is installed, make sure the relevant services are up and running
(CxJobsManager, CxScansManager, CxSystemManager, CxScanEngine, web server ).

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

15. You can now connect to the WebPortal Url: http://localhost/CxWebclient/ or the windows client
with default credentials: UserName : admin@cx / password: admin. Password can be changed
in the web admin interface

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

A PPENDIX A
IIS 7.0 requirements in Windows 2008 Server
1.

Go to server Manager Roles

2.

Edit IIS Roles

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

A PPENDIX B
IIS 7.0 requirements in Windows 7
1.

Open the Control Panel

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

2.

Click on Uninstall a program

3.

Click on Turn Windows features on or off

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

4.

Add ASP.NET and IIS 6 Management Compatibility roles.

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

A PPENDIX C
IIS 8.0 requirements in Windows 2012 Server
1.

Go to Server Manager

2.
3.

Click on Add roles and features.


Select installation type Role-based

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

4.

Select the checkmarx server

5.

Add The Application server with the IIS support

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

6.

In the IIS section add ASP.NET and IIS 6 Management Compatibility roles.

CHECKMARX SOURCE CODE ANALYSIS TECHNOLOGIES

| WWW.CHECKMARX.COM

TELEPHONE: +972-3-7581800 | [email protected] | FAX: +972-3-6959743

You might also like