dartssh2 library

Classes

OpenSSHBcryptKdfOptions
OpenSSHEcdsaKeyPair
OpenSSHEd25519KeyPair
OpenSSHKdfOptions
OpenSSHKeyPair
OpenSSHKeyPairs
OpenSSHRsaKeyPair
RsaKeyPair
RsaKeyPairDEKInfo
Corresponds to the DEK-Info header in PEM.
RsaPrivateKey
SftpAbortError
SftpClient
SftpError
SftpExtensionError
SftpExtensionUnsupportedError
SftpExtensionVersionMismatchError
SftpFile
SftpFileAttrs
SftpFileMode
SftpFileOpenMode
SftpFileWriter
Holds the state of a streaming write operation from stream to file.
SftpHandsake
Handsake information received from the server.
SftpName
SftpStatusCode
SftpStatusError
SSHAlgorithms
SSHAuthAbortError
Errors that happen when the authentication failed due to other reasons. For example network errors.
SSHAuthError
Errors that happen when the library fails to authenticate.
SSHAuthFailError
Errors that happen when the library tried all the authentication methods and failed to authenticate.
SSHChannelOpenError
Errors that happen when the library fails to open a channel.
SSHChannelRequestError
Errors that happen when the library fails to send a channel request.
SSHCipherType
SSHClient
SSHContentType
A MIME/IANA media type used as the value of the SSHHttpHeaders.contentTypeHeader header.
SSHError
Interface for all the exceptions thrown by the library.
SSHForwardChannel
SSHHandshakeError
Errors that happen when the library fails to connect to handshake.
SSHHostkeyError
Errors that happen when the library fails to verify the host key.
SSHHostkeyType
SSHHttpClient
A HTTP client that works over SSH port forwarding.
SSHHttpClientRequest
HTTP request created on a SSHHttpClient.
SSHHttpClientResponse
HTTP response for a SSHHttpClientRequest.
SSHHttpHeaders
Headers for HTTP requests and responses.
SSHInternalError
Errors that are not expected to occur. Most of the time, these are caused by bugs in the library.
SSHKexType
SSHKeyDecodeError
Errors that happen when the library fails to decode a key.
SSHKeyDecryptError
Errors that happen when the library fails to decrypt the host key.
SSHKeyPair
SSHMacType
SSHPacketError
Errors that happen when the library receives an malformed packet.
SSHPem
SSHPtyConfig
SSHRemoteForward
SSHSession
A SSHSession represents a remote execution of a program.
SSHSessionExitSignal
Information about the exit signal of a remote process.
SSHSocket
SSHSocketError
Errors related to the underlying socket.
SSHStateError
Errors that happen when the library receives an unexpected packet.
SSHTransport

Enums

SftpFileType
SSHHttpProtocolVersion
Version of HTTP to use for the request.
SSHSignal

Mixins

DoneFuture
Implements Future interface for SftpFileWriter.
SSHMessageError
Errors with a message.

Extensions

SSHSignalX on SSHSignal

Constants

chunkSize → const int
The amount of data to send in a single SFTP packet.
maxBytesOnTheWire → const int
The maximum amount of data that can be sent to the remote host without receiving an acknowledgement.

Functions

digestSha1() → Digest
digestSha256() → Digest
digestSha384() → Digest
digestSha512() → Digest

Typedefs

SSHAuthenticatedHandler = void Function()
SSHChangePasswordRequestHandler = FutureOr<SSHChangePasswordResponse?> Function(String prompt)
SSHHostkeyVerifyHandler = FutureOr<bool> Function(String type, Uint8List fingerprint)
Function called when host key is received. type is the type of the host key, For example 'ssh-rsa', fingerprint md5 fingerprint of the host key.
SSHPacketHandler = void Function(Uint8List payload)
SSHPasswordRequestHandler = FutureOr<String?> Function()
https://datatracker.ietf.org/doc/html/rfc4252#section-8
SSHPrintHandler = void Function(String?)
SSHRemoteConnectionFilter = bool Function(String host, int port)
SSHTransportReadyHandler = void Function()
SSHUserauthBannerHandler = void Function(String banner)
https://datatracker.ietf.org/doc/html/rfc4252#section-5.4
SSHUserInfoRequestHandler = FutureOr<List<String>?> Function(SSHUserInfoRequest request)
https://datatracker.ietf.org/doc/html/rfc4256#section-3.3

Exceptions / Errors

SSHHttpException
Exception thrown when an SSH HTTP request fails.