SSLEngine provided by the Java Cryptography Architecture
18 | to perform a TLS upgrade of the plaintext connection before any connection secrets are exchanged.
19 | The subsequent connection is then secured using TLS.
20 |
21 | The encryption algorithms and cyphers used by the SSLEngine when using Oracle JDK 1.8
22 | are described in [Java Cryptography Architecture Standard Algorithm Name Documentation for JDK 8](http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html))
23 | If stronger algorithms are needed (for example, AES with 256-bit keys), the [JCE Unlimited Strength Jurisdiction Policy Files](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
24 | can be obtained on Oracle website and installed in the JDK/JRE.
25 |
26 |
27 | Protocol uses non-blocking I/O wherever possible which removes the performance bottleneck of the JNLP3-connect protocol.
28 |
29 | The protocol stack starts with the network layer, proceeds to an arbitrary number of filter layers, and ends with the application layer.
30 | It is represented as a doubly-linked list:
31 |
32 | 
33 |
34 | ### WebSocket
35 |
36 | * Introduced in: Remoting version 4.0, [JEP-222](https://jenkins.io/jep/222)
37 | * At initial release, this protocol is considered a beta release and has not yet undergone extensive testing.
38 |
39 | Uses WebSocket over an HTTP(S) port to handle handshakes, encryption, framing, etc.
40 |
41 | ## Plugin protocols
42 |
43 | ### Remoting Kafka Plugin
44 |
45 | * [Remoting Kafka Plugin](https://github.com/jenkinsci/remoting-kafka-plugin) uses Kafka as fault-tolerant communication layer to support command invocation between Jenkins controller and agent.
46 | * The plugin gets rid of current direct TCP connection between controller and agent.
47 | * More info can be found in the technical [documentation](https://github.com/jenkinsci/remoting-kafka-plugin/blob/master/docs/DOCUMENTATION.md) of the plugin.
48 |
--------------------------------------------------------------------------------
/docs/remoting-kafka-architecture.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenkinsci/remoting/1d80543ebaf27c64e3641d6a67993a13ca9cd7f6/docs/remoting-kafka-architecture.png
--------------------------------------------------------------------------------
/docs/tcpAgentStatus.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jenkinsci/remoting/1d80543ebaf27c64e3641d6a67993a13ca9cd7f6/docs/tcpAgentStatus.png
--------------------------------------------------------------------------------
/docs/troubleshooting.md:
--------------------------------------------------------------------------------
1 | Troubleshooting Remoting issues
2 | ====
3 |
4 | This page provides information about common remoting issues and the ways allowing to triangulate and solve them.
5 | In particular cases the page provides references to external resources.
6 |
7 | NOTE: The page is under construction
--------------------------------------------------------------------------------
/docs/workDir.md:
--------------------------------------------------------------------------------
1 | Remoting Work directory
2 | ===
3 |
4 | In Remoting work directory is an internal data storage, which may be used by Remoting to store caches, logs and other metadata.
5 |
6 | Remoting work directory is available starting from Remoting `3.8`, which is available in [Jenkins 2.68](https://jenkins.io/changelog/#v2.68)).
7 | Before this version there was no working directory concept in the library itself;
8 | all operations were managed by library users (e.g. Jenkins agent workspaces).
9 |
10 | ### Before Remoting 3.8 (Jenkins 2.68)
11 |
12 | * There is no work directory management in Remoting itself
13 | * Logs are not being persisted to the disk unless `-agentLog` option is specified
14 | * JAR Cache is being stored in `${user.home}/.jenkins` unless `-jarCache` option is specified
15 |
16 | ### After Remoting 3.8 (Jenkins 2.68)
17 |
18 | Due to compatibility reasons, Remoting retains the legacy behavior by default.
19 | Work directory can be enabled using the `-workDir` option in CLI.
20 |
21 | Once the option is enabled, Remoting starts using the following structure:
22 |
23 | ```
24 | ${WORKDIR}
25 | |_ ${INTERNAL_DIR} - defined by '-internalDir', 'remoting' by default
26 | |_ jarCache - JAR Cache
27 | |_ logs - Remoting logs
28 | |_ ... - Other directories contributed by library users
29 | ```
30 |
31 | Structure of the `logs` directory depends on the logging settings.
32 | See [this page](logging.md) for more information.
33 |
34 | ### Migrating to work directories in Jenkins
35 |
36 | :exclamation: Remoting does not perform migration from the previous structure,
37 | because it cannot identify potential external users of the data.
38 |
39 | Once the `-workDir` flag is enabled in Remoting, admins are expected to do the following:
40 |
41 | 1. Remove the `${user.home}/.jenkins` directory if there is no other Remoting instances running under the same user.
42 | 2. Consider upgrading configurations of agents in order to enable Work Directories
43 | * SSH agents can be configured in agent settings.
44 | * JNLP agents should be started with the `-workDir` parameter.
45 | * See [JENKINS-44108](https://issues.jenkins-ci.org/browse/JENKINS-44108) for more information about changes in Jenkins plugins, which enable work directories by default.
46 |
--------------------------------------------------------------------------------
/src/assembly/agent-load-test.xml:
--------------------------------------------------------------------------------
1 |
18 | * interface Foo {
19 | * void bar();
20 | * @Asynchronous
21 | * void zot();
22 | * }
23 | *
24 | * Foo foo = getSomeRemoteReferenceToFoo();
25 | * // this invocation calls a remote method, wait for that to complete,
26 | * // then return.
27 | * foo.bar();
28 | * // this invocation returns immediately after the request to execute a remote method
29 | * // is sent to the other side. There's no ordering guarantee as to when
30 | * // this method actually gets executed. For example, if you invoke two async
31 | * // calls, they may execute in the reverse order.
32 | * foo.zot();
33 | *
34 | *
35 | * @see Channel#callAsync(Callable)
36 | * @author Kohsuke Kawaguchi
37 | * @since 2.24
38 | */
39 | @Documented
40 | @Target(ElementType.METHOD)
41 | @Retention(RetentionPolicy.RUNTIME)
42 | public @interface Asynchronous {}
43 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/CallableDecoratorAdapter.java:
--------------------------------------------------------------------------------
1 | package hudson.remoting;
2 |
3 | import org.jenkinsci.remoting.CallableDecorator;
4 |
5 | /**
6 | * Use {@link CallableFilter} as {@link CallableDecorator}
7 | * @author Kohsuke Kawaguchi
8 | */
9 | class CallableDecoratorAdapter extends CallableDecorator {
10 | private final CallableFilter filter;
11 |
12 | public CallableDecoratorAdapter(CallableFilter filter) {
13 | this.filter = filter;
14 | }
15 |
16 | @Override
17 | public
18 | * V call(Callable c) {
19 | * doSomePrep();
20 | * try {
21 | * return c.call();
22 | * } finally {
23 | * doSomeCleanUp();
24 | * }
25 | * }
26 | *
27 | */
28 | 10 | * The header is {@link #SIZE} bytes, in the network order. The first bit designates whether this chunk 11 | * is the last chunk (0 if this is the last chunk), and the remaining 15 bits designate the 12 | * length of the chunk as unsigned number. 13 | * 14 | * @author Kohsuke Kawaguchi 15 | */ 16 | public class ChunkHeader { 17 | 18 | public static final int SIZE = 2; 19 | 20 | public static int read(ByteBuffer buf) { 21 | return parse(buf.get(), buf.get()); 22 | } 23 | 24 | public static int peek(ByteBuffer buf) { 25 | return peek(buf, 0); 26 | } 27 | 28 | public static int peek(ByteBuffer buf, int pos) { 29 | return parse(buf.get(pos), buf.get(pos + 1)); 30 | } 31 | 32 | public static int parse(byte[] buf) { 33 | return parse(buf, 0); 34 | } 35 | 36 | public static int parse(byte[] buf, int pos) { 37 | return parse(buf[pos], buf[pos + 1]); 38 | } 39 | 40 | public static int parse(int b1, int b2) { 41 | return ((b1 & 0xFF) << 8) | (b2 & 0xFF); 42 | } 43 | 44 | public static boolean isLast(int header) { 45 | return (header & 0x8000) == 0; 46 | } 47 | 48 | public static int length(int header) { 49 | return header & 0x7FFF; 50 | } 51 | 52 | public static void write(ByteBuffer buf, int length, boolean hasMore) { 53 | buf.put((byte) ((hasMore ? 0x80 : 0) | (length >> 8))); 54 | buf.put((byte) length); 55 | } 56 | 57 | public static void write(ByteBufferQueue buf, int length, boolean hasMore) { 58 | buf.put((byte) ((hasMore ? 0x80 : 0) | (length >> 8))); 59 | buf.put((byte) length); 60 | } 61 | 62 | public static byte[] pack(int length, boolean hasMore) { 63 | byte[] header = new byte[SIZE]; 64 | header[0] = (byte) ((hasMore ? 0x80 : 0) | (length >> 8)); 65 | header[1] = (byte) (length); 66 | return header; 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /src/main/java/hudson/remoting/ChunkedCommandTransport.java: -------------------------------------------------------------------------------- 1 | package hudson.remoting; 2 | 3 | import java.io.ByteArrayOutputStream; 4 | import java.io.IOException; 5 | import java.io.InputStream; 6 | import java.io.OutputStream; 7 | 8 | /** 9 | * A variation of {@link ClassicCommandTransport} that uses the chunked encoding. 10 | * 11 | * @author Kohsuke Kawaguchi 12 | */ 13 | class ChunkedCommandTransport extends AbstractSynchronousByteArrayCommandTransport { 14 | private final Capability remoteCapability; 15 | 16 | private final ChunkedInputStream in; 17 | private final ChunkedOutputStream out; 18 | 19 | /** 20 | * See {@link CommandTransport#getUnderlyingStream()} 21 | */ 22 | private final OutputStream rawOut; 23 | 24 | /*package*/ ChunkedCommandTransport( 25 | Capability remoteCapability, InputStream in, OutputStream out, OutputStream rawOut) { 26 | this.remoteCapability = remoteCapability; 27 | this.in = new ChunkedInputStream(in); 28 | this.out = new ChunkedOutputStream(8192, out); 29 | this.rawOut = rawOut; 30 | } 31 | 32 | @Override 33 | public Capability getRemoteCapability() throws IOException { 34 | return remoteCapability; 35 | } 36 | 37 | @Override 38 | public byte[] readBlock(Channel channel) throws IOException, ClassNotFoundException { 39 | ByteArrayOutputStream baos = new ByteArrayOutputStream(); 40 | in.readUntilBreak(baos); 41 | return baos.toByteArray(); 42 | } 43 | 44 | @Override 45 | public void writeBlock(Channel channel, byte[] payload) throws IOException { 46 | out.write(payload); 47 | out.sendBreak(); 48 | } 49 | 50 | @Override 51 | public void closeWrite() throws IOException { 52 | out.close(); 53 | } 54 | 55 | @Override 56 | public void closeRead() throws IOException { 57 | in.close(); 58 | } 59 | 60 | @Override 61 | OutputStream getUnderlyingStream() { 62 | return rawOut; 63 | } 64 | } 65 | -------------------------------------------------------------------------------- /src/main/java/hudson/remoting/ClassLoaderHolder.java: -------------------------------------------------------------------------------- 1 | package hudson.remoting; 2 | 3 | import edu.umd.cs.findbugs.annotations.CheckForNull; 4 | import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; 5 | import java.io.IOException; 6 | import java.io.ObjectInputStream; 7 | import java.io.ObjectOutputStream; 8 | import org.jenkinsci.remoting.SerializableOnlyOverRemoting; 9 | 10 | /** 11 | * Remoting-aware holder of {@link ClassLoader} that replaces ClassLoader by its {@link RemoteClassLoader}. 12 | * 13 | * @author Kohsuke Kawaguchi 14 | * @since 2.12 15 | */ 16 | public class ClassLoaderHolder implements SerializableOnlyOverRemoting { 17 | 18 | @CheckForNull 19 | private transient ClassLoader classLoader; 20 | 21 | public ClassLoaderHolder(@CheckForNull ClassLoader classLoader) { 22 | this.classLoader = classLoader; 23 | } 24 | 25 | public ClassLoaderHolder() {} 26 | 27 | @CheckForNull 28 | public ClassLoader get() { 29 | return classLoader; 30 | } 31 | 32 | public void set(@CheckForNull ClassLoader classLoader) { 33 | this.classLoader = classLoader; 34 | } 35 | 36 | @SuppressFBWarnings(value = "MC_OVERRIDABLE_METHOD_CALL_IN_READ_OBJECT", justification = "TODO needs triage") 37 | private void readObject(ObjectInputStream ois) throws IOException, ClassNotFoundException { 38 | RemoteClassLoader.IClassLoader proxy = (RemoteClassLoader.IClassLoader) ois.readObject(); 39 | classLoader = proxy == null 40 | ? null 41 | : getChannelForSerialization().importedClassLoaders.get(proxy); 42 | } 43 | 44 | @SuppressFBWarnings( 45 | value = "DMI_NONSERIALIZABLE_OBJECT_WRITTEN", 46 | justification = "RemoteClassLoader.export() produces a serializable wrapper class") 47 | private void writeObject(ObjectOutputStream oos) throws IOException { 48 | if (classLoader == null) { 49 | oos.writeObject(null); 50 | } else { 51 | RemoteClassLoader.IClassLoader proxy = RemoteClassLoader.export(classLoader, getChannelForSerialization()); 52 | oos.writeObject(proxy); 53 | } 54 | } 55 | 56 | private static final long serialVersionUID = 1L; 57 | } 58 | -------------------------------------------------------------------------------- /src/main/java/hudson/remoting/DaemonThreadFactory.java: -------------------------------------------------------------------------------- 1 | package hudson.remoting; 2 | 3 | import edu.umd.cs.findbugs.annotations.NonNull; 4 | import java.util.concurrent.ThreadFactory; 5 | import java.util.logging.Level; 6 | import java.util.logging.Logger; 7 | 8 | /** 9 | * @author Kohsuke Kawaguchi 10 | */ 11 | public class DaemonThreadFactory implements ThreadFactory { 12 | private static final Logger LOGGER = Logger.getLogger(DaemonThreadFactory.class.getName()); 13 | 14 | @Override 15 | public Thread newThread(@NonNull Runnable r) { 16 | Thread thread = new Thread(r); 17 | thread.setDaemon(true); 18 | thread.setUncaughtExceptionHandler( 19 | (t, e) -> LOGGER.log(Level.SEVERE, e, () -> "Unhandled exception in thread " + t)); 20 | return thread; 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /src/main/java/hudson/remoting/DiagnosedStreamCorruptionException.java: -------------------------------------------------------------------------------- 1 | package hudson.remoting; 2 | 3 | import edu.umd.cs.findbugs.annotations.NonNull; 4 | import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; 5 | import java.io.PrintWriter; 6 | import java.io.StreamCorruptedException; 7 | import java.io.StringWriter; 8 | 9 | /** 10 | * Signals a {@link StreamCorruptedException} with some additional diagnostic information. 11 | * 12 | * @author Kohsuke Kawaguchi 13 | */ 14 | public class DiagnosedStreamCorruptionException extends StreamCorruptedException { 15 | private final Exception diagnoseFailure; 16 | 17 | @NonNull 18 | private final byte[] readBack; 19 | 20 | @NonNull 21 | private final byte[] readAhead; 22 | 23 | DiagnosedStreamCorruptionException( 24 | Exception cause, Exception diagnoseFailure, @NonNull byte[] readBack, @NonNull byte[] readAhead) { 25 | initCause(cause); 26 | this.diagnoseFailure = diagnoseFailure; 27 | this.readBack = readBack; 28 | this.readAhead = readAhead; 29 | } 30 | 31 | public Exception getDiagnoseFailure() { 32 | return diagnoseFailure; 33 | } 34 | 35 | @NonNull 36 | public byte[] getReadBack() { 37 | return readBack.clone(); 38 | } 39 | 40 | @NonNull 41 | public byte[] getReadAhead() { 42 | return readAhead.clone(); 43 | } 44 | 45 | @Override 46 | @SuppressFBWarnings( 47 | value = "INFORMATION_EXPOSURE_THROUGH_AN_ERROR_MESSAGE", 48 | justification = "Used for diagnosing stream corruption between agent and server.") 49 | public String toString() { 50 | StringBuilder buf = new StringBuilder(); 51 | buf.append(super.toString()).append("\n"); 52 | buf.append("Read back: ").append(HexDump.toHex(readBack)).append('\n'); 53 | buf.append("Read ahead: ").append(HexDump.toHex(readAhead)); 54 | if (diagnoseFailure != null) { 55 | StringWriter w = new StringWriter(); 56 | PrintWriter p = new PrintWriter(w); 57 | diagnoseFailure.printStackTrace(p); 58 | p.flush(); 59 | 60 | buf.append("\nDiagnosis problem:\n "); 61 | buf.append(w.toString().trim().replace("\n", "\n ")); 62 | } 63 | return buf.toString(); 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /src/main/java/hudson/remoting/EngineListener.java: -------------------------------------------------------------------------------- 1 | /* 2 | * The MIT License 3 | * 4 | * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi 5 | * 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy 7 | * of this software and associated documentation files (the "Software"), to deal 8 | * in the Software without restriction, including without limitation the rights 9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 | * copies of the Software, and to permit persons to whom the Software is 11 | * furnished to do so, subject to the following conditions: 12 | * 13 | * The above copyright notice and this permission notice shall be included in 14 | * all copies or substantial portions of the Software. 15 | * 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 22 | * THE SOFTWARE. 23 | */ 24 | package hudson.remoting; 25 | 26 | import javax.swing.SwingUtilities; 27 | 28 | /** 29 | * Receives status notification from {@link Engine}. 30 | * 31 | *
32 | * The callback will be invoked on a non-GUI thread, so if the implementation 33 | * wants to touch Swing, {@link SwingUtilities#invokeLater(Runnable)} would be needed. 34 | * 35 | *
36 | * To implement this interface outside this module, extend from {@link EngineListenerAdapter}
37 | * instead to protect against method additions in the future.
38 | *
39 | * @author Kohsuke Kawaguchi
40 | */
41 | public interface EngineListener {
42 | /**
43 | * Status message that indicates the progress of the operation.
44 | */
45 | void status(String msg);
46 |
47 | /**
48 | * Status message, with additional stack trace that indicates an error that was recovered.
49 | */
50 | void status(String msg, Throwable t);
51 |
52 | /**
53 | * Fatal error that's non recoverable.
54 | */
55 | void error(Throwable t);
56 |
57 | /**
58 | * Called when a connection is terminated.
59 | */
60 | void onDisconnect();
61 |
62 | /**
63 | * Called when a re-connection is about to be attempted.
64 | * @since 2.0
65 | */
66 | void onReconnect();
67 | }
68 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/EngineListenerAdapter.java:
--------------------------------------------------------------------------------
1 | package hudson.remoting;
2 |
3 | /**
4 | * Adapter class for {@link EngineListener} to shield subtypes from future callback additions.
5 | *
6 | * @author Kohsuke Kawaguchi
7 | * @since 2.36
8 | */
9 | public abstract class EngineListenerAdapter implements EngineListener {
10 | @Override
11 | public void status(String msg) {}
12 |
13 | @Override
14 | public void status(String msg, Throwable t) {}
15 |
16 | @Override
17 | public void error(Throwable t) {}
18 |
19 | @Override
20 | public void onDisconnect() {}
21 |
22 | @Override
23 | public void onReconnect() {}
24 | }
25 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/EngineListenerSplitter.java:
--------------------------------------------------------------------------------
1 | package hudson.remoting;
2 |
3 | import java.util.List;
4 | import java.util.concurrent.CopyOnWriteArrayList;
5 |
6 | /**
7 | * {@link EngineListener} that distributes callbacks.
8 | *
9 | * @author Kohsuke Kawaguchi
10 | * @since 2.36
11 | */
12 | public class EngineListenerSplitter implements EngineListener {
13 | protected final List
20 | * This method is somewhat like {@link OutputStream#close()},
21 | * in that it signals the end of a stream. In addition to what the close method does,
22 | * this method will cause the {@link InputStream#read()}
23 | * method (or any other overloaded versions) to throw an
24 | * {@link IOException} with the given throwable as the cause.
25 | *
26 | *
27 | * {@link InputStream} will report an error only after all the data that has written
28 | * before is read. IOW, the error will not magically jump over the data that was written.
29 | *
30 | *
31 | * This is useful to propagate error over a pipe. If used over
32 | * a channel with the remoting library that doesn't yet support this,
33 | * or if the {@link OutputStream} isn't connecting to an {@link InputStream},
34 | * this method behaves exactly like {@link OutputStream#close()}.
35 | *
36 | *
37 | * If {@link OutputStream} is already closed or error state is
38 | * set, this method will be no-op.
39 | *
40 | * @param e
41 | * if null, this method behaves exactly like {@link OutputStream#close()}
42 | */
43 | void error(@CheckForNull Throwable e) throws IOException;
44 | }
45 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/Future.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 | package hudson.remoting;
25 |
26 | import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
27 |
28 | // TODO: This Future should be actually deprecated, because it may confuse API users
29 | /**
30 | * Alias to {@link Future}.
31 | *
32 | *
33 | * This alias is defined so that retro-translation won't affect
34 | * the publicly committed signature of the API.
35 | *
36 | * @author Kohsuke Kawaguchi
37 | */
38 | @SuppressFBWarnings(
39 | value = "NM_SAME_SIMPLE_NAME_AS_INTERFACE",
40 | justification = "This class is just an alias, but this alias is a part of public API")
41 | public interface Future
30 | * Behaviors of the methods are explained in {@link Channel}.
31 | *
32 | * @author Kohsuke Kawaguchi
33 | */
34 | interface IChannel {
35 | Object getProperty(Object key);
36 |
37 | Object waitForProperty(Object key) throws InterruptedException;
38 | }
39 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/IReadResolve.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 | package hudson.remoting;
25 |
26 | import java.io.ObjectStreamException;
27 |
28 | /**
29 | * Used internally in the remoting code to have the proxy object
30 | * implement readResolve.
31 | *
32 | * @author Kohsuke Kawaguchi
33 | */
34 | public interface IReadResolve {
35 | Object readResolve() throws ObjectStreamException;
36 | }
37 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/InitializeJarCacheMain.java:
--------------------------------------------------------------------------------
1 | package hudson.remoting;
2 |
3 | import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
4 | import java.io.File;
5 | import java.io.FilenameFilter;
6 | import java.io.IOException;
7 | import java.nio.file.Files;
8 | import java.nio.file.StandardCopyOption;
9 |
10 | /**
11 | * Takes a directory of jars and populates them into the given jar cache
12 | * directory with the correct hash names.
13 | *
14 | * Ideally this class should exist outside hudson.remoting but unfortunately
15 | * it needs access to package-private methods in hudson.remoting.
16 | *
17 | * @author Akshay Dayal
18 | */
19 | public class InitializeJarCacheMain {
20 |
21 | private static final FilenameFilter JAR_FILE_FILTER = (dir, name) -> name.endsWith(".jar");
22 |
23 | /**
24 | * Requires 2 parameters:
25 | *
13 | * The remoting library supports local jar file caching for the efficiency in remote class loading.
14 | * The cache stores jar files sent by the other side, and identifies jars with MD5 checksums that uniquely
15 | * identifies its content.
16 | *
17 | * This allows the cache to be reused by future channel sessions or other concurrent channel sessions.
18 | *
19 | * @author Kohsuke Kawaguchi
20 | * @since 2.24
21 | */
22 | public abstract class JarCache {
23 |
24 | /**
25 | * Default JAR cache location for disabled workspace Manager.
26 | */
27 | public static final File DEFAULT_NOWS_JAR_CACHE_LOCATION =
28 | new File(System.getProperty("user.home"), ".jenkins/cache/jars");
29 |
30 | // TODO: replace by checked exception
31 | /**
32 | * Gets a default value for {@link FileSystemJarCache} to be initialized on agents.
33 | * @return Created JAR Cache
34 | * @throws IOException Default JAR Cache location cannot be initialized
35 | */
36 | @NonNull
37 | /*package*/ static JarCache getDefault() throws IOException {
38 | try {
39 | return new FileSystemJarCache(DEFAULT_NOWS_JAR_CACHE_LOCATION, true);
40 | } catch (IllegalArgumentException ex) {
41 | throw new IOException("Failed to initialize the default JAR Cache location", ex);
42 | }
43 | }
44 |
45 | /**
46 | * Looks up the jar in cache, and if not found, use {@link JarLoader} to retrieve it
47 | * from the other side.
48 | *
49 | *
50 | * This method must be concurrency-safe.
51 | *
52 | * @param channel
53 | * Channel that needs this jar file.
54 | * @return
55 | * URL of the jar file.
56 | */
57 | @NonNull
58 | public abstract CompletableFuture
11 | * {@link Channel} exposes this as {@linkplain Channel#getRemoteProperty(Object) a remote property}
12 | * under the key {@link #OURS}, then once retrieved we store it in a local property under {@link #THEIRS}.
13 | *
14 | * @author Kohsuke Kawaguchi
15 | * @since 2.24
16 | */
17 | public interface JarLoader {
18 | /**
19 | * Retrieve the jar file image.
20 | *
21 | * This method is called by the other side to receive the jar file. This call implicitly
22 | * has the effect of {@link #notifyJarPresence(long, long)}
23 | *
24 | * @param sink
25 | * This stream receives the jar file.
26 | *
27 | * @throws InterruptedException
28 | * Since this is a remote call, if the calling thread gets interrupted while waiting for the completion
29 | * of the call, this exception will be thrown.
30 | */
31 | void writeJarTo(long sum1, long sum2, OutputStream sink) throws IOException, InterruptedException;
32 |
33 | /**
34 | * Called by the other side to notify that they already own the jar file of the given checksum.
35 | *
36 | * This allows this side to send {@link ResourceImageRef} smartly by avoiding unnecessary
37 | * image transport.
38 | */
39 | @Asynchronous
40 | void notifyJarPresence(long sum1, long sum2);
41 |
42 | /**
43 | * @param sums
44 | * Array of even length. sums[2i] and sumes[2i+1] are paired up and interpreted as one checksum.
45 | */
46 | @Asynchronous
47 | void notifyJarPresence(long[] sums);
48 |
49 | /**
50 | * Used by the local side to see if the jar file of the given checksum is already present
51 | * on the other side. Used to decide if the class file image gets sent to the remote or not.
52 | */
53 | boolean isPresentOnRemote(Checksum sum);
54 |
55 | String OURS = JarLoader.class.getName() + ".ours";
56 | ChannelProperty
8 | * The use of this exception triggers the caller to wrap a thrown exception to
9 | * add the stack trace that includes the call site information, making
10 | * the debugging easier
11 | *
12 | *
13 | * @author Kohsuke Kawaguchi
14 | */
15 | class RemotingSystemException extends RuntimeException {
16 | RemotingSystemException(Throwable cause) {
17 | super(cause);
18 | }
19 |
20 | RemotingSystemException(String message, Throwable cause) {
21 | super(message, cause);
22 | }
23 |
24 | private static final long serialVersionUID = 1L;
25 | }
26 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/RequestAbortedException.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 | package hudson.remoting;
25 |
26 | /**
27 | * Signals that the communication is aborted and thus
28 | * the pending {@link Request} will never recover its {@link Response}.
29 | *
30 | * @author Kohsuke Kawaguchi
31 | */
32 | // this was added before RemotingSystemException. Going forward, it's probably
33 | // unnecessary to define specific subtypes of RemotingSystemException
34 | public class RequestAbortedException extends RemotingSystemException {
35 | public RequestAbortedException(Throwable cause) {
36 | super(cause);
37 | }
38 |
39 | private static final long serialVersionUID = 238929914783987425L;
40 | }
41 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/RequiredRoleCheckerWrapper.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright (c) 2021, CloudBees, Inc.
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 | package hudson.remoting;
25 |
26 | import edu.umd.cs.findbugs.annotations.NonNull;
27 | import java.util.Collection;
28 | import org.jenkinsci.remoting.Role;
29 | import org.jenkinsci.remoting.RoleChecker;
30 | import org.jenkinsci.remoting.RoleSensitive;
31 |
32 | /**
33 | * Implementation that can tell whether a {@code #check} method was invoked.
34 | */
35 | /* package-private */ class RequiredRoleCheckerWrapper extends RoleChecker {
36 | private boolean checked;
37 |
38 | private RoleChecker roleChecker;
39 |
40 | public RequiredRoleCheckerWrapper(RoleChecker roleChecker) {
41 | this.roleChecker = roleChecker;
42 | }
43 |
44 | @Override
45 | public void check(@NonNull RoleSensitive subject, Role... expected) throws SecurityException {
46 | checked = true;
47 | roleChecker.check(subject, expected);
48 | }
49 |
50 | @Override
51 | public void check(@NonNull RoleSensitive subject, @NonNull Role expected) throws SecurityException {
52 | checked = true;
53 | roleChecker.check(subject, expected);
54 | }
55 |
56 | @Override
57 | public void check(@NonNull RoleSensitive subject, @NonNull Collection
15 | * This is used when {@link ResourceImageInJar} cannot be used because we couldn't identify the jar file.
16 | *
17 | * @author Kohsuke Kawaguchi
18 | */
19 | @SuppressFBWarnings(
20 | value = "URLCONNECTION_SSRF_FD",
21 | justification = "Used by the agent as part of jar cache management.")
22 | class ResourceImageDirect extends ResourceImageRef {
23 | /**
24 | * The actual resource.
25 | */
26 | private final byte[] payload;
27 |
28 | ResourceImageDirect(byte[] payload) {
29 | this.payload = payload;
30 | }
31 |
32 | ResourceImageDirect(URL resource) throws IOException {
33 | this(Util.readFully(resource.openStream()));
34 | }
35 |
36 | @Override
37 | Future
11 | * We support two kinds of references. One {@linkplain ResourceImageInJar points to a resource inside a jar},
12 | * and the other {@linkplain ResourceImageDirect directly contains the byte[] image}.
13 | *
14 | *
15 | * Subtypes need to be available on both sides of the channel, so it's package protected.
16 | *
17 | * @author Kohsuke Kawaguchi
18 | */
19 | /*package*/ abstract class ResourceImageRef implements Serializable {
20 | /**
21 | * Obtains the a resource file byte image.
22 | *
23 | * @param channel
24 | * The channel object as the context.
25 | * @param resourcePath
26 | * Fully qualified name of the resource being retrieved, that doesn't start with '/',
27 | * such as 'java/lang/String.class' Identical to the name parameter in {@link ClassLoader#getResource(String)}.
28 | *
29 | * This parameter must be the same name you used to retrieve {@link RemoteClassLoader.ClassReference}.
30 | *
31 | * One {@link ResourceImageRef} represents a single resource, and that resource name
32 | * is specified when you retrieve {@link RemoteClassLoader.ClassReference}. Therefore from pure abstraction
33 | * point of view, this information is redundant. However, specifying that information reduces
34 | * the amount of state {@link ResourceImageRef}s need to carry around, which helps reduce
35 | * the bandwidth consumption.
36 | */
37 | /*package*/ abstract Future
35 | * Unlike plain {@link Socket#getInputStream()}, closing the stream
36 | * does not close the entire socket, and instead it merely partial-close
37 | * a socket in the direction.
38 | *
39 | * @author Kohsuke Kawaguchi
40 | */
41 | public class SocketInputStream extends FilterInputStream {
42 | private final Socket socket;
43 |
44 | /**
45 | * @deprecated
46 | * Use {@link SocketChannelStream#in(Socket)}
47 | */
48 | @Deprecated
49 | public SocketInputStream(Socket socket) throws IOException {
50 | super(socket.getInputStream());
51 | this.socket = socket;
52 | }
53 |
54 | @Override
55 | public void close() throws IOException {
56 | if (socket.isClosed()) {
57 | return;
58 | }
59 | if (!socket.isInputShutdown()) {
60 | socket.shutdownInput();
61 | }
62 | if (socket.isOutputShutdown()) {
63 | socket.close();
64 | }
65 | }
66 | }
67 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/SynchronousExecutorService.java:
--------------------------------------------------------------------------------
1 | package hudson.remoting;
2 |
3 | import edu.umd.cs.findbugs.annotations.NonNull;
4 | import java.util.Collections;
5 | import java.util.List;
6 | import java.util.concurrent.AbstractExecutorService;
7 | import java.util.concurrent.ExecutorService;
8 | import java.util.concurrent.TimeUnit;
9 |
10 | /**
11 | * {@link ExecutorService} that executes synchronously.
12 | *
13 | * @author Kohsuke Kawaguchi
14 | */
15 | class SynchronousExecutorService extends AbstractExecutorService {
16 | private volatile boolean shutdown = false;
17 | private int count = 0;
18 |
19 | @Override
20 | public void shutdown() {
21 | shutdown = true;
22 | }
23 |
24 | @Override
25 | @NonNull
26 | public List
13 | * Thie indirection on {@link URL} allows us to make sure that URLs backed by temporary files
14 | * actually do exist before we use them.
15 | *
16 | * @author Kohsuke Kawaguchi
17 | */
18 | abstract class URLish {
19 | private URLish() {}
20 |
21 | /**
22 | * Converts URLish to the standard {@link URL} type.
23 | * @return URL or {@code null} if the target destination is known to be non-existent.
24 | * @throws MalformedURLException URL cannot be constructed
25 | */
26 | @CheckForNull
27 | abstract URL toURL() throws MalformedURLException;
28 |
29 | @NonNull
30 | static URLish from(@NonNull final URL url) {
31 |
32 | return new URLish() {
33 | @Override
34 | @NonNull
35 | URL toURL() {
36 | return url;
37 | }
38 | };
39 | }
40 |
41 | @NonNull
42 | static URLish from(@NonNull final File f) {
43 | return new URLish() {
44 | @Override
45 | URL toURL() throws MalformedURLException {
46 | // be defensive against external factors that might have deleted this file, since we use /tmp
47 | // see http://www.nabble.com/Surefire-reports-tt17554215.html
48 | if (f.exists()) {
49 | return f.toURI().toURL();
50 | }
51 | return null;
52 | }
53 | };
54 | }
55 | }
56 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/UnexportCommand.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 | package hudson.remoting;
25 |
26 | import edu.umd.cs.findbugs.annotations.CheckForNull;
27 |
28 | /**
29 | * {@link Command} that unexports an object.
30 | * @author Kohsuke Kawaguchi
31 | */
32 | public class UnexportCommand extends Command {
33 | private final int oid;
34 |
35 | UnexportCommand(int oid, @CheckForNull Throwable cause) {
36 | this.oid = oid;
37 | chainCause(cause);
38 | }
39 |
40 | /**
41 | * @deprecated Use {@link #UnexportCommand(int, Throwable)}
42 | */
43 | @Deprecated
44 | public UnexportCommand(int oid) {
45 | this(oid, null);
46 | }
47 |
48 | @Override
49 | protected void execute(Channel channel) {
50 | channel.unexport(oid, createdAt);
51 | }
52 |
53 | @Override
54 | public String toString() {
55 | return "Unexport";
56 | }
57 |
58 | private static final long serialVersionUID = 1L;
59 | }
60 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/forward/CopyThread.java:
--------------------------------------------------------------------------------
1 | package hudson.remoting.forward;
2 |
3 | import java.io.IOException;
4 | import java.io.InputStream;
5 | import java.io.OutputStream;
6 | import java.util.logging.Level;
7 | import java.util.logging.Logger;
8 |
9 | /**
10 | * Copies a stream and close them at EOF.
11 | *
12 | * @author Kohsuke Kawaguchi
13 | */
14 | final class CopyThread extends Thread {
15 | private static final Logger LOGGER = Logger.getLogger(CopyThread.class.getName());
16 | private final InputStream in;
17 | private final OutputStream out;
18 |
19 | /**
20 | * Callers are responsible for closing the input and output streams.
21 | */
22 | public CopyThread(String threadName, InputStream in, OutputStream out, Runnable termination) {
23 | this(threadName, in, out, termination, 5);
24 | }
25 |
26 | private CopyThread(String threadName, InputStream in, OutputStream out, Runnable termination, int remainingTries) {
27 | super(threadName);
28 | this.in = in;
29 | this.out = out;
30 | setUncaughtExceptionHandler((t, e) -> {
31 | if (remainingTries > 0) {
32 | LOGGER.log(Level.WARNING, e, () -> "Uncaught exception in CopyThread " + t + ", retrying copy");
33 | new CopyThread(threadName, in, out, termination, remainingTries - 1).start();
34 | } else {
35 | LOGGER.log(Level.SEVERE, e, () -> "Uncaught exception in CopyThread " + t + ", out of retries");
36 | termination.run();
37 | }
38 | });
39 | }
40 |
41 | @Override
42 | public void run() {
43 | try {
44 | byte[] buf = new byte[8192];
45 | int len;
46 | while ((len = in.read(buf)) > 0) {
47 | out.write(buf, 0, len);
48 | }
49 | } catch (IOException e) {
50 | LOGGER.log(Level.WARNING, e, () -> "Exception while copying in thread: " + getName());
51 | }
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/forward/Forwarder.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 | package hudson.remoting.forward;
25 |
26 | import java.io.IOException;
27 | import java.io.OutputStream;
28 | import java.io.Serializable;
29 |
30 | /**
31 | * Abstracts away how the forwarding is set up.
32 | *
33 | * @author Kohsuke Kawaguchi
34 | */
35 | public interface Forwarder extends Serializable {
36 | /**
37 | * Establishes a port forwarding connection and returns
38 | * the writer end.
39 | *
40 | * @param out
41 | * The writer end to the initiator. The callee will
42 | * start a thread that writes to this.
43 | */
44 | OutputStream connect(OutputStream out) throws IOException;
45 | }
46 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/forward/ListeningPort.java:
--------------------------------------------------------------------------------
1 | package hudson.remoting.forward;
2 |
3 | import java.io.Closeable;
4 | import java.io.IOException;
5 |
6 | /**
7 | * Represents a listening port that forwards a connection
8 | * via port forwarding.
9 | *
10 | * @author Kohsuke Kawaguchi
11 | */
12 | public interface ListeningPort extends Closeable {
13 | /**
14 | * TCP/IP port that is listening.
15 | */
16 | int getPort();
17 |
18 | /**
19 | * Shuts down the port forwarding by removing the server socket.
20 | * Connections that are already established will not be affected
21 | * by this operation.
22 | */
23 | @Override
24 | void close() throws IOException;
25 | }
26 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/forward/package-info.java:
--------------------------------------------------------------------------------
1 | /**
2 | * TCP port forwarding over {@code hudson.remoting}.
3 | */
4 | package hudson.remoting.forward;
5 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/jnlp/Main.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 | package hudson.remoting.jnlp;
25 |
26 | import hudson.remoting.Launcher;
27 | import java.io.IOException;
28 | import org.kohsuke.args4j.CmdLineException;
29 |
30 | /**
31 | * Previous entry point to pseudo-JNLP agent.
32 | *
33 | * See also {@code jenkins-agent.jnlp.jelly} in the core.
34 | *
35 | * @author Kohsuke Kawaguchi
36 | * @deprecated use {@link Launcher}
37 | */
38 | @Deprecated
39 | public class Main extends Launcher {
40 |
41 | private static volatile boolean deprecationWarningLogged;
42 |
43 | public static void main(String... args) throws IOException, InterruptedException {
44 | logDeprecation();
45 | Launcher.main(args);
46 | }
47 |
48 | @Override
49 | public void run() throws CmdLineException, IOException, InterruptedException {
50 | logDeprecation();
51 | super.run();
52 | }
53 |
54 | private static void logDeprecation() {
55 | if (deprecationWarningLogged) {
56 | return;
57 | }
58 | System.err.println(
59 | "WARNING: Using deprecated entrypoint \"java -cp agent.jar hudson.remoting.jnlp.Main\". Use \"java -jar agent.jar\" instead.");
60 | deprecationWarningLogged = true;
61 | }
62 | }
63 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/jnlp/package-info.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 | /**
25 | * Code for launching the remote agent through JNLP.
26 | *
27 | *
28 | * This involves in getting the connection parameters through command line,
29 | * which is provided from {@code jenkins-agent.jnlp.jelly} file in the core.
30 | */
31 | package hudson.remoting.jnlp;
32 |
--------------------------------------------------------------------------------
/src/main/java/hudson/remoting/package-info.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 | /**
25 | * Remoting infrastructure for Hudson.
26 | *
27 | *
28 | * Code in this package is used for running a part of a program in agents.
29 | * If you are new to this package, start from {@link hudson.remoting.Channel}.
30 | */
31 | package hudson.remoting;
32 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/remoting/CallableDecorator.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.remoting;
2 |
3 | import hudson.remoting.Callable;
4 | import hudson.remoting.Channel;
5 |
6 | /**
7 | * Decorator on {@code Callable.call()} to filter the execution.
8 | *
9 | * @author Kohsuke Kawaguchi
10 | * @see Channel#addLocalExecutionInterceptor(CallableDecorator)
11 | */
12 | public abstract class CallableDecorator {
13 | /**
14 | * Used to decorate everything that executes in the channel as a result of a request from the other side,
15 | * such as RPC executions on exported objects, user-provided {@link Callable} execution, pipe write, and so on.
16 | */
17 | public If you think you need to implement {@link RoleSensitive#checkRoles} please reread that method’s Javadoc.
22 | *
23 | * Normally, each side of the channel has a fixed set of roles (say {@code actualRoles}),
24 | * and the implementation would be {@code actualRoles.containsAll(roles)}.
25 | *
26 | * @param subject
27 | * Object whose role we are checking right now. Useful context information when reporting an error.
28 | * @param expected
29 | * The current JVM that executes the callable should have one of these roles.
30 | * Never empty nor null.
31 | * @throws SecurityException
32 | * Any exception thrown will prevent the callable from getting executed, but we recommend
33 | * {@link SecurityException}
34 | */
35 | public abstract void check(@NonNull RoleSensitive subject, @NonNull Collection
11 | * This interface is defined separately from {@link Callable} so that other callable-like interfaces
12 | * can reuse this.
13 | *
14 | * @author Kohsuke Kawaguchi
15 | * @see RoleChecker
16 | * @since 2.47
17 | */
18 | public interface RoleSensitive {
19 | /**
20 | * Verifies the roles expected by this callable by invoking {@link RoleChecker#check(RoleSensitive, Collection)}
21 | * method (or its variants), to provide an opportunity for {@link RoleChecker} to reject this object.
22 | * Do not implement this method unless you know what you are doing.
23 | * If you have a Jenkins {@link Callable} or {@code FileCallable}, use the standard abstract base classes instead,
24 | * such as {@code MasterToSlaveCallable}, {@code MasterToSlaveFileCallable}, {@code NotReallyRoleSensitiveCallable}, etc.
25 | * See this document for details.
26 | *
27 | * If the method returns normally, the check has passed.
28 | *
29 | * @throws SecurityException
30 | * If there's a mismatch in the expected roles and the actual roles that should prevent
31 | * the execution of this callable.
32 | *
33 | * @throws AbstractMethodError
34 | * In the history of this library, this interface was added rather later, so there's lots of
35 | * {@link Callable}s out there that do not implement this method.
36 | * For this reason, code that calls this method should be prepared to
37 | * receive {@link AbstractMethodError}, and treat that as if the invocation of
38 | * {@code checker.check(this,Role.UNKNOWN)} has happened.
39 | */
40 | void checkRoles(RoleChecker checker) throws SecurityException;
41 | }
42 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/remoting/engine/HostPort.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.remoting.engine;
2 |
3 | class HostPort {
4 |
5 | private static final int PORT_MIN = 0;
6 | private static final int PORT_MAX = (1 << 16) - 1;
7 |
8 | private String host;
9 | private int port;
10 |
11 | public HostPort(String value) {
12 | splitHostPort(value, null, 0);
13 | }
14 |
15 | public HostPort(String value, String defaultHost, int defaultPort) {
16 | splitHostPort(value, defaultHost, defaultPort);
17 | }
18 |
19 | private void splitHostPort(String value, String defaultHost, int defaultPort) {
20 | String hostPortValue = value.trim();
21 | if (hostPortValue.charAt(0) == '[') {
22 | extractIPv6(hostPortValue);
23 | return;
24 | }
25 | int portSeparator = hostPortValue.lastIndexOf(':');
26 | if (portSeparator < 0) {
27 | throw new IllegalArgumentException("Invalid HOST:PORT value: " + value);
28 | }
29 | String hostValue = hostPortValue.substring(0, portSeparator).trim();
30 | host = !hostValue.isEmpty() ? hostValue : defaultHost;
31 | String portString = hostPortValue.substring(portSeparator + 1).trim();
32 | if (!portString.isEmpty()) {
33 | port = Integer.parseInt(portString);
34 | if (port <= PORT_MIN || port > PORT_MAX) {
35 | throw new IllegalArgumentException(
36 | "Port " + value + " out of valid range [" + PORT_MIN + ", " + PORT_MAX + ")");
37 | }
38 | } else {
39 | port = defaultPort;
40 | }
41 | }
42 |
43 | private void extractIPv6(String hostPortValue) {
44 | int endBracket = hostPortValue.indexOf(']');
45 | if (endBracket < 2) {
46 | throw new IllegalArgumentException("Invalid IPv6 value.");
47 | }
48 | host = hostPortValue.substring(1, endBracket).trim();
49 | int portSeparator = hostPortValue.lastIndexOf(':');
50 | if (portSeparator < endBracket) {
51 | throw new IllegalArgumentException("Missing port.");
52 | }
53 | port = Integer.parseInt(hostPortValue.substring(portSeparator + 1).trim());
54 | }
55 |
56 | public String getHost() {
57 | return host;
58 | }
59 |
60 | public int getPort() {
61 | return port;
62 | }
63 | }
64 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/remoting/engine/JnlpEndpointResolver.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright (c) 2019, CloudBees, Inc.
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 | package org.jenkinsci.remoting.engine;
25 |
26 | import java.io.IOException;
27 | import java.security.KeyFactory;
28 | import java.security.NoSuchAlgorithmException;
29 | import java.security.interfaces.RSAPublicKey;
30 | import java.security.spec.InvalidKeySpecException;
31 | import java.security.spec.X509EncodedKeySpec;
32 | import java.util.Base64;
33 |
34 | public abstract class JnlpEndpointResolver {
35 |
36 | public abstract JnlpAgentEndpoint resolve() throws IOException;
37 |
38 | public abstract void waitForReady() throws InterruptedException;
39 |
40 | protected RSAPublicKey getIdentity(String base64EncodedIdentity) throws InvalidKeySpecException {
41 | if (base64EncodedIdentity == null) {
42 | return null;
43 | }
44 | try {
45 | byte[] encodedKey = Base64.getDecoder().decode(base64EncodedIdentity);
46 | if (encodedKey == null) {
47 | return null;
48 | }
49 | X509EncodedKeySpec spec = new X509EncodedKeySpec(encodedKey);
50 | KeyFactory kf = KeyFactory.getInstance("RSA");
51 | return (RSAPublicKey) kf.generatePublic(spec);
52 | } catch (NoSuchAlgorithmException e) {
53 | throw new IllegalStateException(
54 | "The Java Language Specification mandates RSA as a supported algorithm.", e);
55 | }
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/remoting/nio/Closeables.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.remoting.nio;
2 |
3 | import java.io.Closeable;
4 | import java.io.IOException;
5 | import java.net.Socket;
6 | import java.nio.channels.SelectableChannel;
7 | import java.nio.channels.SocketChannel;
8 | import java.util.logging.Level;
9 | import java.util.logging.Logger;
10 |
11 | /**
12 | * Creates {@link Closeable} that does socket half-close.
13 | *
14 | * @author Kohsuke Kawaguchi
15 | */
16 | class Closeables {
17 | public static Closeable input(SelectableChannel ch) {
18 | if (ch instanceof SocketChannel) {
19 | final SocketChannel s = (SocketChannel) ch;
20 | return () -> {
21 | try {
22 | s.socket().shutdownInput();
23 | } catch (IOException e) {
24 | // at least as of Java7u55, shutdownInput fails if the socket
25 | // is already closed or half-closed, as opposed to be a no-op.
26 | // so let's just ignore close error altogether
27 | LOGGER.log(Level.FINE, "Failed to close " + s, e);
28 | }
29 | maybeClose(s);
30 | };
31 | } else {
32 | return ch;
33 | }
34 | }
35 |
36 | public static Closeable output(SelectableChannel ch) {
37 | if (ch instanceof SocketChannel) {
38 | final SocketChannel s = (SocketChannel) ch;
39 | return () -> {
40 | try {
41 | s.socket().shutdownOutput();
42 | } catch (IOException e) {
43 | // see the discussion in try/catch block around shutdownInput above
44 | LOGGER.log(Level.FINE, "Failed to close " + s, e);
45 | }
46 | maybeClose(s);
47 | };
48 | } else {
49 | return ch;
50 | }
51 | }
52 |
53 | /**
54 | * If both direction is closed, close the whole thing.
55 | */
56 | private static void maybeClose(SocketChannel sc) throws IOException {
57 | Socket s = sc.socket();
58 | if (s.isInputShutdown() && s.isOutputShutdown()) {
59 | s.close();
60 | sc.close();
61 | }
62 | }
63 |
64 | private static final Logger LOGGER = Logger.getLogger(Closeables.class.getName());
65 | }
66 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/remoting/nio/SelectorThreadOnly.java:
--------------------------------------------------------------------------------
1 | package org.jenkinsci.remoting.nio;
2 |
3 | import java.lang.annotation.ElementType;
4 | import java.lang.annotation.Retention;
5 | import java.lang.annotation.RetentionPolicy;
6 | import java.lang.annotation.Target;
7 |
8 | /**
9 | * Marks the methods that can be only executed by the NIO selector thread.
10 | *
11 | *
14 | * This exercises {@link NioChannelHub} differently because it has different channel
15 | * objects for read end and the write end.
16 | *
17 | * @author Kohsuke Kawaguchi
18 | */
19 | public class NioPipeRunner extends AbstractNioChannelRunner {
20 | @Override
21 | public Channel start() throws Exception {
22 | final SynchronousQueue
12 | * Use the tee command or network packet capturing tool to capture the traffic between the controller and
13 | * the agent, then run it through this tool to get the dump of what commands are sent between them.
14 | *
15 | * @author Kohsuke Kawaguchi
16 | */
17 | public class TrafficAnalyzer {
18 | public static void main(String[] args) throws Exception {
19 | File f = new File("/home/kohsuke/ws/hudson/investigations/javafx-windows-hang/out.log");
20 | try (DataInputStream fin = new DataInputStream(new FileInputStream(f))) {
21 | fin.readFully(new byte[4]); // skip preamble
22 | try (ObjectInputStream ois = new ObjectInputStream(fin)) {
23 | for (int n = 0; ; n++) {
24 | Command o = (Command) ois.readObject();
25 | System.out.println("#" + n + " : " + o);
26 | if (o instanceof RemoteInvocationHandler.RPCRequest) {
27 | RemoteInvocationHandler.RPCRequest request = (RemoteInvocationHandler.RPCRequest) o;
28 | System.out.print(" (");
29 | boolean first = true;
30 | for (Object argument : request.getArguments()) {
31 | if (first) {
32 | first = false;
33 | } else {
34 | System.out.print(",");
35 | }
36 | System.out.print(argument);
37 | }
38 | System.out.println(")");
39 | }
40 | if (o.createdAt != null) {
41 | o.createdAt.printStackTrace(System.out);
42 | }
43 | }
44 | }
45 | }
46 | }
47 | }
48 |
--------------------------------------------------------------------------------
/src/test/java/hudson/remoting/URLDeserializatinHelperTest.java:
--------------------------------------------------------------------------------
1 | package hudson.remoting;
2 |
3 | import java.io.IOException;
4 | import java.net.Proxy;
5 | import java.net.URL;
6 | import org.junit.Test;
7 |
8 | public class URLDeserializatinHelperTest {
9 | @Test
10 | public void openURLWithProxy() throws IOException {
11 | URL original = new URL("https://localhost");
12 | URL url = URLDeserializationHelper.wrapIfRequired(original);
13 | url.openConnection(Proxy.NO_PROXY);
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
/src/test/java/hudson/remoting/WithRunner.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright (c) 2010, InfraDNA, Inc.
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 | package hudson.remoting;
25 |
26 | import java.lang.annotation.Documented;
27 | import java.lang.annotation.ElementType;
28 | import java.lang.annotation.Inherited;
29 | import java.lang.annotation.Retention;
30 | import java.lang.annotation.RetentionPolicy;
31 | import java.lang.annotation.Target;
32 |
33 | /**
34 | * Specify the channel runners for a test case.
35 | * @author Kohsuke Kawaguchi
36 | */
37 | @Retention(RetentionPolicy.RUNTIME)
38 | @Target(ElementType.TYPE)
39 | @Documented
40 | @Inherited
41 | public @interface WithRunner {
42 | Class[] value();
43 | }
44 |
--------------------------------------------------------------------------------
/src/test/java/hudson/remoting/pipe/RandomWorkload.java:
--------------------------------------------------------------------------------
1 | package hudson.remoting.pipe;
2 |
3 | import java.io.IOException;
4 | import java.io.InputStream;
5 | import java.io.OutputStream;
6 | import java.util.Random;
7 | import org.junit.Assert;
8 |
9 | /**
10 | * Use {@link Random} with the fixed seed as the data stream to detect corruption.
11 | *
12 | * To shake things up a bit, reading and writing at the different byte[] size boundary.
13 | *
14 | * @author Kohsuke Kawaguchi
15 | */
16 | public class RandomWorkload extends Assert implements Workload {
17 | private final long size;
18 |
19 | /**
20 | * Size of the test.
21 | */
22 | public RandomWorkload(long size) {
23 | this.size = size;
24 | }
25 |
26 | @Override
27 | public void write(OutputStream o) throws IOException {
28 | Random data = new Random(0);
29 | Random boundary = new Random(1);
30 |
31 | for (long l = 0; l < size; ) {
32 | int c = boundary.nextInt(4096);
33 | c = (int) Math.min(c, size - l);
34 |
35 | byte[] buf = new byte[c];
36 | for (int i = 0; i < c; i++) {
37 | buf[i] = (byte) data.nextInt();
38 | }
39 |
40 | o.write(buf);
41 | l += c;
42 | }
43 |
44 | o.close();
45 | }
46 |
47 | @Override
48 | public void read(InputStream i) throws IOException {
49 | Random data = new Random(0);
50 | Random boundary = new Random(2);
51 |
52 | long total = 0;
53 | while (true) {
54 | int c = boundary.nextInt(4096);
55 | byte[] buf = new byte[c];
56 |
57 | int n = i.read(buf);
58 | if (n < 0) {
59 | break;
60 | }
61 |
62 | for (int j = 0; j < n; j++) {
63 | assertEquals(buf[j], (byte) data.nextInt());
64 | }
65 |
66 | total += n;
67 | }
68 |
69 | i.close();
70 | assertEquals(size, total);
71 | }
72 | }
73 |
--------------------------------------------------------------------------------
/src/test/java/hudson/remoting/pipe/Workload.java:
--------------------------------------------------------------------------------
1 | package hudson.remoting.pipe;
2 |
3 | import java.io.IOException;
4 | import java.io.InputStream;
5 | import java.io.OutputStream;
6 |
7 | /**
8 | * Abstraction for creating and verifying data that goes over a input/output stream pair.
9 | *
10 | * @author Kohsuke Kawaguchi
11 | */
12 | public interface Workload {
13 | void write(OutputStream o) throws IOException;
14 |
15 | void read(InputStream i) throws IOException;
16 | }
17 |
--------------------------------------------------------------------------------
/src/test/java/hudson/remoting/throughput/DumbReceiver.java:
--------------------------------------------------------------------------------
1 | package hudson.remoting.throughput;
2 |
3 | import java.io.OutputStream;
4 | import java.net.ServerSocket;
5 | import java.net.Socket;
6 | import org.apache.commons.io.IOUtils;
7 |
8 | /**
9 | * @author Kohsuke Kawaguchi
10 | */
11 | public class DumbReceiver {
12 | public static void main(String[] args) throws Exception {
13 | ServerSocket ss = new ServerSocket(PORT);
14 | while (true) {
15 | System.out.println("Ready");
16 | try (Socket s = ss.accept()) {
17 | System.out.println("Accepted");
18 | IOUtils.copy(s.getInputStream(), OutputStream.nullOutputStream());
19 | }
20 | }
21 | }
22 |
23 | public static final int PORT = 9533;
24 | }
25 |
--------------------------------------------------------------------------------
/src/test/java/hudson/remoting/throughput/DumbSender.java:
--------------------------------------------------------------------------------
1 | package hudson.remoting.throughput;
2 |
3 | import java.io.ByteArrayInputStream;
4 | import java.net.Socket;
5 | import java.util.Random;
6 | import java.util.concurrent.TimeUnit;
7 | import org.apache.commons.io.IOUtils;
8 |
9 | /**
10 | * @author Kohsuke Kawaguchi
11 | */
12 | public class DumbSender {
13 | public static void main(String[] args) throws Exception {
14 | byte[] payload = getRandomSequence();
15 |
16 | for (int i = 0; i < 2; i++) {
17 | try (Socket s = new Socket("127.0.0.2", DumbReceiver.PORT)) {
18 | System.out.println("Started");
19 | long start = System.nanoTime();
20 | IOUtils.copy(new ByteArrayInputStream(payload), s.getOutputStream());
21 | System.out.println("Done: " + TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - start));
22 | }
23 | }
24 | }
25 |
26 | private static byte[] getRandomSequence() {
27 | byte[] buf = new byte[10 * 1024 * 1024];
28 | new Random(0).nextBytes(buf);
29 | return buf;
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/src/test/java/hudson/remoting/throughput/Receiver.java:
--------------------------------------------------------------------------------
1 | package hudson.remoting.throughput;
2 |
3 | import hudson.remoting.Channel;
4 | import hudson.remoting.ChannelBuilder;
5 | import hudson.remoting.SocketChannelStream;
6 | import java.io.BufferedInputStream;
7 | import java.io.BufferedOutputStream;
8 | import java.net.ServerSocket;
9 | import java.net.Socket;
10 | import java.util.concurrent.Executors;
11 |
12 | /**
13 | * Accepts a channel one at a time.
14 | *
15 | * @author Kohsuke Kawaguchi
16 | */
17 | public class Receiver {
18 | public static void main(String[] args) throws Exception {
19 | try (ServerSocket ss = new ServerSocket(PORT)) {
20 | while (true) {
21 | System.out.println("Ready");
22 | try (Socket s = ss.accept()) {
23 | s.setTcpNoDelay(true);
24 | System.out.println("Accepted");
25 | Channel ch = new ChannelBuilder("bogus", Executors.newCachedThreadPool())
26 | .build(
27 | new BufferedInputStream(SocketChannelStream.in(s)),
28 | new BufferedOutputStream(SocketChannelStream.out(s)));
29 | ch.join();
30 | }
31 | }
32 | }
33 | }
34 |
35 | public static final int PORT = 9532;
36 | }
37 |
--------------------------------------------------------------------------------
/src/test/java/hudson/remoting/util/GCTask.java:
--------------------------------------------------------------------------------
1 | package hudson.remoting.util;
2 |
3 | import hudson.remoting.CallableBase;
4 | import java.io.IOException;
5 | import java.util.HashSet;
6 | import java.util.Set;
7 |
8 | /**
9 | * @author Kohsuke Kawaguchi
10 | */
11 | public class GCTask extends CallableBase
26 | *
29 | */
30 | @SuppressFBWarnings(
31 | value = "PATH_TRAVERSAL_IN",
32 | justification =
33 | "These file values are provided by users with sufficient administrative permissions to run this utility program.")
34 | public static void main(String[] argv) throws Exception {
35 | if (argv.length != 2) {
36 | throw new IllegalArgumentException("Usage: java -cp agent.jar hudson.remoting.InitializeJarCacheMain "
37 | + "Rules
12 | *
13 | *
16 | *
17 | * @author Kohsuke Kawaguchi
18 | */
19 | @Target(ElementType.METHOD)
20 | @Retention(RetentionPolicy.SOURCE)
21 | @interface SelectorThreadOnly {}
22 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/remoting/protocol/IOHubRegistrationCallback.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright (c) 2016, CloudBees, Inc., Stephen Connolly
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 | package org.jenkinsci.remoting.protocol;
25 |
26 | import java.nio.channels.ClosedChannelException;
27 | import java.nio.channels.SelectableChannel;
28 | import java.nio.channels.SelectionKey;
29 |
30 | /**
31 | * Callback to be notified when a call to
32 | * {@link IOHub#register(SelectableChannel, IOHubReadyListener, boolean, boolean, boolean, boolean, IOHubRegistrationCallback)} has completed registration.
33 | *
34 | * @since 3.0
35 | */
36 | public interface IOHubRegistrationCallback {
37 |
38 | /**
39 | * Notification callback that the {@link SelectableChannel} has been successfully registered.
40 | *
41 | * @param selectionKey the {@link SelectionKey} that the {@link SelectableChannel} was registered as.
42 | */
43 | void onRegistered(SelectionKey selectionKey);
44 |
45 | /**
46 | * Notification callback that the {@link SelectableChannel} was closed by the time the registration request was
47 | * processed.
48 | *
49 | * @param e the {@link ClosedChannelException} that was thrown when the registration request was attempted.
50 | */
51 | void onClosedChannel(ClosedChannelException e);
52 | }
53 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/remoting/protocol/IOHubRegistrationFutureAdapterImpl.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright (c) 2016, CloudBees, Inc., Stephen Connolly
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 | package org.jenkinsci.remoting.protocol;
25 |
26 | import hudson.remoting.Future;
27 | import java.nio.channels.ClosedChannelException;
28 | import java.nio.channels.SelectionKey;
29 | import org.jenkinsci.remoting.util.SettableFuture;
30 |
31 | /**
32 | * Converts the {@link IOHubRegistrationCallback} pattern into a {@link Future}.
33 | *
34 | * @since 3.0
35 | */
36 | class IOHubRegistrationFutureAdapterImpl implements IOHubRegistrationCallback {
37 | /**
38 | * The future.
39 | */
40 | private final SettableFutureCloseable.
48 | *
49 | * @param closeable the object to close, may be null or already closed
50 | * @since 3.0
51 | */
52 | public static void closeQuietly(Closeable closeable) {
53 | try {
54 | if (closeable != null) {
55 | closeable.close();
56 | }
57 | } catch (IOException ioe) {
58 | // ignore
59 | }
60 | }
61 | }
62 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/remoting/util/PathUtils.java:
--------------------------------------------------------------------------------
1 | /*
2 | *
3 | * The MIT License
4 | *
5 | * Copyright (c) 2017 CloudBees, Inc.
6 | *
7 | * Permission is hereby granted, free of charge, to any person obtaining a copy
8 | * of this software and associated documentation files (the "Software"), to deal
9 | * in the Software without restriction, including without limitation the rights
10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 | * copies of the Software, and to permit persons to whom the Software is
12 | * furnished to do so, subject to the following conditions:
13 | *
14 | * The above copyright notice and this permission notice shall be included in
15 | * all copies or substantial portions of the Software.
16 | *
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 | * THE SOFTWARE.
24 | *
25 | */
26 |
27 | package org.jenkinsci.remoting.util;
28 |
29 | import edu.umd.cs.findbugs.annotations.NonNull;
30 | import java.io.File;
31 | import java.io.IOException;
32 | import java.nio.file.InvalidPathException;
33 | import java.nio.file.Path;
34 | import org.kohsuke.accmod.Restricted;
35 | import org.kohsuke.accmod.restrictions.NoExternalUse;
36 |
37 | /**
38 | * Utilities for {@link Path} handling.
39 | */
40 | @Restricted(NoExternalUse.class)
41 | public class PathUtils {
42 |
43 | private PathUtils() {}
44 |
45 | /**
46 | * Converts {@link File} to {@link Path} and checks runtime exceptions.
47 | * @param file File
48 | * @return Resulting path
49 | * @throws IOException Conversion error caused by {@link InvalidPathException}
50 | * @since 3.14
51 | */
52 | @NonNull
53 | @Restricted(NoExternalUse.class)
54 | public static Path fileToPath(@NonNull File file) throws IOException {
55 | try {
56 | return file.toPath();
57 | } catch (InvalidPathException ex) {
58 | throw new IOException(ex);
59 | }
60 | }
61 | }
62 |
--------------------------------------------------------------------------------
/src/main/java/org/jenkinsci/remoting/util/ThrowableUtils.java:
--------------------------------------------------------------------------------
1 | /*
2 | * The MIT License
3 | *
4 | * Copyright (c) 2016, CloudBees, Inc.
5 | *
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy
7 | * of this software and associated documentation files (the "Software"), to deal
8 | * in the Software without restriction, including without limitation the rights
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | * copies of the Software, and to permit persons to whom the Software is
11 | * furnished to do so, subject to the following conditions:
12 | *
13 | * The above copyright notice and this permission notice shall be included in
14 | * all copies or substantial portions of the Software.
15 | *
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 | * THE SOFTWARE.
23 | */
24 | package org.jenkinsci.remoting.util;
25 |
26 | import edu.umd.cs.findbugs.annotations.CheckForNull;
27 |
28 | /**
29 | * Utility methods to help when working with {@link Throwable} instances.
30 | *
31 | * @since 3.0
32 | */
33 | public class ThrowableUtils {
34 |
35 | /**
36 | * This is a utility class, prevent accidental instance creation.
37 | */
38 | private ThrowableUtils() {
39 | throw new IllegalAccessError("Utility class");
40 | }
41 |
42 | /**
43 | * Allows building a chain of exceptions.
44 | *
45 | * @param e1 The first exception (or {@code null}).
46 | * @param e2 The second exception (or {@code null}).
47 | * @param