Skip to content

Fix JENKINS-34788 Add jenkins host url validation #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix JENKINS-34788 Add jenkins host url validation #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,11 @@
<artifactId>junit</artifactId>
<version>1.0</version>
</dependency>
<dependency>
<groupId>commons-validator</groupId>
<artifactId>commons-validator</artifactId>
<version>1.3.1</version>
</dependency>
</dependencies>

<build>
Expand Down
43 changes: 21 additions & 22 deletions src/main/java/org/jenkinsci/plugins/bitbucket/BitbucketBuildStatusNotifier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,7 @@
import com.google.gson.GsonBuilder;
import hudson.Extension;
import hudson.Launcher;
import hudson.model.AbstractBuild;
import hudson.model.AbstractProject;
import hudson.model.BuildListener;
import hudson.model.Item;
import hudson.model.Job;
import hudson.model.Result;
import hudson.model.*;
import hudson.plugins.git.GitSCM;
import hudson.plugins.git.util.BuildData;
import hudson.plugins.mercurial.MercurialSCM;
Expand All @@ -28,19 +23,14 @@
import hudson.util.FormValidation;
import hudson.util.ListBoxModel;
import hudson.util.LogTaskListener;
import java.util.Iterator;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import jenkins.model.Jenkins;
import net.sf.json.JSONObject;
import org.apache.commons.codec.digest.DigestUtils;
import org.apache.commons.validator.UrlValidator;
import org.eclipse.jgit.transport.RemoteConfig;
import org.eclipse.jgit.transport.URIish;
import org.jenkinsci.plugins.bitbucket.api.*;
import org.jenkinsci.plugins.bitbucket.api.BitbucketApi;
import org.jenkinsci.plugins.bitbucket.api.BitbucketApiService;
import org.jenkinsci.plugins.bitbucket.model.BitbucketBuildStatus;
import org.jenkinsci.plugins.bitbucket.model.BitbucketBuildStatusResource;
import org.jenkinsci.plugins.bitbucket.model.BitbucketBuildStatusSerializer;
Expand All @@ -52,6 +42,11 @@
import org.kohsuke.stapler.StaplerRequest;
import org.scribe.model.*;

import java.net.MalformedURLException;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;

public class BitbucketBuildStatusNotifier extends Notifier {

private static final Logger logger = Logger.getLogger(BitbucketBuildStatusNotifier.class.getName());
Expand Down Expand Up @@ -92,14 +87,12 @@ public boolean prebuild(AbstractBuild<?, ?> build, BuildListener listener) {

try {
this.notifyBuildStatus(build, listener);
logger.info("Bitbucket notify on start succeeded");
} catch (Exception e) {
logger.log(Level.INFO, "Bitbucket notify on start failed: " + e.getMessage(), e);
listener.getLogger().println("Bitbucket notify on start failed: " + e.getMessage());
e.printStackTrace(listener.getLogger());
}

logger.info("Bitbucket notify on start succeeded");

return true;
}

Expand All @@ -113,14 +106,12 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen

try {
this.notifyBuildStatus(build, listener);
logger.info("Bitbucket notify on finish succeeded");
} catch (Exception e) {
logger.log(Level.INFO, "Bitbucket notify on finish failed: " + e.getMessage(), e);
listener.getLogger().println("Bitbucket notify on finish failed: " + e.getMessage());
e.printStackTrace(listener.getLogger());
}

logger.info("Bitbucket notify on finish succeeded");

return true;
}

Expand Down Expand Up @@ -296,10 +287,11 @@ private void notifyBuildStatus(final AbstractBuild build, final BuildListener li

private BitbucketBuildStatus createBitbucketBuildStatusFromBuild(AbstractBuild build) throws Exception {

UrlValidator validator = new UrlValidator();
String buildState = this.guessBitbucketBuildState(build.getResult());
// bitbucket requires the key to be shorter than 40 chars
String buildKey = DigestUtils.md5Hex(build.getProject().getFullDisplayName() + "#" + build.getNumber());
String buildUrl = build.getProject().getAbsoluteUrl() + build.getNumber() + '/';
URIish buildUrl = new URIish(build.getProject().getAbsoluteUrl() + build.getNumber() + '/');
String buildName = build.getProject().getFullDisplayName() + " #" + build.getNumber();
AbstractTestResultAction testResult = build.getAction(AbstractTestResultAction.class);
String description = "";
Expand All @@ -308,7 +300,12 @@ private BitbucketBuildStatus createBitbucketBuildStatusFromBuild(AbstractBuild b
description = passedCount + " of " + testResult.getTotalCount() + " tests passed";
}

return new BitbucketBuildStatus(buildState, buildKey, buildUrl, buildName, description);
// validate URL to avoid Bitbucket bad requests
if (!validator.isValid(buildUrl.toString())) {
throw new MalformedURLException("Job URL " + buildUrl.toString() + " is not valid. Please ensure your Jenkins host has a valid URL wihtin its configuration.");
}

return new BitbucketBuildStatus(buildState, buildKey, buildUrl.toString(), buildName, description);
}

private interface ScmAdapter {
Expand Down Expand Up @@ -438,6 +435,8 @@ public ListBoxModel doFillCredentialsIdItems(@AncestorInPath Job<?,?> owner) {

public FormValidation doCheckCredentialsId(@QueryParameter final String credentialsId,
@AncestorInPath final Job<?,?> owner) {


String globalCredentialsId = this.getGlobalCredentialsId();

if (credentialsId == null || credentialsId.isEmpty()) {
Expand Down