feat: Add PROXY protocol#44
Open
donovanhubbard wants to merge 3 commits into
Open
Conversation
Author
|
The CI isn't going to work with this because of the go version upgrade, and I'm not sure how you want to handle that. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CONTRIBUTING.md.In 2011 the people working on HA Proxy developed what would be known as the PROXY protocol. This solved the problem of how upstream load balancers and proxies could pass information about the original client's IP address and port to the backend server.
In order to take advantage of the PROXY protocol, the load balancer must send the PROXY header and the backend server needs to be able to read the header. The protocol is supported by a wide variety of load balancers including:
HA Proxy
nginx
Amazon Application Load Balancers
Traefik
Envoy
Cloudflare
This pull request adds support for the PROXY protocol to the ssh server via a new option called EnableProxyProtocol. An example has been included in the _examples directory.
This is accomplished through the https://github.com/pires/go-proxyproto library. It replaces the information returned by the ssh.Session object's RemoteAdd() function with the requestor's original IP address and port and not the load balancer's load balancer and port which is what would be displayed without this protocol.
This was discussed in #43
It's a fairly simple code change. I've been running my own fork of this for several weeks with no problems.
However, the package I'm using has a minimum supported go version of
1.25which is a change from the forks current version of1.23. For reference go1.24ended support in Feb 11, 2026. I don't know if that will be a problem for you or not.