AMQPClassic Task

An easy-to-use AMQP 0.9.1 client implementation, with support for RabbitMQ extensions.

Remarks

The AMQPClassic task provides an easy-to-use AMQP 0.9.1 client implementation, and it also supports certain RabbitMQ extensions to the AMQP 0.9.1 specification. The task supports both plaintext and TLS-enabled connections over TCP.

Connecting

The AMQP 0.9.1 transport protocol has two layers: an overall connection between the client and server, and one or more channels running over that connection.

AMQPClassic Send Task

At a minimum, you must supply an RemoteHost, RemotePort, and ChannelName for the connection. In order to authenticate with the AMQPClassic broker you will need to specify a User and Password. The AuthScheme property contains a preferential list of authentication methods to be enabled on the task.

Setting ChannelName will create a channel with the specified name on the broker. Once the task has connected to the server it is possible to manipulate exchanges and queues and publish messages.

The task will send the contents of the MessageBody property.

The AMQPClassic Sender and Receiver Tasks have support for SSL transport layer security. This may be enabled by setting SSLStartMode, SSLCert and SSLAcceptServerCert to appropriate values.

Declaring Exchanges

Set DeclareExchange to true to declare an exchange. ChannelName, ExchangeName, ExchangeType, ExchangeType, ExchangePassive, and ExchangeAutoDelete may also be set.

Declaring Queues

Set DeclareQueue to true to declare a queue. ChannelName, QueueName, QueuePassive, QueueDurable, QueueExclusive, and QueueAutoDelete may also be set.

Binding Queues to Exchanges

Set BindQueue to true to bind a exchange with specified RoutingKey.

Creating Consumers

The receiver task will use the Consumer properties to start a consumer for QueueName.

Sender Property List

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


AppId	The Id of the application that created the message.
AsynchronousMode	Indicates whether the server handles the request in asynchronous mode.
AuthScheme	The authentication scheme to use when connecting.
BindQueue	Bind the queue to the exchange with given RoutingKey.
ChannelName	The name of the channel the message is associated with.
ClientProperties	A collection of table fields that describe properties of the client.
ContentEncoding	The content encoding of the message's body.
ContentType	The content type (MIME type) of the message's body.
CorrelationId	The correlation Id of the message.
DeclareExchange	This is used to verify that an exchange named ExchangeName exists, and potentially creates it if no such exchange exists.
DeclareQueue	This is used to verify that a queue named QueueName exists; and potentially creates it if no such queue exists.
DeleteExchange	Specifies whether delete the exchange named ExchangeName.
DeleteQueue	Deletes a queue.
DeliveryMode	The delivery mode of the message.
ExchangeAutoDelete	This specifies whether the server should automatically delete the exchange when all queues have been unbound from it.
ExchangeDurable	This specifies what happens to the exchange in the event of a server restart.
ExchangeIfUnused	Specifies whether the server will delete the exchange if no queues are bound to it.
ExchangeName	The name of the exchange.
ExchangePassive	This specifies how the server will deal with a preexisting exchange.
ExchangeType	This specifies the exchange type.
Expiration	The time-to-live value for this message.
Firewall	A set of properties related to firewall access.
Headers	Headers associated with the message.
Immediate	Controls what the server should do if the message cannot be immediately delivered to any consumer.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
Mandatory	Controls what the server should do if a message cannot be routed to any queue.
MessageBody	The message body.
MessageId	The unique Id of the message.
MessageType	The message's type.
Other	Defines a set of configuration settings to be used by the component.
Password	A password to use for SASL authentication.
PersistentConnection	Instructs the component whether to keep the connection to the server open.
Priority	The priority of the message.
PublishConfirms	Enables publish confirmations mode for a channel.
QueueAutoDelete	This specifies whether the server should automatically delete the queue when all consumers have finished using it.
QueueDurable	Durable specifies what happens to the queue in the event of a server restart.
QueueExclusive	Exclusive , if True , indicates that the queue may only be accessed by the current connection.
QueueIfEmpty	Specifies whether to delete the queue when consumers are attached.
QueueIfUnused	Specifies whether to delete the queue when no messages are in it.
QueueName	The name of the queue.
QueuePassive	This specifies how the server will deal with a preexisting queue.
Recover	Requests the server to redeliver all messages on a given channel that have not been acknowledged.
RemoteHost	The address of the remote host. Domain names are resolved to IP addresses.
RemotePort	The port of the AQMP server (default is 5672). The default port for SSL is 5671.
ReplyTo	The address to send replies to for the message.
Requeue	This property controls how the server should attempt to redeliver the messages awaiting acknowledgement.
RoutingKey	The RoutingKey parameter specifies the binding's routing key.
RuntimeLicense	Specifies the component runtime license key.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAny	Tells the component to accept any server certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
SSLStartMode	Determines how the component starts the SSL negotiation.
Timeout	A timeout for the component.
Timestamp	The message's timestamp.
TransactionMode	Whether the channel is operating in Transaction mode.
UnBindQueue	Unbind the queue to the exchange with given RoutingKey.
User	A username to use for SASL authentication.
UserId	The identity of the user responsible for producing the message.
VirtualHost	The virtual host to connect to.

