ConnectBot SSH Library/org.connectbot.sshlib/AuthHandler

AuthHandler

Callback-driven authentication handler.

The library drives the authentication flow per RFC 4252, calling back into this handler for materials. The flow is: none → publickey probe → sign → keyboard-interactive → password

Functions

onAuthMethodsAvailable

open suspend fun onAuthMethodsAvailable(methods: Set<String>)

Called when the server reports which authentication methods are available. Override to observe or log.

onBanner

open suspend fun onBanner(message: String)

Called when the server sends an authentication banner (SSH_MSG_USERAUTH_BANNER). This is often used for out-of-band authentication instructions (e.g., a URL to visit).

onKeyboardInteractivePrompt

abstract suspend fun onKeyboardInteractivePrompt(name: String, instruction: String, prompts: List<KeyboardInteractiveCallback.Prompt>): List<String>?

Called when the server sends keyboard-interactive prompts. Return responses (one per prompt), or null to skip keyboard-interactive.

onPasswordNeeded

abstract suspend fun onPasswordNeeded(): String?

Return the password, or null to skip password auth.

onPublicKeysNeeded

abstract suspend fun onPublicKeysNeeded(): List<AuthPublicKey>

Return public keys to probe. Empty list skips public key auth.

onSignatureRequest

abstract suspend fun onSignatureRequest(key: AuthPublicKey, dataToSign: ByteArray): ByteArray?

Called only for keys the server accepted (PK_OK). Return the signature over dataToSign, or null to skip this key.