java.lang.Object

com.sshtools.j2ssh.transport.TransportProtocolCommon

All Implemented Interfaces:: TransportProtocol, Runnable

Direct Known Subclasses:: TransportProtocolClient, TransportProtocolServer

public abstract class TransportProtocolCommon extends Object implements TransportProtocol, Runnable

Version:: $Revision: 1.2 $
Author:: $author$

Field Summary

Fields

Modifier and Type

Field

Description

protected TransportProtocolAlgorithmSync

algorithmsIn

protected TransportProtocolAlgorithmSync

algorithmsOut

protected String

clientIdent

protected SshMsgKexInit

clientKexInit

protected Boolean

completeOnNewKeys

static final int

EOL_CRLF

static final int

EOL_LF

protected byte[]

hostKey

protected HostKeyVerification

hosts

protected BigInteger

k

protected Map

kexs

protected static org.apache.commons.logging.Log

log

protected SshMessageStore

messageStore

protected SshConnectionProperties

properties

static final String

PROTOCOL_VERSION

protected String

serverIdent

protected SshMsgKexInit

serverKexInit

protected byte[]

sessionIdentifier

protected byte[]

signature

static String

SOFTWARE_VERSION_COMMENTS

protected com.sshtools.j2ssh.transport.TransportProtocolInputStream

sshIn

protected com.sshtools.j2ssh.transport.TransportProtocolOutputStream

sshOut

protected TransportProtocolState

state
Constructor Summary

Constructors

Constructor

Description

TransportProtocolCommon()

Creates a new TransportProtocolCommon object.
Method Summary

Modifier and Type

Method

Description

void

addEventHandler(TransportProtocolEventHandler eventHandler)

void

addMessageStore(SshMessageStore store)

protected void

beginKeyExchange()

protected void

completeKeyExchange()

protected SshMsgKexInit

createLocalKexInit()

protected String

determineAlgorithm(List clientAlgorithms, List serverAlgorithms)

void

disconnect(String description)

int

getConnectionId()

protected abstract String

getDecryptionAlgorithm()

protected abstract String

getEncryptionAlgorithm()

protected List

getEventHandlers()

long

getIncomingByteCount()

protected abstract String

getInputStreamCompAlgortihm()

protected abstract String

getInputStreamMacAlgorithm()

protected String

getKexAlgorithm()

abstract String

getLocalId()

protected abstract SshMsgKexInit

getLocalKexInit()

long

getOutgoingByteCount()

protected abstract String

getOutputStreamCompAlgorithm()

protected abstract String

getOutputStreamMacAlgorithm()

SshConnectionProperties

getProperties()

int

getRemoteEOL()

abstract String

getRemoteId()

protected abstract SshMsgKexInit

getRemoteKexInit()

byte[]

getSessionIdentifier()

TransportProtocolState

getState()

String

getUnderlyingProviderDetail()

boolean

isConnected()

protected void

onCorruptMac()

protected abstract void

onDisconnect()

protected abstract void

onMessageReceived(SshMessage msg)

protected abstract void

onStartTransportProtocol()

protected abstract void

performKeyExchange(SshKeyExchange kex)

protected SshMessage

processMessages()

SshMessage

readMessage(int[] filter)

abstract void

registerTransportMessages()

void

removeMessageStore(SshMessageStore ms)

void

run()

protected void

sendDisconnect(int reason, String description)

protected void

sendDisconnect(int reason, String description, IOException error)

protected void

sendKeyExchangeInit()

void

sendMessage(SshMessage msg, Object sender)

protected void

sendNewKeys()

void

setKexTimeout(long seconds)

void

setKexTransferLimit(long kilobytes)

protected abstract void

setLocalIdent()

protected abstract void

setLocalKexInit(SshMsgKexInit msg)

protected abstract void

setRemoteIdent(String ident)

protected abstract void

setRemoteKexInit(SshMsgKexInit msg)

void

setSendIgnore(boolean sendIgnore)

protected abstract void

setupNewKeys(byte[] encryptCSKey, byte[] encryptCSIV, byte[] encryptSCKey, byte[] encryptSCIV, byte[] macCSKey, byte[] macSCKey)

protected void

startBinaryPacketProtocol()

void

