SFTP Connector

The SFTP Component adds SSH-secured file transfer capabilities to your MuleSoft.

Remarks

The SFTP Connector adds a complete SFTP client to your Mule Project that enables it with SSH-secured file download and upload functionality.

SFTP Receive Connector

The SFTP Receive Connector will establish a connection to a server and download a group of files The SFTP Receive Connector requires that a single property be set: SSHHost. You may also set an SSHPort if the server is not running on the default SSH port. In order to authenticate with the SSH server, you will need to specify an SSHUser, and either SSHPassword or SSHCert depending upon the SSHAuthMode to be used.

The connector will connect to the SFTP server every PollingInterval and list the directory specified by RemotePath. All files that match the FileMask will be downloaded and submitted to the Mule Project as individual Mule Messages. In order to guarantee that files are not downloaded multiple times, you may set the DeleteMode.

Download Example

Drag and drop the SFTP Receive Connector into the source position of a flow. All that is necessary to get started is to configure the connection settings.

Just as an example, say you want to download a group of files stored on a remote machine in /home/Bob/files.

To configure the connector, one option is to specify a RemotePath of /home/Bob/files and an empty FileMask. Since FileMask defaults to *.*, all files in the RemotePath will be downloaded.

One mule event will be generated for each downloaded file. You can use a File Write connector behind the SFTP Receive connector to write the files to disk.

The received filename is available in the ReceivedFileName attribute on each Mule Message. To write the entire group of files to disk, you can set the Path property of the File Write connector to the following DataWeave code:

"C:\\my\\files\\" ++ attributes.ReceivedFileName

The Content can be left as payload. That is all that is required to begin downloading files.

SFTP Send Connector

The SFTP Send Connector will establish a connection to a server and upload a file. The bytes in the payload of the incoming Mule Message will be uploaded as a single file. The SFTP Send Connector requires both an SSHHost and a RemoteFile. You may also set an SSHPort if the server is not running on the default SSH port. In order to authenticate with the SSH server, you will need to specify an SSHUser, and either SSHPassword or SSHCert depending upon the SSHAuthMode to be used.

The connector will connect to the SFTP server whenever it has a message to send. The connector will attempt to upload to the specified RemotePath. If Overwrite is set to True, the connector will delete or overwrite remote files as necessary to complete the operation.

In order to prevent parallel processing by another application before your upload is complete, you may need to set a temporary upload directory via RemoteTempPath. If the temporary directory is set, the file will first be uploaded to the specified temporary directory, and will be moved to the final destination path once the upload has completed.

Upload Single Example

Add a File Read connector in front of the SFTP Send connector and configure it to read a particular target file. There is no need to transform the output of the File Read connector before passing it to the SFTP Send connector. Configure the SFTP Send connector with the above connection settings. That is all that is required to upload the file.

Upload Multiple Example

The Send operation only uploads a single file at a time so we will need to perform the Send operation once for each file.

To get started, add a File List connector to your flow and configure it to list a target folder. Behind the File List connector add a For Each Scope and configure it to iterate over the message payload. Inside the For Each Scope, add a SFTP Send operation and configure it with the above connection settings.

Set the RemoteFile property dynamically with DataWeave to preserve the uploaded filename. To do this, click the Mule Expression indicator on the RemoteFile property and add the following DataWeave code:

"/home/Spencer/files" ++ attributes.fileName

That is all that is required to upload a group of files.

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.


AfterConnect	A set of FTP-style commands to be executed immediately after connecting to the SSHHost .
AfterGet	A set of FTP-style commands to be executed after the download.
BeforeGet	A set of FTP-style commands to be executed before the download.
DeleteMode	Controls if and when the remote file is deleted after download.
FileMask	Indicates the type of files to download from the SSH server.
Firewall	A set of properties related to firewall access.
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.
Other	Defines a set of configuration settings to be used by the component.
PersistentConnection	Instructs the component whether to keep the connection to the server open.
ReceivedFileDate	The date of the remote file received by the SFTP component.
ReceivedFileName	The name of the remote file received by the SFTP component.
ReceivedFilePath	The remote path of the file received by the SFTP component.
ReceivedFileSize	The size of the remote file received by the SFTP component.
ReceivedFileSSHUser	The SSH user name used by the SFTP component when downloading the remote file.
RemotePath	The current path on the SSH server.
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.
TempPath	A temporary local directory where data can be stored before the component processes it.
Timeout	A timeout for the component.

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.