Config Settings

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


AckMessagesCount	The number of messages to accept before sending an ACK.
Global	The scope which the QoS request should apply to.
PrefetchCount	The number of unacknowledged messages the server will limit itself to sending.
PrefetchSize	The window size in bytes.
SetQoS	request a specific quality of service for a certain scope.
TransactionMaxCount	The max value of max transaction size.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlags	Flags that control certificate verification.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
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.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelay	Whether or not to delay when sending packets.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.

AppId Property (AMQPClassic Task)

The Id of the application that created the message.

Data Type

String

Default Value

Remarks

This field holds the Id of the application that created the message. It may be empty if the message does not have an application Id set.

This value must be specified as a string no longer than 255 characters.

AsynchronousMode Property (AMQPClassic Task)

Indicates whether the server handles the request in asynchronous mode.

Data Type

Boolean

Default Value

false

Remarks

If true, the server will execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.

AuthScheme Property (AMQPClassic Task)

The authentication scheme to use when connecting.

Data Type

Enumeration

Possible Values

None (0)
SASLAnonymous (1)
SASLPlain (2)

Default Value

Remarks

This property controls what authentication scheme the task should use when connecting to the remote host.

Valid values are:

smNone (0)
smSASLAnonymous (1) - Default
smSASLPlain (2)

BindQueue Property (AMQPClassic Task)

Bind the queue to the exchange with given RoutingKey.

Data Type

Boolean

Default Value

false

Remarks

When set, the task will bind to the exchange with specified RoutingKey.

ChannelName Property (AMQPClassic Task)

The name of the channel the message is associated with.

Data Type

String

Default Value

Remarks

This property is associated with the name of the channel the message was accessed or sent over.

ClientProperties Property (AMQPClassic Task)

A collection of table fields that describe properties of the client.

Data Type

String

Default Value

Remarks

This property holds a collection of table fields that represent client properties. During the connection process, these properties will be sent to the server.

Each line contains a AMQP table field. The table field structure should follow this pattern: "key, type(int), value".

Key must be an ASCII string that:

Starts with an ASCII letter, $, or $ character.
Only contains ASCII letters, digits, underscores, $, and $ characters.
Is unique among all sibling table field key names.
Is no longer than 128 characters.

Value is table field's value and must be formatted according to the type. Type is the table field's value type. Acceptable value types are:


Value Type	JSON Value Type	Description	Value Format
fvtBoolean (0)	`boolean`	Boolean	"True" or "False"
fvtByte (1)	`byte`	Byte	-128 to 127
fvtUbyte (2)	`ubyte`	Unsigned byte	0 to 255
fvtShort (3)	`short`	Short	-32768 to 32767
fvtUshort (4)	`ushort`	Unsigned short	0 to 65535
fvtInt (5)	`int`	Integer	-2147483648 to 2147483647
fvtUint (6)	`uint`	Unsigned integer	0 to 4294967295
fvtLong (7)	`long`	Long	-9223372036854775808 to 9223372036854775807
fvtUlong (8)	`ulong`	Unsigned long	0 to 18446744073709551615
fvtFloat (9)	`float`	Float	IEEE 754 32-bit floating point number
fvtDouble (10)	`double`	Double	IEEE 754 64-bit floating point number
fvtDecimal (11)	`decimal`	Decimal	Hex-encoded byte string
fvtSstring (12)	`sstring`	Short string	UTF-8 string data, limited to 255 bytes; may not contain null bytes (`\0`)
fvtString (13)	`string`	String	String data
fvtArray (14)	`array`	Array	JSON array of type-value pairs
fvtTimestamp (15)	`timestamp`	Timestamp	Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC)
fvtTable (16)	`table`	Table	JSON object containing name-type-value tuples
fvtNull (17 - default)	`null`	Null	N/A (Value is ignored)

For the fvtArray (14) value type, the Value should be specified as a JSON array of type-value pairs; for example: [ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ]

For the fvtTable (16) value type, theValue; should be specified as a JSON object containing name-type-value tuples; for example: { { "name": "Test1", "type": "long", "value": 12345678901234 }, { "name": "Test2", "type": "boolean", "value": "false" }, { "name": "Test3", "type": "string", "value": "This is a test." } }

Notes regarding fvtArray (14) and fvtTable (16) type Value:

All "type" fields in the JSON content must be set to one of the value types in the table above.
For fvtTable (16) type Value, all "name" fields must adhere to the rules described above by the Key documentation.
Nesting and mixing multiple levels of arrays and tables in the JSON is allowed.

While the task does not send any client properties by default, it is common for AMQP clients to send "product", "version", and "platform" properties to help identify themselves.

ConsumerExclusive Property (AMQPClassic Task)

Whether the consumer is exclusive.

Data Type

Boolean

