This PowerShell Module offers simple integration between a PowerShell script and CipherTrust Manager
Download this module (available as CipherTrustManager.zip for simplicity) and put it in the Modules directory on your Windows computer. These Modules are usually put in C:\Users<current user>\Documents\WindowsPowerShell\Modules but you can install it anywhere the $Env:PSModulePath can find it
Import-Module CipherTrustManager -Force -ErrorAction Stop. The -Force will ensure that the module is overwritten if already loaded. The -ErrorAction Stop will abort your script if the module cannot be found.Connect-CipherTrustManager `
-server <ip_address_of_CipherTrust_Manager> `
-user <account_with_access> `
-pass <password_for_that_account>
.
├── README.md
├── CipherTrustManager.psd1 # Module Manafest
├── CipherTrustManager.psm1 # Primary Module (Loads all submodules)
├── CertificateAuthority # A Certificate Authority (CA) issues and installs digital certificates and certificate signing requests (CSR).
│ ├── CipherTrustManager-CAs.psm1 # Module to configure the Certificat Authority (CA).
├── CCKM # CipherTrust Cloud Key Manager can manage the lifecycle of CSP keys as well as create them
│ ├── CipherTrustManager-CCKM-AWSCKS.psm1 # Manage keys within AWS
├── DataProtection # Data protection is a centralized place for all Application and Database encryption configuration.
│ ├── CipherTrustManager-AccessPolicies.psm1 # Manage how a user/app can `access` data through the `Reveal` API
│ ├── CipherTrustManager-ClientProfiles.psm1 # Create the Client Profile of how an Application or Database is protected as seen in `Application Data Protection` tile of CipherTrust Manager
│ ├── CipherTrustManager-CharacterSets.psm1 # A character set is used with format preserving algorithms to define characters that are to be included for protection. For example when encrypting a credit card number a user will want the encrypted data to only contain numbers.
│ ├── CipherTrustManager-DPGPolicies.psm1 # Configure the DPG Policy that contains a set of URLs tied with encryption parameters
│ ├── CipherTrustManager-MaskingFormats.psm1 # Create a set of Masking Formats that determine HOW data will be revealed (e.g. Show last four chars, Hide first six chars)
│ ├── CipherTrustManager-ProtectionPolicies.psm1 # Manage how specific data is protected by defining critical parameters like the cipher and key to use through the `Protect` API
│ ├── CipherTrustManager-UserSets.psm1 # Manage lists of users that can be assigned to HOW data is presented by the `Reveal` API
├── Info # These endpoints allow the user to query for some basic information from CipherTrust Manager - the name, version and model number, vendor of the platform. It is also possible to update the platform name to something that is illustrative to the user.
│ ├── CipherTrustManager-Info.psm1 # Manage System Information inclding ability to change name of CipherTrust Manager server
├── Interfaces # Interfaces are the services the CipherTrust Manager is hosting. Most interfaces are listening on a particular port, but may also represent other input channels, like local shell access or serial port access.
│ ├── CipherTrustManager-Interfaces.psm1 # Manage interfaces
├── Keys # Keys are the cryptographic material used in crypto operations.
│ ├── CipherTrustManager-Keys.psm1 # Manage keys
├── Syslog Connections # Users are unique individuals or systems using the API.
│ ├── CipherTrustManager-SyslogConnections.psm1 # Manage connections to remote syslog servers.
├── Users # Users are unique individuals or systems using the API.
│ ├── CipherTrustManager-Users.psm1 # Manage Users.
└── Utils # Miscellaneous Utilities including managing lifecycle of the Authentication Token (JWT).
└── CipherTrustManager-Utils.psm1
As best we could, we have added documentation and help to the module. To see what a command can do AND get examples:
Get-Help Connect-CipherTrustManager
Get-Help Connect-CipherTrustManager -examples
Get-Help Connect-CipherTrustManager -full