/n software Connectors for MuleSoft
Version 22.0 [Build 8376]

SCP Connector

Properties   Config Settings  

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

Remarks

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

SCP Receive Connector

The SCP 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 SCP server every PollingInterval and download the file(s) specified by FileMask. All files that match the FileMask will be downloaded and submitted to the Mule Project as individual messages.

Download Example

Add an SCP Receive source connector to your flow and configure the connection settings. That is all that is required to get started.

Optionally specify a RemotePath to change the working directory on the remote machine. The connector will handle connecting to the server and downloading a group of files. One Mule event is generated for each file downloaded.

Behind the SCP Receive connector you can add a File Write connector to write each file to disk. You will need to dynamically set the Path property on the File Write connector to accomplish this. Click the Mule expression indicator on the Path property and set the value to:

'C:\\temp\\' ++ attributes.ReceivedFileName

The received filename will then be used as the same filename on disk. The content of each file will be present in the payload of the Mule Message. That is all that is required to write an incoming file to disk. Additional properties about the file and SSH user are also available in the attributes collection.

SCP Send Connector

The SCP 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 SCP server whenever it has a message to send. The connector will attempt to upload to the specified RemotePath.

Upload Files Example

To get started, add a File Read connector to your flow and configure it to read a target file. Behind the File Read connector, add an SCP Send module and configure the connection settings. There is no need to transform the output of the File Read connector before passing it to the SCP Send module.

The connector will upload the bytes in the payload to the specified RemoteFile at the location specified in RemotePath

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.

FileMaskIndicates the type of files to download from the SSH server.
FirewallA set of properties related to firewall access.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during component execution.
LogTypeHow information gets logged during component execution.
OtherDefines a set of configuration settings to be used by the component.
PersistentConnectionInstructs the component whether to keep the connection to the server open.
ReceivedFileNameThe name of the remote file received by the SCP component.
ReceivedFilePathThe remote path of the received file.
ReceivedFileSizeThe size of the remote file received by the SCP component.
ReceivedFileSSHUserThe SSH user name used by the SCP component when downloading the remote file.
RemotePathThe current path on the SSH server.
RuntimeLicenseSpecifies the component runtime license key.
SSHAcceptServerHostKeyInstructs the component to accept the server host key that matches the supplied key.
SSHAuthModeThe type of authentication used by the component.
SSHCertThe certificate to use for client authentication during the SSH handshake.
SSHCompressionAlgorithmsA comma-separated list of compression algorithms allowed for this connection.
SSHHostThe address of the SSH host.
SSHPasswordThe password for SSH password-based authentication.
SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
SSHUserThe username for SSH authentication.
TempPathA temporary local directory where data can be stored before the component processes it.
TimeoutA 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.

FirewallA set of properties related to firewall access.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during component execution.
LogTypeHow information gets logged during component execution.
OtherDefines a set of configuration settings to be used by the component.
PersistentConnectionInstructs the component whether to keep the connection to the server open.
RemoteFileThe name of the destination file on the SSH server for uploading.
RemotePathThe current path on the SSH server.
RuntimeLicenseSpecifies the component runtime license key.
SSHAcceptServerHostKeyInstructs the component to accept the server host key that matches the supplied key.
SSHAuthModeThe type of authentication used by the component.
SSHCertThe certificate to use for client authentication during the SSH handshake.
SSHCompressionAlgorithmsA comma-separated list of compression algorithms allowed for this connection.
SSHHostThe address of the SSH host.
SSHPasswordThe password for SSH password-based authentication.
SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
SSHUserThe username for SSH authentication.
TimeoutA 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.

FilePermissionsSpecifies the permissions of a file to be set after a successful upload.
KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
LogSSHPacketsIf True, detailed SSH packet logging is performed.
RecursiveModeIf set to true the component will recursively upload or download files.
ServerResponseWindowThe time to wait for a server response in milliseconds.
SSHAcceptServerHostKeyFingerPrintInstructs the component to accept the server's host key with this fingerprint.
SSHEncryptionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
SSHPublicKeyAlgorithmsSpecifies the supported public key algorithms for the server's public key.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