AfterConnect	A set of FTP-style commands to be executed immediately after connecting to the SSHHost .
AfterPut	A set of FTP-style commands to be executed after the upload.
Append	Whether or not the component should append data to the RemoteFile .
BeforePut	A set of FTP-style commands to be executed before the upload.
Firewall	A set of properties related to firewall access.
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.
Other	Defines a set of configuration settings to be used by the component.
Overwrite	Whether or not the component should overwrite files during transfer.
PersistentConnection	Instructs the component whether to keep the connection to the server open.
RemoteFile	The name of the destination file on the SSH server for uploading.
RemotePath	The current path on the SSH server.
RemoteTempPath	A temporary directory on the server to store files before moving them to RemotePath .
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.
Timeout	A timeout for the component.

Config Settings

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


DisableRealPath	Controls whether or not the SSH_FXP_REALPATH request is sent.
DownloadCacheFile	When set, only new files will be downloaded from the server.
DownloadCacheFileDuration	The number of minutes that a file name will remain in the download cache.
EnableFileDetailsComparison	Whether the receive component should consider metadata differences when deciding whether to download a file again.
ExcludeMask	Instructs the component to exclude some files when downloading.
FileMaskDelimiter	Specifies a delimiter to use for setting multiple file masks.
FilePermissions	Specifies the permissions of a file to be set after a successful upload.
IgnoreFileMaskCasing	Instructs the component to ignore casing of when FileMask is set.
KeyRenegotiationThreshold	Sets the threshold for the SSH Key Renegotiation.
ListDirBeforeDelete	Determines if the directory is listed before a resource is deleted.
ListDirBeforeDownload	Determines if the directory is listed on download.
LocalEOL	When TransferMode is set, this specifies the line ending for the local system.
LogSSHPackets	If True, detailed SSH packet logging is performed.
MaxFileData	Specifies the maximum payload size of an SFTP packet.
MaxFilesPerPollingInterval	The maximum number of files that will be downloaded from the server during a single poll.
ProtocolVersion	The highest allowable SFTP version to use.
RenameMode	The condition under which RenameTo is used.
RenameTo	A filename to which RemoteFile will be renamed.
ServerEOL	When TransferMode is set, this specifies the line ending for the remote system.
SortCriteria	Determines sort order before downloading files.
SSHAcceptServerHostKeyFingerPrint	Instructs the component to accept the server's host key with this fingerprint.
SSHEncryptionAlgorithms	A comma-separated list containing all allowable compression algorithms.
SSHFingerprintHashAlgorithm	The algorithm used to calculate the fingerprint.
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.
TemporaryDownloadExtension	An extension to be appended during download.
TemporaryUploadExtension	An extension to be appended during upload.
TransferMode	The transfer mode (ASCII or Binary).
UseStrictKeyExchange	Specifies how strict key exchange is supported.
WaitForServerDisconnect	Causes the component to wait for the server to close the connection.
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.

AfterConnect Property (SFTP Connector)

A set of FTP-style commands to be executed immediately after connecting to the SSHHost .

Data Type

String

Default Value

Remarks

AfterConnect is a script that is executed immediately following a successful connection.

Each line in the script is treated as a single command. By default, if the connector encounters any errors while executing a command, it will log the error message and will continue to process the script. This behavior can be turned off by inserting "ONERROR FAIL" at any point in the script, which will cause the script to terminate on error but will not interrupt the normal operation of the connector. The default behavior can be restored at any point in the script by inserting the line "ONERROR RESUME".

Valid additional scripting commands are listed below:


