Package com.hierynomus.sshj.userauth.agent

Class AuthAgent

java.lang.Object

net.schmizz.sshj.userauth.method.AbstractAuthMethod

net.schmizz.sshj.userauth.method.KeyedAuthMethod

com.hierynomus.sshj.userauth.agent.AuthAgent

All Implemented Interfaces:

SSHPacketHandler, AuthMethod

public class AuthAgent
extends KeyedAuthMethod

The "publickey" authentication method backed by an SSH agent, for a single agent identity.

It behaves exactly like AuthPublickey - send the public key, and on SSH_MSG_USERAUTH_PK_OK send a signed request - except the signature is produced by the AgentProxy (which drives the hardware, PIN and touch) and used verbatim. This is how FIDO/U2F security keys (sk-*) authenticate: the agent returns a complete signature with the security-key flags and counter already appended.

Use fromIdentities(AgentProxy) to turn every identity the agent holds into a method:

   try (AgentProxy agent = AgentProxy.fromEnvironment()) {
       ssh.auth(username, AuthAgent.fromIdentities(agent));
   }
 

Field Summary

Fields inherited from class net.schmizz.sshj.userauth.method.KeyedAuthMethod

kProv

Fields inherited from class net.schmizz.sshj.userauth.method.AbstractAuthMethod

log, params

Constructor Summary

Constructors

Constructor	Description
AuthAgent(AgentProxy agent, AgentIdentity identity)

Method Summary

Modifier and Type	Method	Description
protected SSHPacket	buildReq()	Builds a SSHPacket containing the fields common to all authentication method.
static List<AuthMethod>	fromIdentities(AgentProxy agent)	Build one AuthAgent method per identity the agent currently holds, ready to hand to SSHClient.auth(String, Iterable).
void	handle(Message cmd, SSHPacket buf)	Delegate handling of some SSH packet to this object.
protected SSHPacket	putPubKey(SSHPacket reqBuf)

Methods inherited from class net.schmizz.sshj.userauth.method.KeyedAuthMethod

getPublicKeyAlgorithm, putSig, shouldRetry

Methods inherited from class net.schmizz.sshj.userauth.method.AbstractAuthMethod

getName, init, makeAccountResource, request, setLoggerFactory

Methods inherited from class java.lang.Object

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

Constructor Details

AuthAgent

public AuthAgent(AgentProxy agent,
 AgentIdentity identity)

Method Details

fromIdentities

public static List<AuthMethod> fromIdentities(AgentProxy agent)
                                       throws IOException

Build one AuthAgent method per identity the agent currently holds, ready to hand to SSHClient.auth(String, Iterable).

Throws:

IOException

handle

public void handle(Message cmd,
 SSHPacket buf)
            throws UserAuthException,
TransportException

Description copied from interface: SSHPacketHandler

Delegate handling of some SSH packet to this object.

Specified by:

handle in interface SSHPacketHandler

Overrides:

handle in class AbstractAuthMethod

Parameters:

cmd - the SSH message identifier

buf - SSHPacket containing rest of the request

Throws:

UserAuthException

TransportException

buildReq

protected SSHPacket buildReq()
                      throws UserAuthException

Description copied from class: AbstractAuthMethod

Builds a SSHPacket containing the fields common to all authentication method. Method-specific fields can further be put into this buffer.

Overrides:

buildReq in class AbstractAuthMethod

Throws:

UserAuthException

putPubKey

protected SSHPacket putPubKey(SSHPacket reqBuf)
                       throws UserAuthException

Overrides:

putPubKey in class KeyedAuthMethod

Throws:

UserAuthException