SSH Adapter

The SSH Component enables your BizTalk Server to execute remote commands over SSH.

Remarks

The SSH Adapter uses the SSH "exec" subsystem to remotely execute commands from your BizTalk Server.

SSH Send Adapter

The SSH Send Adapter provides an ultra light-weight remote command execution client for your BizTalk Server. You must first set an SSHHost. If the SSH server requires authentication, you should set the necessary SSHUser, and either SSHPassword or SSHCert depending on the SSHAuthMode you wish to use. Once the SSH server information is set, you must enter the Command you wish to execute.

Whenever called from the BizTalk Message Engine, the adapter will execute the given command. If the outbound message has any data, that data will supplied to the executing command's standard input.

Once the command has finished executing, the adapter will write the output from the command's standard out pipe to the CommandStdOut property in the message context. It will also write the command's exit code to the CommandExitStatus property, and any data from the standard err pipe to the CommandErrorMessage property in the message context.

Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.

Sender Property List

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


Command	The command to be sent to the remote host.
CommandErrorMessage	The error message, if any, returned by the server after command execution.
CommandExitStatus	The exit code for the executed command for the current message.
CommandSSHUser	The SSH user name used by the component when executing the command.
CommandStdErr	The standard error output of the executed Command .
CommandStdOut	The standard output of the executed Command .
ConnectionLifetime	Instructs the component whether or not to leave the connection to the server open.
FailOnError	Controls how the component treats error codes returned by command execution.
Firewall	A set of properties related to firewall access.
MaxPersistentConnections	The maximum number of simultaneous persistent connections when sending.
MaxThreads	The maximum number of threads that the component may consume.
MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch.
Other	Defines a set of configuration settings to be used by the component.
RuntimeLicense	Specifies the component runtime license key.
SSHAcceptServerHostKey	Instructs the component to accept the server host key that matches the supplied key.
SSHAuthMode	The type of authentication used by the component.
SSHCert	The certificate to use for client authentication during the SSH handshake.
SSHCompressionAlgorithms	A comma-separated list of compression algorithms allowed for this connection.
SSHHost	The address of the SSH host.
SSHPassword	The password for SSH password-based authentication.
SSHPort	The port on the SSH server where the SSH service is running; by default, 22.
SSHUser	The username for SSH authentication.
SSOAffiliate	Specifies the name of the SSO Affiliate Application.
Timeout	A timeout for the component.
TransmitBatchMode	How the transmitter processes batches.
TransportLog	Tells the component where and how to report information about its operations.
URI	The Uniform Resource Identifier (URI) of the send port or receive location.

Config Settings

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


KeyRenegotiationThreshold	Sets the threshold for the SSH Key Renegotiation.
LogSSHPackets	If True, detailed SSH packet logging is performed.
SSHAcceptServerHostKeyFingerPrint	Instructs the component to accept the server's host key with this fingerprint.
SSHEncryptionAlgorithms	A comma-separated list containing all allowable compression algorithms.
SSHKeyExchangeAlgorithms	Specifies the supported key exchange algorithms.
SSHMacAlgorithms	Specifies the supported Mac algorithms.
SSHPublicKeyAlgorithms	Specifies the supported public key algorithms for the server's public key.
UseStrictKeyExchange	Specifies how strict key exchange is supported.
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.

SSH Transmitter

Setting the SSH Adapter Configuration Properties for a Dynamic Send Port

A dynamic send port does not provide any transport configuration options in BizTalk Explorer because it is expected that these properties will be provided with the context properties associated with the message. These properties can be set in a custom pipeline or in an orchestration. To set message configuration properties in an orchestration you can do the following:

Add a Construct Message shape to your orchestration.
Configure the Construct Message shape to construct a new message. (for example Message_2)
Add a Message Assignment shape to the Construct Message shape.
Add code to the Message Assignment shape to initialize the message that you constructed and to set the appropriate configuration properties for the message.

Configuring the SSH Send Port with the BizTalk Server Administration Console

To configure the send port by using the BizTalk Server Administration console, use the following procedure:

To configure variables for a SSH send port:

In the BizTalk Server Administration console, create a new send port or double-click an existing send port to modify it. For more information, see How to Create a Send Port. Configure all of the send port options and specify nsoftware.SSH 2022 for the Type option in the Transport section of the General tab.
On the General tab, in the Transport section, click the Configure button next to Type.

