SSHSession

Undocumented in source.
class SSHSession : Disposable {}

Constructors

this
this()
Undocumented in source.
this
this(ssh_session session)
Undocumented in source.

Destructor

~this
~this()
Undocumented in source.

Members

Aliases

AuthCallback
alias AuthCallback = string delegate(string prompt, bool echo, bool verify)
Undocumented in source.
MessageCallback
alias MessageCallback = bool delegate(SSHSession session, SSHMessage message)
Undocumented in source.
OnConnectStatusChangedCallback
alias OnConnectStatusChangedCallback = void delegate(SSHSession session, float v)
Undocumented in source.
OnGlobalRequestCallback
alias OnGlobalRequestCallback = void delegate(SSHSession session, SSHMessage message)
Undocumented in source.
OnLogCallback
alias OnLogCallback = void delegate(SSHSession session, LogLevel level, string msg)
Undocumented in source.
OpenRequestX11Callback
alias OpenRequestX11Callback = SSHChannel delegate(SSHSession session, string originatorAddres, ushort originatorPort)
Undocumented in source.
ServerAuthGSSAPIMicCallback
alias ServerAuthGSSAPIMicCallback = AuthState delegate(SSHSession session, string user, string principal)
Undocumented in source.
ServerAuthNoneCallback
alias ServerAuthNoneCallback = AuthState delegate(SSHSession session, string user)
Undocumented in source.
ServerAuthPasswordCallback
alias ServerAuthPasswordCallback = AuthState delegate(SSHSession session, string user, string password)
Undocumented in source.
ServerAuthPublicKeyCallback
alias ServerAuthPublicKeyCallback = AuthState delegate(SSHSession session, string user, SSHKey publicKey, PublicKeyState signatureState)
Undocumented in source.
ServerChannelOpenRequestCallback
alias ServerChannelOpenRequestCallback = SSHChannel delegate(SSHSession session)
Undocumented in source.
ServerGSSAPIAcceptSecCtxCallback
alias ServerGSSAPIAcceptSecCtxCallback = bool delegate(SSHSession session, string inputToken, out string outputToken)
Undocumented in source.
ServerGSSAPISelectOidCallback
alias ServerGSSAPISelectOidCallback = string delegate(SSHSession session, string user, string[] oids)
Undocumented in source.
ServerServiceRequestCallback
alias ServerServiceRequestCallback = bool delegate(SSHSession session, string service)
Undocumented in source.

Functions

acceptForward
SSHChannel acceptForward(int timeoutMs)
Undocumented in source. Be warned that the author may not have intended to support it.
acceptForward
SSHChannel acceptForward(int timeoutMs, ushort destPort)
Undocumented in source. Be warned that the author may not have intended to support it.
blockingFlush
bool blockingFlush(int timeout)

Returns false on timeout

cancelForward
void cancelForward(string address, ushort port)
Undocumented in source. Be warned that the author may not have intended to support it.
connect
bool connect()

Returns false if the session is in nonblocking mode, and call must be done again.

disconnect
void disconnect()
Undocumented in source. Be warned that the author may not have intended to support it.
dispose
void dispose()
Undocumented in source. Be warned that the author may not have intended to support it.
freeChannel
void freeChannel(SSHChannel toDel)
Undocumented in source. Be warned that the author may not have intended to support it.
getCopy
SSHSession getCopy()
Undocumented in source. Be warned that the author may not have intended to support it.
getMessage
SSHMessage getMessage()
Undocumented in source. Be warned that the author may not have intended to support it.
getOption
string getOption(SessionOption type)
Undocumented in source. Be warned that the author may not have intended to support it.
handleKeyExchange
void handleKeyExchange()
Undocumented in source. Be warned that the author may not have intended to support it.
listenForward
bool listenForward(string address, ushort port, ushort boundPort)

return false if in nonblocking mode and call has to be done again.

