Xbase++

Set a TTY Mode for an SSH PTY Request

Demonstrates the Chilkat Ssh.SetTtyMode method, which adds or updates one TTY mode to be included in a later SendReqPty request. The first argument is the mode name and the second is its integer value. Call it once per mode, before requesting the PTY.

Background: TTY modes are the terminal settings a PTY is created with — the same knobs stty exposes. The classic use is SetTtyMode("ECHO", 0), which stops the terminal from echoing input; that is how a password prompt keeps typed characters off the screen. Modes accumulate on the object and are sent with the next PTY request.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oSsh
LOCAL nSshPort
LOCAL cPassword
LOCAL nChannelNum

nSuccess := 0

//  Demonstrates the Ssh.SetTtyMode method, which adds or updates one TTY mode to be included in
//  a later SendReqPty request.  The 1st argument is the mode name and the 2nd is its integer
//  value.  Call it once per mode, before SendReqPty.

oSsh := CreateObject("Chilkat.Ssh")

nSshPort := 22
nSuccess := oSsh:Connect("ssh.example.com", nSshPort)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

//  Normally you would not hard-code the password in source.  You should instead obtain it
//  from an interactive prompt, environment variable, or a secrets vault.
cPassword := "mySshPassword"

nSuccess := oSsh:AuthenticatePw("mySshLogin", cPassword)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

//  Open a session channel.  A negative return value indicates failure.
nChannelNum := oSsh:OpenSessionChannel()
IF (nChannelNum < 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

//  Request that the allocated terminal not echo input.
nSuccess := oSsh:SetTtyMode("ECHO", 0)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

//  The modes set above are included in the PTY request.
nSuccess := oSsh:SendReqPty(nChannelNum, "xterm", 80, 24, 0, 0)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

nSuccess := oSsh:SendReqShell(nChannelNum)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

oSsh:Disconnect()

oSsh:destroy()