Contents x
    CMS Applications
    • 26 Dec 2024
    • 14 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    CMS Applications

    • Updated on 26 Dec 2024
    • 14 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    About this Article
    This article provides information about the CMS Applications including creation, modification, deletion, association of instances and auto discovery of application.


    What is a CMS Application?

    Application is the VSP equivalent of Application Workload in your environment. Application Workloads that need VSP-Web or VSP-Memory protection must be created in the CMS to enable VSP protection. The application structure is depicted below:


    Different Application Status

    A Probe can exist in any of the below statuses:

    Probe StatusDescription
    UnknownProbe whose status is unknown due to application shutdown, unsuccessful communication with the server OR expired certification installed on the Probe or AE
    RegisteredVSP Probe has established a connection with the CMS
    ProvisionedProbe is provisioned (secured) but not started
    NormalProbe is provisioned (secured), started and monitored by VSP
    ThreatProbe with a minimum of one threat detected by VSP
    Threat OfflineProbe with a minimum of one threat detected by VSP and the application is offline (stopped)
    AttackProbe with a minimum of one attack detected by VSP
    Attack OfflineProbe with a minimum of one attack detected by VSP and the application is offline (stopped)


    Applications exist in one of the two provisioning status values:

    Application Provisioning StatusColor Code
    ProvisionedGreen
    FailedRed


    Create Application

    Create a new application on the CMS as described below:

     

    For VM
    1. Navigate to Manage > Web > Application Provisioning in the left navigation pane. Click Add Application
    2. Provide Application (Name) and Version (Optional). Click NEXT
    3. Add Application Server
      1. Provide Service Name, Service Tag, Service Type and Operating System Platform
      2. Provide Service Type as Application Server for Web and Memory Protection
      3. The provided service tag can be utilized during VSP probe installation to enable automatic provisioning into the Application Server
      4. Select the appropriate Deployment Type – VM

        VM_AddService

      5. Add Process: Provide the below information 
        Field NameDescription
        Process NameName of the Process
        Process Description

        (Optional) A short description of the Process

        Select Process Type

        Select the appropriate process type from the drop-down. Eg: Java, Binary, .NET

        Protection Profile NameSelect the appropriate Protection Profile from the drop-down. Click here for more information
        Web Profile Name(Optional - For Web protection only) Drop-down list with all available Web Profiles
        Select Vulnerabilities

        Based on the selected Process Type, select the vulnerabilities against which VSP Protection is desired. The protection level can be configured for each vulnerability. By default, when a vulnerability is selected, the associated protection mode is set to Detect

        Note: XML Injection protection includes DTD Injection, also called XML External Entity (XXE) Injection. XXE attacks manipulate the DTD, allowing an attacker to view files or access other network resources to which the server has access. To detect XXE injection, the following vulnerabilities must be enabled - Path Traversal Injection, Remote File Inclusion and Local File Injection
        Auto-Instrumentation

        Enable – When enabled, instrumentation is performed by VSP at the back end and no manual configurations are required

        Disable – When disabled, instrumentation must be performed manually. Click here for more information

        Note: Refrain from using auto-instrumentation with WebSphere. Opt for manual instrumentation. Click here for more information

        Application Deployment Folder

        (For FSM only) Location where the application is deployed. Eg: /opt/tomcat/webapps

        File Integrity Exclusion Folders(For FSM only) List of directories to be excluded from FSM separated by comma. Eg: /opt/tomcat/logs,/opt/tomcat/work
        File Integrity Monitored Folders(For FSM only) List of additional directories to be included for FSM monitoring. Eg: /usr
        File Extension Exclusion ListList of file extensions to be excluded from FSM Monitoring. Eg: *.log
        Versions 2.9 and Below:
        Start Up Script File Path        		Full path (with the executable name) of the Web Server/Application Server start up script. Eg: /usr/local/apache2/bin/run_apache.sh
        Versions 2.10 and Above:
        Start Up Script File Path or Service Name        		Full path (with the executable name) of the Web Server/Application Server start up script. Eg: /usr/local/apache2/bin/run_apache.sh
        OR

        The service name of the application server if it is configured as Window/Linux service

        Server Type(For VSP-Web only) Select the Server Type from the drop-down. Eg: JBoss, Weblogic, Tomcat
        LFI Profile Name(Optional) Drop-down list with all available LFI Profiles
        RFI Profile Name(Optional) Drop-down list with all available RFI Profiles

        VM_AddProcess

      6. Add Web Process: Provide the below information
        Field NameDescription
        Service NameName of the Service
        Service TagService Identifier that helps users to locate the appropriate web service
        Server Type

        Select Web Services

        Deployment TypeSelect the appropriate type – Virtual Machine
        Operating SystemSelect the appropriate Operating System – Windows OR Linux
        Deployment NameName of the associated deployment
        Web Server NameName of the Web Server
        Web Server Description(Optional) A short description of the Web Server
        Web Server TypeSelect the Web Server type from the drop-down
        Web Server Command LineThe exact command line for starting the web server
        Protection Profile NameSelect the appropriate Protection Profile from the drop-down. Click here for more information about Protection Profile Creation
        Host NameProvide the <hostname>:<port> values. If multiple applications are deployed on the same Web Server, provide the values for all the hostnames and ports, separated by comma
        Web Profile Name(Optional) Drop-down list with all available Web Profiles. Click here for more information about Web Profile creation
        Auto-Instrumentation

        Enable – When enabled, instrumentation is performed by VSP at the back end and no manual configurations are required

        Disable – When disabled, instrumentation must be performed manually. Click here for more information

        Note: Refrain from using auto-instrumentation with WebSphere. Opt for manual instrumentation. Click here for more information
        Select Vulnerabilities

        Select the vulnerabilities against which VSP-Web (on Web Server) Protection is desired. The protection level can be configured for each vulnerability. By default, when a vulnerability is selected, the associated protection mode is set to Detect

        Note: XML Injection protection includes DTD Injection, also called XML External Entity (XXE) Injection. XXE attacks manipulate the DTD, allowing an attacker to view files or access other network resources to which the server has access. To detect XXE injection, the following vulnerabilities must be enabled - Path Traversal Injection, Remote File Inclusion and Local File Injection
        LFI Profile Name(Optional) Drop-down list with all available LFI Profiles
        RFI Profile Name(Optional) Drop-down list with all available RFI Profiles
    4. Click SAVE to view the newly added Application
    5. More Services and Processes can be added to the same Application
    6. To add instances to the Applications, navigate to the Services tab and click Associate Instances 
      1. Select all the required Application Instances on the pop-up window. Click Associate

    For Container
    1. Navigate to Manage > Web > Application Provisioning in the left navigation pane. Click Add Application
    2. Provide Application (Name) and Version (Optional). Click NEXT
    3. Add Application Server
      1. Provide Service Name, Service Tag, Service Type and Operating System Platform
      2. Provide Service Type as Application Server for Web and Memory Protection
      3. The provided service tag can be utilized during VSP probe installation to enable automatic provisioning into the Application Server
      4. Select the appropriate Deployment Type – Container Or K8s
      5. Provide the Pod Name (found in the application’s K8s yaml file) as the Deployment Name
        NOTE
        Ensure that the Deployment Name provided here is the same name as in the customer yaml file during execution of the script vsp_vdt_ci.sh in CI Phase

      6. Add Process: Provide the below information 
        Field NameDescription
        CI Phase Image NameName of the Container Image deployed in CI Phase
        CD Phase Image Name

        (Optional) Name of the Container Image deployed in CD Phase

        Process Name

        Name of the Process

        Process Description(Optional) A short description of the process
        Select Process TypeSelect the appropriate process type from the drop-down. Eg: Java, Binary
        Protection Profile NameSelect the appropriate Protection Profile from the drop-down. A link to create a new Protection Profile is also provided on the CMS
        Web Profile Name(Optional - For VSP-Web only) Drop-down list with all available Web Profiles
        Select Vulnerabilities

        Based on the selected Process Type, select the vulnerabilities against which VSP Protection is desired. The protection level can be configured for each vulnerability. By default, when a vulnerability is selected, the associated protection mode is set to Detect

        Note: XML Injection protection includes DTD Injection, also called XML External Entity (XXE) Injection. XXE attacks manipulate the DTD, allowing an attacker to view files or access other network resources to which the server has access. To detect XXE injection, the following vulnerabilities must be enabled - Path Traversal Injection, Remote File Inclusion and Local File Injection
        Application Deployment Folder(For FSM only) Location where the application is deployed. Eg: /opt/tomcat/webapps
        File Integrity Exclusion Folders(For FSM only) List of directories to be excluded from FSM separated by comma. Eg: /opt/tomcat/logs,/opt/tomcat/work
        File Integrity Monitored Folders(For FSM only) List of additional directories to be included for FSM monitoring. Eg: /usr
        File Extension Exclusion ListList of file extensions to be excluded from FSM Monitoring. Eg: *.log
        Versions 2.9 and Below:
        Start Up Script File Path        		Full path (with the executable name) of the Web Server/Application Server start up script. Eg: /usr/local/apache2/bin/run_apache.sh
        Versions 2.10 and Above:
        Start Up Script File Path or Service Name        		Full path (with the executable name) of the Web Server/Application Server start up script. Eg: /usr/local/apache2/bin/run_apache.sh
        OR

        The service name of the application server if it is configured as Window/Linux service

        Server Type(For VSP-Web only) Select the Server Type from the drop-down. Eg: JBoss, Weblogic, Tomcat
        LFI Profile Name(Optional) Drop-down list with all available LFI Profiles
        RFI Profile Name(Optional) Drop-down list with all available RFI Profiles


      7. Add Web Process: Provide the below information
        Field NameDescription
        Service NameName of the Service
        Service TagService Identifier that helps users to locate the appropriate web service
        Server Type

        Select Web Services

        Deployment TypeSelect the appropriate type – Virtual Machine, Container, K8s (Kubernetes Pod)
        Operating SystemSelect the appropriate Operating System – Windows OR Linux
        Deployment NameName of the associated deployment
        CI Phase Image NameName of the Container Image deployed in CI Phase
        CD Phase Image Name(Optional) Name of the Container Image deployed in CD Phase
        Web Server NameName of the Web Server
        Web Server Description(Optional) A short description of the Web Server
        Web Server TypeSelect the Web Server type from the drop-down
        Web Server Command LineThe exact command line for starting the web server
        Protection Profile NameSelect the appropriate Protection Profile from the drop-down. A link to create a new Protection Profile is also provided
        Host NameProvide the <hostname>:<port> values. If multiple applications are deployed on the same Web Server, provide the values for all the hostnames and ports, separated by comma
        Web Profile NameProvide the <hostname>:<port> values. If multiple applications are deployed on the same Web Server, provide the values for all the hostnames and ports, separated by commas
        Select Vulnerabilities

        Select the vulnerabilities against which VSP-Web (on Web Server) Protection is desired. The protection level can be configured for each vulnerability. By default, when a vulnerability is selected, the associated protection mode is set to Detect

        Note: XML Injection protection includes DTD Injection, also called XML External Entity (XXE) Injection. XXE attacks manipulate the DTD, allowing an attacker to view files or access other network resources to which the server has access. To detect XXE injection, the following vulnerabilities must be enabled - Path Traversal Injection, Remote File Inclusion and Local File Injection
        LFI Profile Name(Optional) Drop-down list with all available LFI Profiles
        RFI Profile Name(Optional) Drop-down list with all available RFI Profiles
    4. Click SAVE to view the newly added Application
    5. More Services and Processes can be added to the same Application


    Application Auto-Discovery (VM Only)

    Application Discovery is a component of the installed VSP probe. It scans the Probes after installation and at regular intervals (Default duration - weekly) to discover the web applications hosted on them. Once the web applications are discovered, appropriate Applications are created on CMS with the discovered information. In cases where manual application creation is desired, refer to Create Application


    Coverage

    1. Version 2.11 and Above: Application Discovery discovers all applications. In cases where the applications are not compatible with VSP, it is indicated on CMS as depicted: NotCompatibleApplication
    2. Version 2.10 and Below: Application Discovery discovers applications on both Linux and Windows VMs that can be provisioned as per the VSP Compatibility Matrix
    3. For Java-based applications:
      1. Cluster/Domain mode is not supported for application servers listed below:’
        1. JBoss
        2. WildFly
        3. Glassfish
        4. WebLogic
        5. WebSphere
          NOTE
          Refrain from using auto-instrumentation with WebSphere. Opt for manual instrumentation
      2. Java Application servers configured as services may not be discovered


    Pre-requisites

    The pre-requisites are:

    1. (Not applicable for .NET and .NET Core) The application process is running during Application Discovery scan


    Application Discovery Workflow


    1. After probe installation, Application Discovery collects information about running applications on the host
    2. Based on this information, a new application is created or the instance is associated with the existing application on CMS. A system alert is generated for auto-association of instances
      1. Navigate to Manage > Web > Application Provisioning in the left navigation pane to view the application
      2. The name of the newly created Application is of the format: <Process Type>_<Deployment Folder>_<Application Server>_<Application Server Version>
      3. Example: JAVA17_opt_my_app_Tomcat_10.0
      4. For .NET and .NET Core Applications, the name of the newly created Application is of the format: <SiteName_SubSiteName1_…_SubsiteNameN_OnIIS>. The .NET version number is also populated on the UI
        NOTE

        The slashes (“/” OR “\”) in the directory paths are replaced with an underscore (“_”)
        The maximum number of characters for the application name is 55. In cases where the number is exceeded, it is truncated

      5. The auto-discovered applications have the Created By field as SystemDiscoveredAppSource
      6. During upgrade scenarios from VSP 2.5/2.6 to VSP 2.7 or above, review both the discovered applications from VSP 2.7 or above and user-created applications from VSP 2.5/2.6 after Application Discovery. Delete the applications that are not needed
    3. Once the application is created, the user may configure the security policy by editing the newly created process:DiscoveredAppEditProcess
      1. Create the required protection profile, web profile, LFI/RFI profiles. Associate them with the application
      2. Select vulnerabilities
      3. The auto-discovered fields – Process Type, Application Deployment Folder, Start Up Script File Path, Server Type - cannot be modified since they are auto-discovered. Other fields including the names of Application, Service and Processes can be modified
        NOTE
        In cases where the security profile is not configured and the process is not running on the instance, another Application Discovery scan removes the newly created application
        For WebSphere, the auto instrumentation option is disabled by default
    4. Once the security profile is configured, the application is auto-provisioned and moves to 100% completion
    5. Restart the business application (application process) to enable security policies in the application. This restart is required only during the first-time selection of security policies. Subsequent changes to the security policies do not require an application restart


    Application Discovery Configuration

    Below are the commands for various application discovery configurations

    1. To modify the duration between the automated Application Discovery scans
      vsp-cli edit-service fde edit restartFrequency <Number of hours>
    2. To disable application discovery scans
      vsp-cli edit-service fde edit restartFrequency 0
    3. To manually initiate a scan
      vsp-cli start fde


    Upgrades to PHP and NodeJS Language Version

    VSP Auto Discovery creates a new application in CMS if the application changes PHP or NodeJS versions (Example: PHP is upgraded from version 7.3 to version 7.4). The new application is listed in CMS alongside the old application with the older PHP or NodeJS version. Security policies need to be recreated for this new application on the “Edit Process” screen.

    NOTE
    In case of NodeJS, any modification of the start-up script path results in a new application creation in CMS by VSP Auto Discovery


    Application List on CMS

    The list of Applications can be viewed on the CMS

    1. Navigate to Manage > Web > Application Provisioning in the left navigation pane. Applications are listed along with the number of attacks, threats and incidents associated with them
    2. Standard search and export/import features are available
    3. Expand an Application to view more information in the tabs:
      1. Details – Generic information about an Application is provided
      2. Services– Information related to the associated Services and their Processes is provided
        1. To view the configured vulnerabilities protection, expand the required service and click Vulnerability Protection
        2. The pop-up window displays Instrumentation Type and Protection Mode for each configured vulnerability. The instrumentation types are Deep (for application services), HTTP (for Web services) and Mix (for Custom Injection – both Deep and HTTP)
      3. Progress – Information related to the associated instances, status, configured vulnerabilities and the completion (in percentage) is provided. In case of an error(s), the information about the error is displayed
    4. Version 2.10 and Below: Click the Attack, Threat OR Incident link to navigate to the Incidents page that displays the incidents associated with the Application
    5. For Applications with Containers or Kubernetes Pod instances, once the Installation of VSP Agent is completed on that instance, the configuration is locked. This is depicted by the below icon. Once the configuration is locked, it cannot be deleted. Modification is allowed only for certain fieldsLock Service


    Lock/Unlock Processes (Containers only)

    1. Once the CD tool (Click here for more information) is executed during Application Setup, the process associated with an application is locked. It is indicated by the below icon
    2. To unlock the process, expand the application and click on tab Services. Expand the listed service
    3. Click on the below icon associated with the process. Click YES on the confirmation screen
    4. Once unlocked, it is indicated by the below icon
    5. To lock an unlocked process, click on the below icon. Click YES on the confirmation screen


    Secure Probe

    Securing/Provisioning an Probe begins VSP protection on that instance. Auto-provisioning can be enabled by providing the service tag at the time of Probe Installation. It can be performed manually:

    1. Click Start to secure a specific Probe. VSP monitoring begins at that instance. This is applicable for VMs only
      1. Click YES on the confirmation pop-up
    2. For Pods and Containers, the provisioning is initially automated. Subsequent stop and start actions are allowed
    3. The progress of securing each server is displayed through a progress bar. The information on the page gets refreshed automatically
    4. Click Stop to stop provisioning of a specific Probe. This is applicable for VMs only.
      1. Click YES on the confirmation pop-up
    NOTE
    Once an Application is provisioned, VSP may report File events as a file integrity check is carried out with VirusTotal during Provisioning
    Click here for more information about Custom Provisioning for VM


    Export/Import Applications

    1. Export and import of applications can be used:
      1. When VSP protection is extended to a different environment (Example: Pre-production to Production environment) OR
      2. To clone an existing entry
    2. The Applications can be imported/exported with .virsec extension
    3. The exported information consists of the associated services, processes, protection profile and web profile
    4. Ensure that import/export operations are carried out in the same VSP version. Import/export feature is compatible across various patches in the same major release (Example:  VSP 2.8.x)


    Modify Application

    NOTE
    • For Applications already secure and running with VSP Monitoring, ONLY additional eligible Probes can be included
    • To edit any other parameter in an application, ensure that it is stopped first
    • For containers, only the Applications with unlocked processes can be modified


    To modify applications, follow the below steps:

    1. Navigate to Manage > Web > Application Provisioning in the left navigation pane
    2. To modify the fields Application Name or Version, click Edit. Modify the fields as required
    3. To modify an existing Service, click Edit associated with it. Modify as required
    4. To modify an existing Process, click Edit associated with it. Modify as required


    Delete Associated Instances (VMs only)

    1. Navigate to Manage > Web > Application Provisioning in the left navigation pane. Expand the secured application
    2. Navigate to the Progress tab. Click Delete
    3. Click YES on the confirmation pop-up


    Delete Application

    NOTE
    • Applications already secure and running with VSP Monitoring cannot be deleted
    • To delete such applications, it is necessary to stop the provisioning


    To delete applications, follow the below steps:

    1. Navigate to Manage > Web > Application Provisioning in the left navigation pane
    2. On the displayed list of applications, click the delete link of the required application
    3. Click YES on the confirmation pop-up

                  


    Was this article helpful?
    Related articles
    What's Next