In the nsoftware.SSH 2022 Transport Properties dialog box, use the following properties to:


Command	The command to be sent to the remote host. Type: xs:string Default Value: "" NOTE: This property must be specified.
CommandErrorMessage	The error message, if any, returned by the server after command execution. Type: xs:string Default Value: ""
CommandExitStatus	The exit code for the executed command for the current message. Type: xs:int Default Value: 0
CommandSSHUser	The SSH user name used by the component when executing the command. Type: xs:string Default Value: ""
CommandStdErr	The standard error output of the executed Command . Type: xs:string Default Value: ""
CommandStdOut	The standard output of the executed Command . Type: xs:string Default Value: ""
ConnectionLifetime	Instructs the component whether or not to leave the connection to the server open. Type: xs:int Default Value: 0
FailOnError	Controls how the component treats error codes returned by command execution. Type: bool Default Value: true
Firewall	A set of properties related to firewall access. Type: Firewall Default Value: null
MaxPersistentConnections	The maximum number of simultaneous persistent connections when sending. Type: xs:int Default Value: 1
MaxThreads	The maximum number of threads that the component may consume. Type: xs:int Default Value: 20
MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch. Type: xs:int Default Value: 1
Other	Defines a set of configuration settings to be used by the component. Type: xs:string Default Value: ""
RuntimeLicense	Specifies the component runtime license key. Type: xs:string Default Value: ""
SSHAcceptServerHostKey	Instructs the component to accept the server host key that matches the supplied key. Type: Certificate Default Value: null
SSHAuthMode	The type of authentication used by the component. Type: xs:int Default Value: 2
SSHCert	The certificate to use for client authentication during the SSH handshake. Type: Certificate Default Value: null NOTE: The digital id must have a private key associated with it.
SSHCompressionAlgorithms	A comma-separated list of compression algorithms allowed for this connection. Type: xs:string Default Value: "none"
SSHHost	The address of the SSH host. Type: xs:string Default Value: "" NOTE: This property must be specified.
SSHPassword	The password for SSH password-based authentication. Type: baf:Password Default Value: ""
SSHPort	The port on the SSH server where the SSH service is running; by default, 22. Type: xs:int Default Value: 22
SSHUser	The username for SSH authentication. Type: xs:string Default Value: ""
SSOAffiliate	Specifies the name of the SSO Affiliate Application. Type: baf:SSOList Default Value: ""
Timeout	A timeout for the component. Type: xs:int Default Value: 60
TransmitBatchMode	How the transmitter processes batches. Type: xs:int Default Value: 0
TransportLog	Tells the component where and how to report information about its operations. Type: Log Default Value: null
URI	The Uniform Resource Identifier (URI) of the send port or receive location. Type: xs:string Default Value: ""

Click OK and OK again to save settings.

Command Property (SSH Adapter)

The command to be sent to the remote host.

Data Type

String

Default Value

Remarks

Assigning a UNIX command to this property makes the adapter attempt to connect to the SSHHost and execute the command under the user's default shell. There is no need to append an end-of-line character to the command. All output from the remote application will be returned to the adapter.

Note: the adapter will terminate the connection once the remote application has finished executing.

CommandErrorMessage Property (SSH Adapter)

The error message, if any, returned by the server after command execution.

Data Type

String

Default Value

Remarks

After executing the Command, the server will send a notification containing the CommandExitStatus. The server may also send a textual representation of that code, which will be stored in CommandErrorMessage.

This property is not available in the Receiver.

CommandExitStatus Property (SSH Adapter)

The exit code for the executed command for the current message.

Data Type

Integer

Default Value

Remarks

This property is not available in the Receiver.

CommandSSHUser Property (SSH Adapter)

The SSH user name used by the component when executing the command.

Data Type

String

Default Value

Remarks

This value contains the SSHUser used by the adapter to authenticate before executing the Command. It can be read from the context of a message being received by an adapter receive location.

This property is not available in the Receiver.

CommandStdErr Property (SSH Adapter)

The standard error output of the executed Command .

Data Type

String

Default Value

Remarks

This property will contain the standard error output of the Command once execution has completed.

This property is not available in the Receiver.

CommandStdOut Property (SSH Adapter)

The standard output of the executed Command .

Data Type

