Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

back

CCKM API

Overview

search

Please Note:

Overview

CipherTrust Cloud Key Manager (CCKM, also referred to as CCKM Embedded) centralizes the management of key life cycle for various cloud services providers. The CCKM complies with data security mandates in cloud storage environments while retaining the custodianship of the encryption keys. Enterprises can back up keys on-premise, destroy keys when no longer needed, and manage the entire life cycle of the cloud keys.

The following diagram shows the high level CCKM overview:

CCKM Components

The CCKM solution comprises the following components:

  • CCKM GUI on the CipherTrust Manager for administrators and users

  • At least one of the supported clouds

  • A supported trusted key source

  • A supported Internet browser

The product is delivered as a licensed component of the CipherTrust Manager appliance that can be installed on any one of the supported deployment methods.

Supported Clouds

  • AWS China

  • AWS GovCloud

  • Azure Cloud

  • Azure China Cloud

  • Azure US Government

  • Oracle Cloud

  • Salesforce

  • Salesforce Sandbox

  • SAP Data Custodian

AWS China cloud does not support uploading 256-bit keys. It supports 128-bit keys only. CCKM automatically uploads 128-bit keys to the AWS China cloud through the GUI. Other AWS clouds support upload of 256-bit keys.

AWS China cloud does not support creation of native asymmetric keys.

Supported Cloud Services

  • AWS Customer Managed CMKs

  • Azure Cloud BYOK

  • Azure Stack (Azure Active Directory, Azure AD)

  • Azure Stack (Active Directory Federation Services, AD FS)

  • Google Workspace Client Side Encryption (CSE)

  • Google Cloud CustomerManaged Encryption Keys (CMEK)

  • Google Cloud External Key Manager (EKM)

  • Oracle Cloud Infrastructure (OCI)

  • Salesforce Bring Your Own Key (BYOK)

  • Salesforce Cache-Only Key Service

  • SAP Data Custodian Key Management Service (BYOK)

Supported Key Sources

CCKM uses the following as the trusted key sources for the encryption keys employed within the supported clouds:

  • CipherTrust Manager

  • Azure Dedicated HSM

  • Luna Network HSM (referred to as Luna HSM in this document): This release supports:

    • Luna Network HSM Software and Firmware versions v7.3.x and higher.

    • PED and Password-based HSM configurations.

    • Import of RSA-4096 keys from Luna HSM Software and Firmware versions 7.4.x and higher.

    • Only asymmetric keys with Luna HSM.

  • Data Security Manager (DSM): This release supports DSM v6.4 Cumulative Patch 3 and higher.

The CipherTrust Manager supports all clouds that CCKM supports. The CipherTrust Manager stores its own keys and the backup keys from the supported clouds.

On the CipherTrust Manager, CCKM cannot manage source keys created on the CCKM Appliance v1.x.

Supported Deployment Methods

The CCKM is delivered as part of the CipherTrust Manager appliance. So, CCKM can be automatically deployed with the deployment of the CipherTrust Manager in the following supported environments:

  • Amazon Web Services

  • Google Cloud Platform

  • Microsoft Azure

  • Oracle Cloud

  • Private Clouds - Oracle VMware vSphere, Microsoft Hyper-V, and OpenStack

  • Physical Appliances

Refer to the CipherTrust Manager Deployment Guide for the complete list of supported environments and deployment instructions.

Supported Internet Browsers

The CCKM supports the following Internet browsers:

  • Chrome 51.0.2704 (64-bit) or later

  • Firefox 45.0 or later

  • Microsoft Edge 91.0.864.37 or later

CCKM Functionality

The CCKM provides following functionalities for the supported cloud services:

  • Life cycle management of keys, key versions, and attributes:

    • View Keys

    • Update Keys

    • Upload Keys

    • Rotate Keys

    • Delete Keys

  • Disaster recovery of keys:

    • Backup Keys

    • Restore Keys

  • Hybrid key management:

    • On-premise keys storage

    • Management of both keys originating from trusted key sources and cloud-provider-sourced keys

    • Key synchronization

  • Compliance management:

    • On-premise key storage with up to FIPS 140-2 Level 3 certification (CipherTrust Manager K570 with K7 card, Luna Network HSM, DSM)

    • Key storage in public or private clouds, inaccessible to cloud services with FIPS 140-2 Level 1 (Luna Network HSM, DSM)

  • Key visibility reporting:

    • Key Activity Report: Inspect individual key histories by operations, for example, when they were refreshed, rotated, edited, or deleted. Also, use this report to compare key activities between CCKM and a cloud service.

    • Key Aging Report: Track keys by their expiration dates. Audit a range of dates, from past material deletions to future scheduled deletions, within a cloud service.

    • Service/Usage Report: Monitor key usage by tracking services and applications consuming the keys. View when and where a service requests the use of each key.

    Reporting is not supported for the Azure Stack cloud. All clouds do not support all types of reports. Refer to related sections of the CCKM documentation for cloud-specific reports.

