Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[JENKINS-51390] If an exception cannot be serialized for program.dat,…
… replace it with a ProxyException.
- Loading branch information
Showing
3 changed files
with
187 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
109 changes: 109 additions & 0 deletions
109
src/main/java/org/jenkinsci/plugins/workflow/support/pickles/ThrowablePickle.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| /* | ||
| * 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 org.jenkinsci.plugins.workflow.support.pickles; | ||
|
|
||
| import com.google.common.util.concurrent.ListenableFuture; | ||
| import hudson.Extension; | ||
| import hudson.Functions; | ||
| import hudson.remoting.ProxyException; | ||
| import java.io.IOException; | ||
| import java.io.NotSerializableException; | ||
| import java.io.OutputStream; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
| import org.apache.commons.io.output.NullOutputStream; | ||
| import org.jboss.marshalling.Marshaller; | ||
| import org.jboss.marshalling.Marshalling; | ||
| import org.jboss.marshalling.MarshallingConfiguration; | ||
| import org.jboss.marshalling.river.RiverMarshallerFactory; | ||
| import org.jenkinsci.plugins.scriptsecurity.sandbox.Whitelist; | ||
| import org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.GroovySandbox; | ||
| import org.jenkinsci.plugins.workflow.flow.FlowExecutionOwner; | ||
| import org.jenkinsci.plugins.workflow.pickles.Pickle; | ||
| import org.jenkinsci.plugins.workflow.pickles.PickleFactory; | ||
| import org.jenkinsci.plugins.workflow.support.concurrent.Futures; | ||
| import org.jenkinsci.plugins.workflow.support.pickles.serialization.RiverWriter; | ||
| import org.kohsuke.accmod.Restricted; | ||
| import org.kohsuke.accmod.restrictions.NoExternalUse; | ||
|
|
||
| /** | ||
| * Ensures that exceptions are safely serializable. | ||
| * Replaces anything problematic with {@link ProxyException}. | ||
| * Mainly defends against {@link NotSerializableException}. | ||
| */ | ||
| @Restricted(NoExternalUse.class) | ||
| public final class ThrowablePickle extends Pickle { | ||
|
|
||
| private static final Logger LOGGER = Logger.getLogger(ThrowablePickle.class.getName()); | ||
| private static final long serialVersionUID = 1; | ||
|
|
||
| /** Stack trace of the original exception. */ | ||
| private final ProxyException t; | ||
| /** Class name of the original exception. */ | ||
| private final String clazz; | ||
| /** Stack trace of the problem serializing the original exception. */ | ||
| private final String error; | ||
|
|
||
| private ThrowablePickle(Throwable t, Exception x) { | ||
| LOGGER.log(Level.FINE, "Sanitizing {0} due to {1}", new Object[] {t, x}); | ||
| this.t = new ProxyException(t); | ||
| clazz = t.getClass().getName(); | ||
| error = Functions.printThrowable(x); | ||
| } | ||
|
|
||
| @Override public ListenableFuture<?> rehydrate(FlowExecutionOwner owner) { | ||
| try { | ||
| owner.getListener().getLogger().println(error.trim()); | ||
| owner.getListener().getLogger().println("Loading unserializable exception; result will no longer be assignable to class " + clazz); | ||
| } catch (IOException x) { | ||
| LOGGER.log(Level.WARNING, null, x); | ||
| } | ||
| return Futures.immediateFuture(t); | ||
| } | ||
|
|
||
| @Extension public static final class Factory extends PickleFactory { | ||
|
|
||
| /** @see RiverWriter */ | ||
| @Override public Pickle writeReplace(Object o) { | ||
| if (o instanceof Throwable) { | ||
| Throwable t = (Throwable) o; | ||
| try (OutputStream ignore = new NullOutputStream(); | ||
| // Could set an ObjectResolver to ignore _other_ pickles, but we do really expect an Exception to have fields of, say, FilePath. | ||
| Marshaller marshaller = new RiverMarshallerFactory().createMarshaller(new MarshallingConfiguration())) { | ||
| GroovySandbox.runInSandbox(() -> { | ||
| marshaller.start(Marshalling.createByteOutput(ignore)); | ||
| marshaller.writeObject(t); | ||
| return null; | ||
| }, Whitelist.all()); | ||
| } catch (Exception x) { | ||
| return new ThrowablePickle(t, x); | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } |
76 changes: 76 additions & 0 deletions
76
src/test/java/org/jenkinsci/plugins/workflow/support/pickles/ThrowablePickleTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /* | ||
| * 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 org.jenkinsci.plugins.workflow.support.pickles; | ||
|
|
||
| import hudson.remoting.ProxyException; | ||
| import java.util.logging.Level; | ||
| import org.jenkinsci.plugins.scriptsecurity.sandbox.whitelists.Whitelisted; | ||
| import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition; | ||
| import org.jenkinsci.plugins.workflow.job.WorkflowJob; | ||
| import org.jenkinsci.plugins.workflow.job.WorkflowRun; | ||
| import org.jenkinsci.plugins.workflow.test.steps.SemaphoreStep; | ||
| import org.junit.ClassRule; | ||
| import org.junit.Test; | ||
| import org.junit.Rule; | ||
| import org.jvnet.hudson.test.BuildWatcher; | ||
| import org.jvnet.hudson.test.Issue; | ||
| import org.jvnet.hudson.test.LoggerRule; | ||
| import org.jvnet.hudson.test.RestartableJenkinsRule; | ||
|
|
||
| public class ThrowablePickleTest { | ||
|
|
||
| @ClassRule public static BuildWatcher buildWatcher = new BuildWatcher(); | ||
| @Rule public RestartableJenkinsRule rr = new RestartableJenkinsRule(); | ||
| @Rule public LoggerRule logging = new LoggerRule().record(ThrowablePickle.class, Level.FINE); | ||
|
|
||
| @Issue("JENKINS-51390") | ||
| @Test public void smokes() throws Exception { | ||
| String beName = BadException.class.getName(); | ||
| rr.then(r -> { | ||
| WorkflowJob p = r.createProject(WorkflowJob.class, "p"); | ||
| p.setDefinition(new CpsFlowDefinition("try {throw new " + beName + "()} catch (x) {semaphore 'wait'; echo(/caught a $x/)}", true)); | ||
| WorkflowRun b = p.scheduleBuild2(0).waitForStart(); | ||
| SemaphoreStep.waitForStart("wait/1", b); | ||
| }); | ||
| rr.then(r -> { | ||
| WorkflowRun b = r.jenkins.getItemByFullName("p", WorkflowJob.class).getBuildByNumber(1); | ||
| SemaphoreStep.success("wait/1", null); | ||
| r.assertBuildStatusSuccess(r.waitForCompletion(b)); | ||
| r.assertLogContains("in field " + beName + ".notSerializable", b); | ||
| r.assertLogContains("assignable to class " + beName, b); | ||
| r.assertLogContains("caught a " + ProxyException.class.getName() + ": " + beName, b); | ||
| }); | ||
| } | ||
|
|
||
| public static class BadException extends Exception { | ||
|
|
||
| private final Object notSerializable = new Object(); | ||
|
|
||
| @Whitelisted | ||
| public BadException() {} | ||
|
|
||
| } | ||
|
|
||
| } |