Managing CADP for Java Applications

An application definition contains necessary configurations that are required for a client to function smoothly. A registration token generated while defining the application is used to register the clients with the CipherTrust Manager.

The application definition includes:

• Configuration parameters: required to initialize and configure the client.

• CSR parameters: required to create or renew client certificates and keys.

• CA parameters: required to issue and install digital certificates and CSR.

In this article, you will learn how to:

• Define application

• View application

• Edit application

• Deleting application

Defining Application

1. Log on to the CipherTrust Manager GUI as administrator.

2. Open Application Data Protection.

3. In the left pane, click Applications. The list of applications is displayed on the screen.

4. On the Applications page, click Add Application. The Add Application wizard is displayed. Follow the steps to complete the setup.

Add General Info

1. On the General Info screen of the Add Application Wizard, specify a unique Name for the application.

2. Select the Connector Type as CADP for Java from the drop-down list.

3. Click Next to go to the Settings screen.

Configure Parameters

1. On the Settings screen of the Add Application Wizard, configure the following parameters.

   1. Client Configuration

      These parameters are required to initialize CADP for Java clients.

      • Logging

        Field	Description	Mandatory	Default
        Log Level	The level of logging to determine verbosity of clients logs. Possible options — INFO — WARN — ERROR — DEBUG	Yes	WARN
        Log Size Limit	Determines how large log files are before they are rotated.	No	100K
        Log Max Backup Index	Maximum number of log backup files to be stored on the disk if log rotation is enabled.	No	-1
        Log GMT	If selected, timestamp will be formatted in GMT.	No	No default

        Note

        By default, the CADP for Java logs are rotated on daily basis. You can change the frequency of log rotation using the CipherTrust Manager's API Playground. At present, log rotation can't be modified through the CipherTrust Manager UI.

      • Local Encryption

        Field	Description	Mandatory	Default
        Key Cache Expiry	Determines the minimum amount of time a key can be cached.	Yes	43200 seconds

      • Connection Configuration

        Field	Description	Mandatory	Default
        Heartbeat Interval	Time interval (in seconds) after which the client needs to send heartbeat notification to the CipherTrust Manager to get updated policies and configurations.	Yes	300 seconds
        Heartbeat Timeout Count	Number of continuously missed heartbeats after which a client marks itself as unhealthy. After this count, the CipherTrust Manager revokes the client and the client stops performing any cryptographic operations.	Yes	5 minutes If this parameter is set to -1, client will continue to send the heartbeats until it is alive and the CipherTrust Manager will not revoke the client.

        The CipherTrust Manager updates status of all the clients after every 5 minutes based on the number of missed heartbeats.

   2. Server Configuration

      These parameters are required to configure server settings such as CA, CSR, and Connection configurations.

      • Group Permissions

        Field	Description	Mandatory	Default
        Client Groups	Clients associated with the application will get permissions based on the selected groups. By default, all clients are added to the Application Data Protection Clients group.	No	Application Data Protection Clients

      • CA Parameter

        Field	Description	Mandatory	Default
        Local CA	Select a local CA from the available options. The CA issues digital certificates and signs CSR.	No	CipherTrust Root CA

        Note

        Local CA should be added in the Local Trusted CAs of the Web interface on the CipherTrust Manager.

      • CSR Parameters

        Field	Description	Mandatory	Default
        Common Name	Select the user. This is the CADP for Java user who will interact with CM.	No	No default
        City	Name of the city.	No	No default
        Country	Name of the country.	No	No default
        State	Name of the state.	No	No default
        Organization Name	Organization name.	No	No default
        Organization Unit	Organization unit.	No	No default
        Email	Valid email id.	No	No default
        Certificate Duration	Validity period of a client certificate.	No	730 days
        Certificate Auto Renewal	Turn on the Certificate Auto Renewal toggle to automatically renew the client certificate before it expires in the user environment. The process of certificate auto renewal is explained here.	No	By default, the toggle is off.

2. Click Next to go to Confirmation page.

Confirmation

1. On the Confirmation screen, verify the application details. This screen displays general information and settings .

2. If you want to modify any detail, click Edit and update the details.

3. Click Save. A message stating Application is successfully created is displayed on the screen. At this step, a Registration Token is returned. The clients will use this token to get registered on the CipherTrust Manager.

4. Click Close to exit the wizard. The newly defined application is added to the list of Applications.

After defining the application, register your CADP for JAVA client with the CipherTrust Manager using the generated registration token, as detailed in Quick Start document of CADP for JAVA 8.18.0 or higher.

Viewing Application

The Applications page shows the unified view for all the applications defined on the CipherTrust Manager. Refer to Single Pane of Glass for details.

Viewing details of application

Click application name to view its details. The detailed view shows:

• Clients tab: provides insight into details of clients registered within an application.

• Settings tab: provides information about the parameters that were used to define application for a client.

Clients tab

The Clients tab displays the list of clients registered with an applications, their status, version, name, and so on. It provides the count of:

• The Total Active clients.

• The number of clients in Error state.

• The number of clients in Warning state.

• The number of clients in Healthy state.

• The number of Revoked clients.

Click each tab to filter the clients by their status.

Client status

The CipherTrust Manager updates status of all the CADP for Java clients after every 5 minute based on the number of missed heartbeats. A client can be in one of the following states:

The Clients tab also shows the following details:

Settings tab

The Settings tab shows the configuration details for client. Refer to Managing CADP for Java Applications.

On the detailed view of applications page, you can also:

• Refresh clients

• Remove revoked clients

Modifying Application

To modify settings and of an application:

1. Open Application Data Protection.

2. In the left pane, click Applications. The list of applications is displayed on the screen.

3. Click the name of the application that you want to modify. The <Application-name> screen shows the clients, settings, and policy associated with the application.

4. Click the Settings tab. You can modify the client, server, and network configurations.

5. Click Update. A message Application updated successfully is displayed.

Deleting Application

1. Open Application Data Protection.

2. In the left pane, click Applications. The list of applications is displayed on the screen.

3. Click the overflow icon () corresponding to the application that you want to delete.

4. Click Delete. A dialog box appears prompting to confirm the action.

5. Click Delete. A message, <Application_name> has been deleted appears on screen.

   Warning

   Deleting an application also deletes all the associated clients. This action may impact the operations performed by the clients. So, before deleting an application, ensure all the mapped clients are not in use.