Ssh1Context (Maverick Legacy - Client Assembly 1.7.61 API)

java.lang.Object
- com.maverick.ssh1.Ssh1Context

All Implemented Interfaces:

ExecutorServiceProvider, SshContext
```
public final class Ssh1Context
extends Object
implements SshContext
```
This class implements SshContext to provide SSH1 connection configuration through the SshConnector class. Currently this provides only one additional feature which is to set the preferred cipher type, however there is currently only one cipher algorithm supported so this feature is reserved for future use. To configure the SSH1 context use the following code:
SshConnector con = SshConnector.getInstance(); Ssh1Context context = (Ssh1Context) con.getContext(SshConnector.SSH1); context.setCipherType(Ssh1Context.CIPHER_3DES);

Author:

Lee David Painter

Field Summary

Fields
Modifier and Type Field and Description

static int CIPHER_3DES

static int CIPHER_DES

Fields
Modifier and Type	Field and Description
`static int`	`CIPHER_3DES`
`static int`	`CIPHER_DES`

Constructor Summary

Constructors
Constructor and Description

Ssh1Context()
Construct a new context instance with default values.

Constructors
Constructor and Description
`Ssh1Context()` Construct a new context instance with default values.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SshCipher`	`createCipher(int cipherType)`
`void`	`enableFIPSMode()` Deprecated. This method is out-of-date. Use JCEProvider.initializeDefaultProvider("BCFIPS") passing a FIPS approved JCE provider in approved mode to restrict algorithms to only those supported by the approved FIPS environment.
`int`	`getChannelLimit()` Get the maximum number of channels that are allowed open at any one time.
`int`	`getCipherType(int supportedCiphers)` Get the cipher type for this configuration context.
`ExecutorService`	`getExecutorService()`
`HostKeyVerification`	`getHostKeyVerification()` Get the host key verification implementation.
`int`	`getMessageTimeout()`
`String`	`getSFTPProvider()` Get the path to the SFTP provider.
`byte[]`	`getX11AuthenticationCookie()` Get a fake random cookie for X11 authentication
`String`	`getX11Display()` Get the currently configured XDisplay setting which will be null if no display is currently set.
`byte[]`	`getX11RealCookie()` Get the real X11 authentication cookie, if not cookie has been set the fake cookie will be returned.
`ForwardingRequestListener`	`getX11RequestListener()` Get the X11 forwarding request listener.
`boolean`	`isSHA1SignaturesSupported()` Option to disable SHA1 signatures on RSA keys.
`void`	`setChannelLimit(int maxChannels)` Set the maximum number of channels that are allowed open at any one time.
`void`	`setCipherType(int preferredCipher)` Set the cipher type for this configuration context.
`void`	`setExecutorService(ExecutorService executor)`
`void`	`setHostKeyVerification(HostKeyVerification verify)` Set the host key verification implementation.
`void`	`setMessageTimeout(int messageTimeout)`
`void`	`setSFTPProvider(String sftp_path)` Set the path to the SFTP provider.
`void`	`setSHA1SignaturesSupported(boolean supportSHA1Signatures)` Option to disable SHA1 signatures on RSA keys.
`void`	`setX11AuthenticationCookie(byte[] x11FakeCookie)` Set the fake cookie used for X11 authentication
`void`	`setX11Display(String xDisplay)` Set the DISPLAY variable for the SSH connection.
`void`	`setX11RealCookie(byte[] x11RealCookie)` Sets the real X11 authentication cookie which can be obtained from the users $HOME/.Xauthority file.
`void`	`setX11RequestListener(ForwardingRequestListener x11Listener)` Set the listener to which X11 forwarding requests will be processed.

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

- Field Detail
  - CIPHER_DES
```
public static final int CIPHER_DES
```
    See Also:
    
    Constant Field Values
  - CIPHER_3DES
```
public static final int CIPHER_3DES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Ssh1Context
```
public Ssh1Context()
```
    Construct a new context instance with default values.
- Method Detail
  - setChannelLimit
```
public void setChannelLimit(int maxChannels)
```
    Description copied from interface: SshContext
    
    Set the maximum number of channels that are allowed open at any one time.
    
    Specified by:
    
    setChannelLimit in interface SshContext
  - getChannelLimit
```
public int getChannelLimit()
```
    Description copied from interface: SshContext
    
    Get the maximum number of channels that are allowed open at any one time.
    
    Specified by:
    
    getChannelLimit in interface SshContext
    
    Returns:
    
    the maximum number of channels
  - setSFTPProvider
```
public void setSFTPProvider(String sftp_path)
```
    Description copied from interface: SshContext
    
    Set the path to the SFTP provider. For SSH1 connections an attempt to execute this provider will be made as SSH1 does not support subsystems. For SSH2 connections an attempt will be made to execute this provider if the subsystem cannot be started.
    
    Specified by:
    
    setSFTPProvider in interface SshContext
  - getSFTPProvider
```
public String getSFTPProvider()
```
    Description copied from interface: SshContext
    
    Get the path to the SFTP provider. For SSH1 connections an attempt to execute this provider will be made as SSH1 does not support subsystems. For SSH2 connections an attempt will be made to execute this provider if the subsystem cannot be started. The default is '/usr/libexec/sftp-server'
    
    Specified by:
    
    getSFTPProvider in interface SshContext
    
    Returns:
    
    String
  - setX11Display
```
public void setX11Display(String xDisplay)
```
    Description copied from interface: SshContext
    
    Set the DISPLAY variable for the SSH connection. If this is set the SSH sessions will have their DISPLAY variable set and X sessions will be forwarded over the SSH connection to the display specified.
    
    Specified by:
    
    setX11Display in interface SshContext
    
    Parameters:
    
    xDisplay - the display in the form localhost:1
  - getX11Display
