Skip to main content

Backing Up & Recovering CxSAST

The following page describes the backup and recovery procedures for CxSAST

Backing up CxSAST

CxSAST Enterprise is composed of application files, configuration files and SQL databases.

Generally the best backup method (available only for virtual machines) would be a daily snapshot of the CxSAST machine(s) and restoration when needed.

If the Snapshots option is not available, do the following:

  1. Make sure there are no scans currently running.

  2. Stop all Cx Windows services and Web servers (depending on the Checkmarx components installed on the server):

    On a centralized host:o CxSystemManager

    o CxJobsManager

    o CxScansManager

    o CxSastResults

    o CxScanEngine

    o Management and Orchestration:

    = CxARM

    = CxARMETL

    = CxRemediationIntelligence

    o Shared services:

    = ActiveMQ

    o Web server (run "iisreset /stop" from elevated CMD or Stop action for the server name in IIS Console):

    = World Wide Web Publishing Service

    = IIS Admin Service

  3. Back up the Checkmarx folder by copying it aside (Logs folder can be excluded)

    Example: <Checkmarx Installation Path>\Checkmarx -> <Checkmarx Installation Path>\Checkmarx01012016

  4. Back up the CxDB, CxActivity and CxARM SQL databases using standard Database tools

  5. Back up the CxSRC folder - scanned source folder - by creating a copy

    Example: X:\CxSrc -> X:\CxSrc01012016Note: Check that you have the CxSAST installation zip file for the current backed up version (can be requested from Checkmarx support).

  6. Back up the following Access Control and CxEngine environment variables:

    o AccessControlClientCredentialsSecret

    o MessageQueuePassword

    o CX_ES_MESSAGE_QUEUE_PASSWORD

  7. Start all Cx Windows services and Web servers (depending on the Checkmarx components installed on the server):

    On a centralized host:o CxSystemManager

    o CxJobsManager

    o CxScansManager

    o CxSastResults

    o CxScanEngine

    o Management and Orchestration:

    = CxARM

    = CxARMETL

    = CxRemediationIntelligence

    o Shared services:

    = ActiveMQ

    o Web server (run "iisreset /start" from elevated CMD or Start action for the server name in IIS Console):

    = World Wide Web Publishing Service

    = IIS Admin Service

Recovering CxSAST

The recovery procedure may be different based on the state of CxSAST server(s). If CxSAST exists and is working you can start from the second step.

If the CxSAST server(s) must be rebuilt, do the following:

  1. Install CxSAST with same version as your backed up version to the same path as your former CxSAST installation

  2. Stop all Cx Windows services and Web servers (depending on the Checkmarx components installed on the server):

    On a centralized host:o CxSystemManager

    o CxJobsManager

    o CxScansManager

    o CxSastResults

    o CxScanEngine

    o Management and Orchestration:

    = CxARM

    = CxARMETL

    = CxRemediationIntelligence

    o Shared services:

    = ActiveMQ

    o Web server (run "iisreset /stop" from elevated CMD or Stop action for the server name in IIS Console):

    = World Wide Web Publishing Service

    = IIS Admin Service

  3. Move/rename the Checkmarx folder

    Example: <Checkmarx Installation Path>\Checkmarx --> <Checkmarx Installation Path>\checkmarxNew01012016

  4. Restore the Checkmarx folder

  5. Move the old Checkmarx folder that you previously saved back to the original Checkmarx folder location.

    Example: <Checkmarx Installation Path>\checkmarx0101216 --> <Checkmarx Installation Path>\Checkmarx

  6. Restore the database

    Restore the databases using the backup that you previously saved using the standard database tools.

  7. Restore the scanned source folder,

  8. Move the old scanned source folder that you previously saved back to the original folder location.

    Example: X:\CxSrc01012016 --> X:\CxSrc

  9. Restore the following Access Control and CxEngine environment variables:

    o AccessControlClientCredentialsSecret

    o MessageQueuePassword

    o CX_ES_MESSAGE_QUEUE_PASSWORD

  10. Start all Cx Windows services and Web servers (depending on the Checkmarx components installed on the server):

    On a centralized host:o CxSystemManager

    o CxJobsManager

    o CxScansManager

    o CxSastResults

    o CxScanEngine

    o Management and Orchestration:

    = CxARM

    = CxARMETL

    = CxRemediationIntelligence

    o Shared services:

    = ActiveMQ

    o Web server (run "iisreset /start" from elevated CMD or Start action for the server name in IIS Console):

    = World Wide Web Publishing Service

    = IIS Admin Service

  11. Check the recovered version

  12. Perform a basic test on the restored installation to check that everything is up and running.

    o Login

    o View older scan results

    o Run a small new scan

    o View the new scan results

Notice

Should you need any further assistance, please don't hesitate to contact Checkmarx support.

.