startTransportProtocol(TransportProvider provider, SshConnectionProperties properties)

protected final void

stop()

void

unregisterMessage(Integer messageId, SshMessageStore store)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- log
  
  protected static org.apache.commons.logging.Log log
- EOL_CRLF
  
  public static final int EOL_CRLF
  See Also:
  
  Constant Field Values
- EOL_LF
  
  public static final int EOL_LF
  See Also:
  
  Constant Field Values
- PROTOCOL_VERSION
  
  public static final String PROTOCOL_VERSION
  See Also:
  
  Constant Field Values
- SOFTWARE_VERSION_COMMENTS
  
  public static String SOFTWARE_VERSION_COMMENTS
- k
  
  protected BigInteger k
- completeOnNewKeys
  
  protected Boolean completeOnNewKeys
- hosts
  
  protected HostKeyVerification hosts
- kexs
  
  protected Map kexs
- properties
  
  protected SshConnectionProperties properties
- messageStore
  
  protected SshMessageStore messageStore
- clientKexInit
  
  protected SshMsgKexInit clientKexInit
- serverKexInit
  
  protected SshMsgKexInit serverKexInit
- clientIdent
  
  protected String clientIdent
- serverIdent
  
  protected String serverIdent
- algorithmsIn
  
  protected TransportProtocolAlgorithmSync algorithmsIn
- algorithmsOut
  
  protected TransportProtocolAlgorithmSync algorithmsOut
- state
  
  protected TransportProtocolState state
- sessionIdentifier
  
  protected byte[] sessionIdentifier
- hostKey
  
  protected byte[] hostKey
- signature
  
  protected byte[] signature
- sshIn
  
  protected com.sshtools.j2ssh.transport.TransportProtocolInputStream sshIn
- sshOut
  
  protected com.sshtools.j2ssh.transport.TransportProtocolOutputStream sshOut
Constructor Details
- TransportProtocolCommon
  
  public TransportProtocolCommon()
  
  Creates a new TransportProtocolCommon object.
Method Details
- getConnectionId
  
  public int getConnectionId()
  
  Specified by:
  
  getConnectionId in interface TransportProtocol
  
  Returns:
- getRemoteEOL
  
  public int getRemoteEOL()
  
  Returns:
- getState
  
  public TransportProtocolState getState()
  
  Specified by:
  
  getState in interface TransportProtocol
  
  Returns:
- getProperties
  
  public SshConnectionProperties getProperties()
  
  Returns:
- onDisconnect
  
  protected abstract void onDisconnect()
- disconnect
  
  public void disconnect(String description)
  
  Specified by:
  
  disconnect in interface TransportProtocol
  
  Parameters:
  
  description -
- setSendIgnore
  
  public void setSendIgnore(boolean sendIgnore)
  
  Parameters:
  
  sendIgnore -
- setKexTimeout
  
  public void setKexTimeout(long seconds) throws TransportProtocolException
  
  Parameters:
  
  seconds -
  
  Throws:
  
  TransportProtocolException
- setKexTransferLimit
  
  public void setKexTransferLimit(long kilobytes) throws TransportProtocolException
  
  Parameters:
  
  kilobytes -
  
  Throws:
  
  TransportProtocolException
- getOutgoingByteCount
  
  public long getOutgoingByteCount()
- getIncomingByteCount
  
  public long getIncomingByteCount()
  
  Returns:
- addEventHandler
  
  public void addEventHandler(TransportProtocolEventHandler eventHandler)
  
  Parameters:
  
  eventHandler -
- registerTransportMessages
  
  public abstract void registerTransportMessages() throws MessageAlreadyRegisteredException
  
  Throws:
  
  MessageAlreadyRegisteredException
- getSessionIdentifier
  
  public byte[] getSessionIdentifier()
  
  Specified by:
  
  getSessionIdentifier in interface TransportProtocol
  
  Returns:
- run
  
  public void run()
  
  Specified by:
  
  run in interface Runnable
- sendMessage
  
  public void sendMessage(SshMessage msg, Object sender) throws IOException
  
  Specified by:
  
  sendMessage in interface TransportProtocol
  
  Parameters:
  
  msg -
  
  sender -
  
  Throws:
  
  IOException
  
  TransportProtocolException
