Package org.apache.sshd.agent

Interface SshAgentFactory

All Known Implementing Classes:
LocalAgentFactory, ProxyAgentFactory, UnixAgentFactory
public interface SshAgentFactory
The SshAgentFactory is used to communicate with an SshAgent.

  • Method Details

    • getChannelForwardingFactories

      List<ChannelFactory> getChannelForwardingFactories(FactoryManager manager)
      The channels are requested by the ssh server when forwarding a client request. The channel will receive agent requests and needs to forward them to the agent, either local or through another proxy.
      Parameters:
      manager - The FactoryManager through which the request is made
      Returns:
      The ChannelFactory-ies used to create channels for agent forwarding on the client side. If null or empty, agent forwarding is not available.

    • createClient

      SshAgent createClient(Session session, FactoryManager manager) throws IOException
      Create an SshAgent that can be used on the client side by the authentication process to send possible keys.
      Parameters:
      session - the Session the SshAgent is to be created for; may be null
      manager - The FactoryManager instance
      Returns:
      The SshAgent instance, or null if no SSH agent shall be used
      Throws:
      IOException - If failed to create the client

    • createServer

      SshAgentServer createServer(ConnectionService service) throws IOException
      Create the server side that will be used by other SSH clients. It will usually create a channel that will forward the requests to the original client.
      Parameters:
      service - The ConnectionService to use
      Returns:
      The SshAgentServer instance
      Throws:
      IOException - If failed to create the server