SecureBlackbox Lite 2020 Kotlin Edition

Questions / Feedback?

AuthFailed Event

Fires if an authentication attempt fails.

Syntax

public open class DefaultSftpclientEventListener : SftpclientEventListener {
  ...
  public override fun authFailed(e: SftpclientAuthFailedEvent) {}
  ...
}

public class SftpclientAuthFailedEvent {
  val authType: Int
}

Remarks

This event fires if an authentication attempt fails (for example, if a bad password had been provided). AuthType parameter indicates the authentication type.

AuthFailed may be fired more than once, depending on the configured authentication parameters and the value assigned to the AuthAttempts property.

This event does not necessarily lead to connection abortion, as the client may still have a chance of authenticating with a different method.

Supported authentication types:

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox Lite 2020 Kotlin Edition - Version 20.0 [Build 8063]