Apache Mina SSHD 2.15.0 · org.apache.sshd.server.auth.AbstractUserAuth

Modifier and Type	Field and Description
private final String	name
private String	service
private ServerSession	session
private String	username

Access	Constructor and Description
protected	AbstractUserAuth(String name)

Method Summary

Modifier and Type	Method and Description
public Boolean	auth(ServerSession the current `ServerSession` session session, String the user trying to log in username, String the requested service name service, Buffer the request buffer containing parameters specific to this request buffer) Implements org.apache.sshd.server.auth.UserAuth.auth. Try to authenticate the user.
public void	destroy() Implements org.apache.sshd.server.auth.UserAuth.destroy. Free any system resources used by the module.
protected abstract Boolean	doAuth(Buffer buffer, boolean init)
public final String	getName() Implements org.apache.sshd.common.NamedResource.getName.
public ServerSession	getServerSession() Implements org.apache.sshd.server.session.ServerSessionHolder.getServerSession.
public String	getService()
public ServerSession	getSession() Implements org.apache.sshd.common.auth.UserAuthInstance.getSession.
public String	getUsername() Implements org.apache.sshd.common.auth.UsernameHolder.getUsername.
public Boolean	next(Buffer the request buffer containing parameters specific to this request buffer) Implements org.apache.sshd.server.auth.UserAuth.next. Handle another step in the authentication process.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.apache.sshd.common.util.logging.AbstractLoggingBean:: debug debug debug debug debug error error error error error getSimplifiedLogger info info warn warn warn warn warn warn warn warn

name	back to summary
private final String name

service	back to summary
private String service

session	back to summary
private ServerSession session

username	back to summary
private String username

AbstractUserAuth	back to summary
protected AbstractUserAuth(String name)

Method Detail

auth back to summary

auth	back to summary
public Boolean auth(ServerSession session, String username, String service, Buffer buffer) throws Exception Implements org.apache.sshd.server.auth.UserAuth.auth. Doc from org.apache.sshd.server.auth.UserAuth.auth. Try to authenticate the user. This methods should return a non `null` value indicating if the authentication succeeded. If the authentication is still ongoing, a `null` value should be returned. Parameters session:ServerSession the current `ServerSession` session username:String the user trying to log in service:String the requested service name buffer:Buffer the request buffer containing parameters specific to this request Returns:Boolean `true` if the authentication succeeded, `false` if the authentication failed and `null` if not finished yet Annotations @Override Exceptions Exception: if the authentication fails

public Boolean auth(ServerSession session, String username, String service, Buffer buffer) throws Exception

Implements org.apache.sshd.server.auth.UserAuth.auth.

Doc from org.apache.sshd.server.auth.UserAuth.auth.

Try to authenticate the user. This methods should return a non null value indicating if the authentication succeeded. If the authentication is still ongoing, a null value should be returned.

Parameters

session:ServerSession: the current ServerSession session
username:String: the user trying to log in
service:String: the requested service name
buffer:Buffer: the request buffer containing parameters specific to this request

Returns:Boolean

true if the authentication succeeded, false if the authentication failed and null if not finished yet

Annotations

@Override

Exceptions

Exception:: if the authentication fails

destroy	back to summary
public void destroy() Implements org.apache.sshd.server.auth.UserAuth.destroy. Doc from org.apache.sshd.server.auth.UserAuth.destroy. Free any system resources used by the module. Annotations @Override

destroy

back to summary

public void destroy()

Implements org.apache.sshd.server.auth.UserAuth.destroy.

Doc from org.apache.sshd.server.auth.UserAuth.destroy.

Free any system resources used by the module.

Annotations

@Override

doAuth	back to summary
protected abstract Boolean doAuth(Buffer buffer, boolean init) throws Exception

getName	back to summary
public final String getName() Implements org.apache.sshd.common.NamedResource.getName. Returns:String Doc from org.apache.sshd.common.NamedResource.getName. The resource name Annotations @Override

getName

back to summary

public final String getName()

Implements org.apache.sshd.common.NamedResource.getName.

Returns:String

Doc from org.apache.sshd.common.NamedResource.getName.

The resource name

Annotations

@Override

getServerSession back to summary

getServerSession	back to summary
public ServerSession getServerSession() Implements org.apache.sshd.server.session.ServerSessionHolder.getServerSession. Returns:ServerSession Doc from org.apache.sshd.server.session.ServerSessionHolder.getServerSession. The underlying `ServerSession` used Annotations @Override

public ServerSession getServerSession()

Implements org.apache.sshd.server.session.ServerSessionHolder.getServerSession.

Returns:ServerSession

Doc from org.apache.sshd.server.session.ServerSessionHolder.getServerSession.

The underlying ServerSession used

Annotations

@Override

getService	back to summary
public String getService()

getSession back to summary

getSession	back to summary
public ServerSession getSession() Implements org.apache.sshd.common.auth.UserAuthInstance.getSession. Returns:ServerSession Doc from org.apache.sshd.common.auth.UserAuthInstance.getSession. The current session for which the authentication is being tracked Note may be `null` if the instance has not been initialized yet Annotations @Override

public ServerSession getSession()

Implements org.apache.sshd.common.auth.UserAuthInstance.getSession.

Returns:ServerSession

Doc from org.apache.sshd.common.auth.UserAuthInstance.getSession.

The current session for which the authentication is being tracked

Note

may be null if the instance has not been initialized yet

Annotations

@Override

getUsername back to summary

getUsername	back to summary
public String getUsername() Implements org.apache.sshd.common.auth.UsernameHolder.getUsername. Returns:String Doc from org.apache.sshd.common.auth.UsernameHolder.getUsername. The attached username - may be `null`/empty if holder not yet initialized Annotations @Override

public String getUsername()

Implements org.apache.sshd.common.auth.UsernameHolder.getUsername.

Returns:String

Doc from org.apache.sshd.common.auth.UsernameHolder.getUsername.

The attached username - may be null/empty if holder not yet initialized

Annotations

@Override

next back to summary

next	back to summary
public Boolean next(Buffer buffer) throws Exception Implements org.apache.sshd.server.auth.UserAuth.next. Doc from org.apache.sshd.server.auth.UserAuth.next. Handle another step in the authentication process. Parameters buffer:Buffer the request buffer containing parameters specific to this request Returns:Boolean `true` if the authentication succeeded, `false` if the authentication failed and `null` if not finished yet Annotations @Override Exceptions Exception: if the authentication fails

public Boolean next(Buffer buffer) throws Exception

Implements org.apache.sshd.server.auth.UserAuth.next.

Doc from org.apache.sshd.server.auth.UserAuth.next.

Handle another step in the authentication process.

Parameters

buffer:Buffer: the request buffer containing parameters specific to this request

Returns:Boolean

true if the authentication succeeded, false if the authentication failed and null if not finished yet

Annotations

@Override

Exceptions

Exception:: if the authentication fails

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public abstract Class AbstractUserAuth

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail