Paho client doesn't support custom headers for MQTT connection over WebSockets

[vit21ik]

When you need connection to MQTT broker using WebSockets, paho client sets default headers:

pw.print("Upgrade: websocket" + LINE_SEPARATOR);
pw.print("Connection: Upgrade" + LINE_SEPARATOR);
pw.print("Sec-WebSocket-Key: " + key + LINE_SEPARATOR);
pw.print("Sec-WebSocket-Protocol: mqtt" + LINE_SEPARATOR);
pw.print("Sec-WebSocket-Version: 13" + LINE_SEPARATOR);

In some cases required send custom headers, for example if you wanted to connect to AWS Iot broker.
https://docs.aws.amazon.com/iot/latest/developerguide/custom-auth.html

It would be great add custom headers support to WebSocket handshake request.

• Bug exists Release Version 1.2.0 ( Master Branch)
• Bug exists in Snapshot Version 1.2.1-SNAPSHOT (Develop Branch)
• Bug exists in MQTTv5 Version (mqttv5-new Branch)

If this is a bug regarding the Android Service, please raise the bug here instead: https://github.com/eclipse/paho.mqtt.android/issues/new

[vit21ik]

Actually I did this changes in my forked repository - vit21ik@7df2eaa

I could create merge request to develop branch.

[jpwsutton]

Thanks for the pull request, once we merge it would you mind if I ported your changes over to our new MQTTv5 client?

[davidgraeff]

Eclipse Smarthome would use this as well. A near term release including this could help our current mqtt ambitions.

[vit21ik]

Added custom headers to mqtt v5

[davidgraeff]

Can be closed, can't it?

[desokroshan]

@jpwsutton Is there a way to consume these changes via gradle?

[aniket91]

How do I use this feature? I used the latest dependency in maven-


org.eclipse.paho
org.eclipse.paho.client.mqttv3
1.2.0

But I do not see an option to set custom headers.

[desokroshan]

You can build the jar file from the develop branch as mentioned here and add it to your classpath. These changes will be available as part of 1.3.0 which is overdue.

[JacquesSmuts]

It is now available in version 1.2.1 and you implement it like so:

MqttClient client = new MqttClient("wss://<BROKER_URI>", "MyClient");
MqttConnectOptions connectOptions = new MqttConnectOptions();
Properties properties = new Properties();
properties.setProperty("X-Amz-CustomAuthorizer-Name", <SOME_VALUE>);
properties.setProperty("X-Amz-CustomAuthorizer-Signature", <SOME_VALUE>);
properties.setProperty(<SOME_VALUE>, <SOME_VALUE>);
connectOptions.setCustomWebSocketHeaders(properties);
client.connect(connectOptions);

[rrmorey]

It is now available in version 1.2.1 and you implement it like so:

MqttClient client = new MqttClient("wss://<BROKER_URI>", "MyClient");
MqttConnectOptions connectOptions = new MqttConnectOptions();
Properties properties = new Properties();
properties.setProperty("X-Amz-CustomAuthorizer-Name", <SOME_VALUE>);
properties.setProperty("X-Amz-CustomAuthorizer-Signature", <SOME_VALUE>);
properties.setProperty(<SOME_VALUE>, <SOME_VALUE>);
connectOptions.setCustomWebSocketHeaders(properties);
client.connect(connectOptions);

How can we retrieve the headers on the subscriber side?