newChannel
SSHChannel newChannel()
Undocumented in source. Be warned that the author may not have intended to support it.
newSFTP
SFTPSession newSFTP(SSHChannel channel)
Undocumented in source. Be warned that the author may not have intended to support it.
newSFTP
SFTPSession newSFTP()
Undocumented in source. Be warned that the author may not have intended to support it.
newSFTPServer
SFTPSession newSFTPServer(SSHChannel channel)
Undocumented in source. Be warned that the author may not have intended to support it.
newScp
SSHSCP newScp(SCPMode mode, string location)
Undocumented in source. Be warned that the author may not have intended to support it.
parseConfig
void parseConfig(string fileName)
Undocumented in source. Be warned that the author may not have intended to support it.
registerChannel
void registerChannel(SSHChannel ch)
Undocumented in source. Be warned that the author may not have intended to support it.
sendDebug
void sendDebug(string message, bool alwaysDisplay)
Undocumented in source. Be warned that the author may not have intended to support it.
sendIgnore
void sendIgnore(string message)
Undocumented in source. Be warned that the author may not have intended to support it.
setFdExcept
void setFdExcept()
Undocumented in source. Be warned that the author may not have intended to support it.
setFdToRead
void setFdToRead()
Undocumented in source. Be warned that the author may not have intended to support it.
setFdToWrite
void setFdToWrite()
Undocumented in source. Be warned that the author may not have intended to support it.
setOption
void setOption(SessionOption type, string[] value)
Undocumented in source. Be warned that the author may not have intended to support it.
setOption
void setOption(SessionOption type, bool value)
Undocumented in source. Be warned that the author may not have intended to support it.
setOption
void setOption(SessionOption type, string value)
Undocumented in source. Be warned that the author may not have intended to support it.
setOption
void setOption(SessionOption type, T value)
Undocumented in source. Be warned that the author may not have intended to support it.
silentDisconnect
void silentDisconnect()
Undocumented in source. Be warned that the author may not have intended to support it.
userauthAgent
AuthState userauthAgent(string username)
Undocumented in source. Be warned that the author may not have intended to support it.
userauthGSSAPI
AuthState userauthGSSAPI()
Undocumented in source. Be warned that the author may not have intended to support it.
userauthKeyboardInteractive
AuthState userauthKeyboardInteractive(string username)
Undocumented in source. Be warned that the author may not have intended to support it.
userauthKeyboardInteractiveGetAnswer
string userauthKeyboardInteractiveGetAnswer(uint i)
Undocumented in source. Be warned that the author may not have intended to support it.
userauthKeyboardInteractiveGetInstruction
string userauthKeyboardInteractiveGetInstruction()
Undocumented in source. Be warned that the author may not have intended to support it.
userauthKeyboardInteractiveGetNAnswers
int userauthKeyboardInteractiveGetNAnswers()
Undocumented in source. Be warned that the author may not have intended to support it.
userauthKeyboardInteractiveGetNPrompts
int userauthKeyboardInteractiveGetNPrompts()
Undocumented in source. Be warned that the author may not have intended to support it.
userauthKeyboardInteractiveGetName
string userauthKeyboardInteractiveGetName()
Undocumented in source. Be warned that the author may not have intended to support it.
userauthKeyboardInteractiveGetPrompt
string userauthKeyboardInteractiveGetPrompt(uint i)
Undocumented in source. Be warned that the author may not have intended to support it.
userauthKeyboardInteractiveGetPrompt
string userauthKeyboardInteractiveGetPrompt(uint i, bool echo)
Undocumented in source. Be warned that the author may not have intended to support it.
userauthKeyboardInteractiveSetAnswer
void userauthKeyboardInteractiveSetAnswer(uint i, string answer)
Undocumented in source. Be warned that the author may not have intended to support it.
userauthList
AuthMethod userauthList(string username)
Undocumented in source. Be warned that the author may not have intended to support it.
userauthNone
AuthState userauthNone(string username)
Undocumented in source. Be warned that the author may not have intended to support it.
userauthPassword
AuthState userauthPassword(string username, string password)
Undocumented in source. Be warned that the author may not have intended to support it.
userauthPublicKey
AuthState userauthPublicKey(string username, SSHKey privateKey)
Undocumented in source. Be warned that the author may not have intended to support it.
userauthPublicKeyAuto
AuthState userauthPublicKeyAuto(string username, string passPhrase)
Undocumented in source. Be warned that the author may not have intended to support it.
userauthTryPublicKey
AuthState userauthTryPublicKey(string username, SSHKey publicKey)
Undocumented in source. Be warned that the author may not have intended to support it.
writeKnownHost
void writeKnownHost()
Undocumented in source. Be warned that the author may not have intended to support it.

Properties