User Roles

CCKM has the following users with different responsibilities in administering and using the resources of supported clouds and key sources.

CCKM Admins

There is a System Defined Group named "CCKM Admins". Users within the "CCKM Admins" group are CCKM Administrators. Additionally, the CCKM administrators need the Key Users, Connection Admins, and User Admins permissions to perform key operations on the supported clouds.

A CCKM Administrator is responsible for creating and managing the following resources:

  • AWS KMS Accounts, AWS Keys

  • Azure Key Vaults, Azure Subscriptions, and Azure Keys

  • Luna HSM Partitions, Luna Keys

  • DSM Domains, DSM Keys

  • Google Cloud Projects, Key Rings, and Keys

  • Google EKM endpoints

  • Salesforce Organizations, Tenant Secrets

  • SAP Groups, SAP Keys

  • CCKM Schedules

  • CCKM Reports

CCKM Users

There is a System Defined Group named "CCKM Users". CCKM users registered with the CipherTrust Manager are part of this group. Additionally, the CCKM users need the Key Users permissions to perform key operations on the supported clouds.

Proxy Configuration

If you plan to run the CipherTrust Manager appliance behind a proxy, you must configure the proxy, as described in Proxy Configuration.

For CCKM, configure an HTTPS proxy.

For the list of URLs to be whitelisted, refer to URLs to Whitelist for Running CipherTrust Manager Behind Proxy.

Now, you should be able to connect CCKM with the cloud through the proxy.

URLs to Whitelist for Running CipherTrust Manager Behind Proxy

The following URLs must be whitelisted before you run the CipherTrust Manager behind a proxy.

Amazon Web Services

ServiceURLPurpose
CloudWatchLogslogs.<region-name>.amazonaws.comFetch AWS reports.
EC2ec2.amazonaws.comRequired to fetch AWS regions. After all the regions are fetched, the service is no longer needed.
EC2ec2.us-east-1.amazonaws.comRequired to fetch AWS regions. After all the regions are fetched, the service is no longer needed.
EC2ec2.<region-name>.amazonaws.comRequired to fetch AWS regions. This URL is used if aws_sts_regional_endpoints is set to regional when adding an AWS connection. After all the regions are fetched, the service is no longer needed.
KMSkms.<region-name>.amazonaws.comCommunicate with AWS KMS for key management.
STSsts.amazonaws.comAuthenticate AWS users.
STSsts.<region-name>.amazonaws.comAuthenticate AWS users. This URL is used if aws_sts_regional_endpoints is set to regional when adding an AWS connection.

AWS GovCloud

ServiceURLPurpose
CloudWatchLogslogs.<region-name>.amazonaws.comFetch AWS reports.
EC2ec2.amazonaws.comRequired to fetch AWS regions. After all the regions are fetched, the service is no longer needed.
EC2ec2.us-gov-east-1.amazonaws.comRequired to fetch AWS regions. After all the regions are fetched, the service is no longer needed.
EC2ec2.<region-name>.amazonaws.comRequired to fetch AWS regions. This URL is used if aws_sts_regional_endpoints is set to regional when adding an AWS connection. After all the regions are fetched, the service is no longer needed.
KMSkms.<region-name>.amazonaws.comCommunicate with AWS KMS for key management.
STSsts.us-gov-east-1.amazonaws.comAuthenticate AWS users.
STSsts.<region-name>.amazonaws.comAuthenticate AWS users. This URL is used if aws_sts_regional_endpoints is set to regional when adding an AWS connection.

AWS China Cloud

ServiceURLPurpose
CloudWatchLogslogs.<region-name>.amazonaws.com.cnFetch AWS reports.
EC2ec2.amazonaws.com.cnRequired to fetch AWS regions. After all the regions are fetched, the service is no longer needed.
EC2ec2.cn-north-1.amazonaws.com.cnRequired to fetch AWS regions. After all the regions are fetched, the service is no longer needed.
EC2ec2.<region-name>.amazonaws.com.cnRequired to fetch AWS regions. This URL is used if aws_sts_regional_endpoints is set to regional when adding an AWS connection. After all the regions are fetched, the service is no longer needed.
KMSkms.<region-name>.amazonaws.com.cnCommunicate with AWS KMS for key management.
STSsts.cn-north-1.amazonaws.com.cnAuthenticate AWS users.
STSsts.<region-name>.amazonaws.com.cnAuthenticate AWS users. This URL is used if aws_sts_regional_endpoints is set to regional when adding an AWS connection.

