Package org.apache.sshd.cli.client

Class SshKeyScanMain

java.lang.Object

org.apache.sshd.cli.client.SshKeyScanMain

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, Callable<Void>, EventListener, ServerKeyVerifier, SessionListener, SimplifiedLog, SshdEventListener

public class SshKeyScanMain
extends Object
implements Channel, Callable<Void>, ServerKeyVerifier, SessionListener, SimplifiedLog

A naive implementation of ssh-keyscan(1)

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.sshd.common.session.SessionListener

SessionListener.Event

Field Summary

Fields

Modifier and Type	Field	Description
private SshClient	client
private final Map<String,String>	currentHostFingerprints
static final List<String>	DEFAULT_KEY_TYPES	Default key types if not overridden from the command line
static final Level	DEFAULT_LEVEL
static final long	DEFAULT_TIMEOUT
private InputStream	input
private List<String>	keyTypes
private Level	level
private final AtomicBoolean	open
private int	port
private long	timeout

Fields inherited from interface org.apache.sshd.common.util.logging.SimplifiedLog

EMPTY

Constructor Summary

Constructors

Constructor	Description
SshKeyScanMain()

Method Summary

Modifier and Type	Method	Description
Void	call()
void	close()
protected List<KeyPair>	createKeyPairs(String keyType)
protected Map<String,List<KeyPair>>	createKeyPairs(Collection<String> typeNames)
InputStream	getInputStream()
List<String>	getKeyTypes()
Level	getLogLevel()
int	getPort()
long	getTimeout()
static <S extends SshKeyScanMain> S	initializeScanner(S scanner, Collection<String> hosts)
boolean	isEnabledLevel(Level level)
boolean	isOpen()
void	log(Level level, Object message, Throwable t)
protected void	logNegotiationProposal(String type, Map<KexProposalOption,String> proposal)
protected void	logSessionEvent(Session session, Object event)
static void	main(String[] args)
static List<String>	parseCommandLineArguments(SshKeyScanMain scanner, String... args)
protected void	resolveServerKeys(SshClient client, String host, String kt, List<KeyPair> ids)
protected void	resolveServerKeys(SshClient client, String host, Map<String,List<KeyPair>> pairsMap, Map<String,List<NamedFactory<Signature>>> sigFactories)
protected List<NamedFactory<Signature>>	resolveSignatureFactories(String keyType)
void	sessionClosed(Session session)	A session has been closed
void	sessionCreated(Session session)	A new session just been created
void	sessionEvent(Session session, SessionListener.Event event)	An event has been triggered
void	sessionException(Session session, Throwable t)	An exception was caught and the session will be closed (if not already so).
void	sessionNegotiationEnd(Session session, Map<KexProposalOption,String> clientProposal, Map<KexProposalOption,String> serverProposal, Map<KexProposalOption,String> negotiatedOptions, Throwable reason)	Signals the end of the negotiation options handling
void	sessionNegotiationStart(Session session, Map<KexProposalOption,String> clientProposal, Map<KexProposalOption,String> serverProposal)	Signals the start of the negotiation options handling
void	setInputStream(InputStream input)
static <S extends SshKeyScanMain> S	setInputStream(S scanner, Collection<String> hosts)
void	setKeyTypes(List<String> keyTypes)
void	setLogLevel(Level level)
void	setPort(int port)
void	setTimeout(long timeout)
private static String	toString(SocketAddress addr)
boolean	verifyServerKey(ClientSession sshClientSession, SocketAddress remoteAddress, PublicKey serverKey)	Verify that the server key provided is really the one of the host.
protected void	writeServerKey(String remoteLocation, String keyType, PublicKey serverKey)

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.common.session.SessionListener

sessionDisconnect, sessionEstablished, sessionNegotiationOptionsCreated, sessionPeerIdentificationLine, sessionPeerIdentificationReceived, sessionPeerIdentificationSend

Methods inherited from interface org.apache.sshd.common.util.logging.SimplifiedLog

debug, debug, error, error, info, info, isDebugEnabled, isErrorEnabled, isInfoEnabled, isTraceEnabled, isWarnEnabled, log, trace, trace, warn, warn

Field Details

DEFAULT_KEY_TYPES

public static final List<String> DEFAULT_KEY_TYPES

Default key types if not overridden from the command line

DEFAULT_TIMEOUT

public static final long DEFAULT_TIMEOUT

DEFAULT_LEVEL

public static final Level DEFAULT_LEVEL

open

private final AtomicBoolean open

client

private SshClient client

port

private int port

timeout

private long timeout

keyTypes

private List<String> keyTypes

input

private InputStream input

level

private Level level

currentHostFingerprints

private final Map<String,String> currentHostFingerprints

Constructor Details

SshKeyScanMain

public SshKeyScanMain()

Method Details

getPort

public int getPort()

setPort

public void setPort(int port)

getInputStream

public InputStream getInputStream()

setInputStream

public void setInputStream(InputStream input)

getKeyTypes

public List<String> getKeyTypes()

setKeyTypes