String

Default Value

Remarks

This property will contain the standard output of the Command once execution has completed.

This property is not available in the Receiver.

ConnectionLifetime Property (SSH Adapter)

Instructs the component whether or not to leave the connection to the server open.

Data Type

Enumeration

Possible Values

Automatic (0)
Per Batch (1)
Persisted (2)

Default Value

Remarks

This property is used when uploading batches of messages to a server that use the same connection properties. In order to minimize connection-related protocol overhead, connections may be persisted with various lifetimes:


Automatic (0 - default)	The connection to the server will be established as needed per each message. When the message transmission is complete, the adapter will disconnect from the server.
Per Batch (1)	During each batch, the connection to the server will be established as needed per each message. If a connection already exists to the server, that will be used as opposed to creating a new one. At the end of the batch, all such connections will be disconnected.
Persisted (2)	Connections will be established as needed and stored. If a connection already exists for a server, that will be used as opposed to creating a new one. The connections will not be disconnected until the adapter is terminated by the BizTalk Message Engine.

This property is not available in the Receiver.

FailOnError Property (SSH Adapter)

Controls how the component treats error codes returned by command execution.

Data Type

Boolean

Default Value

true

Remarks

If set to True, FailOnError will cause the adapter to stop processing the inbound data and raise an error if the SSHHost returns an unsuccessful error code when executing the Command.

If set to False, the adapter will return all error information through the message context properties CommandExitStatus and CommandErrorMessage. Any standard output from the command's execution will be stored as usual in the message body.

Note: since FailOnError defaults to True, some improper command values may result in unexpected errors. In this case, it is useful to examine the standard output for any hints on proper command usage by setting FailOnError to false and writing the contents of the message to a file.

Firewall Property (SSH Adapter)

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

MaxPersistentConnections Property (SSH Adapter)

The maximum number of simultaneous persistent connections when sending.

Data Type

Integer

Default Value

Remarks

This setting specifies the maximum number of simultaneous persistent connections when sending.

The default value is 1, which limits the adapter to using one persistent connection for the adapter at any one time. This means when ConnectionLifetime is set to Persisted the send adapter will first check to see if an existing connection is present before transmitting data. In the case where a connection exists but another instance of the send port is using the connection the adapter will wait for the connection to become free. A value of 1 effectively serializes all communication for the send port through one persistent connection.

By setting a value greater than 1 a pool of persistent connections can be created. This allows multiple simultaneous persistent connections to be used. When the send adapter is active it will check to see if there are any existing connections. In the case where a connection exists but is being used by another instance of the send port it will attempt to create a new persistent connection. If creating a new persistent connection would exceed the limit specified in this setting the adapter will instead wait for a connection to become free. Setting this to a value greater than 1 allows multiple simultaneous connections to be made while still taking advantage of persistent connections to reduce the overhead of re-connecting.

Note: This only applies to the send adapter.

The default value is 1.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Receiver.

MaxThreads Property (SSH Adapter)

The maximum number of threads that the component may consume.

Data Type

Integer

Default Value

Remarks

This property limits the number of concurrent threads that the adapter may consume while completing its work.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

MaxTransmissionBatchSize Property (SSH Adapter)

The maximum number of messages that can be sent in a single batch.

Data Type

Integer

Default Value

Remarks

This property controls the maximum size of an outbound message batch.

Note: be careful when modifying this property as it directly effects the efficiency of the transmit adapter. Setting MaxTransmissionBatchSize to a low value in an environment that requires transmission of large quantities of data will result in the adapter accumulating several small batches. If TransmitBatchMode is set to Parallel, this will result in the adapter transmitting many small batches at once and can put a heavy load on the processor.

Conversely, if TransmitBatchMode is set to Serial, setting MaxTransmissionBatchSize to a large value may result in long transmission delays as the adapter will wait on existing work to complete before accepting new messages from the BizTalk Message Engine. This is especially true when the adapter is transmitting large data.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Receiver.

Other Property (SSH Adapter)

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

Data Type

String

Default Value

Remarks

The adapter 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 adapter, 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

PersistentConnection Property (SSH Adapter)

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

Data Type

Boolean

Default Value

false

Remarks

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

RequeueEndpoints Property (SSH Adapter)

Whether to requeue receive endpoints if the polling interval has not been reached.

Data Type