cd Path	Change the remote directory to the specified path.
del Filename	Delete the specified file from the remote server.
mkdir Directory	Create the specified remote directory on the server.
rn Filename NewFilename	Rename the remote file specified by Filename to the NewFilename.
move Filename NewFilename	Move the remote file located at Filename to the NewFilename.
rm Filename	Remove the specified file from the remote server.
rmdir Directory	Remove the remote directory from the server.
touch Filename	Create the specified file on the server.

AfterGet Property (SFTP Connector)

A set of FTP-style commands to be executed after the download.

Data Type

String

Default Value

Remarks

AfterGet is a script that is executed immediately following each successful download operation.

Valid additional scripting commands are listed below:


cd Path	Change the remote directory to the specified path.
del Filename	Delete the specified file from the remote server.
mkdir Directory	Create the specified remote directory on the server.
rn Filename NewFilename	Rename the remote file specified by Filename to the NewFilename.
move Filename NewFilename	Move the remote file located at Filename to the NewFilename.
rm Filename	Remove the specified file from the remote server.
rmdir Directory	Remove the remote directory from the server.
touch Filename	Create the specified file on the server.

This property is not available in the Sender.

AfterPut Property (SFTP Connector)

A set of FTP-style commands to be executed after the upload.

Data Type

String

Default Value

Remarks

AfterPut is a script that is executed immediately following each successful upload operation.

Valid additional scripting commands are listed below:


cd Path	Change the remote directory to the specified path.
del Filename	Delete the specified file from the remote server.
mkdir Directory	Create the specified remote directory on the server.
rn Filename NewFilename	Rename the remote file specified by Filename to the NewFilename.
move Filename NewFilename	Move the remote file located at Filename to the NewFilename.
rm Filename	Remove the specified file from the remote server.
rmdir Directory	Remove the remote directory from the server.
touch Filename	Create the specified file on the server.

This property is not available in the Receiver.

Append Property (SFTP Connector)

Whether or not the component should append data to the RemoteFile .

Data Type

Boolean

Default Value

false

Remarks

This property controls the connector's upload behavior. When set to TRUE, the connector will append data to the file specified by RemoteFile rather than creating or overwriting it.

This property is not available in the Receiver.

BeforeGet Property (SFTP Connector)

A set of FTP-style commands to be executed before the download.

Data Type

String

Default Value

Remarks

BeforeGet is a script that is executed immediately before each download operation.

Valid additional scripting commands are listed below:


cd Path	Change the remote directory to the specified path.
del Filename	Delete the specified file from the remote server.
mkdir Directory	Create the specified remote directory on the server.
rn Filename NewFilename	Rename the remote file specified by Filename to the NewFilename.
move Filename NewFilename	Move the remote file located at Filename to the NewFilename.
rm Filename	Remove the specified file from the remote server.
rmdir Directory	Remove the remote directory from the server.
touch Filename	Create the specified file on the server.

This property is not available in the Sender.

BeforePut Property (SFTP Connector)

A set of FTP-style commands to be executed before the upload.

Data Type

String

Default Value

Remarks

BeforePut is a script that is executed immediately before each upload operation.

Valid additional scripting commands are listed below:


cd Path	Change the remote directory to the specified path.
del Filename	Delete the specified file from the remote server.
mkdir Directory	Create the specified remote directory on the server.
rn Filename NewFilename	Rename the remote file specified by Filename to the NewFilename.
move Filename NewFilename	Move the remote file located at Filename to the NewFilename.
rm Filename	Remove the specified file from the remote server.
rmdir Directory	Remove the remote directory from the server.
touch Filename	Create the specified file on the server.

This property is not available in the Receiver.

DeleteMode Property (SFTP Connector)

Controls if and when the remote file is deleted after download.

Data Type

Enumeration

Possible Values

Never (0)
On Success (1)
On Failure (2)
Always (3)

Default Value

Remarks

This property informs the connector as to whether or not it should delete a remote files from the server after a successful download. The possible values and their meanings are as follows:


Never	The remote file is never deleted.
OnSuccess	The remote file is deleted after a successful download.
OnFailure	The remote file is deleted if the transfer fails.
Always	The remote file is deleted regardless of success or failure of the transfer.