Default Value

false

Remarks

The ConsumerExclusive property, if True, will cause the task to request that the server create an exclusive consumer. Attaching an exclusive consumer to a queue prevents any other consumers from consuming messages from that queue.

This property is not available in the Sender.

ConsumerNoAck Property (AMQPClassic Task)

Whether each message is acknowledged by the component.

Data Type

Boolean

Default Value

false

Remarks

The ConsumerNoAck property controls whether the server will expect the task to acknowledge each message delivered.

This property is not available in the Sender.

ConsumerNoLocal Property (AMQPClassic Task)

Whether the consumer will consume messages published on the same channel.

Data Type

Boolean

Default Value

false

Remarks

The ConsumerNoLocal property, if True, ensures that the consumer never consumes messages published on the same channel. (Note that this functionality is not available on RabbitMQ servers, which ignore the NoLocal parameter).

This property is not available in the Sender.

ConsumerTag Property (AMQPClassic Task)

The consumer tag used to uniquely identify a consumer on a channel.

Data Type

String

Default Value

Remarks

ConsumerTag is a string which uniquely identifies the new consumer on the specified channel. If empty string is passed for ConsumerTag, the server will generate a consumer tag automatically when it creates the consumer.

This property is not available in the Sender.

ContentEncoding Property (AMQPClassic Task)

The content encoding of the message's body.

Data Type

String

Default Value

Remarks

This field holds the content encoding of the message's body. It may be empty if the message does not have a content encoding set.

This value must be specified as a string no longer than 255 characters.

ContentType Property (AMQPClassic Task)

The content type (MIME type) of the message's body.

Data Type

String

Default Value

Remarks

This field holds the content type (MIME type) of the message's body. It may be empty if the message does not have a content type set.

This value must be specified as a string no longer than 255 characters.

CorrelationId Property (AMQPClassic Task)

The correlation Id of the message.

Data Type

String

Default Value

Remarks

This field holds the correlation Id of the message. It may be empty if the message does not have a correlation Id set.

This value must be specified as a string no longer than 255 characters.

DeclareExchange Property (AMQPClassic Task)

This is used to verify that an exchange named ExchangeName exists, and potentially creates it if no such exchange exists.

Data Type

Boolean

Default Value

false

Remarks

ChannelName, ExchangeName, ExchangeType, ExchangeType, ExchangePassive, and ExchangeAutoDelete may also be set.

ChannelName controls what channel the component will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that is not involved in message publishing or consumption.

ExchangeName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq. unless ExchangePassive is True.

ExchangeType specifies the exchange type. All servers support the direct and fanout exchange types, and most should also support the topic and header exchange types. Some servers may support additional, custom exchange types as well. Refer to your server's documentation for more information about each exchange type, and to determine what exchange types it supports other than direct and fanout.

If ExchangePassive is True, the server will only verify that an exchange with the given ExchangeName actually exists (regardless of how it is configured).

If ExchangePassive is False, and no exchange named ExchangeName currently exists, the server will create one.

If ExchangePassive is False, and there is a preexisting exchange named ExchangeName, the server will verify that its current configuration matches the given parameters and arguments.

ExchangeType specifies what happens to the exchange in the event of a server restart. Durable exchanges will be recreated, while non-durable (transient) exchanges will not.

ExchangeAutoDelete specifies whether the server should automatically delete the exchange when all queues have been unbound from it. Note that this parameter is only sent if the RabbitMQCompatible configuration setting is enabled; it is ignored otherwise.

DeclareQueue Property (AMQPClassic Task)

This is used to verify that a queue named QueueName exists; and potentially creates it if no such queue exists.

Data Type

Boolean

Default Value

false

Remarks

ChannelName, QueueName, QueuePassive, QueueDurable, QueueExclusive, and QueueAutoDelete may also be set.

If creating a new queue, empty string can be passed for QueueName to have the server automatically generate a name for the new queue (which can then be retrieved using the QueueName configuration setting). In all other cases, QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq. unless the Passive parameter is True.

If QueuePassive is True, the server will only verify that a queue with the given QueueName actually exists (regardless of how it is configured).

If QueuePassive is False, and no queue named QueueName currently exists, the server will create one.

If QueuePassive is False, and there is a preexisting queue named QueueName, the server will verify that its current configuration matches the given parameters and arguments.

QueueDurable specifies what happens to the queue in the event of a server restart. A durable queue will be recreated, while non-durable (transient) queue will not. (Note that the messages in durable queues will still be lost unless they are marked as persistent.)

QueueExclusive, if True, indicates that the queue may only be accessed by the current connection. Exclusive queues are deleted when the current connection closes.

