User Guide
Quick Start
Tasks
- Upgrade from PA/CAP to CADP
- Create an NAE Session
- Setting up SSL with CipherTrust Manager
- Add Multiple CipherTrust Manager Servers
- Key Operations
  - Creating a Key
  - Creating a New Version of the Versioned Key
  - Using a Versioned Key to Decrypt, SignV, and MACV
  - Getting an Instance of a Key Object
  - Alternative Method to Get an Instance of a Key Object
  - Deleting a Key using the Key Name
  - Exporting a Key
  - Exporting a Wrapped Key
  - Setting a Key Mode and Padding
  - Getting Attributes of a Key
  - Exporting Versioned Key
  - Fetching Key Version using ID
- Generate and Verify MAC
- Encrypt a String Using an AES Key
- Decrypt a String Using an AES Key
- Encrypt a String Using an RSA Key
- Decrypt a String Using an RSA Key
- Encrypting/Decrypting a File
- Sign and SignVerify Data using an EC Key
- Sign and SignVerify Data using an RSA Key
- Enable Connection Pooling
- Enable Symmetric Key Caching
- Enable Asymmetric Key Caching
- Set Logging Parameters
- Change the Default Value of Connection Timeout
- Setting Transaction ID in Logs
- Logging to Syslog Server
Advanced Topics
- Configuration
  - Network Configuration Parameters
  - Connection Configuration Parameters
  - Caching Parameters
  - Logging Parameters
  - Syslog Advanced Configuration Parameters
  - SSL Configuration Parameters
  - Miscellaneous Configuration Parameters
- Connection Pooling
- Load Balancing Group
- Multi-tier Load Balancing Group
- Symmetric/Asymmetric Key Caching
- Persistent Key Caching
- Supported Services & Operations
- Supported Algorithms
- NAE Supported Functions
  - Supporting Calls
  - Connection Calls
  - Key-related Calls
  - MAC/Hash-related Calls
  - Security Considerations
- Format Preserving Encryption
- FPE/AES/Unicode Cardinality Block-Size Table
- API Definitions
- Key Permissions on Groups
- CryptoDataUtility
Troubleshooting

Getting Attributes of a Key

Call the GetKeyAttributes method to retrieve the attributes of a key.

NaeKeyManagement nkm = new NaeKeyManagement(session);
Dictionary<string, object> SystemAttr = new Dictionary<string, object>();
Dictionary<string, object> CustomAttr = new Dictionary<string, object>();
nkm.GetKeyAttributes(session, keyname, SystemAttr, CustomAttr);

You can also retrieve the information for a specific key version by using version number prefix (#versionNumber).

The following table lists the attributes returned by this method with description.

Attribute	Description
KeyName	Contains the subject of the query.
Keybits	Contains the key size.
KeySize	Contains the key size.
Algorithms	Lists the set of algorithms with which this key can be used.
Algorithm	Contains a standard identifier string for the cryptographic algorithm. See Supported Key Algorithms for more information on supported algorithms and key sizes.
Versioned	Indicates that the key is a versioned key.
Exportable	Indicates that the key is exportable.
Deletable	Indicates that the key is deletable.
Encrypt	Indicates that the key is capable of encryption. Only present and applicable for symmetric keys.
Decrypt	Indicates that the key is capable of decryption. Only present and applicable for symmetric keys.
Sign	Indicates that the key is capable of creating signatures.
SignV	Indicates that the key is capable of verifying signatures.
MAC	Indicates that the key is capable of creating MACs.
MACV	Indicates that the key is capable of verifying MACs.
UsePublic	Indicates that the public portion of the key can encrypt data. Only present and applicable for asymmetric keys.
UsePrivate	Indicates that the private portion of the key can decrypt data. Only present and applicable for asymmetric keys.
Fingerprint	The key's fingerprint.
DefaultIVBase16	The default IV of the key.
KeyVersionNumber	The version number of this key.
KeyVersion State	The state of the key version.
NumKey Versions	The total number of key versions for this key.
NumActive Versions	The number of versions in the active state.
NumRestricted Versions	The number of versions in the restricted state.
NumRetired Versions	The number of versions in the retired state.
NumWipedVersions	The number of versions in the wiped state.
CustomAttributeList	List of custom attributes. The actual values are base64 encoded. This element is not included if the key does not have any associated custom attributes.
KeyCreationDate	The key's creation date and time. The creation date and time displays according to the time zone set on the CipherTrust Application Data Protection for .NET Core.
IsOwner	Present if the User issuing the KeyInfoRequest command is the Key Owner.

Getting Attributes of a Key

On this page

Suggest A Change