Two-Factor Auth Account

In this article

Overview

Use this account type to connect Binary Snaps with data sources that use Two-Factor Auth accounts. This account supports two factor authentication (2FA) for Security File Transfer Protocol (SFTP) to access SFTP. It uses two separate security layers of verification to grant access that include the Basic Auth (username/password) and the SSH Key (username/private key) methods.

Prerequisites

  • Target FTP should be enabled with Two-Factor authentication.
  • Valid username/password and SSH key with passphrase.

Limitations and Known Issues

None.

Account Settings

  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ( ): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ( ): Indicates that you can add fields in the fieldset.

  • Remove icon (): Indicates that you can remove fields from the fieldset.


Field NameField TypeDescription

Label*


Default Value: N/A
Example
SFTP_2FA_Auth

String

Enter a unique label for the account.

Username*


Default Value: N/A
Example
:user@snaplogic.com

String/Expression

Enter a username for SSH authentication.

Password*


Default Value: N/A
Example:
 m!ster18Gu@rd8!keip

String/ExpressionEnter a password associated with the supplied account username.

Private key*


Default Value: N/A
Example
admin_passphrase.key

String/Expression

Enter the private key part of SSH authentication. You can also upload the private key file to the SLDB by clicking the Upload  icon

You can generate a private key using any SSH key generator. See Generate SSH Key Using PuTTY Key Generator for more information.

Acceptable File Paths

  • Relative paths

    • filename.json: Saves the file in the project.

    • ../shared/filename.json: Saves the file in the Project Shared Space.

    • ../../shared/filename.json: Saves the files in the Org Shared project.

  • Absolute path

    • /<org>/<projectSpace>/<project>/filename.json

Lint Warning

The Snap displays a Lint Warning in your Pipeline in the following scenarios:

  • INCORRECT_FILE_PATH: When you provide an incorrect file path to write a file, such as not following the given relative paths pattern or absolute path patterns.

  • INCORRECT_ORG_PATHWhen you create files or directories in a different org other than the one where the Pipeline is executing.

Therefore, we recommend that you:

  • confirm to any of the acceptable relative paths. Otherwise, use an absolute path, that is provide a file path that belongs to the same org where you want to write the file, OR
  • use the File Upload icon to specify the File path.

Key Passphrase*


Default Value: N/A
Example
p@$$zk!98

String/ExpressionEnter the passphrase used to decrypt the private key.

Account Encryption

Standard Encryption

If you are using Standard Encryption, follow the High sensitivity settings under Enhanced Encryption.

Enhanced Encryption

If the account you are using has the Enhanced Encryption feature, the account fields are encrypted for each sensitivity level as shown below:

  • High: Key passphrase
  • Medium + High: Username, Key passphrase
  • Low + Medium + High: Username, Private key, Key passphrase

Generating SSH Key Using PuTTY Key Generator

You can download the PuTTYgen application for Windows using this link.

  1. Open the PuTTYgen application.


  2. Choose SSH-1 (RSA) key type under Parameters.
  3. Enter the required value in the Number of bits in a generate key field. (Default: 2048)
  4. Click Generate that is adjacent to Generate a public/private key pair under Actions.

    The PuTTY Key Generator uses mouse movements to generate a unique secure key. Move the mouse around till the progress bar fills up completely.


    The utility generates the public and private keys.

  5. Provide values in the Key comment and Key passphrase fields as required.
  6. Click Save public key and Save private key to save the private and public key (PPK) files to a secure and private location.
  7. Send the Public Key to the SFTP host.
  8. Store the keys and passphrase into the password/key vault.

The PuTTY Key Generator uses the PPK format for keys. If your SFTP client requires a standard OpenSSH key format, export the key by using Export OpenSSH Key on the Conversions menu.