AmazonKMS Control

Properties   Methods   Events   Config Settings   Errors  

The AmazonKMS control provides an easy-to-use interface for Amazon's Key Management Service.

Syntax

AmazonKMS

Remarks

The AmazonKMS control makes it easy to work with the Amazon Key Management Service (KMS) in a secure manner using TLS. Amazon KMS allows you to create, manage, and use KMS keys for cryptographic operations. You can also work with aliases, and generate data keys and data key pairs.

To begin, register for an AWS account and obtain an AccessKey and SecretKey to use for authentication. Once one or more KMS keys have been created, either via the AWS console (recommended) or this API, you'll be ready to start using the control to manage and use the KMS keys.

Resource Terminology

As implied above, there are three kinds of resources associated with Amazon KMS. The primary resource type is the AWS KMS key, or "KMS key". KMS keys can be symmetric or asymmetric, and can be used either for encryption and decryption, or signing and verification. KMS keys themselves can never leave the Amazon cloud, they are used for server-side cryptographic operations only. This is a security feature, but it does mean that the amount of data that can be processed in a KMS key-based cryptographic operation is relatively small.

To work around the small server-side cryptographic operation data limit, Amazon KMS also supports the generation of data keys (symmetric) and data key pairs (asymmetric), which can then be used outside of Amazon KMS in order to encrypt/decrypt and sign/verify larger amounts data. KMS itself only generates these keys, it does not track them or make use of them for cryptographic operations. However, it does encrypt the data key (or, for data key pairs, the private key) using a KMS key when it is generated, which means that the key must be decrypted using a KMS key each time it needs to be used. For more information, refer to Amazon's Envelope Encryption description, which details the many security benefits of this strategy.

The last resource is called an alias. Aliases provide friendly names for KMS keys, which can otherwise only be identified by their Id or Amazon resource name (ARN). Since an alias is a standalone resource, it can be created and deleted without affecting the KMS key it refers to. It can also be updated to refer to a different KMS key at any time.

Note: KMS keys and aliases are region-specific resources. That is, KMS keys and aliases cannot be accessed or used outside of the region that they reside in.

Using the Control

KMS keys can be created using the CreateKey method. A KMS key's key spec (i.e., whether it is symmetric or asymmetric, and in the latter case, what kind of asymmetric) and usage (i.e., whether it is for encryption/decryption or signing/verification) must be set at the time of creation, and they cannot be changed later. A description of the KMS key can also be provided when it is created, and can be changed at any time using the UpdateKeyDescription method.

When a KMS key will no longer be used, it can be scheduled for deletion using the ScheduleKeyDeletion method. AWS requires that KMS keys remain in a "pending deletion" state for at least seven days to help ensure that they are truly no longer needed. If at any time during the waiting period it is discovered that the KMS key is still needed, the deletion can be canceled using the CancelKeyDeletion method (KMS keys cannot be used while they are pending deletion). // The CreateKey method returns the Amazon resource name of the newly-created KMS key. string keyArn = kms.CreateKey("SYMMETRIC_DEFAULT", false, "Test key"); // ... Some time later ... // Schedules the KMS key for deletion in 15 days. kms.ScheduleKeyDeletion(keyArn, 15);

Aliases can be created and deleted using the CreateAlias and DeleteAlias methods. Also, while aliases can be updated to refer to a different KMS key at any time during their lifetime. Note that all alias names must begin with the prefix alias/ (but cannot begin with alias/aws/, which is a reserved prefix). kms.CreateAlias("alias/MyTestKey", keyArn); kms.UpdateAlias("alias/MyTestKey", otherKeyArn); kms.DeleteAlias("alias/MyTestKey"); // Only deletes the alias; the KMS key it refers to is unaffected.

To list KMS keys or aliases, use the ListKeys and ListAliases methods. For the former, the IncludeKeyDetails property can optionally be enabled to have the control attempt to retrieve the full information for each KMS key (Amazon only returns the KMS key's ARN and Id while listing). // If there are many KMS keys to list, there may be multiple pages of results. This will // cause all pages of results to be accumulated into the Keys collection property. do { kms.ListKeys(); } while (!string.IsNullOrEmpty(kms.KeyMarker)); foreach (AWSKey key in kms.Keys) { Console.WriteLine(key.ARN); }

Depending on a KMS key's usage, it can be used to perform different cryptographic operations. KMS keys with encryption/decryption usage can be used in Encrypt, Decrypt, and ReEncrypt operations. KMS keys with sign/verify usage can be used in Sign and Verify operations. To perform a cryptographic operation, use InputData or InputFile to supply the input data that should be processed. All operations will output the result data to OutputData or OutputFile (except Verify; refer to its documentation for more information). // Create an asymmetric KMS key with encrypt/decrypt usage. string keyArn = kms.CreateKey("RSA_4096", false, "Encryption Key #237"); // Encrypt the string "Test123" and write the encrypted data to an output file. kms.InputData = "Test123"; kms.OutputFile = "C:/temp/enc.dat"; kms.Encrypt(keyArn, "RSAES_OAEP_SHA_256"); // ...Later, decrypt the data again. kms.InputFile = "C:/temp/enc.dat"; kms.OutputFile = ""; // So that the data will be output to the OutputData property. kms.Decrypt(keyArn, "RSAES_OAEP_SHA_256");

It's important to note that the amount of data that can be processed in server-side cryptographic operations is very small. For signing operations, it is limited to 4096 bytes; for encryption operations, the limit varies based on the selected KMS key's key spec and the selected encryption algorithm (see the Encrypt method's documentation for more information).

To work around this issue, Amazon KMS supports the generation of data keys and data key pairs (described above) which can be used locally to encrypt/decrypt or sign/verify large amounts of data. To generate a data key or a data key pair, call the GenerateDataKey and GenerateDataKeyPair methods. // Generates a data key, including a plaintext copy. // The encrypted copy is encrypted by the specified KMS key. kms.GenerateDataKey("AES_256", keyArn, true); // The resulting information is stored in the following properties: // kms.KeyData.ARN: The ARN of the KMS key used to encrypt the data key. // kms.KeyData.EncryptedKey: The encrypted copy of the data key. // kms.KeyData.KeySpec: The spec of the generated data key. // kms.KeyData.PlaintextKey: The plaintext copy of the data key (if it was requested). // Generates a data key pair, including plaintext copy. // The encrypted copy of the private key is encrypted by the specified KMS key. kms.GenerateDataKeyPair("ECC_NIST_P384", keyArn, true); // The resulting information is stored in the following properties: // kms.KeyData.ARN: The ARN of the KMS key used to encrypt the data key pair's private key. // kms.KeyData.EncryptedKey: The encrypted copy of the private key. // kms.KeyData.KeySpec: The spec of the generated data key pair. // kms.KeyData.PlaintextKey: The plaintext copy of the private key (if it was requested). // kms.KeyData.PublicKey: The data key pair's public key.

The control also supports a variety of other functionality, including:

• Retrieval of an asymmetric KMS key's public key with GetPublicKey.
• Enabling and disabling KMS keys with SetKeyEnabled.
• Automatic rotation of KMS keys with GetKeyRotationStatus and SetKeyRotationStatus.
• Encryption contexts for Encrypt, Decrypt, and ReEncrypt.
• And more!

Property List

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

AccessKey Property (AmazonKMS Control)

The access key to use for authentication.

Syntax

amazonkmscontrol.AccessKey[=string]

Default Value

""

Remarks

This property specifies the access key that should be used for authentication. Both this property and SecretKey must be set before attempting any operations which connect to the server.

Data Type

String

AliasCount Property (AmazonKMS Control)

The number of records in the Alias arrays.

Syntax

amazonkmscontrol.AliasCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• AliasARN
• AliasKeyId
• AliasName

The array indices start at 0 and end at AliasCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

AliasARN Property (AmazonKMS Control)

The Amazon resource name (ARN) of the alias.

Syntax

amazonkmscontrol.AliasARN(AliasIndex)

Default Value

""

Remarks

The Amazon resource name (ARN) of the alias.

This property reflects the Amazon resource name (ARN) of the alias.

The AliasIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AliasCount property.

This property is read-only and not available at design time.

Data Type

String

AliasKeyId Property (AmazonKMS Control)

The Id of the KMS key that the alias is associated with.

Syntax

amazonkmscontrol.AliasKeyId(AliasIndex)

Default Value

""

Remarks

The Id of the KMS key that the alias is associated with.

This property reflects the Id of the KMS key that the alias is associated with.

Note that AWS pre-creates certain aliases, so it is possible for this property to be empty.

The AliasIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AliasCount property.

This property is read-only and not available at design time.

Data Type

String

AliasName Property (AmazonKMS Control)

The name of the alias.

Syntax

amazonkmscontrol.AliasName(AliasIndex)

Default Value

""

Remarks

The name of the alias.

This property reflects the name of the alias, including the alias/ prefix.

The AliasIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AliasCount property.

This property is read-only and not available at design time.

Data Type

String

AliasMarker Property (AmazonKMS Control)

A marker indicating what page of aliases to return next.

Syntax

amazonkmscontrol.AliasMarker[=string]

Default Value

""

Remarks

This property will be populated when ListAliases is called if the results are pages and there are more pages. To list all aliases, continue to call ListAliases until this property returns empty string.

Refer to ListAliases for more information.

This property is not available at design time.

Data Type

String

EncryptionContextCount Property (AmazonKMS Control)

The number of records in the EncryptionContext arrays.

Syntax

amazonkmscontrol.EncryptionContextCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• EncryptionContextName
• EncryptionContextValue

The array indices start at 0 and end at EncryptionContextCount - 1.

This property is not available at design time.

Data Type

Integer

EncryptionContextName Property (AmazonKMS Control)

The name of the context item.

Syntax

amazonkmscontrol.EncryptionContextName(EncryptionContextIndex)[=string]

Default Value

""

Remarks

The name of the context item.

This property specifies the name of the context item.

The EncryptionContextIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionContextCount property.

This property is not available at design time.

Data Type

String

EncryptionContextValue Property (AmazonKMS Control)

The value of the context item.

Syntax

amazonkmscontrol.EncryptionContextValue(EncryptionContextIndex)[=string]

Default Value

""

Remarks

The value of the context item.

This property specifies the value of the context item.

The EncryptionContextIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionContextCount property.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (AmazonKMS Control)

Whether to automatically detect and use firewall system settings, if available.

Syntax

amazonkmscontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (AmazonKMS Control)

The type of firewall to connect through.

Syntax

amazonkmscontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (AmazonKMS Control)

The name or IP address of the firewall (optional).

Syntax

amazonkmscontrol.FirewallHost[=string]

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (AmazonKMS Control)

A password if authentication is to be used when connecting through the firewall.

Syntax

amazonkmscontrol.FirewallPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (AmazonKMS Control)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

amazonkmscontrol.FirewallPort[=integer]

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (AmazonKMS Control)

A username if authentication is to be used when connecting through a firewall.

Syntax

amazonkmscontrol.FirewallUser[=string]

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

Idle Property (AmazonKMS Control)

The current status of the control.

Syntax

amazonkmscontrol.Idle

Default Value

True

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

IncludeKeyDetails Property (AmazonKMS Control)

Whether to attempt to retrieve full details when listing KMS keys.

Syntax

amazonkmscontrol.IncludeKeyDetails[=boolean]

Default Value

False

Remarks

This property specifies whether the control should make additional requests when ListKeys is called in order to retrieve full information for each KMS key. By default, Amazon will only return the KeyARN and KeyId of each KMS key.

If this property is enabled, then after the initial listing is returned, the control will call GetKeyInfo internally for each KMS key returned. For all KMS keys for which this call is successful, the additional information will be used to populate the Keys properties. Any KMS keys for which the GetKeyInfo call fails will only have their KeyARN and KeyId properties populated, as usual.

This property is not available at design time.

Data Type

Boolean

InputData Property (AmazonKMS Control)

The data to process.

Syntax

amazonkmscontrol.InputData[=string]

Default Value

""

Remarks

This property specifies the data that should be processed in a cryptographic operation.

Input Sources & Output Destinations

The control automatically determines the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

1. The InputFile property
2. The InputData property

The first valid input source found is used. The order in which the output properties are considered is as follows:

1. The OutputFile property
2. The OutputData property

To read or write binary data to the property, a Variant (Byte Array) version is provided in .InputDataB.

This property is not available at design time.

Data Type

Binary String

InputFile Property (AmazonKMS Control)

The file whose data should be processed.

Syntax

amazonkmscontrol.InputFile[=string]

Default Value

""

Remarks

This property specifies the file whose data should be processed in a cryptographic operation. It accepts both absolute and relative file paths.

Input Sources & Output Destinations

The control automatically determines the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

1. The InputFile property
2. The InputData property

The first valid input source found is used. The order in which the output properties are considered is as follows:

1. The OutputFile property
2. The OutputData property

Data Type

String

KeyDataAlgorithms Property (AmazonKMS Control)

The algorithms supported by the public key.

Syntax

amazonkmscontrol.KeyDataAlgorithms

Default Value

""

Remarks

The algorithms supported by the public key.

When GetPublicKey is called, this property will contain a comma-separated list of algorithms that the KeyPublicKey can be used with. Always empty when GenerateDataKey or GenerateDataKeyPair is called.

If KeyForSigning is , possible values are:

• SYMMETRIC_DEFAULT
• RSAES_OAEP_SHA_1
• RSAES_OAEP_SHA_256

If KeyForSigning is , possible values are:

• RSASSA_PSS_SHA_256
• RSASSA_PSS_SHA_384
• RSASSA_PSS_SHA_512
• RSASSA_PKCS1_V1_5_SHA_256
• RSASSA_PKCS1_V1_5_SHA_384
• RSASSA_PKCS1_V1_5_SHA_512
• ECDSA_SHA_256
• ECDSA_SHA_384
• ECDSA_SHA_512

This property is read-only and not available at design time.

Data Type

String

KeyDataARN Property (AmazonKMS Control)

The Amazon resource name (ARN) of the associated KMS key.

Syntax

amazonkmscontrol.KeyDataARN

Default Value

""

Remarks

The Amazon resource name (ARN) of the associated KMS key.

When GetPublicKey is called, this property reflects the Amazon resource name (ARN) of the KMS key whose KeyPublicKey was downloaded.

When GenerateDataKey or GenerateDataKeyPair is called, this property reflects the ARN of the KMS key that encrypted the data key or the data key pair's private key (respectively) that is stored in KeyEncryptedKey.

This property is read-only and not available at design time.

Data Type

String

KeyDataEncryptedKey Property (AmazonKMS Control)

The encrypted key or private key data.

Syntax

amazonkmscontrol.KeyDataEncryptedKey

Default Value

""

Remarks

The encrypted key or private key data.

When GenerateDataKey is called, this property reflects the encrypted data key that was downloaded. When GenerateDataKeyPair is called, this property reflects the encrypted private key of the data key pair that was downloaded.

In the case of GenerateDataKeyPair, note that the actual private key data will be in DER format upon decryption. It is up to the application to convert it to another format after decryption if necessary.

Always empty when GetPublicKey is called.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyDataEncryptedKeyB.

This property is read-only and not available at design time.

Data Type

Binary String

KeyDataForSigning Property (AmazonKMS Control)

Whether the public key is for signing or encryption.

Syntax

amazonkmscontrol.KeyDataForSigning

Default Value

False

Remarks

Whether the public key is for signing or encryption.

When GetPublicKey is called, this property reflects whether the downloaded KeyPublicKey is to be used for verification () or encryption ().

Always when GenerateDataKey or GenerateDataKeyPair is called.

This property is read-only and not available at design time.

Data Type

Boolean

KeyDataKeySpec Property (AmazonKMS Control)

The key spec of the downloaded key data.

Syntax

amazonkmscontrol.KeyDataKeySpec

Default Value

""

Remarks

The key spec of the downloaded key data.

When GetPublicKey is called, this property reflects the spec of the KMS key whose KeyPublicKey was downloaded, and the possible values are:

• RSA_2048
• RSA_3072
• RSA_4096
• ECC_NIST_P256 (secp256r1)
• ECC_NIST_P384 (secp384r1)
• ECC_NIST_P521 (secp521r1)
• ECC_SECG_P256K1 (secp256k1)

When GenerateDataKey is called, this property reflects either the spec of the data key or the size of the data key in bytes (whichever was passed to the method); one of:

• AES_128
• AES_256
• Some number of bytes in the range 1 to 1024 (e.g., 64)

When GenerateDataKeyPair is called, this property reflects the spec of the data key pair, and the possible values are the same as they are for GetPublicKey.

This property is read-only and not available at design time.

Data Type

String

KeyDataPlaintextKey Property (AmazonKMS Control)

The plaintext key or private key data.

Syntax

amazonkmscontrol.KeyDataPlaintextKey

Default Value

""

Remarks

The plaintext key or private key data.

If, when GenerateDataKey or GenerateDataKeyPair is called, the IncludePlaintext parameter was , this property will reflect the plaintext data key or private key of the data key pair (respectively) that was downloaded. Otherwise, it will be empty.

In the case of GenerateDataKeyPair, this property exposes the private key in PEM format for convenience.

Always empty when GetPublicKey is called.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .KeyDataPlaintextKeyB.

This property is read-only and not available at design time.

Data Type

Binary String

KeyDataPublicKey Property (AmazonKMS Control)

The public key.

Syntax

amazonkmscontrol.KeyDataPublicKey

Default Value

""

Remarks

The public key.

When GetPublicKey is called, this property will reflect the public key of the KMS key. When GenerateDataKeyPair is called, this property will reflect the public key of the data key pair. The public key is exposed in PEM format for convenience.

Always empty when GenerateDataKey is called.

This property is read-only and not available at design time.

Data Type

String

KeyMarker Property (AmazonKMS Control)

A marker indicating what page of KMS keys to return next.

Syntax

amazonkmscontrol.KeyMarker[=string]

Default Value

""

Remarks

This property will be populated when ListKeys is called if the results are paged and there are more pages. To list all KMS keys, continue to call ListKeys until this property returns empty string.

Refer to ListKeys for more information.

This property is not available at design time.

Data Type

String

KeyCount Property (AmazonKMS Control)

The number of records in the Key arrays.

Syntax

amazonkmscontrol.KeyCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• KeyAccountId
• KeyAlgorithms
• KeyARN
• KeyAWSManaged
• KeyCloudHSMClusterId
• KeyCreationDate
• KeyCustomKeyStoreId
• KeyDataAlgorithms
• KeyDataARN
• KeyDataEncryptedKey
• KeyDataForSigning
• KeyDataKeySpec
• KeyDataPlaintextKey
• KeyDataPublicKey
• KeyDeletionDate
• KeyDescription
• KeyEnabled
• KeyExpirationDate
• KeyForSigning
• KeyId
• KeyKeySpec
• KeyOrigin
• KeyState

The array indices start at 0 and end at KeyCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

KeyAccountId Property (AmazonKMS Control)

The Id of the AWS account that owns the KMS key.

Syntax

amazonkmscontrol.KeyAccountId(KeyIndex)

Default Value

""

Remarks

The Id of the AWS account that owns the KMS key.

This property reflects the Id of the AWS account that owns the KMS key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyAlgorithms Property (AmazonKMS Control)

A comma-separated list of algorithms that the KMS key supports.

Syntax

amazonkmscontrol.KeyAlgorithms(KeyIndex)

Default Value

""

Remarks

A comma-separated list of algorithms that the KMS key supports.

This property reflects a comma-separated list of algorithms that the KMS key supports.

If KeyForSigning is , possible values are:

• SYMMETRIC_DEFAULT
• RSAES_OAEP_SHA_1
• RSAES_OAEP_SHA_256

If KeyForSigning is , possible values are:

• RSASSA_PSS_SHA_256
• RSASSA_PSS_SHA_384
• RSASSA_PSS_SHA_512
• RSASSA_PKCS1_V1_5_SHA_256
• RSASSA_PKCS1_V1_5_SHA_384
• RSASSA_PKCS1_V1_5_SHA_512
• ECDSA_SHA_256
• ECDSA_SHA_384
• ECDSA_SHA_512

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyARN Property (AmazonKMS Control)

The Amazon resource name (ARN) of the KMS key.

Syntax

amazonkmscontrol.KeyARN(KeyIndex)

Default Value

""

Remarks

The Amazon resource name (ARN) of the KMS key.

This property reflects the Amazon resource name (ARN) of the KMS key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyAWSManaged Property (AmazonKMS Control)

Whether the KMS key is AWS-managed.

Syntax

amazonkmscontrol.KeyAWSManaged(KeyIndex)

Default Value

False

Remarks

Whether the KMS key is AWS-managed.

This property reflects whether the KMS key is AWS-managed () or customer-managed ().

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyCloudHSMClusterId Property (AmazonKMS Control)

The Id of the CloudHSM cluster the KMS key's key material resides in, if applicable.

Syntax

amazonkmscontrol.KeyCloudHSMClusterId(KeyIndex)

Default Value

""

Remarks

The Id of the CloudHSM cluster the KMS key's key material resides in, if applicable.

If the KMS key resides in a custom key store, this property reflects the Id of the CloudHSM that the KMS key's key material resides in.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyCreationDate Property (AmazonKMS Control)

The creation date of the KMS key.

Syntax

amazonkmscontrol.KeyCreationDate(KeyIndex)

Default Value

""

Remarks

The creation date of the KMS key.

This property reflects the creation date of the KMS key, in seconds since the Unix epoch (including fractional seconds).

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyCustomKeyStoreId Property (AmazonKMS Control)

The Id of the custom key store that the KMS key resides in, if applicable.

Syntax

amazonkmscontrol.KeyCustomKeyStoreId(KeyIndex)

Default Value

""

Remarks

The Id of the custom key store that the KMS key resides in, if applicable.

If the KMS key resides in a custom key store, this property reflects the Id of said custom key store.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyDeletionDate Property (AmazonKMS Control)

The date at which the KMS key will be deleted, if applicable.

Syntax

amazonkmscontrol.KeyDeletionDate(KeyIndex)

Default Value

""

Remarks

The date at which the KMS key will be deleted, if applicable.

If the KMS key's KeyState is aksPendingDeletion (2), this property will reflect the deletion date, in seconds since the Unix epoch (including fractional seconds).

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyDescription Property (AmazonKMS Control)

The KMS key's description.

Syntax

amazonkmscontrol.KeyDescription(KeyIndex)

Default Value

""

Remarks

The KMS key's description.

This property reflects the KMS key's description. To change a KMS key's description, use the UpdateKeyDescription method.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyEnabled Property (AmazonKMS Control)

Whether the KMS key is enabled.

Syntax

amazonkmscontrol.KeyEnabled(KeyIndex)

Default Value

False

Remarks

Whether the KMS key is enabled.

This property reflects whether the KMS key is currently enabled.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyExpirationDate Property (AmazonKMS Control)

The date at which the KMS key's key material will expire, if applicable.

Syntax

amazonkmscontrol.KeyExpirationDate(KeyIndex)

Default Value

""

Remarks

The date at which the KMS key's key material will expire, if applicable.

If the KMS key's key material KeyOrigin is akoExternal (1), and the external key material has an expiration date, this property will reflect said date, in seconds since the Unix epoch (including fractional seconds).

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyForSigning Property (AmazonKMS Control)

Whether the KMS key is for signing or encryption.

Syntax

amazonkmscontrol.KeyForSigning(KeyIndex)

Default Value

False

Remarks

Whether the KMS key is for signing or encryption.

This property reflects whether the KMS key's usage is signing/verification () or encryption/decryption ().

A KMS key's usage determines which cryptographic operations it can be used for. For example, a KMS key with signing/verification usage can be used for Sign and Verify operations, but not for Encrypt, Decrypt or ReEncrypt operations.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Boolean

KeyId Property (AmazonKMS Control)

The Id of the KMS key.

Syntax

amazonkmscontrol.KeyId(KeyIndex)

Default Value

""

Remarks

The Id of the KMS key.

This property reflects the Id of the KMS key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyKeySpec Property (AmazonKMS Control)

The key spec of the KMS key.

Syntax

amazonkmscontrol.KeyKeySpec(KeyIndex)

Default Value

""

Remarks

The key spec of the KMS key.

This property reflects the key spec of the KMS key. For symmetric KMS keys, the only possible value is SYMMETRIC_DEFAULT which, according to the Amazon KMS documentation, is based on AES-256-GCM. For asymmetric KMS keys, possible values are:

• RSA_2048
• RSA_3072
• RSA_4096
• ECC_NIST_P256 (secp256r1)
• ECC_NIST_P384 (secp384r1)
• ECC_NIST_P521 (secp521r1)
• ECC_SECG_P256K1 (secp256k1)

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String

KeyOrigin Property (AmazonKMS Control)

The origin of the KMS key's key material.

Syntax

amazonkmscontrol.KeyOrigin(KeyIndex)

Possible Values

akoKMS(0), 
akoExternal(1), 
akoCloudHSM(2)

Default Value

0

Remarks

The origin of the KMS key's key material.

This property reflects the origin of the KMS key's key material. Possible values are:

• akoKMS (0): Key material from Amazon KMS. (Also the default value used when ListKeys is called.)
• akoExternal (1): External key material imported into Amazon KMS.
• akoCloudHSM (2): Key material from an Amazon CloudHSM cluster.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Integer

KeyState Property (AmazonKMS Control)

The KMS key's state.

Syntax

amazonkmscontrol.KeyState(KeyIndex)

Possible Values

aksEnabled(0), 
aksDisabled(1), 
aksPendingDeletion(2), 
aksPendingImport(3), 
aksUnavailable(4)

Default Value

0

Remarks

The KMS key's state.

This property reflects the KMS key's state. Possible values are:

• aksEnabled (0): The KMS key is enabled and ready for use. (Also the default value used when ListKeys is called.)
• aksDisabled (1): The KMS key is disabled and cannot be used until it is enabled again.
• aksPendingDeletion (2): The KMS key is pending deletion and cannot be used unless the deletion is canceled.
• aksPendingImport (3): The KMS key has been created, but external key material has not yet been imported into it, so it cannot be used.
• aksUnavailable (4): The KMS key is currently unavailable because the CloudHSM cluster that contains its key material has been disconnected from Amazon KMS.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Integer

LocalHost Property (AmazonKMS Control)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

amazonkmscontrol.LocalHost[=string]

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the control is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

OtherHeaders Property (AmazonKMS Control)

Other headers as determined by the user (optional).

Syntax

amazonkmscontrol.OtherHeaders[=string]

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF (Chr$(13) & Chr$(10)) .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the control beyond what is provided.

This property is not available at design time.

Data Type

String

OutputData Property (AmazonKMS Control)

The output data.

Syntax

amazonkmscontrol.OutputData[=string]

Default Value

""

Remarks

This property is populated with the data that was output from a successful cryptographic operation.

Note: For the Verify operation, this property functions as a secondary input property instead (along with InputData); refer to the Verify method for more information.

Input Sources & Output Destinations

The control automatically determines the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

1. The InputFile property
2. The InputData property

The first valid input source found is used. The order in which the output properties are considered is as follows:

1. The OutputFile property
2. The OutputData property

To read or write binary data to the property, a Variant (Byte Array) version is provided in .OutputDataB.

This property is not available at design time.

Data Type

Binary String

OutputFile Property (AmazonKMS Control)

The file to which output data should be written.

Syntax

amazonkmscontrol.OutputFile[=string]

Default Value

""

Remarks

This property specifies the file to which data output from a successful cryptographic operation should be written.

Note: For the Verify operation, the specified file functions as a secondary input file instead (along with InputFile); refer to the Verify method for more information.

Input Sources & Output Destinations

The control automatically determines the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

1. The InputFile property
2. The InputData property

The first valid input source found is used. The order in which the output properties are considered is as follows:

1. The OutputFile property
2. The OutputData property

Data Type

String

Overwrite Property (AmazonKMS Control)

Whether the output file should be overwritten if necessary.

Syntax

amazonkmscontrol.Overwrite[=boolean]

Default Value

False

Remarks

This property controls whether the specified OutputFile should be overwritten if it already exists.

Data Type

Boolean

ParsedHeaderCount Property (AmazonKMS Control)

The number of records in the ParsedHeader arrays.

Syntax

amazonkmscontrol.ParsedHeaderCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ParsedHeaderField Property (AmazonKMS Control)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

amazonkmscontrol.ParsedHeaderField(ParsedHeaderIndex)

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderValue Property (AmazonKMS Control)

This property contains the header contents.

Syntax

amazonkmscontrol.ParsedHeaderValue(ParsedHeaderIndex)

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ProxyAuthScheme Property (AmazonKMS Control)

The type of authorization to perform when connecting to the proxy.

Syntax

amazonkmscontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the control will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (AmazonKMS Control)

Whether to automatically detect and use proxy system settings, if available.

Syntax

amazonkmscontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (AmazonKMS Control)

A password if authentication is to be used for the proxy.

Syntax

amazonkmscontrol.ProxyPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (AmazonKMS Control)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

amazonkmscontrol.ProxyPort[=integer]

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (AmazonKMS Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

amazonkmscontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (AmazonKMS Control)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

amazonkmscontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (AmazonKMS Control)

A username if authentication is to be used for the proxy.

Syntax

amazonkmscontrol.ProxyUser[=string]

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

QueryParamCount Property (AmazonKMS Control)

The number of records in the QueryParam arrays.

Syntax

amazonkmscontrol.QueryParamCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

The array indices start at 0 and end at QueryParamCount - 1.

This property is not available at design time.

Data Type

Integer

QueryParamName Property (AmazonKMS Control)

The name of the query parameter.

Syntax

amazonkmscontrol.QueryParamName(QueryParamIndex)[=string]

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

QueryParamValue Property (AmazonKMS Control)

The value of the query parameter.

Syntax

amazonkmscontrol.QueryParamValue(QueryParamIndex)[=string]

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The control will automatically URL-encode this value when sending the request.

The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

Region Property (AmazonKMS Control)

The region that the control will make requests against.

Syntax

amazonkmscontrol.Region[=string]

Default Value

"us-east-1"

Remarks

This property controls which region the control will make requests against. By default the control uses us-east-1, the US East (N. Virginia) region. This property should be changed in order to create or access resources in other regions, as KMS keys and aliases are region-specific resources.

Regions:

The control will always convert this property's value to lowercase. If this property is cleared, the control will reset it to the default value.

Data Type

String

SecretKey Property (AmazonKMS Control)

The secret key to use for authentication.

Syntax

amazonkmscontrol.SecretKey[=string]

Default Value

""

Remarks

This property specifies the secret key that should be used for authentication. Both this property and AccessKey must be set before attempting any operations which connect to the server.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (AmazonKMS Control)

The date on which this certificate becomes valid.

Syntax

amazonkmscontrol.SSLAcceptServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (AmazonKMS Control)

The date on which the certificate expires.

Syntax

amazonkmscontrol.SSLAcceptServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (AmazonKMS Control)

A comma-delimited list of extended key usage identifiers.

Syntax

amazonkmscontrol.SSLAcceptServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (AmazonKMS Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

amazonkmscontrol.SSLAcceptServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (AmazonKMS Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

amazonkmscontrol.SSLAcceptServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (AmazonKMS Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

amazonkmscontrol.SSLAcceptServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (AmazonKMS Control)

The issuer of the certificate.

Syntax

amazonkmscontrol.SSLAcceptServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (AmazonKMS Control)

The private key of the certificate (if available).

Syntax

amazonkmscontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (AmazonKMS Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

amazonkmscontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (AmazonKMS Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

amazonkmscontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (AmazonKMS Control)

The public key of the certificate.

Syntax

amazonkmscontrol.SSLAcceptServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (AmazonKMS Control)

The textual description of the certificate's public key algorithm.

Syntax

amazonkmscontrol.SSLAcceptServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (AmazonKMS Control)

The length of the certificate's public key (in bits).

Syntax

amazonkmscontrol.SSLAcceptServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (AmazonKMS Control)

The serial number of the certificate encoded as a string.

Syntax

amazonkmscontrol.SSLAcceptServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (AmazonKMS Control)

The text description of the certificate's signature algorithm.

Syntax

amazonkmscontrol.SSLAcceptServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (AmazonKMS Control)

The name of the certificate store for the client certificate.

Syntax

amazonkmscontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (AmazonKMS Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

amazonkmscontrol.SSLAcceptServerCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (AmazonKMS Control)

The type of certificate store for this certificate.

Syntax

amazonkmscontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (AmazonKMS Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

amazonkmscontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (AmazonKMS Control)

The MD5 hash of the certificate.

Syntax

amazonkmscontrol.SSLAcceptServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (AmazonKMS Control)

The SHA-1 hash of the certificate.

Syntax

amazonkmscontrol.SSLAcceptServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (AmazonKMS Control)

The SHA-256 hash of the certificate.

Syntax

amazonkmscontrol.SSLAcceptServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (AmazonKMS Control)

The text description of UsageFlags .

Syntax

amazonkmscontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (AmazonKMS Control)

The flags that show intended use for the certificate.

Syntax

amazonkmscontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (AmazonKMS Control)

The certificate's version number.

Syntax

amazonkmscontrol.SSLAcceptServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (AmazonKMS Control)

The subject of the certificate used for client authentication.

Syntax

amazonkmscontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (AmazonKMS Control)

The certificate (PEM/Base64 encoded).

Syntax

amazonkmscontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (AmazonKMS Control)

The date on which this certificate becomes valid.

Syntax

amazonkmscontrol.SSLCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (AmazonKMS Control)

The date on which the certificate expires.

Syntax

amazonkmscontrol.SSLCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (AmazonKMS Control)

A comma-delimited list of extended key usage identifiers.

Syntax

amazonkmscontrol.SSLCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (AmazonKMS Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

amazonkmscontrol.SSLCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (AmazonKMS Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

amazonkmscontrol.SSLCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (AmazonKMS Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

amazonkmscontrol.SSLCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (AmazonKMS Control)

The issuer of the certificate.

Syntax

amazonkmscontrol.SSLCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (AmazonKMS Control)

The private key of the certificate (if available).

Syntax

amazonkmscontrol.SSLCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (AmazonKMS Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

amazonkmscontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (AmazonKMS Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

amazonkmscontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (AmazonKMS Control)

The public key of the certificate.

Syntax

amazonkmscontrol.SSLCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (AmazonKMS Control)

The textual description of the certificate's public key algorithm.

Syntax

amazonkmscontrol.SSLCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (AmazonKMS Control)

The length of the certificate's public key (in bits).

Syntax

amazonkmscontrol.SSLCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (AmazonKMS Control)

The serial number of the certificate encoded as a string.

Syntax

amazonkmscontrol.SSLCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (AmazonKMS Control)

The text description of the certificate's signature algorithm.

Syntax

amazonkmscontrol.SSLCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (AmazonKMS Control)

The name of the certificate store for the client certificate.

Syntax

amazonkmscontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (AmazonKMS Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

amazonkmscontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (AmazonKMS Control)

The type of certificate store for this certificate.

Syntax

amazonkmscontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (AmazonKMS Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

amazonkmscontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (AmazonKMS Control)

The MD5 hash of the certificate.

Syntax

amazonkmscontrol.SSLCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (AmazonKMS Control)

The SHA-1 hash of the certificate.

Syntax

amazonkmscontrol.SSLCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (AmazonKMS Control)

The SHA-256 hash of the certificate.

Syntax

amazonkmscontrol.SSLCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (AmazonKMS Control)

The text description of UsageFlags .

Syntax

amazonkmscontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (AmazonKMS Control)

The flags that show intended use for the certificate.

Syntax

amazonkmscontrol.SSLCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (AmazonKMS Control)

The certificate's version number.

Syntax

amazonkmscontrol.SSLCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (AmazonKMS Control)

The subject of the certificate used for client authentication.

Syntax

amazonkmscontrol.SSLCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (AmazonKMS Control)

The certificate (PEM/Base64 encoded).

Syntax

amazonkmscontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (AmazonKMS Control)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

amazonkmscontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

Data Type

Integer

SSLServerCertEffectiveDate Property (AmazonKMS Control)

The date on which this certificate becomes valid.

Syntax

amazonkmscontrol.SSLServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (AmazonKMS Control)

The date on which the certificate expires.

Syntax

amazonkmscontrol.SSLServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (AmazonKMS Control)

A comma-delimited list of extended key usage identifiers.

Syntax

amazonkmscontrol.SSLServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (AmazonKMS Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

amazonkmscontrol.SSLServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (AmazonKMS Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

amazonkmscontrol.SSLServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (AmazonKMS Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

amazonkmscontrol.SSLServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (AmazonKMS Control)

The issuer of the certificate.

Syntax

amazonkmscontrol.SSLServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (AmazonKMS Control)

The private key of the certificate (if available).

Syntax

amazonkmscontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (AmazonKMS Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

amazonkmscontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (AmazonKMS Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

amazonkmscontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (AmazonKMS Control)

The public key of the certificate.

Syntax

amazonkmscontrol.SSLServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (AmazonKMS Control)

The textual description of the certificate's public key algorithm.

Syntax

amazonkmscontrol.SSLServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (AmazonKMS Control)

The length of the certificate's public key (in bits).

Syntax

amazonkmscontrol.SSLServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (AmazonKMS Control)

The serial number of the certificate encoded as a string.

Syntax

amazonkmscontrol.SSLServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (AmazonKMS Control)

The text description of the certificate's signature algorithm.

Syntax

amazonkmscontrol.SSLServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (AmazonKMS Control)

The name of the certificate store for the client certificate.

Syntax

amazonkmscontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (AmazonKMS Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

amazonkmscontrol.SSLServerCertStorePassword

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (AmazonKMS Control)

The type of certificate store for this certificate.

Syntax

amazonkmscontrol.SSLServerCertStoreType

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (AmazonKMS Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

amazonkmscontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (AmazonKMS Control)

The MD5 hash of the certificate.

Syntax

amazonkmscontrol.SSLServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (AmazonKMS Control)

The SHA-1 hash of the certificate.

Syntax

amazonkmscontrol.SSLServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (AmazonKMS Control)

The SHA-256 hash of the certificate.

Syntax

amazonkmscontrol.SSLServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (AmazonKMS Control)

The text description of UsageFlags .

Syntax

amazonkmscontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (AmazonKMS Control)

The flags that show intended use for the certificate.

Syntax

amazonkmscontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (AmazonKMS Control)

The certificate's version number.

Syntax

amazonkmscontrol.SSLServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (AmazonKMS Control)

The subject of the certificate used for client authentication.

Syntax

amazonkmscontrol.SSLServerCertSubject

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (AmazonKMS Control)

The certificate (PEM/Base64 encoded).

Syntax

amazonkmscontrol.SSLServerCertEncoded

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (AmazonKMS Control)

The timeout for the control.

Syntax

amazonkmscontrol.Timeout[=integer]

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the control fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

AddEncryptionContextItem Method (AmazonKMS Control)

Adds an item to the EncryptionContext properties.

Syntax

amazonkmscontrol.AddEncryptionContextItem Name, Value

Remarks

This method adds an item to the EncryptionContext* properties. Name specifies the name of the item, and Value specifies the value of the item.

AddQueryParam Method (AmazonKMS Control)

Adds a query parameter to the QueryParams properties.

Syntax

amazonkmscontrol.AddQueryParam Name, Value

Remarks

This method is used to add a query parameter to the QueryParams properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the control automatically. Consult the service documentation for details on the available parameters.

CancelKeyDeletion Method (AmazonKMS Control)

Cancels the deletion of the specified KMS key.

Syntax

amazonkmscontrol.CancelKeyDeletion KeyId

Remarks

This method cancels the deletion of the KMS key specified by KeyId. Refer to the ScheduleKeyDeletion method for more information.

The value passed for the KeyId parameter must be the Id or ARN of a KMS key in the current account and Region.

ClearKeyData Method (AmazonKMS Control)

Clears information stored in the KeyData properties.

Syntax

amazonkmscontrol.ClearKeyData PlaintextOnly

Remarks

This method clears the information stored in the KeyData properties, removing it from memory. If the PlaintextOnly parameter is , only the KeyDataPlaintextKey property is cleared.

Config Method (AmazonKMS Control)

Sets or retrieves a configuration setting.

Syntax

amazonkmscontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateAlias Method (AmazonKMS Control)

Creates a new alias.

Syntax

amazonkmscontrol.CreateAlias Name, KeyId

Remarks

This method creates a new alias with the given Name and associates it with the KMS key specified by KeyId.

The value passed for Name must begin with alias/, and must consist solely of alphanumeric characters, forward slashes /, underscores _, and hyphens -. The final name must not begin with alias/aws/, which is a reserved prefix.

The value passed for the KeyId parameter must be the Id or ARN of a KMS key in the current account and Region.

CreateKey Method (AmazonKMS Control)

Creates a new KMS key.

Syntax

amazonkmscontrol.CreateKey KeySpec, ForSigning, Description

Remarks

This method creates a new KMS key of the specified KeySpec, and returns its Amazon resource name (ARN). The new KMS key's Id is the last part of the returned ARN; for example, if the ARN is arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab, then the KMS key's Id is 1234abcd-12ab-34cd-56ef-1234567890ab.

The KeySpec parameter specifies the type of KMS key that should be created. To create a symmetric key, pass SYMMETRIC_DEFAULT (or empty string); this will create a key using a symmetric algorithm based on AES-256-GCM. To create an asymmetric key, pass one of the following strings instead:

• RSA_2048
• RSA_3072
• RSA_4096
• ECC_NIST_P256 (secp256r1)
• ECC_NIST_P384 (secp384r1)
• ECC_NIST_P521 (secp521r1)
• ECC_SECG_P256K1 (secp256k1)

The ForSigning parameter specifies whether the new KMS key should be for encryption and decryption () or signing and verification (). However, this is only applicable for RSA key specs; symmetric keys are always for encryption/decryption, and elliptic curve key specs are always for signing/verification, so this parameter is ignored if one of those specs is passed for KeySpec.

The Description parameter specifies the KMS key's description. This description can be changed at any time using the UpdateKeyDescription method.

To create the KMS key in a custom key store, set the CustomKeyStoreId configuration setting before calling this method. To set the KMS key's key policy, set the CreateKeyPolicy configuration setting before calling this method. Refer to these configuration settings for more information.

Decrypt Method (AmazonKMS Control)

Decrypts data using a KMS key.

Syntax

amazonkmscontrol.Decrypt KeyId, Algorithm

Remarks

This method decrypts data using the KMS key specified by KeyId and the given Algorithm. The data to decrypt is taken from the the specified InputFile or the InputData property. The decrypted data is output to the the specified OutputFile or the OutputData property.

The value passed for the KeyId parameter must be the Id or ARN of a KMS key, or the name or ARN of an alias, in the current Region. If an ARN is provided, it can be for a KMS key or alias in another account so long as the appropriate permissions are in place.

The Algorithm parameter specifies which algorithm to use to decrypt the data; it must match the algorithm used to encrypt the data previously. Possible values vary depending on the specified KMS key's key spec:

If Algorithm is SYMMETRIC_DEFAULT, the encryption context items in the EncryptionContext properties will be included in the request. Keep in mind that in order to successfully decrypt the data, the exact same encryption context items that were present when the data was encrypted must be supplied again. Encryption context items are case-sensitive, but not order-sensitive.

This method will fail if any of the following are true regarding the specified KMS key:

• Its KeyState is anything other than aksEnabled (0).
• It is for signing/verification instead of encryption/decryption (see KeyForSigning).
• It is an AWS-managed KMS key (see KeyAWSManaged).

DeleteAlias Method (AmazonKMS Control)

Deletes an alias.

Syntax

amazonkmscontrol.DeleteAlias AliasName

Remarks

This method deletes the alias with the given AliasName.

The value passed for the AliasName parameter must include the alias/ prefix, and must be the name of an alias in the current account and Region

DoEvents Method (AmazonKMS Control)

This method processes events from the internal message queue.

Syntax

amazonkmscontrol.DoEvents 

Remarks

When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Encrypt Method (AmazonKMS Control)

Encrypts data using a KMS key.

Syntax

amazonkmscontrol.Encrypt KeyId, Algorithm

Remarks

This method encrypts data using the KMS key specified by KeyId and the given Algorithm. The data to encrypt is taken from the the specified InputFile or the InputData property. The encrypted data is output to the the specified OutputFile or the OutputData property.

The value passed for the KeyId parameter must be the Id or ARN of a KMS key, or the name or ARN of an alias, in the current Region. If an ARN is provided, it can be for a KMS key or alias in another account so long as the appropriate permissions are in place.

The Algorithm parameter specifies which algorithm to use to encrypt the data. Possible values vary depending on the specified KMS key's key spec. The KMS key's key spec and the selected algorithm together dictate the maximum size of the input data.

If Algorithm is SYMMETRIC_DEFAULT, the encryption context items in the EncryptionContext properties will be included in the request. Including an encryption context when encrypting data means that the exact same encryption context must be supplied again in order to decrypt the data. Encryption context items are case-sensitive, but not order-sensitive.

This method will fail if any of the following are true regarding the specified KMS key:

• Its KeyState is anything other than aksEnabled (0).
• It is for signing/verification instead of encryption/decryption (see KeyForSigning).
• It is an AWS-managed KMS key (see KeyAWSManaged).

GenerateDataKey Method (AmazonKMS Control)

Generates a data key that can be used outside of Amazon KMS.

Syntax

amazonkmscontrol.GenerateDataKey KeySpec, KeyId, IncludePlaintext

Remarks

This method generates a data key that can be used outside of Amazon KMS for encryption and decryption. The generated data key will be encrypted using the KMS key specified by KeyId before it is returned. The key and its related information will be downloaded to the following KeyData properties, refer to their documentation for more information:

• KeyDataARN
• KeyDataEncryptedKey
• KeyDataKeySpec
• KeyDataPlaintextKey (if is passed for IncludePlaintext)

The KeySpec parameter specifies either the spec of the data key, or the size of the data key in bytes. Valid values are:

• AES_128
• AES_256
• Some number of bytes in the range 1 to 1024 (e.g., 64)

The value passed for the KeyId parameter must be the Id or ARN of a KMS key, or the name or ARN of an alias, in the current Region. If an ARN is provided, it can be for a KMS key or alias in another account so long as the appropriate permissions are in place. The specified KMS key must be symmetric. Any encryption context items present in the EncryptionContext properties will be included in the request and used when encrypting the data key; they must be supplied again in order to decrypt it.

The IncludePlaintext parameter specifies whether the server should return a plaintext (i.e., unencrypted) copy of the data key in addition to the encrypted copy. This can be useful if the data key will be used immediately.

This method will fail if any of the following are true regarding the specified KMS key:

• Its KeyState is anything other than aksEnabled (0).
• It is asymmetric (see KeyKeySpec).
• It is for signing/verification instead of encryption/decryption (see KeyForSigning).
• It is an AWS-managed KMS key (see KeyAWSManaged).

GenerateDataKeyPair Method (AmazonKMS Control)

Generates a data key pair that can be used outside of Amazon KMS.

Syntax

amazonkmscontrol.GenerateDataKeyPair KeyPairSpec, KeyId, IncludePlaintext

Remarks

This method generates a data key pair that can be used outside of Amazon KMS for encryption and decryption, or signing and verification. The private key of the generated key pair will be encrypted using the KMS key specified by KeyId before it is returned. The key and its related information will be downloaded to the following KeyData properties, refer to their documentation for more information:

• KeyDataARN
• KeyDataEncryptedKey
• KeyDataKeySpec
• KeyDataPlaintextKey (if is passed for IncludePlaintext)
• KeyDataPublicKey

The KeySpec parameter specifies the spec of the data key pair. Valid values are:

• RSA_2048
• RSA_3072
• RSA_4096
• ECC_NIST_P256 (secp256r1)
• ECC_NIST_P384 (secp384r1)
• ECC_NIST_P521 (secp521r1)
• ECC_SECG_P256K1 (secp256k1)

The value passed for the KeyId parameter must be the Id or ARN of a KMS key, or the name or ARN of an alias, in the current Region. If an ARN is provided, it can be for a KMS key or alias in another account so long as the appropriate permissions are in place. The specified KMS key must be symmetric. Any encryption context items present in the EncryptionContext properties will be included in the request and used when encrypting the private key; they must be supplied again in order to decrypt it.

The IncludePlaintext parameter specifies whether the server should return a plaintext (i.e., unencrypted) copy of the data key pair's private key in addition to the encrypted copy. This can be useful if the private key will be used immediately.

This method will fail if any of the following are true regarding the specified KMS key:

• Its KeyState is anything other than aksEnabled (0).
• It is asymmetric (see KeyKeySpec).
• It is for signing/verification instead of encryption/decryption (see KeyForSigning).
• It is an AWS-managed KMS key (see KeyAWSManaged).

GenerateRandomBytes Method (AmazonKMS Control)

Generates a cryptographically-secure random byte string.

Syntax

amazonkmscontrol.GenerateRandomBytes NumBytes

Remarks

This method uses Amazon KMS to generate a cryptographically-secure random byte string of the specified length (measured in bytes). The random bytes are output to the the OutputFile or the OutputData property.

The value passed for NumBytes must be in the range 1 to 1024.

GetKeyInfo Method (AmazonKMS Control)

Gets information about a KMS key.

Syntax

amazonkmscontrol.GetKeyInfo KeyId

Remarks

This method gets information about the KMS key specified by KeyId. When the information is returned, the control clears the Keys properties and repopulates them with a single item that contains the KMS key's information. The KeyList event is also fired.

The value passed for the KeyId parameter must be the Id or ARN of a KMS key, or the name or ARN of an alias, in the current Region. If an ARN is provided, it can be for a KMS key or alias in another account so long as the appropriate permissions are in place.

GetKeyRotationStatus Method (AmazonKMS Control)

Retrieves the key rotation status for a KMS key.

Syntax

amazonkmscontrol.GetKeyRotationStatus KeyId

Remarks

This method retrieves the key rotation status for the KMS key specified by KeyId; it will return if the KMS key's key material is set to be automatically rotated, or if not.

The value passed for the KeyId parameter must be the Id or ARN of a KMS key in the current Region. If an ARN is provided, it can be for a KMS key in another account so long as the appropriate permissions are in place.

This method will always return for asymmetric KMS keys, KMS keys with imported key material, and KMS keys that reside in a custom key store, as such KMS keys do not support automatic key rotation. This method will also return if the server returns an error for any other reason.

GetPublicKey Method (AmazonKMS Control)

Retrieves the public key of an asymmetric KMS key.

Syntax

amazonkmscontrol.GetPublicKey KeyId

Remarks

This method retrieves the public key of the asymmetric KMS key specified by KeyId. The public key and its related information will be downloaded to the following KeyData properties, refer to their documentation for more information:

• KeyDataAlgorithms
• KeyDataARN
• KeyDataForSigning
• KeyDataKeySpec
• KeyDataPublicKey

This method will fail if any of the following are true regarding the specified KMS key:

• Its KeyState is anything other than aksEnabled (0).
• It is symmetric (see KeyKeySpec).
• It is an AWS-managed KMS key (see KeyAWSManaged).

ListAliases Method (AmazonKMS Control)

Lists aliases in the current account and region.

Syntax

amazonkmscontrol.ListAliases ForKeyId

Remarks

This method lists the aliases in the current account and Region. Optionally, aliases for a specific KMS key (in the current account and Region) can be listed by passing its Id or ARN for the ForKeyId parameter.

Calling this method will fire the AliasList event once for each alias, and will also populate the Aliases properties.

If there are still more aliases available to list when this method returns, the AliasMarker property will be populated. Continue to call this method until AliasMarker is empty to accumulate all pages of results in the Aliases properties.

The MaxAliases configuration setting can be used to control the maximum number of results to return at once.

ListKeys Method (AmazonKMS Control)

Lists KMS keys in the current account and region.

Syntax

amazonkmscontrol.ListKeys 

Remarks

This method lists the KMS keys in the current account and Region.

Calling this method will fire the KeyList event once for each KMS key, and will also populate the Keys properties. However, note that by default only the KeyARN and KeyId properties will be populated, since the server does not return full information for KMS keys when listing them. The IncludeKeyDetails property can be enabled to have the control attempt to retrieve full information for each KMS key; refer to its documentation for more information.

If there are still more KMS keys available to list when this method returns, the KeyMarker property will be populated. Continue to call this method until KeyMarker is empty to accumulate all pages of results in the Keys properties.

The MaxKeys configuration setting can be used to control the maximum number of results to return at once.

ReEncrypt Method (AmazonKMS Control)

Decrypts data using one KMS key and re-encrypts it using another KMS key.

Syntax

amazonkmscontrol.ReEncrypt OldKeyId, OldAlgorithm, NewKeyId, NewAlgorithm

Remarks

This method decrypts data using the KMS key specified by OldKeyId and re-encrypts it using the KMS key specified by NewKeyId. This process happens completely on the server; at no point is the unencrypted data transferred over the wire.

The encrypted data is taken from the the specified InputFile or the InputData property. The re-encrypted data is output to the the specified OutputFile or the OutputData property.

The values passed for the OldKeyId and NewKeyId parameters must be the Id or ARN of a KMS key, or the name or ARN of an alias, in the current Region. For either or both parameters, if an ARN is provided, it can be for a KMS key or alias in another account so long as the appropriate permissions are in place.

The OldAlgorithm and NewAlgorithm parameters specify the encryption algorithm currently in use, and the new encryption algorithm, respectively. Valid values vary depending on the old and new KMS keys key specs:

If OldAlgorithm is SYMMETRIC_DEFAULT, the encryption context items in the EncryptionContext properties will be included in the request for use with decryption. Keep in mind that in order to successfully decrypt the data, the exact same encryption context items that were present when the data was encrypted must be supplied again. Encryption context items are case-sensitive, but not order-sensitive.

If NewAlgorithm is SYMMETRIC_DEFAULT, the encryption context items in the EncryptionContext properties will also be included in the request for use with re-encryption, effectively causing the encryption context to be transferred to the re-encrypted data. Alternatively, the NewEncryptionContext configuration setting can be set before calling this method in order to supply a new encryption context (or, if set to {}, to "remove" the existing one).

This method will fail if any of the following are true regarding either of the specified KMS keys:

• Its KeyState is anything other than aksEnabled (0).
• It is for signing/verification instead of encryption/decryption (see KeyForSigning).
• It is an AWS-managed KMS key (see KeyAWSManaged).

Reset Method (AmazonKMS Control)

Resets the control to its initial state.

Syntax

amazonkmscontrol.Reset 

Remarks

This method resets the control to its initial state.

ScheduleKeyDeletion Method (AmazonKMS Control)

Schedules the deletion of a KMS key.

Syntax

amazonkmscontrol.ScheduleKeyDeletion KeyId, DaysToWait

Remarks

This method schedules the deletion of the KMS key specified by KeyId. The DaysToWait parameter specifies the length of the waiting period; it must be a value between 7 and 30.

When a KMS key is scheduled for deletion, it cannot be used. This is a safety feature designed to help identify any code that still relies on the KMS key.

SendCustomRequest Method (AmazonKMS Control)

Sends a custom request to the server.

Syntax

amazonkmscontrol.SendCustomRequest Action

Remarks

This method can be used to send arbitrary requests to the server. The value passed for the Action parameter must be one of the actions described in the Amazon KMS documentation.

When this method is called, the control does the following:

1. Builds a request URL, including query parameters, based on the following:
   • Region
   • QueryParams
2. Adds request headers from OtherHeaders.
3. Adds any request body supplied via the specified InputFile or InputData.
4. Signs the request.
5. Sends the request to the server.
6. Stores the response headers in the ParsedHeaders properties; and the response body in the specified OutputFile or OutputData.

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

SetKeyEnabled Method (AmazonKMS Control)

Enables or disables a KMS key.

Syntax

amazonkmscontrol.SetKeyEnabled KeyId, Enabled

Remarks

This method enables or disables the KMS key specified by KeyId.

The value passed for the KeyId parameter must be the Id or ARN of a KMS key in the current account and Region.

This method will fail if any of the following are true regarding the specified KMS key:

• Its KeyState is aksPendingDeletion (2) or aksPendingImport (3).
• It is an AWS-managed KMS key (see KeyAWSManaged).

SetKeyRotationStatus Method (AmazonKMS Control)

Enables or disables automatic key rotation for a KMS key.

Syntax

amazonkmscontrol.SetKeyRotationStatus KeyId, Enabled

Remarks

This method enables or disables automatic key material rotation for the KMS key specified by KeyId.

The value passed for the KeyId parameter must be the Id or ARN of a KMS key in the current account and Region.

This method will fail if any of the following are true regarding the specified KMS key:

• Its KeyState is anything other than aksEnabled (0).
• It is asymmetric (see KeyKeySpec).
• It has imported key material (see KeyOrigin).
• It resides in a custom key store (see KeyCustomKeyStoreId).
• It is an AWS-managed KMS key (see KeyAWSManaged).

Sign Method (AmazonKMS Control)

Signs a message using a KMS key.

Syntax

amazonkmscontrol.Sign KeyId, Algorithm, IsDigest

Remarks

This method signs a message using the KMS key specified by KeyId and the given Algorithm. The message data to sign is taken from the the specified InputFile or the InputData property. The signature data is output to the the specified OutputFile or the OutputData property.

The value passed for the KeyId parameter must be the Id or ARN of a KMS key, or the name or ARN of an alias, in the current Region. If an ARN is provided, it can be for a KMS key or alias in another account so long as the appropriate permissions are in place.

The Algorithm parameter specifies which algorithm to use to sign the data. Possible values are:

• RSASSA_PSS_SHA_256
• RSASSA_PSS_SHA_384
• RSASSA_PSS_SHA_512
• RSASSA_PKCS1_V1_5_SHA_256
• RSASSA_PKCS1_V1_5_SHA_384
• RSASSA_PKCS1_V1_5_SHA_512
• ECDSA_SHA_256
• ECDSA_SHA_384
• ECDSA_SHA_512

The IsDigest parameter specifies whether the message data is the original message () or a message digest (). When supplying a message digest, keep in mind that the same digest will need to be provided in order to Verify the signature later.

Note that a maximum of 4096 bytes of message data can be sent to the server. If IsDigest is , and more than 4096 bytes of message data are provided, the control will automatically compute an appropriate message digest and send it instead. In such cases, the computed digest is made available via the MessageDigest configuration setting.

This method will fail if any of the following are true regarding the specified KMS key:

• Its KeyState is anything other than aksEnabled (0).
• It is symmetric (see KeyKeySpec).
• It is for encryption/decryption instead of signing/verification (see KeyForSigning).
• It is an AWS-managed KMS key (see KeyAWSManaged).

UpdateAlias Method (AmazonKMS Control)

Updates an alias to refer to a different KMS key.

Syntax

amazonkmscontrol.UpdateAlias AliasName, NewKeyId

Remarks

This method updates the alias named AliasName, changing it so that it refers to the KMS key specified by NewKeyId.

The value passed for the AliasName parameter must include the alias/ prefix, and must be the name of an alias in the current account and Region

The value passed for the NewKeyId parameter must be the Id or ARN of a KMS key in the current account and Region. The specified KMS key must be of the same type (i.e., symmetric or asymmetric) and have the same usage (i.e., encryption/decryption or signing/verification) as the KMS key that the alias currently refers to.

This method will fail if the specified alias is AWS-managed (i.e., its name begins with alias/aws/). This method will also fail if the specified KMS key's state is aksPendingDeletion (2), or if it is AWS-managed (see KeyAWSManaged).

UpdateKeyDescription Method (AmazonKMS Control)

Updates a KMS key's description.

Syntax

amazonkmscontrol.UpdateKeyDescription KeyId, NewDescription

Remarks

This method updates the description of the KMS key specified by KeyId.

The value passed for the KeyId parameter must be the Id or ARN of a KMS key in the current account and Region.

This method will fail if the specified KMS key's state is aksPendingDeletion (2), or if it is AWS-managed (see KeyAWSManaged).

Verify Method (AmazonKMS Control)

Verifies a digital signature using a KMS key.

Syntax

amazonkmscontrol.Verify KeyId, Algorithm, IsDigest

Remarks

This method verifies a digital signature using the KMS key specified by KeyId and the given Algorithm. The message data is taken from the the specified InputFile or the InputData property. The digital signature data is taken from the specified OutputFile or the OutputData property. If the signature is successfully verified, this method returns , otherwise it returns .

The value passed for the KeyId parameter must be the Id or ARN of a KMS key, or the name or ARN of an alias, in the current Region. If an ARN is provided, it can be for a KMS key or alias in another account so long as the appropriate permissions are in place.

The Algorithm parameter specifies which algorithm was used to sign the data. Possible values are:

• RSASSA_PSS_SHA_256
• RSASSA_PSS_SHA_384
• RSASSA_PSS_SHA_512
• RSASSA_PKCS1_V1_5_SHA_256
• RSASSA_PKCS1_V1_5_SHA_384
• RSASSA_PKCS1_V1_5_SHA_512
• ECDSA_SHA_256
• ECDSA_SHA_384
• ECDSA_SHA_512

The IsDigest parameter specifies whether the data whose signature is being verified is the original message () or a message digest (). When a message digest is supplied, keep in mind that it must be the exact same digest that was used at signing time, regardless of whether it has been recomputed.

Note that, as with the Sign method, a maximum of 4096 bytes of message data can be sent to the server. If IsDigest is , and more than 4096 bytes of message data are provided, the control will automatically compute an appropriate message digest and send it instead. In such cases, the computed digest is made available via the MessageDigest configuration setting.

This method will fail if any of the following are true regarding the specified KMS key:

• Its KeyState is anything other than aksEnabled (0).
• It is symmetric (see KeyKeySpec).
• It is for encryption/decryption instead of signing/verification (see KeyForSigning).
• It is an AWS-managed KMS key (see KeyAWSManaged).

AliasList Event (AmazonKMS Control)

Fires once for each alias when listing aliases.

Syntax

Sub amazonkmscontrol_AliasList(ARN As String, Name As String, KeyId As String)

Remarks

This event fires once for each alias returned when ListAliases is called.

ARN reflects the Amazon resource name of the alias.

Name reflects the name of the alias, including the alias/ prefix.

KeyId reflects the Id of the KMS key that the alias refers to.

EndTransfer Event (AmazonKMS Control)

This event fires when a document finishes transferring.

Syntax

Sub amazonkmscontrol_EndTransfer(Direction As Integer)

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (AmazonKMS Control)

Fired when information is available about errors during data delivery.

Syntax

Sub amazonkmscontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (AmazonKMS Control)

Fired every time a header line comes in.

Syntax

Sub amazonkmscontrol_Header(Field As String, Value As String)

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

KeyList Event (AmazonKMS Control)

Fires once for each KMS key when listing KMS keys.

Syntax

Sub amazonkmscontrol_KeyList(ARN As String, Id As String, AccountId As String, Description As String, Enabled As Boolean, AWSManaged As Boolean, ForSigning As Boolean, KeySpec As String, Algorithms As String, State As Integer, CreationDate As String, DeletionDate As String)

Remarks

This event fires once for each KMS key returned when ListKeys or GetKeyInfo is called. However, note that only ARN and Id are populated when ListKeys is called (unless the IncludeKeyDetails property is enabled; refer to its documentation for more information).

ARN reflects the Amazon resource name of the KMS key.

Id reflects the Id of the KMS key.

AccountId reflects the Id of the AWS account that owns the KMS key.

Description reflects the KMS key's description.

Enabled reflects whether the KMS key is currently enabled.

AWSManaged reflects whether the KMS key is AWS-managed () or customer-managed ().

ForSigning reflects whether the KMS key's usage is signing/verification () or encryption/decryption ().

KeySpec reflects the key spec of the KMS key. For symmetric KMS keys, the only possible value is SYMMETRIC_DEFAULT which, according to the Amazon KMS documentation, is based on AES-256-GCM. For asymmetric KMS keys, possible values are:

• RSA_2048
• RSA_3072
• RSA_4096
• ECC_NIST_P256 (secp256r1)
• ECC_NIST_P384 (secp384r1)
• ECC_NIST_P521 (secp521r1)
• ECC_SECG_P256K1 (secp256k1)

Algorithms reflects a comma-separated list of algorithms that the KMS key supports. If KeyForSigning is , possible values are:

• SYMMETRIC_DEFAULT
• RSAES_OAEP_SHA_1
• RSAES_OAEP_SHA_256

If KeyForSigning is , possible values are:

• RSASSA_PSS_SHA_256
• RSASSA_PSS_SHA_384
• RSASSA_PSS_SHA_512
• RSASSA_PKCS1_V1_5_SHA_256
• RSASSA_PKCS1_V1_5_SHA_384
• RSASSA_PKCS1_V1_5_SHA_512
• ECDSA_SHA_256
• ECDSA_SHA_384
• ECDSA_SHA_512

State reflects the KMS key's state. Possible values are:

• aksEnabled (0): The KMS key is enabled and ready for use. (Also the default value used when ListKeys is called.)
• aksDisabled (1): The KMS key is disabled and cannot be used until it is enabled again.
• aksPendingDeletion (2): The KMS key is pending deletion and cannot be used unless the deletion is canceled.
• aksPendingImport (3): The KMS key has been created, but external key material has not yet been imported into it, so it cannot be used.
• aksUnavailable (4): The KMS key is currently unavailable because the CloudHSM cluster that contains its key material has been disconnected from Amazon KMS.

CreationDate reflects the creation date of the KMS key, in seconds since the Unix epoch (including fractional seconds).

If the KMS key's state is aksPendingDeletion (2), DeletionDate reflects the deletion date, in seconds since the Unix epoch (including fractional seconds)

Log Event (AmazonKMS Control)

Fired once for each log message.

Syntax

Sub amazonkmscontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

This event is fired once for each log message generated by the control. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

SSLServerAuthentication Event (AmazonKMS Control)

Fired after the server presents its certificate to the client.

Syntax

Sub amazonkmscontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (AmazonKMS Control)

Fired when secure connection progress messages are available.

Syntax

Sub amazonkmscontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (AmazonKMS Control)

This event fires when a document starts transferring (after the headers).

Syntax

Sub amazonkmscontrol_StartTransfer(Direction As Integer)

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (AmazonKMS Control)

Fired while a document transfers (delivers document).

Syntax

Sub amazonkmscontrol_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String)

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (AmazonKMS Control)

AmazonKMS Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings