Communicating with an SSH server

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Communication

SSH functions

Prefix syntax

Communicating with an SSH server

Principle

How to?

See also

Communicating with an SSH server

Principle

Secure Shell (SSH) is a secure communication protocol. The exchanged data is secured via encryption keys.

A server can support the secure SSH protocol to receive remote commands.

WINDEV and WEBDEV propose several functions allowing you to connect, start a session, transmit commands to run and retrieve the result of these commands.

The protocol is SSH-2.

Two methods can be used to communicate with an SSH server:

Send the Shell commands directly,
Communicating with an SSH server.

How to?

Direct sending of commands

The direct sending of commands is performed by SSHCommand. The parameters for connecting to the SSH server must be described in an sshSession variable.

Example:

cMySession is sshSession
buffOutput is Buffer
cMySession.Address = "127.0.0.1"
cMySession.Port = 22
cMySession.User = "login"
cMySession.UserPassword = "pass"
nExitCode is int
sOutput is ANSI string
sOutputErr is ANSI string
(nExitCode, sOutput, sOutputErr) = SSHCommand(cMySession, EDT_Command)
IF ErrorOccurred THEN
Error(ErrorInfo(errFullDetails))
RETURN
END
EDT_ExitCode = nExitCode
EDT_StdOut = UTF8ToString(sOutput)
EDT_StdErr = UTF8ToString(sOutputErr)

Dialog with an SSH server

The dialog with the SSH server is performed by the following functions:


SSHConnectShell	Starts a new SSH session of "Shell" type.
SSHDisconnectShell	Closes an SSH session that was opened by SSHConnectShell.
SSHRead	Reads the data found on the output buffer of the SSH session.
SSHWrite	Writes data into the specified SSH session.

The parameters for connecting to the SSH server must be described in an sshSession variable.

Example:

cMySession is sshSession
cMySession.Address = "127.0.0.1"
cMySession.Port = 22
cMySession.User = "login"
cMySession.UserPassword = "pass"
IF SSHConnectShell(cMySession) THEN
Info("Session started")
bufOutput is Buffer = "data"
SSHWrite(cMySession, bufOutput)
SSHDisconnectShell(cMySession)
END