Completed migration to ConfigurationProperties annotation. Added boot metadata generation to build.

hawkbit-rest-resource/src/main/java/org/eclipse/hawkbit/controller/ArtifactStoreController.java

@@ -25,13 +25,11 @@ import org.eclipse.hawkbit.repository.model.Artifact;
 import org.eclipse.hawkbit.repository.model.LocalArtifact;
 import org.eclipse.hawkbit.repository.model.Target;
 import org.eclipse.hawkbit.rest.resource.helper.RestResourceConversionHelper;
+import org.eclipse.hawkbit.security.HawkbitSecurityProperties;
 import org.eclipse.hawkbit.util.IpUtil;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.bind.RelaxedPropertyResolver;
-import org.springframework.context.EnvironmentAware;
-import org.springframework.core.env.Environment;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.web.bind.annotation.AuthenticationPrincipal;
@@ -55,7 +53,7 @@ import org.springframework.web.bind.annotation.RestController;
  */
 @RestController
 @RequestMapping(ControllerConstants.ARTIFACTS_V1_REQUEST_MAPPING)
-public class ArtifactStoreController implements EnvironmentAware {
+public class ArtifactStoreController {
     private static final Logger LOG = LoggerFactory.getLogger(ArtifactStoreController.class);
 
     @Autowired
@@ -67,14 +65,8 @@ public class ArtifactStoreController implements EnvironmentAware {
     @Autowired
     private CacheWriteNotify cacheWriteNotify;
 
-    private static final String SP_SERVER_CONFIG_PREFIX = "hawkbit.server.";
-    private RelaxedPropertyResolver environment;
-
-    @Override
-    public void setEnvironment(final Environment environment) {
-        this.environment = new RelaxedPropertyResolver(environment, SP_SERVER_CONFIG_PREFIX);
-
-    }
+    @Autowired
+    private HawkbitSecurityProperties securityProperties;
 
     /**
      * Handles GET {@link Artifact} download request. This could be full or
@@ -138,8 +130,8 @@ public class ArtifactStoreController implements EnvironmentAware {
 
     private Action checkAndReportDownloadByTarget(final HttpServletRequest request, final String targetid,
             final LocalArtifact artifact) {
-        final Target target = controllerManagement.updateLastTargetQuery(targetid, IpUtil.getClientIpFromRequest(
-                request, environment.getProperty("security.rp.remote_ip_header", String.class, "X-Forwarded-For")));
+        final Target target = controllerManagement.updateLastTargetQuery(targetid,
+                IpUtil.getClientIpFromRequest(request, securityProperties.getClients().getRemoteIpHeader()));
 
         final Action action = controllerManagement
                 .getActionForDownloadByTargetAndSoftwareModule(target.getControllerId(), artifact.getSoftwareModule());

hawkbit-rest-resource/src/main/java/org/eclipse/hawkbit/controller/RootController.java

@@ -41,15 +41,13 @@ import org.eclipse.hawkbit.repository.model.SoftwareModule;
 import org.eclipse.hawkbit.repository.model.Target;
 import org.eclipse.hawkbit.repository.model.TargetUpdateStatus;
 import org.eclipse.hawkbit.rest.resource.helper.RestResourceConversionHelper;
+import org.eclipse.hawkbit.security.HawkbitSecurityProperties;
 import org.eclipse.hawkbit.tenancy.TenantAware;
 import org.eclipse.hawkbit.util.IpUtil;
 import org.hibernate.validator.constraints.NotEmpty;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.bind.RelaxedPropertyResolver;
-import org.springframework.context.EnvironmentAware;
-import org.springframework.core.env.Environment;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
@@ -74,7 +72,7 @@ import org.springframework.web.bind.annotation.RestController;
  */
 @RestController
 @RequestMapping(ControllerConstants.BASE_V1_REQUEST_MAPPING)
-public class RootController implements EnvironmentAware {
+public class RootController {
 
     private static final Logger LOG = LoggerFactory.getLogger(RootController.class);
     private static final String GIVEN_ACTION_IS_NOT_ASSIGNED_TO_GIVEN_TARGET = "given action ({}) is not assigned to given target ({}).";
@@ -99,16 +97,8 @@ public class RootController implements EnvironmentAware {
     @Autowired
     private TenantAware tenantAware;
 
-    private String requestHeader;
-
-    @Override
-    public void setEnvironment(final Environment environment) {
-        final RelaxedPropertyResolver relaxedPropertyResolver = new RelaxedPropertyResolver(environment,
-                SP_SERVER_CONFIG_PREFIX);
-
-        requestHeader = relaxedPropertyResolver.getProperty("security.rp.remote_ip_header", String.class,
-                "X-Forwarded-For");
-    }
+    @Autowired
+    private HawkbitSecurityProperties securityProperties;
 
     /**
      * Returns all artifacts of a given software module and target.
@@ -155,12 +145,13 @@ public class RootController implements EnvironmentAware {
         LOG.debug("getControllerBase({})", targetid);
 
         final Target target = controllerManagement.findOrRegisterTargetIfItDoesNotexist(targetid,
-                IpUtil.getClientIpFromRequest(request, requestHeader));
+                IpUtil.getClientIpFromRequest(request, securityProperties.getClients().getRemoteIpHeader()));
 
         if (target.getTargetInfo().getUpdateStatus() == TargetUpdateStatus.UNKNOWN) {
             LOG.debug("target with {} extsisted but was in status UNKNOWN -> REGISTERED)", targetid);
             controllerManagement.updateTargetStatus(target.getTargetInfo(), TargetUpdateStatus.REGISTERED,
-                    System.currentTimeMillis(), IpUtil.getClientIpFromRequest(request, requestHeader));
+                    System.currentTimeMillis(),
+                    IpUtil.getClientIpFromRequest(request, securityProperties.getClients().getRemoteIpHeader()));
         }
 
         return new ResponseEntity<>(
@@ -195,7 +186,7 @@ public class RootController implements EnvironmentAware {
         ResponseEntity<Void> result;
 
         final Target target = controllerManagement.updateLastTargetQuery(targetid,
-                IpUtil.getClientIpFromRequest(request, requestHeader));
+                IpUtil.getClientIpFromRequest(request, securityProperties.getClients().getRemoteIpHeader()));
         final SoftwareModule module = softwareManagement.findSoftwareModuleById(softwareModuleId);
 
         if (checkModule(fileName, module)) {
@@ -265,7 +256,8 @@ public class RootController implements EnvironmentAware {
     public ResponseEntity<Void> downloadArtifactMd5(@PathVariable final String targetid,
             @PathVariable final Long softwareModuleId, @PathVariable final String fileName,
             final HttpServletResponse response, final HttpServletRequest request) {
-        controllerManagement.updateLastTargetQuery(targetid, IpUtil.getClientIpFromRequest(request, requestHeader));
+        controllerManagement.updateLastTargetQuery(targetid,
+                IpUtil.getClientIpFromRequest(request, securityProperties.getClients().getRemoteIpHeader()));
 
         final SoftwareModule module = softwareManagement.findSoftwareModuleById(softwareModuleId);
 
@@ -311,7 +303,7 @@ public class RootController implements EnvironmentAware {
         LOG.debug("getControllerBasedeploymentAction({},{})", targetid, resource);
 
         final Target target = controllerManagement.updateLastTargetQuery(targetid,
-                IpUtil.getClientIpFromRequest(request, requestHeader));
+                IpUtil.getClientIpFromRequest(request, securityProperties.getClients().getRemoteIpHeader()));
 
         final Action action = findActionWithExceptionIfNotFound(actionId);
         if (!action.getTarget().getId().equals(target.getId())) {
@@ -362,7 +354,7 @@ public class RootController implements EnvironmentAware {
         LOG.debug("provideBasedeploymentActionFeedback for target [{},{}]: {}", targetid, actionId, feedback);
 
         final Target target = controllerManagement.updateLastTargetQuery(targetid,
-                IpUtil.getClientIpFromRequest(request, requestHeader));
+                IpUtil.getClientIpFromRequest(request, securityProperties.getClients().getRemoteIpHeader()));
 
         if (!actionId.equals(feedback.getId())) {
             LOG.warn(
@@ -469,7 +461,8 @@ public class RootController implements EnvironmentAware {
             + ControllerConstants.CONFIG_DATA_ACTION, method = RequestMethod.PUT, consumes = MediaType.APPLICATION_JSON_VALUE)
     public ResponseEntity<Void> putConfigData(@Valid @RequestBody final ConfigData configData,
             @PathVariable final String targetid, final HttpServletRequest request) {
-        controllerManagement.updateLastTargetQuery(targetid, IpUtil.getClientIpFromRequest(request, requestHeader));
+        controllerManagement.updateLastTargetQuery(targetid,
+                IpUtil.getClientIpFromRequest(request, securityProperties.getClients().getRemoteIpHeader()));
 
         controllerManagement.updateControllerAttributes(targetid, configData.getData());
 
@@ -495,7 +488,7 @@ public class RootController implements EnvironmentAware {
         LOG.debug("getControllerCancelAction({})", targetid);
 
         final Target target = controllerManagement.updateLastTargetQuery(targetid,
-                IpUtil.getClientIpFromRequest(request, requestHeader));
+                IpUtil.getClientIpFromRequest(request, securityProperties.getClients().getRemoteIpHeader()));
 
         final Action action = findActionWithExceptionIfNotFound(actionId);
         if (!action.getTarget().getId().equals(target.getId())) {
@@ -542,7 +535,7 @@ public class RootController implements EnvironmentAware {
         LOG.debug("provideCancelActionFeedback for target [{}]: {}", targetid, feedback);
 
         final Target target = controllerManagement.updateLastTargetQuery(targetid,
-                IpUtil.getClientIpFromRequest(request, requestHeader));
+                IpUtil.getClientIpFromRequest(request, securityProperties.getClients().getRemoteIpHeader()));
 
         if (!actionId.equals(feedback.getId())) {
             LOG.warn(

hawkbit-rest-resource/src/test/resources/application-test.properties

@@ -24,7 +24,7 @@ hawkbit.server.database=H2
 hawkbit.server.database.env=TEST
 spring.main.show_banner=false
 
-hawkbit.server.controller.security.authentication.header=true
+hawkbit.server.ddi.security.authentication.header=true
 
 hawkbit.server.artifact.repo.upload.maxFileSize=5MB