# AmazonSecrets Class The AmazonSecrets class provides an easy-to-use interface for Amazon's Secrets Manager service. ## Syntax ```text AmazonSecrets ``` ## Remarks The AmazonSecrets class makes it easy to work with the Amazon Secrets Manager service in a secure manner using TLS. Amazon Secrets Manager allows you to securely store secrets (e.g., passwords, symmetric keys, etc.) in the cloud so that the aren't persisted locally. This class helps you to create, manage, and access those secrets. To begin, register for an AWS account and obtain an [AccessKey](#accesskey-property-amazonsecrets-class) and [SecretKey](#secretkey-property-amazonsecrets-class) to use for authentication. ### Resource Terminology A secret in Amazon Secrets Manager is a container for one or more secret versions, which is where secret data is actually stored. Each secret version can have between zero and 20 *staging labels* attached to it at any given time. A staging label is a simple string that can be used instead of a version Id to refer to a particular secret version when retrieving secret data. A staging label can only be attached to one version of a secret at any given time. The server ensures that there is always exactly one version of a secret with the special staging label *AWSCURRENT*, but otherwise you are free to apply any staging labels to any secret versions you choose. Secret versions that do not have any staging labels attached to them are considered *deprecated*, and the server may delete them at any time without warning. Deprecated secret versions are not shown in a secret's version list unless explicitly asked for. ### Using the Class The [CreateSecret](#createsecret-method-amazonsecrets-class) method will create a new secret with an initial secret version that holds the specified secret data. To change a secret's data, create a new version of it using the [CreateVersion](#createversion-method-amazonsecrets-class) method. To retrieve a secret's data, call the [GetSecret](#getsecret-method-amazonsecrets-class) method, and specify the specific version (either by Id or using a staging label) whose data should be retrieved. If no particular version is specified, the version with the *AWSCURRENT* staging label is used. Secrets that will no longer be used can be deleted using the [DeleteSecret](#deletesecret-method-amazonsecrets-class) method, either immediately or after a waiting period. If a secret is scheduled for deletion later, then during said waiting period the deletion can be canceled using [CancelDeletion](#canceldeletion-method-amazonsecrets-class). ```csharp // Creates a new secret with the textual data "Test123" named MySecret. // The initial secret version will have only the "AWSCURRENT" staging label. amazonsecrets.SecretString = "Test123"; amazonsecrets.CreateSecret("MySecret", "A description of my secret."); // Creates a new secret version with the textual data "Cats456" and // attaches the staging labels "AWSCURRENT" (which gets moved from the previous version) // and "best-version" to it. amazonsecrets.SecretString = "Cats456"; amazonsecrets.CreateVersion("MySecret", "AWSCURRENT,best-version"); // Downloads the latest secret version's data to a local file. amazonsecrets.LocalFile = "C:\temp\secret.txt"; amazonsecrets.GetSecret("MySecret", "", ""); // Schedules the secret, and all its versions, for deletion after 10 days. amazonsecrets.DeleteSecret("MySecret", 10); // Cancels the scheduled deletion. amazonsecrets.CancelDeletion("MySecret"); ``` To list secrets, use the [ListSecrets](#listsecrets-method-amazonsecrets-class) method. To list a secret's versions, use the [ListVersions](#listversions-method-amazonsecrets-class) method. ```csharp // If there are many secrets to list, there may be multiple pages of results. This will // cause all pages of results to be accumulated into the Secrets collection property. do { amazonsecrets.ListSecrets(); } while (!string.IsNullOrEmpty(amazonsecrets.SecretMarker)); // A similar thing applies to secret versions as well. do { amazonsecrets.ListVersions("MySecret"); } while (!string.IsNullOrEmpty(amazonsecrets.VersionMarker)); ``` The class also supports other functionality, including: - Adding, removing, and moving staging labels between secret versions using [MoveStagingLabel](#movestaginglabel-method-amazonsecrets-class). - Retrieval of information for a single secret with [GetSecretInfo](#getsecretinfo-method-amazonsecrets-class). - Random password generation using [GenRandomPassword](#genrandompassword-method-amazonsecrets-class). - And more! ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AccessKey](#accesskey-property-amazonsecrets-class) | The access key to use for authentication. | | [Firewall](#firewall-property-amazonsecrets-class) | A set of properties related to firewall access. | | [Idle](#idle-property-amazonsecrets-class) | The current status of the class. | | [LocalFile](#localfile-property-amazonsecrets-class) | The local file to write data to, or whose data should be sent. | | [LocalHost](#localhost-property-amazonsecrets-class) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [OtherHeaders](#otherheaders-property-amazonsecrets-class) | Other headers as determined by the user (optional). | | [Overwrite](#overwrite-property-amazonsecrets-class) | Whether the local file should be overwritten if necessary. | | [ParsedHeaders](#parsedheaders-property-amazonsecrets-class) | This property includes a collection of headers returned from the last request. | | [Proxy](#proxy-property-amazonsecrets-class) | A set of properties related to proxy access. | | [QueryParams](#queryparams-property-amazonsecrets-class) | Additional query parameters to be included in the request. | | [Region](#region-property-amazonsecrets-class) | The region that the class will make requests against. | | [SecretData](#secretdata-property-amazonsecrets-class) | The binary secret data that was retrieved or that should be sent. | | [SecretKey](#secretkey-property-amazonsecrets-class) | The secret key to use for authentication. | | [SecretMarker](#secretmarker-property-amazonsecrets-class) | A marker indicating what page of secrets to return next. | | [Secrets](#secrets-property-amazonsecrets-class) | A collection of secrets. | | [SecretString](#secretstring-property-amazonsecrets-class) | The textual secret data that was retrieved or that should be sent. | | [SSLAcceptServerCert](#sslacceptservercert-property-amazonsecrets-class) | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#sslcert-property-amazonsecrets-class) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLProvider](#sslprovider-property-amazonsecrets-class) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#sslservercert-property-amazonsecrets-class) | The server certificate for the last established connection. | | [Timeout](#timeout-property-amazonsecrets-class) | The timeout for the class. | | [VersionMarker](#versionmarker-property-amazonsecrets-class) | A marker indicating what page of secret versions to return next. | | [Versions](#versions-property-amazonsecrets-class) | A collection of secret versions. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddQueryParam](#addqueryparam-method-amazonsecrets-class) | Adds a query parameter to the QueryParams properties. | | [CancelDeletion](#canceldeletion-method-amazonsecrets-class) | Cancels the deletion of a secret. | | [Config](#config-method-amazonsecrets-class) | Sets or retrieves a configuration setting. | | [CreateSecret](#createsecret-method-amazonsecrets-class) | Creates a new secret. | | [CreateVersion](#createversion-method-amazonsecrets-class) | Creates a new secret version. | | [DeleteSecret](#deletesecret-method-amazonsecrets-class) | Deletes a secret and all of its versions. | | [DoEvents](#doevents-method-amazonsecrets-class) | This method processes events from the internal message queue. | | [GenRandomPassword](#genrandompassword-method-amazonsecrets-class) | Returns a server-generated random password that complies with the given criteria. | | [GetSecret](#getsecret-method-amazonsecrets-class) | Retrieves a secret version's data. | | [GetSecretInfo](#getsecretinfo-method-amazonsecrets-class) | Gets information about a secret. | | [ListSecrets](#listsecrets-method-amazonsecrets-class) | Lists secrets in the current account and region. | | [ListVersions](#listversions-method-amazonsecrets-class) | List the secret versions for the specified secret. | | [MoveStagingLabel](#movestaginglabel-method-amazonsecrets-class) | Adds, removes, or moves a staging label. | | [Reset](#reset-method-amazonsecrets-class) | Resets the class to its initial state. | | [SendCustomRequest](#sendcustomrequest-method-amazonsecrets-class) | Sends a custom request to the server. | | [SetInputStream](#setinputstream-method-amazonsecrets-class) | Sets the stream whose data should be sent. | | [SetOutputStream](#setoutputstream-method-amazonsecrets-class) | Sets the stream to which received data should be written. | | [UpdateSecret](#updatesecret-method-amazonsecrets-class) | Updates a secret's information. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [EndTransfer](#endtransfer-event-amazonsecrets-class) | Fired when a document finishes transferring. | | [Error](#error-event-amazonsecrets-class) | Fired when information is available about errors during data delivery. | | [Header](#header-event-amazonsecrets-class) | Fired every time a header line comes in. | | [Log](#log-event-amazonsecrets-class) | Fired once for each log message. | | [SecretList](#secretlist-event-amazonsecrets-class) | Fires once for each secret when listing secrets. | | [SSLServerAuthentication](#sslserverauthentication-event-amazonsecrets-class) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-amazonsecrets-class) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-amazonsecrets-class) | Fired when a document starts transferring (after the headers). | | [Transfer](#transfer-event-amazonsecrets-class) | Fired while a document transfers (delivers document). | | [VersionList](#versionlist-event-amazonsecrets-class) | Fires once for each secret version when listing secret versions. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AccumulatePages](#AccumulatePages) | Whether the class should accumulate subsequent pages of results when listing them. | | [AlwaysParseVersions](#AlwaysParseVersions) | Whether to parse version information when listing secrets. | | [AWSProfile](#AWSProfile) | The name of the AWS CLI profile that the class should use to obtain authentication and region information. | | [AWSProfileDir](#AWSProfileDir) | The location of the AWS CLI credentials and config files. | | [IncludeDeleted](#IncludeDeleted) | Whether to include secrets scheduled for deletion when listing secrets. | | [IncludeDeprecated](#IncludeDeprecated) | Whether to include deprecated version when listing versions. | | [KMSKeyId](#KMSKeyId) | The Id of the Amazon KMS KMS key that should be used to encrypt a secret. | | [MaxSecrets](#MaxSecrets) | The maximum number of results to return when listing secrets. | | [PreferBinary](#PreferBinary) | Whether the class should treat secret data as binary or textual in ambiguous situations. | | [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 class. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the class 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 class. | | [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 class. | | [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. | | [UsePlatformHTTPClient](#UsePlatformHTTPClient) | Whether or not to use the platform HTTP client. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class 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. | | [KeepAliveRetryCount](#KeepAliveRetryCount) | The number of keep-alive packets to be sent before the remotehost is considered disconnected. | | [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 class 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. | | [SSLCACertFilePaths](#SSLCACertFilePaths) | The paths to CA certificate files on Unix/Linux. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [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. | | [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. | | [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class 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 ([AmazonSecrets](#amazonsecrets-class) Class) The access key to use for authentication. ## Syntax ```text ANSI (Cross Platform) char* GetAccessKey();int SetAccessKey(const char* lpszAccessKey); Unicode (Windows) LPWSTR GetAccessKey();INT SetAccessKey(LPCWSTR lpszAccessKey); ``` ## Default Value "" ## Remarks This property specifies the access key that should be used for authentication. Both this property and [SecretKey](#secretkey-property-amazonsecrets-class) must be set before attempting any operations which connect to the server. ## Data Type String # Firewall Property ([AmazonSecrets](#amazonsecrets-class) Class) A set of properties related to firewall access. ## Syntax ```text CloudKeysFirewall* GetFirewall(); int SetFirewall(CloudKeysFirewall* val); ``` ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the class will attempt to connect. ## Data Type [CloudKeysFirewall](#firewall-type) # Idle Property ([AmazonSecrets](#amazonsecrets-class) Class) The current status of the class. ## Syntax ```text ANSI (Cross Platform) int GetIdle(); Unicode (Windows) BOOL GetIdle(); ``` ## Default Value TRUE ## Remarks This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times. This property is read-only. ## Data Type Boolean # LocalFile Property ([AmazonSecrets](#amazonsecrets-class) Class) The local file to write data to, or whose data should be sent. ## Syntax ```text ANSI (Cross Platform) char* GetLocalFile();wchar_t* GetLocalFile_W(); // Windows onlyint SetLocalFile(const char* lpszLocalFile);int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only Unicode (Windows) LPWSTR GetLocalFile();INT SetLocalFile(LPCWSTR lpszLocalFile); ``` ## Default Value "" ## Remarks This property specifies the location of a local file on disk. This is used as the source file when calling [CreateSecret](#createsecret-method-amazonsecrets-class) or [CreateVersion](#createversion-method-amazonsecrets-class), and as the destination file when calling [GetSecret](#getsecret-method-amazonsecrets-class). When creating a secret, the class assumes that data specified via a local file is binary in nature; the [PreferBinary](#PreferBinary) configuration setting can be used to control this behavior, refer to its documentation for more information. Note: Setting this property to a non-empty value will discard and streams set using [SetInputStream](#setinputstream-method-amazonsecrets-class) and [SetOutputStream](#setoutputstream-method-amazonsecrets-class). Similarly, passing a non-null value to either of those methods will clear this property. ## Data Type String # LocalHost Property ([AmazonSecrets](#amazonsecrets-class) Class) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text ANSI (Cross Platform) char* GetLocalHost();int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();INT SetLocalHost(LPCWSTR lpszLocalHost); ``` ## 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 class initiate connections (or accept in the case of server classes) 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 class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window. ## Data Type String # OtherHeaders Property ([AmazonSecrets](#amazonsecrets-class) Class) Other headers as determined by the user (optional). ## Syntax ```text ANSI (Cross Platform) char* GetOtherHeaders();int SetOtherHeaders(const char* lpszOtherHeaders); Unicode (Windows) LPWSTR GetOtherHeaders();INT SetOtherHeaders(LPCWSTR lpszOtherHeaders); ``` ## 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 (*"\r\n"*) . 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 class beyond what is provided. This property is not available at design time. ## Data Type String # Overwrite Property ([AmazonSecrets](#amazonsecrets-class) Class) Whether the local file should be overwritten if necessary. ## Syntax ```text ANSI (Cross Platform) int GetOverwrite();int SetOverwrite(int bOverwrite); Unicode (Windows) BOOL GetOverwrite();INT SetOverwrite(BOOL bOverwrite); ``` ## Default Value FALSE ## Remarks This property controls whether the specified [LocalFile](#localfile-property-amazonsecrets-class) should be overwritten if it already exists. This property is not available at design time. ## Data Type Boolean # ParsedHeaders Property ([AmazonSecrets](#amazonsecrets-class) Class) This property includes a collection of headers returned from the last request. ## Syntax ```text CloudKeysList* GetParsedHeaders(); ``` ## 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. ## Data Type [CloudKeysHeader](#header-type) # Proxy Property ([AmazonSecrets](#amazonsecrets-class) Class) A set of properties related to proxy access. ## Syntax ```text CloudKeysProxy* GetProxy(); int SetProxy(CloudKeysProxy* val); ``` ## Remarks This property contains fields describing the proxy through which the class will attempt to connect. ## Data Type [CloudKeysProxy](#proxy-type) # QueryParams Property ([AmazonSecrets](#amazonsecrets-class) Class) Additional query parameters to be included in the request. ## Syntax ```text CloudKeysList* GetQueryParams(); int SetQueryParams(CloudKeysList* val); ``` ## Remarks This is a collection of query parameters that will be added to the request. Parameters can be added via the [AddQueryParam](#addqueryparam-method-amazonsecrets-class) method. ## Data Type [CloudKeysQueryParam](#queryparam-type) # Region Property ([AmazonSecrets](#amazonsecrets-class) Class) The region that the class will make requests against. ## Syntax ```text ANSI (Cross Platform) char* GetRegion();int SetRegion(const char* lpszRegion); Unicode (Windows) LPWSTR GetRegion();INT SetRegion(LPCWSTR lpszRegion); ``` ## Default Value "us-east-1" ## Remarks This property controls which region the class will make requests against. By default the class 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 secrets 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 class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value. ## Data Type String # SecretData Property ([AmazonSecrets](#amazonsecrets-class) Class) The binary secret data that was retrieved or that should be sent. ## Syntax ```text ANSI (Cross Platform) int GetSecretData(char* &lpSecretData, int &lenSecretData);int SetSecretData(const char* lpSecretData, int lenSecretData); Unicode (Windows) INT GetSecretData(LPSTR &lpSecretData, INT &lenSecretData);INT SetSecretData(LPCSTR lpSecretData, INT lenSecretData); ``` ## Remarks Either this property or the [SecretString](#secretstring-property-amazonsecrets-class) property is populated with secret data after calling [GetSecret](#getsecret-method-amazonsecrets-class), depending on whether the secret data is binary or textual, so long as [SetOutputStream](#setoutputstream-method-amazonsecrets-class) and [LocalFile](#localfile-property-amazonsecrets-class) are not set. This property (or the [SecretString](#secretstring-property-amazonsecrets-class) property) can also be set before calling [CreateSecret](#createsecret-method-amazonsecrets-class) or [CreateVersion](#createversion-method-amazonsecrets-class); its data will be sent if [SetInputStream](#setinputstream-method-amazonsecrets-class) and [LocalFile](#localfile-property-amazonsecrets-class) are not set. This property and [SecretString](#secretstring-property-amazonsecrets-class) are mutually exclusive; setting one will clear the other. This property is not available at design time. ## Data Type Byte Array # SecretKey Property ([AmazonSecrets](#amazonsecrets-class) Class) The secret key to use for authentication. ## Syntax ```text ANSI (Cross Platform) char* GetSecretKey();int SetSecretKey(const char* lpszSecretKey); Unicode (Windows) LPWSTR GetSecretKey();INT SetSecretKey(LPCWSTR lpszSecretKey); ``` ## Default Value "" ## Remarks This property specifies the secret key that should be used for authentication. Both this property and [AccessKey](#accesskey-property-amazonsecrets-class) must be set before attempting any operations which connect to the server. ## Data Type String # SecretMarker Property ([AmazonSecrets](#amazonsecrets-class) Class) A marker indicating what page of secrets to return next. ## Syntax ```text ANSI (Cross Platform) char* GetSecretMarker();int SetSecretMarker(const char* lpszSecretMarker); Unicode (Windows) LPWSTR GetSecretMarker();INT SetSecretMarker(LPCWSTR lpszSecretMarker); ``` ## Default Value "" ## Remarks This property will be populated when [ListSecrets](#listsecrets-method-amazonsecrets-class) is called if the results are paged and there are more pages. To list all secrets, continue to call [ListSecrets](#listsecrets-method-amazonsecrets-class) until this property returns empty string. Refer to [ListSecrets](#listsecrets-method-amazonsecrets-class) for more information. This property is not available at design time. ## Data Type String # Secrets Property ([AmazonSecrets](#amazonsecrets-class) Class) A collection of secrets. ## Syntax ```text CloudKeysList* GetSecrets(); ``` ## Remarks This collection holds a list of [AWSSecret](#awssecret-type) items. Calling [ListSecrets](#listsecrets-method-amazonsecrets-class) or [GetSecretInfo](#getsecretinfo-method-amazonsecrets-class) will populate this collection. This property is read-only and not available at design time. ## Data Type [CloudKeysAWSSecret](#awssecret-type) # SecretString Property ([AmazonSecrets](#amazonsecrets-class) Class) The textual secret data that was retrieved or that should be sent. ## Syntax ```text ANSI (Cross Platform) char* GetSecretString();int SetSecretString(const char* lpszSecretString); Unicode (Windows) LPWSTR GetSecretString();INT SetSecretString(LPCWSTR lpszSecretString); ``` ## Default Value "" ## Remarks Either this property or the [SecretData](#secretdata-property-amazonsecrets-class) property is populated with secret data after calling [GetSecret](#getsecret-method-amazonsecrets-class), depending on whether the secret data is binary or textual, so long as [SetOutputStream](#setoutputstream-method-amazonsecrets-class) and [LocalFile](#localfile-property-amazonsecrets-class) are not set. This property (or the [SecretData](#secretdata-property-amazonsecrets-class) property) can also be set before calling [CreateSecret](#createsecret-method-amazonsecrets-class) or [CreateVersion](#createversion-method-amazonsecrets-class); its data will be sent if [SetInputStream](#setinputstream-method-amazonsecrets-class) and [LocalFile](#localfile-property-amazonsecrets-class) are not set. This property and [SecretData](#secretdata-property-amazonsecrets-class) are mutually exclusive; setting one will clear the other. This property is not available at design time. ## Data Type String # SSLAcceptServerCert Property ([AmazonSecrets](#amazonsecrets-class) Class) Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax ```text CloudKeysCertificate* GetSSLAcceptServerCert(); int SetSSLAcceptServerCert(CloudKeysCertificate* val); ``` ## Remarks If it finds any issues with the certificate presented by the server, the class 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. ## Data Type [CloudKeysCertificate](#certificate-type) # SSLCert Property ([AmazonSecrets](#amazonsecrets-class) Class) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax ```text CloudKeysCertificate* GetSSLCert(); int SetSSLCert(CloudKeysCertificate* val); ``` ## Remarks This property includes the digital certificate that the class 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. ## Data Type [CloudKeysCertificate](#certificate-type) # SSLProvider Property ([AmazonSecrets](#amazonsecrets-class) Class) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text ANSI (Cross Platform) int GetSSLProvider();int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();INT SetSSLProvider(INT iSSLProvider); ``` ## Possible Values ```text SSLP_AUTOMATIC(0), SSLP_PLATFORM(1), SSLP_INTERNAL(2) ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the class 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 class will select a provider depending on the current platform. When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. ## Data Type Integer # SSLServerCert Property ([AmazonSecrets](#amazonsecrets-class) Class) The server certificate for the last established connection. ## Syntax ```text CloudKeysCertificate* GetSSLServerCert(); ``` ## 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. ## Data Type [CloudKeysCertificate](#certificate-type) # Timeout Property ([AmazonSecrets](#amazonsecrets-class) Class) The timeout for the class. ## Syntax ```text ANSI (Cross Platform) int GetTimeout();int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();INT SetTimeout(INT iTimeout); ``` ## 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 class will wait for the operation to complete before returning control. The class will use [DoEvents](#doevents-method-amazonsecrets-class) 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 class fails with an error. NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. ## Data Type Integer # VersionMarker Property ([AmazonSecrets](#amazonsecrets-class) Class) A marker indicating what page of secret versions to return next. ## Syntax ```text ANSI (Cross Platform) char* GetVersionMarker();int SetVersionMarker(const char* lpszVersionMarker); Unicode (Windows) LPWSTR GetVersionMarker();INT SetVersionMarker(LPCWSTR lpszVersionMarker); ``` ## Default Value "" ## Remarks This property will be populated when [ListVersions](#listversions-method-amazonsecrets-class) is called if the results are paged and there are more pages. To list all secret versions, continue to call [ListVersions](#listversions-method-amazonsecrets-class) until this property returns empty string. Refer to [ListVersions](#listversions-method-amazonsecrets-class) for more information. This property is not available at design time. ## Data Type String # Versions Property ([AmazonSecrets](#amazonsecrets-class) Class) A collection of secret versions. ## Syntax ```text CloudKeysList* GetVersions(); ``` ## Remarks This collection holds a list of [AWSSecretVersion](#awssecretversion-type) items. Calling [ListVersions](#listversions-method-amazonsecrets-class), [GetSecretInfo](#getsecretinfo-method-amazonsecrets-class), or (if the [AlwaysParseVersions](#AlwaysParseVersions) configuration setting is enabled) [ListSecrets](#listsecrets-method-amazonsecrets-class) will populate this collection. This property is read-only and not available at design time. ## Data Type [CloudKeysAWSSecretVersion](#awssecretversion-type) # AddQueryParam Method ([AmazonSecrets](#amazonsecrets-class) Class) Adds a query parameter to the QueryParams properties. ## Syntax ```text ANSI (Cross Platform) int AddQueryParam(const char* lpszName, const char* lpszValue); Unicode (Windows) INT AddQueryParam(LPCWSTR lpszName, LPCWSTR lpszValue); ``` ## Remarks This method is used to add a query parameter to the [QueryParams](#queryparams-property-amazonsecrets-class) 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 class automatically. Consult the service documentation for details on the available parameters. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # CancelDeletion Method ([AmazonSecrets](#amazonsecrets-class) Class) Cancels the deletion of a secret. ## Syntax ```text ANSI (Cross Platform) int CancelDeletion(const char* lpszSecretId); Unicode (Windows) INT CancelDeletion(LPCWSTR lpszSecretId); ``` ## Remarks This method cancels the deletion of the secret specified by *SecretId*. Refer to the [DeleteSecret](#deletesecret-method-amazonsecrets-class) method's documentation for more information. The value passed for *SecretId* must the ARN or name of a secret in the current account and [Region](#region-property-amazonsecrets-class). ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # Config Method ([AmazonSecrets](#amazonsecrets-class) Class) Sets or retrieves a configuration setting. ## Syntax ```text ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-amazonsecrets-class) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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-amazonsecrets-class), you must call *Config("PROPERTY")*. The value will be returned as a string. ## Error Handling (C++) This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. # CreateSecret Method ([AmazonSecrets](#amazonsecrets-class) Class) Creates a new secret. ## Syntax ```text ANSI (Cross Platform) char* CreateSecret(const char* lpszSecretName, const char* lpszDescription); Unicode (Windows) LPWSTR CreateSecret(LPCWSTR lpszSecretName, LPCWSTR lpszDescription); ``` ## Remarks This method creates a new secret with the given *SecretName*. The secret data is taken from the input stream supplied via the [SetInputStream](#setinputstream-method-amazonsecrets-class) method, the specified [LocalFile](#localfile-property-amazonsecrets-class), or the [SecretData](#secretdata-property-amazonsecrets-class) or [SecretString](#secretstring-property-amazonsecrets-class) property; it may be up to 65536 bytes in length. The Id of the initial secret version is returned. The value passed for *SecretName* may be up to 512 characters long, and must consist solely of ASCII letters, digits, and the following characters: */_+=.@-*. The *Description* parameter is optional; it can be any string up to 2048 characters long. If desired, the [KMSKeyId](#KMSKeyId) configuration setting can be set before calling this method to specify the Amazon KMS CMK (customer master key) to use to encrypt the secret (by default, an AWS-managed one is used). ## Error Handling (C++) This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. # CreateVersion Method ([AmazonSecrets](#amazonsecrets-class) Class) Creates a new secret version. ## Syntax ```text ANSI (Cross Platform) char* CreateVersion(const char* lpszSecretId, const char* lpszStagingLabels); Unicode (Windows) LPWSTR CreateVersion(LPCWSTR lpszSecretId, LPCWSTR lpszStagingLabels); ``` ## Remarks This method creates a new version of the secret specified by *SecretId*. The secret data is taken from the input stream supplied via the [SetInputStream](#setinputstream-method-amazonsecrets-class) method, the specified [LocalFile](#localfile-property-amazonsecrets-class), or the [SecretData](#secretdata-property-amazonsecrets-class) or [SecretString](#secretstring-property-amazonsecrets-class) property; it may be up to 65536 bytes in length. The Id of the newly-created secret version is returned. The value passed for *SecretId* must the ARN or name of a secret in the current account and [Region](#region-property-amazonsecrets-class). The value passed for *StagingLabels* must be a comma-separated list of staging labels to attach to the new version; up to 20 staging labels can be attached to a secret version. If empty string is passed, *AWSCURRENT* is assumed. The server may do the following things depending on which staging labels are specified: - If any of the specified staging labels are currently attached to other versions of this secret, they are moved from those versions to the new one. - If the *AWSCURRENT* staging label is attached to the new version, the server will automatically move the *AWSPREVIOUS* staging label to the version that *AWSCURRENT* was previously attached to. ## Error Handling (C++) This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. # DeleteSecret Method ([AmazonSecrets](#amazonsecrets-class) Class) Deletes a secret and all of its versions. ## Syntax ```text ANSI (Cross Platform) int DeleteSecret(const char* lpszSecretId, int iDaysToWait); Unicode (Windows) INT DeleteSecret(LPCWSTR lpszSecretId, INT iDaysToWait); ``` ## Remarks This method deletes the secret specified by *SecretId*, and all of its versions, either immediately or after a waiting period depending on the value passed for *DaysToWait*. The value passed for *SecretId* must the ARN or name of a secret in the current account and [Region](#region-property-amazonsecrets-class). If *0* is passed for *DaysToWait*, the secret is deleted immediately. Otherwise, *DaysToWait* must be a value in the range *7* to *30* (inclusive), which will cause the secret to be scheduled for deletion. During the waiting period: - The secret's data cannot be retrieved from any secret version. - The deletion can be canceled by calling the [CancelDeletion](#canceldeletion-method-amazonsecrets-class) method. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # DoEvents Method ([AmazonSecrets](#amazonsecrets-class) Class) This method processes events from the internal message queue. ## Syntax ```text ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents(); ``` ## Remarks When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # GenRandomPassword Method ([AmazonSecrets](#amazonsecrets-class) Class) Returns a server-generated random password that complies with the given criteria. ## Syntax ```text ANSI (Cross Platform) char* GenRandomPassword(int iLength, int bLowercase, int bUppercase, int bNumbers, int bPunctuation, int bSpaces, const char* lpszExcludeChars, int bRequireEach); Unicode (Windows) LPWSTR GenRandomPassword(INT iLength, BOOL bLowercase, BOOL bUppercase, BOOL bNumbers, BOOL bPunctuation, BOOL bSpaces, LPCWSTR lpszExcludeChars, BOOL bRequireEach); ``` ## Remarks This method requests and returns a random password generated by the server based on a number of criteria. The *Length* parameter specifies how long the password must be; it must be a value in the range *1* to *4096* (inclusive). The *Lowercase*, *Uppercase*, *Numbers*, *Punctuation*, and *Spaces* parameters specify whether the server is *allowed* to include characters of each type. The *Lowercase* and *Uppercase* types cover ASCII characters only. For *Punctuation*, the applicable characters are: *! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~* The *ExcludeChars* parameters specifies a list of characters that *must not* be included in the password. For example, passing *&" -* would exclude ampersands, double quotes, spaces, and hyphens. The *RequireEach* parameter specifies whether the server *must* include at least one of each allowed character type in the password. ## Error Handling (C++) This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. # GetSecret Method ([AmazonSecrets](#amazonsecrets-class) Class) Retrieves a secret version's data. ## Syntax ```text ANSI (Cross Platform) int GetSecret(const char* lpszSecretId, const char* lpszVersionId, const char* lpszStagingLabel); Unicode (Windows) INT GetSecret(LPCWSTR lpszSecretId, LPCWSTR lpszVersionId, LPCWSTR lpszStagingLabel); ``` ## Remarks This method retrieves the secret data held by a version of the secret specified by *SecretId*. The exact version whose data should be retrieved is specified by either *VersionId* *or* *StagingLabel* (if both are specified, the latter is ignored). If neither are specified, the data from the secret version with the *AWSCURRENT* staging label is retrieved. The value passed for *SecretId* must the ARN or name of a secret in the current account and [Region](#region-property-amazonsecrets-class). The secret data is returned via the output stream supplied via the [SetOutputStream](#setoutputstream-method-amazonsecrets-class) method, the specified [LocalFile](#localfile-property-amazonsecrets-class), or the [SecretData](#secretdata-property-amazonsecrets-class) or [SecretString](#secretstring-property-amazonsecrets-class) property. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # GetSecretInfo Method ([AmazonSecrets](#amazonsecrets-class) Class) Gets information about a secret. ## Syntax ```text ANSI (Cross Platform) int GetSecretInfo(const char* lpszSecretId); Unicode (Windows) INT GetSecretInfo(LPCWSTR lpszSecretId); ``` ## Remarks This method gets information about the secret specified by *SecretId*. When the information is returned, the class clears the [Secrets](#secrets-property-amazonsecrets-class) collection and repopulates it collection (however, not all fields are populated). The [SecretList](#secretlist-event-amazonsecrets-class) and [VersionList](#versionlist-event-amazonsecrets-class) events are also fired. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # ListSecrets Method ([AmazonSecrets](#amazonsecrets-class) Class) Lists secrets in the current account and region. ## Syntax ```text ANSI (Cross Platform) int ListSecrets(); Unicode (Windows) INT ListSecrets(); ``` ## Remarks This method lists the secrets in the current account and [Region](#region-property-amazonsecrets-class). Note that, by default, secrets that have been scheduled for deletion are not included in the results; the [IncludeDeleted](#IncludeDeleted) configuration setting can be used to control this behavior. Calling this method will fire the [SecretList](#secretlist-event-amazonsecrets-class) event once for each secret, and will also populate the [Secrets](#secrets-property-amazonsecrets-class) collection. If the [AlwaysParseVersions](#AlwaysParseVersions) configuration setting is enabled, each secret's basic version information will also be parsed and used to populate the [Versions](#versions-property-amazonsecrets-class) collection and fire the [VersionList](#versionlist-event-amazonsecrets-class) event. If there are still more secrets available to list when this method returns, the [SecretMarker](#secretmarker-property-amazonsecrets-class) property will be populated. Continue to call this method until [SecretMarker](#secretmarker-property-amazonsecrets-class) is empty to accumulate all pages of results in the [Secrets](#secrets-property-amazonsecrets-class) collection. The [MaxSecrets](#MaxSecrets) configuration setting can be used to control the maximum number of results to return at once. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # ListVersions Method ([AmazonSecrets](#amazonsecrets-class) Class) List the secret versions for the specified secret. ## Syntax ```text ANSI (Cross Platform) int ListVersions(const char* lpszSecretId); Unicode (Windows) INT ListVersions(LPCWSTR lpszSecretId); ``` ## Remarks This method lists the secret versions for the secret specified by *SecretId*. Note that by default, only non-deprecated versions are returned (i.e., those with at least one staging label attached to them); the [IncludeDeprecated](#IncludeDeprecated) configuration setting can be used to control this behavior. Calling this method will fire the [VersionList](#versionlist-event-amazonsecrets-class) event once for each secret version, and will also populate the [Versions](#versions-property-amazonsecrets-class) collection. If there are still more secret versions available to list when this method returns, the [VersionMarker](#versionmarker-property-amazonsecrets-class) property will be populated. Continue to call this method until [VersionMarker](#versionmarker-property-amazonsecrets-class) is empty to accumulate all pages of results in the [Versions](#versions-property-amazonsecrets-class) collection. The [MaxSecrets](#MaxSecrets) configuration setting can be used to control the maximum number of results to return at once. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # MoveStagingLabel Method ([AmazonSecrets](#amazonsecrets-class) Class) Adds, removes, or moves a staging label. ## Syntax ```text ANSI (Cross Platform) int MoveStagingLabel(const char* lpszSecretId, const char* lpszStagingLabel, const char* lpszFromVersionId, const char* lpszToVersionId); Unicode (Windows) INT MoveStagingLabel(LPCWSTR lpszSecretId, LPCWSTR lpszStagingLabel, LPCWSTR lpszFromVersionId, LPCWSTR lpszToVersionId); ``` ## Remarks This method adds, removes, or moves a staging label between versions of the secret specified by *SecretId*. The value passed for *SecretId* must the ARN or name of a secret in the current account and [Region](#region-property-amazonsecrets-class). The *StagingLabel* parameter specifies the staging label that should be added, removed, or moved. If the staging label is *AWSCURRENT*, it cannot be removed, only moved, and the server will automatically move the *AWSPREVIOUS* staging label to the secret version specified by *FromVersionId*. The *FromVersionId* and *ToVersionId* parameters specify which version(s) to operate against. When adding a new staging label to a secret version, only *ToVersionId* must be specified. When removing a staging label from a version, only *FromVersionId* must be specified. When moving an existing staging label from one version to another, both *FromVersionId* and *ToVersionId* must be specified. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # Reset Method ([AmazonSecrets](#amazonsecrets-class) Class) Resets the class to its initial state. ## Syntax ```text ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset(); ``` ## Remarks This method resets the class to its initial state. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # SendCustomRequest Method ([AmazonSecrets](#amazonsecrets-class) Class) Sends a custom request to the server. ## Syntax ```text ANSI (Cross Platform) int SendCustomRequest(const char* lpszAction, const char* lpszBody); Unicode (Windows) INT SendCustomRequest(LPCWSTR lpszAction, LPCWSTR lpszBody); ``` ## 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 Secrets Manager documentation. When this method is called, the class does the following: 1. Builds a request URL, including query parameters, based on the following: - [Region](#region-property-amazonsecrets-class) - [QueryParams](#queryparams-property-amazonsecrets-class) 2. Adds request headers from [OtherHeaders](#otherheaders-property-amazonsecrets-class). 3. Adds the specified request *Body*, if non-empty. 4. Signs the request. 5. Sends the request to the server. 6. Stores the response headers in the [ParsedHeaders](#parsedheaders-property-amazonsecrets-class) collection; and the response body in the stream specified using [SetOutputStream](#setoutputstream-method-amazonsecrets-class), the specified [LocalFile](#localfile-property-amazonsecrets-class), or [SecretData](#secretdata-property-amazonsecrets-class). 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. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # SetInputStream Method ([AmazonSecrets](#amazonsecrets-class) Class) Sets the stream whose data should be sent. ## Syntax ```text ANSI (Cross Platform) int SetInputStream(CloudKeysStream* sInputStream); Unicode (Windows) INT SetInputStream(CloudKeysStream* sInputStream); ``` ## Remarks This method sets the stream whose data should be sent when [CreateSecret](#createsecret-method-amazonsecrets-class) or [CreateVersion](#createversion-method-amazonsecrets-class) is called. The class assumes that any data specified via an input stream is binary in nature; the [PreferBinary](#PreferBinary) configuration setting can be used to control this behavior, refer to its documentation for more information. Note: Passing a non-null value for *InputStream* will cause the [LocalFile](#localfile-property-amazonsecrets-class) property to be cleared. Similarly, setting [LocalFile](#localfile-property-amazonsecrets-class) to a non-empty value will discard any stream set using this method. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # SetOutputStream Method ([AmazonSecrets](#amazonsecrets-class) Class) Sets the stream to which received data should be written. ## Syntax ```text ANSI (Cross Platform) int SetOutputStream(CloudKeysStream* sOutputStream); Unicode (Windows) INT SetOutputStream(CloudKeysStream* sOutputStream); ``` ## Remarks This method sets the stream to which data should be written when [GetSecret](#getsecret-method-amazonsecrets-class) is called. Note: Passing a non-null value for *OutputStream* will cause the [LocalFile](#localfile-property-amazonsecrets-class) property to be cleared. Similarly, setting [LocalFile](#localfile-property-amazonsecrets-class) to a non-empty value will discard any stream set using this method. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # UpdateSecret Method ([AmazonSecrets](#amazonsecrets-class) Class) Updates a secret's information. ## Syntax ```text ANSI (Cross Platform) int UpdateSecret(const char* lpszSecretId, const char* lpszDescription); Unicode (Windows) INT UpdateSecret(LPCWSTR lpszSecretId, LPCWSTR lpszDescription); ``` ## Remarks This method updates the information of the secret specified by *SecretId*. The value passed for *SecretId* must the ARN or name of a secret in the current account and [Region](#region-property-amazonsecrets-class). The *Description* parameter specifies the secret's new description (which may be empty). The [KMSKeyId](#KMSKeyId) configuration setting can also be set before calling this method to change the AWS KMS key used to encrypt the secret. However, if the KMS key used to encrypt a secret is changed, it is important that the secret's data be updated at least once using [CreateVersion](#createversion-method-amazonsecrets-class). When a new version is created, the server decrypts the secret using the old KMS key and re-encrypts it using the new one. If the old KMS key is deleted or disabled before this occurs, the server will no longer be able to decrypt the secret, effectively causing its data to be lost. ## Error Handling (C++) This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.) # EndTransfer Event ([AmazonSecrets](#amazonsecrets-class) Class) Fired when a document finishes transferring. ## Syntax ```text ANSI (Cross Platform) virtual int FireEndTransfer(AmazonSecretsEndTransferEventParams *e); typedef struct { int Direction; int reserved; } AmazonSecretsEndTransferEventParams; Unicode (Windows) virtual INT FireEndTransfer(AmazonSecretsEndTransferEventParams *e); typedef struct { INT Direction; INT reserved; } AmazonSecretsEndTransferEventParams; ``` ## 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 ([AmazonSecrets](#amazonsecrets-class) Class) Fired when information is available about errors during data delivery. ## Syntax ```text ANSI (Cross Platform) virtual int FireError(AmazonSecretsErrorEventParams *e); typedef struct { int ErrorCode; const char *Description; int reserved; } AmazonSecretsErrorEventParams; Unicode (Windows) virtual INT FireError(AmazonSecretsErrorEventParams *e); typedef struct { INT ErrorCode; LPCWSTR Description; INT reserved; } AmazonSecretsErrorEventParams; ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-amazonsecrets-class) section. # Header Event ([AmazonSecrets](#amazonsecrets-class) Class) Fired every time a header line comes in. ## Syntax ```text ANSI (Cross Platform) virtual int FireHeader(AmazonSecretsHeaderEventParams *e); typedef struct { const char *Field; const char *Value; int reserved; } AmazonSecretsHeaderEventParams; Unicode (Windows) virtual INT FireHeader(AmazonSecretsHeaderEventParams *e); typedef struct { LPCWSTR Field; LPCWSTR Value; INT reserved; } AmazonSecretsHeaderEventParams; ``` ## 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). # Log Event ([AmazonSecrets](#amazonsecrets-class) Class) Fired once for each log message. ## Syntax ```text ANSI (Cross Platform) virtual int FireLog(AmazonSecretsLogEventParams *e); typedef struct { int LogLevel; const char *Message; const char *LogType; int reserved; } AmazonSecretsLogEventParams; Unicode (Windows) virtual INT FireLog(AmazonSecretsLogEventParams *e); typedef struct { INT LogLevel; LPCWSTR Message; LPCWSTR LogType; INT reserved; } AmazonSecretsLogEventParams; ``` ## Remarks This event is fired once for each log message generated by the class. 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" # SecretList Event ([AmazonSecrets](#amazonsecrets-class) Class) Fires once for each secret when listing secrets. ## Syntax ```text ANSI (Cross Platform) virtual int FireSecretList(AmazonSecretsSecretListEventParams *e); typedef struct { const char *ARN; const char *Name; const char *Description; const char *CreationDate; const char *DeletionDate; const char *LastAccessDate; const char *LastChangeDate; int reserved; } AmazonSecretsSecretListEventParams; Unicode (Windows) virtual INT FireSecretList(AmazonSecretsSecretListEventParams *e); typedef struct { LPCWSTR ARN; LPCWSTR Name; LPCWSTR Description; LPCWSTR CreationDate; LPCWSTR DeletionDate; LPCWSTR LastAccessDate; LPCWSTR LastChangeDate; INT reserved; } AmazonSecretsSecretListEventParams; ``` ## Remarks This event fires once for each secret returned when [ListSecrets](#listsecrets-method-amazonsecrets-class) or [GetSecretInfo](#getsecretinfo-method-amazonsecrets-class) is called. *ARN* reflects the Amazon resource name of the secret. *Name* reflects the name of the secret. *Description* reflects the secret's description. *CreationDate* reflects the secret's creation date, in seconds since the Unix epoch (including fractional seconds). *DeletionDate* reflects the secret's scheduled deletion date, if applicable, in seconds since the Unix epoch (including fractional seconds). *LastAccessDate* reflects the secret's last access date, in seconds since the Unix epoch. It provides date-level resolution only, the time is not included. *LastChangeDate* reflects the secret's last change date, in seconds since the Unix epoch (including fractional seconds). # SSLServerAuthentication Event ([AmazonSecrets](#amazonsecrets-class) Class) Fired after the server presents its certificate to the client. ## Syntax ```text ANSI (Cross Platform) virtual int FireSSLServerAuthentication(AmazonSecretsSSLServerAuthenticationEventParams *e); typedef struct { const char *CertEncoded; int lenCertEncoded; const char *CertSubject; const char *CertIssuer; const char *Status; int Accept; int reserved; } AmazonSecretsSSLServerAuthenticationEventParams; Unicode (Windows) virtual INT FireSSLServerAuthentication(AmazonSecretsSSLServerAuthenticationEventParams *e); typedef struct { LPCSTR CertEncoded; INT lenCertEncoded; LPCWSTR CertSubject; LPCWSTR CertIssuer; LPCWSTR Status; BOOL Accept; INT reserved; } AmazonSecretsSSLServerAuthenticationEventParams; ``` ## 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 ([AmazonSecrets](#amazonsecrets-class) Class) Fired when secure connection progress messages are available. ## Syntax ```text ANSI (Cross Platform) virtual int FireSSLStatus(AmazonSecretsSSLStatusEventParams *e); typedef struct { const char *Message; int reserved; } AmazonSecretsSSLStatusEventParams; Unicode (Windows) virtual INT FireSSLStatus(AmazonSecretsSSLStatusEventParams *e); typedef struct { LPCWSTR Message; INT reserved; } AmazonSecretsSSLStatusEventParams; ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([AmazonSecrets](#amazonsecrets-class) Class) Fired when a document starts transferring (after the headers). ## Syntax ```text ANSI (Cross Platform) virtual int FireStartTransfer(AmazonSecretsStartTransferEventParams *e); typedef struct { int Direction; int reserved; } AmazonSecretsStartTransferEventParams; Unicode (Windows) virtual INT FireStartTransfer(AmazonSecretsStartTransferEventParams *e); typedef struct { INT Direction; INT reserved; } AmazonSecretsStartTransferEventParams; ``` ## 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 ([AmazonSecrets](#amazonsecrets-class) Class) Fired while a document transfers (delivers document). ## Syntax ```text ANSI (Cross Platform) virtual int FireTransfer(AmazonSecretsTransferEventParams *e); typedef struct { int Direction; int64 BytesTransferred; int PercentDone; const char *Text; int lenText; int reserved; } AmazonSecretsTransferEventParams; Unicode (Windows) virtual INT FireTransfer(AmazonSecretsTransferEventParams *e); typedef struct { INT Direction; LONG64 BytesTransferred; INT PercentDone; LPCSTR Text; INT lenText; INT reserved; } AmazonSecretsTransferEventParams; ``` ## 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. # VersionList Event ([AmazonSecrets](#amazonsecrets-class) Class) Fires once for each secret version when listing secret versions. ## Syntax ```text ANSI (Cross Platform) virtual int FireVersionList(AmazonSecretsVersionListEventParams *e); typedef struct { const char *SecretARN; const char *SecretName; const char *VersionId; const char *StagingLabels; const char *CreationDate; const char *LastAccessDate; int reserved; } AmazonSecretsVersionListEventParams; Unicode (Windows) virtual INT FireVersionList(AmazonSecretsVersionListEventParams *e); typedef struct { LPCWSTR SecretARN; LPCWSTR SecretName; LPCWSTR VersionId; LPCWSTR StagingLabels; LPCWSTR CreationDate; LPCWSTR LastAccessDate; INT reserved; } AmazonSecretsVersionListEventParams; ``` ## Remarks This event fires once for each secret version returned when [ListVersions](#listversions-method-amazonsecrets-class), [GetSecretInfo](#getsecretinfo-method-amazonsecrets-class), or (if the [AlwaysParseVersions](#AlwaysParseVersions) configuration setting is enabled) [ListSecrets](#listsecrets-method-amazonsecrets-class) is called. Note that *CreationDate* and *LastAccessDate* are only populated when [ListVersions](#listversions-method-amazonsecrets-class) is called. *SecretARN* reflects the Amazon resource name of the secret this is a version of. *SecretName* reflects the name of the secret this is a version of. *VersionId* reflects the Id of the secret version. *StagingLabels* reflects a comma-separated list of staging labels attached to the secret version. *CreationDate* reflects the secret version's creation date, in seconds since the Unix epoch (including fractional seconds). *LastAccessDate* reflects the secret version's last access date, in seconds since the Unix epoch. It provides date-level resolution only, the time is not included. # AWSSecret Type An Amazon Secrets Manager secret. ## Syntax *CloudKeysAWSSecret* (declared in *cloudkeys.h*) ## Remarks This type represents an Amazon Secrets Manager secret. The following fields are available: - [ARN](#AWSSecret_f_ARN) - [CreationDate](#AWSSecret_f_CreationDate) - [DeletionDate](#AWSSecret_f_DeletionDate) - [Description](#AWSSecret_f_Description) - [KMSKeyId](#AWSSecret_f_KMSKeyId) - [LastAccessDate](#AWSSecret_f_LastAccessDate) - [LastChangeDate](#AWSSecret_f_LastChangeDate) - [Name](#AWSSecret_f_Name) - [OwningService](#AWSSecret_f_OwningService) ## Fields **ARN** *char* (read-only)* *Default Value: ""* The Amazon resource name (ARN) of the secret. This field reflects the Amazon resource name (ARN) of the secret. **CreationDate** *char* (read-only)* *Default Value: ""* The creation date of the secret. This field reflects the creation date of the secret, in seconds since the Unix epoch (including fractional seconds). **DeletionDate** *char* (read-only)* *Default Value: ""* The deletion date of the secret. This field reflects the deletion date of the secret, in seconds since the Unix epoch (including fractional seconds). **Description** *char* (read-only)* *Default Value: ""* The secret's description. This field reflects the secret's description. **KMSKeyId** *char* (read-only)* *Default Value: ""* The ARN or alias of the Amazon KMS KMS key used to encrypt the secret. This field reflects the ARN or alias of the Amazon KMS key used to encrypt the secret. **LastAccessDate** *char* (read-only)* *Default Value: ""* The last access date of the secret. This field reflects the last access date of the secret, in seconds since the Unix epoch. Note that this field offers date-level resolution, time is not included. **LastChangeDate** *char* (read-only)* *Default Value: ""* The last change date of the secret. This field reflects the last change date of the secret, in seconds since the Unix epoch (including fractional seconds). **Name** *char* (read-only)* *Default Value: ""* The name of the secret. This field reflects the name of the secret. **OwningService** *char* (read-only)* *Default Value: ""* The name of the service that created the secret. This field reflects the name of the AWS service that created the secret. # AWSSecretVersion Type An Amazon Secrets Manager secret version. ## Syntax *CloudKeysAWSSecretVersion* (declared in *cloudkeys.h*) ## Remarks This type represents an Amazon Secrets Manager secret version. The following fields are available: - [CreationDate](#AWSSecretVersion_f_CreationDate) - [LastAccessDate](#AWSSecretVersion_f_LastAccessDate) - [SecretARN](#AWSSecretVersion_f_SecretARN) - [SecretName](#AWSSecretVersion_f_SecretName) - [StagingLabels](#AWSSecretVersion_f_StagingLabels) - [VersionId](#AWSSecretVersion_f_VersionId) ## Fields **CreationDate** *char* (read-only)* *Default Value: ""* The creation date of the secret version. This field reflects the creation date of the secret version, in seconds since the Unix epoch (including fractional seconds). **LastAccessDate** *char* (read-only)* *Default Value: ""* The last access date of the secret version. This field reflects the last access date of the secret version, in seconds since the Unix epoch. Note that this field offers date-level resolution, time is not included. **SecretARN** *char* (read-only)* *Default Value: ""* The Amazon resource name (ARN) of the secret this is a version of. This field reflects the Amazon resource name (ARN) of the secret that this is a version of. **SecretName** *char* (read-only)* *Default Value: ""* The name of the secret that this is a version of. This field reflects the name of the secret that this is a version of. **StagingLabels** *char* (read-only)* *Default Value: ""* The staging labels attached to the secret version. This field reflects a comma-separated list of staging labels attached to the secret version. Each secret version can have up to 20 staging labels attached to it at once, and a particular staging label can only be attached to one secret version at any given time. **VersionId** *char* (read-only)* *Default Value: ""* The Id of the secret version. This field reflects the Id of the secret version. # Certificate Type This is the digital certificate being used. ## Syntax *CloudKeysCertificate* (declared in *cloudkeys.h*) ## 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) - [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) - [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) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *char* (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. **ExpirationDate** *char* (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** *char* (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *char* (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** *char* (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** *char* (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** *char* (read-only)* *Default Value: ""* The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. **PrivateKey** *char* (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** *int (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** *char* (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** *char* (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *char* (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** *int (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *char* (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** *char* (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** *char** *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field 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) field 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) field 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** *char** *Default Value: ""* If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store. **StoreType** *int* *Default Value: 0* The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This field 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 class 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. | **SubjectAltNames** *char* (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *char* (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** *char* (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** *char* (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** *char* (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** *int (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) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *char* (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *char** *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 field 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. **Encoded** *char** *Default Value: ""* The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields 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. ## Constructors ```text Certificate() ``` Creates a instance whose properties can be set. ```text Certificate(const char* lpEncoded, int lenEncoded) ``` Parses * Encoded * as an X.509 public key. ```text Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject) ``` * 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. ## Syntax *CloudKeysFirewall* (declared in *cloudkeys.h*) ## 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** *int* *Default Value: FALSE* Whether to automatically detect and use firewall system settings, if available. **FirewallType** *int* *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** *char** *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 field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class fails with an error. **Password** *char** *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) fields are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error. **Port** *int* *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) field for details. NOTE: This field is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) field for details. **User** *char** *Default Value: ""* A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this field and the [Password](#Firewall_f_Password) field are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class fails with an error. ## Constructors ```text Firewall() ``` # Header Type This is an HTTP header as it is received from the server. ## Syntax *CloudKeysHeader* (declared in *cloudkeys.h*) ## 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** *char** *Default Value: ""* This field contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered). **Value** *char** *Default Value: ""* This field contains the [Header](#header-type) contents. ## Constructors ```text Header() ``` ```text Header(const char* lpszField, const char* lpszValue) ``` # Proxy Type The proxy the component will connect to. ## Syntax *CloudKeysProxy* (declared in *cloudkeys.h*) ## 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** *int* *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) fields 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) fields are set, the class 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 class. Look at the configuration file for the class 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 field will clear the values of [User](#Proxy_f_User) and [Password](#Proxy_f_Password). **AutoDetect** *int* *Default Value: FALSE* Whether to automatically detect and use proxy system settings, if available. The default value is *false*. **Password** *char** *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) fields 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) fields 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) fields are used to authenticate through NTLM negotiation. **Port** *int* *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) field for details. **Server** *char** *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) field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [Server](#Proxy_f_Server) field is set to the corresponding address. If the search is not successful, an error is returned. **SSL** *int* *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 class will use the psTunnel option. If the URL is an http URL, the class 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** *char** *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) fields 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) fields 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) fields are used to authenticate through NTLM negotiation. ## Constructors ```text Proxy() ``` ```text Proxy(const char* lpszServer, int iPort) ``` ```text Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword) ``` # QueryParam Type A query parameter to send in the request. ## Syntax *CloudKeysQueryParam* (declared in *cloudkeys.h*) ## 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** *char** *Default Value: ""* The name of the query parameter. This field specifies the name of the query parameter. **Value** *char** *Default Value: ""* The value of the query parameter. This field specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request. ## Constructors ```text QueryParam() ``` ```text QueryParam(const char* lpszName, const char* lpszValue) ``` # CloudKeysList Type ## Syntax *CloudKeysList* (declared in *cloudkeys.h*) ## Remarks *CloudKeysList* is a generic class that is used to hold a collection of objects of type *T*, where *T* is one of the custom types supported by the AmazonSecrets class. ```text int GetCount() {} ``` ```text int SetCount(int count) {} ``` ```text T* Get(int index) {} ``` ```text T* Set(int index, T* value) {} ``` | | | | --- | --- | | Methods | | | GetCount | This method returns the current size of the collection. | | SetCount | This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. | | Get | This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified. | | Set | This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class. | # CloudKeysStream Type ## Syntax *CloudKeysStream* (declared in *cloudkeys.h*) ## Remarks The AmazonSecrets class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the CloudKeysStream interface and pass the AmazonSecrets class an instance of that concrete class. When implementing the CloudKeysStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur. ```text bool CanRead() { return true; } ``` ```text bool CanSeek() { return true; } ``` ```text bool CanWrite() { return true; } ``` ```text int64 GetLength() = 0; ``` ```text void Close() {} ``` ```text int Flush() { return 0; } ``` ```text int Read(void* buffer, int count) = 0; ``` ```text int64 Seek(int64 offset, int seekOrigin) = 0; ``` ```text int Write(const void* buffer, int count) = 0; ``` | | | | --- | --- | | Properties | | | CanRead | Whether the stream supports reading. | | CanSeek | Whether the stream supports seeking. | | CanWrite | Whether the stream supports writing. | | Length | Gets the length of the stream, in bytes. | | Methods | | | Close | Closes the stream, releasing all resources currently allocated for it. This method is called automatically when a CloudKeysStream object is deleted. | | Flush | Forces all data held by the stream's buffers to be written out to storage. Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. | | Read | Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. | | Seek | Sets the current position within the stream based on a particular point of origin. Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are: 0: Seek from beginning. 1: Seek from current position. 2: Seek from end. Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. | | Write | Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. | # Config Settings ([AmazonSecrets](#amazonsecrets-class) Class) The class 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 class, access to these *internal properties* is provided through the [Config](#config-method-amazonsecrets-class) method. ### AmazonSecrets Config Settings **AccumulatePages**: Whether the class should accumulate subsequent pages of results when listing them.This setting controls how the class 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. **AlwaysParseVersions**: Whether to parse version information when listing secrets.By default, this setting is disabled, and the class will parse version information when [GetSecretInfo](#getsecretinfo-method-amazonsecrets-class) is called and use it to populate the [Versions](#versions-property-amazonsecrets-class) collection and fire the [VersionList](#versionlist-event-amazonsecrets-class) event, but will *not* do so when [ListSecrets](#listsecrets-method-amazonsecrets-class) is called. If this setting is enabled, the class will also parse version information included in each secret item returned when [ListSecrets](#listsecrets-method-amazonsecrets-class) is called, and all secrets' version information will be accumulated in [Versions](#versions-property-amazonsecrets-class) and exposed via [VersionList](#versionlist-event-amazonsecrets-class). **AWSProfile**: The name of the AWS CLI profile that the class 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 class 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 class 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 class also supports the *region* element, if it is present in the specified profile. The class 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 class 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 class 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 class 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). **IncludeDeleted**: Whether to include secrets scheduled for deletion when listing secrets.This setting specifies whether the server should include secrets scheduled for deletion (but not yet deleted) in the results when [ListSecrets](#listsecrets-method-amazonsecrets-class) is called. By default, this setting is disabled, and secret scheduled for deletion are not included in the [ListSecrets](#listsecrets-method-amazonsecrets-class) results. **IncludeDeprecated**: Whether to include deprecated version when listing versions.This setting specifies whether the server should include deprecated secret versions (i.e., those without any staging labels attached to them) in the results when [ListVersions](#listversions-method-amazonsecrets-class) is called. By default, this setting is disabled, and deprecated secret versions are not included in the [ListVersions](#listversions-method-amazonsecrets-class) results. **KMSKeyId**: The Id of the Amazon KMS KMS key that should be used to encrypt a secret.This setting can be set to the ARN or alias of an AWS KMS key before calling [CreateSecret](#createsecret-method-amazonsecrets-class) to have the secret be encrypted by that KMS key instead of the default AWS-managed one. This setting can also be set before calling [UpdateSecret](#updatesecret-method-amazonsecrets-class) to change the KMS key used to encrypt the secret; refer to that method's documentation for more information. **MaxSecrets**: The maximum number of results to return when listing secrets.This setting specifies the maximum number of results that should be returned by a call to [ListSecrets](#listsecrets-method-amazonsecrets-class) or [ListVersions](#listversions-method-amazonsecrets-class). If this setting is *-1* (default), the server chooses an appropriate default. Otherwise, the setting must be set to a value in the range *1* to *100*. **PreferBinary**: Whether the class should treat secret data as binary or textual in ambiguous situations.On the server, a secret has two mutually exclusive fields that can be used to store secret data: one for binary data (*SecretBinary*), and one for textual data (*SecretString*). When the class creates a secret or secret version using [CreateSecret](#createsecret-method-amazonsecrets-class) or [CreateVersion](#createversion-method-amazonsecrets-class), it has to choose which of these two fields to store data in. When the secret data is provided via the [SecretData](#secretdata-property-amazonsecrets-class) or the [SecretString](#secretstring-property-amazonsecrets-class) property, the class always knows which field to store the data in based on which property is populated. However, when data is provided via a [LocalFile](#localfile-property-amazonsecrets-class) or an input stream specified via [SetInputStream](#setinputstream-method-amazonsecrets-class), the class cannot determine which field is more suitable, so it chooses based how this setting is set. By default, this setting is enabled, and the class will use the binary data field to store the secret data in the cases described above. Disabling this setting will cause the class to use the textual data field instead. Note that attempting to send non-textual data when this setting is disabled is likely to result in data loss or other problems. **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 class 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 class 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 class 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-amazonsecrets-class) and [SecretKey](#secretkey-property-amazonsecrets-class) 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 class should use the FIPS endpoint for the currently-selected [Region](#region-property-amazonsecrets-class) 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 class 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 class 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 class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms. When True, the class 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 class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error 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](#localfile-property-amazonsecrets-class). When set to True, downloaded data will be appended to [LocalFile](#localfile-property-amazonsecrets-class). This may be used in conjunction with Range to resume a failed download. This is applicable only when [LocalFile](#localfile-property-amazonsecrets-class) 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 class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. 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-amazonsecrets-class) 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 class.If set to True, the URL passed to the class 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 class 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 class fails with an error. **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 class fails with an error instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class 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 class.This property specifies the HTTP version used by the class. 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 class 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-amazonsecrets-class) 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 class 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 class 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 (*"\r\n"*) . 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 class 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 classes 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 classes that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes 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 classes 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 classes 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 class.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 class. **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 class 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 class 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*. In the C++ Edition for Windows, the *W version of the class must be used. For instance, *DNSW* or *HTTPW*. **UsePlatformHTTPClient**: Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (*URLConnection* in Java, *WebRequest* in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine). NOTE: This setting is applicable only to Mac/iOS editions. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class 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 class 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 **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 class will use [Timeout](#timeout-property-amazonsecrets-class) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes 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 classes 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 class fails with an error. NOTE: This setting is provided for use by classes 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 classes 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 classes 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 class fails with an error. NOTE: This setting is provided for use by classes 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. **KeepAliveRetryCount**: The number of keep-alive packets to be sent before the remotehost is considered disconnected.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 number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9. NOTE: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD. **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 class 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-amazonsecrets-class) 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 class initiate connections (or accept in the case of server classes) only through that interface. If the class is connected, the [LocalHost](#localhost-property-amazonsecrets-class) 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 class binds. This configuration setting must be set before a connection is attempted. It instructs the class 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 class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class 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-amazonsecrets-class) 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-amazonsecrets-class) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-amazonsecrets-class) 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 class 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 class is the same. **SSLCACertFilePaths**: The paths to CA certificate files on Unix/Linux.This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux. The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates. The default value is as follows: */etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem* **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-amazonsecrets-class) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-amazonsecrets-class) 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----- ``` **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-amazonsecrets-class) 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 class 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-amazonsecrets-class) 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-amazonsecrets-class) 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-amazonsecrets-class) 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-amazonsecrets-class) 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 class will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-amazonsecrets-class) 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-amazonsecrets-class) 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 class when the [SSLProvider](#sslprovider-property-amazonsecrets-class) 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-amazonsecrets-class) 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-amazonsecrets-class) 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-amazonsecrets-class) 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-amazonsecrets-class) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-amazonsecrets-class) 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 class 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 class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-amazonsecrets-class) 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-amazonsecrets-class) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the class 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 class fails with an error. 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-amazonsecrets-class) 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-amazonsecrets-class) 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 class 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 class 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 class 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*. **ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. **SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when [DoEvents](#doevents-method-amazonsecrets-class) is called, the class will wait for the amount of time specified here before returning. The default value is 20. **UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class 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 classes 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 class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # Trappable Errors ([AmazonSecrets](#amazonsecrets-class) Class) ## Error Handling (C++) Call the *GetLastErrorCode()* method to obtain the last called method's result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. ### Common Errors | | | | --- | --- | | 600 | A server error occurred, and/or the class 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 already exists and [Overwrite](#overwrite-property-amazonsecrets-class) is false. | | 607 | An exception occurred while working with the specified InputFile or OutputFile (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 class may also return one of the following error codes, which are inherited from other classes. ### 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 class may also return one of the following error codes, which are inherited from other classes. ### 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-amazonsecrets-class) 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 class 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). |