QueueAutoDelete specifies whether the server should automatically delete the queue when all consumers have finished using it. (Note that auto-delete queues aren't eligible for deletion until after a consumer attaches to them for the first time.)

DeleteExchange Property (AMQPClassic Task)

Specifies whether delete the exchange named ExchangeName.

Data Type

Boolean

Default Value

false

Remarks

Set this property to true to delete the exchange named ExchangeName.

DeleteQueue Property (AMQPClassic Task)

Deletes a queue.

Data Type

Boolean

Default Value

false

Remarks

Set to true to delete the queue.

ChannelName, QueueName, QueueIfUnused, and QueueIfEmpty must also be set.

QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq.

When QueueIfUnused is True, the server will only delete the queue if no consumers are attached to it.

When QueueIfEmpty is True, the server will only delete the queue if it has no messages in it. (When QueueIfEmpty is False, servers will typically move any remaining messages to a dead-letter queue, if one is available.)

DeliveryMode Property (AMQPClassic Task)

The delivery mode of the message.

Data Type

Enumeration

Possible Values

Unspecified (0)
Nonpersistent (1)
Persistent (2)

Default Value

Remarks

This field holds the delivery mode of the message; possible values are:

0: Unspecified.
1: Non-persistent; the message may be lost if the server encounters an error.
2: Persistent; the message will not be lost, even in case of server errors.

The default is 0, which indicates that the message does not have an explicit delivery mode set.

ExchangeAutoDelete Property (AMQPClassic Task)

This specifies whether the server should automatically delete the exchange when all queues have been unbound from it.

Data Type

Boolean

Default Value

false

Remarks

Note that this parameter is only sent if the RabbitMQCompatible configuration setting is enabled; it is ignored otherwise.

ExchangeDurable Property (AMQPClassic Task)

This specifies what happens to the exchange in the event of a server restart.

Data Type

Boolean

Default Value

false

Remarks

Durable exchanges will be recreated, while non-durable (transient) exchanges will not.

ExchangeIfUnused Property (AMQPClassic Task)

Specifies whether the server will delete the exchange if no queues are bound to it.

Data Type

Boolean

Default Value

false

Remarks

When True, the server will only delete the exchange if no queues are bound to it.

ExchangeName Property (AMQPClassic Task)

The name of the exchange.

Data Type

String

Default Value

Remarks

ExchangePassive Property (AMQPClassic Task)

This specifies how the server will deal with a preexisting exchange.

Data Type

Boolean

Default Value

false

Remarks

If ExchangePassive is True, the server will only verify that an exchange with the given ExchangeName actually exists (regardless of how it is configured).

If ExchangePassive is False, and no exchange named ExchangeName currently exists, the server will create one.

If ExchangePassive is False, and there is a preexisting exchange named ExchangeName, the server will verify that its current configuration matches the given parameters and arguments.

ExchangeType Property (AMQPClassic Task)

This specifies the exchange type.

Data Type

Enumeration

Possible Values

Direct (0)
Fanout (1)
Topic (2)
Header (3)

Default Value

Remarks

ExchangeType specifies the exchange type. All servers support the direct and fanout exchange types, and most should also support the topic and header exchange types. Some servers may support additional, custom exchange types as well. Refer to your server's documentation for more information about each exchange type, and to determine what exchange types it supports other than direct and fanout.

Expiration Property (AMQPClassic Task)

The time-to-live value for this message.

Data Type

String

Default Value

Remarks

This property specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL.

Firewall Property (AMQPClassic Task)

A set of properties related to firewall access.

Data Type

Firewall

Remarks

This is a Firewall type property which contains fields describing the firewall through which the task will attempt to connect.

Headers Property (AMQPClassic Task)

Headers associated with the message.

Data Type

String

Default Value

Remarks

This property holds additional Headers associated with the message. It may be empty if the message does not have any headers set.

This property must be specified as a JSON object containing name-type-value tuples; for example: { { "name": "Header1", "type": "long", "value": 12345678901234 }, { "name": "Header2", "type": "boolean", "value": "false" }, { "name": "Header3", "type": "string", "value": "This is a test." } }

All "name" values must be ASCII strings that:

Start with an ASCII letter, $, or $ character.
Only contain ASCII letters, digits, underscores, $, and $ characters.
Are unique among their siblings.
Are no longer than 128 characters.

The following table describes all valid "type" values, and how to format the "value" field for each:


JSON Value Type	Description	Value Format
`boolean`	Boolean	"True" or "False"
`byte`	Byte	-128 to 127
`ubyte`	Unsigned byte	0 to 255
`short`	Short	-32768 to 32767
`ushort`	Unsigned short	0 to 65535
`int`	Integer	-2147483648 to 2147483647
`uint`	Unsigned integer	0 to 4294967295
`long`	Long	-9223372036854775808 to 9223372036854775807
`ulong`	Unsigned long	0 to 18446744073709551615
`float`	Float	IEEE 754 32-bit floating point number
`double`	Double	IEEE 754 64-bit floating point number
`decimal`	Decimal	Hex-encoded byte string
`sstring`	Short string	UTF-8 string data, limited to 255 bytes; may not contain null bytes (`\0`)
`string`	String	String data
`array`	Array	JSON array of type-value pairs
`timestamp`	Timestamp	Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC)
`table`	Table	JSON object containing name-type-value tuples
`null`	Null	N/A (Value is ignored)

Note: The ulong and sstring value types are not supported when the RabbitMQCompatible configuration setting is enabled.

Headers of the table type should be specified in the same manner as shown above, while headers of the array type should be specified as a JSON array of type-value pairs; for example: [ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ]

Nesting and mixing multiple levels of arrays and tables is allowed.

Immediate Property (AMQPClassic Task)

Controls what the server should do if the message cannot be immediately delivered to any consumer.

Data Type

Boolean

Default Value

false

Remarks

The Immediate property controls what the server should do if the message can't be immediately delivered to any consumer (either because it cannot be routed to a queue, or because the queues it can be routed to have no active consumers attached to them).

If True, the server will return the message. If False, the server will queue the message if possible, or drop it if not.

This property is not available in the Receiver.

LogFile Property (AMQPClassic Task)

The file to write logging information to at runtime.

Data Type

String

Default Value

Remarks

To write logging information to a file instead of using the task's logging API, set this property to a valid file on disk.

When set, any logging information is appended to the specified file and not written to the task's logging API.

LogMode Property (AMQPClassic Task)

What information gets logged during component execution.

Data Type

Enumeration

Possible Values

Verbose (0)
Info (1)
Warning (2)
Error (3)
Fatal (4)

Default Value

Remarks

This property controls what information the task logs. The possible values have the following affect on the task's behavior:


Verbose	The task will report all information regarding the transport.
Info	The task will report all major operations, as well as all warnings and errors.
Warning	The task will report any conditions that could result in unpredictable behavior as well as errors.
Error	The task will report all errors that prevent normal operations from completing.
Fatal	The task will report only serious errors that cause the task to completely stop functioning.

Mandatory Property (AMQPClassic Task)

Controls what the server should do if a message cannot be routed to any queue.

Data Type

Boolean

Default Value

false

Remarks

The Mandatory property controls what the server should do if the message can't be routed to any queue (either because it isn't eligible for any of the queues bound to the specified exchange because of how their bindings are configured, or because no queues are bound to the exchange in the first place). If True, the server will return the message. If False, the server will drop the message.

This property is not available in the Receiver.

MessageBody Property (AMQPClassic Task)

The message body.

Data Type

String

Default Value

Remarks

This property holds the body of the message. It may be empty.

This property is not available in the Receiver.

MessageId Property (AMQPClassic Task)

The unique Id of the message.

Data Type

String

Default Value

Remarks

This field holds the unique Id of the message. It may be empty if the message does not have a unique Id.

This value must be specified as a string no longer than 255 characters.

MessageType Property (AMQPClassic Task)

The message's type.

Data Type

String

Default Value

Remarks

This property holds the type of the message. It may be empty if the message does not have a type set.

This value must be specified as a string no longer than 255 characters.

Other Property (AMQPClassic Task)

Defines a set of configuration settings to be used by the component.

Data Type

String

Default Value

Remarks

The task accepts one or more 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 task, access to these internal properties is provided through the Other property.

The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line. For example: configname1=value1 configname2=value2

Password Property (AMQPClassic Task)

A password to use for SASL authentication.

Data Type

Password

Default Value

Remarks

This property contains a password to use for SASL authentication.

PersistentConnection Property (AMQPClassic Task)

Instructs the component whether to keep the connection to the server open.

Data Type

Boolean

Default Value

false

Remarks

If set to true, the task will first attempt to use an existing connection. If no such connection exists, it will create a new connection. When the task completes, it will persist the connection so that the task will reuse it during the next polling interval. Setting this property to true can improve performance if you are polling very frequently.

Set the Logoff configuration to tell the task to logoff from the persisted connection after completion.

Priority Property (AMQPClassic Task)

The priority of the message.

Data Type

Integer

Default Value

Remarks

This property holds the priority of the message. Valid priority values are 0-9; any other value causes the message to have unspecified priority when sent.

PublishConfirms Property (AMQPClassic Task)

Enables publish confirmations mode for a channel.

Data Type

Boolean

Default Value

false

Remarks

If true, the channel specified by ChannelName will have publish confirmations mode enabled. While a channel is in publish confirmations mode, the server will acknowledge each message published by the component.

Note that a channel will stay in publish confirmations mode, once enabled, until it is deleted.

This property is not available in the Receiver.

QueueAutoDelete Property (AMQPClassic Task)

This specifies whether the server should automatically delete the queue when all consumers have finished using it.

Data Type

Boolean

Default Value

false

Remarks

Note that auto-delete queues aren't eligible for deletion until after a consumer attaches to them for the first time.

QueueDurable Property (AMQPClassic Task)

Durable specifies what happens to the queue in the event of a server restart.

Data Type

Boolean

Default Value

false

Remarks

A durable queue will be recreated, while a non-durable (transient) queue will not. (Note that the messages in durable queues will still be lost unless they are marked as persistent).

QueueExclusive Property (AMQPClassic Task)

Exclusive , if True , indicates that the queue may only be accessed by the current connection.

Data Type

Boolean

Default Value

false

Remarks

Exclusive queues are deleted when the current connection closes.

QueueIfEmpty Property (AMQPClassic Task)

Specifies whether to delete the queue when consumers are attached.

Data Type

Boolean

Default Value

false

Remarks

When True, the server will only delete the queue if no consumers are attached to it.

QueueIfUnused Property (AMQPClassic Task)

Specifies whether to delete the queue when no messages are in it.

Data Type

Boolean

Default Value

false

Remarks

When True, the server will only delete the queue if it has no messages in it. (When QueueIfEmpty is False, servers will typically move any remaining messages to a dead-letter queue, if one is available.)

QueueName Property (AMQPClassic Task)

The name of the queue.

Data Type

String

Default Value

Remarks

QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. This value must be specified as a string no longer than 255 characters.

QueuePassive Property (AMQPClassic Task)

This specifies how the server will deal with a preexisting queue.

Data Type

Boolean

Default Value

false

Remarks

If QueuePassive is True, the server will only verify that a queue with the given QueueName actually exists (regardless of how it is configured).

If QueuePassive is False, and no queue named QueueName currently exists, the server will create one.

If QueuePassive is False, and there is a preexisting queue named QueueName, the server will verify that its current configuration matches the given parameters and arguments.

Recover Property (AMQPClassic Task)

Requests the server to redeliver all messages on a given channel that have not been acknowledged.

Data Type

Boolean

Default Value

false

Remarks

Set this property to true to request that the server redeliver all messages that it previously sent to the component on the channel specified by ChannelName which are still awaiting acknowledgement.

This property is not available in the Receiver.

RemoteHost Property (AMQPClassic Task)

The address of the remote host. Domain names are resolved to IP addresses.

Data Type

String

Default Value

Remarks

This property specifies the IP address (IP number in dotted internet format) or Domain Name of the remote host. If this property is set to a Domain Name, a DNS request is initiated, and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned. If the component is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

RemotePort Property (AMQPClassic Task)

The port of the AQMP server (default is 5672). The default port for SSL is 5671.

Data Type

Integer

Default Value

5672

Remarks

This property specifies a service port on the remote host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

ReplyTo Property (AMQPClassic Task)

The address to send replies to for the message.

Data Type

String

Default Value

Remarks

This property specifies the address to send replies to for the message. It may be empty if the message does not have a specific reply-to address set.

This value must be specified as a string no longer than 255 characters.

Requeue Property (AMQPClassic Task)

This property controls how the server should attempt to redeliver the messages awaiting acknowledgement.

Data Type

Boolean

Default Value

false

Remarks

If set to True, the server will simple put the messages back on their original queues, and they will be delivered like any other queued messages (potentially to other consumers). If set to False, the server will redeliver the messages to the component directly.

RoutingKey Property (AMQPClassic Task)

The RoutingKey parameter specifies the binding's routing key.

Data Type

String

Default Value

Remarks

Exchanges that use routing-key-based logic make some sort of comparison between the routing keys of incoming messages and this value to decide which messages should be forwarded to the specified queue. Examples of exchange types which use routing keys include:

direct exchanges, which compare (for equality) the routing keys of incoming messages to the routing keys of each queue bound to them.
topic exchanges, which match the routing keys of incoming messages against the routing pattern of each queue bound to them.

Not all exchange types make use of routing keys, in which case empty string can be passed for the RoutingKey parameter. Examples of exchange types which don't use routing keys include:

fanout exchanges simply forward incoming messages to all queues bound to them, unconditionally.
header exchanges only forward messages that include certain headers. When binding a queue to a header exchange, add items to the to describe the headers that eligible messages must have, and whether they must have any or all of those headers.

Note that the format of the RoutingKey parameter and/or the content of the may differ slightly between server implementations. Refer to your server's documentation to determine what it expects to receive for each exchange type that it supports.

RuntimeLicense Property (AMQPClassic Task)

Specifies the component runtime license key.

Data Type

String

Default Value

Remarks

You can use the RuntimeLicense property to set the runtime key for the task license.

SSLAcceptServerCert Property (AMQPClassic Task)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Data Type

Certificate

Remarks

If it finds any issues with the certificate presented by the server, the task will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

This property is used to set a Public Key Certificate.

Ordinarily, the system will attempt to locate the public key in trusted certificate stores in the system registry. If a match is found, the certificate is trusted, and the process proceeds without error. If the certificate is not trusted, the task will report an error.

You may explicitly set a public key, either to accept a key that is not installed on the system, or to ensure that a specific key is presented. Public key certificates may be loaded from the machine registry or from file. If you click on the ellipses, a certificate selection dialog will open. To select a public key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of available certificates will be shown below.

Alternatively, you may specify a public key on file. Select the PEM or Certificate File tabs to load a public key from file. You can use the browse button to examine the file system for the certificate that you wish to use. Public keys typically are stored in .CER, .DER, or .PEM files, but other formats may be used. You can click on the Open button to examine the contents of the certificate. Or, if you have a certificate stored in memory, you can write the contents of the certificate into the text box provided. Note that if you are loading a certificate from memory, the certificate must be Base-64 encoded, or the string representation of the certificate may become corrupted and uninterpretable.

Regardless of how you selected the certificate, once you hit the OK button, the task will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the task was not able to verify the selection, a dialog box will appear instead detailing the verification error.

Note: You may also set SSLAcceptServerCertAcceptAny to True without opening the certificate selection dialog to force the task to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes.

SSLAcceptServerCertAcceptAny Property (AMQPClassic Task)

Tells the component to accept any server certificate.

Data Type

Boolean

Default Value

false

Remarks

When set to true, the task will unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes.

SSLCert Property (AMQPClassic Task)

The certificate to use for client authentication during the SSL handshake.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for SSL client authentication.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format. If you click on the ellipses, a certificate selection dialog will open. To select a private key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of certificates which have private keys will be shown below.

To select a private key certificate from a file in PKCS#12 format, select the PFX Store tab. The browse button can be used to examine the file system for PKCS#12 (.pfx or .p12) certificates. If you wish to examine the certificate, provide the password in the field provided and click on the Open button to examine the file store for certificates present. To load a certificate from PEM files, select the PEM tab. Like the PFX file selection, you can specify the password and click the Open button to examine the certificates in the PEM store, or you may paste any PEM data stored in memory.

SSLStartMode Property (AMQPClassic Task)

Determines how the component starts the SSL negotiation.

Data Type

Enumeration

Possible Values

Automatic (0)
Implicit (1)
Explicit (2)
None (3)

Default Value

Remarks

The SSLStartMode property may have one of the following values:


Automatic	If the remote port is set to the standard plaintext port of the protocol (where applicable), the task will behave the same as if SSLStartMode is set to Explicit. In all other cases, SSL negotiation will be implicit (Implicit).
Implicit	The SSL negotiation will start immediately after the connection is established.
Explicit	The task will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
None	No SSL negotiation, no SSL security. All communication will be in plaintext mode.

Timeout Property (AMQPClassic Task)

A timeout for the component.

Data Type

Integer

Default Value

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 task will wait for the operation to complete before returning control.

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

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the task may be changed to absolute timeouts, i.e. the task will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

The default value for the Timeout property is 60 (seconds).

Timestamp Property (AMQPClassic Task)

The message's timestamp.

Data Type

String

Default Value

"0"

Remarks

This property holds the timestamp of the message, specified as milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). It may be less than or equal to 0 (default) if the message does not have a timestamp set.

TransactionMode Property (AMQPClassic Task)

Whether the channel is operating in Transaction mode.

Data Type

Boolean

Default Value

false

Remarks

If set to true, the channel will operate in transaction mode. While a channel is in transaction mode, all messages published and acknowledgements sent over it will be part of a transaction, and the server will wait to process them until the transaction is either committed or rolled back.

By default this is false and channels will operate in normal mode.

This property is not available in the Receiver.

UnBindQueue Property (AMQPClassic Task)

Unbind the queue to the exchange with given RoutingKey.

Data Type

Boolean

Default Value

false

Remarks

When set to true, the task will unbind the queue to the exchange with specified RoutingKey.

User Property (AMQPClassic Task)

A username to use for SASL authentication.

Data Type

String

Default Value

Remarks

This property contains a username to use for SASL authentication.

UserId Property (AMQPClassic Task)

The identity of the user responsible for producing the message.

Data Type

String

Default Value

Remarks

This property specifies the identity of the user responsible for producing the message. It may be empty if no specific user was responsible for creating the message.

A message's user Id may be used for verification or authentication by the server and/or the final consumer.

This value must be specified as a string no longer than 255 characters.

VirtualHost Property (AMQPClassic Task)

The virtual host to connect to.

Data Type

String

Default Value

"/"

Remarks

This property specifies the virtual host to connect to on the server, and is set to / by default.

Note that the configuration of the server defines what virtual hosts are available.

This setting cannot be changed while connected.

Certificate Type

The digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Store
String

The name of the certificate store for the client certificate.

The StoreType field specifies the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field in order to specify client certificates. If Store has a value, and Subject is set, a search for a certificate is initiated. Please refer to the Subject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of 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.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file.

StorePassword
String

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

StoreType
CertStoreTypes

The type of certificate store for this certificate.

