#67+#141 Implement Authentication Service and DB versioning with Flyway

acl-service/src/main/java/javasabr/mqtt/acl/service/AclEngineBasedAuthorizationService.java

@@ -26,7 +26,7 @@ public boolean authorizeSubscribe(MqttUser user, TopicFilter topicFilter) {
   }
 
   // we know that writing this to not volatile field will not apply it for all threads immediately,
-  // but for us it's not critical comparing to cost of reading volatile field
+  // but for us, it's not critical comparing to cost of reading volatile field
   protected synchronized void switchTo(AclEngine newEngine) {
     this.engine = newEngine;
   }

application/build.gradle

@@ -11,12 +11,15 @@ dependencies {
   implementation projects.coreService
   implementation projects.aclService
   implementation projects.aclGroovyDsl
+  implementation projects.authenticationService
   implementation libs.rlib.logger.slf4j
   implementation libs.springboot.starter.core
   implementation libs.springboot.starter.log4j2
 
   testImplementation projects.testSupport
   testImplementation testFixtures(projects.network)
+  testImplementation projects.credentialsSourceFile
+  testImplementation projects.authenticationProviderBasic
 }
 
 tasks.withType(GroovyCompile).configureEach {

application/src/main/java/javasabr/mqtt/broker/application/config/MqttBrokerSpringConfig.java

@@ -3,6 +3,8 @@
 import java.net.InetSocketAddress;
 import java.util.Collection;
 import javasabr.mqtt.acl.service.conifg.GroovyDslBasedAclServiceSpringConfig;
+import javasabr.mqtt.auth.api.AuthenticationService;
+import javasabr.mqtt.auth.service.config.AuthenticationServiceSpringConfig;
 import javasabr.mqtt.model.MqttProperties;
 import javasabr.mqtt.model.MqttServerConnectionConfig;
 import javasabr.mqtt.model.QoS;
@@ -11,11 +13,9 @@
 import javasabr.mqtt.network.handler.NetworkMqttUserReleaseHandler;
 import javasabr.mqtt.network.impl.ExternalNetworkMqttUser;
 import javasabr.mqtt.network.user.NetworkMqttUserFactory;
-import javasabr.mqtt.service.AuthenticationService;
 import javasabr.mqtt.service.AuthorizationService;
 import javasabr.mqtt.service.ClientIdRegistry;
 import javasabr.mqtt.service.ConnectionService;
-import javasabr.mqtt.service.CredentialSource;
 import javasabr.mqtt.service.MessageOutFactoryService;
 import javasabr.mqtt.service.PublishDeliveringService;
 import javasabr.mqtt.service.PublishReceivingService;
@@ -31,11 +31,9 @@
 import javasabr.mqtt.service.impl.DefaultTopicService;
 import javasabr.mqtt.service.impl.DisabledAuthorizationService;
 import javasabr.mqtt.service.impl.ExternalNetworkMqttUserFactory;
-import javasabr.mqtt.service.impl.FileCredentialsSource;
 import javasabr.mqtt.service.impl.InMemoryClientIdRegistry;
 import javasabr.mqtt.service.impl.InMemoryRetainMessageService;
 import javasabr.mqtt.service.impl.InMemorySubscriptionService;
-import javasabr.mqtt.service.impl.SimpleAuthenticationService;
 import javasabr.mqtt.service.message.handler.MqttInMessageHandler;
 import javasabr.mqtt.service.message.handler.impl.ConnectInMqttInMessageHandler;
 import javasabr.mqtt.service.message.handler.impl.DisconnectMqttInMessageHandler;
@@ -75,6 +73,7 @@
 import org.springframework.core.env.Environment;
 
 @Import({
+    AuthenticationServiceSpringConfig.class,
     GroovyDslBasedAclServiceSpringConfig.class
 })
 @CustomLog
@@ -101,22 +100,9 @@ MqttSessionService mqttSessionService(
     return new InMemoryMqttSessionService(cleanInterval);
   }
 
-  @Bean
-  CredentialSource credentialSource(
-      @Value("${credentials.source.file.name:credentials}") String fileName) {
-    return new FileCredentialsSource(fileName);
-  }
-
-  @Bean
-  AuthenticationService authenticationService(
-      CredentialSource credentialSource,
-      @Value("${authentication.allow.anonymous:false}") boolean allowAnonymousAuth) {
-    return new SimpleAuthenticationService(credentialSource, allowAnonymousAuth);
-  }
-
   @Bean
   @ConditionalOnProperty(
-      name = "acl.engine.type", 
+      name = "acl.engine.type",
       havingValue = "disabled", 
       matchIfMissing = true)
   AuthorizationService authorizationService() {
@@ -178,7 +164,7 @@ MqttInMessageHandler publishAckMqttInMessageHandler(MessageOutFactoryService mes
   MqttInMessageHandler publishCompleteMqttInMessageHandler(MessageOutFactoryService messageOutFactoryService) {
     return new PublishCompleteMqttInMessageHandler(messageOutFactoryService);
   }
-  
+
   @Bean
   MqttInMessageHandler publishMqttInMessageHandler(
       PublishReceivingService publishReceivingService,

application/src/main/resources/application.properties

@@ -1,2 +1 @@
-authentication.allow.anonymous=false
-credentials.source.file.name=credentials
+authentication.provider.anonymous.enabled=false

application/src/test/groovy/javasabr/mqtt/broker/application/ConnectSubscribePublishTest.groovy

@@ -13,6 +13,8 @@ import com.hivemq.client.mqtt.mqtt5.message.subscribe.suback.Mqtt5SubAckReasonCo
 
 import java.util.concurrent.CompletableFuture
 
+import static javasabr.mqtt.broker.application.MqttClientFactory.generateClientId
+
 class ConnectSubscribePublishTest extends IntegrationSpecification {
 
   def "should deliver publish message QoS 0 using mqtt 3.1.1"() {

application/src/test/groovy/javasabr/mqtt/broker/application/ExternalConnectionTest.groovy

@@ -5,14 +5,8 @@ import com.hivemq.client.mqtt.mqtt3.message.connect.connack.Mqtt3ConnAckReturnCo
 import com.hivemq.client.mqtt.mqtt5.exceptions.Mqtt5ConnAckException
 import com.hivemq.client.mqtt.mqtt5.message.connect.connack.Mqtt5ConnAckReasonCode
 import javasabr.mqtt.model.MqttProperties
-import javasabr.mqtt.model.QoS
-import javasabr.mqtt.model.reason.code.ConnectAckReasonCode
-import javasabr.mqtt.network.message.in.ConnectAckMqttInMessage
-import javasabr.mqtt.network.message.out.ConnectMqtt311OutMessage
-import javasabr.rlib.common.util.ArrayUtils
 import spock.lang.Ignore
 
-import java.nio.charset.StandardCharsets
 import java.util.concurrent.CompletionException
 
 class ExternalConnectionTest extends IntegrationSpecification {
@@ -139,33 +133,7 @@ class ExternalConnectionTest extends IntegrationSpecification {
         cause.mqttMessage.returnCode == Mqtt3ConnAckReturnCode.BAD_USER_NAME_OR_PASSWORD
   }
 
-  @Ignore
-  def "client should not connect to broker without username and with pass using MQTT 3.1.1"() {
-    given:
-        def client = buildMqtt311MockClient()
-        def clientId = generateClientId()
-    when:
-
-        client.connect()
-        client.send(new ConnectMqtt311OutMessage(
-            "",
-            "",
-            clientId,
-            "wrongPassword".getBytes(StandardCharsets.UTF_8),
-            ArrayUtils.EMPTY_BYTE_ARRAY,
-            QoS.AT_MOST_ONCE,
-            keepAlive,
-            false,
-            false
-        ))
-
-        def connectAck = client.readNext() as ConnectAckMqttInMessage
-
-    then:
-        connectAck.reasonCode == ConnectAckReasonCode.BAD_USER_NAME_OR_PASSWORD
-  }
-
-  def "client should not connect to broker with wrong pass using MQTT 5"() {
+  def "client should not connect to broker with wrong pass using mqtt 5"() {
     given:
         def client = buildExternalMqtt5Client()
     when:

application/src/test/groovy/javasabr/mqtt/broker/application/IntegrationSpecification.groovy

@@ -1,6 +1,5 @@
 package javasabr.mqtt.broker.application
 
-import com.hivemq.client.mqtt.MqttClient
 import com.hivemq.client.mqtt.mqtt3.Mqtt3AsyncClient
 import com.hivemq.client.mqtt.mqtt5.Mqtt5AsyncClient
 import javasabr.mqtt.broker.application.config.MqttBrokerTestConfig
@@ -17,7 +16,6 @@ import org.springframework.test.context.TestPropertySource
 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig
 
 import java.nio.charset.StandardCharsets
-import java.util.concurrent.atomic.AtomicInteger
 import java.util.concurrent.atomic.AtomicReference
 
 @TestPropertySource("classpath:application-test.properties")
@@ -30,74 +28,30 @@ class IntegrationSpecification extends BaseSpecification {
   public static final clientId = "testClientId"
   public static final keepAlive = 120
 
-  private static final idGenerator = new AtomicInteger(1)
-
   @Autowired
   InetSocketAddress externalNetworkAddress
 
   @Autowired
   MqttServerConnectionConfig externalConnectionConfig
 
   def buildExternalMqtt311Client() {
-    return buildMqtt311Client(generateClientId(), externalNetworkAddress)
+    return buildExternalMqtt311Client(generateClientId())
   }
 
   def buildExternalMqtt5Client() {
-    return buildMqtt5Client(generateClientId(), externalNetworkAddress)
+    return buildExternalMqtt5Client(generateClientId())
   }
 
   def buildExternalMqtt311Client(String clientId) {
-    return MqttClient.builder()
-        .identifier(clientId)
-        .serverHost(externalNetworkAddress.getHostName())
-        .serverPort(externalNetworkAddress.getPort())
-        .useMqttVersion3()
-        .build()
-        .toAsync()
-  }
-
-  def buildMqtt311Client(String clientId, InetSocketAddress address) {
-    return MqttClient.builder()
-        .identifier(clientId)
-        .serverHost(address.getHostName())
-        .serverPort(address.getPort())
-        .useMqttVersion3()
-        .addDisconnectedListener {
-          println "[${clientId}|mqtt311] disconnected:[${it.cause.message}]"
-        }
-        .build()
-        .toAsync()
+    return MqttClientFactory.buildMqtt311Client(clientId, externalNetworkAddress)
   }
 
   def buildExternalMqtt5Client(String clientId) {
-    return MqttClient.builder()
-        .identifier(clientId)
-        .serverHost(externalNetworkAddress.getHostName())
-        .serverPort(externalNetworkAddress.getPort())
-        .useMqttVersion5()
-        .build()
-        .toAsync()
-  }
-
-  def buildMqtt5Client(String clientId, InetSocketAddress address) {
-    return MqttClient.builder()
-        .identifier(clientId)
-        .serverHost(address.getHostName())
-        .serverPort(address.getPort())
-        .useMqttVersion5()
-        .addDisconnectedListener {
-          println "[${clientId}|mqtt5] disconnected:[${it.cause.message}]"
-        }
-        .build()
-        .toAsync()
+    return MqttClientFactory.buildMqtt5Client(clientId, externalNetworkAddress)
   }
 
   def generateClientId() {
-    return generateClientId("Default")
-  }
-
-  def generateClientId(String prefix) {
-    return prefix + "_" + idGenerator.incrementAndGet()
+    return MqttClientFactory.generateClientId("Default")
   }
 
   def connectWith(Mqtt3AsyncClient client, String user, String pass) {

application/src/test/groovy/javasabr/mqtt/broker/application/MqttClientFactory.groovy

@@ -0,0 +1,42 @@
+package javasabr.mqtt.broker.application
+
+import com.hivemq.client.mqtt.MqttClient
+import com.hivemq.client.mqtt.mqtt3.Mqtt3AsyncClient
+import com.hivemq.client.mqtt.mqtt5.Mqtt5AsyncClient
+
+import java.util.concurrent.atomic.AtomicInteger
+
+class MqttClientFactory {
+
+  private static final ID_GENERATOR = new AtomicInteger(1)
+
+  static Mqtt5AsyncClient buildMqtt5Client(String clientId, InetSocketAddress address) {
+    return MqttClient.builder()
+        .identifier(clientId)
+        .serverHost(address.getHostName())
+        .serverPort(address.getPort())
+        .useMqttVersion5()
+        .addDisconnectedListener {
+          println "[${clientId}|mqtt5] disconnected:[${it.cause.message}]"
+        }
+        .build()
+        .toAsync()
+  }
+
+  static Mqtt3AsyncClient buildMqtt311Client(String clientId, InetSocketAddress address) {
+    return MqttClient.builder()
+        .identifier(clientId)
+        .serverHost(address.getHostName())
+        .serverPort(address.getPort())
+        .useMqttVersion3()
+        .addDisconnectedListener {
+          println "[${clientId}|mqtt311] disconnected:[${it.cause.message}]"
+        }
+        .build()
+        .toAsync()
+  }
+
+  static String generateClientId(String prefix) {
+    return prefix + "_" + ID_GENERATOR.incrementAndGet()
+  }
+}

application/src/test/groovy/javasabr/mqtt/broker/application/PublishRetryTest.groovy

@@ -24,6 +24,8 @@ import javasabr.mqtt.service.session.MqttSessionService
 import javasabr.rlib.collections.array.Array
 import org.springframework.beans.factory.annotation.Autowired
 
+import static javasabr.mqtt.broker.application.MqttClientFactory.generateClientId
+
 class PublishRetryTest extends IntegrationSpecification {
 
   private static final int testSessionExpiryIntervalInSecs = 120

application/src/test/groovy/javasabr/mqtt/broker/application/config/MqttBrokerTestConfig.groovy

@@ -1,3 +1,4 @@
+//file:noinspection SpringJavaInjectionPointsAutowiringInspection
 package javasabr.mqtt.broker.application.config
 
 import javasabr.mqtt.network.MqttConnection
@@ -12,7 +13,7 @@ import org.springframework.context.annotation.Import
 import java.util.concurrent.ThreadLocalRandom
 
 @Import([
-    MqttBrokerSpringConfig,
+    MqttBrokerSpringConfig
 ])
 @Configuration(proxyBeanMethods = false)
 class MqttBrokerTestConfig {
@@ -25,7 +26,7 @@ class MqttBrokerTestConfig {
       try {
         externalNetwork.start(address)
         return address;
-      } catch (RuntimeException e) {
+      } catch (RuntimeException ignored) {
       }
     }
     throw new RuntimeException()
@@ -41,6 +42,6 @@ class MqttBrokerTestConfig {
                             ConnectionService connectionService,
                             InetSocketAddress externalNetworkAddress) {
     externalNetwork.onAccept(connectionService::processAcceptedConnection);
-    return null;
+    return null
   }
 }

application/src/test/resources/application-test.properties

@@ -1,5 +1,9 @@
-authentication.allow.anonymous=true
-credentials.source.file.name=credentials-test
+authentication.provider.default.method=basic
+authentication.provider.anonymous.enabled=true
+authentication.provider.basic.enabled=true
+authentication.credentials-source.file.enabled=true
+authentication.credentials-source.file.path=classpath:auth/credentials-test
+
 mqtt.external.connection.shared.subscription.available=true
 mqtt.external.connection.wildcard.subscription.available=true
 

application/src/test/resources/auth/credentials-test

@@ -0,0 +1,2 @@
+user=correct-password
+user1=password

authentication-api/build.gradle

@@ -0,0 +1,14 @@
+plugins {
+  id("java-library")
+  id("configure-java")
+  id("groovy")
+}
+
+description = "Authentication API"
+
+dependencies {
+  api projects.base
+
+  testImplementation projects.testSupport
+  testFixturesApi projects.testSupport
+}