SFTP source connector fail connect with provided SSH key credentials

Last update: 2023-11-21

Quick guide to fix the SFTP source connector fail error with SSH key credentials using PuTTY tool to convert from PPK to OpenSSH format. (Instructions on how to generate the keys can be found in SFTP connector: Set up a Base64-encoded OpenSSH private key for SFTP.)

Description

Environment
Adobe Experience Platform

Issue

You want to set up a SFTP source connector within AEP.

The SFTP source connector fails connecting with the provided authentication credentials using SSH key. You may be using PuttyGen to generate the keys.

Resolution

Solution
First of all, make sure all the prerequisites are met:

1. Verify with your SFTP provider the type of key it is supported
a. SSH-1 vs SSH-2
b. Generated key size in bits: default is 2048

2. Authorise AEP IPs on your SFTP Provider
a. Verify the data center where your AEP instance is deployed.
i. VA7: North America
ii. NLD2: Europe
iii. AUS5: Australia
b. AEP IPs can be found in the SFTP Connector documentation.

3.  AEP supports an RSA or DSA type OpenSSH key.

The SFTP connector supports an RSA or DSA type OpenSSH key. Ensure that your key file content starts with "-----BEGIN [ RSA/DSA] PRIVATE KEY-----" and ends with "-----END [ RSA/DSA] PRIVATE KEY-----". If the private key file is a PPK-format file, use the PuTTY tool to convert from PPK to OpenSSH format.

Instructions on how to generate the keys can be found in SFTP connector: Set up a Base64-encoded OpenSSH private key for SFTP.

4. AEP requires a OpenSSH base64 encoded private key 

If you are still having problems, there may be an issue with the way the private key generated by PuttyGen is transformed.

Note that AEP requires the private key to be of OpenSSL format-encoded base64.

Once the keys are generated, you must save the private key using the (PuttyGen) menu (conversions » Export OpenSSH Key), this will generate the private key in OpenSSH format and ONLY THEN you can encode it in base64.

Since AEP requires the private key to be base64 encoded, you can either:

• Use the Encode to Base64 format tool at https://www.base64encode.org/.

or

• Use OpenSSL by issuing the following command:

openSSL base64 -in yourPrivateKeyFile -out
yourPrivateKeyFileBase64

On this page