Ip Address tracking configurable.

Signed-off-by: Kai Zimmermann <kai.zimmermann@bosch-si.com>

hawkbit-ddi-resource/src/main/java/org/eclipse/hawkbit/ddi/rest/resource/DdiArtifactStoreController.java

@@ -134,7 +134,7 @@ public class DdiArtifactStoreController implements DdiDlArtifactStoreControllerR
     private Action checkAndReportDownloadByTarget(final HttpServletRequest request, final String targetid,
             final LocalArtifact artifact) {
         final Target target = controllerManagement.updateLastTargetQuery(targetid,
-                IpUtil.getClientIpFromRequest(request, securityProperties.getClients().getRemoteIpHeader()));
+                IpUtil.getClientIpFromRequest(request, securityProperties));
 
         final Action action = controllerManagement
                 .getActionForDownloadByTargetAndSoftwareModule(target.getControllerId(), artifact.getSoftwareModule());

hawkbit-ddi-resource/src/main/java/org/eclipse/hawkbit/ddi/rest/resource/DdiRootController.java

@@ -119,16 +119,14 @@ public class DdiRootController implements DdiRootControllerRestApi {
     public ResponseEntity<DdiControllerBase> getControllerBase(@PathVariable("targetid") final String targetid) {
         LOG.debug("getControllerBase({})", targetid);
 
-        final Target target = controllerManagement.findOrRegisterTargetIfItDoesNotexist(targetid,
-                IpUtil.getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(),
-                        securityProperties.getClients().getRemoteIpHeader()));
+        final Target target = controllerManagement.findOrRegisterTargetIfItDoesNotexist(targetid, IpUtil
+                .getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(), securityProperties));
 
         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(requestResponseContextHolder.getHttpServletRequest(),
-                            securityProperties.getClients().getRemoteIpHeader()));
+                    System.currentTimeMillis(), IpUtil.getClientIpFromRequest(
+                            requestResponseContextHolder.getHttpServletRequest(), securityProperties));
         }
 
         return new ResponseEntity<>(
@@ -143,9 +141,8 @@ public class DdiRootController implements DdiRootControllerRestApi {
             @PathVariable("fileName") final String fileName) {
         ResponseEntity<InputStream> result;
 
-        final Target target = controllerManagement.updateLastTargetQuery(targetid,
-                IpUtil.getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(),
-                        securityProperties.getClients().getRemoteIpHeader()));
+        final Target target = controllerManagement.updateLastTargetQuery(targetid, IpUtil
+                .getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(), securityProperties));
         final SoftwareModule module = softwareManagement.findSoftwareModuleById(softwareModuleId);
 
         if (checkModule(fileName, module)) {
@@ -200,9 +197,8 @@ public class DdiRootController implements DdiRootControllerRestApi {
     public ResponseEntity<Void> downloadArtifactMd5(@PathVariable("targetid") final String targetid,
             @PathVariable("softwareModuleId") final Long softwareModuleId,
             @PathVariable("fileName") final String fileName) {
-        controllerManagement.updateLastTargetQuery(targetid,
-                IpUtil.getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(),
-                        securityProperties.getClients().getRemoteIpHeader()));
+        controllerManagement.updateLastTargetQuery(targetid, IpUtil
+                .getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(), securityProperties));
 
         final SoftwareModule module = softwareManagement.findSoftwareModuleById(softwareModuleId);
 
@@ -228,9 +224,8 @@ public class DdiRootController implements DdiRootControllerRestApi {
             @RequestParam(value = "c", required = false, defaultValue = "-1") final int resource) {
         LOG.debug("getControllerBasedeploymentAction({},{})", targetid, resource);
 
-        final Target target = controllerManagement.updateLastTargetQuery(targetid,
-                IpUtil.getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(),
-                        securityProperties.getClients().getRemoteIpHeader()));
+        final Target target = controllerManagement.updateLastTargetQuery(targetid, IpUtil
+                .getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(), securityProperties));
 
         final Action action = findActionWithExceptionIfNotFound(actionId);
         if (!action.getTarget().getId().equals(target.getId())) {
@@ -263,9 +258,8 @@ public class DdiRootController implements DdiRootControllerRestApi {
             @PathVariable("targetid") final String targetid, @PathVariable("actionId") @NotEmpty final Long actionId) {
         LOG.debug("provideBasedeploymentActionFeedback for target [{},{}]: {}", targetid, actionId, feedback);
 
-        final Target target = controllerManagement.updateLastTargetQuery(targetid,
-                IpUtil.getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(),
-                        securityProperties.getClients().getRemoteIpHeader()));
+        final Target target = controllerManagement.updateLastTargetQuery(targetid, IpUtil
+                .getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(), securityProperties));
 
         if (!actionId.equals(feedback.getId())) {
             LOG.warn(
@@ -357,9 +351,8 @@ public class DdiRootController implements DdiRootControllerRestApi {
     @Override
     public ResponseEntity<Void> putConfigData(@Valid @RequestBody final DdiConfigData configData,
             @PathVariable("targetid") final String targetid) {
-        controllerManagement.updateLastTargetQuery(targetid,
-                IpUtil.getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(),
-                        securityProperties.getClients().getRemoteIpHeader()));
+        controllerManagement.updateLastTargetQuery(targetid, IpUtil
+                .getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(), securityProperties));
 
         controllerManagement.updateControllerAttributes(targetid, configData.getData());
 
@@ -372,9 +365,8 @@ public class DdiRootController implements DdiRootControllerRestApi {
             @PathVariable("actionId") @NotEmpty final Long actionId) {
         LOG.debug("getControllerCancelAction({})", targetid);
 
-        final Target target = controllerManagement.updateLastTargetQuery(targetid,
-                IpUtil.getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(),
-                        securityProperties.getClients().getRemoteIpHeader()));
+        final Target target = controllerManagement.updateLastTargetQuery(targetid, IpUtil
+                .getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(), securityProperties));
 
         final Action action = findActionWithExceptionIfNotFound(actionId);
         if (!action.getTarget().getId().equals(target.getId())) {
@@ -403,9 +395,8 @@ public class DdiRootController implements DdiRootControllerRestApi {
             @PathVariable("actionId") @NotEmpty final Long actionId) {
         LOG.debug("provideCancelActionFeedback for target [{}]: {}", targetid, feedback);
 
-        final Target target = controllerManagement.updateLastTargetQuery(targetid,
-                IpUtil.getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(),
-                        securityProperties.getClients().getRemoteIpHeader()));
+        final Target target = controllerManagement.updateLastTargetQuery(targetid, IpUtil
+                .getClientIpFromRequest(requestResponseContextHolder.getHttpServletRequest(), securityProperties));
 
         if (!actionId.equals(feedback.getId())) {
             LOG.warn(

hawkbit-ddi-resource/src/test/java/org/eclipse/hawkbit/ddi/rest/resource/DdiRootControllerTest.java

@@ -33,9 +33,11 @@ import org.eclipse.hawkbit.repository.util.WithUser;
 import org.eclipse.hawkbit.rest.AbstractRestIntegrationTestWithMongoDB;
 import org.eclipse.hawkbit.rest.util.JsonBuilder;
 import org.eclipse.hawkbit.rest.util.MockMvcResultPrinter;
+import org.eclipse.hawkbit.security.HawkbitSecurityProperties;
 import org.eclipse.hawkbit.tenancy.configuration.TenantConfigurationKey;
 import org.eclipse.hawkbit.util.IpUtil;
 import org.junit.Test;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.hateoas.MediaTypes;
 import org.springframework.http.MediaType;
 
@@ -50,6 +52,9 @@ import ru.yandex.qatools.allure.annotations.Stories;
 @Stories("Root Poll Resource")
 public class DdiRootControllerTest extends AbstractRestIntegrationTestWithMongoDB {
 
+    @Autowired
+    private HawkbitSecurityProperties securityProperties;
+
     @Test
     @Description("Ensures that targets cannot be created e.g. in plug'n play scenarios when tenant does not exists but can be created if the tenant exists.")
     @WithUser(tenantId = "tenantDoesNotExists", allSpPermissions = true, authorities = "ROLE_CONTROLLER", autoCreateTenant = false)
@@ -257,6 +262,23 @@ public class DdiRootControllerTest extends AbstractRestIntegrationTestWithMongoD
 
     }
 
+    @Test
+    @Description("Ensures that the source IP address of the polling target is not stored in repository if disabled")
+    public void rootRsIpAddressNotStoredIfDisabled() throws Exception {
+        securityProperties.getClients().setTrackRemoteIp(false);
+
+        // test
+        final String knownControllerId1 = "0815";
+        mvc.perform(get("/{tenant}/controller/v1/{controllerId}", tenantAware.getCurrentTenant(), knownControllerId1))
+                .andDo(MockMvcResultPrinter.print()).andExpect(status().isOk());
+
+        // verify
+        final Target target = targetManagement.findTargetByControllerID(knownControllerId1);
+        assertThat(target.getTargetInfo().getAddress()).isEqualTo(IpUtil.createHttpUri("***"));
+
+        securityProperties.getClients().setTrackRemoteIp(true);
+    }
+
     @Test
     @Description("Controller trys to finish an update process after it has been finished by an error action status.")
     public void tryToFinishAnUpdateProcessAfterItHasBeenFinished() throws Exception {