Azure Public Cloud

URLPurpose
management.azure.comFetch subscriptions and key vaults
login.microsoftonline.comAuthenticate Azure credentials
graph.windows.netFor Azure Stack
vault.azure.netManage keys
api.loganalytics.ioFetch Azure reports
managedhsm.azure.netManage keys

Azure US Gov Cloud

URLPurpose
management.core.usgovcloudapi.netFetch subscriptions and key vaults
management.usgovcloudapi.netFetch subscriptions and key vaults
login.microsoftonline.usAuthenticate Azure credentials
vault.usgovcloudapi.netManage keys
graph.windows.netFor Azure Stack
api.loganalytics.usFetch Azure reports

Azure China Cloud

URLPurpose
management.core.chinacloudapi.cnFetch subscriptions and key vaults
management.chinacloudapi.cnFetch subscriptions and key vaults
login.chinacloudapi.cnAuthenticate Azure credentials
vault.azure.cnManage keys
graph.chinacloudapi.cnFor Azure Stack

Google Cloud CMEK

URLPurpose
https://oauth2.googleapis.comAuthenticate Google cloud service accounts
https://cloudresourcemanager.googleapis.comFetch Google cloud projects
https://cloudkms.googleapis.comManage Google cloud keys, and fetch Google cloud locations and key rings
https://logging.googleapis.comFetch Google cloud reports

Google Workspace CSE

URLPurpose
https://www.googleapis.com/Verify and validate authentication and authorization JWTs
https://admin.google.com• Configure endpoint URLs and Identity Provider (IdP) settings on the Google Admin Console
• Cross-Origin Resource Sharing (CORS) URL to allow requests from the Origin URL
https://krahsc.google.comCORS URL to allow requests from the Origin URL
https://client-side-encryption.google.comCORS URL to allow requests from the Origin URL
https://docs.google.comEncrypt and decrypt Google Docs
https://drive.google.comEncrypt and decrypt Google Drive
https://meet.google.comEncrypt and decrypt Google Meet calls
https://calendar.google.comEncrypt and decrypt Google Calendar events

Oracle Cloud

ServiceURLPurpose
Auditaudit.<region>.oraclecloud.comFetch OCI audit logs that will be used for OCI report generation.
Identityidentity.<region>.oci.oraclecloud.comRequired to test connection and fetch Oracle compartments and other related resources.
Vault (KMS)kms.<region>.oraclecloud.comCommunicate with OCI vaults for key management.
Object Storageobjectstorage.<region>.oraclecloud.comCommunicate with OCI buckets for key backup/restore.

Salesforce Cloud

URLPurpose
login.salesforce.comAuthenticate Salesforce user credentials
test.salesforce.comVerify SFDC Sandbox users (used to test connection with the Salesforce Sandbox)
<YourInstance>.salesforce.comManage keys

SAP Data Custodian

ServiceURLPurpose
KMS<instance-subdomain>.datacustodian.cloud.sapCommunicate with SAP KMS for authorization, audit, cryptography, keys, groups, and backups.

Connecting CCKM in Amazon Virtual Private Cloud (VPC)

When AWS KMS is in Amazon VPC, CCKM cannot connect with the EC2, KMS, and STS services using public IP addresses. You cannot add AWS connections and AWS keys on the CipherTrust Manager. For successful connection, add the IP addresses of VPC endpoints for these services for your AWS regions to the DNS hosts on the CipherTrust Manager.

For example, you need to add the IP addresses of VPC endpoints of sts.amazonaws.com, ec2.us-east-1.amazonaws.com, and kms.us-east-1.amazonaws.com service URLs to the DNS hosts list.

To add the IP address of a VPC endpoint:

On AWS Console

  1. Create the VPC endpoint for a service.

  2. Copy the DNS name of the service.

  3. Ping the DNS name to find out the associated IP address.

  4. Copy the IP address.

On CipherTrust Manager

  1. Log on to the CipherTrust Manager GUI.

  2. In the left pane, click Admin Settings > DNS Hosts.

  3. Click Add DNS Host.

  4. In the Hostname field, enter the service URL, for example, sts.amazonaws.com.

  5. In the IP Address field, paste the copied IP address.

  6. Click Save.

Similarly, add the DNS host entries for all three services, for all your AWS regions.