Interfaces

This section provides an overview of the CipherTrust Manager interfaces.

CLI

The CipherTrust Manager includes a CLI tool, named ksctl, that can be downloaded and run locally to control a remote CipherTrust Manager appliance. ksctl exclusively uses the REST API to communicate with the CipherTrust Manager, so anything that you can do with the tool, you can also do directly with the REST API. Conversely, ksctl exposes most of the functionality of the REST API. It can perform management functions, such as managing registration tokens and clients.

To use the CLI:

1. Open the CipherTrust Manager URL in a browser.

2. Click the API & CLI Documentation link. The API playground is displayed.

3. At the top left, click CLI Guide. The CLI documentation is displayed.

4. At the top right, click the CLI download button. This downloads the ksctl_images.zip file.

5. Unzip the ksctl_images.zip file. The extracted files contain platform specific files. For example, the file for Windows is ksctl-win-amd64, and for Linux, the file is ksctl-linux-amd64.

6. Set up the ksctl-<os> file for your system. Refer to the CipherTrust Manager CLI documentation for details.

7. Run ksctl pf to run ProtectFile specific commands.

Refer to the CipherTrust Manager documentation for details. For details on commands related to ProtectFile, refer to the online documentation of ksctl pf.

REST API

Use the REST interface from the API playground or through any REST client such as curl. The REST interface acquires an authorization token internally and uses it for making API calls.

Acquiring an Authorization Token

To acquire a token:

1. Open the CipherTrust Manager URL in a browser.

2. Click the API & CLI Documentation link. The API playground is displayed.

3. At the top right, click Authenticate.

4. Enter username and password.

5. Click POST.

On successful token generation, the remaining token expiry time in seconds is displayed. Two new buttons, Clear Credentials and Re Authenticate, are also displayed at the top right.

Using the Token

The authorization token acquired above is used in examples in the API playground. The token expires in 5 minutes; if expired, generate a new token, as described in Acquiring an Authorization Token.

Making an API Call

To make an API call, find the API in the left pane and click it. In the right pane, specify the required parameters, and click an appropriate button (for example, POST, GET, DELETE, or Curl). For example, to create a client registration token on the CipherTrust Manager:

1. In the left pane of the API playground, click Client-Management/Tokens.

2. Under Client-Management/Tokens, click Create. The Create section of the API playground is displayed in the right pane.

3. In the body field, specify required parameters with their values, as shown below.

   {
        "ca_id": "d94ef496-5e43-4424-a6e7-f4213c108415",
        "lifetime": "10h",
        "cert_duration": 730,
        "max_clients": 100,
        "name_prefix": "pf_client"
   }
   

   Note

   Here, ca_id represents the ID of the local CA. To get the ID, navigate to Certificate Authority and click List local CAs. In the List local CAs section on the right, click GET. The output will list local CAs. View the ID of the local CA you need.

   Expand schema under the body field for names and types of fields. Hover your mouse over each field to view its description. The parameter names and casing in the body field must match with those shown in the schema. Also, ensure that parameters and their values are specified in double quotes.

4. Click POST.

Alternatively, to get an equivalent curl command, click the Curl button. The curl equivalent will be shown in the text field below. Use the curl tool to run the command to make the REST API call.

Similarly, all API calls can be made by referring to the schema shown in the playground.

GUI

Use the CipherTrust Manager's GUI (also called the Management Console) to perform management functions, such as managing client profiles, clients, access policy groups, and rules. These functions can also be performed using the CLI tool or REST API.

To use the GUI:

1. Open the CipherTrust Manager URL in a browser.

2. Enter Username and Password.

3. Click Log In. By default, the Products page is displayed.

4. Click ProtectFile & Transparent Encryption UserSpace to open the application.