Boolean

Default Value

false

Remarks

This setting controls whether receive endpoints are requeued for later processing if the polling interval has not yet been reached. When this setting is set to No (default) each thread will block until the polling interval for the corresponding receive location is reached. If there exist more active receive locations than MaxThreads it is possible for some threads to block the execution of others since they may be waiting for a polling interval.

When this setting is set to Yes if the polling interval has not been reached the thread will not block until the polling interval is reached, and instead the endpoint will be requeued to be processed later. This lets subsequent endpoints in the queue to be processed.

If MaxThreads is set to a low value and there are a larger number of receive locations setting this to Yes will help assure that polling intervals are respected and receive locations poll in a timely manner.

The default value is No.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

RuntimeLicense Property (SSH Adapter)

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

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

SSHAcceptServerHostKey Property (SSH Adapter)

Instructs the component to accept the server host key that matches the supplied key.

Data Type

Certificate

Remarks

If the host key that will be used by the server is known in advance, this property may be set to accept the expected key. If you are using the fingerprint, you may supply it to the SSHAcceptServerHostKeyFingerPrint setting by HEX encoding the values in the form "0a:1b:2c:3d". If this property is not set the server will not be authenticated, and the connection will be refused by the client.

Note: You may also set the Accept Any field to Yes without opening the certificate selection dialog to force the adapter 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 adapter to report the server's credentials to Location.

SSHAuthMode Property (SSH Adapter)

The type of authentication used by the component.

Data Type

Enumeration

Possible Values

None (0)
Multi Factor (1)
Password (2)
Public Key (3)
Keyboard Interactive (4)
GSSAPIWith Mic (5)

Default Value

Remarks

SSHAuthMode controls how the adapter attempts to authenticate when connecting to the SSHHost. The following authentication methods are available:


None	The adapter will attempt anonymous authentication.
Multi-Factor	The adapter will attempt as many authentication steps as the server requires using whatever credentials it has available.
Password	The adapter will send the SSHPassword to the server.
Public Key	The adapter will send the SSHCert to the server;
Keyboard-Interactive	The adapter will perform SSH keyboard-interactive authentication, responding automatically to the server's authentication prompts. It will supply the value of SSHPassword as the response to the "password" prompt. Note: this method is not truly keyboard-interactive, and the adapter may not recognize all prompts supplied by the server. It should be used only when the SSHHost cannot be configured to authenticate the SSHUser via more easily automated methods such as Password or Public Key.
GSSAPIWithMic	This allows the adapter to attempt Kerberos authentication using the GSSAPI-WITH-MIC scheme. The client will try Kerberos authentication using the value of SSHUser (single sign-on), or if SSHPassword is specified as well, it will try Kerberos authentication with alternate credentials.

SSHCert Property (SSH Adapter)

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

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for SSH 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.

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

SSHCompressionAlgorithms Property (SSH Adapter)

A comma-separated list of compression algorithms allowed for this connection.

Data Type

String

Default Value

"none"

Remarks

This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the adapter will raise an error and the connection will be aborted.

SSHCompressionAlgorithms must be set to a comma-separated list containing at least one of the following values:


zlib	Zlib compression is allowed for this connection.
none	No compression is allowed for this connection.

SSHHost Property (SSH Adapter)

The address of the SSH host.

Data Type

String

Default Value

Remarks

The SSHHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If the SSHHost property is set to a Domain Name, a DNS request is initiated, and upon successful termination of the request, the SSHHost property is set to the corresponding address. If the search is not successful, an error is logged.

SSHPassword Property (SSH Adapter)

The password for SSH password-based authentication.

Data Type

Password

Default Value

Remarks

SSHPassword specifies the password which is used to authenticate the client to the SSH server.

SSHPort Property (SSH Adapter)

The port on the SSH server where the SSH service is running; by default, 22.

Data Type

Integer

Default Value

Remarks

The SSHPort specifies a service port on the SSH host to connect to.

SSHUser Property (SSH Adapter)

The username for SSH authentication.

Data Type

String

Default Value

Remarks

SSHUser specifies the username which is used to authenticate the client to the SSH server. This property is required.

SSOAffiliate Property (SSH Adapter)

Specifies the name of the SSO Affiliate Application.

Data Type

String

Default Value

Remarks

