com.hp.ucmdb.discovery.library.clients.agents.ssh

Class SSHAgent

java.lang.Object

AbstractAgent

com.hp.ucmdb.discovery.library.clients.agents.BaseAgent

com.hp.ucmdb.discovery.library.clients.agents.ssh.SSHAgent

All Implemented Interfaces:

Agent, LocalizedClient, BandwidthControl, RemoteFileSystemManager

public class SSHAgent
extends BaseAgent
implements LocalizedClient, RemoteFileSystemManager, BandwidthControl

Represent a SSH agent - support SSH1 & SSH2 protocols Using external library - appgate Mindterm (http://www.appgate.com) Important: A few changes were made to the external library, our jar's are not the original ones! 16-Nov-2008: After a move to Mindterm 4.0, several changes were made to the code bellow. For rolling-back to 2.4/3.2 versions, unmark @@OLD_MINDTERM_VERSION comments. User: okogan Date: Jun 16, 2005 Time: 10:26:58 AM

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CIPHER The cipher for the SSH connection.
static java.lang.String	DEFAULT_SSH_PORT_STR
static java.lang.String	ENABLE_FILE_TRANSFER_ERROR_MESSAGE
static java.lang.String	FAIL_CONN_IF_NO_BUNNER
static java.lang.String	KBD_AUTH
static java.lang.String	KEY_AUTH
static java.lang.String	KEY_FILE By default the SSH authentication method is by password.
static java.lang.String	PASSPHRASE Password for the SSH authentication.
static java.lang.String	PASSWORD_AUTH
static java.lang.String	PORT The SSH port.
static java.lang.String	PROMPT_RESPONSES
static java.lang.String	PROMPTS The prompts & responses for the keyboard interactive
static java.lang.String	SESSION_TIMEOUT This property is relevant when running session inside SSH session.
static java.lang.String	SFTP_SUBSYSTEM_ERROR_MESSAGE
static java.lang.String	SSH_LOG_LEVEL The external SSH library log level (one of the parameters.
static int	SSH_VER1
static int	SSH_VER2
static int	SSH_VER2_1
static java.lang.String	SSH_VERSION_1
static java.lang.String	SSH_VERSION_2
static java.lang.String	SSH_VERSION_2_OR_1
static java.lang.String	VERSION Which SSH version to connect.
static java.lang.String	WAIT_FOR_DATA

Fields inherited from class com.hp.ucmdb.discovery.library.clients.agents.BaseAgent

ANSI_ENCODING, ENCODING, OEM_ENCODING

Constructor Summary

Constructors

Constructor and Description
SSHAgent(java.lang.String ipAddress, java.lang.String userName, java.lang.String password, int connectTimeout, int defaultCmdTimeout, java.util.Properties properties)
SSHAgent(java.lang.String ipAddress, java.lang.String userName, java.lang.String password, int connectTimeout, java.util.Properties properties)

Method Summary

Methods

Modifier and Type	Method and Description
void	alert(java.lang.String msg)
boolean	askConfirmation(java.lang.String message, boolean defAnswer)
void	closed(SSHOutputStream out, char[] buf, int len) This function is called from the SSHOutputStream through the Expector interface when the stream is closed
void	connect() Trying to connect to the server through SSH protocol
void	connected(SSHClient client)
void	disconnect() Closing all the opened resources
void	disconnected(SSHClient client, boolean graceful)
java.lang.String	doExecuteCommand(java.lang.String command) Invokes a command on the remote server.
java.lang.String	doExecuteCommand(java.lang.String command, boolean waitForTimeout)
java.lang.String	doExecuteCommand(java.lang.String command, int cmdTimeout, boolean waitForTimeout)
DynamicParserTable	doTableCommand(java.lang.String command) Invokes a command on the remote server.
int	downloadFile(java.lang.String localFilePath, java.lang.String remoteFilePath, boolean shouldOverrideLocalFile) Download file from remote machine to probe using SCP protocol (SSH's files transferring protocol).
int	downloadFile(java.lang.String localFilePath, java.lang.String remoteFilePath, ExistingFileResolution localFileResolution) Download the specified file (remoteFilePath) from remote machine to probe.
void	executeSuCommand() Start "SU" session (send "su - ") command to remote machine.
void	exitFromSu() If we are in "SU" session ("su - " command was sent previously), send "exit" command to end "SU" session on remote machine.
int[]	getAuthTypes(SSHClientUser origin)
int	getBandwidthLimit() Gets bandwidth limit for file operations in kilobits per second.
java.lang.String	getChallengeResponse(SSHClientUser origin, java.lang.String challenge)
int	getCipher(SSHClientUser origin)
SSHRSAKeyFile	getIdentityFile(SSHClientUser origin)
java.lang.String	getIdentityPassword(SSHClientUser origin)
byte[]	getLastCommandOutputBytes()
java.lang.String	getPassword(SSHClientUser origin)
java.lang.String	getShellCmdSeperator()
java.lang.String	getSsh2Error()
java.lang.String	getSudoCommands()
java.lang.String	getSudoPaths()
java.lang.String	getUsername(SSHClientUser origin)
boolean	isInSUMode()
boolean	isSuConfigured()
boolean	isVerbose()
boolean	licenseDialog(java.lang.String license)
static void	main(java.lang.String[] args)
void	open(SSHClient client)
java.lang.String	promptLine(java.lang.String prompt, boolean echo) Prompt for a single string.
java.lang.String	promptLine(java.lang.String prompt, java.lang.String defaultVal)
int	promptList(java.lang.String name, java.lang.String instruction, java.lang.String[] choices) This function is only used by AppGate internal code so there is no need to actually implement it in any other code.
java.lang.String[]	promptMulti(java.lang.String[] prompts, boolean[] echos) Prompt for multiple strings.
java.lang.String[]	promptMultiFull(java.lang.String name, java.lang.String instruction, java.lang.String[] prompts, boolean[] echos) Prompt for multiple strings.
java.lang.String	promptPassword(java.lang.String prompt)
void	propsStateChanged(SSHPropertyHandler props)
boolean	quietPrompts()
void	reached(SSHOutputStream out, char[] buf, int len, java.lang.String boundary) This function is called from the SSHOutputStream through the Expector interface
static java.lang.String	removeMarkers(java.lang.String output) Remove end/start markers from the specified output
void	report(java.lang.String msg)
void	sessionStarted(SSHClient client)
void	setBandwidthLimit(int limit) Sets bandwidth limit for file operations in kilobits per second.
void	setCharset(java.nio.charset.Charset charset)
void	startNewSession(SSHClient client)
java.lang.String	toString()
static java.lang.String	translateBackspace(java.lang.String contents)
int	uploadFile(java.lang.String localFilePath, java.lang.String remoteFilePath, boolean shouldOverrideRemoteFile) Upload file from probe to remote machine using SCP protocol (SSH files transferring protocol).
int	uploadFile(java.lang.String localFilePath, java.lang.String remoteFilePath, ExistingFileResolution remoteFileResolution) Upload the specified file (localFilePath) from probe's machine to remote machine
boolean	verifyKnownHosts(java.security.interfaces.RSAPublicKey hostPub)

Methods inherited from class com.hp.ucmdb.discovery.library.clients.agents.BaseAgent

getCharsetName, getMaxCommandLength, parseTable, setMaxCommandLength, setProperty

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hp.ucmdb.discovery.library.clients.agents.Agent

getProperty

Field Detail

PASSWORD_AUTH

public static final java.lang.String PASSWORD_AUTH

See Also:

Constant Field Values

KEY_AUTH

public static final java.lang.String KEY_AUTH

See Also:

Constant Field Values

KBD_AUTH

public static final java.lang.String KBD_AUTH

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

Which SSH version to connect. if the version is 1, only try to connect through SSH-1 if the version is 2_1, try to connect through SSH-2, and if the connection is failed, we try to connect through SSH-1 if the version is 2, try to connect through SSH-2 only

See Also:

Constant Field Values

SSH_VER1

public static final int SSH_VER1

See Also:

Constant Field Values

SSH_VER2_1

public static final int SSH_VER2_1

See Also:

Constant Field Values

SSH_VER2

public static final int SSH_VER2

See Also:

Constant Field Values

SSH_VERSION_1

public static final java.lang.String SSH_VERSION_1

See Also:

Constant Field Values

SSH_VERSION_2

public static final java.lang.String SSH_VERSION_2

See Also:

Constant Field Values

SSH_VERSION_2_OR_1

public static final java.lang.String SSH_VERSION_2_OR_1

See Also:

Constant Field Values

PORT

public static final java.lang.String PORT

The SSH port. by default the port is 22.

See Also:

Constant Field Values

DEFAULT_SSH_PORT_STR

public static final java.lang.String DEFAULT_SSH_PORT_STR

SESSION_TIMEOUT

public static final java.lang.String SESSION_TIMEOUT

This property is relevant when running session inside SSH session. For example when running MQ discovery When echo is used, �timeout� is the read timeout of the socket, SSH_COMMAND_TIMEOUT is the timeout of the command. When echo is not used, �timeout�+�sessionTimeout� is used. Because timeout is the end of the command when echo is not used, read timeout should be bigger than timeout. Otherwise, the socket is closed after the first command.

See Also:

Constant Field Values

SSH_LOG_LEVEL

public static final java.lang.String SSH_LOG_LEVEL

The external SSH library log level (one of the parameters. used for debug purpose) log level ranges 1-7; the debug level is 7

See Also:

Constant Field Values

PASSPHRASE

public static final java.lang.String PASSPHRASE

Password for the SSH authentication. If this property is not specified, the password is taken from the constructor password parameter

See Also:

Constant Field Values

KEY_FILE

public static final java.lang.String KEY_FILE

By default the SSH authentication method is by password. if a key file is specified, then the SSH authentication method will be by a public key file.

See Also:

Constant Field Values

CIPHER

public static final java.lang.String CIPHER

The cipher for the SSH connection.

See Also:

Constant Field Values

PROMPTS

public static final java.lang.String PROMPTS

The prompts & responses for the keyboard interactive

See Also:

Constant Field Values

PROMPT_RESPONSES

public static final java.lang.String PROMPT_RESPONSES

See Also:

Constant Field Values

WAIT_FOR_DATA

public static final java.lang.String WAIT_FOR_DATA

See Also:

Constant Field Values

FAIL_CONN_IF_NO_BUNNER

public static final java.lang.String FAIL_CONN_IF_NO_BUNNER

See Also:

Constant Field Values

SFTP_SUBSYSTEM_ERROR_MESSAGE

public static final java.lang.String SFTP_SUBSYSTEM_ERROR_MESSAGE

See Also:

Constant Field Values

ENABLE_FILE_TRANSFER_ERROR_MESSAGE

public static final java.lang.String ENABLE_FILE_TRANSFER_ERROR_MESSAGE

See Also:

Constant Field Values

Constructor Detail

SSHAgent

public SSHAgent(java.lang.String ipAddress,
        java.lang.String userName,
        java.lang.String password,
        int connectTimeout,
        java.util.Properties properties)
         throws java.lang.Exception

Throws:

java.lang.Exception

SSHAgent

public SSHAgent(java.lang.String ipAddress,
        java.lang.String userName,
        java.lang.String password,
        int connectTimeout,
        int defaultCmdTimeout,
        java.util.Properties properties)
         throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

toString

public java.lang.String toString()

getSudoCommands

public java.lang.String getSudoCommands()

Overrides:

getSudoCommands in class BaseAgent

getSudoPaths

public java.lang.String getSudoPaths()

Overrides:

getSudoPaths in class BaseAgent

getSsh2Error

public java.lang.String getSsh2Error()

translateBackspace

public static java.lang.String translateBackspace(java.lang.String contents)

removeMarkers

public static java.lang.String removeMarkers(java.lang.String output)

Remove end/start markers from the specified output

Parameters:

output -

Returns:

stripped output

reached

public void reached(SSHOutputStream out,
           char[] buf,
           int len,
           java.lang.String boundary)

This function is called from the SSHOutputStream through the Expector interface

Parameters:

out - - the SSHOutputStream

buf - - the bytes written to the stream

len - - number of bytes

boundary - - the boundary string that was reached

closed

public void closed(SSHOutputStream out,
          char[] buf,
          int len)

This function is called from the SSHOutputStream through the Expector interface when the stream is closed

Parameters:

out - - the SSHOutputStream

buf - - the bytes written to the stream

len - - num of bytes

getShellCmdSeperator

public java.lang.String getShellCmdSeperator()

Overrides:

getShellCmdSeperator in class BaseAgent

doTableCommand

public DynamicParserTable doTableCommand(java.lang.String command)
                                  throws java.lang.Exception

Description copied from class: BaseAgent

Invokes a command on the remote server. This method is suitable for services which might return tables such as sql

Specified by:

doTableCommand in interface Agent

Specified by:

doTableCommand in class BaseAgent

Parameters:

command - the command to invoke

Returns:

DynamicParserTable the table that returned

Throws:

java.lang.Exception - when the command could not operate.

doExecuteCommand

public java.lang.String doExecuteCommand(java.lang.String command)
                                  throws java.lang.Exception

Description copied from class: BaseAgent

Invokes a command on the remote server.

Specified by:

doExecuteCommand in interface Agent

Specified by:

doExecuteCommand in class BaseAgent

Parameters:

command - the command to invoke

Returns:

String the buffer that returned

Throws:

java.lang.Exception - when the command could not operate.

doExecuteCommand

public java.lang.String doExecuteCommand(java.lang.String command,
                                boolean waitForTimeout)
                                  throws java.lang.Exception

Overrides:

doExecuteCommand in class BaseAgent

Throws:

java.lang.Exception

doExecuteCommand

public java.lang.String doExecuteCommand(java.lang.String command,
                                int cmdTimeout,
                                boolean waitForTimeout)
                                  throws java.lang.Exception

Overrides:

doExecuteCommand in class BaseAgent

Throws:

java.lang.Exception

isInSUMode

public boolean isInSUMode()

isSuConfigured

public boolean isSuConfigured()

executeSuCommand

public void executeSuCommand()
                      throws java.lang.Exception

Start "SU" session (send "su - ") command to remote machine.

Throws:

java.lang.Exception - - if we failed to start "SU" session.

exitFromSu

public void exitFromSu()
                throws java.lang.Exception

If we are in "SU" session ("su - " command was sent previously), send "exit" command to end "SU" session on remote machine.

Throws:

java.lang.Exception - - if sending "exit" command failed from some reason.

disconnect

public void disconnect()

Closing all the opened resources

Specified by:

disconnect in interface Agent

Specified by:

disconnect in class BaseAgent

connect

public void connect()
             throws java.lang.Exception

Trying to connect to the server through SSH protocol

Throws:

java.lang.Exception

uploadFile

public int uploadFile(java.lang.String localFilePath,
             java.lang.String remoteFilePath,
             boolean shouldOverrideRemoteFile)
               throws java.lang.Exception

Upload file from probe to remote machine using SCP protocol (SSH files transferring protocol).

Specified by:

uploadFile in interface RemoteFileSystemManager

Parameters:

localFilePath - - name of the file on probe to be uploaded to remote machine.

remoteFilePath - - name of the uploaded file on the remote machine (including path)

shouldOverrideRemoteFile - - defines behavior in case remoteFilePath already exists. Currently this flag is not supported (the method will always overwrite remote file).

Returns:

zero in case of success.

Throws:

java.lang.Exception

downloadFile

public int downloadFile(java.lang.String localFilePath,
               java.lang.String remoteFilePath,
               boolean shouldOverrideLocalFile)
                 throws java.lang.Exception

Download file from remote machine to probe using SCP protocol (SSH's files transferring protocol).

Specified by:

downloadFile in interface RemoteFileSystemManager

Parameters:

localFilePath - - name of the downloaded file on probe (full absolute path).

remoteFilePath - - name of the file on remote machine to be downloaded (full absolute path).

shouldOverrideLocalFile - - defines behaviour in case localFilePath contains a path to file that already exists. If shouldOverrideLocalFile is set to true, then local file will be overwritten with downloaded file. Otherwise (shouldOverrideLocalFile=false), this method won't do anything.

Returns:

zero in case of success

Throws:

java.lang.Exception

uploadFile

public int uploadFile(java.lang.String localFilePath,
             java.lang.String remoteFilePath,
             ExistingFileResolution remoteFileResolution)
               throws java.lang.Exception

Upload the specified file (localFilePath) from probe's machine to remote machine

Specified by:

uploadFile in interface RemoteFileSystemManager

Parameters:

localFilePath - - the path of the file to be upload from probe machine

remoteFilePath - - the path of the uploaded file on remote machine

remoteFileResolution - - defines behavior if the file on remote machine already exists.

Returns:

zero in case of success.

Throws:

java.lang.Exception - - exception is thrown in case the upload failed.

downloadFile

public int downloadFile(java.lang.String localFilePath,
               java.lang.String remoteFilePath,
               ExistingFileResolution localFileResolution)
                 throws java.lang.Exception

Download the specified file (remoteFilePath) from remote machine to probe.

Specified by:

downloadFile in interface RemoteFileSystemManager

Parameters:

localFilePath - - defines the name of downloaded file on probe's machine.

remoteFilePath - - the path of the downloaded file on remote machine.

localFileResolution - - defines behavior if the localFilePath already exists on probe machine.

Returns:

zero in case of success

Throws:

java.lang.Exception - - exception is thrown in case of download failed.

startNewSession

public void startNewSession(SSHClient client)

sessionStarted

public void sessionStarted(SSHClient client)

connected

public void connected(SSHClient client)

open

public void open(SSHClient client)

disconnected

public void disconnected(SSHClient client,
                boolean graceful)

report

public void report(java.lang.String msg)

alert

public void alert(java.lang.String msg)

propsStateChanged

public void propsStateChanged(SSHPropertyHandler props)

askConfirmation

public boolean askConfirmation(java.lang.String message,
                      boolean defAnswer)

licenseDialog

public boolean licenseDialog(java.lang.String license)

quietPrompts

public boolean quietPrompts()

promptLine

public java.lang.String promptLine(java.lang.String prompt,
                          java.lang.String defaultVal)
                            throws java.io.IOException

Throws:

java.io.IOException

promptPassword

public java.lang.String promptPassword(java.lang.String prompt)
                                throws java.io.IOException

Throws:

java.io.IOException

isVerbose

public boolean isVerbose()

getUsername

public java.lang.String getUsername(SSHClientUser origin)
                             throws java.io.IOException

Throws:

java.io.IOException

getPassword

public java.lang.String getPassword(SSHClientUser origin)
                             throws java.io.IOException

Throws:

java.io.IOException

getChallengeResponse

public java.lang.String getChallengeResponse(SSHClientUser origin,
                                    java.lang.String challenge)
                                      throws java.io.IOException

Throws:

java.io.IOException

getAuthTypes

public int[] getAuthTypes(SSHClientUser origin)

getCipher

public int getCipher(SSHClientUser origin)

getIdentityFile

public SSHRSAKeyFile getIdentityFile(SSHClientUser origin)
                              throws java.io.IOException

Throws:

java.io.IOException

getIdentityPassword

public java.lang.String getIdentityPassword(SSHClientUser origin)
                                     throws java.io.IOException

Throws:

java.io.IOException

verifyKnownHosts

public boolean verifyKnownHosts(java.security.interfaces.RSAPublicKey hostPub)
                         throws java.io.IOException

Throws:

java.io.IOException

promptLine

public java.lang.String promptLine(java.lang.String prompt,
                          boolean echo)
                            throws SSH2UserCancelException

Prompt for a single string.

Parameters:

prompt - The prompt string to show

echo - True if the text the user enters should be echoed.

Returns:

The text entered by the user.

Throws:

SSH2UserCancelException

promptMulti

public java.lang.String[] promptMulti(java.lang.String[] prompts,
                             boolean[] echos)
                               throws SSH2UserCancelException

Prompt for multiple strings. The expectation here is that the client will put up a dialog where the user sees multiple prompts and input fields.

Parameters:

prompts - List of prompts to show

echos - List of boolean values which indicates if the text entered for the corresponding prompt should be echoed.

Returns:

An array of strings which contains on element for each prompt, in the same order. The elements should contain the text the user entered.

Throws:

SSH2UserCancelException

promptMultiFull

public java.lang.String[] promptMultiFull(java.lang.String name,
                                 java.lang.String instruction,
                                 java.lang.String[] prompts,
                                 boolean[] echos)
                                   throws SSH2UserCancelException

Prompt for multiple strings. The expectation here is that the client will put up a dialog where the user sees multiple prompts and input fields. This version of the call includes more elements which should be shown in the dialog.

Parameters:

name - Suggested title of the dialog

instruction - Instructions to show to user in the dialog

prompts - List of prompts to show

echos - List of boolean values which indicates if the text entered for the corresponding prompt should be echoed.

Returns:

An array of strings which contains on element for each prompt, in the same order. The elements should contain the text the user entered.

Throws:

SSH2UserCancelException

promptList

public int promptList(java.lang.String name,
             java.lang.String instruction,
             java.lang.String[] choices)
               throws SSH2UserCancelException

This function is only used by AppGate internal code so there is no need to actually implement it in any other code.

It is used to let the user select one element in a list.

Parameters:

name - Suggested title of dialog

instruction - Instructions to show to user

choices - Array of possible choices

Returns:

index of selected list item

Throws:

SSH2UserCancelException

getLastCommandOutputBytes

public byte[] getLastCommandOutputBytes()
                                 throws java.lang.Exception

Specified by:

getLastCommandOutputBytes in interface LocalizedClient

Throws:

java.lang.Exception

setCharset

public void setCharset(java.nio.charset.Charset charset)

Specified by:

setCharset in interface LocalizedClient

getBandwidthLimit

public int getBandwidthLimit()

Gets bandwidth limit for file operations in kilobits per second. Zero is used to indicate unlimited speed.

Specified by:

getBandwidthLimit in interface BandwidthControl

Returns:

bandwidth limit

setBandwidthLimit

public void setBandwidthLimit(int limit)

Sets bandwidth limit for file operations in kilobits per second. Zero is used to indicate unlimited speed.

Specified by:

setBandwidthLimit in interface BandwidthControl

Parameters:

limit - bandwidth limit

main

public static void main(java.lang.String[] args)