FileMask Property (SCP 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:

CharacterEscape Sequence
? [?]
* [*]
[ [[]
\ [\]

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

This property is not available in the Sender.

Firewall Property (SCP 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 (SCP 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 (SCP 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

3

Remarks

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

VerboseThe connector will report all information regarding the transport.
InfoThe connector will report all major operations, as well as all warnings and errors.
WarningThe connector will report any conditions that could result in unpredictable behavior as well as errors.
ErrorThe connector will report all errors that prevent normal operations from completing.
FatalThe connector will report only serious errors that cause the connector to completely stop functioning.

LogType Property (SCP Connector)

How information gets logged during component execution.

Data Type

Enumeration

Possible Values

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

Default Value

1

Remarks

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

NoneThe connector will not report any logging information.
ConsoleThe connector will report all logging information to the console.
FileThe 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 (SCP 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

PersistentConnection Property (SCP Connector)

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

Data Type

Boolean

Default Value

false

Remarks

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

ReceivedFileName Property (SCP Connector)

The name of the remote file received by the SCP component.

Data Type

String

Default Value

""

Remarks

This is the filename returned by the server.

This value is also placed in the File.ReceivedFileName and the FTP.ReceivedFileName context properties. This is to ensure compatibility with other connectors that poll those context properties when filling out macros such as %SourceFileName%.

This property is not available in the Sender.

ReceivedFilePath Property (SCP Connector)

The remote path of the received file.

Data Type

String

Default Value

""

Remarks

This property holds the remote path of the received file. It identifies the path on the server from which the file was downloaded. In most cases this will be identical to RemotePath.

In the case where RecursiveMode is set to true this value can be used to preserve the remote directory structure.

This property is not available in the Sender.

ReceivedFileSize Property (SCP Connector)

The size of the remote file received by the SCP component.

Data Type

Integer

Default Value

0

Remarks

This value contains the size of the remote file being received by the SCP connector. It can be read from the context of a message being received by an SCP connector receive location.

This property is not available in the Sender.

ReceivedFileSSHUser Property (SCP Connector)

The SSH user name used by the SCP component when downloading the remote file.

Data Type

String

Default Value

""

Remarks

This value contains the SSHUser used by the SCP connector to authenticate before downloading the remote file. It can be read from the context of a message being received by an SCP connector receive location.

This property is not available in the Sender.

RemoteFile Property (SCP Connector)

The name of the destination file on the SSH server for uploading.

Data Type

String

Default Value

"#[attributes.fileName]"

Remarks

The RemoteFile is either an absolute file path, or a relative path based on RemotePath.

This property is not available in the Receiver.

RemotePath Property (SCP Connector)

The current path on the SSH server.

Data Type

String

Default Value

""

Remarks

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.

RuntimeLicense Property (SCP Connector)

Specifies the component runtime license key.

Data Type

String

Default Value

""

Remarks

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

SSHAcceptServerHostKey Property (SCP Connector)

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 connector to report the server's credentials to Location.

SSHAuthMode Property (SCP Connector)

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

2

Remarks

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

NoneThe connector will attempt anonymous authentication.
Multi-FactorThe connector will attempt as many authentication steps as the server requires using whatever credentials it has available.
PasswordThe connector will send the SSHPassword to the server.
Public KeyThe connector will send the SSHCert to the server;
Keyboard-InteractiveThe 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.
GSSAPIWithMicThis 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 (SCP 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 (SCP 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:

zlibZlib compression is allowed for this connection.
noneNo compression is allowed for this connection.

SSHHost Property (SCP Connector)

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

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

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

Data Type

Integer

Default Value

22

Remarks

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

SSHUser Property (SCP Connector)

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.

TempPath Property (SCP Connector)

A temporary local directory where data can be stored before the component processes it.

Data Type

String

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

A timeout for the component.

Data Type

Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the 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

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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.
SPCSoftware publisher certificates.

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

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

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

StorePassword
String

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

StoreType
CertStoreTypes

The type of certificate store for this certificate.

The 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).
20 (cstSecurityKey)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 cstSecurityKey, 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.cstSecurityKey; 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.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Subject
String

The subject of the certificate used for client authentication.

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

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

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

Example (Searching with partial subject)

Control.CertSubject = "Test"

If a match is not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

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

Thumbprint
String

The thumbprint of the certificate.

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

Firewall Type

The firewall the component will connect through.

Remarks

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

Fields

AutoDetect
Boolean

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

FirewallType
FirewallTypes

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

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

Host
String

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

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

Password
String

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

Port
Integer

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

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

User
String

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

Config Settings (SCP 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.

SCP Config Settings

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.

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 connector will include detailed information about the SSH level packets in the log. The default value is False.

RecursiveMode:   If set to true the connector will recursively upload or download files.

When a filemask is specified in LocalFile (sending) or FileMask (receiving) this setting specifies if sub-directories and files are transferred as well. By default this value is False and only files in the specified directory will be transferred. If set to true recursion will be used to transfer all child folders and files.

When sending, LocalFile should contain the path and filemask of a location on disk from which files will be uploaded. For instance "c:\files\*.txt".

When receiving, the ReceivedFilePath message context property is populated and provides the remote path from which the file was downloaded. Note that the server may not always return the expected files depending on the FileMask specified. A value of "*" should always work, however more complex filemask values may not be handled by the server as expected.

ServerResponseWindow:   The time to wait for a server response in milliseconds.

After an operation is complete the server may still return an error. This setting controls the amount of time the connector will wait for an error to be returned. This value is specified in milliseconds. The default value is "20".

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-cbc256-bit AES encryption in CBC mode
aes192-cbc192-bit AES encryption in CBC mode
aes128-cbc128-bit AES encryption in CBC mode
3des-cbc192-bit (3-key) triple DES encryption in CBC mode
aes256-ctr256-bit AES encryption in CTR mode
aes192-ctr192-bit AES encryption in CTR mode
aes128-ctr128-bit AES encryption in CTR mode
3des-ctr192-bit (3-key) triple DES encryption in CTR mode
cast128-cbcCAST-128 encryption
blowfish-cbcBlowfish encryption
arcfourARC4 encryption
arcfour128128-bit ARC4 encryption
arcfour256256-bit ARC4 encryption
aes256-gcm@openssh.com256-bit AES encryption in GCM mode.
aes128-gcm@openssh.com128-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
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.
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
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.
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.

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.

By default the connector will use the system security libraries to perform cryptographic functions where applicable. Setting this to True tells the connector to use the internal implementation instead of using the system's security API.

Copyright (c) 2022 /n software inc. - All rights reserved.
/n software Connectors for MuleSoft - Version 22.0 [Build 8376]