Module org.eclipse.jgit.ssh.apache

Package org.eclipse.jgit.internal.transport.sshd.agent

Class SshAgentClient

java.lang.Object

org.eclipse.jgit.internal.transport.sshd.agent.SshAgentClient

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, org.apache.sshd.agent.SshAgent

public class SshAgentClient
extends Object
implements org.apache.sshd.agent.SshAgent

A client for an SSH2 agent. This client supports querying identities, signature requests, and adding keys to an agent (with or without constraints). Removing keys is not supported, and the older SSH1 protocol is not supported.

See Also:

• SSH Agent Protocol, RFC draft

Field Summary

Fields inherited from interface org.apache.sshd.agent.SshAgent

SSH_AUTHSOCKET_ENV_NAME

Constructor Summary

Constructors

Constructor	Description
SshAgentClient(Connector connector)	Creates a new SshAgentClient implementing the SSH2 ssh agent protocol, using the given Connector to connect to the SSH agent and to exchange messages.

Method Summary

Modifier and Type	Method	Description
void	addIdentity(KeyPair key, String comment, org.apache.sshd.agent.SshAgentKeyConstraint... constraints)
void	close()
Iterable<? extends Map.Entry<PublicKey,String>>	getIdentities()
boolean	isOpen()
void	removeAllIdentities()
void	removeIdentity(PublicKey key)
Map.Entry<String,byte[]>	sign(org.apache.sshd.common.session.SessionContext session, PublicKey key, String algorithm, byte[] data)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.agent.SshAgent

resolveLocalIdentity

Constructor Details

SshAgentClient

public SshAgentClient(Connector connector)

Creates a new SshAgentClient implementing the SSH2 ssh agent protocol, using the given Connector to connect to the SSH agent and to exchange messages.

Parameters:

connector - Connector to use

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Throws:

IOException

getIdentities

public Iterable<? extends Map.Entry<PublicKey,String>> getIdentities()
                                                              throws IOException

Specified by:

getIdentities in interface org.apache.sshd.agent.SshAgent

Throws:

IOException

sign

public Map.Entry<String,byte[]> sign(org.apache.sshd.common.session.SessionContext session,
 PublicKey key,
 String algorithm,
 byte[] data)
                              throws IOException

Specified by:

sign in interface org.apache.sshd.agent.SshAgent

Throws:

IOException

addIdentity

public void addIdentity(KeyPair key,
 String comment,
 org.apache.sshd.agent.SshAgentKeyConstraint... constraints)
                 throws IOException

Specified by:

addIdentity in interface org.apache.sshd.agent.SshAgent

Throws:

IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

removeIdentity

public void removeIdentity(PublicKey key)
                    throws IOException

Specified by:

removeIdentity in interface org.apache.sshd.agent.SshAgent

Throws:

IOException

removeAllIdentities

public void removeAllIdentities()
                         throws IOException

Specified by:

removeAllIdentities in interface org.apache.sshd.agent.SshAgent

Throws:

IOException