Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #18 from jglick/ExecRemoteAgent-JENKINS-36997
[JENKINS-36997] CLI implementation of RemoteAgent
- Loading branch information
Showing
9 changed files
with
278 additions
and
39 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
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
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
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
172 changes: 172 additions & 0 deletions
172
src/main/java/com/cloudbees/jenkins/plugins/sshagent/exec/ExecRemoteAgent.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,172 @@ | ||
| /* | ||
| * The MIT License | ||
| * | ||
| * Copyright (c) 2014, Eccam s.r.o., Milan Kriz, 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 com.cloudbees.jenkins.plugins.sshagent.exec; | ||
|
|
||
| import com.cloudbees.jenkins.plugins.sshagent.RemoteAgent; | ||
| import hudson.AbortException; | ||
| import hudson.FilePath; | ||
| import hudson.Launcher; | ||
| import hudson.model.TaskListener; | ||
| import java.io.ByteArrayOutputStream; | ||
| import java.io.IOException; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
|
|
||
| /** | ||
| * An implementation that uses native SSH agent installed on a system. | ||
| */ | ||
| public class ExecRemoteAgent implements RemoteAgent { | ||
| private static final String AuthSocketVar = "SSH_AUTH_SOCK"; | ||
| private static final String AgentPidVar = "SSH_AGENT_PID"; | ||
|
|
||
| private final Launcher launcher; | ||
|
|
||
| /** | ||
| * The listener in case we need to report exceptions | ||
| */ | ||
| private final TaskListener listener; | ||
|
|
||
| private final FilePath temp; | ||
|
|
||
| /** | ||
| * The socket bound by the agent. | ||
| */ | ||
| private final String socket; | ||
|
|
||
| /** Agent environment used for {@code ssh-add} and {@code ssh-agent -k}. */ | ||
| private final Map<String, String> agentEnv; | ||
|
|
||
| ExecRemoteAgent(Launcher launcher, TaskListener listener, FilePath temp) throws Exception { | ||
| this.launcher = launcher; | ||
| this.listener = listener; | ||
| this.temp = temp; | ||
|
|
||
| ByteArrayOutputStream baos = new ByteArrayOutputStream(); | ||
| if (launcher.launch().cmds("ssh-agent").stdout(baos).start().joinWithTimeout(1, TimeUnit.MINUTES, listener) != 0) { | ||
| throw new AbortException("Failed to run ssh-agent"); | ||
| } | ||
| agentEnv = parseAgentEnv(new String(baos.toByteArray(), StandardCharsets.US_ASCII)); // TODO could include local filenames, better to look up remote charset | ||
|
|
||
| if (agentEnv.containsKey(AuthSocketVar)) { | ||
| socket = agentEnv.get(AuthSocketVar); | ||
| } else { | ||
| throw new AbortException(AuthSocketVar + " was not included"); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public String getSocket() { | ||
| return socket; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public void addIdentity(String privateKey, final String passphrase, String comment) throws IOException, InterruptedException { | ||
| FilePath keyFile = temp.createTextTempFile("private_key_", ".key", privateKey); | ||
| try { | ||
| keyFile.chmod(0600); | ||
|
|
||
| FilePath askpass = passphrase != null ? createAskpassScript() : null; | ||
| try { | ||
|
|
||
| Map<String,String> env = new HashMap<>(agentEnv); | ||
| if (passphrase != null) { | ||
| env.put("SSH_PASSPHRASE", passphrase); | ||
| env.put("DISPLAY", ":0"); // just to force using SSH_ASKPASS | ||
| env.put("SSH_ASKPASS", askpass.getRemote()); | ||
| } | ||
| if (launcher.launch().cmds("ssh-add", keyFile.getRemote()).envs(env).stdout(listener).start().joinWithTimeout(1, TimeUnit.MINUTES, listener) != 0) { | ||
| throw new AbortException("Failed to run ssh-add"); | ||
| } | ||
| } finally { | ||
| if (askpass != null && askpass.exists()) { // the ASKPASS script is self-deleting, anyway rather try to delete it in case of some error | ||
| askpass.delete(); | ||
| } | ||
| } | ||
| } finally { | ||
| keyFile.delete(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public void stop() throws IOException, InterruptedException { | ||
| if (launcher.launch().cmds("ssh-agent", "-k").envs(agentEnv).stdout(listener).start().joinWithTimeout(1, TimeUnit.MINUTES, listener) != 0) { | ||
| throw new AbortException("Failed to run ssh-agent -k"); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Parses ssh-agent output. | ||
| */ | ||
| private Map<String,String> parseAgentEnv(String agentOutput) throws Exception{ | ||
| Map<String, String> env = new HashMap<>(); | ||
|
|
||
| // get SSH_AUTH_SOCK | ||
| env.put(AuthSocketVar, getAgentValue(agentOutput, AuthSocketVar)); | ||
| listener.getLogger().println(AuthSocketVar + "=" + env.get(AuthSocketVar)); | ||
|
|
||
| // get SSH_AGENT_PID | ||
| env.put(AgentPidVar, getAgentValue(agentOutput, AgentPidVar)); | ||
| listener.getLogger().println(AgentPidVar + "=" + env.get(AgentPidVar)); | ||
|
|
||
| return env; | ||
| } | ||
|
|
||
| /** | ||
| * Parses a value from ssh-agent output. | ||
| */ | ||
| private String getAgentValue(String agentOutput, String envVar) { | ||
| int pos = agentOutput.indexOf(envVar) + envVar.length() + 1; // +1 for '=' | ||
| int end = agentOutput.indexOf(';', pos); | ||
| return agentOutput.substring(pos, end); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a self-deleting script for SSH_ASKPASS. Self-deleting to be able to detect a wrong passphrase. | ||
| */ | ||
| private FilePath createAskpassScript() throws IOException, InterruptedException { | ||
| // TODO: assuming that ssh-add runs the script in shell even on Windows, not cmd | ||
| // for cmd following could work | ||
| // suffix = ".bat"; | ||
| // script = "@ECHO %SSH_PASSPHRASE%\nDEL \"" + askpass.getAbsolutePath() + "\"\n"; | ||
|
|
||
| FilePath askpass = temp.createTextTempFile("askpass_", ".sh", "#!/bin/sh\necho $SSH_PASSPHRASE\nrm $0\n"); | ||
|
|
||
| // executable only for a current user | ||
| askpass.chmod(0700); | ||
| return askpass; | ||
| } | ||
| } |
84 changes: 84 additions & 0 deletions
84
src/main/java/com/cloudbees/jenkins/plugins/sshagent/exec/ExecRemoteAgentFactory.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,84 @@ | ||
| /* | ||
| * The MIT License | ||
| * | ||
| * Copyright (c) 2014, Eccam s.r.o., Milan Kriz | ||
| * | ||
| * 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 com.cloudbees.jenkins.plugins.sshagent.exec; | ||
|
|
||
| import com.cloudbees.jenkins.plugins.sshagent.RemoteAgent; | ||
| import com.cloudbees.jenkins.plugins.sshagent.RemoteAgentFactory; | ||
| import hudson.Extension; | ||
| import hudson.FilePath; | ||
| import hudson.Launcher; | ||
| import hudson.model.TaskListener; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
|
|
||
|
|
||
| /** | ||
| * A factory that uses the native SSH agent installed on a remote system. SSH agent has to be in PATH environment variable. | ||
| */ | ||
| @Extension | ||
| public class ExecRemoteAgentFactory extends RemoteAgentFactory { | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public String getDisplayName() { | ||
| return "Exec ssh-agent (binary ssh-agent on a remote machine)"; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public boolean isSupported(Launcher launcher, final TaskListener listener) { | ||
| try { | ||
| int status = launcher.launch().cmds("ssh-agent", "-k").quiet(true).start().joinWithTimeout(1, TimeUnit.MINUTES, listener); | ||
| /* | ||
| * `ssh-agent -k` returns 0 if terminates running agent or 1 if | ||
| * it fails to terminate it. On Linux, | ||
| */ | ||
| return (status == 0) || (status == 1); | ||
| } catch (IOException e) { | ||
| e.printStackTrace(); | ||
| listener.getLogger().println("Could not find ssh-agent: IOException: " + e.getMessage()); | ||
| listener.getLogger().println("Check if ssh-agent is installed and in PATH"); | ||
| return false; | ||
| } catch (InterruptedException e) { | ||
| e.printStackTrace(); | ||
| listener.getLogger().println("Could not find ssh-agent: InterruptedException: " + e.getMessage()); | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public RemoteAgent start(Launcher launcher, final TaskListener listener, FilePath temp) throws Throwable { | ||
| return new ExecRemoteAgent(launcher, listener, temp); | ||
| } | ||
| } |
Oops, something went wrong.