- onStartTransportProtocol
  
  protected abstract void onStartTransportProtocol() throws IOException
  
  Throws:
  
  IOException
- startTransportProtocol
  
  public void startTransportProtocol(TransportProvider provider, SshConnectionProperties properties) throws IOException
  
  Parameters:
  
  provider -
  
  properties -
  
  Throws:
  
  IOException
- getUnderlyingProviderDetail
  
  public String getUnderlyingProviderDetail()
  
  Specified by:
  
  getUnderlyingProviderDetail in interface TransportProtocol
  
  Returns:
- unregisterMessage
  
  public void unregisterMessage(Integer messageId, SshMessageStore store) throws MessageNotRegisteredException
  
  Parameters:
  
  messageId -
  
  store -
  
  Throws:
  
  MessageNotRegisteredException
- getDecryptionAlgorithm
  
  protected abstract String getDecryptionAlgorithm() throws AlgorithmNotAgreedException
  
  Returns:
  
  Throws:
  
  AlgorithmNotAgreedException
- getEncryptionAlgorithm
  
  protected abstract String getEncryptionAlgorithm() throws AlgorithmNotAgreedException
  
  Returns:
  
  Throws:
  
  AlgorithmNotAgreedException
- getInputStreamCompAlgortihm
  
  protected abstract String getInputStreamCompAlgortihm() throws AlgorithmNotAgreedException
  
  Returns:
  
  Throws:
  
  AlgorithmNotAgreedException
- getInputStreamMacAlgorithm
  
  protected abstract String getInputStreamMacAlgorithm() throws AlgorithmNotAgreedException
  
  Returns:
  
  Throws:
  
  AlgorithmNotAgreedException
- setLocalIdent
  
  protected abstract void setLocalIdent()
- getLocalId
  
  public abstract String getLocalId()
  
  Returns:
- setLocalKexInit
  
  protected abstract void setLocalKexInit(SshMsgKexInit msg)
  
  Parameters:
  
  msg -
- getLocalKexInit
  
  protected abstract SshMsgKexInit getLocalKexInit()
  
  Returns:
- getOutputStreamCompAlgorithm
  
  protected abstract String getOutputStreamCompAlgorithm() throws AlgorithmNotAgreedException
  
  Returns:
  
  Throws:
  
  AlgorithmNotAgreedException
- getOutputStreamMacAlgorithm
  
  protected abstract String getOutputStreamMacAlgorithm() throws AlgorithmNotAgreedException
  
  Returns:
  
  Throws:
  
  AlgorithmNotAgreedException
- setRemoteIdent
  
  protected abstract void setRemoteIdent(String ident)
  
  Parameters:
  
  ident -
- getRemoteId
  
  public abstract String getRemoteId()
  
  Returns:
- setRemoteKexInit
  
  protected abstract void setRemoteKexInit(SshMsgKexInit msg)
  
  Parameters:
  
  msg -
- getRemoteKexInit
  
  protected abstract SshMsgKexInit getRemoteKexInit()
  
  Returns:
- performKeyExchange
  
  protected abstract void performKeyExchange(SshKeyExchange kex) throws IOException, KeyExchangeException
  
  Parameters:
  
  kex -
  
  Throws:
  
  IOException
  
  KeyExchangeException
- getKexAlgorithm
  
  protected String getKexAlgorithm() throws AlgorithmNotAgreedException
  
  Returns:
  
  Throws:
  
  AlgorithmNotAgreedException
- isConnected
  
  public boolean isConnected()
  
  Specified by:
  
  isConnected in interface TransportProtocol
- beginKeyExchange
  
  protected void beginKeyExchange() throws IOException, KeyExchangeException
  
  Throws:
  
  IOException
  
  KeyExchangeException
- createLocalKexInit
  
  protected SshMsgKexInit createLocalKexInit() throws IOException
  
  Returns:
  
  Throws:
  
  IOException
- onCorruptMac
  
  protected void onCorruptMac()
- onMessageReceived
  
  protected abstract void onMessageReceived(SshMessage msg) throws IOException
  
  Parameters:
  
  msg -
  
  Throws:
  
  IOException
- sendDisconnect
  
  protected void sendDisconnect(int reason, String description)
  
  Parameters:
  
  reason -
  
  description -
- sendDisconnect
  
  protected void sendDisconnect(int reason, String description, IOException error)
  
  Parameters:
  
  reason -
  
  description -
  
  error -
- sendKeyExchangeInit
  
  protected void sendKeyExchangeInit() throws IOException
  
  Throws:
  
  IOException
- sendNewKeys
  
  protected void sendNewKeys() throws IOException
  
  Throws:
  
  IOException
- setupNewKeys
  
  protected abstract void setupNewKeys(byte[] encryptCSKey, byte[] encryptCSIV, byte[] encryptSCKey, byte[] encryptSCIV, byte[] macCSKey, byte[] macSCKey) throws AlgorithmNotAgreedException, AlgorithmOperationException, AlgorithmNotSupportedException, AlgorithmInitializationException
  
  Parameters:
  
  encryptCSKey -
  
  encryptCSIV -
  
  encryptSCKey -
  
  encryptSCIV -
  
  macCSKey -
  
  macSCKey -
  
  Throws:
  
  AlgorithmNotAgreedException
  
  AlgorithmOperationException
  
  AlgorithmNotSupportedException
  
  AlgorithmInitializationException
- completeKeyExchange
  
  protected void completeKeyExchange() throws IOException
  
  Throws:
  
  IOException
  
  TransportProtocolException
- getEventHandlers
  
  protected List getEventHandlers()
  
  Returns:
- determineAlgorithm
  
  protected String determineAlgorithm(List clientAlgorithms, List serverAlgorithms) throws AlgorithmNotAgreedException
  
  Parameters:
  
  clientAlgorithms -
  
  serverAlgorithms -
  
  Returns:
  
  Throws:
  
  AlgorithmNotAgreedException
- startBinaryPacketProtocol
  
  protected void startBinaryPacketProtocol() throws IOException
  
  Throws:
  
  IOException
- stop
  
  protected final void stop()
- readMessage
  
  public SshMessage readMessage(int[] filter) throws IOException
  
  Specified by:
  
  readMessage in interface TransportProtocol
  
  Parameters:
  
  filter -
  
  Returns:
  
  Throws:
  
  IOException
- processMessages
  
  protected SshMessage processMessages() throws IOException
  
  Returns:
  
  Throws:
  
  IOException
- addMessageStore
  
  public void addMessageStore(SshMessageStore store) throws MessageAlreadyRegisteredException
  
  Specified by:
  
  addMessageStore in interface TransportProtocol
  
  Parameters:
  
  store -
  
  Throws:
  
  MessageAlreadyRegisteredException
- removeMessageStore
  
  public void removeMessageStore(SshMessageStore ms)
  
  Parameters:
  
  ms -

Class TransportProtocolCommon

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

log

EOL_CRLF

EOL_LF

PROTOCOL_VERSION

SOFTWARE_VERSION_COMMENTS

k

completeOnNewKeys

hosts

kexs

properties

messageStore

clientKexInit

serverKexInit

clientIdent

serverIdent

algorithmsIn

algorithmsOut

state

sessionIdentifier

hostKey

signature

sshIn

sshOut

Constructor Details

TransportProtocolCommon

Method Details

getConnectionId

getRemoteEOL

getState

getProperties

onDisconnect

disconnect

setSendIgnore

setKexTimeout

setKexTransferLimit

getOutgoingByteCount

getIncomingByteCount

addEventHandler

registerTransportMessages

getSessionIdentifier

run

sendMessage

onStartTransportProtocol

startTransportProtocol

getUnderlyingProviderDetail

unregisterMessage

getDecryptionAlgorithm

getEncryptionAlgorithm

getInputStreamCompAlgortihm

getInputStreamMacAlgorithm

setLocalIdent

getLocalId

setLocalKexInit

getLocalKexInit

getOutputStreamCompAlgorithm

getOutputStreamMacAlgorithm

setRemoteIdent

getRemoteId

setRemoteKexInit

getRemoteKexInit

performKeyExchange

getKexAlgorithm

isConnected

beginKeyExchange

createLocalKexInit

onCorruptMac

onMessageReceived

sendDisconnect

sendDisconnect

sendKeyExchangeInit

sendNewKeys

setupNewKeys

completeKeyExchange

getEventHandlers