on_auth_attempt Event
Reports a user authentication attempt.
Syntax
class SFTPServerAuthAttemptEventParams(object): @property def connection_id() -> int: ... @property def username() -> str: ... @property def auth_type() -> int: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class SFTPServer: @property def on_auth_attempt() -> Callable[[SFTPServerAuthAttemptEventParams], None]: ... @on_auth_attempt.setter def on_auth_attempt(event_hook: Callable[[SFTPServerAuthAttemptEventParams], None]) -> None: ...
Remarks
ConnectionID identifies the session, Username specifies client's username, and AuthType specifies the authentication type. Use the Accept parameter to accept or decline the attempt.
Supported authentication types:
| atRhosts | 0x01 | RHOSTS file authentication. Rarely used today. |
| atPublicKey | 0x02 | Public key (sometimes called private key) authentication |
| atPassword | 0x04 | Password-based authentication |
| atHostbased | 0x08 | Hostbased authentication |
| atKeyboard | 0x10 | Keyboard-interactive authentication. This is often used in place of generic password authentication. |
| atGssWithMic | 0x20 | GSS authentication |
| atGssKeyex | 0x40 | GSS authentication with key exchange |
| atPublicKeyAgent | 0x80 | Public key agent authentication |