# AmazonKMS Component The AmazonKMS component provides an easy-to-use interface for Amazon's Key Management Service. ## Syntax ```text TckAmazonKMS ``` ## Remarks The AmazonKMS component 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](#accesskey-property-amazonkms-component) and [SecretKey](#secretkey-property-amazonkms-component) 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 component 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](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#enveloping) 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 Component KMS keys can be created using the [CreateKey](#createkey-method-amazonkms-component) 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](#updatekeydescription-method-amazonkms-component) method. When a KMS key will no longer be used, it can be scheduled for deletion using the [ScheduleKeyDeletion](#schedulekeydeletion-method-amazonkms-component) 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](#cancelkeydeletion-method-amazonkms-component) method (KMS keys cannot be used while they are pending deletion). ```csharp // 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](#createalias-method-amazonkms-component) and [DeleteAlias](#deletealias-method-amazonkms-component) 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). ```csharp 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](#listkeys-method-amazonkms-component) and [ListAliases](#listaliases-method-amazonkms-component) methods. For the former, the [IncludeKeyDetails](#includekeydetails-property-amazonkms-component) property can optionally be enabled to have the component attempt to retrieve the full information for each KMS key (Amazon only returns the KMS key's ARN and Id while listing). ```csharp // 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](#encrypt-method-amazonkms-component), [Decrypt](#decrypt-method-amazonkms-component), and [ReEncrypt](#reencrypt-method-amazonkms-component) operations. KMS keys with sign/verify usage can be used in [Sign](#sign-method-amazonkms-component) and [Verify](#verify-method-amazonkms-component) operations. To perform a cryptographic operation, use [InputData](#inputdata-property-amazonkms-component), [InputFile](#inputfile-property-amazonkms-component), or [SetInputStream](#setinputstream-method-amazonkms-component) to supply the input data that should be processed. All operations will output the result data to [OutputData](#outputdata-property-amazonkms-component), [OutputFile](#outputfile-property-amazonkms-component), or [SetOutputStream](#setoutputstream-method-amazonkms-component) (except [Verify](#verify-method-amazonkms-component); refer to its documentation for more information). ```csharp // 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](#encrypt-method-amazonkms-component) 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](#generatedatakey-method-amazonkms-component) and [GenerateDataKeyPair](#generatedatakeypair-method-amazonkms-component) methods. ```csharp // 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 component also supports a variety of other functionality, including: - Retrieval of an asymmetric KMS key's public key with [GetPublicKey](#getpublickey-method-amazonkms-component). - Enabling and disabling KMS keys with [SetKeyEnabled](#setkeyenabled-method-amazonkms-component). - Automatic rotation of KMS keys with [GetKeyRotationStatus](#getkeyrotationstatus-method-amazonkms-component) and [SetKeyRotationStatus](#setkeyrotationstatus-method-amazonkms-component). - Encryption contexts for [Encrypt](#encrypt-method-amazonkms-component), [Decrypt](#decrypt-method-amazonkms-component), and [ReEncrypt](#reencrypt-method-amazonkms-component). - And more! ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AccessKey](#accesskey-property-amazonkms-component) | The access key to use for authentication. | | [Aliases](#aliases-property-amazonkms-component) | A collection of aliases. | | [AliasMarker](#aliasmarker-property-amazonkms-component) | A marker indicating what page of aliases to return next. | | [EncryptionContext](#encryptioncontext-property-amazonkms-component) | A collection of encryption context items. | | [Firewall](#firewall-property-amazonkms-component) | A set of properties related to firewall access. | | [Idle](#idle-property-amazonkms-component) | The current status of the component. | | [IncludeKeyDetails](#includekeydetails-property-amazonkms-component) | Whether to attempt to retrieve full details when listing KMS keys. | | [InputData](#inputdata-property-amazonkms-component) | The data to process. | | [InputFile](#inputfile-property-amazonkms-component) | The file whose data should be processed. | | [KeyData](#keydata-property-amazonkms-component) | The downloaded key information. | | [KeyMarker](#keymarker-property-amazonkms-component) | A marker indicating what page of KMS keys to return next. | | [Keys](#keys-property-amazonkms-component) | A collection of keys. | | [LocalHost](#localhost-property-amazonkms-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [OtherHeaders](#otherheaders-property-amazonkms-component) | Other headers as determined by the user (optional). | | [OutputData](#outputdata-property-amazonkms-component) | The output data. | | [OutputFile](#outputfile-property-amazonkms-component) | The file to which output data should be written. | | [Overwrite](#overwrite-property-amazonkms-component) | Whether the output file should be overwritten if necessary. | | [ParsedHeaders](#parsedheaders-property-amazonkms-component) | This property includes a collection of headers returned from the last request. | | [Proxy](#proxy-property-amazonkms-component) | A set of properties related to proxy access. | | [QueryParams](#queryparams-property-amazonkms-component) | Additional query parameters to be included in the request. | | [Region](#region-property-amazonkms-component) | The region that the component will make requests against. | | [SecretKey](#secretkey-property-amazonkms-component) | The secret key to use for authentication. | | [SSLAcceptServerCert](#sslacceptservercert-property-amazonkms-component) | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#sslcert-property-amazonkms-component) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLProvider](#sslprovider-property-amazonkms-component) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#sslservercert-property-amazonkms-component) | The server certificate for the last established connection. | | [Timeout](#timeout-property-amazonkms-component) | The timeout for the component. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddEncryptionContextItem](#addencryptioncontextitem-method-amazonkms-component) | Adds an item to the EncryptionContext properties. | | [AddQueryParam](#addqueryparam-method-amazonkms-component) | Adds a query parameter to the QueryParams properties. | | [CancelKeyDeletion](#cancelkeydeletion-method-amazonkms-component) | Cancels the deletion of the specified KMS key. | | [ClearKeyData](#clearkeydata-method-amazonkms-component) | Clears information stored in the KeyData properties. | | [Config](#config-method-amazonkms-component) | Sets or retrieves a configuration setting. | | [CreateAlias](#createalias-method-amazonkms-component) | Creates a new alias. | | [CreateKey](#createkey-method-amazonkms-component) | Creates a new KMS key. | | [Decrypt](#decrypt-method-amazonkms-component) | Decrypts data using a KMS key. | | [DeleteAlias](#deletealias-method-amazonkms-component) | Deletes an alias. | | [DoEvents](#doevents-method-amazonkms-component) | This method processes events from the internal message queue. | | [Encrypt](#encrypt-method-amazonkms-component) | Encrypts data using a KMS key. | | [GenerateDataKey](#generatedatakey-method-amazonkms-component) | Generates a data key that can be used outside of Amazon KMS. | | [GenerateDataKeyPair](#generatedatakeypair-method-amazonkms-component) | Generates a data key pair that can be used outside of Amazon KMS. | | [GenerateRandomBytes](#generaterandombytes-method-amazonkms-component) | Generates a cryptographically-secure random byte string. | | [GetKeyInfo](#getkeyinfo-method-amazonkms-component) | Gets information about a KMS key. | | [GetKeyRotationStatus](#getkeyrotationstatus-method-amazonkms-component) | Retrieves the key rotation status for a KMS key. | | [GetPublicKey](#getpublickey-method-amazonkms-component) | Retrieves the public key of an asymmetric KMS key. | | [ListAliases](#listaliases-method-amazonkms-component) | Lists aliases in the current account and region. | | [ListKeys](#listkeys-method-amazonkms-component) | Lists KMS keys in the current account and region. | | [ReEncrypt](#reencrypt-method-amazonkms-component) | Decrypts data using one KMS key and re-encrypts it using another KMS key. | | [Reset](#reset-method-amazonkms-component) | Resets the component to its initial state. | | [ScheduleKeyDeletion](#schedulekeydeletion-method-amazonkms-component) | Schedules the deletion of a KMS key. | | [SendCustomRequest](#sendcustomrequest-method-amazonkms-component) | Sends a custom request to the server. | | [SetInputStream](#setinputstream-method-amazonkms-component) | Sets the stream whose data should be processed. | | [SetKeyEnabled](#setkeyenabled-method-amazonkms-component) | Enables or disables a KMS key. | | [SetKeyRotationStatus](#setkeyrotationstatus-method-amazonkms-component) | Enables or disables automatic key rotation for a KMS key. | | [SetOutputStream](#setoutputstream-method-amazonkms-component) | Sets the stream to which output data should be written. | | [Sign](#sign-method-amazonkms-component) | Signs a message using a KMS key. | | [UpdateAlias](#updatealias-method-amazonkms-component) | Updates an alias to refer to a different KMS key. | | [UpdateKeyDescription](#updatekeydescription-method-amazonkms-component) | Updates a KMS key's description. | | [Verify](#verify-method-amazonkms-component) | Verifies a digital signature using a KMS key. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AliasList](#aliaslist-event-amazonkms-component) | Fires once for each alias when listing aliases. | | [EndTransfer](#endtransfer-event-amazonkms-component) | Fired when a document finishes transferring. | | [Error](#error-event-amazonkms-component) | Fired when information is available about errors during data delivery. | | [Header](#header-event-amazonkms-component) | Fired every time a header line comes in. | | [KeyList](#keylist-event-amazonkms-component) | Fires once for each KMS key when listing KMS keys. | | [Log](#log-event-amazonkms-component) | Fired once for each log message. | | [SSLServerAuthentication](#sslserverauthentication-event-amazonkms-component) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-amazonkms-component) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-amazonkms-component) | Fired when a document starts transferring (after the headers). | | [Transfer](#transfer-event-amazonkms-component) | Fired while a document transfers (delivers document). | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AccumulatePages](#AccumulatePages) | Whether the component should accumulate subsequent pages of results when listing them. | | [AWSProfile](#AWSProfile) | The name of the AWS CLI profile that the component should use to obtain authentication and region information. | | [AWSProfileDir](#AWSProfileDir) | The location of the AWS CLI credentials and config files. | | [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) | Whether the specified input stream should be closed after data is read from it. | | [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing) | Whether the specified output stream should be closed after data is written to it. | | [CreateKeyPolicy](#CreateKeyPolicy) | The key policy JSON to send when creating a new KMS key. | | [CustomKeyStoreId](#CustomKeyStoreId) | The Id of the custom key store that the KMS key should be created in. | | [MaxAliases](#MaxAliases) | The maximum number of results to return when listing aliases. | | [MaxKeys](#MaxKeys) | The maximum number of results to return when listing KMS keys. | | [MessageDigest](#MessageDigest) | The message digest computed by the component during the last sign or verify operation, if any. | | [NewEncryptionContext](#NewEncryptionContext) | The new encryption context to use when re-encrypting data. | | [RawRequest](#RawRequest) | Returns the data that was sent to the server. | | [RawResponse](#RawResponse) | Returns the data that was received from the server. | | [SessionToken](#SessionToken) | The session token to send in the request when using temporary credentials. | | [UseEC2RoleCredentials](#UseEC2RoleCredentials) | Whether to authenticate requests with credentials obtained from the IAM role attached to the EC2 instance. | | [UseFIPSEndpoint](#UseFIPSEndpoint) | Whether to use the FIPs endpoint to communicate with the server. | | [XChildCount](#XChildCount) | The number of child elements of the current element. | | [XChildName\[i\]](#XChildName[i]) | The name of the child element. | | [XChildXText\[i\]](#XChildXText[i]) | The inner text of the child element. | | [XElement](#XElement) | The name of the current element. | | [XParent](#XParent) | The parent of the current element. | | [XPath](#XPath) | Provides a way to point to a specific element in the returned XML or JSON response. | | [XSubTree](#XSubTree) | A snapshot of the current element in the document. | | [XText](#XText) | The text of the current element. | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the component. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the component will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the component. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the component. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the component will close the upload or download stream after the transfer. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the component whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the component binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AccessKey Property ([AmazonKMS](#amazonkms-component) Component) The access key to use for authentication. ## Syntax *Delphi Syntax* ```text property AccessKey: String read get_AccessKey write set_AccessKey; ``` ## Default Value '' ## Remarks This property specifies the access key that should be used for authentication. Both this property and [SecretKey](#secretkey-property-amazonkms-component) must be set before attempting any operations which connect to the server. # Aliases Property ([AmazonKMS](#amazonkms-component) Component) A collection of aliases. ## Syntax *Delphi Syntax* ```text property Aliases: TckAWSAliasList read get_Aliases; ``` ## Remarks This collection holds a list of [AWSAlias](#awsalias-type) items. Calling [ListAliases](#listaliases-method-amazonkms-component) will populate this collection. This property is read-only and not available at design time. Please refer to the [AWSAlias](#awsalias-type) type for a complete list of fields. # AliasMarker Property ([AmazonKMS](#amazonkms-component) Component) A marker indicating what page of aliases to return next. ## Syntax *Delphi Syntax* ```text property AliasMarker: String read get_AliasMarker write set_AliasMarker; ``` ## Default Value '' ## Remarks This property will be populated when [ListAliases](#listaliases-method-amazonkms-component) is called if the results are pages and there are more pages. To list all aliases, continue to call [ListAliases](#listaliases-method-amazonkms-component) until this property returns empty string. Refer to [ListAliases](#listaliases-method-amazonkms-component) for more information. This property is not available at design time. # EncryptionContext Property ([AmazonKMS](#amazonkms-component) Component) A collection of encryption context items. ## Syntax *Delphi Syntax* ```text property EncryptionContext: TckAWSContextItemList read get_EncryptionContext write set_EncryptionContext; ``` ## Remarks This collection holds a list of [AWSContextItem](#awscontextitem-type) items. Calling [AddEncryptionContextItem](#addencryptioncontextitem-method-amazonkms-component) will populate this collection. The items in this collection are used when [Encrypt](#encrypt-method-amazonkms-component), [Decrypt](#decrypt-method-amazonkms-component), [GenerateDataKey](#generatedatakey-method-amazonkms-component), or [GenerateDataKeyPair](#generatedatakeypair-method-amazonkms-component) is called. This property is not available at design time. Please refer to the [AWSContextItem](#awscontextitem-type) type for a complete list of fields. # Firewall Property ([AmazonKMS](#amazonkms-component) Component) A set of properties related to firewall access. ## Syntax *Delphi Syntax* ```text property Firewall: TckFirewall read get_Firewall write set_Firewall; ``` ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the component will attempt to connect. Please refer to the [Firewall](#firewall-type) type for a complete list of fields. # Idle Property ([AmazonKMS](#amazonkms-component) Component) The current status of the component. ## Syntax *Delphi Syntax* ```text property Idle: Boolean read get_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. # IncludeKeyDetails Property ([AmazonKMS](#amazonkms-component) Component) Whether to attempt to retrieve full details when listing KMS keys. ## Syntax *Delphi Syntax* ```text property IncludeKeyDetails: Boolean read get_IncludeKeyDetails write set_IncludeKeyDetails; ``` ## Default Value false ## Remarks This property specifies whether the component should make additional requests when [ListKeys](#listkeys-method-amazonkms-component) is called in order to retrieve full information for each KMS key. By default, Amazon will only return the [ARN](#AWSKey_f_ARN) and [Id](#AWSKey_f_Id) of each KMS key. If this property is enabled, then after the initial listing is returned, the component will call [GetKeyInfo](#getkeyinfo-method-amazonkms-component) 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](#keys-property-amazonkms-component) collection. Any KMS keys for which the [GetKeyInfo](#getkeyinfo-method-amazonkms-component) call fails will only have their [ARN](#AWSKey_f_ARN) and [Id](#AWSKey_f_Id) properties populated, as usual. This property is not available at design time. # InputData Property ([AmazonKMS](#amazonkms-component) Component) The data to process. ## Syntax *Delphi Syntax* ```text property InputData: String read get_InputData write set_InputData; property InputDataB: TBytes read get_InputDataB write set_InputDataB; ``` ## Default Value '' ## Remarks This property specifies the data that should be processed in a cryptographic operation. ### Input Sources & Output Destinations The component 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. An input stream supplied via the [SetInputStream](#setinputstream-method-amazonkms-component) method 2. The [InputFile](#inputfile-property-amazonkms-component) property 3. The InputData property The first valid input source found is used. The order in which the output properties are considered is as follows: 1. An output stream supplied via the [SetOutputStream](#setoutputstream-method-amazonkms-component) method 2. The [OutputFile](#outputfile-property-amazonkms-component) property 3. The [OutputData](#outputdata-property-amazonkms-component) property This property is not available at design time. # InputFile Property ([AmazonKMS](#amazonkms-component) Component) The file whose data should be processed. ## Syntax *Delphi Syntax* ```text property InputFile: String read get_InputFile write set_InputFile; ``` ## 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. Setting this property to a non-empty value will discard any stream set using the [SetInputStream](#setinputstream-method-amazonkms-component) method. Similarly, passing a non-null value to the aforementioned method will clear this property. ### Input Sources & Output Destinations The component 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. An input stream supplied via the [SetInputStream](#setinputstream-method-amazonkms-component) method 2. The InputFile property 3. The [InputData](#inputdata-property-amazonkms-component) property The first valid input source found is used. The order in which the output properties are considered is as follows: 1. An output stream supplied via the [SetOutputStream](#setoutputstream-method-amazonkms-component) method 2. The [OutputFile](#outputfile-property-amazonkms-component) property 3. The [OutputData](#outputdata-property-amazonkms-component) property # KeyData Property ([AmazonKMS](#amazonkms-component) Component) The downloaded key information. ## Syntax *Delphi Syntax* ```text property KeyData: TckAWSKeyData read get_KeyData; ``` ## Remarks This property holds an [AWSKeyData](#awskeydata-type) object. It may represent any of the following, depending on which method was called: - When [GetPublicKey](#getpublickey-method-amazonkms-component) is called, it will contain the specified KMS key's public key, plus additional information about it. - When [GenerateDataKey](#generatedatakey-method-amazonkms-component) is called, it will contain the data key and information about it. - When [GenerateDataKeyPair](#generatedatakeypair-method-amazonkms-component) is called, it will contain the data key pair and information about it. This property is read-only and not available at design time. Please refer to the [AWSKeyData](#awskeydata-type) type for a complete list of fields. # KeyMarker Property ([AmazonKMS](#amazonkms-component) Component) A marker indicating what page of KMS keys to return next. ## Syntax *Delphi Syntax* ```text property KeyMarker: String read get_KeyMarker write set_KeyMarker; ``` ## Default Value '' ## Remarks This property will be populated when [ListKeys](#listkeys-method-amazonkms-component) is called if the results are paged and there are more pages. To list all KMS keys, continue to call [ListKeys](#listkeys-method-amazonkms-component) until this property returns empty string. Refer to [ListKeys](#listkeys-method-amazonkms-component) for more information. This property is not available at design time. # Keys Property ([AmazonKMS](#amazonkms-component) Component) A collection of keys. ## Syntax *Delphi Syntax* ```text property Keys: TckAWSKeyList read get_Keys; ``` ## Remarks This collection holds a list of [AWSKey](#awskey-type) items. Calling [ListKeys](#listkeys-method-amazonkms-component) will populate this collection. This property is read-only and not available at design time. Please refer to the [AWSKey](#awskey-type) type for a complete list of fields. # LocalHost Property ([AmazonKMS](#amazonkms-component) Component) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Delphi Syntax* ```text property LocalHost: String read get_LocalHost write set_LocalHost; ``` ## 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 component initiate connections (or accept in the case of server components) 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 component 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. # OtherHeaders Property ([AmazonKMS](#amazonkms-component) Component) Other headers as determined by the user (optional). ## Syntax *Delphi Syntax* ```text property OtherHeaders: String read get_OtherHeaders write set_OtherHeaders; ``` ## 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 (*'#13#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 component beyond what is provided. This property is not available at design time. # OutputData Property ([AmazonKMS](#amazonkms-component) Component) The output data. ## Syntax *Delphi Syntax* ```text property OutputData: String read get_OutputData write set_OutputData; property OutputDataB: TBytes read get_OutputDataB write set_OutputDataB; ``` ## Default Value '' ## Remarks This property is populated with the data that was output from a successful cryptographic operation. NOTE: For the [Verify](#verify-method-amazonkms-component) operation, this property functions as a secondary input property instead (along with [InputData](#inputdata-property-amazonkms-component)); refer to the [Verify](#verify-method-amazonkms-component) method for more information. ### Input Sources & Output Destinations The component 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. An input stream supplied via the [SetInputStream](#setinputstream-method-amazonkms-component) method 2. The [InputFile](#inputfile-property-amazonkms-component) property 3. The [InputData](#inputdata-property-amazonkms-component) property The first valid input source found is used. The order in which the output properties are considered is as follows: 1. An output stream supplied via the [SetOutputStream](#setoutputstream-method-amazonkms-component) method 2. The [OutputFile](#outputfile-property-amazonkms-component) property 3. The OutputData property This property is not available at design time. # OutputFile Property ([AmazonKMS](#amazonkms-component) Component) The file to which output data should be written. ## Syntax *Delphi Syntax* ```text property OutputFile: String read get_OutputFile write set_OutputFile; ``` ## Default Value '' ## Remarks This property specifies the file to which data output from a successful cryptographic operation should be written. Setting this property to a non-empty value will discard any stream set using the [SetOutputStream](#setoutputstream-method-amazonkms-component) method. Similarly, passing a non-null value to the aforementioned method will clear this property. NOTE: For the [Verify](#verify-method-amazonkms-component) operation, the specified file functions as a secondary input file instead (along with [InputFile](#inputfile-property-amazonkms-component)); refer to the [Verify](#verify-method-amazonkms-component) method for more information. ### Input Sources & Output Destinations The component 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. An input stream supplied via the [SetInputStream](#setinputstream-method-amazonkms-component) method 2. The [InputFile](#inputfile-property-amazonkms-component) property 3. The [InputData](#inputdata-property-amazonkms-component) property The first valid input source found is used. The order in which the output properties are considered is as follows: 1. An output stream supplied via the [SetOutputStream](#setoutputstream-method-amazonkms-component) method 2. The OutputFile property 3. The [OutputData](#outputdata-property-amazonkms-component) property # Overwrite Property ([AmazonKMS](#amazonkms-component) Component) Whether the output file should be overwritten if necessary. ## Syntax *Delphi Syntax* ```text property Overwrite: Boolean read get_Overwrite write set_Overwrite; ``` ## Default Value false ## Remarks This property controls whether the specified [OutputFile](#outputfile-property-amazonkms-component) should be overwritten if it already exists. # ParsedHeaders Property ([AmazonKMS](#amazonkms-component) Component) This property includes a collection of headers returned from the last request. ## Syntax *Delphi Syntax* ```text property ParsedHeaders: TckHeaderList read get_ParsedHeaders; ``` ## Remarks This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each [Header](#header-type) in this collection contains information describing that header. [MaxHeaders](#MaxHeaders) can be used to control the maximum number of headers saved. This property is read-only and not available at design time. Please refer to the [Header](#header-type) type for a complete list of fields. # Proxy Property ([AmazonKMS](#amazonkms-component) Component) A set of properties related to proxy access. ## Syntax *Delphi Syntax* ```text property Proxy: TckProxy read get_Proxy write set_Proxy; ``` ## Remarks This property contains fields describing the proxy through which the component will attempt to connect. Please refer to the [Proxy](#proxy-type) type for a complete list of fields. # QueryParams Property ([AmazonKMS](#amazonkms-component) Component) Additional query parameters to be included in the request. ## Syntax *Delphi Syntax* ```text property QueryParams: TckQueryParamList read get_QueryParams write set_QueryParams; ``` ## Remarks This is a collection of query parameters that will be added to the request. Parameters can be added via the [AddQueryParam](#addqueryparam-method-amazonkms-component) method. Please refer to the [QueryParam](#queryparam-type) type for a complete list of fields. # Region Property ([AmazonKMS](#amazonkms-component) Component) The region that the component will make requests against. ## Syntax *Delphi Syntax* ```text property Region: String read get_Region write set_Region; ``` ## Default Value 'us-east-1' ## Remarks This property controls which region the component will make requests against. By default the component 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: | Value | Region | | --- | --- | | us-east-1 (Default) | US East (N. Virginia) | | us-east-2 | US East (Ohio) | | us-west-1 | US West (N. California) | | us-west-2 | US West (Oregon) | | af-south-1 | Africa (Cape Town) | | ap-east-1 | Asia Pacific (Hong Kong) | | ap-northeast-1 | Asia Pacific (Tokyo) | | ap-northeast-2 | Asia Pacific (Seoul) | | ap-northeast-3 | Asia Pacific (Osaka-Local) | | ap-south-1 | Asia Pacific (Mumbai) | | ap-southeast-1 | Asia Pacific (Singapore) | | ap-southeast-2 | Asia Pacific (Sydney) | | ca-central-1 | Canada (Central) | | cn-north-1 | China (Beijing) | | cn-northwest-1 | China (Ningxia) | | eu-central-1 | Europe (Frankfurt) | | eu-north-1 | Europe (Stockholm) | | eu-south-1 | Europe (Milan) | | eu-west-1 | Europe (Ireland) | | eu-west-2 | Europe (London) | | eu-west-3 | Europe (Paris) | | me-south-1 | Middle East (Bahrain) | | sa-east-1 | South America (Sao Paulo) | | us-gov-east-1 | AWS GovCloud (US East) | | us-gov-west-1 | AWS GovCloud (US West) | The component will always convert this property's value to lowercase. If this property is cleared, the component will reset it to the default value. # SecretKey Property ([AmazonKMS](#amazonkms-component) Component) The secret key to use for authentication. ## Syntax *Delphi Syntax* ```text property SecretKey: String read get_SecretKey write set_SecretKey; ``` ## Default Value '' ## Remarks This property specifies the secret key that should be used for authentication. Both this property and [AccessKey](#accesskey-property-amazonkms-component) must be set before attempting any operations which connect to the server. # SSLAcceptServerCert Property ([AmazonKMS](#amazonkms-component) Component) Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax *Delphi Syntax* ```text property SSLAcceptServerCert: TckCertificate read get_SSLAcceptServerCert write set_SSLAcceptServerCert; ``` ## Remarks If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally. NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLCert Property ([AmazonKMS](#amazonkms-component) Component) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax *Delphi Syntax* ```text property SSLCert: TckCertificate read get_SSLCert write set_SSLCert; ``` ## Remarks This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the [Encoded](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the store and subject fields. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLProvider Property ([AmazonKMS](#amazonkms-component) Component) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax *Delphi Syntax* ```text property SSLProvider: TckTSSLProviders read get_SSLProvider write set_SSLProvider; TckTSSLProviders = ( sslpAutomatic, sslpPlatform, sslpInternal ); ``` ## Default Value sslpAutomatic ## 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 component 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: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform. When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the component will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. # SSLServerCert Property ([AmazonKMS](#amazonkms-component) Component) The server certificate for the last established connection. ## Syntax *Delphi Syntax* ```text property SSLServerCert: TckCertificate read get_SSLServerCert; ``` ## Remarks This property contains the server certificate for the last established connection. SSLServerCert is reset every time a new connection is attempted. This property is read-only. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # Timeout Property ([AmazonKMS](#amazonkms-component) Component) The timeout for the component. ## Syntax *Delphi Syntax* ```text property Timeout: Integer read get_Timeout write set_Timeout; ``` ## 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 component will wait for the operation to complete before returning control. The component will use [DoEvents](#doevents-method-amazonkms-component) 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 component raises an exception. 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. # AddEncryptionContextItem Method ([AmazonKMS](#amazonkms-component) Component) Adds an item to the EncryptionContext properties. ## Syntax *Delphi Syntax* ```text procedure AddEncryptionContextItem(Name: String; Value: String); ``` ## Remarks This method adds an item to the **EncryptionContext*** collection. *Name* specifies the name of the item, and *Value* specifies the value of the item. # AddQueryParam Method ([AmazonKMS](#amazonkms-component) Component) Adds a query parameter to the QueryParams properties. ## Syntax *Delphi Syntax* ```text procedure AddQueryParam(Name: String; Value: String); ``` ## Remarks This method is used to add a query parameter to the [QueryParams](#queryparams-property-amazonkms-component) collection. *Name* specifies the name of the parameter, and *Value* specifies the value of the parameter. All specified *Value*s will be URL encoded by the component automatically. Consult the service documentation for details on the available parameters. # CancelKeyDeletion Method ([AmazonKMS](#amazonkms-component) Component) Cancels the deletion of the specified KMS key. ## Syntax *Delphi Syntax* ```text procedure CancelKeyDeletion(KeyId: String); ``` ## Remarks This method cancels the deletion of the KMS key specified by *KeyId*. Refer to the [ScheduleKeyDeletion](#schedulekeydeletion-method-amazonkms-component) 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](#region-property-amazonkms-component). # ClearKeyData Method ([AmazonKMS](#amazonkms-component) Component) Clears information stored in the KeyData properties. ## Syntax *Delphi Syntax* ```text procedure ClearKeyData(PlaintextOnly: Boolean); ``` ## Remarks This method clears the information stored in the [KeyData](#keydata-property-amazonkms-component) properties, removing it from memory. If the *PlaintextOnly* parameter is *True*, only the [PlaintextKey](#AWSKeyData_f_PlaintextKey) property is cleared. # Config Method ([AmazonKMS](#amazonkms-component) Component) Sets or retrieves a configuration setting. ## Syntax *Delphi Syntax* ```text function Config(ConfigurationString: String): String; ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-amazonkms-component) for the component. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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](#config-settings-amazonkms-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # CreateAlias Method ([AmazonKMS](#amazonkms-component) Component) Creates a new alias. ## Syntax *Delphi Syntax* ```text procedure CreateAlias(Name: String; KeyId: String); ``` ## 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](#region-property-amazonkms-component). # CreateKey Method ([AmazonKMS](#amazonkms-component) Component) Creates a new KMS key. ## Syntax *Delphi Syntax* ```text function CreateKey(KeySpec: String; ForSigning: Boolean; Description: String): String; ``` ## 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 (*False*) or signing and verification (*True*). 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](#updatekeydescription-method-amazonkms-component) method. To create the KMS key in a custom key store, set the [CustomKeyStoreId](#CustomKeyStoreId) configuration setting before calling this method. To set the KMS key's key policy, set the [CreateKeyPolicy](#CreateKeyPolicy) configuration setting before calling this method. Refer to these configuration settings for more information. # Decrypt Method ([AmazonKMS](#amazonkms-component) Component) Decrypts data using a KMS key. ## Syntax *Delphi Syntax* ```text procedure Decrypt(KeyId: String; Algorithm: String); ``` ## Remarks This method decrypts data using the KMS key specified by *KeyId* and the given *Algorithm*. The data to decrypt is taken from the input stream supplied via the [SetInputStream](#setinputstream-method-amazonkms-component) method, the specified [InputFile](#inputfile-property-amazonkms-component), or the [InputData](#inputdata-property-amazonkms-component) property. The decrypted data is output to the output stream supplied via the [SetOutputStream](#setoutputstream-method-amazonkms-component) method, the specified [OutputFile](#outputfile-property-amazonkms-component), or the [OutputData](#outputdata-property-amazonkms-component) 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](#region-property-amazonkms-component). 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: | KMS key's Key Spec | Valid Algorithms | | --- | --- | | SYMMETRIC_DEFAULT | SYMMETRIC_DEFAULT (default if empty) | | RSA_2048 | RSAES_OAEP_SHA_1 RSAES_OAEP_SHA_256 | | RSA_3072 | RSAES_OAEP_SHA_1 RSAES_OAEP_SHA_256 | | RSA_4096 | RSAES_OAEP_SHA_1 RSAES_OAEP_SHA_256 | If *Algorithm* is *SYMMETRIC_DEFAULT*, the encryption context items in the [EncryptionContext](#encryptioncontext-property-amazonkms-component) collection 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 [State](#AWSKey_f_State) is anything other than *aksEnabled (0)*. - It is for signing/verification instead of encryption/decryption (see [ForSigning](#AWSKey_f_ForSigning)). - It is an AWS-managed KMS key (see [AWSManaged](#AWSKey_f_AWSManaged)). # DeleteAlias Method ([AmazonKMS](#amazonkms-component) Component) Deletes an alias. ## Syntax *Delphi Syntax* ```text procedure DeleteAlias(AliasName: String); ``` ## 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](#region-property-amazonkms-component) # DoEvents Method ([AmazonKMS](#amazonkms-component) Component) This method processes events from the internal message queue. ## Syntax *Delphi Syntax* ```text procedure DoEvents(); ``` ## Remarks When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns. # Encrypt Method ([AmazonKMS](#amazonkms-component) Component) Encrypts data using a KMS key. ## Syntax *Delphi Syntax* ```text procedure Encrypt(KeyId: String; Algorithm: String); ``` ## Remarks This method encrypts data using the KMS key specified by *KeyId* and the given *Algorithm*. The data to encrypt is taken from the input stream supplied via the [SetInputStream](#setinputstream-method-amazonkms-component) method, the specified [InputFile](#inputfile-property-amazonkms-component), or the [InputData](#inputdata-property-amazonkms-component) property. The encrypted data is output to the output stream supplied via the [SetOutputStream](#setoutputstream-method-amazonkms-component) method, the specified [OutputFile](#outputfile-property-amazonkms-component), or the [OutputData](#outputdata-property-amazonkms-component) 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](#region-property-amazonkms-component). 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. | KMS key's Key Spec | Valid Algorithms | Max Bytes | | --- | --- | --- | | SYMMETRIC_DEFAULT | SYMMETRIC_DEFAULT (default if empty) | 4096 | | RSA_2048 | RSAES_OAEP_SHA_1 RSAES_OAEP_SHA_256 | 214 190 | | RSA_3072 | RSAES_OAEP_SHA_1 RSAES_OAEP_SHA_256 | 342 318 | | RSA_4096 | RSAES_OAEP_SHA_1 RSAES_OAEP_SHA_256 | 470 446 | Note that it is important to keep track of the encryption algorithm used, since it must be specified again when calling [Decrypt](#decrypt-method-amazonkms-component) (or [ReEncrypt](#reencrypt-method-amazonkms-component)) later. If *Algorithm* is *SYMMETRIC_DEFAULT*, the encryption context items in the [EncryptionContext](#encryptioncontext-property-amazonkms-component) collection 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 [State](#AWSKey_f_State) is anything other than *aksEnabled (0)*. - It is for signing/verification instead of encryption/decryption (see [ForSigning](#AWSKey_f_ForSigning)). - It is an AWS-managed KMS key (see [AWSManaged](#AWSKey_f_AWSManaged)). # GenerateDataKey Method ([AmazonKMS](#amazonkms-component) Component) Generates a data key that can be used outside of Amazon KMS. ## Syntax *Delphi Syntax* ```text procedure GenerateDataKey(KeySpec: String; KeyId: String; IncludePlaintext: Boolean); ``` ## 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](#keydata-property-amazonkms-component) properties, refer to their documentation for more information: - [ARN](#AWSKeyData_f_ARN) - [EncryptedKey](#AWSKeyData_f_EncryptedKey) - [KeySpec](#AWSKeyData_f_KeySpec) - [PlaintextKey](#AWSKeyData_f_PlaintextKey) (if *True* 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](#region-property-amazonkms-component). 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](#encryptioncontext-property-amazonkms-component) collection 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 [State](#AWSKey_f_State) is anything other than *aksEnabled (0)*. - It is asymmetric (see [KeySpec](#AWSKey_f_KeySpec)). - It is for signing/verification instead of encryption/decryption (see [ForSigning](#AWSKey_f_ForSigning)). - It is an AWS-managed KMS key (see [AWSManaged](#AWSKey_f_AWSManaged)). # GenerateDataKeyPair Method ([AmazonKMS](#amazonkms-component) Component) Generates a data key pair that can be used outside of Amazon KMS. ## Syntax *Delphi Syntax* ```text procedure GenerateDataKeyPair(KeyPairSpec: String; KeyId: String; IncludePlaintext: Boolean); ``` ## 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](#keydata-property-amazonkms-component) properties, refer to their documentation for more information: - [ARN](#AWSKeyData_f_ARN) - [EncryptedKey](#AWSKeyData_f_EncryptedKey) - [KeySpec](#AWSKeyData_f_KeySpec) - [PlaintextKey](#AWSKeyData_f_PlaintextKey) (if *True* is passed for *IncludePlaintext*) - [PublicKey](#AWSKeyData_f_PublicKey) 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](#region-property-amazonkms-component). 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](#encryptioncontext-property-amazonkms-component) collection 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 [State](#AWSKey_f_State) is anything other than *aksEnabled (0)*. - It is asymmetric (see [KeySpec](#AWSKey_f_KeySpec)). - It is for signing/verification instead of encryption/decryption (see [ForSigning](#AWSKey_f_ForSigning)). - It is an AWS-managed KMS key (see [AWSManaged](#AWSKey_f_AWSManaged)). # GenerateRandomBytes Method ([AmazonKMS](#amazonkms-component) Component) Generates a cryptographically-secure random byte string. ## Syntax *Delphi Syntax* ```text procedure GenerateRandomBytes(NumBytes: Integer); ``` ## 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 output stream supplied via the [SetOutputStream](#setoutputstream-method-amazonkms-component) method, the [OutputFile](#outputfile-property-amazonkms-component), or the [OutputData](#outputdata-property-amazonkms-component) property. The value passed for *NumBytes* must be in the range 1 to 1024. # GetKeyInfo Method ([AmazonKMS](#amazonkms-component) Component) Gets information about a KMS key. ## Syntax *Delphi Syntax* ```text procedure GetKeyInfo(KeyId: String); ``` ## Remarks This method gets information about the KMS key specified by *KeyId*. When the information is returned, the component clears the [Keys](#keys-property-amazonkms-component) collection and repopulates them with a single item that contains the KMS key's information. The [KeyList](#keylist-event-amazonkms-component) 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](#region-property-amazonkms-component). 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](#amazonkms-component) Component) Retrieves the key rotation status for a KMS key. ## Syntax *Delphi Syntax* ```text function GetKeyRotationStatus(KeyId: String): Boolean; ``` ## Remarks This method retrieves the key rotation status for the KMS key specified by *KeyId*; it will return *True* if the KMS key's key material is set to be automatically rotated, or *False* if not. The value passed for the *KeyId* parameter must be the Id or ARN of a KMS key in the current [Region](#region-property-amazonkms-component). 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 *False* 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 *False* if the server returns an error for any other reason. # GetPublicKey Method ([AmazonKMS](#amazonkms-component) Component) Retrieves the public key of an asymmetric KMS key. ## Syntax *Delphi Syntax* ```text procedure GetPublicKey(KeyId: String); ``` ## 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](#keydata-property-amazonkms-component) properties, refer to their documentation for more information: - [Algorithms](#AWSKeyData_f_Algorithms) - [ARN](#AWSKeyData_f_ARN) - [ForSigning](#AWSKeyData_f_ForSigning) - [KeySpec](#AWSKeyData_f_KeySpec) - [PublicKey](#AWSKeyData_f_PublicKey) This method will fail if any of the following are true regarding the specified KMS key: - Its [State](#AWSKey_f_State) is anything other than *aksEnabled (0)*. - It is symmetric (see [KeySpec](#AWSKey_f_KeySpec)). - It is an AWS-managed KMS key (see [AWSManaged](#AWSKey_f_AWSManaged)). # ListAliases Method ([AmazonKMS](#amazonkms-component) Component) Lists aliases in the current account and region. ## Syntax *Delphi Syntax* ```text procedure ListAliases(ForKeyId: String); ``` ## Remarks This method lists the aliases in the current account and [Region](#region-property-amazonkms-component). Optionally, aliases for a specific KMS key (in the current account and [Region](#region-property-amazonkms-component)) can be listed by passing its Id or ARN for the *ForKeyId* parameter. Calling this method will fire the [AliasList](#aliaslist-event-amazonkms-component) event once for each alias, and will also populate the [Aliases](#aliases-property-amazonkms-component) collection. If there are still more aliases available to list when this method returns, the [AliasMarker](#aliasmarker-property-amazonkms-component) property will be populated. Continue to call this method until [AliasMarker](#aliasmarker-property-amazonkms-component) is empty to accumulate all pages of results in the [Aliases](#aliases-property-amazonkms-component) collection. The [MaxAliases](#MaxAliases) configuration setting can be used to control the maximum number of results to return at once. # ListKeys Method ([AmazonKMS](#amazonkms-component) Component) Lists KMS keys in the current account and region. ## Syntax *Delphi Syntax* ```text procedure ListKeys(); ``` ## Remarks This method lists the KMS keys in the current account and [Region](#region-property-amazonkms-component). Calling this method will fire the [KeyList](#keylist-event-amazonkms-component) event once for each KMS key, and will also populate the [Keys](#keys-property-amazonkms-component) collection. However, note that by default only the [ARN](#AWSKey_f_ARN) and [Id](#AWSKey_f_Id) properties will be populated, since the server does not return full information for KMS keys when listing them. The [IncludeKeyDetails](#includekeydetails-property-amazonkms-component) property can be enabled to have the component 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](#keymarker-property-amazonkms-component) property will be populated. Continue to call this method until [KeyMarker](#keymarker-property-amazonkms-component) is empty to accumulate all pages of results in the [Keys](#keys-property-amazonkms-component) collection. The [MaxKeys](#MaxKeys) configuration setting can be used to control the maximum number of results to return at once. # ReEncrypt Method ([AmazonKMS](#amazonkms-component) Component) Decrypts data using one KMS key and re-encrypts it using another KMS key. ## Syntax *Delphi Syntax* ```text procedure ReEncrypt(OldKeyId: String; OldAlgorithm: String; NewKeyId: String; NewAlgorithm: String); ``` ## 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 input stream supplied via the [SetInputStream](#setinputstream-method-amazonkms-component) method, the specified [InputFile](#inputfile-property-amazonkms-component), or the [InputData](#inputdata-property-amazonkms-component) property. The re-encrypted data is output to the output stream supplied via the [SetOutputStream](#setoutputstream-method-amazonkms-component) method, the specified [OutputFile](#outputfile-property-amazonkms-component), or the [OutputData](#outputdata-property-amazonkms-component) 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](#region-property-amazonkms-component). 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: | KMS key's Key Spec | Valid Algorithms | | --- | --- | | SYMMETRIC_DEFAULT | SYMMETRIC_DEFAULT (default if empty) | | RSA_2048 | RSAES_OAEP_SHA_1 RSAES_OAEP_SHA_256 | | RSA_3072 | RSAES_OAEP_SHA_1 RSAES_OAEP_SHA_256 | | RSA_4096 | RSAES_OAEP_SHA_1 RSAES_OAEP_SHA_256 | Note that it is important to keep track of the new encryption algorithm used, since it must be specified again when calling [Decrypt](#decrypt-method-amazonkms-component) (or ReEncrypt) later. If *OldAlgorithm* is *SYMMETRIC_DEFAULT*, the encryption context items in the [EncryptionContext](#encryptioncontext-property-amazonkms-component) collection 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](#encryptioncontext-property-amazonkms-component) collection 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](#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 [State](#AWSKey_f_State) is anything other than *aksEnabled (0)*. - It is for signing/verification instead of encryption/decryption (see [ForSigning](#AWSKey_f_ForSigning)). - It is an AWS-managed KMS key (see [AWSManaged](#AWSKey_f_AWSManaged)). # Reset Method ([AmazonKMS](#amazonkms-component) Component) Resets the component to its initial state. ## Syntax *Delphi Syntax* ```text procedure Reset(); ``` ## Remarks This method resets the component to its initial state. # ScheduleKeyDeletion Method ([AmazonKMS](#amazonkms-component) Component) Schedules the deletion of a KMS key. ## Syntax *Delphi Syntax* ```text procedure ScheduleKeyDeletion(KeyId: String; DaysToWait: Integer); ``` ## 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](#amazonkms-component) Component) Sends a custom request to the server. ## Syntax *Delphi Syntax* ```text procedure SendCustomRequest(Action: String); ``` ## 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 component does the following: 1. Builds a request URL, including query parameters, based on the following: - [Region](#region-property-amazonkms-component) - [QueryParams](#queryparams-property-amazonkms-component) 2. Adds request headers from [OtherHeaders](#otherheaders-property-amazonkms-component). 3. Adds any request body supplied via the stream specified using [SetInputStream](#setinputstream-method-amazonkms-component), the specified [InputFile](#inputfile-property-amazonkms-component), or [InputData](#inputdata-property-amazonkms-component). 4. Signs the request. 5. Sends the request to the server. 6. Stores the response headers in the [ParsedHeaders](#parsedheaders-property-amazonkms-component) collection; and the response body in the stream specified using [SetOutputStream](#setoutputstream-method-amazonkms-component), the specified [OutputFile](#outputfile-property-amazonkms-component), or [OutputData](#outputdata-property-amazonkms-component). If the response body is JSON data, the [XPath](#XPath), [XText](#XText), and other **X*** configuration settings can then be used to navigate and extract information from it. # SetInputStream Method ([AmazonKMS](#amazonkms-component) Component) Sets the stream whose data should be processed. ## Syntax *Delphi Syntax* ```text procedure SetInputStream(InputStream: TStream); ``` ## Remarks This method sets the stream whose data should be processed in a cryptographic operation. Passing a non-null value for *InputStream* will cause the [InputFile](#inputfile-property-amazonkms-component) property to be cleared. Similarly, setting [InputFile](#inputfile-property-amazonkms-component) to a non-empty value will discard any stream set using this method. ### Input Sources & Output Destinations The component 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. An input stream supplied via the SetInputStream method 2. The [InputFile](#inputfile-property-amazonkms-component) property 3. The [InputData](#inputdata-property-amazonkms-component) property The first valid input source found is used. The order in which the output properties are considered is as follows: 1. An output stream supplied via the [SetOutputStream](#setoutputstream-method-amazonkms-component) method 2. The [OutputFile](#outputfile-property-amazonkms-component) property 3. The [OutputData](#outputdata-property-amazonkms-component) property # SetKeyEnabled Method ([AmazonKMS](#amazonkms-component) Component) Enables or disables a KMS key. ## Syntax *Delphi Syntax* ```text procedure SetKeyEnabled(KeyId: String; Enabled: Boolean); ``` ## 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](#region-property-amazonkms-component). This method will fail if any of the following are true regarding the specified KMS key: - Its [State](#AWSKey_f_State) is *aksPendingDeletion (2)* or *aksPendingImport (3)*. - It is an AWS-managed KMS key (see [AWSManaged](#AWSKey_f_AWSManaged)). # SetKeyRotationStatus Method ([AmazonKMS](#amazonkms-component) Component) Enables or disables automatic key rotation for a KMS key. ## Syntax *Delphi Syntax* ```text procedure SetKeyRotationStatus(KeyId: String; Enabled: Boolean); ``` ## 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](#region-property-amazonkms-component). This method will fail if any of the following are true regarding the specified KMS key: - Its [State](#AWSKey_f_State) is anything other than *aksEnabled (0)*. - It is asymmetric (see [KeySpec](#AWSKey_f_KeySpec)). - It has imported key material (see [Origin](#AWSKey_f_Origin)). - It resides in a custom key store (see [CustomKeyStoreId](#AWSKey_f_CustomKeyStoreId)). - It is an AWS-managed KMS key (see [AWSManaged](#AWSKey_f_AWSManaged)). # SetOutputStream Method ([AmazonKMS](#amazonkms-component) Component) Sets the stream to which output data should be written. ## Syntax *Delphi Syntax* ```text procedure SetOutputStream(OutputStream: TStream); ``` ## Remarks This method sets the stream to which data output from a successful cryptographic operation should be written. Passing a non-null value for *OutputStream* will cause the [OutputFile](#outputfile-property-amazonkms-component) property to be cleared. Similarly, setting [OutputFile](#outputfile-property-amazonkms-component) to a non-empty value will discard any stream set using this method. ### Input Sources & Output Destinations The component 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. An input stream supplied via the [SetInputStream](#setinputstream-method-amazonkms-component) method 2. The [InputFile](#inputfile-property-amazonkms-component) property 3. The [InputData](#inputdata-property-amazonkms-component) property The first valid input source found is used. The order in which the output properties are considered is as follows: 1. An output stream supplied via the SetOutputStream method 2. The [OutputFile](#outputfile-property-amazonkms-component) property 3. The [OutputData](#outputdata-property-amazonkms-component) property # Sign Method ([AmazonKMS](#amazonkms-component) Component) Signs a message using a KMS key. ## Syntax *Delphi Syntax* ```text procedure Sign(KeyId: String; Algorithm: String; IsDigest: Boolean); ``` ## 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 input stream supplied via the [SetInputStream](#setinputstream-method-amazonkms-component) method, the specified [InputFile](#inputfile-property-amazonkms-component), or the [InputData](#inputdata-property-amazonkms-component) property. The signature data is output to the output stream supplied via the [SetOutputStream](#setoutputstream-method-amazonkms-component) method, the specified [OutputFile](#outputfile-property-amazonkms-component), or the [OutputData](#outputdata-property-amazonkms-component) 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](#region-property-amazonkms-component). 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 (*False*) or a message digest (*True*). When supplying a message digest, keep in mind that the same digest will need to be provided in order to [Verify](#verify-method-amazonkms-component) the signature later. Note that a maximum of 4096 bytes of message data can be sent to the server. If *IsDigest* is *False*, and more than 4096 bytes of message data are provided, the component will automatically compute an appropriate message digest and send it instead. In such cases, the computed digest is made available via the [MessageDigest](#MessageDigest) configuration setting. This method will fail if any of the following are true regarding the specified KMS key: - Its [State](#AWSKey_f_State) is anything other than *aksEnabled (0)*. - It is symmetric (see [KeySpec](#AWSKey_f_KeySpec)). - It is for encryption/decryption instead of signing/verification (see [ForSigning](#AWSKey_f_ForSigning)). - It is an AWS-managed KMS key (see [AWSManaged](#AWSKey_f_AWSManaged)). # UpdateAlias Method ([AmazonKMS](#amazonkms-component) Component) Updates an alias to refer to a different KMS key. ## Syntax *Delphi Syntax* ```text procedure UpdateAlias(AliasName: String; NewKeyId: String); ``` ## 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](#region-property-amazonkms-component) The value passed for the *NewKeyId* parameter must be the Id or ARN of a KMS key in the current account and [Region](#region-property-amazonkms-component). 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 [AWSManaged](#AWSKey_f_AWSManaged)). # UpdateKeyDescription Method ([AmazonKMS](#amazonkms-component) Component) Updates a KMS key's description. ## Syntax *Delphi Syntax* ```text procedure UpdateKeyDescription(KeyId: String; NewDescription: String); ``` ## 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](#region-property-amazonkms-component). This method will fail if the specified KMS key's state is *aksPendingDeletion (2)*, or if it is AWS-managed (see [AWSManaged](#AWSKey_f_AWSManaged)). # Verify Method ([AmazonKMS](#amazonkms-component) Component) Verifies a digital signature using a KMS key. ## Syntax *Delphi Syntax* ```text function Verify(KeyId: String; Algorithm: String; IsDigest: Boolean): Boolean; ``` ## 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 input stream supplied via the [SetInputStream](#setinputstream-method-amazonkms-component) method, the specified [InputFile](#inputfile-property-amazonkms-component), or the [InputData](#inputdata-property-amazonkms-component) property. The digital signature data is taken from the specified [OutputFile](#outputfile-property-amazonkms-component) or the [OutputData](#outputdata-property-amazonkms-component) property. If the signature is successfully verified, this method returns *True*, otherwise it returns *False*. 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](#region-property-amazonkms-component). 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 (*False*) or a message digest (*True*). 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](#sign-method-amazonkms-component) method, a maximum of 4096 bytes of message data can be sent to the server. If *IsDigest* is *False*, and more than 4096 bytes of message data are provided, the component will automatically compute an appropriate message digest and send it instead. In such cases, the computed digest is made available via the [MessageDigest](#MessageDigest) configuration setting. This method will fail if any of the following are true regarding the specified KMS key: - Its [State](#AWSKey_f_State) is anything other than *aksEnabled (0)*. - It is symmetric (see [KeySpec](#AWSKey_f_KeySpec)). - It is for encryption/decryption instead of signing/verification (see [ForSigning](#AWSKey_f_ForSigning)). - It is an AWS-managed KMS key (see [AWSManaged](#AWSKey_f_AWSManaged)). # AliasList Event ([AmazonKMS](#amazonkms-component) Component) Fires once for each alias when listing aliases. ## Syntax *Delphi Syntax* ```text type TAliasListEvent = procedure ( Sender: TObject; const ARN: String; const Name: String; const KeyId: String ) of Object; property OnAliasList: TAliasListEvent read FOnAliasList write FOnAliasList; ``` ## Remarks This event fires once for each alias returned when [ListAliases](#listaliases-method-amazonkms-component) 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](#amazonkms-component) Component) Fired when a document finishes transferring. ## Syntax *Delphi Syntax* ```text type TEndTransferEvent = procedure ( Sender: TObject; Direction: Integer ) of Object; property OnEndTransfer: TEndTransferEvent read FOnEndTransfer write FOnEndTransfer; ``` ## Remarks This event is fired first when the client finishes sending data to the server (in a *POST* or *PUT* request) and then 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](#amazonkms-component) Component) Fired when information is available about errors during data delivery. ## Syntax *Delphi Syntax* ```text type TErrorEvent = procedure ( Sender: TObject; ErrorCode: Integer; const Description: String ) of Object; property OnError: TErrorEvent read FOnError write FOnError; ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception. 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](#trappable-errors-amazonkms-component) section. # Header Event ([AmazonKMS](#amazonkms-component) Component) Fired every time a header line comes in. ## Syntax *Delphi Syntax* ```text type THeaderEvent = procedure ( Sender: TObject; const Field: String; const Value: String ) of Object; property OnHeader: THeaderEvent read FOnHeader write FOnHeader; ``` ## 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](#amazonkms-component) Component) Fires once for each KMS key when listing KMS keys. ## Syntax *Delphi Syntax* ```text type TKeyListEvent = procedure ( Sender: TObject; const ARN: String; const Id: String; const AccountId: String; const Description: String; Enabled: Boolean; AWSManaged: Boolean; ForSigning: Boolean; const KeySpec: String; const Algorithms: String; State: Integer; const CreationDate: String; const DeletionDate: String ) of Object; property OnKeyList: TKeyListEvent read FOnKeyList write FOnKeyList; ``` ## Remarks This event fires once for each KMS key returned when [ListKeys](#listkeys-method-amazonkms-component) or [GetKeyInfo](#getkeyinfo-method-amazonkms-component) is called. However, note that only *ARN* and *Id* are populated when [ListKeys](#listkeys-method-amazonkms-component) is called (unless the [IncludeKeyDetails](#includekeydetails-property-amazonkms-component) 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 (*True*) or customer-managed (*False*). *ForSigning* reflects whether the KMS key's usage is signing/verification (*True*) or encryption/decryption (*False*). *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 [ForSigning](#AWSKey_f_ForSigning) is *False*, possible values are: - *SYMMETRIC_DEFAULT* - *RSAES_OAEP_SHA_1* - *RSAES_OAEP_SHA_256* If [ForSigning](#AWSKey_f_ForSigning) is *True*, 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](#listkeys-method-amazonkms-component) 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](#amazonkms-component) Component) Fired once for each log message. ## Syntax *Delphi Syntax* ```text type TLogEvent = procedure ( Sender: TObject; LogLevel: Integer; const Message: String; const LogType: String ) of Object; property OnLog: TLogEvent read FOnLog write FOnLog; ``` ## Remarks This event is fired once for each log message generated by the component. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | 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](#amazonkms-component) Component) Fired after the server presents its certificate to the client. ## Syntax *Delphi Syntax* ```text type TSSLServerAuthenticationEvent = procedure ( Sender: TObject; const CertEncoded: String; const CertEncodedB: TBytes; const CertSubject: String; const CertIssuer: String; const Status: String; var Accept: Boolean ) of Object; property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication; ``` ## 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](#amazonkms-component) Component) Fired when secure connection progress messages are available. ## Syntax *Delphi Syntax* ```text type TSSLStatusEvent = procedure ( Sender: TObject; const Message: String ) of Object; property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus; ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([AmazonKMS](#amazonkms-component) Component) Fired when a document starts transferring (after the headers). ## Syntax *Delphi Syntax* ```text type TStartTransferEvent = procedure ( Sender: TObject; Direction: Integer ) of Object; property OnStartTransfer: TStartTransferEvent read FOnStartTransfer write FOnStartTransfer; ``` ## Remarks This event is fired first when the client starts sending data to the server (in a *POST* or *PUT* request) and then 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](#amazonkms-component) Component) Fired while a document transfers (delivers document). ## Syntax *Delphi Syntax* ```text type TTransferEvent = procedure ( Sender: TObject; Direction: Integer; BytesTransferred: Int64; PercentDone: Integer; const Text: String; const TextB: TBytes ) of Object; property OnTransfer: TTransferEvent read FOnTransfer write FOnTransfer; ``` ## 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. # AWSAlias Type An Amazon KMS alias. ## Remarks This type represents an Amazon KMS alias. The following fields are available: - [ARN](#AWSAlias_f_ARN) - [KeyId](#AWSAlias_f_KeyId) - [Name](#AWSAlias_f_Name) ## Fields **ARN** *String (read-only)* *Default Value: ""* The Amazon resource name (ARN) of the alias. This property reflects the Amazon resource name (ARN) of the alias. **KeyId** *String (read-only)* *Default Value: ""* 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. **Name** *String (read-only)* *Default Value: ""* The name of the alias. This property reflects the name of the alias, including the *alias/* prefix. # AWSContextItem Type An Amazon KMS encryption context item. ## Remarks This type represents an Amazon KMS encryption context item. The following fields are available: - [Name](#AWSContextItem_f_Name) - [Value](#AWSContextItem_f_Value) ## Fields **Name** *String* *Default Value: ""* The name of the context item. This property specifies the name of the context item. **Value** *String* *Default Value: ""* The value of the context item. This property specifies the value of the context item. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valName: String; valValue: String); ``` # AWSKey Type An AWS KMS key. ## Remarks This type represents an AWS KMS key. The following fields are available: - [AccountId](#AWSKey_f_AccountId) - [Algorithms](#AWSKey_f_Algorithms) - [ARN](#AWSKey_f_ARN) - [AWSManaged](#AWSKey_f_AWSManaged) - [CloudHSMClusterId](#AWSKey_f_CloudHSMClusterId) - [CreationDate](#AWSKey_f_CreationDate) - [CustomKeyStoreId](#AWSKey_f_CustomKeyStoreId) - [DeletionDate](#AWSKey_f_DeletionDate) - [Description](#AWSKey_f_Description) - [Enabled](#AWSKey_f_Enabled) - [ExpirationDate](#AWSKey_f_ExpirationDate) - [ForSigning](#AWSKey_f_ForSigning) - [Id](#AWSKey_f_Id) - [KeySpec](#AWSKey_f_KeySpec) - [Origin](#AWSKey_f_Origin) - [State](#AWSKey_f_State) ## Fields **AccountId** *String (read-only)* *Default Value: ""* 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. **Algorithms** *String (read-only)* *Default Value: ""* 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 [ForSigning](#AWSKey_f_ForSigning) is *False*, possible values are: - *SYMMETRIC_DEFAULT* - *RSAES_OAEP_SHA_1* - *RSAES_OAEP_SHA_256* If [ForSigning](#AWSKey_f_ForSigning) is *True*, 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* **ARN** *String (read-only)* *Default Value: ""* The Amazon resource name (ARN) of the KMS key. This property reflects the Amazon resource name (ARN) of the KMS key. **AWSManaged** *Boolean (read-only)* *Default Value: False* Whether the KMS key is AWS-managed. This property reflects whether the KMS key is AWS-managed (*True*) or customer-managed (*False*). **CloudHSMClusterId** *String (read-only)* *Default Value: ""* 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. **CreationDate** *String (read-only)* *Default Value: ""* 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). **CustomKeyStoreId** *String (read-only)* *Default Value: ""* 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. **DeletionDate** *String (read-only)* *Default Value: ""* The date at which the KMS key will be deleted, if applicable. If the KMS key's [State](#AWSKey_f_State) is *aksPendingDeletion (2)*, this property will reflect the deletion date, in seconds since the Unix epoch (including fractional seconds). **Description** *String (read-only)* *Default Value: ""* The KMS key's description. This property reflects the KMS key's description. To change a KMS key's description, use the [UpdateKeyDescription](#updatekeydescription-method-amazonkms-component) method. **Enabled** *Boolean (read-only)* *Default Value: False* Whether the KMS key is enabled. This property reflects whether the KMS key is currently enabled. **ExpirationDate** *String (read-only)* *Default Value: ""* The date at which the KMS key's key material will expire, if applicable. If the KMS key's key material [Origin](#AWSKey_f_Origin) 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). **ForSigning** *Boolean (read-only)* *Default Value: False* Whether the KMS key is for signing or encryption. This property reflects whether the KMS key's usage is signing/verification (*True*) or encryption/decryption (*False*). 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](#sign-method-amazonkms-component) and [Verify](#verify-method-amazonkms-component) operations, but not for [Encrypt](#encrypt-method-amazonkms-component), [Decrypt](#decrypt-method-amazonkms-component) or [ReEncrypt](#reencrypt-method-amazonkms-component) operations. **Id** *String (read-only)* *Default Value: ""* The Id of the KMS key. This property reflects the Id of the KMS key. **KeySpec** *String (read-only)* *Default Value: ""* 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) **Origin** *TckAWSKeyOrigins (read-only)* *Default Value: 0* 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](#listkeys-method-amazonkms-component) is called.) - *akoExternal (1)*: External key material imported into Amazon KMS. - *akoCloudHSM (2)*: Key material from an Amazon CloudHSM cluster. **State** *TckAWSKeyStates (read-only)* *Default Value: 0* 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](#listkeys-method-amazonkms-component) 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. # AWSKeyData Type Key information downloaded from Amazon KMS. ## Remarks This type represents a KMS key's public key, a data key, or a data key pair downloaded from Amazon KMS. The following fields are available: - [Algorithms](#AWSKeyData_f_Algorithms) - [ARN](#AWSKeyData_f_ARN) - [EncryptedKey](#AWSKeyData_f_EncryptedKey) - [ForSigning](#AWSKeyData_f_ForSigning) - [KeySpec](#AWSKeyData_f_KeySpec) - [PlaintextKey](#AWSKeyData_f_PlaintextKey) - [PublicKey](#AWSKeyData_f_PublicKey) ## Fields **Algorithms** *String (read-only)* *Default Value: ""* The algorithms supported by the public key. When [GetPublicKey](#getpublickey-method-amazonkms-component) is called, this property will contain a comma-separated list of algorithms that the [PublicKey](#AWSKeyData_f_PublicKey) can be used with. Always empty when [GenerateDataKey](#generatedatakey-method-amazonkms-component) or [GenerateDataKeyPair](#generatedatakeypair-method-amazonkms-component) is called. If [ForSigning](#AWSKeyData_f_ForSigning) is *False*, possible values are: - *SYMMETRIC_DEFAULT* - *RSAES_OAEP_SHA_1* - *RSAES_OAEP_SHA_256* If [ForSigning](#AWSKeyData_f_ForSigning) is *True*, 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* **ARN** *String (read-only)* *Default Value: ""* The Amazon resource name (ARN) of the associated KMS key. When [GetPublicKey](#getpublickey-method-amazonkms-component) is called, this property reflects the Amazon resource name (ARN) of the KMS key whose [PublicKey](#AWSKeyData_f_PublicKey) was downloaded. When [GenerateDataKey](#generatedatakey-method-amazonkms-component) or [GenerateDataKeyPair](#generatedatakeypair-method-amazonkms-component) 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 [EncryptedKey](#AWSKeyData_f_EncryptedKey). **EncryptedKey** *String (read-only)* *Default Value: ""* The encrypted key or private key data. When [GenerateDataKey](#generatedatakey-method-amazonkms-component) is called, this property reflects the encrypted data key that was downloaded. When [GenerateDataKeyPair](#generatedatakeypair-method-amazonkms-component) is called, this property reflects the encrypted private key of the data key pair that was downloaded. In the case of [GenerateDataKeyPair](#generatedatakeypair-method-amazonkms-component), 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](#getpublickey-method-amazonkms-component) is called. **EncryptedKeyB** *TBytes (read-only)* *Default Value: ""* The encrypted key or private key data. When [GenerateDataKey](#generatedatakey-method-amazonkms-component) is called, this property reflects the encrypted data key that was downloaded. When [GenerateDataKeyPair](#generatedatakeypair-method-amazonkms-component) is called, this property reflects the encrypted private key of the data key pair that was downloaded. In the case of [GenerateDataKeyPair](#generatedatakeypair-method-amazonkms-component), 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](#getpublickey-method-amazonkms-component) is called. **ForSigning** *Boolean (read-only)* *Default Value: False* Whether the public key is for signing or encryption. When [GetPublicKey](#getpublickey-method-amazonkms-component) is called, this property reflects whether the downloaded [PublicKey](#AWSKeyData_f_PublicKey) is to be used for verification (*True*) or encryption (*False*). Always *False* when [GenerateDataKey](#generatedatakey-method-amazonkms-component) or [GenerateDataKeyPair](#generatedatakeypair-method-amazonkms-component) is called. **KeySpec** *String (read-only)* *Default Value: ""* The key spec of the downloaded key data. When [GetPublicKey](#getpublickey-method-amazonkms-component) is called, this property reflects the spec of the KMS key whose [PublicKey](#AWSKeyData_f_PublicKey) 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](#generatedatakey-method-amazonkms-component) 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](#generatedatakeypair-method-amazonkms-component) is called, this property reflects the spec of the data key pair, and the possible values are the same as they are for [GetPublicKey](#getpublickey-method-amazonkms-component). **PlaintextKey** *String (read-only)* *Default Value: ""* The plaintext key or private key data. If, when [GenerateDataKey](#generatedatakey-method-amazonkms-component) or [GenerateDataKeyPair](#generatedatakeypair-method-amazonkms-component) is called, the *IncludePlaintext* parameter was *True*, 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](#generatedatakeypair-method-amazonkms-component), this property exposes the private key in PEM format for convenience. Always empty when [GetPublicKey](#getpublickey-method-amazonkms-component) is called. **PlaintextKeyB** *TBytes (read-only)* *Default Value: ""* The plaintext key or private key data. If, when [GenerateDataKey](#generatedatakey-method-amazonkms-component) or [GenerateDataKeyPair](#generatedatakeypair-method-amazonkms-component) is called, the *IncludePlaintext* parameter was *True*, 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](#generatedatakeypair-method-amazonkms-component), this property exposes the private key in PEM format for convenience. Always empty when [GetPublicKey](#getpublickey-method-amazonkms-component) is called. **PublicKey** *String (read-only)* *Default Value: ""* The public key. When [GetPublicKey](#getpublickey-method-amazonkms-component) is called, this property will reflect the public key of the KMS key. When [GenerateDataKeyPair](#generatedatakeypair-method-amazonkms-component) 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](#generatedatakey-method-amazonkms-component) is called. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [Encoded](#Certificate_f_Encoded) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [Subject](#Certificate_f_Subject) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) ## Fields **EffectiveDate** *String (read-only)* *Default Value: ""* 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. **Encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) properties also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **EncodedB** *TBytes* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) properties also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **ExpirationDate** *String (read-only)* *Default Value: ""* 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. **ExtendedKeyUsage** *String (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *String (read-only)* *Default Value: ""* 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* **FingerprintSHA1** *String (read-only)* *Default Value: ""* 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* **FingerprintSHA256** *String (read-only)* *Default Value: ""* 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* **Issuer** *String (read-only)* *Default Value: ""* The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. **PrivateKey** *String (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *Boolean (read-only)* *Default Value: False* Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *String (read-only)* *Default Value: ""* The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *String (read-only)* *Default Value: ""* 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. **PublicKeyLength** *Integer (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *String (read-only)* *Default Value: ""* 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. **SignatureAlgorithm** *String (read-only)* *Default Value: ""* 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. **Store** *String* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) property denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) property to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | 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). **StoreB** *TBytes* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) property denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) property to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | 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). **StorePassword** *String* *Default Value: ""* If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. **StoreType** *TckCertStoreTypes* *Default Value: 0* The type of certificate store for this certificate. The component supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the component will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the CertMgr component by calling the ListStoreCertificates method after setting the corresponding properties accordingly. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **Subject** *String* *Default Value: ""* 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=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **SubjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *String (read-only)* *Default Value: ""* 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. **ThumbprintSHA1** *String (read-only)* *Default Value: ""* 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. **ThumbprintSHA256** *String (read-only)* *Default Value: ""* 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. **Usage** *String (read-only)* *Default Value: ""* The text description of [UsageFlags](#Certificate_f_UsageFlags). 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. **UsageFlags** *Integer (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [Usage](#Certificate_f_Usage) property for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". ## Constructors > *Delphi Syntax* ```text constructor Create(); ``` Creates a instance whose properties can be set. > *Delphi Syntax* ```text constructor Create(valEncoded: TBytes); ``` Parses * Encoded * as an X.509 public key. > *Delphi Syntax* ```text constructor Create(valStoreType: TckCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. > *Delphi Syntax* ```text constructor Create(valStoreType: TckCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. # Firewall Type The firewall the component will connect through. ## Remarks When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall [Host](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType). The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **AutoDetect** *Boolean* *Default Value: False* Whether to automatically detect and use firewall system settings, if available. **FirewallType** *TckFirewallTypes* *Default Value: 0* The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [Port](#Firewall_f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. | **Host** *String* *Default Value: ""* The name or IP address of the firewall (optional). If a [Host](#Firewall_f_Host) 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 component raises an exception. **Password** *String* *Default Value: ""* A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception. **Port** *Integer* *Default Value: 0* The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) property for details. NOTE: This property is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) property for details. **User** *String* *Default Value: ""* A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this property and the [Password](#Firewall_f_Password) property are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the component raises an exception. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` # Header Type This is an HTTP header as it is received from the server. ## Remarks When a header is received through a Header event, it is parsed into a [Header](#header-type) type. This type contains a [Field](#Header_f_Field), and its corresponding [Value](#Header_f_Value). The following fields are available: - [Field](#Header_f_Field) - [Value](#Header_f_Value) ## Fields **Field** *String* *Default Value: ""* This property contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered). **Value** *String* *Default Value: ""* This property contains the [Header](#header-type) contents. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valField: String; valValue: String); ``` # Proxy Type The proxy the component will connect to. ## Remarks When connecting through a proxy, this type is used to specify different properties of the proxy, such as the [Server](#Proxy_f_Server) and the [AuthScheme](#Proxy_f_AuthScheme). The following fields are available: - [AuthScheme](#Proxy_f_AuthScheme) - [AutoDetect](#Proxy_f_AutoDetect) - [Password](#Proxy_f_Password) - [Port](#Proxy_f_Port) - [Server](#Proxy_f_Server) - [SSL](#Proxy_f_SSL) - [User](#Proxy_f_User) ## Fields **AuthScheme** *TckProxyAuthSchemes* *Default Value: 0* The type of authorization to perform when connecting to the proxy. This is used only when the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are set. [AuthScheme](#Proxy_f_AuthScheme) should be set to authNone (3) when no authentication is expected. By default, [AuthScheme](#Proxy_f_AuthScheme) is authBasic (0), and if the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are set, the component will attempt basic authentication. If [AuthScheme](#Proxy_f_AuthScheme) is set to authDigest (1), digest authentication will be attempted instead. If [AuthScheme](#Proxy_f_AuthScheme) is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token. If [AuthScheme](#Proxy_f_AuthScheme) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of [User](#Proxy_f_User) and [Password](#Proxy_f_Password). **AutoDetect** *Boolean* *Default Value: False* Whether to automatically detect and use proxy system settings, if available. The default value is *False*. **Password** *String* *Default Value: ""* A password if authentication is to be used for the proxy. If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are used to respond to the Digest Authentication challenge from the server. If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are used to authenticate through NTLM negotiation. **Port** *Integer* *Default Value: 80* The Transmission Control Protocol (TCP) port for the proxy [Server](#Proxy_f_Server) (default 80). See the description of the [Server](#Proxy_f_Server) property for details. **Server** *String* *Default Value: ""* If a proxy [Server](#Proxy_f_Server) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [Server](#Proxy_f_Server) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [Server](#Proxy_f_Server) property is set to the corresponding address. If the search is not successful, an error is returned. **SSL** *TckProxySSLTypes* *Default Value: 0* When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: | | | | --- | --- | | psAutomatic (0) | Default setting. If the URL is an https URL, the component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option. | | psAlways (1) | The connection is always SSL-enabled. | | psNever (2) | The connection is not SSL-enabled. | | psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. | **User** *String* *Default Value: ""* A username if authentication is to be used for the proxy. If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are used to respond to the Digest Authentication challenge from the server. If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are used to authenticate through NTLM negotiation. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valServer: String; valPort: Integer); ``` *Delphi Syntax* ```text constructor Create(valServer: String; valPort: Integer; valUser: String; valPassword: String); ``` # QueryParam Type A query parameter to send in the request. ## Remarks This type represents a query parameter to send in the request. The following fields are available: - [Name](#QueryParam_f_Name) - [Value](#QueryParam_f_Value) ## Fields **Name** *String* *Default Value: ""* The name of the query parameter. This property specifies the name of the query parameter. **Value** *String* *Default Value: ""* The value of the query parameter. This property specifies the value of the query parameter. The component will automatically URL-encode this value when sending the request. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valName: String; valValue: String); ``` # Config Settings ([AmazonKMS](#amazonkms-component) Component) The component accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the [Config](#config-method-amazonkms-component) method. ### AmazonKMS Config Settings **AccumulatePages**: Whether the component should accumulate subsequent pages of results when listing them.This setting controls how the component behaves when listing multiple pages of results. If this setting is enabled, each successive page of results will be appended to the appropriate collection properties until the last page of results has been listed (at which point the next list call will cause said collection to be cleared first). If this setting is disabled, the collection will be cleared every time a page of results is returned. By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties. **AWSProfile**: The name of the AWS CLI profile that the component should use to obtain authentication and region information.This setting, if non-empty, must contain the name of the AWS CLI profile whose authentication and (optionally) region information the component should use to communicate with the server. To use the default profile, set this setting to *default*. Refer to the following pages of the AWS CLI documentation for more information about AWS profiles, and the *credentials* and *config* files used to store them: - [Configuration and Credential File Settings](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html) - [Named Profiles](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) - [Using an IAM Role](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-role.html) The component supports key-based credential profiles; i.e., those which include the *aws_access_key_id*, *aws_secret_access_key*, and (optionally) *aws_session_token* elements. Role-based profiles are not supported at this time. In addition to the authentication-related elements mentioned above, the component also supports the *region* element, if it is present in the specified profile. The component searches for the specified profile's information in the *credentials* and *config* files. The [AWSProfileDir](#AWSProfileDir) setting can be used to configure the directory where the component looks for these files. If the aforementioned files do not exist, or the specified profile cannot be found or is missing information, an error will occur. **AWSProfileDir**: The location of the AWS CLI credentials and config files.This setting specifies the directory that the component should check when attempting to locate the AWS CLI *credentials* and *config* files. This setting is only used if the [AWSProfile](#AWSProfile) setting is non-empty. By default, this setting is empty, which will cause the component to check the default location used by the AWS CLI: an *.aws* directory in the current user's home directory; i.e., *%UserProfile%\.aws* (Windows) or *~/.aws* (Linux/macOS). **CloseInputStreamAfterProcessing**: Whether the specified input stream should be closed after data is read from it.This setting specifies whether the component should close the input stream supplied via the [SetInputStream](#setinputstream-method-amazonkms-component) method after its data has been read and processed. By default, this setting is disabled, and the input stream will remain open. **CloseOutputStreamAfterProcessing**: Whether the specified output stream should be closed after data is written to it.This setting specifies whether the component should close the output stream supplied via the [SetOutputStream](#setoutputstream-method-amazonkms-component) method after data has been written to it. By default, this setting is disabled, and the output stream will remain open. **CreateKeyPolicy**: The key policy JSON to send when creating a new KMS key.This setting can be set to a fully-formed key policy JSON object before calling [CreateKey](#createkey-method-amazonkms-component) in order to specify the key policy of the new KMS key. Note that this setting's value, if non-empty, is included in the request as-is without any validation; it must be a valid key policy JSON object structured according the Amazon KMS documentation. **CustomKeyStoreId**: The Id of the custom key store that the KMS key should be created in.This setting can be set to the Id of a custom key store before calling [CreateKey](#createkey-method-amazonkms-component) in order to have the KMS key be created in that custom key store. Refer to the Amazon KMS documentation for more information. **MaxAliases**: The maximum number of results to return when listing aliases.This setting specifies the maximum number of results that should be returned by a call to [ListAliases](#listaliases-method-amazonkms-component). If this setting is *-1* (default), the server's default (50) is used. Acceptable values are *1* to *100* (inclusive). **MaxKeys**: The maximum number of results to return when listing KMS keys.This setting specifies the maximum number of results that should be returned by a call to [ListKeys](#listkeys-method-amazonkms-component). If this setting is *-1* (default), the server's default (100) is used. Acceptable values are *1* to *1000* (inclusive). **MessageDigest**: The message digest computed by the component during the last sign or verify operation, if any.This setting can be queried after calling [Sign](#sign-method-amazonkms-component) or [Verify](#verify-method-amazonkms-component) to obtain the (hex-encoded) message digest computed by the component during the call. If the component did not generate a message digest as part of the call, an empty string will be returned. **NewEncryptionContext**: The new encryption context to use when re-encrypting data.This setting can be set to a JSON object with string properties before calling [ReEncrypt](#reencrypt-method-amazonkms-component) in order to have the server change the encryption context when re-encrypting (assuming *SYMMETRIC_DEFAULT* is passed for the *NewAlgorithm* parameter; other encryption algorithms do not support encryption contexts). If this setting is empty when [ReEncrypt](#reencrypt-method-amazonkms-component) is called, the existing encryption context specified by the [EncryptionContext](#encryptioncontext-property-amazonkms-component) collection is maintained (if possible). To explicitly *remove* the existing encryption context, set this setting to *{}*. Note that this setting's value, if non-empty and not *{}*, is included in the request as-is without any validation; it must be a valid JSON object with only string-typed properties. **RawRequest**: Returns the data that was sent to the server.This setting may be queried after calling any method that sends data to the server to obtain the request data that was transmitted. Such data may be useful for troubleshooting purposes. **RawResponse**: Returns the data that was received from the server.This setting may be queried after calling any method that sends data to the server to obtain the response data that was received. Such data may be useful for troubleshooting purposes. **SessionToken**: The session token to send in the request when using temporary credentials.When using temporary credentials, AWS requires you to send the session token provided with the temporary access and secret key in every request. **UseEC2RoleCredentials**: Whether to authenticate requests with credentials obtained from the IAM role attached to the EC2 instance.When the component is running within an Amazon EC2 instance, this setting can be set to authenticate requests using the IAM role attached to the instance using temporary credentials obtained from the instance metadata service. The IMDSv2 protocol is used by default. Please see the [IMDSVersion](#IMDSVersion) configuration setting for more information. In order for the component to be able to auto-obtain authentication credentials, the EC2 instance must have an "instance profile" with an appropriate IAM role attached to it. Refer to the "[Using an IAM Role to Grant Permissions to Applications Running on Amazon EC2 Instances](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html)" page in the Amazon IAM documentation for more information. By default, this setting is *False*. When set to *True* the component will do the following before each request: 1. Make a request against the EC2 instance to get the name of the role attached to it. 2. Make a request against the metadata service to initiate a session. The request returns a token that must be included in subsequent requests. 3. Parse the response, automatically populating the [AccessKey](#accesskey-property-amazonkms-component) and [SecretKey](#secretkey-property-amazonkms-component) properties and the [SessionToken](#SessionToken) configuration setting. 4. Execute the original request using the temporary security credentials that were acquired. Note: This setting is ignored if the [AWSProfile](#AWSProfile) setting is set to a profile that includes credential information. **UseFIPSEndpoint**: Whether to use the FIPs endpoint to communicate with the server.This setting specifies whether the component should use the FIPS endpoint for the currently-selected [Region](#region-property-amazonkms-component) when communicating with the server. By default, this setting is disabled, and the normal (non-FIPS) endpoint is used. **XChildCount**: The number of child elements of the current element.This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([XChildCount](#XChildCount) - 1). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildName[i]**: The name of the child element.This configuration setting provides the name of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildXText[i]**: The inner text of the child element.This configuration setting provides the inner text of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XElement**: The name of the current element.This configuration setting provides the name of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XParent**: The parent of the current element.This configuration setting provides the parent of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XPath**: Provides a way to point to a specific element in the returned XML or JSON response.The [XPath](#XPath) setting allows you to point to specific elements in the XML or JSON response. When [XPath](#XPath) is set to a valid path, [XElement](#XElement) points to the name of the element, with [XText](#XText), [XParent](#XParent), [XSubTree](#XSubTree), [XChildCount](#XChildCount), [XChildName\[i\]](#XChildName[i]), and [XChildXText\[i\]](#XChildXText[i]) providing other properties of the element. XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the */* character, for example, */A/B/C/D*. An XPath can be absolute (i.e., it starts with */*), or it can be relative to the current [XPath](#XPath) location. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string: | Accessor | Description | | --- | --- | | name | The first element with a particular name. Can be *. | | [i] | The i-th element. | | name[i] | The i-th element with a particular name. | | [last()] | The last element. | | [last()-i] | The element i before the last element. | | name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair. Supports single and double quotes. (XML Only) | | . | The current element. | | .. | The parent element. | NOTE: XPath indices are *1-based*. For example, assume the following XML and JSON responses. XML: ```text value first second value three ``` JSON: ```text { "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } } ``` The following are examples of valid XPaths for these responses: | Description | XML XPath | JSON XPath | | --- | --- | --- | | Document root | / | /json | | Specific element | /firstlevel/one | /json/firstlevel/one | | i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] | This list is not exhaustive, but it provides a general idea of the possibilities. **XSubTree**: A snapshot of the current element in the document.This configuration setting provides the entirety of the current element (including its subelements). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XText**: The text of the current element.This configuration setting provides the inner text of the current element. The current element is specified in the [XPath](#XPath) configuration setting. This configuration setting is read-only. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the component adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The component only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the component will accept compressed data. It then will uncompress the data it has received. The component will handle data compressed by both gzip and deflate compression algorithms. When True, the component adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0". If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component raises an exception if the server does not support HTTP/2. The default value is True. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component. The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form 'Basic [encoded-user-password]'. **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-amazonkms-component) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the component.If set to True, the URL passed to the component will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the component raises an exception. **Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the component raises an exception instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the component will perform a GET on the new location.The default value is False. If set to True, the component will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the component.This property specifies the HTTP version used by the component. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details. **HTTP/2 Notes** When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the component will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed. **HTTP/3 Notes** HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *True*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *False*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *False*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#log-event-amazonkms-component) event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | 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). **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the component will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the component will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (*'#13#10'*) . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the component beyond what is provided. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [User](#Proxy_f_User) and [Password](#Proxy_f_Password) are specified, this value is calculated using the algorithm specified by [AuthScheme](#Proxy_f_AuthScheme). **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by components that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by components that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the component.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the component. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the component will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the component will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the component will attempt to use the Proxy auto-config URL when establishing a connection and [AutoDetect](#Proxy_f_AutoDetect) is set to *True*. When *True* (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **CloseStreamAfterTransfer**: If true, the component will close the upload or download stream after the transfer.This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True. **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use [Timeout](#timeout-property-amazonkms-component) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the component whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by components that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception. NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by components that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the component raises an exception. NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-amazonkms-component) setting 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 value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. If the component is connected, the [LocalHost](#localhost-property-amazonkms-component) setting 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). **LocalPort**: The port in the local host where the component binds. This configuration setting must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the component will use IPv4 exclusively. When set to *1*, the component will use IPv6 exclusively. To instruct the component to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-amazonkms-component) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-amazonkms-component) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-amazonkms-component) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the component will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the component is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-amazonkms-component) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-amazonkms-component) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component raises an exception. When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the component raises an exception. When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-amazonkms-component) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the component will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when [SSLProvider](#sslprovider-property-amazonkms-component) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [SSLProvider](#sslprovider-property-amazonkms-component) is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when [SSLProvider](#sslprovider-property-amazonkms-component) is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [SSLProvider](#sslprovider-property-amazonkms-component) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the component will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-amazonkms-component) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-amazonkms-component) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the component when the [SSLProvider](#sslprovider-property-amazonkms-component) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-amazonkms-component) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *False* by default, but it can be set to *True* to enable the extension. This configuration setting is applicable only when [SSLProvider](#sslprovider-property-amazonkms-component) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-amazonkms-component) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-amazonkms-component) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-amazonkms-component) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-amazonkms-component) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-amazonkms-component) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component raises an exception. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-amazonkms-component) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-amazonkms-component) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*. **UseFIPSCompliantAPI**: Tells the component whether or not to use FIPS certified APIs.When set to *True*, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *True*. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: This setting is applicable only on Windows. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the component will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *True* tells the component to use the internal implementation instead of using the system security libraries. This setting is set to *False* by default on all platforms. # Trappable Errors ([AmazonKMS](#amazonkms-component) Component) ### Common Errors | | | | --- | --- | | 600 | A server error occurred, and/or the component was unable to process the server's response. Please refer to the error message for more information. | | 601 | An unsupported operation or action was attempted. | | 602 | The [RawRequest](#RawRequest) or [RawResponse](#RawResponse) configuration setting was queried without first setting the TransferredRequest configuration setting to ON. | | 603 | The login credentials specified were invalid. Please refer to the error message for more information. | | 604 | An invalid remote resource identifier (i.e., a name, path, Id, etc.) was specified. | | 605 | An invalid index was specified. | | 606 | An operation failed because the specified [OutputFile](#outputfile-property-amazonkms-component) already exists and [Overwrite](#overwrite-property-amazonkms-component) is False. | | 607 | An exception occurred while working with the specified [InputFile](#inputfile-property-amazonkms-component) or [OutputFile](#outputfile-property-amazonkms-component) (or the current value of one of those properties is invalid). Please refer to the error message for more information. | | 608 | An exception occurred while working with the specified input or output stream. Please refer to the error message for more information. | The component may also return one of the following error codes, which are inherited from other components. ### HTTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains the detailed message. | | 143 | Busy executing current method. | | 151 | HTTP protocol error. The error message has the server response. | | 152 | No server specified in URL. | | 153 | Specified URLScheme is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | Interrupted. | | 302 | Cannot open AttachedFile. | The component may also return one of the following error codes, which are inherited from other components. ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#localhost-property-amazonkms-component) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the component is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |