Note: The SFTP Connector is separately licensed. Contact Cleo Sales for more information.
The SFTP Connector supports a connection to a remote SFTP server. It is similar to
SSH FTP Host, but is packaged as a Connector instead of a Host. Most of the features of SSH FTP Host
are supported with the SFTP Connector, but as a Connector, it can be also used in a URI
reference for the Home Directory of a Users Host or as part of a Virtual subfolder.
SFTP Connector Properties
Each instance of the SFTP Connector can be configured with the following settings:
| Property | Description | Required |
|---|---|---|
| Host | The hostname or IP address of the SFTP server. | Yes |
| Port | The port of the SFTP server (usually 22) | Yes |
| Connection Timeout (seconds) | The number of seconds to wait for an SSH connection to complete. | Yes |
| Username | The SSH username. | Yes |
| Connect.Password | The SSH authentication password. | |
| User Auth Key | The SSH authentication certificate. | |
| User Auth Key Password | The password for the authentication key. | Yes |
| Proxies | Optional addresses of HTTP proxies to use for the connection. Connects to proxies using round robin. If there is a proxy connection failure, it will wait for 60 seconds before retrying that proxy. | |
| Maximum Packet Size | The SSH maximum packet size. | Yes |
| Preferred Compression Algorithm | The preferred SSH compression algorithm. | |
| Preferred Key Exchange Algorithm | The preferred SSH key exchange algorithm. | |
| Preferred Cipher Algorithm | The preferred SSH encryption algorithm. | |
| Preferred Mac Algorithm | The preferred SSH MAC algorithm. | |
| Preferred Public Key Algorithm | The preferred SSH public key algorithm. | |
| Resume Failed Transfers | Select to enable attempts to retry failed transfers. | |
| Resume Cache Size | ||
| Command Retries | The number of times the command should be retried when an error or exception occurs. Valid range: [0-5]. |
Yes |
| Command Retry Delay (seconds) | The number of seconds to wait between retries. Valid range: [O-120]. |
Yes |
| Do Not Send Zero Length Fies | For PUT, a switch that controls whether to send a file if is it zero-length. | |
| Delete Received Zero Length Fies | For GET, a switch that controls whether remove a received file that is zero-length. | |
| Retrieve Directory Sort | For PUT, the sorting options for the list of outbound files. | |
| Enable Debug | A switch that indicates whether to perform debug logging. | |
| System Scheme Name | The URI scheme name used as a shortcut to this host. Valid pattern: [[a-zA-Z]{ 1 }[a-zA-Z0-9+\-\.]{ 1,23}]. |
|
| System Public | A switch that indicates whether the connector is public. |
PGP Encryption and Signing
The SFTP Connector supports Partner Packaging using PGP. When Partner Packaging is enabled
for Outgoing transfers, files are optionally PGP encrypted, compressed and signed before they are transferred
to the remote SFTP server using the PUT command. When Partner Packaging is enabled for
Incoming transfers, files are decrypted, decompressed and have their signatures verified after
they are retrieved from the remote SFTP server using the GET command.
PUT Command Properties
Set the following properties to enable and control PGP signing and encryption for files being PUT.
| Property | Description |
|---|---|
| Outgoing.Partner Packaging | Select to enable PGP encryption and/or signing on PUT. |
| Type | Only pgp packaging is supported. |
| Encryption.Cert | Select the PGP certificate to use for encryption on PUT. |
| Encrypt | Select to enable PGP encryption on PUT. |
| Sign | Select to enable PGP signing on PUT. |
| Compress | Select to enable PGP compression on PUT. |
| Armor | Select to enable ASCII-armor encoding with PGP on PUT. |
| Compression Algorithm | Select the compression algorithm, if Compress is selected. |
| Encryption Algorithm | Select the encryption algorithn, if Encrypt is selected. |
| Hash Algorithm | Select the hash algoritm, ff Sign is selected. |
| V3 Signature | Select if V3 PGP signature should be used. |
GET Command Properties
Set the following properties to enable and control PGP decryption and signature verification for files
being retrieved with GET.
| Property | Description |
|---|---|
| Incoming.Partner Packaging | Select to enable PGP decryption and/or signature verification on GET. |
| Type | Only pgp packaging is supported. |
| Decryption.Cert | Select the PGP certificate to use for decryption on GET. |
| Require Encryption | Fail GET for files that are not PGP encrypted. |
| Require Signature | Fail GET for files that are not PGP signed. |
| Decryption.Cert.Password | Provide the password for the Decryption Cert. |
Algorithm Reference
The SFTP Connector supports the following SSH and PGP algorithms.
| Type | Supported Algorithms |
|---|---|
| SSH Compression | zlip zlib@openssh.com |
| SSH Key Exchange | curve25519-sha256@libssh.org diffie-hellman-group-exchange-sha256 |
| SSH Cipher | aes256-ctr aes192-ctr aes128-ctr |
| SSH Mac | hmac-sha2-256 |
| SSH Public Key | ssh-rsa ssh-dss |
| PGP Compression | zip zlib |
| PGP Encryption | des 3des aes/128 aes/192 aes/256 cast5 twofish blowfish |
| PGP Hash | md2 md5 ripemd160 sha1 sha256 sha384 sha512 |
Comments
0 comments
Please sign in to leave a comment.