Skip to content

NIFI-7835 Add authenticated SOCKS and HTTP proxy support for SFTP#5624

Closed
exceptionfactory wants to merge 1 commit intoapache:mainfrom
exceptionfactory:NIFI-7835
Closed

NIFI-7835 Add authenticated SOCKS and HTTP proxy support for SFTP#5624
exceptionfactory wants to merge 1 commit intoapache:mainfrom
exceptionfactory:NIFI-7835

Conversation

@exceptionfactory
Copy link
Copy Markdown
Contributor

Description of PR

NIFI-7835 Adds support for accessing SFTP servers through SOCKS 5 proxy servers that require authentication. Support for authenticated proxy server access also applies to HTTP proxy servers, resolving NIFI-7749.

NiFi SFTP components use SSHJ since version 1.10.0. SSHJ does not provide direct support for authenticated proxy server access, and the current NiFi implementation supports SOCKS and HTTP proxy access without authentication using a custom ProxySocketFactory. The java.net.Authenticator class does not support providing proxy username and password credentials for single instances of java.net.Proxy, instead requiring the use an Authenticator instance for the entire JVM using the Authenticator.setDefault() method. This approach is not suitable for NiFi components that may require different sets of credentials for different component instances.

This pull request integrates the BrokeredSocketFactory from the socketbroker library to support authenticated access to SOCKS and HTTP proxy servers from NiFi SFTP components.

Runtime configurations can be tested using proxy servers that implement standard SOCKS 5 and HTTP CONNECT protocols. The following open source proxy servers can be configured with authentication for testing:

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced
    in the commit message?

  • Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

  • Has your PR been rebased against the latest commit within the target branch (typically main)?

  • Is your initial contribution a single, squashed commit? Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not squash or use --force when pushing to allow for clean monitoring of changes.

For code changes:

  • Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
  • Have you written or updated unit tests to verify your changes?
  • Have you verified that the full build is successful on JDK 8?
  • Have you verified that the full build is successful on JDK 11?
  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
  • If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
  • If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check GitHub Actions CI for build issues and submit an update to your PR as soon as possible.

NIFI-7749 Added authenticated HTTP proxy support for SFTP

- Added StandardSocketFactoryProvider to return SocketFactory based on credentials
Copy link
Copy Markdown
Contributor

@greyp9 greyp9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really useful enhancement to the SFTP processors!

Tested ListSFTP and FetchSFTP using squid (installed) for HTTP proxy and dante (Docker image) for SOCKS proxy, using proxy user name / password configuration. Also checked ability of user/pass proxy to interoperate with SSH pubkey authentication; no problems there. Code looks great.

Congrats on your socketbroker distributable!

Copy link
Copy Markdown
Contributor

@gresockj gresockj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this contribution, @exceptionfactory! I don't have any problems with the code.
Given @greyp9 's runtime testing, I'll go ahead and merge.

@asfgit asfgit closed this in 64495e9 Jan 12, 2022
asfgit pushed a commit that referenced this pull request Jan 12, 2022
NIFI-7749 Added authenticated HTTP proxy support for SFTP

- Added StandardSocketFactoryProvider to return SocketFactory based on credentials

Signed-off-by: Joe Gresock <jgresock@gmail.com>

This closes #5624.
krisztina-zsihovszki pushed a commit to krisztina-zsihovszki/nifi that referenced this pull request Jun 28, 2022
NIFI-7749 Added authenticated HTTP proxy support for SFTP

- Added StandardSocketFactoryProvider to return SocketFactory based on credentials

Signed-off-by: Joe Gresock <jgresock@gmail.com>

This closes apache#5624.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants