SecureBlackbox Lite 2020 Python Edition

Questions / Feedback?

on_auth_attempt Event

Fires when an authentication attempt is performed.

Syntax

class SFTPClientAuthAttemptEventParams(object):
  @property
  def auth_type() -> int: ...

# In class SFTPClient:
@property
def on_auth_attempt() -> Callable[[SFTPClientAuthAttemptEventParams], None]: ...
@on_auth_attempt.setter
def on_auth_attempt(event_hook: Callable[[SFTPClientAuthAttemptEventParams], None]) -> None: ...

Remarks

This event signals the start of an authentication attempt. The AuthType parameter specifies the authentication type. This event may be fired more than once if the client tries different authentication methods one after another.

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 Python Edition - Version 20.0 [Build 8166]