Package org.apache.sshd.agent.local

Class AgentImpl

java.lang.Object

org.apache.sshd.agent.local.AgentImpl

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, SshAgent

public class AgentImpl
extends Object
implements SshAgent

A local SSH agent implementation

Field Summary

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

SSH_AUTHSOCKET_ENV_NAME

Constructor Summary

Constructors

Constructor	Description
AgentImpl()

Method Summary

Modifier and Type	Method	Description
void	addIdentity(KeyPair key, String comment, SshAgentKeyConstraint... constraints)	Adds a key to the agent.
void	close()
Iterable<? extends Map.Entry<PublicKey,String>>	getIdentities()
protected static Map.Entry<KeyPair,String>	getKeyPair(Collection<? extends Map.Entry<KeyPair,String>> keys, PublicKey key)
boolean	isOpen()
void	removeAllIdentities()
void	removeIdentity(PublicKey key)
KeyPair	resolveLocalIdentity(PublicKey key)	Used for reporting client-side public key authentication via agent
Map.Entry<String,byte[]>	sign(SessionContext session, PublicKey key, String algo, byte[] data)

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentImpl

public AgentImpl()

Method Detail

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

getIdentities

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

Specified by:

getIdentities in interface SshAgent

Throws:

IOException

sign

public Map.Entry<String,byte[]> sign(SessionContext session,
                                           PublicKey key,
                                           String algo,
                                           byte[] data)
                                    throws IOException

Specified by:

sign in interface SshAgent

Parameters:

session - The current SessionContext

key - The PublicKey to use for signing

algo - Recommended signature algorithm - if null/empty then one will be selected based on the key type and/or signature factories. Note: even if specific algorithm specified, the implementation may disregard and choose another

data - Data to sign

Returns:

used algorithm + signed data - using the identity

Throws:

IOException - If failed to sign

addIdentity

public void addIdentity(KeyPair key,
                        String comment,
                        SshAgentKeyConstraint... constraints)
                 throws IOException

Description copied from interface: SshAgent

Adds a key to the agent.

Specified by:

addIdentity in interface SshAgent

Parameters:

key - KeyPair to add

comment - to associate with the key

constraints - SshAgentKeyConstraints for this key to pass on to the agent

Throws:

IOException - if an error in the communication with the agent occurred, or the agent did not return a reply indicating successful addition of the key

resolveLocalIdentity

public KeyPair resolveLocalIdentity(PublicKey key)

Description copied from interface: SshAgent

Used for reporting client-side public key authentication via agent

Specified by:

resolveLocalIdentity in interface SshAgent

Parameters:

key - The PublicKey that is going to be used

Returns:

The KeyPair identity for it - if available - null otherwise

removeIdentity

public void removeIdentity(PublicKey key)
                    throws IOException

Specified by:

removeIdentity in interface SshAgent

Throws:

IOException

removeAllIdentities

public void removeAllIdentities()
                         throws IOException

Specified by:

removeAllIdentities in interface SshAgent

Throws:

IOException

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

getKeyPair

protected static Map.Entry<KeyPair,String> getKeyPair(Collection<? extends Map.Entry<KeyPair,String>> keys,
                                                            PublicKey key)