com.hivemq.spi.security

Interface ProxyInformation

public interface ProxyInformation

This class encapsulates all information that is forwarded by a load balancer which uses the PROXY protocol. Except from the source connection information and the load balancer information, most of the values are optional.

HiveMQ supports arbitrary TLVs which can be retrieved as raw TLV values (see rawTLVs())

Since:

3.2

Author:

Dominik Obermaier

Method Summary

Methods

Modifier and Type	Method and Description
InetAddress	proxyAddress() Returns the address of the load balancer that is used to proxy the client connection.
int	proxyPort() Returns the port of the load balancer that is used to proxy the client connection.
com.google.common.collect.ImmutableMap<Byte,byte[]>	rawTLVs() HiveMQ supports arbitrary TLVs, even TLVs that aren't specified by the PROXY protocol.
InetAddress	sourceAddress() Returns the original source address of the MQTT client.
int	sourcePort() Return the original source port of the MQTT client.
com.google.common.base.Optional<String>	sslCertificateCN() If the PROXY protocol implementation of the load balancer supports TLVs and proxies a SSL connection with a X509 client certificate that is sent by the MQTT client, this method returns the forwarded common name of the X509 client certificate (if the client used one to authenticate the SSL connection).
com.google.common.base.Optional<String>	tlsVersion() If the PROXY protocol implementation of the load balancer supports TLVs and proxies a SSL connection, this method returns the TLS version of the original SSL connection

Method Detail

sourcePort

int sourcePort()

Return the original source port of the MQTT client.

Returns:

the original source port of the MQTT client.

sourceAddress

InetAddress sourceAddress()

Returns the original source address of the MQTT client.

Returns:

the original source address of the MQTT client.

proxyPort

int proxyPort()

Returns the port of the load balancer that is used to proxy the client connection.

Returns:

the port of the load balancer that is used to proxy the client connection.

proxyAddress

InetAddress proxyAddress()

Returns the address of the load balancer that is used to proxy the client connection.

Returns:

the address of the load balancer that is used to proxy the client connection.

tlsVersion

com.google.common.base.Optional<String> tlsVersion()

If the PROXY protocol implementation of the load balancer supports TLVs and proxies a SSL connection, this method returns the TLS version of the original SSL connection

Returns:

an Optional that contains the original TLS version if supported by the load balancer

sslCertificateCN

com.google.common.base.Optional<String> sslCertificateCN()

If the PROXY protocol implementation of the load balancer supports TLVs and proxies a SSL connection with a X509 client certificate that is sent by the MQTT client, this method returns the forwarded common name of the X509 client certificate (if the client used one to authenticate the SSL connection).

Returns:

an Optional that contains the Common Name of the X509 client certificate

rawTLVs

com.google.common.collect.ImmutableMap<Byte,byte[]> rawTLVs()

HiveMQ supports arbitrary TLVs, even TLVs that aren't specified by the PROXY protocol. This map contains all the raw TLVs that are sent by the load balancer.

The key is the byte value of the TLV type and the value is the raw TLV as byte value.

Returns:

a Map with raw TLVs