XMPP Connector

The XMPP Component adds instant messaging functionality to your MuleSoft.

Remarks

eXtensible Messaging and Presence Protocol is a highly extensible instant message service based on XML packets. The XMPP Connector is a lightweight XMPP instant messaging client which enables you to send instant messages to any XMPP client within your service's network.

XMPP Send Connector

At a minimum, you must supply an IMServer, IMPort for the connection and a ToJID for the intended recipient of the message. In order to authenticate with the XMPP server you will need to specify a User and Password. The AuthMethods property contains a preferential list of authentication methods to be enabled on the connector.

The connector will send the contents of the MessageText property as the instant message body. The connector also supports sending HTML in the message body via the MessageHTML property.

A simple text message in the MessageText property can alternatively be treated as HTML via the TreatMessageAsHTML configuration setting. Also, when sending to clients that may not support reading HTML entities, ParseHTML can be set to cause the connector to parse an HTML entity into the simple text body of the instant message.

The XMPP Send Connector has support for SSL transport layer security. This may be enabled by setting SSLStartMode, SSLCert and SSLAcceptServerCert to appropriate values.

Send Example

Add an XMPP Send Connector to your flow and configure the connection settings to get started. To send a message, either provide a message in the MessageText or MessageHTML properties or optionally add a File Read connector immediately in front of the XMPP Send Connector. There is no need to transform the File Read output before passing it to the connector. That is all that is required to send a message.

Receiver Property List

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


AuthMethods	Controls how the component authenticates itself with the XMPP server.
Chatroom	The name of the chatroom to join.
ChatroomNickname	The nickname to be used within the chatroom.
ChatroomPassword	The password for the chatroom specified in the Chatroom configuration option.
Firewall	A set of properties related to firewall access.
FromJID	The ID of the user that sent the message.
IMPort	The server port for XMPP (default 5222).
IMServer	This is the instant messaging server.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
LogType	How information gets logged during component execution.
MessageOtherData	This property contains extra data for the current message.
MessageReceivedTime	The timestamp for when an offline message was received.
MessageSubject	This is the subject of the current message.
MessageThread	This is the thread name of the current message.
Other	Defines a set of configuration settings to be used by the component.
Password	This is the user's password.
PersistentConnection	Instructs the component whether to keep the connection to the server open.
Resource	This is the resource for the current session.
RuntimeLicense	Specifies the component runtime license key.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied 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.
ToJID	A semicolon-separated list of destination nodes to receive the current message.
User	The user portion of this entity's Jabber ID.

Sender Property List

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


AuthMethods	Controls how the component authenticates itself with the XMPP server.
Chatroom	The name of the chatroom to join.
ChatroomNickname	The nickname to be used within the chatroom.
ChatroomPassword	The password for the chatroom specified in the Chatroom configuration option.
Firewall	A set of properties related to firewall access.
IMPort	The server port for XMPP (default 5222).
IMServer	This is the instant messaging server.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
LogType	How information gets logged during component execution.
MessageHTML	This is the HTML version of the current message.
MessageOtherData	This property contains extra data for the current message.
MessageSubject	This is the subject of the current message.
MessageText	This is the plain text of the current message.
MessageThread	This is the thread name of the current message.
MessageType	This is the type of the current message.
Other	Defines a set of configuration settings to be used by the component.
Password	This is the user's password.
PersistentConnection	Instructs the component whether to keep the connection to the server open.
Resource	This is the resource for the current session.
RuntimeLicense	Specifies the component runtime license key.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied 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.
ToJID	A semicolon-separated list of destination nodes to receive the current message.
User	The user portion of this entity's Jabber ID.

Config Settings

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


AuthDomain	The domain under which the user must authenticate.
DateTimeFormat	The DateTime format for the MessageReceivedTime message context property.
ParseHTML	Tells the component to parse MessageHTML into a plaintext representation.
ServerDomain	This is the domain of the XMPP service.
TreatMessageAsHTML	Tells the component to treat the message contents as HTML.
UserDomain	The domain under which the user has registered with the XMPP service.
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.

AuthMethods Property (XMPP Connector)

Controls how the component authenticates itself with the XMPP server.

Data Type

String

Default Value

"*"

Remarks

AuthMethods is a comma-separated list of authentication methods to be enabled on the connector, listed in order of preference. When authenticating, the connector will pick the first method in the list that is supported by the server.

The special value * (default) may be supplied to cause the connector to enable all supported authentication methods in order of presumed security. The XMPP connector currently supports the following values for AuthMethods, listed in order of most secure to least secure:

SASL/DIGEST-MD5
AuthIQ/Digest
SASL/CRAM-MD5
SASL/PLAIN
AuthIQ/Plaintext
SASL/NTLM

Chatroom Property (XMPP Connector)

