Skip to content

Commit

Permalink
#65 add ssh-agent support based on jsch-agent-proxy.
Browse files Browse the repository at this point in the history
  • Loading branch information
norrisjeremy committed Sep 5, 2021
1 parent e4c97e7 commit d3e07e0
Show file tree
Hide file tree
Showing 20 changed files with 1,368 additions and 1 deletion.
21 changes: 21 additions & 0 deletions README.jsch-agent-proxy
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
* UsingPageant.java
This sample demonstrates how to get accesses to Pageant.
$ ./mvnw package
$ ./mvnw exec:java \
-Dexec.classpathScope="test" \
-Dexec.mainClass="com.jcraft.jsch.UsingPageant"

* UsingSSHAgent.java
This sample demonstrates how to get accesses to ssh-agent.
$ ./mvnw package
$ ./mvnw exec:java \
-Dexec.classpathScope="test" \
-Dexec.mainClass="com.jcraft.jsch.UsingSSHAgent"

* JSchWithAgentProxy.java
This sample demonstrates how to integrate jsch-agent-proxy into JSch.
$ ./mvnw package
$ ./mvnw exec:java \
-Dexec.classpathScope="test" \
-Dexec.mainClass="com.jcraft.jsch.JSchWithAgentProxy" \
-Dexec.args="foo@bar.com"
4 changes: 4 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,10 @@ As I explained in a [blog post](http://www.matez.de/index.php/2020/06/22/the-fut
* Fixing [#52](https://github.com/mwiede/jsch/issues/52)
* Deprecate `void setFilenameEncoding(String encoding)` in favor of `void setFilenameEncoding(Charset encoding)` in `ChannelSftp`
* Added support for rsa-sha2-256 & rsa-rsa2-512 algorithms to `ChannelAgentForwarding`
* Address [#65](https://github.com/mwiede/jsch/issues/65) by adding ssh-agent support derived from [jsch-agent-proxy](https://github.com/ymnk/jsch-agent-proxy)
* See `src/test/java/com/jcraft/jsch/JSchWithAgentProxy.java` for simple example
* ssh-agent support requires either [Java 16's JEP 380](https://openjdk.java.net/jeps/380) or the addition of [junixsocket](https://github.com/kohlschutter/junixsocket) to classpath
* Pageant support is untested & requires the addition of [JNA](https://github.com/java-native-access/jna) to classpath
* [0.1.65](https://github.com/mwiede/jsch/releases/tag/jsch-0.1.65)
* Added system properties to allow manipulation of various crypto algorithms used by default
* Integrated JZlib, allowing use of zlib@<!-- -->openssh.com & zlib compressions without the need to provide the JZlib jar-file
Expand Down
52 changes: 51 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,40 @@
</licenses>
<properties>
<skipITs>true</skipITs>
<junixsocket.version>2.4.0</junixsocket.version>
<jna.version>5.9.0</jna.version>
</properties>
<dependencies>
<dependency>
<groupId>com.kohlschutter.junixsocket</groupId>
<artifactId>junixsocket-common</artifactId>
<version>${junixsocket.version}</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>com.kohlschutter.junixsocket</groupId>
<artifactId>junixsocket-native-common</artifactId>
<version>${junixsocket.version}</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>com.kohlschutter</groupId>
<artifactId>compiler-annotations</artifactId>
<version>1.4.2</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>net.java.dev.jna</groupId>
<artifactId>jna-jpms</artifactId>
<version>${jna.version}</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>net.java.dev.jna</groupId>
<artifactId>jna-platform-jpms</artifactId>
<version>${jna.version}</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
Expand Down Expand Up @@ -106,7 +138,7 @@
<configuration>
<rules>
<requireJavaVersion>
<version>15</version>
<version>16</version>
</requireJavaVersion>
</rules>
</configuration>
Expand Down Expand Up @@ -179,6 +211,19 @@
<release>15</release>
</configuration>
</execution>
<execution>
<id>default-compile-16</id>
<goals>
<goal>compile</goal>
</goals>
<configuration>
<compileSourceRoots>
<compileSourceRoot>${project.basedir}/src/main/java16</compileSourceRoot>
</compileSourceRoots>
<multiReleaseOutput>true</multiReleaseOutput>
<release>16</release>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
Expand Down Expand Up @@ -276,6 +321,11 @@
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.7</version>
<configuration>
<excludes>
<exclude>com/jcraft/jsch/UnixDomainSocketFactory.class</exclude>
</excludes>
</configuration>
<executions>
<execution>
<id>default-prepare-agent</id>
Expand Down
36 changes: 36 additions & 0 deletions src/main/java/com/jcraft/jsch/AgentConnector.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/* -*-mode:java; c-basic-offset:2; indent-tabs-mode:nil -*- */
/*
Copyright (c) 2011 ymnk, JCraft,Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the distribution.
3. The names of the authors may not be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JCRAFT,
INC. OR ANY CONTRIBUTORS TO THIS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

package com.jcraft.jsch;

public interface AgentConnector {
String getName();
boolean isAvailable();
void query(Buffer buffer) throws AgentProxyException;
}
80 changes: 80 additions & 0 deletions src/main/java/com/jcraft/jsch/AgentIdentity.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
/* -*-mode:java; c-basic-offset:2; indent-tabs-mode:nil -*- */
/*
Copyright (c) 2011 ymnk, JCraft,Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the distribution.
3. The names of the authors may not be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JCRAFT,
INC. OR ANY CONTRIBUTORS TO THIS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

package com.jcraft.jsch;

class AgentIdentity implements Identity {

private AgentProxy agent;
private byte[] blob;
private String comment;
private String algname;
AgentIdentity(AgentProxy agent, byte[] blob, String comment) {
this.agent = agent;
this.blob = blob;
this.comment = comment;
algname = Util.byte2str((new Buffer(blob)).getString());
}

@Override
public boolean setPassphrase(byte[] passphrase) throws JSchException{
return true;
}

@Override
public byte[] getPublicKeyBlob() { return blob; }

@Override
public byte[] getSignature(byte[] data){
return agent.sign(blob, data, null);
}

@Override
public byte[] getSignature(byte[] data, String alg){
return agent.sign(blob, data, alg);
}

@Override
@Deprecated
public boolean decrypt() {
throw new RuntimeException("not implemented");
}

@Override
public String getAlgName() { return algname; }

@Override
public String getName() { return comment; }

@Override
public boolean isEncrypted() { return false; }

@Override
public void clear() { }
}
75 changes: 75 additions & 0 deletions src/main/java/com/jcraft/jsch/AgentIdentityRepository.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
/* -*-mode:java; c-basic-offset:2; indent-tabs-mode:nil -*- */
/*
Copyright (c) 2011 ymnk, JCraft,Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the distribution.
3. The names of the authors may not be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JCRAFT,
INC. OR ANY CONTRIBUTORS TO THIS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

package com.jcraft.jsch;

import java.util.Vector;

public class AgentIdentityRepository implements IdentityRepository {

private AgentProxy agent;
public AgentIdentityRepository(AgentConnector connector) {
this.agent = new AgentProxy(connector);
}

@Override
public Vector<Identity> getIdentities() {
return agent.getIdentities();
}

@Override
public boolean add(byte[] identity) {
return agent.addIdentity(identity);
}

@Override
public boolean remove(byte[] blob) {
return agent.removeIdentity(blob);
}

@Override
public void removeAll() {
agent.removeAllIdentities();
}

@Override
public String getName() {
return agent.getConnector().getName();
}

@Override
public int getStatus() {
if(agent.getConnector().isAvailable()){
return RUNNING;
}
else {
return NOTRUNNING;
}
}
}
Loading

0 comments on commit d3e07e0

Please sign in to comment.