Clearer error from whitelist filter #139

CHANGELOG.md

@@ -30,7 +30,7 @@ Changelog of Generic Webhook Plugin.
 **Whitelist and HMAC #139**
 
 
-[c6a7a3c7c527f29](https://github.com/jenkinsci/generic-webhook-trigger-plugin/commit/c6a7a3c7c527f29) Tomas Bjerre *2019-10-20 15:45:48*
+[d39f81c3ccefaa6](https://github.com/jenkinsci/generic-webhook-trigger-plugin/commit/d39f81c3ccefaa6) Tomas Bjerre *2019-10-20 19:20:49*
 
 
 ### No issue

src/main/java/org/jenkinsci/plugins/gwt/GenericWebHookRequestReceiver.java

@@ -24,6 +24,7 @@
 import javax.servlet.http.HttpServletResponse;
 import org.apache.commons.io.IOUtils;
 import org.jenkinsci.plugins.gwt.jobfinder.JobFinder;
+import org.jenkinsci.plugins.gwt.whitelist.WhitelistException;
 import org.jenkinsci.plugins.gwt.whitelist.WhitelistVerifier;
 import org.kohsuke.stapler.HttpResponse;
 import org.kohsuke.stapler.StaplerRequest;
@@ -53,15 +54,21 @@ public HttpResponse doInvoke(final StaplerRequest request) {
       LOGGER.log(SEVERE, "", e);
     }
 
-    if (!WhitelistVerifier.verifyWhitelist(request.getRemoteHost(), headers, postContent)) {
+    try {
+      if (!WhitelistVerifier.verifyWhitelist(request.getRemoteHost(), headers, postContent)) {
+        final Map<String, Object> response = new HashMap<>();
+        response.put(
+            "triggerResults",
+            "Sender, "
+                + request.getRemoteHost()
+                + ", with headers "
+                + headers
+                + " did not pass whitelist.");
+        return okJSON(response);
+      }
+    } catch (final WhitelistException e) {
       final Map<String, Object> response = new HashMap<>();
-      response.put(
-          "triggerResults",
-          "Sender, "
-              + request.getRemoteHost()
-              + ", with headers "
-              + headers
-              + " did not pass whitelist.");
+      response.put("triggerResults", e.getMessage());
       return okJSON(response);
     }
 

src/main/java/org/jenkinsci/plugins/gwt/whitelist/HMACVerifier.java

@@ -63,7 +63,7 @@ private static String getHeaderValue(
         return value;
       }
     }
-    throw new RuntimeException(
+    throw new WhitelistException(
         "Was unable to find header with name \"" + hmacHeader + "\" among " + headers);
   }
 }

src/main/java/org/jenkinsci/plugins/gwt/whitelist/WhitelistException.java

@@ -0,0 +1,10 @@
+package org.jenkinsci.plugins.gwt.whitelist;
+
+public class WhitelistException extends RuntimeException {
+
+  private static final long serialVersionUID = -3821871257758501700L;
+
+  public WhitelistException(final String string) {
+    super(string);
+  }
+}

src/main/java/org/jenkinsci/plugins/gwt/whitelist/WhitelistVerifier.java

@@ -41,7 +41,7 @@ static boolean whitelistVerify(
         final Optional<StringCredentials> hmacKeyOpt =
             CredentialsHelper.findCredentials(whitelistItem.getHmacCredentialId());
         if (!hmacKeyOpt.isPresent()) {
-          throw new RuntimeException(
+          throw new WhitelistException(
               "Was unable to find secret text credential " + whitelistItem.getHmacCredentialId());
         }
         final String hmacHeader = whitelistItem.getHmacHeader();