ConnectBot SSH Library/org.connectbot.sshlib

Package-level declarations

Types

data class AgentIdentity(val publicKeyBlob: ByteArray, val comment: String, val destinationConstraints: List<DestinationConstraint>? = null)

A public key identity available in the agent.

AgentKeySpec

data class AgentKeySpec(val keyBlob: ByteArray, val isCa: Boolean)

A host key specification used in destination constraints.

AgentProvider

interface AgentProvider

Provider interface for SSH agent forwarding.

AgentResult

sealed interface AgentResult<out T>

Result of an AgentProvider callback.

AgentSignatureFlags

object AgentSignatureFlags

Signature flags for agent sign requests.

AgentSigningContext

data class AgentSigningContext(val publicKeyBlob: ByteArray, val dataToSign: ByteArray, val flags: Int, val sessionId: ByteArray, val serverHostKey: ByteArray, val isBound: Boolean)

Context for agent signing decisions.

AuthHandler

interface AuthHandler

Callback-driven authentication handler.

AuthPublicKey

data class AuthPublicKey(val algorithmName: String, val publicKeyBlob: ByteArray)

An SSH public key for authentication probing.

AuthResult

sealed interface AuthResult

Result of SshClient.authenticatePassword, SshClient.authenticatePublicKey, SshClient.authenticateKeyboardInteractive, and SshClient.authenticate.

ConnectionInfo

data class ConnectionInfo(val kexAlgorithm: String, val serverHostKeyAlgorithm: String, val encryptionAlgorithmC2S: String, val encryptionAlgorithmS2C: String, val macAlgorithmC2S: String?, val macAlgorithmS2C: String?)

Negotiated algorithm details for an established SSH connection.

ConnectResult

sealed interface ConnectResult

Result of SshClient.connect.

DestinationConstraint

data class DestinationConstraint(val fromHostname: String, val fromKeyspecs: List<AgentKeySpec>, val toUsername: String, val toHostname: String, val toHostspecs: List<AgentKeySpec>)

One hop entry in a destination constraint for a key in the agent.

HostKeyVerifier

interface HostKeyVerifier

Verifies the identity of a server by checking its host key.

KeyboardInteractiveCallback

interface KeyboardInteractiveCallback

Callback for keyboard-interactive authentication (RFC 4256).

KeyFingerprint

object KeyFingerprint

SSH key fingerprint utilities.

KnownHostsVerifier

class KnownHostsVerifier(file: File, hostname: String, port: Int = 22) : HostKeyVerifier

A host key verifier that reads from an OpenSSH-style known_hosts file.

PingResult

sealed class PingResult

Result of a SshClient.ping call.

PortForwarder

interface PortForwarder : AutoCloseable

Handle to an active port forwarding.

PublicKey

data class PublicKey(val type: String, val encoded: ByteArray)

A generic public key representation.

SessionExit

sealed interface SessionExit

How the remote process on a session channel terminated (RFC 4254 section 6.10).

SftpAttributes

data class SftpAttributes(val size: Long? = null, val uid: Int? = null, val gid: Int? = null, val permissions: Int? = null, val atime: Int? = null, val mtime: Int? = null)

File attributes for SFTP operations (SFTPv3 ATTRS structure).

SftpClient

interface SftpClient : AutoCloseable

SFTP client for file transfer over SSH (draft-ietf-secsh-filexfer).

SftpDirectoryEntry