Back to FlowSsh Documentation

Client - SetUserAuthHandler, OnPasswordChange, OnFurtherAuth

[C]

__cdecl FlowSshC_Client_SetUserAuthHandler(
  FlowSshC_Client* client,
  FlowSshC_UserAuthHandler handler,
  void* handlerData);

[C++]

[Client] virtual bool OnPasswordChange(PasswordChange& passwordChange);
[Client] virtual bool OnFurtherAuth(FurtherAuth& furtherAuth)

[C#]

[Client] public event PasswordChangeEventHandler OnPasswordChange;
[Client] public event FurtherAuthEventHandler OnFurtherAuth;

[C] Parameters

  • client: FlowSshC_Client pointer.
  • handler: A UserAuthHandler function.
  • handlerData: An application-defined value to be passed to the handler. Optional.

[Cpp/Net] Overrides and Events

  • OnPasswordChange: Invoked if the server requests a new password.
    Parameters:
  • OnFurtherAuth: Invoked if the server needs additional data to authenticate the user.
    Parameters:

Handler Return Value

OnPasswordChange: Return false to abort password change and continue with user authentication (most likely raising FurtherAuth in the process).
OnFurtherAuth: Return false to stop user authentication and disconnect.

Remarks

OnPasswordChange: If a password has expired, the server will usually request a new password from the user.
OnFurtherAuth: Invoked if the server needs additional data, for instance a password or a keypair, to authenticate the user.

Both handlers are possibly invoked while establishing a connection with the SSH server, at progress [ConnectStep]SshUserAuth.