Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
io.joynr.messaging.mqtt.hivemq.client.HivemqMqttClientCreator Maven / Gradle / Ivy
/*-
* #%L
* %%
* Copyright (C) 2022 BMW Car IT GmbH
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package io.joynr.messaging.mqtt.hivemq.client;
import com.google.inject.Inject;
import com.google.inject.name.Named;
import com.hivemq.client.mqtt.MqttClient;
import com.hivemq.client.mqtt.MqttClientExecutorConfig;
import com.hivemq.client.mqtt.MqttClientSslConfigBuilder;
import com.hivemq.client.mqtt.lifecycle.MqttClientConnectedContext;
import com.hivemq.client.mqtt.lifecycle.MqttClientConnectedListener;
import com.hivemq.client.mqtt.lifecycle.MqttClientDisconnectedContext;
import com.hivemq.client.mqtt.lifecycle.MqttClientDisconnectedListener;
import com.hivemq.client.mqtt.mqtt5.Mqtt5ClientBuilder;
import com.hivemq.client.mqtt.mqtt5.Mqtt5RxClient;
import com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5ConnAckException;
import com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5DisconnectException;
import com.hivemq.client.mqtt.mqtt5.message.connect.connack.Mqtt5ConnAck;
import com.hivemq.client.mqtt.mqtt5.message.disconnect.Mqtt5Disconnect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.UnrecoverableKeyException;
import java.security.cert.CertificateException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.concurrent.ScheduledExecutorService;
import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.KeyManagerFactory;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLEngine;
import javax.net.ssl.SSLSession;
import io.joynr.exceptions.JoynrIllegalStateException;
import io.joynr.messaging.mqtt.JoynrMqttClient;
import io.joynr.messaging.mqtt.JoynrMqttClientCreator;
import io.joynr.messaging.mqtt.MqttModule;
import io.joynr.messaging.routing.MessageRouter;
import io.joynr.statusmetrics.ConnectionStatusMetricsImpl;
import io.joynr.statusmetrics.JoynrStatusMetricsReceiver;
import io.reactivex.schedulers.Schedulers;
public class HivemqMqttClientCreator implements JoynrMqttClientCreator {
private static final Logger logger = LoggerFactory.getLogger(HivemqMqttClientCreator.class);
private final ScheduledExecutorService scheduledExecutorService;
private HashMap mqttGbidToBrokerUriMap;
private HashMap mqttGbidToKeepAliveTimerSecMap;
private HashMap mqttGbidToConnectionTimeoutSecMap;
private final boolean cleanSession;
private final JoynrStatusMetricsReceiver joynrStatusMetricsReceiver;
private final IHivemqMqttClientTrustManagerFactory trustManagerFactory;
@Inject(optional = true)
@Named(MqttModule.PROPERTY_KEY_MQTT_KEYSTORE_PATH)
private String keyStorePath;
@Inject(optional = true)
@Named(MqttModule.PROPERTY_KEY_MQTT_TRUSTSTORE_PATH)
private String trustStorePath;
@Inject(optional = true)
@Named(MqttModule.PROPERTY_KEY_MQTT_KEYSTORE_TYPE)
private String keyStoreType;
@Inject(optional = true)
@Named(MqttModule.PROPERTY_KEY_MQTT_TRUSTSTORE_TYPE)
private String trustStoreType;
@Inject(optional = true)
@Named(MqttModule.PROPERTY_KEY_MQTT_KEYSTORE_PWD)
private String keyStorePWD;
@Inject(optional = true)
@Named(MqttModule.PROPERTY_KEY_MQTT_TRUSTSTORE_PWD)
private String trustStorePWD;
@Inject(optional = true)
@Named(MqttModule.PROPERTY_KEY_MQTT_USERNAME)
private String username = "";
@Inject(optional = true)
@Named(MqttModule.PROPERTY_KEY_MQTT_PASSWORD)
private String password = "";
@Inject(optional = true)
@Named(MqttModule.PROPERTY_KEY_MQTT_DISABLE_HOSTNAME_VERIFICATION)
private Boolean disableHostnameVerification = false;
@Inject
@Named(MqttModule.MQTT_CIPHERSUITE_LIST)
private List cipherSuiteList;
@Inject
@Named(MqttModule.PROPERTY_KEY_MQTT_RECONNECT_SLEEP_MS)
private int reconnectDelayMs;
@Inject
@Named(MqttModule.PROPERTY_KEY_MQTT_RECEIVE_MAXIMUM)
private int receiveMaximum;
@Inject(optional = true)
@Named(MqttModule.PROPERTY_KEY_MQTT_RETAIN)
private Boolean retain = false;
@Inject
// CHECKSTYLE IGNORE ParameterNumber FOR NEXT 1 LINES
public HivemqMqttClientCreator(@Named(MqttModule.PROPERTY_MQTT_CLEAN_SESSION) boolean cleanSession,
@Named(MessageRouter.SCHEDULEDTHREADPOOL) ScheduledExecutorService scheduledExecutorService,
JoynrStatusMetricsReceiver joynrStatusMetricsReceiver,
@Named(MqttModule.MQTT_GBID_TO_BROKERURI_MAP) HashMap mqttGbidToBrokerUriMap,
@Named(MqttModule.MQTT_TO_KEEP_ALIVE_TIMER_SEC_MAP) HashMap mqttGbidToKeepAliveTimerSecMap,
@Named(MqttModule.MQTT_GBID_TO_CONNECTION_TIMEOUT_SEC_MAP) HashMap mqttGbidToConnectionTimeoutSecMap,
IHivemqMqttClientTrustManagerFactory trustManagerFactory) {
this.cleanSession = cleanSession;
this.scheduledExecutorService = scheduledExecutorService;
this.joynrStatusMetricsReceiver = joynrStatusMetricsReceiver;
this.mqttGbidToBrokerUriMap = (mqttGbidToBrokerUriMap != null) ? new HashMap<>(mqttGbidToBrokerUriMap) : null;
this.mqttGbidToKeepAliveTimerSecMap = (mqttGbidToKeepAliveTimerSecMap != null)
? new HashMap<>(mqttGbidToKeepAliveTimerSecMap)
: null;
this.mqttGbidToConnectionTimeoutSecMap = (mqttGbidToConnectionTimeoutSecMap != null)
? new HashMap<>(mqttGbidToConnectionTimeoutSecMap)
: null;
this.trustManagerFactory = trustManagerFactory;
}
@Override
public JoynrMqttClient createClient(String gbid,
String clientId,
boolean isReceiver,
boolean isSender,
boolean isReplyReceiver) {
URI serverUri;
try {
if (mqttGbidToBrokerUriMap.containsKey(gbid)) {
serverUri = new URI(mqttGbidToBrokerUriMap.get(gbid));
} else {
throw new JoynrIllegalStateException("Invalid GBID: " + gbid);
}
} catch (URISyntaxException e) {
throw new JoynrIllegalStateException("Invalid MQTT broker URI: " + mqttGbidToBrokerUriMap.get(gbid), e);
}
logger.info("Creating MQTT client for gbid \"{}\", uri {}, clientId {}", gbid, serverUri, clientId);
MqttClientExecutorConfig executorConfig = MqttClientExecutorConfig.builder()
.nettyExecutor(scheduledExecutorService)
.applicationScheduler(Schedulers.from(scheduledExecutorService))
.build();
assert (!isReplyReceiver || isReceiver);
ConnectionStatusMetricsImpl connectionStatusMetrics = new ConnectionStatusMetricsImpl();
connectionStatusMetrics.setGbid(gbid);
connectionStatusMetrics.setSender(isSender);
connectionStatusMetrics.setReceiver(isReceiver);
connectionStatusMetrics.setReplyReceiver(isReplyReceiver);
connectionStatusMetrics.setUrl(mqttGbidToBrokerUriMap.get(gbid));
joynrStatusMetricsReceiver.addConnectionStatusMetrics(connectionStatusMetrics);
ResubscribeHandler resubscribeHandler = new ResubscribeHandler(connectionStatusMetrics);
DisconnectedListener disconnectedListener = new DisconnectedListener(connectionStatusMetrics);
Mqtt5ClientBuilder clientBuilder = MqttClient.builder()
.useMqttVersion5()
.identifier(clientId)
.serverHost(serverUri.getHost())
.serverPort(serverUri.getPort())
// automaticReconnectWithDefaultConfig (see MqttClientAutoReconnectImpl)
// uses reconnectDelay = delay + randomDelay
// delay: startDelay: 1s, maxDelay: 120s
// randomDelay =(long) (delay / 4d / Integer.MAX_VALUE * ThreadLocalRandom.current().nextInt());
// => maxRandomDelay = 30s
// => maxReconnectDelay = 150s
.automaticReconnectWithDefaultConfig()
.addConnectedListener(resubscribeHandler)
.addDisconnectedListener(disconnectedListener)
.executorConfig(executorConfig);
if (serverUri.getScheme().equals("ssl") || serverUri.getScheme().equals("tls")
|| serverUri.getScheme().equals("mqtts")) {
clientBuilder.sslWithDefaultConfig();
setupSslConfig(clientBuilder);
}
if (username != null && !username.isEmpty() && password != null && !password.isEmpty()) {
clientBuilder.simpleAuth()
.username(username)
.password(password.getBytes(StandardCharsets.UTF_8))
.applySimpleAuth();
}
Mqtt5RxClient client = clientBuilder.buildRx();
HivemqMqttClient result = new HivemqMqttClient(client,
mqttGbidToKeepAliveTimerSecMap.get(gbid),
cleanSession,
mqttGbidToConnectionTimeoutSecMap.get(gbid),
reconnectDelayMs,
receiveMaximum,
isReceiver,
isSender,
retain,
gbid,
connectionStatusMetrics);
logger.info("Created MQTT client for gbid {}, uri {}, clientId {}: {}",
gbid,
serverUri,
clientId,
result.getClientInformationString());
resubscribeHandler.setClient(result);
disconnectedListener.setClientInformationString(result.getClientInformationString());
return result;
}
private void setupSslConfig(Mqtt5ClientBuilder clientBuilder) {
MqttClientSslConfigBuilder.Nested sslConfig = clientBuilder.sslConfig();
if (cipherSuiteList != null && cipherSuiteList.size() > 0) {
for (String cipherSuite : cipherSuiteList) {
logger.debug("Using cipher suite {}.", cipherSuite);
}
sslConfig.cipherSuites(cipherSuiteList);
} else {
List cipherSuites = getEnabledCipherSuites();
for (String cipherSuite : cipherSuites) {
logger.debug("Using cipher suite {}.", cipherSuite);
}
sslConfig.cipherSuites(cipherSuites);
}
if (trustStorePath != null && trustStorePWD != null) {
KeyStore trustStore = getKeystore(trustStorePath, trustStorePWD, trustStoreType);
logger.info("Setting up trust manager with {} / {} (password omitted)", trustStorePath, trustStoreType);
if (trustStore != null) {
try {
sslConfig.trustManagerFactory(trustManagerFactory.getTrustManagerFactory(trustStore));
if (disableHostnameVerification) {
sslConfig.hostnameVerifier(new HostnameVerifier() {
public boolean verify(String hostname, SSLSession session) {
logger.info("Skipping regular hostname verification");
return true;
}
});
logger.info("Hostname verification disabled.");
}
} catch (NoSuchAlgorithmException | KeyStoreException e) {
logger.error("Unable to create trust store factory:", e);
}
}
}
if (keyStorePath != null && keyStorePWD != null) {
logger.info("Setting up key manager with {} / {} (password omitted)", keyStorePath, keyStoreType);
KeyStore keyStore = getKeystore(keyStorePath, keyStorePWD, keyStoreType);
if (keyStore != null) {
try {
KeyManagerFactory keyManagerFactory = KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm());
keyManagerFactory.init(keyStore, keyStorePWD.toCharArray());
sslConfig.keyManagerFactory(keyManagerFactory);
} catch (NoSuchAlgorithmException | KeyStoreException | UnrecoverableKeyException e) {
logger.error("Unable to create key manager factory:", e);
}
}
}
sslConfig.applySslConfig();
}
private List getEnabledCipherSuites() {
try {
final SSLContext context = SSLContext.getInstance("TLS");
context.init(null, null, null);
final SSLEngine sslEngine = context.createSSLEngine();
return Arrays.asList(sslEngine.getEnabledCipherSuites());
} catch (Exception e) {
return Arrays.asList(new String[]{ "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" });
}
}
private KeyStore getKeystore(String storePath, String storePassword, String storeType) {
try {
KeyStore keyStore = KeyStore.getInstance(storeType == null ? KeyStore.getDefaultType() : storeType);
try (InputStream inputStream = getInputStream(storePath)) {
keyStore.load(inputStream, storePassword.toCharArray());
}
return keyStore;
} catch (SecurityException | KeyStoreException | IOException | NoSuchAlgorithmException
| CertificateException e) {
logger.error("Unable to load keystore from {} / {} (password omitted):", storePath, storeType, e);
}
return null;
}
private InputStream getInputStream(String path) throws IOException {
InputStream result = Thread.currentThread().getContextClassLoader().getResourceAsStream(path);
if (result == null) {
result = ClassLoader.getSystemClassLoader().getResourceAsStream(path);
}
if (result == null) {
File file = new File(path);
if (file.exists()) {
result = new FileInputStream(file);
}
}
if (result == null) {
try {
URL url = new URL(path);
result = url.openStream();
} catch (MalformedURLException e) {
logger.debug("Attempt to interpret {} as URL failed. Ignoring.", path);
}
}
return result;
}
static class ResubscribeHandler implements MqttClientConnectedListener {
private HivemqMqttClient client;
private ConnectionStatusMetricsImpl connectionStatusMetrics;
void setClient(HivemqMqttClient client) {
this.client = client;
}
public ResubscribeHandler(ConnectionStatusMetricsImpl connectionStatusMetrics) {
this.connectionStatusMetrics = connectionStatusMetrics;
}
@Override
public void onConnected(MqttClientConnectedContext context) {
client.resubscribe();
connectionStatusMetrics.setConnected(true);
}
}
static class DisconnectedListener implements MqttClientDisconnectedListener {
private String clientInformation;
private ConnectionStatusMetricsImpl connectionStatusMetrics;
DisconnectedListener(ConnectionStatusMetricsImpl connectionStatusMetrics) {
this.connectionStatusMetrics = connectionStatusMetrics;
}
void setClientInformationString(String clientInformation) {
this.clientInformation = clientInformation;
}
@Override
public void onDisconnected(MqttClientDisconnectedContext context) {
Throwable cause = context.getCause();
logger.info("{}: HiveMQ MQTT client disconnected: source: {}{}",
clientInformation,
context.getSource(),
getCauseMessage(cause),
cause);
connectionStatusMetrics.setConnected(false);
connectionStatusMetrics.increaseConnectionDrops();
}
private String getCauseMessage(Throwable cause) {
String message = "";
if (cause instanceof Mqtt5DisconnectException) {
Mqtt5DisconnectException disconnectException = (Mqtt5DisconnectException) cause;
Mqtt5Disconnect disconnect = disconnectException.getMqttMessage();
message = ", " + disconnect;
} else if (cause instanceof Mqtt5ConnAckException) {
Mqtt5ConnAckException mqtt5ConnAckException = (Mqtt5ConnAckException) cause;
Mqtt5ConnAck connAck = mqtt5ConnAckException.getMqttMessage();
message = ", " + connAck;
}
return message;
}
}
}