This property allows the adapter to load credentials from an Enterprise Single Sign-On secret server.

Timeout Property (SSH Adapter)

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

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

TransmitBatchMode Property (SSH Adapter)

How the transmitter processes batches.

Data Type

Enumeration

Possible Values

Parallel (0)
Serial (1)

Default Value

Remarks

This property controls how the transmitter processes message batches:


Parallel	The adapter will process however many batches the BizTalk Message Engine sends it. The number of maximum concurrent batches may be controlled by the MaxThreads property.
Serial	The adapter will queue batches from the BizTalk Message Engine and process them one at a time.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Receiver.

TransportLog Property (SSH Adapter)

Tells the component where and how to report information about its operations.

Data Type

Log

Remarks

This is a Log type property which contains fields describing how and where the adapter will record information about its execution.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

URI Property (SSH Adapter)

The Uniform Resource Identifier (URI) of the send port or receive location.

Data Type

String

Default Value

Remarks

This property specifies a URI for the send port or receive location. Setting this property is optional.

By default the adapter will automatically generate a URI. You may choose to specify your own value here to be used in place of the generated URI.

If this value is specified it must begin with the correct prefix, as seen in the default value.

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 adapter supports both public and private keys in a variety of formats. When the cstAuto value is used the adapter 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 adapter. 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.

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Certificate();

Creates a Certificate instance whose properties can be set.

