jenkins.slaves

Class JnlpSlaveAgentProtocol

java.lang.Object

jenkins.AgentProtocol

jenkins.slaves.JnlpSlaveAgentProtocol

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

JnlpSlaveAgentProtocol2

@Extension
public class JnlpSlaveAgentProtocol
extends AgentProtocol

AgentProtocol that accepts connection from slave agents.

Security

Once connected, remote slave agents can send in commands to be executed on the master, so in a way this is like an rsh service. Therefore, it is important that we reject connections from unauthorized remote slaves.

We do this by computing HMAC of the slave name. This code is sent to the slave inside the .jnlp file (this file itself is protected by HTTP form-based authentication that we use everywhere else in Jenkins), and the slave sends this token back when it connects to the master. Unauthorized slaves can't access the protected .jnlp file, so it can't impersonate a valid slave.

We don't want to force the JNLP slave agents to be restarted whenever the server restarts, so right now this secret master key is generated once and used forever, which makes this whole scheme less secure.

Since:

1.467

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	JnlpSlaveAgentProtocol.Handler

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static HMACConfidentialKey	SLAVE_SECRET This secret value is used as a seed for slaves.

Constructor Summary

Constructors

Constructor and Description
JnlpSlaveAgentProtocol()

Method Summary

Modifier and Type	Method and Description
String	getName() Protocol name.
void	handle(Socket socket) Called by the connection handling thread to execute the protocol.

Methods inherited from class jenkins.AgentProtocol

all, of

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SLAVE_SECRET

public static final HMACConfidentialKey SLAVE_SECRET

This secret value is used as a seed for slaves.

Constructor Detail

JnlpSlaveAgentProtocol

public JnlpSlaveAgentProtocol()

Method Detail

getName

public String getName()

Description copied from class: AgentProtocol

Protocol name. This is a short string that consists of printable ASCII chars. Sent by the client to select the protocol.

Specified by:

getName in class AgentProtocol

Returns:

null to be disabled. This is useful for avoiding getting used until the protocol is properly configured.

handle

public void handle(Socket socket)
            throws IOException,
                   InterruptedException

Description copied from class: AgentProtocol

Called by the connection handling thread to execute the protocol.

Specified by:

handle in class AgentProtocol

Throws:

IOException

InterruptedException