SFTP Connection
Overview
The SFTP connection allows IB-X Agents to connect to remote servers using the SSH File Transfer Protocol (SFTP).
SFTP provides encrypted file transfer over SSH and is commonly used in enterprise environments for secure file exchange.
The connection supports:
- Username and password authentication
- SSH private key authentication
- Passphrase-protected private key authentication
- Advanced SSH algorithm configuration
SFTP is a different protocol from FTP and FTPS. Although all three protocols can be used to transfer files, SFTP operates over SSH and uses different authentication and encryption mechanisms.
For FTP or FTPS connections, see FTP Connection.
Connection Properties
Configure the following properties when creating an SFTP connection.
| Property | Description |
|---|---|
| Host | Hostname or IP address of the SFTP server. For example, sftp.example.com. Required. |
| Port | Port used to connect to the SFTP server. Defaults to 22. Required. |
| Username | SSH account username. Required. |
| Authentication Type | Determines the authentication method used to establish the SSH connection. |
| Call Stat on Connect | When enabled, verifies access to the remote file system immediately after establishing the SSH session. Enabled by default. |
Authentication
Select the authentication method required by the target SFTP server.
The following authentication types are supported:
- Password
- Private Key
- Private Key + Passphrase
Changing the Authentication Type clears the Password, Private Key, and Passphrase fields and resets any stored credential values.
Password
Select Password to authenticate using an SSH username and password.
| Property | Description |
|---|---|
| Password | Password associated with the SSH account. Stored securely by IB-X. |
For an existing connection, use the edit option provided for the password field when the stored password needs to be replaced.
Private Key
Select Private Key to authenticate using an SSH private key that does not require a passphrase.
| Property | Description |
|---|---|
| Private Key | SSH private key used for authentication. The key can be pasted directly or uploaded from a supported key file. Required. |
Commonly used private key formats include:
- PEM
- OpenSSH
- PPK
Supported private key formats can depend on the SSH server and the method used to generate the key.
If authentication fails, verify that the private key format is supported by the target server.
Private Key + Passphrase
Select Private Key + Passphrase when the SSH private key is protected by a passphrase.
| Property | Description |
|---|---|
| Private Key | SSH private key used for authentication. Required. |
| Passphrase | Passphrase used to decrypt the private key. Stored securely by IB-X. Required. |
For an existing connection, use the edit option provided for the passphrase field when the stored passphrase needs to be replaced.
Call Stat on Connect
Call Stat on Connect controls whether IB-X verifies access to the remote file system immediately after establishing the SSH session.
This option is enabled by default.
When enabled, the connection performs a file system status operation after connecting. This helps identify file system access or permission issues during connection validation instead of discovering them later when a workflow attempts a file operation.
Disable this option only when the target SFTP server does not support or permit the corresponding file system operation during connection establishment.
Advanced SSH Settings
The Advanced SSH Settings section allows specific SSH algorithms to be configured for the connection.
These settings are collapsed by default.
Leave the fields empty to allow automatic negotiation using the algorithms supported by the client and server.
| Property | Description |
|---|---|
| Key Exchange (Kex) Algorithms | Controls the algorithms used to negotiate encryption keys during SSH connection establishment. |
| Ciphers | Controls the symmetric encryption algorithms used to protect transferred data. |
| Server Host Keys | Controls the server identity algorithms accepted during host verification. |
| HMAC Algorithms | Controls the message authentication algorithms used to verify data integrity. |
Advanced SSH settings are typically required only in environments with strict security policies or when compatibility with a particular server configuration is required.
Incorrect values may prevent a successful connection.
Testing the Connection
After configuring the SFTP connection, click Test Connection to verify that IB-X can connect to the remote SFTP server using the supplied configuration and authentication method.
Testing the connection can help identify issues such as:
- Incorrect hostname or port
- Invalid username or password
- Invalid or unsupported private key
- Incorrect private key passphrase
- SSH algorithm incompatibility
- Network connectivity problems
- Remote file system access restrictions
When Call Stat on Connect is enabled, the connection test also verifies access to the remote file system after establishing the SSH session.
A successful connection test confirms that IB-X can establish the SFTP connection. Access to individual files and directories still depends on the permissions granted to the configured SSH account.
Used By
The SFTP connection can be used by IB-X workflow activities that perform file and directory operations on remote SFTP servers.
The operations available depend on the workflow activity using the connection and the permissions granted to the configured SSH account.
Security Considerations
When configuring an SFTP connection:
- Use an SSH account with only the permissions required by the Agent.
- Use private key authentication where required by your organization's security policies.
- Protect private keys and passphrases from unauthorized access.
- Configure advanced SSH algorithms only when required by the target server or organizational security policies.
For file transfer using FTP or FTP secured with TLS, see FTP Connection.
For information about creating, editing, testing, cloning, deleting, and auditing connections, see Connections.