The task supports both public and private keys in a variety of formats. When the cstAuto value is used the task will automatically determine the type. This field 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 (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface. To use a security key the necessary data must first be collected using the CERTMGR task. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 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 Store and set StorePassword to the PIN. Code Example: SSH Authentication with Security Key `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Subject
String

The subject of the certificate used for client authentication.

When this property is set, a search is performed in the current certificate store certificate with matching subject.

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

When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

Control.CertSubject = "Test"

If a match is 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.

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

Thumbprint
String (read-only)

The thumbprint of the certificate.

This field is used to specify the thumbprint of the certificate. When there are multiple certificates in the store that have the same subject, the thumbprint will be used to distinguish between them.

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall such as the firewall Host and the FirewallType.

Fields

AutoDetect
Boolean

Tells the task whether or not to automatically detect and use firewall system settings, if available.

FirewallType
FirewallTypes

Determines the type of firewall to connect through. The applicable values are the following:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.

Host
String

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

If the Host field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the Host field is set to the corresponding address. If the search is not successful, an error is returned.

Password
String

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

Port
Integer

The TCP port for the firewall Host. See the description of the Host field for details.

Note that the Port is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
String

A user name if authentication is to be used connecting through a firewall. If the Host is specified, the User and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, a trappable error is fired.

Config Settings (AMQPClassic Task)

The task 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 task, access to these internal properties is provided through the Other property.

AMQPClassic Config Settings

AckMessagesCount: The number of messages to accept before sending an ACK.

When this configuration setting is set to a value greater than one, the task will accept messages without acknowledging them until the count has been reached, at which point it will send a bulk acknowledgement for all the messages.

Global: The scope which the QoS request should apply to.

It is interpreted differently based on whether the server is RabbitMQ or not. Refer to this table:


Global is...	RabbitMQ	Other Servers
False	QoS will be applied individually to each new consumer on the specified channel (existing consumers are unaffected).	QoS applied to all existing and new consumers on the specified channel.
True	QoS applied to all existing and new consumers on the specified channel.	QoS applied to all existing and new consumers on the whole connection.

PrefetchCount: The number of unacknowledged messages the server will limit itself to sending.

A PrefetchCount of 0 indicates no limit.

PrefetchSize: The window size in bytes.

The server will stop sending messages if the total size of all of the currently unacknowledged messages already sent, plus the size of the next message that could be sent, exceeds PrefetchSize bytes. A PrefetchSize of 0 indicates no limit. (Note that RabbitMQ does not support prefetch size limits.)

SetQoS: request a specific quality of service for a certain scope.

When the PrefetchSize and/or PrefetchCount are set for a certain scope, the server will limit how many messages it sends to the task before stopping to wait for or or more of them to be acknowledged.Keep the following things in mind when using QoS:

The limits specified by a QoS request only affect messages that require acknowledgement.
How the server chooses to handle interactions between QoS settings at different scopes is server-dependent.

TransactionMaxCount: The max value of max transaction size.

This config will only take effect when TrasactionMode is on.

SSL Config Settings

ReuseSSLSession: Determines if the SSL session is reused.

If set to true, the task 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 task is the same.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the task 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 UseInternalSecurityAPI is False (default): // The "Other" property could contain ONE of the following lines: SSLEnabledCipherSuites=* SSLEnabledCipherSuites=CALG_AES_256 SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES Possible values when UseInternalSecurityAPI is False (default) include:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when UseInternalSecurityAPI is True:

// The "Other" property could contain ONE of the following lines:
SSLEnabledCipherSuites=*
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA

Possible values when UseInternalSecurityAPI is True include:

TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

If SSLEnabledProtocols is configured to use TLS 1.3 the following values are supported:

TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:


TLS1.3	12288 (Hex 3000) (Experimental)
TLS1.2	3072 (Hex C00) (Default)
TLS1.1	768 (Hex 300) (Default)
TLS1	192 (Hex C0) (Default)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the transport log contains the full certificate chain. By default this value is False and only the leaf certificate will be present.

If set to True all certificates returned by the server will be present in the transport log. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When UseInternalSecurityAPI is set to True this value is automatically set to True. This is needed for proper validation when using the internal provider.

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown Certificate Authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown Certificate Authority revocation status.
0x00000800	Ignore unknown Root revocation status.
0x00008000	Allow test Root certificate.
0x00004000	Trust test Root certificate.
0x80000000	Ignore non-matching CN (certificate CN not-matching server name).

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.

This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is True and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the task will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the task will fail with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: // The "Other" could contain ALL of these lines: UseInternalSecurityAPI=true SSLEnabledProtocols=3072 TLS12SignatureAlgorithms=sha1-rsa,sha1-dsa,sha256-rsa,sha256-dsa The default value for this setting is "sha1-rsa,sha1-dsa,sha224-rsa,sha224-dsa,sha256-rsa,sha256-dsa,sha384-rsa,sha384-dsa,sha512-rsa,sha512-dsa".

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)

The default value is rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

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)

General Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

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

The LocalHost configuration contains the name of the local host as obtained by the Gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the task initiate connections (or accept in the case of server tasks) only through that interface.

If the task is connected, the LocalHost configuration 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).

TcpNoDelay: Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseInternalSecurityAPI: Tells the task whether or not to use the system security libraries or an internal implementation.

When set to False, the task will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to True.

Setting this setting to True tells the task to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

If using the .NET Standard Library, this setting will be True on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all tasks used in the application.

When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file.