page_title	subcategory	description
CipherTrust Provider		The CipherTrust provider can be used configure a CipherTrust instance or cluster or a CipherTrust Data Security Platform as a Service (CDSPaaS) and subsequently manage cloud resources.

CipherTrust Provider

Use the navigation to the left to read about the available resources.

Sample scripts allow you to easily create CipherTrust Manager resources for your cloud and includes some practical examples of using the CipherTrust provider with other cloud providers.

Supported Clouds

Public Clouds

AWS
Azure
Google Cloud

AWS Deployment

To deploy a Virtual CipherTrust Manager from AWS, you must supply the Amazon Machine Image (AMI), available on the AWS Marketplace or through the Thales Cloud Provisioning System. The cluster example in dev_examples demonstrates launching CipherTrust Manager images from AWS.

Azure Deployment

List the available versions with Get-AzVMImage -location eastus2 -PublisherName thalesdiscplusainc1596561677238 -Offer cm_k170v -sku ciphertrust_manager.
Obtain image information for a particular version with az vm image show --location eastus2 --urn thalesdiscplusainc1596561677238:cm_k170v:ciphertrust_manager:<desired-version>. Under plan, obtain the required values for name, product and publisher.
Consult azurerm provider documentation for details on creating a plan to launch a Linux Virtual Machine with the azurerm provider.

Google Cloud Deployment

List the available CipherTrust Manager versions with gcloud compute images list --no-standard-images --project=thales-cpl-public. CipherTrust Manager image names start with the prefix k170v. Copy the NAME of the image you would like to deploy.
Consult Google Cloud Platform provider documentation for details on launching a Virtual Machine image with the GCP provider.

Thales Devices

The following devices can be used to create keys for the above public clouds.

CipherTrust Manager
DSM
HSM Luna

Provider Initialization

All CipherTrust Provider parameters can be provided in :

The provider block of the terraform script
A configuration file ~/.ciphertrust/config

CipherTrust authentication parameters can also be provided as environment variables.

The following table illustrates which parameters can be provided as environment variables or in the configuration file.

Provider Parameter	Environment Variable	Config File	Required	Default Value
address	CM_ADDRESS	address	Yes	N/A
username	CM_USERNAME	username	Yes	N/A
password	CM_PASSWORD	password	Yes	N/A
domain	CM_DOMAIN	domain	No	Empty string (root domain)
auth_domain	CM_AUTH_DOMAIN	auth_domain	No	Empty string (root domain)
remaining parameters	no	yes	No	N/A

The order of precedence when determining the value of a provider parameter:

Provider Block
Environment Variable
Configuration File

Provider Block

For CipherTrust Manager

To authenticate to and log in to the root domain:

provider "ciphertrust" {
  address  = "cm-address"
  username = "cm-username"
  password = "cm-password"
}

To authenticate to and log in to a domain other than root:

provider "ciphertrust" {
  address      = "cm-address"
  username     = "cm-username"
  password     = "cm-password"
  auth_domain  = "users-auth-domain" 
}

To authenticate to a domain but log in to a different domain:

provider "ciphertrust" {
  address      = "cm-address"
  username     = "cm-username"
  password     = "cm-password"
  auth_domain  = "users-auth-domain"
  domain       = "a-different-domain"
}

For CipherTrust Data Security Platform as a Service (CDSPaaS)

provider "ciphertrust" {
  address     = "cdsp-address"
  username    = "cdsp-tenant-username"
  password    = "cdsp-tenant-password"
  auth_domain = "cdsp-tenant-name"
}

Configuration File

All provider parameters can be read from the configuration file.

The configuration file is ~/.ciphertrust/config. For example:

  address = cm-address
  username = cm-username
  password = cm-password

If authentication values exist in the configuration file the provider block can be:

provider "ciphertrust" {}

Environment variables

Some provider parameters can be specified in environment variables.

export CM_USERNAME=cm-username
export CM_PASSWORD=cm-password
export CM_AUTH_DOMAIN=cm-auth-domain
export CM_DOMAIN=cm-domain

If environment variables required for authentication exist the provider block can be:

provider "ciphertrust" {}

Schema

Required

username (String) Username of a CipherTrust user. username can be set in the provider block, via the CM_USERNAME environment variable or in ~/.ciphertrust/config
password (String, Sensitive) Password of a CipherTrust user. password can be set in the provider block, via the CM_PASSWORD environment variable or in ~/.ciphertrust/config

Optional

