Package org.apache.sshd.agent.common

Class AbstractAgentProxy

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.agent.common.AbstractAgentProxy

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.Channel, SshAgent, ExecutorServiceCarrier

public abstract class AbstractAgentProxy
extends AbstractLoggingBean
implements SshAgent, ExecutorServiceCarrier

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	channelType
private CloseableExecutorService	executor

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

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

SSH_AUTHSOCKET_ENV_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAgentProxy(CloseableExecutorService executorService)

Method Summary

Modifier and Type	Method	Description
void	addIdentity(java.security.KeyPair kp, java.lang.String comment, SshAgentKeyConstraint... constraints)	Adds a key to the agent.
void	close()
protected Buffer	createBuffer(byte cmd)
protected Buffer	createBuffer(byte cmd, int extraLen)
java.lang.String	getChannelType()
CloseableExecutorService	getExecutorService()
java.lang.Iterable<? extends java.util.Map.Entry<java.security.PublicKey,java.lang.String>>	getIdentities()
protected Buffer	prepare(Buffer buffer)
void	removeAllIdentities()
void	removeIdentity(java.security.PublicKey key)
protected abstract Buffer	request(Buffer buffer)
void	setChannelType(java.lang.String channelType)
java.util.Map.Entry<java.lang.String,byte[]>	sign(SessionContext session, java.security.PublicKey key, java.lang.String algo, byte[] data)

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.nio.channels.Channel

isOpen

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

resolveLocalIdentity

Field Detail

executor

private CloseableExecutorService executor

channelType

private java.lang.String channelType

Constructor Detail

AbstractAgentProxy

protected AbstractAgentProxy(CloseableExecutorService executorService)

Method Detail

getChannelType

public java.lang.String getChannelType()

setChannelType

public void setChannelType(java.lang.String channelType)

getExecutorService

public CloseableExecutorService getExecutorService()

Specified by:

getExecutorService in interface ExecutorServiceCarrier

Returns:

The CloseableExecutorService to use

getIdentities

public java.lang.Iterable<? extends java.util.Map.Entry<java.security.PublicKey,java.lang.String>> getIdentities()
                                                                                                                throws java.io.IOException

Specified by:

getIdentities in interface SshAgent

Throws:

java.io.IOException

sign

public java.util.Map.Entry<java.lang.String,byte[]> sign(SessionContext session,
                                                               java.security.PublicKey key,
                                                               java.lang.String algo,
                                                               byte[] data)
                                                        throws java.io.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:

java.io.IOException - If failed to sign

addIdentity

public void addIdentity(java.security.KeyPair kp,
                        java.lang.String comment,
                        SshAgentKeyConstraint... constraints)
                 throws java.io.IOException

Description copied from interface: SshAgent

Adds a key to the agent.

Specified by:

addIdentity in interface SshAgent

Parameters:

kp - KeyPair to add

comment - to associate with the key

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

Throws:

java.io.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

removeIdentity

public void removeIdentity(java.security.PublicKey key)
                    throws java.io.IOException

Specified by:

removeIdentity in interface SshAgent

Throws:

java.io.IOException

removeAllIdentities

public void removeAllIdentities()
                         throws java.io.IOException

Specified by:

removeAllIdentities in interface SshAgent

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.nio.channels.Channel

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

createBuffer

protected Buffer createBuffer(byte cmd)

createBuffer

protected Buffer createBuffer(byte cmd,
                              int extraLen)

prepare

protected Buffer prepare(Buffer buffer)

request

protected abstract Buffer request(Buffer buffer)
                           throws java.io.IOException

Throws:

java.io.IOException