Moves DDI artifacts into a dedicated directory/artifact parent (#2002)

Signed-off-by: Avgustin Marinov <Avgustin.Marinov@bosch.com>

hawkbit-ddi/hawkbit-ddi-server/src/main/java/org/eclipse/hawkbit/app/ddi/DDIStart.java

@@ -0,0 +1,56 @@
+/**
+ * Copyright (c) 2015 Bosch Software Innovations GmbH and others
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.eclipse.hawkbit.app.ddi;
+
+import org.eclipse.hawkbit.autoconfigure.security.EnableHawkbitManagedSecurityConfiguration;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.servlet.mvc.support.RedirectAttributes;
+import org.springframework.web.servlet.view.RedirectView;
+
+/**
+ * A {@link SpringBootApplication} annotated class with a main method to start.
+ * The minimal configuration for the stand alone hawkBit DDI server.
+ */
+@SpringBootApplication(scanBasePackages = "org.eclipse.hawkbit")
+@EnableHawkbitManagedSecurityConfiguration
+public class DDIStart {
+
+    /**
+     * Main method to start the spring-boot application.
+     *
+     * @param args the VM arguments.
+     */
+    public static void main(final String[] args) {
+        SpringApplication.run(DDIStart.class, args);
+    }
+
+    @Controller
+    public static class RedirectController {
+
+        @GetMapping("/")
+        public RedirectView redirectToSwagger(
+                RedirectAttributes attributes) {
+            attributes.addFlashAttribute("flashAttribute", "redirectWithRedirectView");
+            attributes.addAttribute("attribute", "redirectWithRedirectView");
+            return new RedirectView("swagger-ui/index.html");
+        }
+    }
+
+    @Configuration
+    @EnableGlobalMethodSecurity(prePostEnabled = true, securedEnabled = true, proxyTargetClass = true)
+    public static class MethodSecurityConfig {
+
+    }
+}

hawkbit-ddi/hawkbit-ddi-server/src/main/resources/application-db2.properties

@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2019 Bosch Software Innovations GmbH and others
+#
+# This program and the accompanying materials are made
+# available under the terms of the Eclipse Public License 2.0
+# which is available at https://www.eclipse.org/legal/epl-2.0/
+#
+# SPDX-License-Identifier: EPL-2.0
+#
+
+# This profile adds basic configurations for a DB2 DB usage.
+# Keep in mind that you need the DB2 driver in your classpath on compile.
+# see https://www.eclipse.org/hawkbit/guides/runhawkbit/
+
+spring.jpa.database=DB2
+spring.datasource.url=jdbc:db2://localhost:50000/hawkbit
+spring.datasource.username=db2inst1
+spring.datasource.password=db2inst1-pwd
+spring.datasource.driverClassName=com.ibm.db2.jcc.DB2Driver

hawkbit-ddi/hawkbit-ddi-server/src/main/resources/application-mssql.properties

@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2018 Bosch Software Innovations GmbH and others
+#
+# This program and the accompanying materials are made
+# available under the terms of the Eclipse Public License 2.0
+# which is available at https://www.eclipse.org/legal/epl-2.0/
+#
+# SPDX-License-Identifier: EPL-2.0
+#
+
+# This profile adds basic configurations for a Microsoft SQL Server DB usage. 
+# Keep in mind that you need the SQL server driver in your classpath on compile.
+# see https://www.eclipse.org/hawkbit/guides/runhawkbit/
+
+spring.jpa.database=SQL_SERVER
+spring.datasource.url=jdbc:sqlserver://localhost:1433;database=hawkbit
+spring.datasource.username=SA
+spring.datasource.password=
+spring.datasource.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver

hawkbit-ddi/hawkbit-ddi-server/src/main/resources/application-mysql.properties

@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2015 Bosch Software Innovations GmbH and others
+#
+# This program and the accompanying materials are made
+# available under the terms of the Eclipse Public License 2.0
+# which is available at https://www.eclipse.org/legal/epl-2.0/
+#
+# SPDX-License-Identifier: EPL-2.0
+#
+
+# This profile adds basic configurations for a MySQL DB usage.
+# Keep in mind that you need the MariaDB driver in your classpath on compile.
+# see https://www.eclipse.org/hawkbit/guides/runhawkbit/
+
+spring.jpa.database=MYSQL
+spring.datasource.url=jdbc:mariadb://localhost:3306/hawkbit
+spring.datasource.username=root
+spring.datasource.password=
+spring.datasource.driverClassName=org.mariadb.jdbc.Driver

hawkbit-ddi/hawkbit-ddi-server/src/main/resources/application-postgresql.properties

@@ -0,0 +1,19 @@
+#
+# Copyright (c) 2020 Enapter Co.,Ltd
+#
+# This program and the accompanying materials are made
+# available under the terms of the Eclipse Public License 2.0
+# which is available at https://www.eclipse.org/legal/epl-2.0/
+#
+# SPDX-License-Identifier: EPL-2.0
+#
+
+# This profile adds basic configurations for a PostgreSQL usage.
+# Keep in mind that you need the PostgreSQL driver in your classpath on compile.
+# see https://www.eclipse.org/hawkbit/guides/runhawkbit/
+
+spring.jpa.database=POSTGRESQL
+spring.datasource.url=jdbc:postgresql://localhost:5432/hawkbit
+spring.datasource.username=postgres
+spring.datasource.password=admin
+spring.datasource.driverClassName=org.postgresql.Driver

hawkbit-ddi/hawkbit-ddi-server/src/main/resources/application.properties

@@ -0,0 +1,83 @@
+#
+# Copyright (c) 2015 Bosch Software Innovations GmbH and others
+#
+# This program and the accompanying materials are made
+# available under the terms of the Eclipse Public License 2.0
+# which is available at https://www.eclipse.org/legal/epl-2.0/
+#
+# SPDX-License-Identifier: EPL-2.0
+#
+
+# Spring configuration
+spring.application.name=ddi-server
+spring.main.allow-bean-definition-overriding=true
+server.port=8081
+
+# Logging configuration
+logging.level.org.eclipse.hawkbit.eventbus.DeadEventListener=WARN
+logging.level.org.springframework.boot.actuate.audit.listener.AuditListener=WARN
+logging.level.org.hibernate.validator.internal.util.Version=WARN
+# security Log with hints on potential attacks
+logging.level.server-security=INFO
+# logging pattern
+logging.pattern.console=%clr(%d{${logging.pattern.dateformat:yyyy-MM-dd'T'HH:mm:ss.SSSXXX}}){faint} %clr(${logging.pattern.level:%5p}) %clr(${PID:}){magenta} %clr(---){faint} %clr([${spring.application.name}] [%X{tenant}:%X{user}] [%15.15t]){faint} %clr(${logging.pattern.correlation:}){faint}%clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${logging.exception-conversion-word:%wEx}
+
+# User Security
+spring.security.user.name=admin
+spring.security.user.password={noop}admin
+
+# Http Encoding
+server.servlet.encoding.charset=UTF-8
+server.servlet.encoding.enabled=true
+server.servlet.encoding.force=true
+
+# DDI authentication configuration
+hawkbit.server.ddi.security.authentication.anonymous.enabled=false
+hawkbit.server.ddi.security.authentication.targettoken.enabled=false
+hawkbit.server.ddi.security.authentication.gatewaytoken.enabled=false
+
+# Optional events
+hawkbit.server.repository.publish-target-poll-event=false
+
+## Configuration for DMF/RabbitMQ integration
+spring.rabbitmq.username=guest
+spring.rabbitmq.password=guest
+spring.rabbitmq.virtual-host=/
+spring.rabbitmq.host=localhost
+spring.rabbitmq.port=5672
+
+# Enable CORS and specify the allowed origins:
+#hawkbit.server.security.cors.enabled=true
+#hawkbit.server.security.cors.allowedOrigins=http://localhost
+
+# Swagger Configuration
+springdoc.api-docs.version=openapi_3_0
+springdoc.show-oauth2-endpoints=true
+springdoc.show-login-endpoint=true
+springdoc.packages-to-scan=org.eclipse.hawkbit.ddi
+springdoc.paths-to-exclude=/system/**
+
+# Flyway disabled - US only
+spring.flyway.enabled=false
+## SQL Database Configuration - END
+
+## No Schedulers - START
+hawkbit.autoassign.scheduler.enabled=false
+hawkbit.rollout.scheduler.enabled=false
+## No Schedulers - END
+
+# Disable discovery client of spring-cloud-commons
+spring.cloud.discovery.enabled=false
+# Enable communication between services
+spring.cloud.bus.enabled=true
+spring.cloud.bus.ack.enabled=false
+spring.cloud.bus.refresh.enabled=false
+spring.cloud.bus.env.enabled=false
+endpoints.spring.cloud.bus.refresh.enabled=false
+endpoints.spring.cloud.bus.env.enabled=false
+spring.cloud.stream.bindings.springCloudBusInput.group=ddi-server
+
+# To use protostuff (for instance fot improved performance) you shall uncomment
+# the following two lines and add io.protostuff:protostuff-core and io.protostuff:protostuff-runtime to dependencies
+#spring.cloud.stream.bindings.springCloudBusInput.content-type=application/binary+protostuff
+#spring.cloud.stream.bindings.springCloudBusOutput.content-type=application/binary+protostuff

hawkbit-ddi/hawkbit-ddi-server/src/main/resources/banner.txt

@@ -0,0 +1,14 @@
+______     _ _                  _                    _    ____  _ _     _____  _____ _____
+|  ____|   | (_)                | |                  | |  |  _ \(_) |   |  __ \|  __ \_   _|
+| |__   ___| |_ _ __  ___  ___  | |__   __ ___      _| | _| |_) |_| |_  | |  | | |  | || |
+|  __| / __| | | '_ \/ __|/ _ \ | '_ \ / _` \ \ /\ / / |/ /  _ <| | __| | |  | | |  | || |
+| |___| (__| | | |_) \__ \  __/ | | | | (_| |\ V  V /|   <| |_) | | |_  | |__| | |__| || |_
+|______\___|_|_| .__/|___/\___| |_| |_|\__,_| \_/\_/ |_|\_\____/|_|\__| |_____/|_____/_____|
+             | |
+             |_|
+
+Eclipse hawkBit DDI Server ${application.formatted-version}
+using Spring Boot ${spring-boot.formatted-version}
+
+Go to https://www.eclipse.org/hawkbit for more information.
+        

hawkbit-ddi/hawkbit-ddi-server/src/test/java/org/eclipse/hawkbit/app/ddi/AbstractSecurityTest.java

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) 2020 Bosch.IO GmbH and others
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.eclipse.hawkbit.app.ddi;
+
+import org.eclipse.hawkbit.repository.test.util.SharedSqlTestDatabaseExtension;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.setup.DefaultMockMvcBuilder;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
+import org.springframework.web.context.WebApplicationContext;
+
+@SpringBootTest(properties = { "hawkbit.dmf.rabbitmq.enabled=false" })
+@ExtendWith(SharedSqlTestDatabaseExtension.class)
+public abstract class AbstractSecurityTest {
+
+    protected MockMvc mvc;
+    @Autowired
+    private WebApplicationContext context;
+
+    @BeforeEach
+    public void setup() {
+        final DefaultMockMvcBuilder builder = MockMvcBuilders.webAppContextSetup(context)
+                .apply(SecurityMockMvcConfigurers.springSecurity()).dispatchOptions(true);
+        mvc = builder.build();
+    }
+}

hawkbit-ddi/hawkbit-ddi-server/src/test/java/org/eclipse/hawkbit/app/ddi/AllowedHostNamesTest.java

@@ -0,0 +1,46 @@
+/**
+ * Copyright (c) 2019 Bosch Software Innovations GmbH and others
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.eclipse.hawkbit.app.ddi;
+
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import io.qameta.allure.Description;
+import io.qameta.allure.Feature;
+import io.qameta.allure.Story;
+import org.junit.jupiter.api.Test;
+import org.springframework.http.HttpHeaders;
+import org.springframework.test.context.TestPropertySource;
+
+@TestPropertySource(properties = { "hawkbit.server.security.allowedHostNames=localhost",
+        "hawkbit.server.security.httpFirewallIgnoredPaths=/index.html" })
+@Feature("Integration Test - Security")
+@Story("Allowed Host Names")
+public class AllowedHostNamesTest extends AbstractSecurityTest {
+
+    @Test
+    @Description("Tests whether a RequestRejectedException is thrown when not allowed host is used")
+    public void allowedHostNameWithNotAllowedHost() throws Exception {
+        mvc.perform(get("/").header(HttpHeaders.HOST, "www.google.com")).andExpect(status().isBadRequest());
+    }
+
+    @Test
+    @Description("Tests whether request is redirected when allowed host is used")
+    public void allowedHostNameWithAllowedHost() throws Exception {
+        mvc.perform(get("/").header(HttpHeaders.HOST, "localhost")).andExpect(status().is3xxRedirection());
+    }
+
+    @Test
+    @Description("Tests whether request without allowed host name and with ignored path end up with a client error")
+    public void notAllowedHostnameWithIgnoredPath() throws Exception {
+        mvc.perform(get("/index.html").header(HttpHeaders.HOST, "www.google.com"))
+                .andExpect(status().is4xxClientError());
+    }
+}

hawkbit-ddi/hawkbit-ddi-server/src/test/java/org/eclipse/hawkbit/app/ddi/PreAuthorizeEnabledTest.java

@@ -0,0 +1,45 @@
+/**
+ * Copyright (c) 2023 Bosch.IO GmbH and others
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.eclipse.hawkbit.app.ddi;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+
+import io.qameta.allure.Description;
+import io.qameta.allure.Feature;
+import io.qameta.allure.Story;
+import org.eclipse.hawkbit.im.authentication.SpPermission;
+import org.eclipse.hawkbit.repository.test.util.WithUser;
+import org.junit.jupiter.api.Test;
+import org.springframework.http.HttpStatus;
+import org.springframework.test.context.TestPropertySource;
+
+@Feature("Integration Test - Security")
+@Story("PreAuthorized enabled")
+@TestPropertySource(properties = { "spring.flyway.enabled=true" })
+public class PreAuthorizeEnabledTest extends AbstractSecurityTest {
+
+    @Test
+    @Description("Tests whether request fail if a role is forbidden for the user")
+    @WithUser(authorities = { SpPermission.READ_TARGET })
+    public void failIfNoRole() throws Exception {
+        mvc.perform(get("/DEFAULT/controller/v1/controllerId")).andExpect(result ->
+                assertThat(result.getResponse().getStatus()).isEqualTo(HttpStatus.FORBIDDEN.value()));
+    }
+
+    @Test
+    @Description("Tests whether request succeed if a role is granted for the user")
+    @WithUser(authorities = { SpPermission.SpringEvalExpressions.CONTROLLER_ROLE })
+    public void successIfHasRole() throws Exception {
+        mvc.perform(get("/DEFAULT/controller/v1/controllerId")).andExpect(result -> {
+            assertThat(result.getResponse().getStatus()).isEqualTo(HttpStatus.OK.value());
+        });
+    }
+}