```
public String getX11Display()
```
    Description copied from interface: SshContext
    
    Get the currently configured XDisplay setting which will be null if no display is currently set.
    
    Specified by:
    
    getX11Display in interface SshContext
    
    Returns:
    
    String
  - getX11AuthenticationCookie
```
public byte[] getX11AuthenticationCookie()
                                  throws SshException
```
    Description copied from interface: SshContext
    
    Get a fake random cookie for X11 authentication
    
    Specified by:
    
    getX11AuthenticationCookie in interface SshContext
    
    Returns:
    
    byte[]
    
    Throws:
    
    SshException
  - setX11AuthenticationCookie
```
public void setX11AuthenticationCookie(byte[] x11FakeCookie)
```
    Description copied from interface: SshContext
    
    Set the fake cookie used for X11 authentication
    
    Specified by:
    
    setX11AuthenticationCookie in interface SshContext
  - setX11RealCookie
```
public void setX11RealCookie(byte[] x11RealCookie)
```
    Description copied from interface: SshContext
    
    Sets the real X11 authentication cookie which can be obtained from the users $HOME/.Xauthority file.
    
    Specified by:
    
    setX11RealCookie in interface SshContext
  - getX11RealCookie
```
public byte[] getX11RealCookie()
                        throws SshException
```
    Description copied from interface: SshContext
    
    Get the real X11 authentication cookie, if not cookie has been set the fake cookie will be returned.
    
    Specified by:
    
    getX11RealCookie in interface SshContext
    
    Returns:
    
    byte[]
    
    Throws:
    
    SshException
  - setX11RequestListener
```
public void setX11RequestListener(ForwardingRequestListener x11Listener)
```
    Description copied from interface: SshContext
    
    Set the listener to which X11 forwarding requests will be processed.
    
    Specified by:
    
    setX11RequestListener in interface SshContext
  - getX11RequestListener
```
public ForwardingRequestListener getX11RequestListener()
```
    Description copied from interface: SshContext
    
    Get the X11 forwarding request listener.
    
    Specified by:
    
    getX11RequestListener in interface SshContext
    
    Returns:
    
    ForwardingRequestListener
  - getCipherType
```
public int getCipherType(int supportedCiphers)
                  throws SshException
```
    Get the cipher type for this configuration context.
    
    Parameters:
    
    supportedCiphers -
    
    Returns:
    
    one of the supported cipher types, for example CIPHER_3DES
    
    Throws:
    
    IOException
    
    SshException
  - setCipherType
```
public void setCipherType(int preferredCipher)
```
    Set the cipher type for this configuration context.
    
    Parameters:
    
    preferredCipher - one of the supported cipher types, for example CIPHER_3DES
  - createCipher
```
public SshCipher createCipher(int cipherType)
                       throws SshException
```
    Throws:
    
    SshException
  - setHostKeyVerification
```
public void setHostKeyVerification(HostKeyVerification verify)
```
    Description copied from interface: SshContext
    
    Set the host key verification implementation.
    
    Specified by:
    
    setHostKeyVerification in interface SshContext
  - getHostKeyVerification
```
public HostKeyVerification getHostKeyVerification()
```
    Description copied from interface: SshContext
    
    Get the host key verification implementation.
    
    Specified by:
    
    getHostKeyVerification in interface SshContext
    
    Returns:
    
    the current host key verification implementation
  - setMessageTimeout
```
public void setMessageTimeout(int messageTimeout)
```
    Specified by:
    
    setMessageTimeout in interface SshContext
  - getMessageTimeout
```
public int getMessageTimeout()
```
    Specified by:
    
    getMessageTimeout in interface SshContext
    
    Returns:
  - enableFIPSMode
```
@Deprecated
public void enableFIPSMode()
                                throws SshException
```
    Deprecated. This method is out-of-date. Use JCEProvider.initializeDefaultProvider("BCFIPS") passing a FIPS approved JCE provider in approved mode to restrict algorithms to only those supported by the approved FIPS environment.
    
    Description copied from interface: SshContext
    
    Enables FIPS compatible algorithms and disables any other non-compatible algorithms.
    
    Specified by:
    
    enableFIPSMode in interface SshContext
    
    Throws:
    
    SshException
  - getExecutorService
```
public ExecutorService getExecutorService()
```
    Specified by:
    
    getExecutorService in interface ExecutorServiceProvider
  - setExecutorService
```
public void setExecutorService(ExecutorService executor)
```
    Specified by:
    
    setExecutorService in interface ExecutorServiceProvider
  - isSHA1SignaturesSupported
```
public boolean isSHA1SignaturesSupported()
```
    Description copied from interface: SshContext
    
    Option to disable SHA1 signatures on RSA keys.
    
    Specified by:
    
    isSHA1SignaturesSupported in interface SshContext
    
    Returns:
  - setSHA1SignaturesSupported
```
public void setSHA1SignaturesSupported(boolean supportSHA1Signatures)
```
    Description copied from interface: SshContext
    
    Option to disable SHA1 signatures on RSA keys.
    
    Specified by:
    
    setSHA1SignaturesSupported in interface SshContext

Class Ssh1Context

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CIPHER_DES

CIPHER_3DES

Constructor Detail

Ssh1Context

Method Detail

setChannelLimit

getChannelLimit

setSFTPProvider

getSFTPProvider

setX11Display

getX11Display

getX11AuthenticationCookie

setX11AuthenticationCookie

setX11RealCookie

getX11RealCookie

setX11RequestListener

getX11RequestListener

getCipherType

setCipherType

createCipher

setHostKeyVerification

getHostKeyVerification

setMessageTimeout

getMessageTimeout

enableFIPSMode

getExecutorService

setExecutorService

isSHA1SignaturesSupported

setSHA1SignaturesSupported