public Certificate(string certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

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

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Firewall();

Log Type

A log where the component will record information about its operations.

Remarks

This describes how and where the adapter will record information describing its execution.

Fields

Location
String
Default Value: "Application"

This field describes the location where the logging information is to be written.

If the EventLog LogType has been chosen, this field must contain the name of the Event Log to which the information should be written. The default value for this field is "Application". If a value other than "Application" is set the computer must be restarted for the change to take effect. Note that the same event log must be used for all send ports and receive locations that use the same adapter.

If the File LogType has been chosen, this field must contain the location of the file to write logging information to on the file system.

The adapter also supports logging to files based on the current date and time. This allows for log files to be organized by days, months, or other intervals as specified. When specifying a log filename include a valid .NET date and time format string within the < and > characters. For instance C:\logs\sftp_<yyyyMMdd>.log or C:\logs\as2_<yyyyMMdd>T<hhmm>.log.

LogMode
LogModes
Default Value: 3

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


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

LogType
LogTypes
Default Value: 1

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


None	The adapter will not report any logging information.
EventLog	The adapter will report all logging information to the event log. The specific event log must be defined in the Location field when this type is selected.
File	The adapter will report all logging information to a file. The desired file must be specified in the Location field when this type has been selected.

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Log();

public Log(LogTypes logType, string location, LogModes logMode);

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy such as the Server and the AuthScheme.

Fields

AuthScheme
ProxyAuthSchemes
Default Value: 0

Use the AuthScheme field to tell the adapter which type of authorization to perform when connecting to the proxy. This is only used when the User and Password fields are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the adapter. Look at the configuration file for the adapter being used to find more information about manually setting this token.

If AuthScheme is set to authNtlm (4), NTLM authentication will be used. This option is only available in the SSL package.

For security reasons, setting this property will clear the values of User and Password.

AutoDetect
Boolean
Default Value: False

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

Password
String
Default Value: ""

A password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
Integer
Default Value: 80

The TCP port for the proxy Server (default 80). See the description of the Server field for details.

Server
String
Default Value: ""

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

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

SSL
ProxySSLTypes
Default Value: 0

Determines when to use SSL for the connection to the proxy. The applicable values are the following:


psAutomatic (0)	Default setting. The connection to the Server is SSL-enabled for 'https' URL-s, and non SSL-enabled for other URL-s.
psAlways (1)	The connection is always SSL-enabled.
psNever (2)	The connection is not SSL-enabled.
psTunnel (3)	The connection is through a tunneling (HTTP) proxy.

User
String
Default Value: ""

A user name, if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Proxy();

public Proxy(string server, int port);

public Proxy(string server, int port, string user, string password);

Config Settings (SSH Adapter)

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

SSH Config Settings

KeyRenegotiationThreshold: Sets the threshold for the SSH Key Renegotiation.

This property allows you to specify the threshold, in the number of bytes, for the SSH Key Renegotiation. The default value for this property is set to 1 GB.

Example (for setting the threshold to 500 MB): SSHComponent.Config("KeyRenegotiationThreshold=524288000")

LogSSHPackets: If True, detailed SSH packet logging is performed.

This setting can be enabled to assist in debugging. When set to True the adapter will include detailed information about the SSH level packets in the log. The default value is False.

SSHAcceptServerHostKeyFingerPrint: Instructs the adapter to accept the server's host key with this fingerprint.

This may be set to a comma-delimited collection of 16-byte MD5 fingerprints that should be accepted as the host's key. You may supply it by HEX encoding the values in the form "0a:1b:2c:3d". Example: SSHAcceptServerHostKeyFingerprint=0a:1b:2c:3d

SSHEncryptionAlgorithms: A comma-separated list containing all allowable compression algorithms.

During the SSH handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client.

At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the component:


aes256-cbc	256-bit AES encryption in CBC mode
aes192-cbc	192-bit AES encryption in CBC mode
aes128-cbc	128-bit AES encryption in CBC mode
3des-cbc	192-bit (3-key) triple DES encryption in CBC mode
aes256-ctr	256-bit AES encryption in CTR mode
aes192-ctr	192-bit AES encryption in CTR mode
aes128-ctr	128-bit AES encryption in CTR mode
3des-ctr	192-bit (3-key) triple DES encryption in CTR mode
cast128-cbc	CAST-128 encryption
blowfish-cbc	Blowfish encryption
arcfour	ARC4 encryption
arcfour128	128-bit ARC4 encryption
arcfour256	256-bit ARC4 encryption
aes256-gcm@openssh.com	256-bit AES encryption in GCM mode.
aes128-gcm@openssh.com	128-bit AES encryption in GCM mode.

The default value is "aes256-ctr,aes192-ctr,aes128-ctr,aes256-cbc,aes192-cbc,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,arcfour256,arcfour128,arcfour,cast128-cbc,aes256-gcm@openssh.com,aes128-gcm@openssh.com".

SSHKeyExchangeAlgorithms: Specifies the supported key exchange algorithms.

This may be used to specify the list of supported key exchange algorithms used during SSH negotiation. The value should contain a comma separated list of algorithms. Supported algorithms are:

curve25519-sha256
curve25519-sha256@libssh.org
diffie-hellman-group1-sha1
diffie-hellman-group14-sha1
diffie-hellman-group14-sha256
diffie-hellman-group16-sha512
diffie-hellman-group18-sha512
diffie-hellman-group-exchange-sha256
diffie-hellman-group-exchange-sha1
ecdh-sha2-nistp256
ecdh-sha2-nistp384
ecdh-sha2-nistp521
gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==
gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==
gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==
gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==
gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==
gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g==

The default value is: curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group-exchange-sha256,diffie-hellman-group14-sha256,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-sha1,diffie-hellman-group14-sha1,diffie-hellman-group1-sha1,gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==,gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==,gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==,gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g==.

SSHMacAlgorithms: Specifies the supported Mac algorithms.

This may be used to specify an alternate list of supported Mac algorithms used during SSH negotiation. This also specifies the order in which the Mac algorithms are preferred. The value should contain a comma separated list of algorithms. Supported algorithms are:

hmac-sha1
hmac-md5
hmac-sha1-96
hmac-md5-96
hmac-sha2-256
hmac-sha2-256-96
hmac-sha2-512
hmac-sha2-512-96
hmac-ripemd160
hmac-ripemd160-96
hmac-sha2-256-etm@openssh.com
hmac-sha2-512-etm@openssh.com
umac-64@openssh.com
umac-64-etm@openssh.com
umac-128@openssh.com
umac-128-etm@openssh.com

The default value is hmac-sha2-256,hmac-sha2-512,hmac-sha1,hmac-md5,hmac-ripemd160,hmac-sha1-96,hmac-md5-96,hmac-sha2-256-96,hmac-sha2-512-96,hmac-ripemd160-96,hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,umac-64@openssh.com,umac-64-etm@openssh.com,umac-128@openssh.com,umac-128-etm@openssh.com.

SSHPublicKeyAlgorithms: Specifies the supported public key algorithms for the server's public key.

This setting specifies the allowed public key algorithms for the server's public key. This list controls only the public key algorithm used when authenticating the server's public key. This list has no bearing on the public key algorithms that can be used by the client when performing public key authentication to the server. The default value is ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa,ssh-dss,x509v3-sign-rsa,x509v3-sign-dss.

This setting specifies a list of signature algorithms that may be used when authenticating to the server using public key authentication. This applies only when public key authentication is performed by the client.

The setting should be a comma separated list of algorithms. At runtime the adapter will evaluate the specified algorithms and if the algorithm is applicable to the certificate specified in SSHCert it will be used. If the algorithm is not applicable the adapter will evaluate the next algorithm. Possible values are:

ssh-rsa
rsa-sha2-256
rsa-sha2-512
ssh-dss
ecdsa-sha2-nistp256
ecdsa-sha2-nistp384
ecdsa-sha2-nistp521
ssh-ed25519
x509v3-sign-rsa
x509v3-sign-dss

The default value in Windows is ssh-rsa,rsa-sha2-256,rsa-sha2-512,ssh-dss,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,ssh-ed25519.

rsa-sha2-256 and rsa-sha2-512 notes

The adapter will query the server for supported algorithms when connecting. If the server indicates support for rsa-sha2-256 or rsa-sha2-512 and the algorithm is present in the list defined by this setting (as in the default value), that algorithm will be used instead of ssh-rsa even when ssh-rsa appears first in the list.

For the rsa-sha2-256 and rsa-sha2-512 algorithms to be automatically preferred the server must support the ext-info-c mechanism. In practice, older servers do not support this and in that case ssh-rsa will be used since it appears first in the list. Newer servers do support this mechanism and in that case rsa-sha2-256 or rsa-sha2-512 will be used even though it appears after ssh-rsa.

This behavior has been carefully designed to provide maximum compatibility while automatically using more secure algorithms when connecting to servers which support them.

UseStrictKeyExchange: Specifies how strict key exchange is supported.

This setting controls whether strict key exchange (strict kex) is enabled to mitigate the Terrapin attack. When enabled, the adapter will indicate support for strict key exchange by automatically including the pseudo-algorithm kex-strict-c-v00@openssh.com for client adapters and kex-strict-s-v00@openssh.com for server adapters in the list of supported key exchange algorithms.

Since both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the adapter provides options to further control the behavior in different scenarios. Possible values for this setting are:


`0`	Disabled. Strict key exchange is not supported in the adapter.
`1` (default)	Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue.
`2`	Enabled, but reject affected algorithms if the remote host does not support strict key exchange. If the remote host supports strict key exchange all algorithms may be used. If the remote host does not support strict key exchange the connection will only continue if the selected encryption and MAC algorithms are not affected by the Terrapin attack.
`3`	Required. If the remote host does not support strict key exchange the connection will fail.

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 adapter initiate connections (or accept in the case of server adapters) only through that interface.

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

When set to False, the adapter 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 adapter 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 adapters 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.

Supported Macros

The adapter also supports the following Macros. These values are not case sensitive and would be supplied to a property in the form %MacroName%.

TempThis is resolved to the full path to the system's temporary directory. MessageIDGlobally unique identifier (GUID) of the message in BizTalk Server. SourceFileNameThe original file name. This includes the extension and excludes the file path, for example, Sample.xml SourceFileNameNoExtThe original file name without the extension or file path, for example, Sample RemoteFileNameThe name of the file as it was uploaded to the remote server. This includes the extension and excludes the file path, for example, Sample.xml. Valid only for AS3, FTP, and SFTP Send Adapters. DestinationPartyName of the destination party. DestinationPartyQualifierQualifier of the destination party. SourcePartyName of the source party. SourcePartyQualifierQualifier of the source party. DateTime:CustomFormatThis special value allows you to specify your own custom time format. For instance DateTime:yyyy would be resolved to the 4 digit year. DateThe date format yyyy-MM-dd. DateTimeThe date format yyyy-MM-ddThhmmss. TimeThe date format hhmmss. DateTime_BTS2000The date format yyyyMMddhhmmssf. DateTime.TZThe date format yyyy-MM-ddThhmmsszzz. Time.TZThe date format hhmmsszzz. Property#<Schema>#<Name>This special value allows you to include a property from the incoming message. For instance "PROPERTY#http://schemas.microsoft.com/BizTalk/2003/system-properties#ReceivePortName" would resolve to the ReceivePortName property of the message.