Note: the default value is Never for data protection purposes. Unless modified this will result in the connector continuously receiving the same data.

This property is not available in the Sender.

FileMask Property (SFTP Connector)

Indicates the type of files to download from the SSH server.

Data Type

String

Default Value

"*.*"

Remarks

This property will limit what kinds of files the connector will download from the server. Only files matching the pattern specified in FileMask will be retrieved.

The following special characters are supported for pattern matching:


?	Any single character.
*	Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct).
[,-]	A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]).
\	The slash is ignored and exact matching is performed on the next character.

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:


Character	Escape Sequence
?	[?]
*	[*]
[	[[]
\	[\]

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

This property is not available in the Sender.

Firewall Property (SFTP 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.

LogFile Property (SFTP 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 (SFTP 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 (SFTP 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.

Other Property (SFTP 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

Overwrite Property (SFTP Connector)

Whether or not the component should overwrite files during transfer.

Data Type

Boolean

Default Value

false

Remarks

This property is a value indicating whether or not the connector should overwrite files on the server if they already exist. If Overwrite is false, an error will be thrown whenever RemoteFile exists before an upload operation.

This property is not available in the Receiver.

PersistentConnection Property (SFTP Connector)

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

Data Type

Boolean

Default Value

false

The RemotePath can be used to set the working directory by setting it to either an absolute directory path or a path relative to the initial remote directory when the connector connects to the SSH server.

RemoteTempPath Property (SFTP Connector)

A temporary directory on the server to store files before moving them to RemotePath .

Data Type

String

Default Value

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 connector attempts to authenticate when connecting to the SSHHost. The following authentication methods are available:


None	The connector will attempt anonymous authentication.
Multi-Factor	The connector will attempt as many authentication steps as the server requires using whatever credentials it has available.
Password	The connector will send the SSHPassword to the server.
Public Key	The connector will send the SSHCert to the server;
Keyboard-Interactive	The connector 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 connector 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 connector 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 (SFTP Connector)

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.

SSHCompressionAlgorithms Property (SFTP Connector)

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

The address of the SSH host.

Data Type

String

Default Value

Default Value

Remarks

This property indicates a temporary directory where the connector can store any data before the connector processes it. If TempPath is empty, the connector will receive all data to memory. If set, the connector will generate and write all inbound data to a temporary file in the specified directory.

Once the file is submitted, the connector will handle closing the file stream and deleting the temporary file. However, if the connector is shut down during a transfer some temporary files may be left in the directory. To ensure optimal performance, server administrators should check the directory regularly and remove old or extraneous files. Note: by default, this property is empty and the connector will use memory streams to store all inbound data before submitting it. It is recommended that you use a temporary directory when downloading large batches or batches containing large files to alleviate potential increased memory requirements.

This property is not available in the Sender.

Timeout Property (SFTP 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).

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 (SFTP 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.

SFTP Config Settings

DisableRealPath: Controls whether or not the SSH_FXP_REALPATH request is sent.

This configuration setting can be used to skip sending the SSH_FXP_REALPATH request, which asks the server to canonicalize the value in RemotePath to an absolute path. The default value is false, which will cause the component to send the request normally. If set to true, component will not send the SSH_FXP_REALPATH packet and will use the value in RemotePath directly.

DownloadCacheFile: When set, only new files will be downloaded from the server.

This may be set to the location of a file on disk that will hold the names of files that were previously downloaded from the server. On each PollingInterval the connector will check to see if the file on the server exists in this list. If the file exists in this list, it is determined that the file was previously downloaded and is not downloaded on the current polling interval. The list is automatically updated on each polling interval. Please see DownloadCacheFileDuration and EnableFileDetailsComparison for more configuration options.

DownloadCacheFileDuration: The number of minutes that a file name will remain in the download cache.

If a file name is added to the DownloadCacheFile and is not seen on the server again within DownloadCacheFileDuration minutes, it will be removed from the cache. This can prevent the download cache file from growing too large in certain cases.

The default value is 0, meaning that files will never be removed.

This setting is only applicable if DownloadCacheFile is set.

EnableFileDetailsComparison: Whether the receive connector should consider metadata differences when deciding whether to download a file again.

This setting is used in conjunction with DownloadCacheFile, and is only available on the receive connector. If DownloadCacheFile is enabled, this setting can be used to control how the receive connector uses the download file cache information when deciding whether to download a file again. (Similar to the "Enable Timestamp Comparison" property on Microsoft's FTP BizTalk Adapter.)

If this is set to False, the receive connector will not download a file again if the cache contains any information about it (that is, if it has been downloaded before).

If this is set to True, the receive connector will check the metadata of the remote file against its cached metadata, and will download the file again if any of the metadata differs.

ExcludeMask: Instructs the connector to exclude some files when downloading.

This configuration setting is used to specify a mask to exclude certain files when downloading. If a file matches both this mask and FileMask, the file will be not be downloaded.

FileMaskDelimiter: Specifies a delimiter to use for setting multiple file masks.

If specified, the file mask will be split into separate masks based on the chosen delimiter. The default is "", which will cause the file mask to be treated as a single value. When using multiple masks, any files that match one or more of the masks will be downloaded. For example, setting FileMaskDelimiter to "," and setting RemoteFile to "*.txt, *.csv" will download all files ending in .txt or .csv.

FilePermissions: Specifies the permissions of a file to be set after a successful upload.

This may be set to an octal value representing the permissions of a file to be set after a successful upload. For example: FilePermissions=0777 Note: When using the SCP connector this must be a 4 digit value. The SFTP connector will accept a 3 digit value.

IgnoreFileMaskCasing: Instructs the connector to ignore casing of when FileMask is set.

By default the value of this setting is false. If set to true the connector will ignore case when matching a value to the FileMask.

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")

ListDirBeforeDelete: Determines if the directory is listed before a resource is deleted.

This is True by default. When set to False the connector will not list the directory before attempting to delete a resource. This may only be used when the exact name of the file is known and is specified in FileMask. This is helpful in situations where the name of the file is known and server permissions do not allow directory listings.

ListDirBeforeDownload: Determines if the directory is listed on download.

This is True by default. When set to False the connector will not list the directory before attempting a download. This may only be used when the exact name of the file is known and is specified in FileMask. This is helpful in situations where the name of the file is known and server permissions do not allow directory listings.

LocalEOL: When TransferMode is set, this specifies the line ending for the local system.

This setting is only applicable when TransferMode is set to 1 (ASCII). The default value is a CrLf character sequence.

When uploading or downloading this value will be compared to ServerEOL. If ServerEOL and LocalEOL are different, the line endings in the file being transferred will be converted to the line endings used by the destination. Line endings will be converted to the value in LocalEOL when downloading. Line endings will be converted to the value in ServerEOL when uploading. If ServerEOL and LocalEOL are the same, no conversion takes place.

The value supplied to this setting should contain a C# .NET style character sequence: TransferMode=1 LocalEOL=\r\ n

Conversion will only happen when TransferMode is set to 1 (ASCII) and ServerEOL and LocalEOL are different.

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

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

MaxFileData: Specifies the maximum payload size of an SFTP packet.

While the SSH specification requires servers and clients to support SSH packets of at least 32000 bytes, some server implementations limit packet size to smaller values. MaxFileData provides a means by which the user can specify the maximum amount of data that can be put into an SFTP packet so that the connector can communicate effectively with these servers. If you are having difficulty when uploading to a server, try setting MaxFileData size to value smaller than 32000.

Most servers that use smaller values will use a maximum SSH packet size of 16KB (16384). In order to most efficiently communicate with such servers, MaxFileData size should be set to 14745.

MaxFilesPerPollingInterval: The maximum number of files that will be downloaded from the server during a single poll.

By default, the connector will download all available files (matching any filemasks) when polling the target directory. To limit the number of files that will be downloaded in a single poll, set this to the maximum number.

Note that to avoid downloading the same subset of files each poll, either DownloadCacheFile or DeleteMode should also be used.

ProtocolVersion: The highest allowable SFTP version to use.

This governs the highest allowable SFTP version to use when negotiating the version with the server. The default value is 3 as this is the most common version. The component supports values from 3 to 6. It is recommended to use the default value of 3 unless there is a specific reason a higher version is needed.

RenameMode: The condition under which RenameTo is used.

This setting controls when the value specified by RenameTo is used. If RenameTo is not specified, this setting has no impact. By default, downloaded files are only renamed after being successfully submitted to BizTalk (a value of 1). Possible values are:


1 (OnSuccess - default)	The file is renamed using the value in RenameTo only after the message is successfully submitted to BizTalk.
2 (OnFailure)	The file is renamed using the value in RenameTo only after the message submission to BizTalk fails.
3 (Always)	The file is renamed using the value in RenameTo regardless of the message submission result.

RenameTo: A filename to which RemoteFile will be renamed.

After downloading a file, the file on the server may be renamed using this setting. This rename action will take place after the batch submission to BizTalk. If you need to perform actions on a file before this, use the AfterGet property. This setting is used in conjunction with RenameMode to conditionally rename a file. For instance, to rename a file after it has been successfully submitted to BizTalk set the Other property of the connector like so: RenameTo=%SourceFileName%.done

ServerEOL: When TransferMode is set, this specifies the line ending for the remote system.

This setting is only applicable when TransferMode is set to 1 (ASCII). The default value is a CrLf character sequence.

When uploading or downloading this value will be compared to LocalEOL. If ServerEOL and LocalEOL are different, the line endings in the file being transferred will be converted to the line endings used by the destination. Line endings will be converted to the value in LocalEOL when downloading. Line endings will be converted to the value in ServerEOL when uploading. If ServerEOL and LocalEOL are the same, no conversion takes place.

The value supplied to this setting should contain a C# .NET style character sequence: TransferMode=1 ServerEOL=\r\ n

Conversion will only happen when TransferMode is set to 1 (ASCII) and ServerEOL and LocalEOL are different.

SortCriteria: Determines sort order before downloading files.

By default, files will be downloaded in the order in which they were listed by the server. When set to a value other than 0, this configuration setting will cause the connector to sort the list of files before downloading. Only applies when ListDirBeforeDownload is true (default). Valid values are:

0 - Disabled
1 - Name, ascending
2 - Name, descending
3 - Date, ascending
4 - Date, descending

SSHAcceptServerHostKeyFingerPrint: Instructs the connector 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".

SSHFingerprintHashAlgorithm: The algorithm used to calculate the fingerprint.

This configuration setting controls which hash algorithm is used to calculate the certificate's fingerprint. Valid values are:

MD5 (default)
SHA1
SHA256

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

TemporaryDownloadExtension: An extension to be appended during download.

During download, it may be necessary for the file on the server to be renamed. After the download is complete the file will be renamed back to the original name.

TemporaryUploadExtension: An extension to be appended during upload.

During upload, it may be necessary for the RemoteFile to be written to a temporary file name. For example, some business process may be set up to expect a specific file extension. Using this setting will allow the connector to upload the file without the remainder of the process attempting to pick up the incomplete file.

TransferMode: The transfer mode (ASCII or Binary).

The value 0 represents Binary and the value 1 represents ASCII. If the value is 0 (default), the initial server mode will be used.

When this value is set to 1 (ASCII) the connector will use the values specified in LocalEOL and ServerEOL to convert line endings as appropriate.

Note: When this value is set to 1 (ASCII) and ProtocolVersion is set to 4 or higher the connector will automatically determine the value for ServerEOL if the server supports the "newline" protocol extension.

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 connector will indicate support for strict key exchange by automatically including the pseudo-algorithm kex-strict-c-v00@openssh.com for client connectors and kex-strict-s-v00@openssh.com for server connectors 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 connector 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 connector.
`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.

WaitForServerDisconnect: Causes the component to wait for the server to close the connection.

When this is set to True, the connector will wait for the server to close the connection after operation is complete instead of closing the connection immediately. This helps prevent ports on the system from being left in the TIME_WAIT state. The default is False.

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.