UserAuth (JSch API)

java.lang.Object
- com.jcraft.jsch.UserAuth

Direct Known Subclasses:

UserAuthGSSAPIWithMIC
```
public abstract class UserAuth
extends Object
```
Usually not to be used by applications. The base class for all User authentication methods supported by this SSH implementation. The actual method will be negiotiated between client and server, and then we'll look up the implementation class by the configuration option with the choosen method as a name.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Buffer`	`buf`
`protected Packet`	`packet`
`protected static int`	`SSH_MSG_USERAUTH_BANNER`
`protected static int`	`SSH_MSG_USERAUTH_FAILURE`
`protected static int`	`SSH_MSG_USERAUTH_INFO_REQUEST`
`protected static int`	`SSH_MSG_USERAUTH_INFO_RESPONSE`
`protected static int`	`SSH_MSG_USERAUTH_PK_OK`
`protected static int`	`SSH_MSG_USERAUTH_REQUEST`
`protected static int`	`SSH_MSG_USERAUTH_SUCCESS`
`protected UserInfo`	`userinfo`
`protected String`	`username`

Constructor Summary

Constructors
Constructor and Description

UserAuth()

Constructors
Constructor and Description
`UserAuth()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

boolean start(Session session)
Will be called by the Session to do the authentication.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`start(Session session)` Will be called by the Session to do the authentication.

- Field Detail
  - SSH_MSG_USERAUTH_REQUEST
```
protected static final int SSH_MSG_USERAUTH_REQUEST
```
    See Also:
    
    Constant Field Values
  - SSH_MSG_USERAUTH_FAILURE
```
protected static final int SSH_MSG_USERAUTH_FAILURE
```
    See Also:
    
    Constant Field Values
  - SSH_MSG_USERAUTH_SUCCESS
```
protected static final int SSH_MSG_USERAUTH_SUCCESS
```
    See Also:
    
    Constant Field Values
  - SSH_MSG_USERAUTH_BANNER
```
protected static final int SSH_MSG_USERAUTH_BANNER
```
    See Also:
    
    Constant Field Values
  - SSH_MSG_USERAUTH_INFO_REQUEST
```
protected static final int SSH_MSG_USERAUTH_INFO_REQUEST
```
    See Also:
    
    Constant Field Values
  - SSH_MSG_USERAUTH_INFO_RESPONSE
```
protected static final int SSH_MSG_USERAUTH_INFO_RESPONSE
```
    See Also:
    
    Constant Field Values
  - SSH_MSG_USERAUTH_PK_OK
```
protected static final int SSH_MSG_USERAUTH_PK_OK
```
    See Also:
    
    Constant Field Values
  - userinfo
```
protected UserInfo userinfo
```
  - packet
```
protected Packet packet
```
  - buf
```
protected Buffer buf
```
  - username
```
protected String username
```
- Constructor Detail
  - UserAuth
```
public UserAuth()
```
- Method Detail
  - start
```
public boolean start(Session session)
              throws Exception
```
    Will be called by the Session to do the authentication. Subclasses will override this method and do the actual authentication, using the session's read/write methods.
    This implementation fills the protected variables username, packet, buf and userinfo and returns true. Subclasses will usually call super.start(session) as first statement in the implementation.
    
    Returns:
    
    true if the authentication was successful, else false.
    
    Throws:
    
    JSchPartialAuthException - if the authentication was partially successful, i.e. not yet sufficient to login, but enough to continue with more methods.
    
    Exception

This is an inofficial Javadoc created by Paŭlo Ebermann. Have a look at the official homepage.

Class UserAuth

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SSH_MSG_USERAUTH_REQUEST

SSH_MSG_USERAUTH_FAILURE

SSH_MSG_USERAUTH_SUCCESS

SSH_MSG_USERAUTH_BANNER

SSH_MSG_USERAUTH_INFO_REQUEST

SSH_MSG_USERAUTH_INFO_RESPONSE

SSH_MSG_USERAUTH_PK_OK

userinfo

packet

buf

username

Constructor Detail

UserAuth

Method Detail

start