address (String) HTTPS URL of the CipherTrust instance. address can be set in the provider block, via the CM_ADDRESS environment variable or in ~/.ciphertrust/config. An address need not be provided when creating a cluster of CipherTrust instances.
auth_domain (String) CipherTrust authentication domain of the user. This is the domain where the user was created. auth_domain can be set in the provider block, via the CM_AUTH_DOMAIN environment variable or in ~/.ciphertrust/config. Default is the empty string (root domain).
aws_operation_timeout (Number) Some AWS key operations, for example, replication, can take some time to complete. This specifies how long to wait for an operation to complete in seconds. aws_operation_timeout can be set in the provider block or in ~/.ciphertrust/config. Default is 480.
azure_operation_timeout (Number) Azure key operations can take time to complete. This specifies how long to wait for an operation to complete in seconds. azure_operation_timeout can be set in the provider block or in ~/.ciphertrust/config. Default is 240.
domain (String) CipherTrust domain to log in to. domain can be set in the provider block, via the CM_DOMAIN environment variable or in ~/.ciphertrust/config. Default is the root domain.
gcp_operation_timeout (Number) Some Google Cloud operations, for example, schedule destroy, are not synchronous. This specifies how long to wait for an operation to complete in seconds. gcp_operation_timeout can be set in the provider block or in ~/.ciphertrust/config. Default is 120.
hsm_operation_timeout (Number) HSM connection operations are not synchronous. This specifies how long to wait for an operation to complete in seconds. hsm_operation_timeout can be set in the provider block or in ~/.ciphertrust/config. Default is 60.
log_file (String) Log file name. log_file can be set in the provider block or in ~/.ciphertrust/config. Default is ctp.log.
log_level (String) Logging level. log_level can be set in the provider block or in ~/.ciphertrust/config. Default is info. Options: debug, info, warning or error.
no_ssl_verify (Boolean) Set to false to verify the server's certificate chain and host name. no_ssl_verify can be set in the provider block or in ~/.ciphertrust/config. Default is true.
rest_api_timeout (Number) CipherTrust rest api timeout in seconds. rest_api_timeout can be set in the provider block or in ~/.ciphertrust/config. Default is 60.

Supported resource types

The following table illustrates which resource types are supported in CipherTrust Manager and CipherTrust Data Security Platform as a Service(CDSPaaS).

Resource Type	CipherTrust Manager	CDSPaaS
ciphertrust_aws_cloudhsm_key	yes	yes
ciphertrust_aws_connection	yes	yes
ciphertrust_aws_custom_keystore	yes	yes
ciphertrust_aws_key	yes	yes
ciphertrust_aws_kms	yes	yes
ciphertrust_aws_policy_template	yes	yes
ciphertrust_aws_xks_key	yes	yes
ciphertrust_azure_connection	yes	yes
ciphertrust_azure_key	yes	yes
ciphertrust_azure_vault	yes	yes
ciphertrust_cluster	yes	no
ciphertrust_cm_key	yes	yes
ciphertrust_cte_client	yes	no
ciphertrust_cte_guardpoint	yes	no
ciphertrust_cte_policies	yes	no
ciphertrust_domain	yes	no
ciphertrust_dsm_connection	yes	no
ciphertrust_dsm_domain	yes	no
ciphertrust_dsm_key	yes	no
ciphertrust_ekm_endpoint	yes	yes
ciphertrust_gcp_acl	yes	yes
ciphertrust_gcp_connection	yes	yes
ciphertrust_gcp_key	yes	yes
ciphertrust_gcp_keyring	yes	yes
ciphertrust_google_project	yes	yes
ciphertrust_groups	yes	yes
ciphertrust_gwcse_endpoint	yes	yes
ciphertrust_gwcse_identity	yes	yes
ciphertrust_hsm_connection	yes	no
ciphertrust_hsm_key	yes	no
ciphertrust_hsm_partition	yes	no
ciphertrust_hsm_server	yes	no
ciphertrust_interface	yes	no
ciphertrust_license	yes	no
ciphertrust_log_forwarder	yes	no
ciphertrust_ntp	yes	no
ciphertrust_password_policy	yes	no
ciphertrust_policies	yes	no
ciphertrust_policy_attachments	yes	no
ciphertrust_property	yes	no
ciphertrust_proxy	yes	no
ciphertrust_scheduler	yes	yes
ciphertrust_syslog	yes	no
ciphertrust_user	yes	yes
ciphertrust_virtual_key	yes	no