public void setKeyTypes(List<String> keyTypes)

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

getLogLevel

public Level getLogLevel()

setLogLevel

public void setLogLevel(Level level)

log

public void log(Level level,
 Object message,
 Throwable t)

Specified by:

log in interface SimplifiedLog

isEnabledLevel

public boolean isEnabledLevel(Level level)

Specified by:

isEnabledLevel in interface SimplifiedLog

call

public Void call()
          throws Exception

Specified by:

call in interface Callable<Void>

Throws:

Exception

resolveServerKeys

protected void resolveServerKeys(SshClient client,
 String host,
 Map<String,List<KeyPair>> pairsMap,
 Map<String,List<NamedFactory<Signature>>> sigFactories)
                          throws IOException

Throws:

IOException

resolveServerKeys

protected void resolveServerKeys(SshClient client,
 String host,
 String kt,
 List<KeyPair> ids)
                          throws Exception

Throws:

Exception

sessionCreated

public void sessionCreated(Session session)

Description copied from interface: SessionListener

A new session just been created

Specified by:

sessionCreated in interface SessionListener

Parameters:

session - The created Session

sessionEvent

public void sessionEvent(Session session,
 SessionListener.Event event)

Description copied from interface: SessionListener

An event has been triggered

Specified by:

sessionEvent in interface SessionListener

Parameters:

session - The referenced Session

event - The generated SessionListener.Event

sessionException

public void sessionException(Session session,
 Throwable t)

Description copied from interface: SessionListener

An exception was caught and the session will be closed (if not already so). Note: the code makes no guarantee that at this stage SessionListener.sessionClosed(Session) will be called or perhaps has already been called

Specified by:

sessionException in interface SessionListener

Parameters:

session - The referenced Session

t - The caught exception

sessionClosed

public void sessionClosed(Session session)

Description copied from interface: SessionListener

A session has been closed

Specified by:

sessionClosed in interface SessionListener

Parameters:

session - The closed Session

sessionNegotiationStart

public void sessionNegotiationStart(Session session,
 Map<KexProposalOption,String> clientProposal,
 Map<KexProposalOption,String> serverProposal)

Description copied from interface: SessionListener

Signals the start of the negotiation options handling

Specified by:

sessionNegotiationStart in interface SessionListener

Parameters:

session - The referenced Session

clientProposal - The client proposal options (un-modifiable)

serverProposal - The server proposal options (un-modifiable)

logNegotiationProposal

protected void logNegotiationProposal(String type,
 Map<KexProposalOption,String> proposal)

sessionNegotiationEnd

public void sessionNegotiationEnd(Session session,
 Map<KexProposalOption,String> clientProposal,
 Map<KexProposalOption,String> serverProposal,
 Map<KexProposalOption,String> negotiatedOptions,
 Throwable reason)

Description copied from interface: SessionListener

Signals the end of the negotiation options handling

Specified by:

sessionNegotiationEnd in interface SessionListener

Parameters:

session - The referenced Session

clientProposal - The client proposal options (un-modifiable)

serverProposal - The server proposal options (un-modifiable)

negotiatedOptions - The successfully negotiated options so far - even if exception occurred (un-modifiable)

reason - Negotiation end reason - null if successful

logSessionEvent

protected void logSessionEvent(Session session,
 Object event)

verifyServerKey

public boolean verifyServerKey(ClientSession sshClientSession,
 SocketAddress remoteAddress,
 PublicKey serverKey)

Description copied from interface: ServerKeyVerifier

Verify that the server key provided is really the one of the host.

Specified by:

verifyServerKey in interface ServerKeyVerifier

Parameters:

sshClientSession - the current ClientSession

remoteAddress - the host's SocketAddress

serverKey - the presented server PublicKey

Returns:

true if the key is accepted for the host

writeServerKey

protected void writeServerKey(String remoteLocation,
 String keyType,
 PublicKey serverKey)
                       throws Exception

Throws:

Exception

toString

private static String toString(SocketAddress addr)

resolveSignatureFactories

protected List<NamedFactory<Signature>> resolveSignatureFactories(String keyType)
                                                           throws GeneralSecurityException

Throws:

GeneralSecurityException

createKeyPairs

protected Map<String,List<KeyPair>> createKeyPairs(Collection<String> typeNames)
                                            throws GeneralSecurityException

Throws:

GeneralSecurityException

createKeyPairs

protected List<KeyPair> createKeyPairs(String keyType)
                                throws GeneralSecurityException

Throws:

GeneralSecurityException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

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

parseCommandLineArguments

public static List<String> parseCommandLineArguments(SshKeyScanMain scanner,
 String... args)
                                              throws IOException

Throws:

IOException

setInputStream

public static <S extends SshKeyScanMain> S setInputStream(S scanner,
 Collection<String> hosts)
                                                   throws IOException

Throws:

IOException

initializeScanner

public static <S extends SshKeyScanMain> S initializeScanner(S scanner,
 Collection<String> hosts)
                                                      throws IOException

Throws:

IOException

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception