diff options
author | Loïc Hoguin <[email protected]> | 2018-10-23 12:10:53 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2018-10-23 12:10:53 +0200 |
commit | d2720842a63dc7bc6ac01d9e2866bfa78cb39aa5 (patch) | |
tree | be72af8e3dc7f40eff2302b739541feb61ce69d2 /src/ranch_ssl.erl | |
parent | 8652000c0c40feee8f664b58ccb5cdfa60441a5f (diff) | |
download | ranch-d2720842a63dc7bc6ac01d9e2866bfa78cb39aa5.tar.gz ranch-d2720842a63dc7bc6ac01d9e2866bfa78cb39aa5.tar.bz2 ranch-d2720842a63dc7bc6ac01d9e2866bfa78cb39aa5.zip |
Add ranch:recv_proxy_header/2
This is the function that should be called regardless of
TCP or TLS being used. The proper usage for this function is:
{ok, ProxyInfo} = ranch:recv_proxy_header(Ref, Timeout),
{ok, Socket} = ranch:handshake(Ref),
...
Ranch takes care of everything else under the hood. Transports
now need to have a Transport:recv_proxy_header/2 function. For
ranch_ssl the function gets the port from the sslsocket() record
and then calls ranch_tcp:recv_proxy_header/2 with it.
This means that two undocumented features are currently used for
this, but the interface is really nice so that's a sacrifice
worth doing. Also worth noting is that OTP 22 should have an
alternative for gen_tcp:unrecv/2 so the only real issue is about
the sslsocket() record at the moment.
Diffstat (limited to 'src/ranch_ssl.erl')
-rw-r--r-- | src/ranch_ssl.erl | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/src/ranch_ssl.erl b/src/ranch_ssl.erl index b232039..03eb5ee 100644 --- a/src/ranch_ssl.erl +++ b/src/ranch_ssl.erl @@ -30,6 +30,7 @@ -export([connect/3]). -export([connect/4]). -export([recv/3]). +-export([recv_proxy_header/2]). -export([send/2]). -export([sendfile/2]). -export([sendfile/4]). @@ -169,6 +170,19 @@ connect(Host, Port, Opts, Timeout) when is_integer(Port) -> recv(Socket, Length, Timeout) -> ssl:recv(Socket, Length, Timeout). +-spec recv_proxy_header(ssl:sslsocket(), timeout()) + -> {ok, ranch_proxy_header:proxy_info()} + | {error, closed | atom()} + | {error, protocol_error, atom()}. +recv_proxy_header(SSLSocket, Timeout) -> + %% There's currently no documented way to perform a TCP recv + %% on an sslsocket(), even before the TLS handshake. However + %% nothing prevents us from retrieving the TCP socket and using + %% it. Since it's an undocumented interface this may however + %% make forward-compatibility more difficult. + {sslsocket, {gen_tcp, TCPSocket, _, _}, _} = SSLSocket, + ranch_tcp:recv_proxy_header(TCPSocket, Timeout). + -spec send(ssl:sslsocket(), iodata()) -> ok | {error, atom()}. send(Socket, Packet) -> ssl:send(Socket, Packet). |