com.oracle.bedrock.runtime.remote

Class HostBased

java.lang.Object

com.oracle.bedrock.runtime.remote.HostBased

All Implemented Interfaces:

Authentication, JSchBasedAuthentication

public class HostBased
extends Object
implements Authentication, JSchBasedAuthentication

A host based Authentication see http://tools.ietf.org/html/rfc4252#section-9

Copyright (c) 2016. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Jonathan Knight

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_HOSTBASED The authentication method name for host based authentication.
static byte[]	NO_PASS_PHRASE The empty pass phrase to use if none is required.
static String	SSH_PREFERRED_AUTHENTICATIONS The SSH configuration name for the preferred authentication methods list.

Constructor Summary

Constructors

Constructor and Description
HostBased(String privateKeyFileName) Create a HostBased using the specified private key.
HostBased(String privateKey, byte[] passphrase) Create a HostBased using the specified private key and pass phrase.
HostBased(String privateKey, String passphrase) Create a HostBased using the specified private key and pass phrase.
HostBased(String privateKey, String publicKey, byte[] passphrase) Create a HostBased using the specified private key and pass phrase.
HostBased(String privateKey, String publicKey, String passphrase) Create a HostBased using the specified private key and pass phrase.

Method Summary

Modifier and Type	Method and Description
HostBased	addIdentity(String privateKey) Add an alternative identity that may be used to attempt authentication.
HostBased	addIdentity(String privateKey, byte[] passphrase) Add an alternative identity that may be used to attempt authentication.
HostBased	addIdentity(String privateKey, String passphrase) Add an alternative identity that may be used to attempt authentication.
HostBased	addIdentity(String privateKey, String publicKey, byte[] passphrase) Add an alternative identity that may be used to attempt authentication.
HostBased	addIdentity(String privateKey, String publicKey, String passphrase) Add an alternative identity that may be used to attempt authentication.
void	configureFramework(com.jcraft.jsch.JSch jsch) Configures the JSch framework for the type of Authentication, prior to creating a Session.
void	configureSession(com.jcraft.jsch.Session session) Configures the JSch Session for the type of Authentication, prior to creating a connection.
static byte[]	stringToBytes(String s) Convert the specified String to a UTF-8 byte array.

Methods inherited from class java.lang.Object

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

Field Detail

NO_PASS_PHRASE

public static final byte[] NO_PASS_PHRASE

The empty pass phrase to use if none is required.

SSH_PREFERRED_AUTHENTICATIONS

public static final String SSH_PREFERRED_AUTHENTICATIONS

The SSH configuration name for the preferred authentication methods list.

See Also:

Constant Field Values

AUTH_HOSTBASED

public static final String AUTH_HOSTBASED

The authentication method name for host based authentication.

See Also:

Constant Field Values

Constructor Detail

HostBased

public HostBased(String privateKeyFileName)

Create a HostBased using the specified private key.

Parameters:

privateKeyFileName - the private key to use to authenticate

HostBased

public HostBased(String privateKey,
                 byte[] passphrase)

Create a HostBased using the specified private key and pass phrase.

Parameters:

privateKey - the private key to use to authenticate

passphrase - he optional pass phrase for the private key

HostBased

public HostBased(String privateKey,
                 String passphrase)

Create a HostBased using the specified private key and pass phrase.

Parameters:

privateKey - the private key to use to authenticate

passphrase - he optional pass phrase for the private key

HostBased

public HostBased(String privateKey,
                 String publicKey,
                 byte[] passphrase)

Create a HostBased using the specified private key and pass phrase.

Parameters:

privateKey - the private key to use to authenticate

publicKey - the optional public key to use to authenticate

passphrase - he optional pass phrase for the private key

HostBased

public HostBased(String privateKey,
                 String publicKey,
                 String passphrase)

Create a HostBased using the specified private key and pass phrase.

Parameters:

privateKey - the private key to use to authenticate

publicKey - the optional public key to use to authenticate

passphrase - he optional pass phrase for the private key

Method Detail

addIdentity

public HostBased addIdentity(String privateKey)

Add an alternative identity that may be used to attempt authentication.

Parameters:

privateKey - the private key to use to authenticate

Returns:

this HostBased

addIdentity

public HostBased addIdentity(String privateKey,
                             String passphrase)

Add an alternative identity that may be used to attempt authentication.

Parameters:

privateKey - the private key to use to authenticate

passphrase - he optional pass phrase for the private key

Returns:

this HostBased

addIdentity

public HostBased addIdentity(String privateKey,
                             byte[] passphrase)

Add an alternative identity that may be used to attempt authentication.

Parameters:

privateKey - the private key to use to authenticate

passphrase - he optional pass phrase for the private key

Returns:

this HostBased

addIdentity

public HostBased addIdentity(String privateKey,
                             String publicKey,
                             String passphrase)

Add an alternative identity that may be used to attempt authentication.

Parameters:

privateKey - the private key to use to authenticate

publicKey - the optional public key to use to authenticate

passphrase - he optional pass phrase for the private key

Returns:

this HostBased

addIdentity

public HostBased addIdentity(String privateKey,
                             String publicKey,
                             byte[] passphrase)

Add an alternative identity that may be used to attempt authentication.

Parameters:

privateKey - the private key to use to authenticate

publicKey - the optional public key to use to authenticate

passphrase - he optional pass phrase for the private key

Returns:

this HostBased

configureFramework

public void configureFramework(com.jcraft.jsch.JSch jsch)

Description copied from interface: JSchBasedAuthentication

Configures the JSch framework for the type of Authentication, prior to creating a Session.

Specified by:

configureFramework in interface JSchBasedAuthentication

Parameters:

jsch - the JSch framework to configure

configureSession

public void configureSession(com.jcraft.jsch.Session session)

Description copied from interface: JSchBasedAuthentication

Configures the JSch Session for the type of Authentication, prior to creating a connection.

Specified by:

configureSession in interface JSchBasedAuthentication

Parameters:

session - the Session to configure

stringToBytes

public static byte[] stringToBytes(String s)

Convert the specified String to a UTF-8 byte array.

Parameters:

s - the string to convert

Returns:

the UTF-8 bytes representing the String