The name of the chatroom to join.

Data Type

String

Default Value

Remarks

When this property is set the XMPP connector will join the specified chatroom upon connection.

ChatroomNickname Property (XMPP Connector)

The nickname to be used within the chatroom.

Data Type

String

Default Value

Remarks

If the Chatroom allows you to set a different nickname from your JabberID, you can specify the nickname to be used in this property.

ChatroomPassword Property (XMPP Connector)

The password for the chatroom specified in the Chatroom configuration option.

Data Type

Password

Default Value

Remarks

If the Chatroom is configured to require a password for joining, the password should be specified in this property.

Firewall Property (XMPP Connector)

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 connector will attempt to connect.

FromJID Property (XMPP Connector)

The ID of the user that sent the message.

Data Type

String

Default Value

Remarks

FromJID should contain a Jabber ID in the form "User@Domain/Resource".

This property is not available in the Sender.

IMPort Property (XMPP Connector)

The server port for XMPP (default 5222).

Data Type

Integer

Default Value

5222

Remarks

A valid port number (a value between 1 and 65535) is required for the connection to take place. For an implicit SSL connection, use port 5223 (please refer to the SSLStartMode property for more information).

IMServer Property (XMPP Connector)

This is the instant messaging server.

Data Type

String

Default Value

Remarks

This is the instant messaging server to which the connector will connect. The IMServer property must contain a valid XMPP (Jabber) server, or any attempt to connect to the server will fail.

LogFile Property (XMPP Connector)

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 connector's logging API, set this property to a valid file on disk and set the LogType property to "File".

LogMode Property (XMPP Connector)

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 connector logs. The possible values have the following affect on the connector's behavior:


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

LogType Property (XMPP Connector)

How information gets logged during component execution.

Data Type

Enumeration

Possible Values

None (0)
Console (1)
File (2)

Default Value

Remarks

This property controls where the connector will log the information. The possible values have the following affect on the connector's behavior:


None	The connector will not report any logging information.
Console	The connector will report all logging information to the console.
File	The connector will report all logging information to a file. The desired file must be specified in the LogFile when this type has been selected.

MessageHTML Property (XMPP Connector)

This is the HTML version of the current message.

Data Type

String

Default Value

Remarks

If the user wishes to send an HTML entity as a part of the message, it must be set in the MessageHTML property. The HTML must be an entire HTML document, including the <html> and <body> tags.

If TreatMessageAsHTML is set to True, and MessageHTML is not set, the contents of the message will be treated as the HTML entity. If ParseHTML is set to True, the HTML entity will be parsed and its textual contents sent in the <body> element. This behavior will be overridden if any value is found in MessageText.

Note: if the HTML entity does not conform to a strict XML structure (e.g., has unbalanced tags), the XMPP connector will fail with an error.

This property is not available in the Receiver.

MessageOtherData Property (XMPP Connector)

This property contains extra data for the current message.

Data Type

String

Default Value

Remarks

In the receiver, MessageOtherData will contain any extra data associated with the message but not defined by the XMPP-IM protocol.

In the transmitter, any data specified in MessageOtherData will be sent in the XMPP-IM request as additional data following the BODY segment.

MessageReceivedTime Property (XMPP Connector)

The timestamp for when an offline message was received.

Data Type

String

Default Value

Remarks

If the XMPP server delivers a message that was received while the XMPP account was offline, MessageReceivedTime will contain the timestamp from the server indicating when the message was originally received.

This property is not available in the Sender.

MessageSubject Property (XMPP Connector)

This is the subject of the current message.

Data Type

String

Default Value

Remarks

MessageSubject will contain any subject associated with the message. Most Jabber clients will ignore the subject unless the MessageType is set to "Headline".

MessageText Property (XMPP Connector)

This is the plain text of the current message.

Data Type

String

Default Value

Remarks

MessageText is the plain text version of the current message, contained in the message XML's "body" child element. The text in this property is automatically escaped to ensure valid XML parsing by the recipient.

By default, the contents of the current message are sent in the <body/> element of the XMPP instant message. If MessageText contains a value, it will be used in place of the message contents. However, this behavior can be controlled by TreatMessageAsHTML, which will treat the message contents as an HTML entity.

This property is not available in the Receiver.

MessageThread Property (XMPP Connector)

This is the thread name of the current message.

Data Type

String

Default Value

Remarks

MessageThread will contain the name of the thread associated with the message. Threads are useful for tracking messages where the MessageType is "Chat" or "Group Chat".

This property is only available at runtime by reading it from the context of a message generated by the connector.

MessageType Property (XMPP Connector)

This is the type of the current message.

Data Type

Enumeration

Possible Values

Normal (0)
Chat (1)
Group Chat (2)
Headline (3)
Error (4)

Default Value

Remarks

MessageType is the type of the message as specified in the XMPP RFC. The possible values are defined in the protocol specification as follows:


Normal	A single message.
Chat	A message sent in the context of two-way chat between two entities.
Group Chat	A message sent in the context of multi-user chat among multiple entities.
Headline	A message that represents one of a list of items (e.g., in a news feed or information ticker).
Error	A message returned to a sender specifying an error associated with a previous message sent by the sender to an intended recipient.

This property is not available in the Receiver.

Other Property (XMPP Connector)

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

Data Type

String

Default Value

Remarks

The connector 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 connector, 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 (XMPP Connector)

This is the user's password.

Data Type

Password

Default Value

Remarks

This must be set before a connection is attempted.

PersistentConnection Property (XMPP Connector)

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

Data Type

Boolean

Default Value

false

Remarks

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

Resource Property (XMPP Connector)

This is the resource for the current session.

Data Type

String

Default Value

"IP*Works! XMPP Agent"

Remarks

Whenever an entity logs in to an XMPP (Jabber) server, it must provide account information as well as a resource. Resources allow multiple clients to log in using the same account. The server will forward all messages and PI data aimed at a specific resource to that resource. If a command or message is to be sent to a Jabber ID with no specified resource, the server will push that command or message out to all connected resources.

RuntimeLicense Property (XMPP Connector)

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 connector license.

SSLAcceptServerCert Property (XMPP Connector)

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 connector 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 connector 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.

Note: You may also set the Accept Any field to Yes without opening the certificate selection dialog to force the connector to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes. Set the LogMode to Info to cause the connector to report the server's credentials to Location.

SSLCert Property (XMPP Connector)

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.

SSLStartMode Property (XMPP Connector)

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 connector 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 connector 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 (XMPP Connector)

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

If Timeout expires, and the operation is not yet complete, the connector 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 connector may be changed to absolute timeouts, i.e. the connector 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).

ToJID Property (XMPP Connector)

A semicolon-separated list of destination nodes to receive the current message.

Data Type

String

Default Value

Remarks

ToJID should contain a semicolon-separated list of complete Jabber IDs in the form "User@Domain/Resource".

User Property (XMPP Connector)

The user portion of this entity's Jabber ID.

Data Type

String

Default Value

Remarks

The User property is a unique username associated with this entity and set at time of registration under the field "user".

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
Default Value: "MY"

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
Default Value: ""

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
Default Value: 0

The type of certificate store for this certificate.

The connector supports both public and private keys in a variety of formats. When the cstAuto value is used the connector 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 connector. 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
Default Value: ""

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)
Default Value: ""

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
Default Value: False

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

FirewallType
FirewallTypes
Default Value: 0

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
Default Value: ""

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
Default Value: ""

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
Default Value: 0

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
Default Value: ""

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 (XMPP Connector)

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

XMPP Config Settings

AuthDomain: The domain under which the user must authenticate.

This is the domain under which the current XMPP User must authenticate when logging onto the IMServer. It should be set if the domain is different than UserDomain or ServerDomain.

DateTimeFormat: The DateTime format for the MessageReceivedTime message context property.

This option is used to control the DateTime format of the "MessageReceivedTime" context property for a received message. This property can be set to any valid DateTime format. Valid formats are available at:

http://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx

http://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx

Default is the "Sortable" format (yyyy-MM-ddTHH:mm:ss).

ParseHTML: Tells the connector to parse MessageHTML into a plaintext representation.

If ParseHTML is set to True, MessageHTML will be parsed and its textual contents sent in the <body> element. This behavior will be overridden if any value is found in MessageText.

ServerDomain: This is the domain of the XMPP service.

This is the domain under which the XMPP service operates. This should be set if the service domain is different than the host address or DNS name supplied in IMServer.

TreatMessageAsHTML: Tells the connector to treat the message contents as HTML.

If TreatMessageAsHTML is set to True, and MessageHTML is not set, the contents of the message will be treated as an HTML entity. If ParseHTML is set to True, the HTML entity will be parsed and its textual contents sent in the <body> element. This behavior will be overridden if any value is found in MessageText.

UserDomain: The domain under which the user has registered with the XMPP service.

This is the domain under which the current XMPP User has register with the XMPP service. This should be set if the User's registration domain was different from the server domain.

SSL Config Settings

ReuseSSLSession: Determines if the SSL session is reused.

If set to true, the connector 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 connector 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 connector 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 connector 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 connector 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 connector initiate connections (or accept in the case of server connectors) only through that interface.

If the connector 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 connector whether or not to use the system security libraries or an internal implementation.

When set to False, the connector will use the system security libraries by default to perform cryptographic functions where applicable.

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

This setting is set to False by default on all platforms.