strip whitespace from whitelist entries

Author: Vladimir Kotal

plugins/src/main/java/opengrok/auth/plugin/UserWhiteListPlugin.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2019, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2021, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2020, Chris Fraire <[email protected]>.
  */
 package opengrok.auth.plugin;
@@ -70,7 +70,7 @@ public void load(Map<String, Object> parameters) {
 
         // Load whitelist from file to memory.
         try (Stream<String> stream = Files.lines(Paths.get(filePath))) {
-            stream.forEach(whitelist::add);
+            stream.map(String::strip).forEach(whitelist::add);
         } catch (IOException e) {
             throw new IllegalArgumentException(String.format("Unable to read the file \"%s\"", filePath), e);
         }
@@ -79,6 +79,11 @@ public void load(Map<String, Object> parameters) {
                 new Object[]{filePath, whitelist.size(), fieldName});
     }
 
+    // for testing
+    Set<String> getWhitelist() {
+        return whitelist;
+    }
+
     @Override
     public void unload() {
         whitelist.clear();
@@ -88,7 +93,7 @@ private boolean checkWhitelist(HttpServletRequest request) {
         User user;
         String attrName = UserPlugin.REQUEST_ATTR;
         if ((user = (User) request.getAttribute(attrName)) == null) {
-            LOGGER.log(Level.WARNING, "cannot get {0} attribute", attrName);
+            LOGGER.log(Level.WARNING, "cannot get {0} attribute from {1}", attrName);
             return false;
         }
 

plugins/src/test/java/opengrok/auth/plugin/UserWhiteListPluginTest.java

@@ -36,13 +36,20 @@
 import java.io.BufferedWriter;
 import java.io.File;
 import java.io.FileOutputStream;
+import java.io.IOException;
 import java.io.OutputStreamWriter;
+import java.io.PrintWriter;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
+import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
@@ -164,6 +171,35 @@ public void shouldThrowOnLoadIfNoFileSpecified(String param) {
                 "caughtException should mention 'Missing parameter'");
     }
 
+    @ParameterizedTest
+    @MethodSource("parameters")
+    public void shouldStripWhitespaceFromWhitelists(String param) throws IOException {
+        plugin = new UserWhiteListPlugin();
+        HashMap<String, Object> pluginParameters = new HashMap<>();
+        pluginParameters.put(UserWhiteListPlugin.FIELD_PARAM, param);
+        Set<String> entries = Set.of("Moomin", " Fillyjonk", "  Snuffkin", "Snork Maiden  ", "Groke ");
+
+        File tmpFile = File.createTempFile("UserWhiteListPluginTestId", "txt");
+        try (PrintWriter writer = new PrintWriter(new OutputStreamWriter(
+                new FileOutputStream(tmpFile), StandardCharsets.UTF_8))) {
+            for (String entity : entries) {
+                writer.println(entity);
+            }
+        }
+
+        // Make sure there as some entries with trailing spaces in the file.
+        Stream<String> stream = Files.lines(tmpFile.toPath());
+        assertTrue(stream.filter(s -> s.startsWith(" ") || s.endsWith(" ")).
+                collect(Collectors.toSet()).size() > 0);
+
+        pluginParameters.put(UserWhiteListPlugin.FILE_PARAM, tmpFile.toString());
+        plugin.load(pluginParameters);
+        tmpFile.delete();
+
+        Set<String> expected = entries.stream().map(String::trim).collect(Collectors.toSet());
+        assertEquals(expected, plugin.getWhitelist());
+    }
+
     @ParameterizedTest
     @MethodSource("parameters")
     public void shouldUnload(String param) {