allowSSH1
bool allowSSH1 [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
allowSSH2
bool allowSSH2 [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
authCallback
AuthCallback authCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
authCallback
AuthCallback authCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
authMethods
AuthMethod authMethods [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
bindAddr
string bindAddr [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
cipherIn
string cipherIn [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
cipherOut
string cipherOut [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
ciphersCS
string[] ciphersCS [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
ciphersCS
string ciphersCS [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
ciphersSC
string[] ciphersSC [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
ciphersSC
string ciphersSC [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
clientBanner
string clientBanner [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
compression
string compression [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
compression
string[] compression [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
compression
bool compression [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
compressionCS
bool compressionCS [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
compressionCS
string[] compressionCS [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
compressionCS
string compressionCS [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
compressionSC
bool compressionSC [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
compressionSC
string[] compressionSC [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
compressionSC
string compressionSC [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
compressonLevel
int compressonLevel [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
disconnectMessage
string disconnectMessage [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
fd
socket_t fd [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
fd
socket_t fd [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
gssapiClientIdentity
string gssapiClientIdentity [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
gssapiCreds
GSSAPICreds gssapiCreds [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
gssapiCreds
GSSAPICreds gssapiCreds [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
gssapiDelegateCredentials
bool gssapiDelegateCredentials [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
gssapiServerIdentity
string gssapiServerIdentity [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
hmacIn
string hmacIn [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
hmacOut
string hmacOut [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
host
string host [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
host
string host [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
hostkeys
string[] hostkeys [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
hostkeys
string hostkeys [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
identity
string identity [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
identity
string identity [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
isBlocking
bool isBlocking [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
isBlocking
bool isBlocking [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
isConnected
bool isConnected [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
issueBanner
string issueBanner [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
kexAlgo
string kexAlgo [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
keyExchange
string keyExchange [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
keyExchange
string[] keyExchange [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
knownHosts
string knownHosts [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
lastError
string lastError [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
logVerbosity
LogVerbosity logVerbosity [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
messageCallback
MessageCallback messageCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
messageCallback
MessageCallback messageCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onConnectStatusChangedCallback
OnConnectStatusChangedCallback onConnectStatusChangedCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onConnectStatusChangedCallback
OnConnectStatusChangedCallback onConnectStatusChangedCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onGlobalRequestCallback
OnGlobalRequestCallback onGlobalRequestCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onGlobalRequestCallback
OnGlobalRequestCallback onGlobalRequestCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onLogCallback
OnLogCallback onLogCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onLogCallback
OnLogCallback onLogCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
openRequestX11Callback
OpenRequestX11Callback openRequestX11Callback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
openRequestX11Callback
OpenRequestX11Callback openRequestX11Callback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
openSSHVersion
int openSSHVersion [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
pollFlags
PollFlags pollFlags [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
port
string port [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
port
ushort port [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
port
ushort port [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
proxyCommand
string proxyCommand [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
proxyCommand
string proxyCommand [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
publicKey
SSHKey publicKey [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverAuthGSSAPIMicCallback
ServerAuthGSSAPIMicCallback serverAuthGSSAPIMicCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverAuthGSSAPIMicCallback
ServerAuthGSSAPIMicCallback serverAuthGSSAPIMicCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverAuthNoneCallback
ServerAuthNoneCallback serverAuthNoneCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverAuthNoneCallback
ServerAuthNoneCallback serverAuthNoneCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverAuthPasswordCallback
ServerAuthPasswordCallback serverAuthPasswordCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverAuthPasswordCallback
ServerAuthPasswordCallback serverAuthPasswordCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverAuthPublicKeyCallback
ServerAuthPublicKeyCallback serverAuthPublicKeyCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverAuthPublicKeyCallback
ServerAuthPublicKeyCallback serverAuthPublicKeyCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverBanner
string serverBanner [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverChannelOpenRequestCallback
ServerChannelOpenRequestCallback serverChannelOpenRequestCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverChannelOpenRequestCallback
ServerChannelOpenRequestCallback serverChannelOpenRequestCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverGSSAPIAcceptSecCtxCallback
ServerGSSAPIAcceptSecCtxCallback serverGSSAPIAcceptSecCtxCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverGSSAPIAcceptSecCtxCallback
ServerGSSAPIAcceptSecCtxCallback serverGSSAPIAcceptSecCtxCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverGSSAPISelectOidCallback
ServerGSSAPISelectOidCallback serverGSSAPISelectOidCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverGSSAPIVerifyMicCallback
ServerGSSAPISelectOidCallback serverGSSAPIVerifyMicCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverKnownState
ServerKnownState serverKnownState [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverServiceRequestCallback
ServerServiceRequestCallback serverServiceRequestCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
serverServiceRequestCallback
ServerServiceRequestCallback serverServiceRequestCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
sshDir
string sshDir [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
sshProtocolVersion
SSHProtocolVersion sshProtocolVersion [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
status
SessionStatusFlags status [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
strictHostkeyCheck
bool strictHostkeyCheck [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
timeout
long timeout [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
timeoutUSec
long timeoutUSec [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
user
string user [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
user
string user [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.

Variables

_session
ssh_session _session;
Undocumented in source.

Inherited Members

From Disposable

dispose
void dispose()
Undocumented in source.

Meta