com.jcraft.jsch

Class HostBasedUserAuth

java.lang.Object

com.jcraft.jsch.UserAuth

com.jcraft.jsch.HostBasedUserAuth

public class HostBasedUserAuth
extends com.jcraft.jsch.UserAuth

A JSch UserAuth implementation for SSH host based authentication,

This class creates the correct hostbased authentication messages as detailed in http://tools.ietf.org/html/rfc4252#section-9 and https://www.ietf.org/rfc/rfc4252.txt

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 standard name of the host based authentication method

Fields inherited from class com.jcraft.jsch.UserAuth

buf, packet, SSH_MSG_USERAUTH_BANNER, SSH_MSG_USERAUTH_FAILURE, SSH_MSG_USERAUTH_INFO_REQUEST, SSH_MSG_USERAUTH_INFO_RESPONSE, SSH_MSG_USERAUTH_PK_OK, SSH_MSG_USERAUTH_REQUEST, SSH_MSG_USERAUTH_SUCCESS, userinfo, username

Constructor Summary

Constructors

Constructor and Description
HostBasedUserAuth()

Method Summary

Modifier and Type	Method and Description
protected void	addSignature(com.jcraft.jsch.Session session, com.jcraft.jsch.Identity identity) Create a signature from the Session.getSessionId() and current UserAuth.buf contents.
protected void	createAuthMessage(String localHostName, String algorithm, byte[] publicKeyBlob) Create the authentication message to send to the server.
protected boolean	handleAuthResponse(com.jcraft.jsch.Session session) Handle the authentication response from the server.
protected void	handleBanner() Handle a SSH_MSG_USERAUTH_BANNER response from the server.
protected void	handleFailure() Handle an SSH_MSG_USERAUTH_FAILURE response from the server.
boolean	start(com.jcraft.jsch.Session session)

Methods inherited from class java.lang.Object

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

Field Detail

AUTH_HOSTBASED

public static final String AUTH_HOSTBASED

The standard name of the host based authentication method

See Also:

Constant Field Values

Constructor Detail

HostBasedUserAuth

public HostBasedUserAuth()

Method Detail

start

public boolean start(com.jcraft.jsch.Session session)
              throws Exception

Overrides:

start in class com.jcraft.jsch.UserAuth

Throws:

Exception

createAuthMessage

protected void createAuthMessage(String localHostName,
                                 String algorithm,
                                 byte[] publicKeyBlob)
                          throws Exception

Create the authentication message to send to the server. The message is created in this UserAuth's internal UserAuth.buf field. The formal of the message is defined by http://tools.ietf.org/html/rfc4252#section-9

Parameters:

localHostName - the local host name being used for the hostbased authentication

algorithm - the name of the key algorithm

publicKeyBlob - the public key

Throws:

Exception - when the auth message can't be created

addSignature

protected void addSignature(com.jcraft.jsch.Session session,
                            com.jcraft.jsch.Identity identity)
                     throws Exception

Create a signature from the Session.getSessionId() and current UserAuth.buf contents.

Parameters:

session - the Session to get the sessionId from

identity - the Identity being used to authenticate to the server

Throws:

Exception - when the signature can't be added

handleAuthResponse

protected boolean handleAuthResponse(com.jcraft.jsch.Session session)
                              throws Exception

Handle the authentication response from the server.

Parameters:

session - the current Session being authenticated

Returns:

true if authentication is successful, otherwise false

Throws:

Exception - if an error occurs

handleBanner

protected void handleBanner()

Handle a SSH_MSG_USERAUTH_BANNER response from the server.

handleFailure

protected void handleFailure()
                      throws com.jcraft.jsch.JSchPartialAuthException

Handle an SSH_MSG_USERAUTH_FAILURE response from the server.

Throws:

JSchPartialAuthException - if this is a partial failure