AmazonSQS Control
Properties Methods Events Config Settings Errors
The AmazonSQS Control provides an easy interface to Amazon's Simple Queue Service (SQS).
Syntax
AmazonSQS
Remarks
The AmazonSQS Control allows you to access Amazon's Simple Queue Service (SQS). SQS allows you to create globally accessible queues on Amazon's servers. These queues can be used by developers to transfer data between distributed application components, without losing messages or requiring each component to always be available. A brief synopsis follows but please refer to Amazon SQS documentation for details.
You will first need to sign up for the SQS service and obtain the AccessKey and SecretKey from Amazon. Then you can start creating queues in your account using CreateQueue. You can then start adding message's to the queue using CreateMessage and retrieve the same using ListMessages.
There are other methods such as ListQueues, DeleteQueue, DeleteMessage etc. that further enable you to manage your SQS queues.
SmoothMQ is also supported. For compatibility with SmoothMQ, APIRequestFormat must be set to 2. Additionally, it is advisable to set ResolveQueueId to true.
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
AccessKey | The Access Key Id for the Amazon Web Services account. |
AttributesCount | The number of records in the Attributes arrays. |
AttributesName | The name of the attribute. |
AttributesValue | The value of the attribute. |
FirewallAutoDetect | Whether to automatically detect and use firewall system settings, if available. |
FirewallType | The type of firewall to connect through. |
FirewallHost | The name or IP address of the firewall (optional). |
FirewallPassword | A password if authentication is to be used when connecting through the firewall. |
FirewallPort | The Transmission Control Protocol (TCP) port for the firewall Host . |
FirewallUser | A username if authentication is to be used when connecting through a firewall. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
MaxMessages | The maximum number of messages retrieved from the queue. |
MessagesCount | The number of records in the Messages arrays. |
MessagesBody | The body of the SQS message. |
MessagesId | The ID of the SQS message. |
MessagesMD5 | The MD5 of the SQS message. |
MessagesReceiptHandle | The Receipt handle of the SQS message. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthScheme | The type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | Whether to automatically detect and use proxy system settings, if available. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
ProxyUser | A username if authentication is to be used for the proxy. |
QueuePrefix | QueuePrefix can be used to filter the queues listed. |
QueuesCount | The number of records in the Queues arrays. |
QueuesId | The ID of the SQS queue. |
QueuesUrl | The URL of the SQS queue. |
Referer | This property includes the referer URL/document (optional). |
SecretKey | The Secret Access Key for the Amazon Web Services account. |
SSLAcceptServerCertEffectiveDate | The date on which this certificate becomes valid. |
SSLAcceptServerCertExpirationDate | The date on which the certificate expires. |
SSLAcceptServerCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
SSLAcceptServerCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLAcceptServerCertIssuer | The issuer of the certificate. |
SSLAcceptServerCertPrivateKey | The private key of the certificate (if available). |
SSLAcceptServerCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
SSLAcceptServerCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
SSLAcceptServerCertPublicKey | The public key of the certificate. |
SSLAcceptServerCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
SSLAcceptServerCertPublicKeyLength | The length of the certificate's public key (in bits). |
SSLAcceptServerCertSerialNumber | The serial number of the certificate encoded as a string. |
SSLAcceptServerCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
SSLAcceptServerCertStore | The name of the certificate store for the client certificate. |
SSLAcceptServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLAcceptServerCertStoreType | The type of certificate store for this certificate. |
SSLAcceptServerCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
SSLAcceptServerCertThumbprintMD5 | The MD5 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
SSLAcceptServerCertUsage | The text description of UsageFlags . |
SSLAcceptServerCertUsageFlags | The flags that show intended use for the certificate. |
SSLAcceptServerCertVersion | The certificate's version number. |
SSLAcceptServerCertSubject | The subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | The certificate (PEM/Base64 encoded). |
SSLCertEffectiveDate | The date on which this certificate becomes valid. |
SSLCertExpirationDate | The date on which the certificate expires. |
SSLCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
SSLCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLCertIssuer | The issuer of the certificate. |
SSLCertPrivateKey | The private key of the certificate (if available). |
SSLCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
SSLCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
SSLCertPublicKey | The public key of the certificate. |
SSLCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
SSLCertPublicKeyLength | The length of the certificate's public key (in bits). |
SSLCertSerialNumber | The serial number of the certificate encoded as a string. |
SSLCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
SSLCertThumbprintMD5 | The MD5 hash of the certificate. |
SSLCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
SSLCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
SSLCertUsage | The text description of UsageFlags . |
SSLCertUsageFlags | The flags that show intended use for the certificate. |
SSLCertVersion | The certificate's version number. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLCertEncoded | The certificate (PEM/Base64 encoded). |
SSLProvider | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCertEffectiveDate | The date on which this certificate becomes valid. |
SSLServerCertExpirationDate | The date on which the certificate expires. |
SSLServerCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
SSLServerCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLServerCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLServerCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLServerCertIssuer | The issuer of the certificate. |
SSLServerCertPrivateKey | The private key of the certificate (if available). |
SSLServerCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
SSLServerCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
SSLServerCertPublicKey | The public key of the certificate. |
SSLServerCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
SSLServerCertPublicKeyLength | The length of the certificate's public key (in bits). |
SSLServerCertSerialNumber | The serial number of the certificate encoded as a string. |
SSLServerCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
SSLServerCertStore | The name of the certificate store for the client certificate. |
SSLServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLServerCertStoreType | The type of certificate store for this certificate. |
SSLServerCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
SSLServerCertThumbprintMD5 | The MD5 hash of the certificate. |
SSLServerCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
SSLServerCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
SSLServerCertUsage | The text description of UsageFlags . |
SSLServerCertUsageFlags | The flags that show intended use for the certificate. |
SSLServerCertVersion | The certificate's version number. |
SSLServerCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/Base64 encoded). |
StatusLine | This property is the first line of the last server response. |
Timeout | The timeout for the control. |
UseSSL | Use SSL when accessing the service. |
VisibilityTimeout | The visibility duration for messages in the queue. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
AddPermission | Adds a permission to a queue for a specific account, which allows for sharing access to the queue. |
ChangeMessageVisibility | Changes the visibility timeout of a message. |
Config | Sets or retrieves a configuration setting. |
CreateMessage | Adds a message to a queue. |
CreateQueue | Creates an SQS queue. |
DeleteMessage | Deletes the message specified. |
DeleteQueue | Deletes a queue. |
DoEvents | This method processes events from the internal message queue. |
GetQueueAttributes | Returns all attributes of a queue. |
GetXValue | Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest . |
Interrupt | This method interrupts the current method. |
ListMessages | Gets messages from the queue. |
ListQueues | Lists the queues under the current account. |
RemovePermission | The RemovePermission action revokes any permissions in the queue policy that matches the UserLabel parameter. |
Reset | Resets request-related properties. |
ResetHeaders | Resets all HTTP headers, cookies, and LocalFile. |
SendCustomRequest | Allows the sending of a custom request to an Amazon web service. |
SetQueueAttribute | Sets an attribute of a queue. |
Event List
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
Connected | Fired immediately after a connection completes (or fails). |
Disconnected | Fired when a connection is closed. |
EndTransfer | Fired when a document finishes transferring. |
Error | Fired when information is available about errors during data delivery. |
Header | Fired every time a header line comes in. |
Message | Fired for each message retrieved from the queue. |
Queue | Fired for each queue of the user. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | Fired when a document starts transferring (after the headers). |
Status | Fired when the HTTP status line is received from the server. |
Transfer | Fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the control with short descriptions. Click on the links for further details.
APIRequestFormat | Changes the API request format. |
APIVersion | Service's API version. |
HTTPMethod | Specifies the HTTP method to use when sending a custom request. |
MessageAttributeCount | The number of message attributes. |
MessageAttributeDataType[i] | The data type of the message attribute. |
MessageAttributeName[i] | The name of the message attribute. |
MessageAttributeValue[i] | The value of the message attribute. |
MessageDeduplicationId | The message deduplication ID for the message being created. |
MessageGroupId | The ID of the message group to which the message belongs. |
PurgeQueue | Deletes all messages in a queue specified by the QueueId. |
ResolveQueueId | If set to true (default false), requests that require Queue URL can also be resolved using the Queue ID. |
SignatureVersion | The version of signature used. |
SignCustomRequest | Tells the control to sign the outgoing request. |
TransferredData | Returns the entire XML response received from the server. |
URL | If set, the default URL will be overridden by this value. |
UseEC2RoleCredentials | If set, authenticate requests with credentials obtained from the specified IAM role attached to the EC2 instance. |
UseFIFOQueues | Whether queues should always be created as FIFO queues. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the control. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the control will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the control. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the control. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the control whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the control binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
AccessKey Property (AmazonSQS Control)
The Access Key Id for the Amazon Web Services account.
Syntax
amazonsqscontrol.AccessKey[=string]
Default Value
""
Remarks
This is the username for the Amazon Web Services account. No two accounts may have the same Access Key. This is used along with the SecretKey to authenticate with Amazon servers.
Data Type
String
AttributesCount Property (AmazonSQS Control)
The number of records in the Attributes arrays.
Syntax
amazonsqscontrol.AttributesCount
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at AttributesCount - 1.This property is read-only and not available at design time.
Data Type
Integer
AttributesName Property (AmazonSQS Control)
The name of the attribute.
Syntax
amazonsqscontrol.AttributesName(AttributesIndex)
Default Value
""
Remarks
The name of the attribute.
The AttributesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributesCount property.
This property is read-only and not available at design time.
Data Type
String
AttributesValue Property (AmazonSQS Control)
The value of the attribute.
Syntax
amazonsqscontrol.AttributesValue(AttributesIndex)
Default Value
""
Remarks
The value of the attribute.
The AttributesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttributesCount property.
This property is read-only and not available at design time.
Data Type
String
FirewallAutoDetect Property (AmazonSQS Control)
Whether to automatically detect and use firewall system settings, if available.
Syntax
amazonsqscontrol.FirewallAutoDetect[=boolean]
Default Value
False
Remarks
Whether to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (AmazonSQS Control)
The type of firewall to connect through.
Syntax
amazonsqscontrol.FirewallType[=integer]
Possible Values
fwNone(0), fwTunnel(1), fwSOCKS4(2), fwSOCKS5(3), fwSOCKS4A(10)
Default Value
0
Remarks
The type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (AmazonSQS Control)
The name or IP address of the firewall (optional).
Syntax
amazonsqscontrol.FirewallHost[=string]
Default Value
""
Remarks
The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.
Data Type
String
FirewallPassword Property (AmazonSQS Control)
A password if authentication is to be used when connecting through the firewall.
Syntax
amazonsqscontrol.FirewallPassword[=string]
Default Value
""
Remarks
A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.
Data Type
String
FirewallPort Property (AmazonSQS Control)
The Transmission Control Protocol (TCP) port for the firewall Host .
Syntax
amazonsqscontrol.FirewallPort[=integer]
Default Value
0
Remarks
The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (AmazonSQS Control)
A username if authentication is to be used when connecting through a firewall.
Syntax
amazonsqscontrol.FirewallUser[=string]
Default Value
""
Remarks
A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.
Data Type
String
LocalHost Property (AmazonSQS Control)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
amazonsqscontrol.LocalHost[=string]
Default Value
""
Remarks
This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the control is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
MaxMessages Property (AmazonSQS Control)
The maximum number of messages retrieved from the queue.
Syntax
amazonsqscontrol.MaxMessages[=integer]
Default Value
1
Remarks
The maximum number of messages retrieved by ListMessages. This is not the number of messages that will be returned, but just the maximum number that will be returned.
Amazon's SQS service dictates that this parameter should be between 1 to 10, all other values are illegal.
Data Type
Integer
MessagesCount Property (AmazonSQS Control)
The number of records in the Messages arrays.
Syntax
amazonsqscontrol.MessagesCount
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at MessagesCount - 1.This property is read-only and not available at design time.
Data Type
Integer
MessagesBody Property (AmazonSQS Control)
The body of the SQS message.
Syntax
amazonsqscontrol.MessagesBody(MessagesIndex)
Default Value
""
Remarks
The body of the SQS message.
The MessagesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.
This property is read-only and not available at design time.
Data Type
String
MessagesId Property (AmazonSQS Control)
The ID of the SQS message.
Syntax
amazonsqscontrol.MessagesId(MessagesIndex)
Default Value
""
Remarks
The ID of the SQS message.
The MessagesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.
This property is read-only and not available at design time.
Data Type
String
MessagesMD5 Property (AmazonSQS Control)
The MD5 of the SQS message.
Syntax
amazonsqscontrol.MessagesMD5(MessagesIndex)
Default Value
""
Remarks
The MD5 of the SQS message.
The MessagesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.
This property is read-only and not available at design time.
Data Type
String
MessagesReceiptHandle Property (AmazonSQS Control)
The Receipt handle of the SQS message.
Syntax
amazonsqscontrol.MessagesReceiptHandle(MessagesIndex)
Default Value
""
Remarks
The Receipt handle of the SQS message.
The MessagesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagesCount property.
This property is read-only and not available at design time.
Data Type
String
OtherHeaders Property (AmazonSQS Control)
Other headers as determined by the user (optional).
Syntax
amazonsqscontrol.OtherHeaders[=string]
Default Value
""
Remarks
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.
The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF (Chr$(13) & Chr$(10)) .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the control beyond what is provided.
This property is not available at design time.
Data Type
String
ProxyAuthScheme Property (AmazonSQS Control)
The type of authorization to perform when connecting to the proxy.
Syntax
amazonsqscontrol.ProxyAuthScheme[=integer]
Possible Values
authBasic(0), authDigest(1), authProprietary(2), authNone(3), authNtlm(4), authNegotiate(5)
Default Value
0
Remarks
The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the control will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.
If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (AmazonSQS Control)
Whether to automatically detect and use proxy system settings, if available.
Syntax
amazonsqscontrol.ProxyAutoDetect[=boolean]
Default Value
False
Remarks
Whether to automatically detect and use proxy system settings, if available. The default value is .
Data Type
Boolean
ProxyPassword Property (AmazonSQS Control)
A password if authentication is to be used for the proxy.
Syntax
amazonsqscontrol.ProxyPassword[=string]
Default Value
""
Remarks
A password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (AmazonSQS Control)
The Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
amazonsqscontrol.ProxyPort[=integer]
Default Value
80
Remarks
The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (AmazonSQS Control)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
amazonsqscontrol.ProxyServer[=string]
Default Value
""
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (AmazonSQS Control)
When to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
amazonsqscontrol.ProxySSL[=integer]
Possible Values
psAutomatic(0), psAlways(1), psNever(2), psTunnel(3)
Default Value
0
Remarks
When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the control will use the psTunnel option. If the URL is an http URL, the control 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. |
Data Type
Integer
ProxyUser Property (AmazonSQS Control)
A username if authentication is to be used for the proxy.
Syntax
amazonsqscontrol.ProxyUser[=string]
Default Value
""
Remarks
A username if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
QueuePrefix Property (AmazonSQS Control)
QueuePrefix can be used to filter the queues listed.
Syntax
amazonsqscontrol.QueuePrefix[=string]
Default Value
""
Remarks
Only the queues whose names start with the specified QueuePrefix are listed when ListQueues is called.
Data Type
String
QueuesCount Property (AmazonSQS Control)
The number of records in the Queues arrays.
Syntax
amazonsqscontrol.QueuesCount
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at QueuesCount - 1.This property is read-only and not available at design time.
Data Type
Integer
QueuesId Property (AmazonSQS Control)
The ID of the SQS queue.
Syntax
amazonsqscontrol.QueuesId(QueuesIndex)
Default Value
""
Remarks
The ID of the SQS queue.
The QueuesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueuesCount property.
This property is read-only and not available at design time.
Data Type
String
QueuesUrl Property (AmazonSQS Control)
The URL of the SQS queue.
Syntax
amazonsqscontrol.QueuesUrl(QueuesIndex)
Default Value
""
Remarks
The URL of the SQS queue.
The QueuesIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueuesCount property.
This property is read-only and not available at design time.
Data Type
String
Referer Property (AmazonSQS Control)
This property includes the referer URL/document (optional).
Syntax
amazonsqscontrol.Referer[=string]
Default Value
""
Remarks
If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.
This property is not available at design time.
Data Type
String
SecretKey Property (AmazonSQS Control)
The Secret Access Key for the Amazon Web Services account.
Syntax
amazonsqscontrol.SecretKey[=string]
Default Value
""
Remarks
This property describes the secret key to the Amazon account. It should not be shared with others. The SecretKey is used along with the AccessKey in the authentication process with Amazon servers.
Data Type
String
SSLAcceptServerCertEffectiveDate Property (AmazonSQS Control)
The date on which this certificate becomes valid.
Syntax
amazonsqscontrol.SSLAcceptServerCertEffectiveDate
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExpirationDate Property (AmazonSQS Control)
The date on which the certificate expires.
Syntax
amazonsqscontrol.SSLAcceptServerCertExpirationDate
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExtendedKeyUsage Property (AmazonSQS Control)
A comma-delimited list of extended key usage identifiers.
Syntax
amazonsqscontrol.SSLAcceptServerCertExtendedKeyUsage
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprint Property (AmazonSQS Control)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
amazonsqscontrol.SSLAcceptServerCertFingerprint
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA1 Property (AmazonSQS Control)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
amazonsqscontrol.SSLAcceptServerCertFingerprintSHA1
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA256 Property (AmazonSQS Control)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
amazonsqscontrol.SSLAcceptServerCertFingerprintSHA256
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLAcceptServerCertIssuer Property (AmazonSQS Control)
The issuer of the certificate.
Syntax
amazonsqscontrol.SSLAcceptServerCertIssuer
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKey Property (AmazonSQS Control)
The private key of the certificate (if available).
Syntax
amazonsqscontrol.SSLAcceptServerCertPrivateKey
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKeyAvailable Property (AmazonSQS Control)
Whether a PrivateKey is available for the selected certificate.
Syntax
amazonsqscontrol.SSLAcceptServerCertPrivateKeyAvailable
Default Value
False
Remarks
Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLAcceptServerCertPrivateKeyContainer Property (AmazonSQS Control)
The name of the PrivateKey container for the certificate (if available).
Syntax
amazonsqscontrol.SSLAcceptServerCertPrivateKeyContainer
Default Value
""
Remarks
The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKey Property (AmazonSQS Control)
The public key of the certificate.
Syntax
amazonsqscontrol.SSLAcceptServerCertPublicKey
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyAlgorithm Property (AmazonSQS Control)
The textual description of the certificate's public key algorithm.
Syntax
amazonsqscontrol.SSLAcceptServerCertPublicKeyAlgorithm
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyLength Property (AmazonSQS Control)
The length of the certificate's public key (in bits).
Syntax
amazonsqscontrol.SSLAcceptServerCertPublicKeyLength
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertSerialNumber Property (AmazonSQS Control)
The serial number of the certificate encoded as a string.
Syntax
amazonsqscontrol.SSLAcceptServerCertSerialNumber
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLAcceptServerCertSignatureAlgorithm Property (AmazonSQS Control)
The text description of the certificate's signature algorithm.
Syntax
amazonsqscontrol.SSLAcceptServerCertSignatureAlgorithm
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLAcceptServerCertStore Property (AmazonSQS Control)
The name of the certificate store for the client certificate.
Syntax
amazonsqscontrol.SSLAcceptServerCertStore[=string]
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.
SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
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).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.
Data Type
Binary String
SSLAcceptServerCertStorePassword Property (AmazonSQS Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
amazonsqscontrol.SSLAcceptServerCertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLAcceptServerCertStoreType Property (AmazonSQS Control)
The type of certificate store for this certificate.
Syntax
amazonsqscontrol.SSLAcceptServerCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
The type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
Data Type
Integer
SSLAcceptServerCertSubjectAltNames Property (AmazonSQS Control)
Comma-separated lists of alternative subject names for the certificate.
Syntax
amazonsqscontrol.SSLAcceptServerCertSubjectAltNames
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintMD5 Property (AmazonSQS Control)
The MD5 hash of the certificate.
Syntax
amazonsqscontrol.SSLAcceptServerCertThumbprintMD5
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA1 Property (AmazonSQS Control)
The SHA-1 hash of the certificate.
Syntax
amazonsqscontrol.SSLAcceptServerCertThumbprintSHA1
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA256 Property (AmazonSQS Control)
The SHA-256 hash of the certificate.
Syntax
amazonsqscontrol.SSLAcceptServerCertThumbprintSHA256
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsage Property (AmazonSQS Control)
The text description of UsageFlags .
Syntax
amazonsqscontrol.SSLAcceptServerCertUsage
Default Value
""
Remarks
The text description of SSLAcceptServerCertUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsageFlags Property (AmazonSQS Control)
The flags that show intended use for the certificate.
Syntax
amazonsqscontrol.SSLAcceptServerCertUsageFlags
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:
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 SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertVersion Property (AmazonSQS Control)
The certificate's version number.
Syntax
amazonsqscontrol.SSLAcceptServerCertVersion
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLAcceptServerCertSubject Property (AmazonSQS Control)
The subject of the certificate used for client authentication.
Syntax
amazonsqscontrol.SSLAcceptServerCertSubject[=string]
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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.
Data Type
String
SSLAcceptServerCertEncoded Property (AmazonSQS Control)
The certificate (PEM/Base64 encoded).
Syntax
amazonsqscontrol.SSLAcceptServerCertEncoded[=string]
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSLCertEffectiveDate Property (AmazonSQS Control)
The date on which this certificate becomes valid.
Syntax
amazonsqscontrol.SSLCertEffectiveDate
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLCertExpirationDate Property (AmazonSQS Control)
The date on which the certificate expires.
Syntax
amazonsqscontrol.SSLCertExpirationDate
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLCertExtendedKeyUsage Property (AmazonSQS Control)
A comma-delimited list of extended key usage identifiers.
Syntax
amazonsqscontrol.SSLCertExtendedKeyUsage
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLCertFingerprint Property (AmazonSQS Control)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
amazonsqscontrol.SSLCertFingerprint
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLCertFingerprintSHA1 Property (AmazonSQS Control)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
amazonsqscontrol.SSLCertFingerprintSHA1
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLCertFingerprintSHA256 Property (AmazonSQS Control)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
amazonsqscontrol.SSLCertFingerprintSHA256
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLCertIssuer Property (AmazonSQS Control)
The issuer of the certificate.
Syntax
amazonsqscontrol.SSLCertIssuer
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLCertPrivateKey Property (AmazonSQS Control)
The private key of the certificate (if available).
Syntax
amazonsqscontrol.SSLCertPrivateKey
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (AmazonSQS Control)
Whether a PrivateKey is available for the selected certificate.
Syntax
amazonsqscontrol.SSLCertPrivateKeyAvailable
Default Value
False
Remarks
Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (AmazonSQS Control)
The name of the PrivateKey container for the certificate (if available).
Syntax
amazonsqscontrol.SSLCertPrivateKeyContainer
Default Value
""
Remarks
The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (AmazonSQS Control)
The public key of the certificate.
Syntax
amazonsqscontrol.SSLCertPublicKey
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLCertPublicKeyAlgorithm Property (AmazonSQS Control)
The textual description of the certificate's public key algorithm.
Syntax
amazonsqscontrol.SSLCertPublicKeyAlgorithm
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertPublicKeyLength Property (AmazonSQS Control)
The length of the certificate's public key (in bits).
Syntax
amazonsqscontrol.SSLCertPublicKeyLength
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLCertSerialNumber Property (AmazonSQS Control)
The serial number of the certificate encoded as a string.
Syntax
amazonsqscontrol.SSLCertSerialNumber
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLCertSignatureAlgorithm Property (AmazonSQS Control)
The text description of the certificate's signature algorithm.
Syntax
amazonsqscontrol.SSLCertSignatureAlgorithm
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertStore Property (AmazonSQS Control)
The name of the certificate store for the client certificate.
Syntax
amazonsqscontrol.SSLCertStore[=string]
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
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).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.
Data Type
Binary String
SSLCertStorePassword Property (AmazonSQS Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
amazonsqscontrol.SSLCertStorePassword[=string]
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (AmazonSQS Control)
The type of certificate store for this certificate.
Syntax
amazonsqscontrol.SSLCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
The type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
Data Type
Integer
SSLCertSubjectAltNames Property (AmazonSQS Control)
Comma-separated lists of alternative subject names for the certificate.
Syntax
amazonsqscontrol.SSLCertSubjectAltNames
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (AmazonSQS Control)
The MD5 hash of the certificate.
Syntax
amazonsqscontrol.SSLCertThumbprintMD5
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA1 Property (AmazonSQS Control)
The SHA-1 hash of the certificate.
Syntax
amazonsqscontrol.SSLCertThumbprintSHA1
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA256 Property (AmazonSQS Control)
The SHA-256 hash of the certificate.
Syntax
amazonsqscontrol.SSLCertThumbprintSHA256
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertUsage Property (AmazonSQS Control)
The text description of UsageFlags .
Syntax
amazonsqscontrol.SSLCertUsage
Default Value
""
Remarks
The text description of SSLCertUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLCertUsageFlags Property (AmazonSQS Control)
The flags that show intended use for the certificate.
Syntax
amazonsqscontrol.SSLCertUsageFlags
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:
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 SSLCertUsage property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (AmazonSQS Control)
The certificate's version number.
Syntax
amazonsqscontrol.SSLCertVersion
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLCertSubject Property (AmazonSQS Control)
The subject of the certificate used for client authentication.
Syntax
amazonsqscontrol.SSLCertSubject[=string]
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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.
Data Type
String
SSLCertEncoded Property (AmazonSQS Control)
The certificate (PEM/Base64 encoded).
Syntax
amazonsqscontrol.SSLCertEncoded[=string]
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSLProvider Property (AmazonSQS Control)
The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
amazonsqscontrol.SSLProvider[=integer]
Possible Values
sslpAutomatic(0), sslpPlatform(1), sslpInternal(2)
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.
When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.
Data Type
Integer
SSLServerCertEffectiveDate Property (AmazonSQS Control)
The date on which this certificate becomes valid.
Syntax
amazonsqscontrol.SSLServerCertEffectiveDate
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLServerCertExpirationDate Property (AmazonSQS Control)
The date on which the certificate expires.
Syntax
amazonsqscontrol.SSLServerCertExpirationDate
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLServerCertExtendedKeyUsage Property (AmazonSQS Control)
A comma-delimited list of extended key usage identifiers.
Syntax
amazonsqscontrol.SSLServerCertExtendedKeyUsage
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLServerCertFingerprint Property (AmazonSQS Control)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
amazonsqscontrol.SSLServerCertFingerprint
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA1 Property (AmazonSQS Control)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
amazonsqscontrol.SSLServerCertFingerprintSHA1
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA256 Property (AmazonSQS Control)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
amazonsqscontrol.SSLServerCertFingerprintSHA256
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLServerCertIssuer Property (AmazonSQS Control)
The issuer of the certificate.
Syntax
amazonsqscontrol.SSLServerCertIssuer
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLServerCertPrivateKey Property (AmazonSQS Control)
The private key of the certificate (if available).
Syntax
amazonsqscontrol.SSLServerCertPrivateKey
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLServerCertPrivateKeyAvailable Property (AmazonSQS Control)
Whether a PrivateKey is available for the selected certificate.
Syntax
amazonsqscontrol.SSLServerCertPrivateKeyAvailable
Default Value
False
Remarks
Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLServerCertPrivateKeyContainer Property (AmazonSQS Control)
The name of the PrivateKey container for the certificate (if available).
Syntax
amazonsqscontrol.SSLServerCertPrivateKeyContainer
Default Value
""
Remarks
The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLServerCertPublicKey Property (AmazonSQS Control)
The public key of the certificate.
Syntax
amazonsqscontrol.SSLServerCertPublicKey
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyAlgorithm Property (AmazonSQS Control)
The textual description of the certificate's public key algorithm.
Syntax
amazonsqscontrol.SSLServerCertPublicKeyAlgorithm
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyLength Property (AmazonSQS Control)
The length of the certificate's public key (in bits).
Syntax
amazonsqscontrol.SSLServerCertPublicKeyLength
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLServerCertSerialNumber Property (AmazonSQS Control)
The serial number of the certificate encoded as a string.
Syntax
amazonsqscontrol.SSLServerCertSerialNumber
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLServerCertSignatureAlgorithm Property (AmazonSQS Control)
The text description of the certificate's signature algorithm.
Syntax
amazonsqscontrol.SSLServerCertSignatureAlgorithm
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLServerCertStore Property (AmazonSQS Control)
The name of the certificate store for the client certificate.
Syntax
amazonsqscontrol.SSLServerCertStore
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.
SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
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).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.
This property is read-only.
Data Type
Binary String
SSLServerCertStorePassword Property (AmazonSQS Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
amazonsqscontrol.SSLServerCertStorePassword
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
This property is read-only.
Data Type
String
SSLServerCertStoreType Property (AmazonSQS Control)
The type of certificate store for this certificate.
Syntax
amazonsqscontrol.SSLServerCertStoreType
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
The type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLServerCertStore and set SSLServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
This property is read-only.
Data Type
Integer
SSLServerCertSubjectAltNames Property (AmazonSQS Control)
Comma-separated lists of alternative subject names for the certificate.
Syntax
amazonsqscontrol.SSLServerCertSubjectAltNames
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLServerCertThumbprintMD5 Property (AmazonSQS Control)
The MD5 hash of the certificate.
Syntax
amazonsqscontrol.SSLServerCertThumbprintMD5
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA1 Property (AmazonSQS Control)
The SHA-1 hash of the certificate.
Syntax
amazonsqscontrol.SSLServerCertThumbprintSHA1
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA256 Property (AmazonSQS Control)
The SHA-256 hash of the certificate.
Syntax
amazonsqscontrol.SSLServerCertThumbprintSHA256
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertUsage Property (AmazonSQS Control)
The text description of UsageFlags .
Syntax
amazonsqscontrol.SSLServerCertUsage
Default Value
""
Remarks
The text description of SSLServerCertUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLServerCertUsageFlags Property (AmazonSQS Control)
The flags that show intended use for the certificate.
Syntax
amazonsqscontrol.SSLServerCertUsageFlags
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:
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 SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLServerCertVersion Property (AmazonSQS Control)
The certificate's version number.
Syntax
amazonsqscontrol.SSLServerCertVersion
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLServerCertSubject Property (AmazonSQS Control)
The subject of the certificate used for client authentication.
Syntax
amazonsqscontrol.SSLServerCertSubject
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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.
This property is read-only.
Data Type
String
SSLServerCertEncoded Property (AmazonSQS Control)
The certificate (PEM/Base64 encoded).
Syntax
amazonsqscontrol.SSLServerCertEncoded
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.
This property is read-only and not available at design time.
Data Type
Binary String
StatusLine Property (AmazonSQS Control)
This property is the first line of the last server response.
Syntax
amazonsqscontrol.StatusLine
Default Value
""
Remarks
This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the control, the error string is the same as the StatusLine property.
The HTTP protocol specifies the structure of the StatusLine as follows: [HTTP version] [Result Code] [Description].
This property is read-only and not available at design time.
Data Type
String
Timeout Property (AmazonSQS Control)
The timeout for the control.
Syntax
amazonsqscontrol.Timeout[=integer]
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.
The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.
If Timeout expires, and the operation is not yet complete, the control fails with an error.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
UseSSL Property (AmazonSQS Control)
Use SSL when accessing the service.
Syntax
amazonsqscontrol.UseSSL[=boolean]
Default Value
True
Remarks
Use this property to specify whether the control should use SSL when connecting to the service.
This property is not available at design time.
Data Type
Boolean
VisibilityTimeout Property (AmazonSQS Control)
The visibility duration for messages in the queue.
Syntax
amazonsqscontrol.VisibilityTimeout[=integer]
Default Value
-1
Remarks
Visibility timeout is used to guard against multiple delivery. Successive calls to ListMessages on a queue will not return any message again until the timeout expires, after which the message may reappear unless deleted with DeleteMessage.
A default visibility timeout is configured when a queue is created using CreateQueue, it can also be altered when a message is added using CreateMessage or when they are retrieved using ListMessages.
The default value for VisibilityTimeout is -1, which notifies the component that you would like to use the default behavior for the current Queue.
Note: Unlike messages received from standard queues, messages received from FIFO queues can only be deleted within their VisibilityTimeout. Attempting to call DeleteMessage for a message received from a FIFO queue after its VisibilityTimeout has expired will cause the server to return an error. Keep this in mind when picking a VisibilityTimeout value to create a FIFO queue and/or retrieve messages with.
Data Type
Integer
AddPermission Method (AmazonSQS Control)
Adds a permission to a queue for a specific account, which allows for sharing access to the queue.
Syntax
amazonsqscontrol.AddPermission QueueId, UserLabel, AmazonAccount, PermissionName
Remarks
This method adds a permission to the queue specified by QueueId for the user account specified by AmazonAccount. UserLabel is the unique identification of the permission you're granting, and is used when deleting the permission via the RemovePermission method. The current list of values you may pass in the PermissionName parameter are listed below:
- SendMessage
- ReceiveMessage
- DeleteMessage
- ChangeMessageVisibility
- GetQueueAttributes
Note that when you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue.
AddPermission writes an SQS-generated policy. If you want to write your own policy, use SetQueueAttribute to upload your policy.
This method returns the RequestId contained in the Amazon response.
ChangeMessageVisibility Method (AmazonSQS Control)
Changes the visibility timeout of a message.
Syntax
amazonsqscontrol.ChangeMessageVisibility QueueId, ReceiptHandle, VisiblityTimeout
Remarks
Changes the visibility of the message specified by ReceiptHandle in the queue specified by QueueId. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours.
This method returns the RequestId contained in the Amazon response.
Config Method (AmazonSQS Control)
Sets or retrieves a configuration setting.
Syntax
amazonsqscontrol.Config ConfigurationString
Remarks
Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
CreateMessage Method (AmazonSQS Control)
Adds a message to a queue.
Syntax
amazonsqscontrol.CreateMessage QueueId, Message
Remarks
Adds a message to the queue specified. If VisibilityTimeout is specified it is updated for all the messages in the queue.
CreateMessage returns a message id assigned to the message that is added to a queue. This can then be used to ListMessages or DeleteMessage.
Note: When adding a message to a FIFO queue, the MessageGroupId configuration setting must be populated before calling this method.
CreateQueue Method (AmazonSQS Control)
Creates an SQS queue.
Syntax
amazonsqscontrol.CreateQueue QueueName
Remarks
A queue with the specified name is created.
CreateQueue returns a queue id assigned to the queue. This can then be used to CreateMessage or DeleteQueue.
If the QueueName ends with .fifo, the queue will be created as a FIFO queue. Alternatively, if the UseFIFOQueues configuration setting is enabled, the control will always attempt to create FIFO queues, appending .fifo to the given QueueName if necessary (all FIFO queues' names must have that suffix).
DeleteMessage Method (AmazonSQS Control)
Deletes the message specified.
Syntax
amazonsqscontrol.DeleteMessage QueueId, ReceiptHandle
Remarks
Deletes the message specified by ReceiptHandle from the queue specified by QueueId.
Note: Unlike messages received from standard queues, messages received from FIFO queues can only be deleted within their VisibilityTimeout. Attempting to call DeleteMessage for a message received from a FIFO queue after its VisibilityTimeout has expired will cause the server to return an error.
DeleteQueue Method (AmazonSQS Control)
Deletes a queue.
Syntax
amazonsqscontrol.DeleteQueue QueueId
Remarks
Deletes the queue specified by QueueId.
DoEvents Method (AmazonSQS Control)
This method processes events from the internal message queue.
Syntax
amazonsqscontrol.DoEvents
Remarks
When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.
GetQueueAttributes Method (AmazonSQS Control)
Returns all attributes of a queue.
Syntax
amazonsqscontrol.GetQueueAttributes QueueId
Remarks
This method retrieves all of the attributes of the queue specified by QueueId, and stores them in the Attributes collection. Queues currently have five attributes that may be returned:
- ApproximateNumberOfMessages
- VisibilityTimeout (for more information, see Visibility Timeout)
- CreatedTimestamp
- LastModifiedTimestamp
- Policy
This method returns the RequestId contained in the Amazon response.
GetXValue Method (AmazonSQS Control)
Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .
Syntax
amazonsqscontrol.GetXValue XPath
Remarks
This method allows a user to retrieve a valid XPath expression from the HTTP response after calling SendCustomRequest.
Interrupt Method (AmazonSQS Control)
This method interrupts the current method.
Syntax
amazonsqscontrol.Interrupt
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListMessages Method (AmazonSQS Control)
Gets messages from the queue.
Syntax
amazonsqscontrol.ListMessages QueueId
Remarks
This method retrieves messages from the queue specified by QueueId, and fires a Message event for each message it receives. The messages may also be accessed using the property Messages.
If VisibilityTimeout greater than -1 it is applied to the messages, otherwise the default timeout of the queue used. Only one message is retrieved by default; this behavior may be modified by changing MaxMessages.
Note: Unlike messages received from standard queues, messages received from FIFO queues can only be deleted within their VisibilityTimeout. Attempting to call DeleteMessage for a message received from a FIFO queue after its VisibilityTimeout has expired will cause the server to return an error.
ListQueues Method (AmazonSQS Control)
Lists the queues under the current account.
Syntax
amazonsqscontrol.ListQueues
Remarks
This method will fire a Queue event for each queue available for the Amazon SQS account specified by AccessKey. The listing may be filtered using QueuePrefix.
RemovePermission Method (AmazonSQS Control)
The RemovePermission action revokes any permissions in the queue policy that matches the UserLabel parameter.
Syntax
amazonsqscontrol.RemovePermission QueueId, UserLabel
Remarks
Note that only the owner of the queue may revoke previously added permissions.
This method returns the RequestId contained in the Amazon response.
Reset Method (AmazonSQS Control)
Resets request-related properties.
Syntax
amazonsqscontrol.Reset
Remarks
Calling this method will reset the component to the original state.
ResetHeaders Method (AmazonSQS Control)
Resets all HTTP headers, cookies, and LocalFile.
Syntax
amazonsqscontrol.ResetHeaders
Remarks
Resets all the HTTP headers as well as LocalFile to "" (empty string).
Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next one.
SendCustomRequest Method (AmazonSQS Control)
Allows the sending of a custom request to an Amazon web service.
Syntax
amazonsqscontrol.SendCustomRequest Url, RequestData, OtherHeaders
Remarks
Allows the sending of a custom request to the Amazon web service. The URL parameter describes the endpoint that is being targeted. The RequestData is set to any data required for the request. The OtherHeaders parameter is used to set any additional headers that should be set for the request.
SetQueueAttribute Method (AmazonSQS Control)
Sets an attribute of a queue.
Syntax
amazonsqscontrol.SetQueueAttribute QueueId, AttributeName, AttributeValue
Remarks
This method sets attributes of the queue specified by QueueId. When you change a queue's attributes, the change can take up to 60 seconds to propagate throughout the SQS system.
This method returns the RequestId contained in the Amazon response.
Connected Event (AmazonSQS Control)
Fired immediately after a connection completes (or fails).
Syntax
Sub amazonsqscontrol_Connected(StatusCode As Integer, Description As String)
Remarks
If the connection is made normally, StatusCode is 0 and Description is "OK".
If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.
Please refer to the Error Codes section for more information.
Disconnected Event (AmazonSQS Control)
Fired when a connection is closed.
Syntax
Sub amazonsqscontrol_Disconnected(StatusCode As Integer, Description As String)
Remarks
If the connection is broken normally, StatusCode is 0 and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.
Please refer to the Error Codes section for more information.
EndTransfer Event (AmazonSQS Control)
Fired when a document finishes transferring.
Syntax
Sub amazonsqscontrol_EndTransfer(Direction As Integer)
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 (AmazonSQS Control)
Fired when information is available about errors during data delivery.
Syntax
Sub amazonsqscontrol_Error(ErrorCode As Integer, Description As String)
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Header Event (AmazonSQS Control)
Fired every time a header line comes in.
Syntax
Sub amazonsqscontrol_Header(Field As String, Value As String)
Remarks
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
Message Event (AmazonSQS Control)
Fired for each message retrieved from the queue.
Syntax
Sub amazonsqscontrol_Message(MessageId As String, ReceiptHandle As String, MessageData As String, MD5 As String)
Remarks
When ListMessages is invoked the control fires Message for each message retrieved. The number of messages retrieved are specified using MaxMessages. OtherData is reserved for future use.
Queue Event (AmazonSQS Control)
Fired for each queue of the user.
Syntax
Sub amazonsqscontrol_Queue(QueueId As String, URL As String)
Remarks
When ListQueues is invoked the control fires Queue for each queue.
SSLServerAuthentication Event (AmazonSQS Control)
Fired after the server presents its certificate to the client.
Syntax
Sub amazonsqscontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (AmazonSQS Control)
Fired when secure connection progress messages are available.
Syntax
Sub amazonsqscontrol_SSLStatus(Message As String)
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (AmazonSQS Control)
Fired when a document starts transferring (after the headers).
Syntax
Sub amazonsqscontrol_StartTransfer(Direction As Integer)
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.
Status Event (AmazonSQS Control)
Fired when the HTTP status line is received from the server.
Syntax
Sub amazonsqscontrol_Status(HTTPVersion As String, StatusCode As Integer, Description As String)
Remarks
HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").
StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").
Transfer Event (AmazonSQS Control)
Fired while a document transfers (delivers document).
Syntax
Sub amazonsqscontrol_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String)
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Config Settings (AmazonSQS Control)
The control 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 control, access to these internal properties is provided through the Config method.AmazonSQS Config Settings
0 (default) | Sends GET requests using AWS query protocol. |
1 | Sends POST requests using AWS query protocol. |
2 | Sends POST requests using AWS JSON protocol. |
Amazon defines each version as the date it was released. An example is: "2009-07-15".
Possible values are:
- 0 (string - default)
- 1 (number)
- 2 (binary)
Valid array indices are from 0 to MessageAttributeCount - 1.
Valid array indices are from 0 to MessageAttributeCount - 1.
Valid array indices are from 0 to MessageAttributeCount - 1.
- Messages sent with identical message bodies that Amazon SQS must treat as unique.
- Messages sent with identical content but different message attributes that Amazon SQS must treat as unique.
- Messages sent with different content (for example, retry counts included in the message body) that Amazon SQS must treat as duplicates.
When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling PurgeQueue will be deleted; messages sent to the queue while it is being purged may be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue was called may be received, but will be deleted within the next minute.
The component will make an extra request invoking the AmazonSQS.GetQueueUrl method and use its response for the request that will require the Queue URL to be resolved.
sqs.Config("URL=https://myregion.custom-sqs-server.com");
sqs.ListMessages("MyQueue");
In order for the control 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" page in the Amazon IAM documentation for more information.
By default, this setting is empty. When populated with an IAM role name, the control will do the following before each request:
- Make a request against the EC2 instance to obtain temporary security credentials for the IAM role associated with the current instance profile.
- Parse the response, automatically populating the AccessKey and SecretKey properties.
- Execute the original request using the temporary security credentials that were acquired.
When enabled, the control will always append the .fifo suffix (if necessary) to the desired QueueName when CreateQueue is called. (Note that queue names can be no longer than 80 characters, including the .fifo suffix.)
HTTP Config Settings
When True, the control adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the control will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the control fails with an error if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP control can be extended with other security schemes in addition to the authorization schemes already implemented by the control.
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]".
The default value is False.
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 control 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 control fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.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 control 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 after calling a method. The 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.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is .
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).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (Chr$(13) & Chr$(10)) .
Use this 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 control beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.
When True (default), the control will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the 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 controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by controls that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This setting is provided for use by controls that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if 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 is a positive value, the system will attempt to send pending data until the specified 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 control 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.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.
If the control is connected, the LocalHost 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).
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.
If an EOL string is found in the input stream before 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 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 is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
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.
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.
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".
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.
If set to True, the control 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 control is the same.
-----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-----
When set to 0 (default), the CRL check will not be performed by the control. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the control will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
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 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 is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the control will pick all of the supported cipher suites. If 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 is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider 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
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 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), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
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 control will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider 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 and other similar SSL configuration settings are not supported.
- If 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 control when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the control 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 control will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
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.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
When specified the control 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 control fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
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.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider 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)
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"
- "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 ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
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)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Trappable Errors (AmazonSQS Control)
AmazonSQS Errors
20602 | An error returned from Amazon SQS. Please refer to the error message for explanation. |
The control may also return one of the following error codes, which are inherited from other controls.
HTTP Errors
20119 | Firewall error. The error description contains the detailed message. |
20144 | Busy executing current method. |
20152 | HTTP protocol error. The error message has the server response. |
20153 | No server specified in URL. |
20154 | Specified URLScheme is invalid. |
20156 | Range operation is not supported by server. |
20157 | Invalid cookie index (out of range). |
20302 | Interrupted. |
20303 | Cannot open AttachedFile. |
The control may also return one of the following error codes, which are inherited from other controls.
TCPClient Errors
20101 | You cannot change the RemotePort at this time. A connection is in progress. |
20102 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
20103 | The RemoteHost address is invalid (0.0.0.0). |
20105 | Already connected. If you want to reconnect, close the current connection first. |
20107 | You cannot change the LocalPort at this time. A connection is in progress. |
20108 | You cannot change the LocalHost at this time. A connection is in progress. |
20113 | You cannot change MaxLineLength at this time. A connection is in progress. |
20117 | RemotePort cannot be zero. Please specify a valid service port number. |
20118 | You cannot change the UseConnection option while the control is active. |
20136 | Operation would block. |
20202 | Timeout. |
20212 | Action impossible in control's present state. |
20213 | Action impossible while not connected. |
20214 | Action impossible while listening. |
20302 | Timeout. |
20303 | Could not open file. |
20435 | Unable to convert string to selected CodePage. |
21106 | Already connecting. If you want to reconnect, close the current connection first. |
21118 | You need to connect first. |
21120 | You cannot change the LocalHost at this time. A connection is in progress. |
21121 | Connection dropped by remote host. |
SSL Errors
20271 | Cannot load specified security library. |
20272 | Cannot open certificate store. |
20273 | Cannot find specified certificate. |
20274 | Cannot acquire security credentials. |
20275 | Cannot find certificate chain. |
20276 | Cannot verify certificate chain. |
20277 | Error during handshake. |
20281 | Error verifying certificate. |
20282 | Could not find client certificate. |
20283 | Could not find server certificate. |
20284 | Error encrypting data. |
20285 | Error decrypting data. |
TCP/IP Errors
25005 | [10004] Interrupted system call. |
25010 | [10009] Bad file number. |
25014 | [10013] Access denied. |
25015 | [10014] Bad address. |
25023 | [10022] Invalid argument. |
25025 | [10024] Too many open files. |
25036 | [10035] Operation would block. |
25037 | [10036] Operation now in progress. |
25038 | [10037] Operation already in progress. |
25039 | [10038] Socket operation on nonsocket. |
25040 | [10039] Destination address required. |
25041 | [10040] Message is too long. |
25042 | [10041] Protocol wrong type for socket. |
25043 | [10042] Bad protocol option. |
25044 | [10043] Protocol is not supported. |
25045 | [10044] Socket type is not supported. |
25046 | [10045] Operation is not supported on socket. |
25047 | [10046] Protocol family is not supported. |
25048 | [10047] Address family is not supported by protocol family. |
25049 | [10048] Address already in use. |
25050 | [10049] Cannot assign requested address. |
25051 | [10050] Network is down. |
25052 | [10051] Network is unreachable. |
25053 | [10052] Net dropped connection or reset. |
25054 | [10053] Software caused connection abort. |
25055 | [10054] Connection reset by peer. |
25056 | [10055] No buffer space available. |
25057 | [10056] Socket is already connected. |
25058 | [10057] Socket is not connected. |
25059 | [10058] Cannot send after socket shutdown. |
25060 | [10059] Too many references, cannot splice. |
25061 | [10060] Connection timed out. |
25062 | [10061] Connection refused. |
25063 | [10062] Too many levels of symbolic links. |
25064 | [10063] File name is too long. |
25065 | [10064] Host is down. |
25066 | [10065] No route to host. |
25067 | [10066] Directory is not empty |
25068 | [10067] Too many processes. |
25069 | [10068] Too many users. |
25070 | [10069] Disc Quota Exceeded. |
25071 | [10070] Stale NFS file handle. |
25072 | [10071] Too many levels of remote in path. |
25092 | [10091] Network subsystem is unavailable. |
25093 | [10092] WINSOCK DLL Version out of range. |
25094 | [10093] Winsock is not loaded yet. |
26002 | [11001] Host not found. |
26003 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
26004 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
26005 | [11004] Valid name, no data record (check DNS setup). |