Skip to content

Commit

Permalink
[SECURITY-794]
Browse files Browse the repository at this point in the history
  • Loading branch information
Wadeck authored and daniel-beck committed Apr 25, 2018
1 parent 7abc713 commit 6eea1e9
Show file tree
Hide file tree
Showing 3 changed files with 189 additions and 1 deletion.
5 changes: 5 additions & 0 deletions core/src/main/java/hudson/tools/ZipExtractionInstaller.java
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,11 @@
import java.net.URL;
import java.net.URLConnection;

import jenkins.model.Jenkins;
import org.jenkinsci.Symbol;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.interceptor.RequirePOST;

/**
* Installs a tool into the Hudson working area by downloading and unpacking a ZIP file.
Expand Down Expand Up @@ -95,7 +97,10 @@ public String getDisplayName() {
return Messages.ZipExtractionInstaller_DescriptorImpl_displayName();
}

@RequirePOST
public FormValidation doCheckUrl(@QueryParameter String value) {
Jenkins.getInstance().checkPermission(Jenkins.ADMINISTER);

try {
URLConnection conn = ProxyConfiguration.open(new URL(value));
conn.connect();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ THE SOFTWARE.
<j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form" xmlns:st="jelly:stapler" xmlns:t="/hudson/tools">
<t:label />
<f:entry title="${%Download URL for binary archive}" field="url">
<f:textbox/>
<f:textbox checkMethod="post"/>
</f:entry>
<f:entry title="${%Subdirectory of extracted archive}" field="subdir">
<f:textbox/>
Expand Down
183 changes: 183 additions & 0 deletions test/src/test/java/hudson/tools/ZipExtractionInstallerTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
/*
* The MIT License
*
* Copyright 2018 CloudBees, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package hudson.tools;

import com.gargoylesoftware.htmlunit.HttpMethod;
import com.gargoylesoftware.htmlunit.InteractivePage;
import com.gargoylesoftware.htmlunit.WebRequest;
import com.gargoylesoftware.htmlunit.html.HtmlPage;
import com.gargoylesoftware.htmlunit.html.HtmlTextInput;
import com.gargoylesoftware.htmlunit.javascript.JavaScriptEngine;
import com.gargoylesoftware.htmlunit.javascript.host.xml.XMLHttpRequest;
import hudson.model.JDK;
import hudson.model.User;
import hudson.util.FormValidation;
import jenkins.model.Jenkins;
import net.sourceforge.htmlunit.corejs.javascript.Function;
import net.sourceforge.htmlunit.corejs.javascript.Scriptable;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.jvnet.hudson.test.Issue;
import org.jvnet.hudson.test.JenkinsRule;
import org.jvnet.hudson.test.MockAuthorizationStrategy;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.lang.reflect.Field;
import java.net.URL;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import static org.hamcrest.Matchers.containsString;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.fail;

public class ZipExtractionInstallerTest {

@Rule
public JenkinsRule j = new JenkinsRule();

@Rule
public TemporaryFolder tmp = new TemporaryFolder();

@Test
@Issue("SECURITY-794")
public void onlyAdminCanReachTheDoCheck() throws Exception {
final String ADMIN = "admin";
final String USER = "user";

j.jenkins.setCrumbIssuer(null);
j.jenkins.setSecurityRealm(j.createDummySecurityRealm());
j.jenkins.setAuthorizationStrategy(new MockAuthorizationStrategy()
.grant(Jenkins.ADMINISTER).everywhere().to(ADMIN)
.grant(Jenkins.READ).everywhere().to(USER)
);

User.getById(ADMIN, true);
User.getById(USER, true);

WebRequest request = new WebRequest(new URL(j.getURL() + "descriptorByName/hudson.tools.ZipExtractionInstaller/checkUrl"), HttpMethod.POST);
request.setRequestBody(URLEncoder.encode("value=https://www.google.com", StandardCharsets.UTF_8.name()));

JenkinsRule.WebClient adminWc = j.createWebClient();
adminWc.login(ADMIN);
assertEquals(200, adminWc.getPage(request).getWebResponse().getStatusCode());

JenkinsRule.WebClient userWc = j.createWebClient();
userWc.getOptions().setThrowExceptionOnFailingStatusCode(false);
userWc.login(USER);
assertEquals(403, userWc.getPage(request).getWebResponse().getStatusCode());
}

@Test
@Issue("SECURITY-794")
public void roundtrip() throws Exception {
final String VALID_URL = "https://www.google.com";
final String INVALID_URL = "only-crappy-letters";

ZipExtractionInstaller installer = new ZipExtractionInstaller("", VALID_URL, "");

j.jenkins.getJDKs().add(new JDK("test", tmp.getRoot().getAbsolutePath(), Arrays.asList(
new InstallSourceProperty(Arrays.<ToolInstaller>asList(installer)))));

JenkinsRule.WebClient wc = j.createWebClient();

SpyingJavaScriptEngine jsEngine = new SpyingJavaScriptEngine(wc, "ZipExtractionInstaller/checkUrl", HttpMethod.POST);
wc.setJavaScriptEngine(jsEngine);

HtmlPage page = wc.goTo("configureTools");

XMLHttpRequest lastRequest = jsEngine.getLastRequest();
String body = URLDecoder.decode(getPrivateWebRequestField(lastRequest).getRequestBody(), "UTF-8");
assertThat(body, containsString(VALID_URL));
assertEquals(FormValidation.ok().renderHtml(), lastRequest.getResponseText());

HtmlTextInput urlInput = page.getDocumentElement().getOneHtmlElementByAttribute("input", "value", VALID_URL);
urlInput.setAttribute("value", INVALID_URL);
j.submit(page.getFormByName("config"));

JDK jdk = j.jenkins.getJDK("test");
InstallSourceProperty isp = jdk.getProperties().get(InstallSourceProperty.class);
assertEquals(1, isp.installers.size());
assertEquals(INVALID_URL, isp.installers.get(ZipExtractionInstaller.class).getUrl());

wc.goTo("configureTools");

lastRequest = jsEngine.getLastRequest();
body = URLDecoder.decode(getPrivateWebRequestField(lastRequest).getRequestBody(), "UTF-8");
assertThat(body, containsString(INVALID_URL));
assertThat(lastRequest.getResponseText(), containsString(Messages.ZipExtractionInstaller_malformed_url()));
}

private class SpyingJavaScriptEngine extends JavaScriptEngine {
private List<XMLHttpRequest> storedRequests = new ArrayList<>();
private String urlToMatch;
private HttpMethod method;

SpyingJavaScriptEngine(JenkinsRule.WebClient wc, @Nullable String urlToMatch, @Nullable HttpMethod method) {
super(wc);
this.urlToMatch = urlToMatch;
this.method = method;
}

@Override
public Object callFunction(InteractivePage page, Function function, Scriptable scope, Scriptable thisObject, Object[] args) {
if (thisObject instanceof XMLHttpRequest) {
try {
WebRequest request = getPrivateWebRequestField((XMLHttpRequest) thisObject);
boolean correctUrl = urlToMatch == null || request.getUrl().toString().contains(urlToMatch);
boolean correctMethod = method == null || request.getHttpMethod().equals(method);
if (correctUrl && correctMethod) {
if (((XMLHttpRequest) thisObject).getReadyState() == 4) {
storedRequests.add((XMLHttpRequest) thisObject);
}
}
} catch (NoSuchFieldException | IllegalAccessException e) {
e.printStackTrace();
}
}
return super.callFunction(page, function, scope, thisObject, args);
}

@Nonnull
public XMLHttpRequest getLastRequest() {
if (storedRequests.isEmpty()) {
fail("There is no available requests for the proposed url/method");
}
return storedRequests.get(storedRequests.size() - 1);
}
}

private static WebRequest getPrivateWebRequestField(XMLHttpRequest xmlHttpRequest) throws NoSuchFieldException, IllegalAccessException {
Field webRequest_Field = XMLHttpRequest.class.getDeclaredField("webRequest_");
webRequest_Field.setAccessible(true);
return (WebRequest) webRequest_Field.get(xmlHttpRequest);
}
}

0 comments on commit 6eea1e9

Please sign in to comment.