Package org.apache.sshd.client.auth
Interface UserAuth
- All Superinterfaces:
ClientSessionHolder
,NamedResource
,UserAuthInstance<ClientSession>
- All Known Implementing Classes:
AbstractUserAuth
,UserAuthHostBased
,UserAuthKeyboardInteractive
,UserAuthPassword
,UserAuthPublicKey
Represents a user authentication mechanism
-
Field Summary
Fields inherited from interface org.apache.sshd.common.NamedResource
BY_NAME_COMPARATOR, NAME_EXTRACTOR
-
Method Summary
Modifier and TypeMethodDescriptionvoid
destroy()
Called to release any allocated resourcesvoid
init
(ClientSession session, String service) boolean
default void
signalAuthMethodFailure
(ClientSession session, String service, boolean partial, List<String> serverMethods, Buffer buffer) Signals reception ofSSH_MSG_USERAUTH_FAILURE
messagedefault void
signalAuthMethodSuccess
(ClientSession session, String service, Buffer buffer) Signal reception ofSSH_MSG_USERAUTH_SUCCESS
messageMethods inherited from interface org.apache.sshd.client.session.ClientSessionHolder
getClientSession
Methods inherited from interface org.apache.sshd.common.NamedResource
getName
Methods inherited from interface org.apache.sshd.common.auth.UserAuthInstance
getSession
-
Method Details
-
init
- Parameters:
session
- TheClientSession
service
- The requesting service name- Throws:
Exception
- If failed to initialize the mechanism
-
process
- Parameters:
buffer
- TheBuffer
to process -null
if not a response buffer, i.e., the underlying authentication mechanism should initiate whatever challenge/response mechanism is required- Returns:
true
if request handled -false
if the next authentication mechanism should be used- Throws:
Exception
- If failed to process the request
-
signalAuthMethodSuccess
default void signalAuthMethodSuccess(ClientSession session, String service, Buffer buffer) throws Exception Signal reception ofSSH_MSG_USERAUTH_SUCCESS
message- Parameters:
session
- TheClientSession
service
- The requesting service namebuffer
- TheBuffer
containing the success message (after having consumed the relevant data from it)- Throws:
Exception
- If failed to handle the callback - Note: may cause session close
-
signalAuthMethodFailure
default void signalAuthMethodFailure(ClientSession session, String service, boolean partial, List<String> serverMethods, Buffer buffer) throws Exception Signals reception ofSSH_MSG_USERAUTH_FAILURE
message- Parameters:
session
- TheClientSession
service
- The requesting service namepartial
-true
if some partial authentication success so farserverMethods
- TheList
of authentication methods that can continuebuffer
- TheBuffer
containing the failure message (after having consumed the relevant data from it)- Throws:
Exception
- If failed to handle the callback - Note: may cause session close
-
destroy
void destroy()Called to release any allocated resources
-