refactor pty flag to Channel level and treat result as boolean in wolfsshd checks

Author: JacobBarthelmeh

apps/wolfsshd/wolfsshd.c

@@ -1204,7 +1204,12 @@ static int SHELL_Subsystem(WOLFSSHD_CONNECTION* conn, WOLFSSH* ssh,
     stdinPipe[1] = -1;
 
     forcedCmd = wolfSSHD_ConfigGetForcedCmd(usrConf);
-    ptyReq = wolfSSH_ReceivedPtyReq(ssh);
+
+    ptyReq = wolfSSH_ChannelIsPty(ssh, NULL);
+    if (ptyReq < 0) {
+        wolfSSH_Log(WS_LOG_ERROR, "[SSHD] Failure get channel PTY state");
+        return WS_FATAL_ERROR;
+    }
 
     /* do not overwrite a forced command with 'exec' sub shell. Only set the
      * 'exec' command when no forced command is set */
@@ -1227,7 +1232,7 @@ static int SHELL_Subsystem(WOLFSSHD_CONNECTION* conn, WOLFSSH* ssh,
 
 
     /* create pipes for stdout and stderr */
-    if (ptyReq == 0 || forcedCmd) {
+    if (!ptyReq || forcedCmd) {
         if (pipe(stdoutPipe) != 0) {
             wolfSSH_Log(WS_LOG_ERROR, "[SSHD] Issue creating stdout pipe");
             return WS_FATAL_ERROR;
@@ -1266,7 +1271,7 @@ static int SHELL_Subsystem(WOLFSSHD_CONNECTION* conn, WOLFSSH* ssh,
         signal(SIGINT,  SIG_DFL);
         signal(SIGCHLD, SIG_DFL);
 
-        if (ptyReq == 0 || forcedCmd) {
+        if (!ptyReq || forcedCmd) {
             close(stdoutPipe[0]);
             close(stderrPipe[0]);
             close(stdinPipe[1]);
@@ -1393,7 +1398,7 @@ static int SHELL_Subsystem(WOLFSSHD_CONNECTION* conn, WOLFSSH* ssh,
             close(stderrPipe[1]);
             close(stdinPipe[1]);
         }
-        else if (ptyReq == 0) {
+        else if (!ptyReq) {
             ret = execv(cmd, (char**)args);
             close(stdoutPipe[1]);
             close(stderrPipe[1]);
@@ -1452,7 +1457,7 @@ static int SHELL_Subsystem(WOLFSSHD_CONNECTION* conn, WOLFSSH* ssh,
 #endif
 
     wolfSSH_SetTerminalResizeCtx(ssh, (void*)&childFd);
-    if (ptyReq == 0 || forcedCmd) {
+    if (!ptyReq || forcedCmd) {
         close(stdoutPipe[1]);
         close(stderrPipe[1]);
         close(stdinPipe[0]);
@@ -1478,7 +1483,7 @@ static int SHELL_Subsystem(WOLFSSHD_CONNECTION* conn, WOLFSSH* ssh,
 
         if (wolfSSH_stream_peek(ssh, tmp, 1) <= 0) {
             /* select on stdout/stderr pipes with forced commands */
-            if (ptyReq == 0 || forcedCmd) {
+            if (!ptyReq || forcedCmd) {
                 FD_SET(stdoutPipe[0], &readFds);
                 if (stdoutPipe[0] > maxFd)
                     maxFd = stdoutPipe[0];
@@ -1524,7 +1529,7 @@ static int SHELL_Subsystem(WOLFSSHD_CONNECTION* conn, WOLFSSH* ssh,
                             if (cnt_r <= 0)
                                 break;
 
-                            if (ptyReq == 0 || forcedCmd) {
+                            if (!ptyReq || forcedCmd) {
                                 cnt_w = (int)write(stdinPipe[1], channelBuffer,
                                     cnt_r);
                             }
@@ -1564,7 +1569,7 @@ static int SHELL_Subsystem(WOLFSSHD_CONNECTION* conn, WOLFSSH* ssh,
                 current = wolfSSH_ChannelFind(ssh, lastChannel,
                     WS_CHANNEL_ID_SELF);
                 eof = wolfSSH_ChannelGetEof(current);
-                if (eof && (ptyReq == 0 || forcedCmd)) {
+                if (eof && (!ptyReq || forcedCmd)) {
                     /* SSH is done, close stdin pipe to child process */
                     close(stdinPipe[1]);
                     stdinPipe[1] = -1;
@@ -1594,7 +1599,7 @@ static int SHELL_Subsystem(WOLFSSHD_CONNECTION* conn, WOLFSSH* ssh,
             }
         }
 
-        if (ptyReq == 0 || forcedCmd) {
+        if (!ptyReq || forcedCmd) {
             if (FD_ISSET(stderrPipe[0], &readFds)) {
                 cnt_r = (int)read(stderrPipe[0], shellBuffer,
                     sizeof shellBuffer);
@@ -1734,7 +1739,7 @@ static int SHELL_Subsystem(WOLFSSHD_CONNECTION* conn, WOLFSSH* ssh,
     }
 
     /* check for any left over data in pipes then close them */
-    if (ptyReq == 0 || forcedCmd) {
+    if (!ptyReq || forcedCmd) {
         int readSz;
 
         fcntl(stdoutPipe[0], F_SETFL, fcntl(stdoutPipe[0], F_GETFL)

src/internal.c

@@ -8951,7 +8951,7 @@ static int DoChannelRequest(WOLFSSH* ssh,
             word32 termSz, modesSz = 0;
             word32 widthChar, heightRows, widthPixels, heightPixels;
 
-            ssh->ptyReq = 1; /* recieved a pty request */
+            channel->ptyReq = 1; /* recieved a pty request */
             termSz = (word32)sizeof(term);
             ret = GetString(term, &termSz, buf, len, &begin);
             if (ret == WS_SUCCESS)

src/ssh.c

@@ -2539,25 +2539,6 @@ WS_SessionType wolfSSH_GetSessionType(const WOLFSSH* ssh)
 }
 
 
-#if defined(WOLFSSH_TERM)
-int wolfSSH_ReceivedPtyReq(const WOLFSSH* ssh)
-{
-    WLOG(WS_LOG_DEBUG, "Entering wolfSSH_ReceivedPtyReq");
-
-    if (ssh == NULL) {
-        return WS_BAD_ARGUMENT;
-    }
-
-    if (ssh->ptyReq) {
-        return 1;
-    }
-    else {
-        return 0;
-    }
-}
-#endif
-
-
 const char* wolfSSH_GetSessionCommand(const WOLFSSH* ssh)
 {
     WLOG(WS_LOG_DEBUG, "Entering wolfSSH_GetSessionCommand()");
@@ -3252,6 +3233,33 @@ WS_SessionType wolfSSH_ChannelGetSessionType(const WOLFSSH_CHANNEL* channel)
 }
 
 
+#if defined(WOLFSSH_TERM)
+/* returns 1 if a PTY was requested, 0 if not, and negative on failure */
+int wolfSSH_ChannelIsPty(WOLFSSH* ssh, WOLFSSH_CHANNEL* channel)
+{
+    WOLFSSH_CHANNEL* channelPtr;
+    int ret = WS_SUCCESS;
+
+    channelPtr = channel;
+
+    /* if channel is NULL than use the last rxtx channel */
+    if (channelPtr == NULL) {
+        word32 channelId = 0;
+
+        ret = wolfSSH_GetLastRxId(ssh, &channelId);
+        if (ret == WS_SUCCESS) {
+            channelPtr = ChannelFind(ssh, channelId, WS_CHANNEL_ID_SELF);
+        }
+    }
+
+    if (ret == WS_SUCCESS) {
+        ret = channelPtr->ptyReq;
+    }
+    return ret;
+}
+#endif
+
+
 const char* wolfSSH_ChannelGetSessionCommand(const WOLFSSH_CHANNEL* channel)
 {
     const char* cmd = NULL;

wolfssh/internal.h

@@ -913,7 +913,6 @@ struct WOLFSSH {
     word32 heightPixels; /* pixel height */
     byte* modes;
     word32 modesSz;
-    byte ptyReq:1;       /* flag for if interactive pty request was received */
 #endif
 #if defined(WOLFSSH_TERM) || defined(WOLFSSH_SHELL)
     word32 exitStatus;
@@ -934,6 +933,7 @@ struct WOLFSSH_CHANNEL {
     byte eofRxd : 1;
     byte eofTxd : 1;
     byte openConfirmed : 1;
+    byte ptyReq : 1; /* flag for if interactive pty request was received */
     word32 channel;
     word32 windowSz;
     word32 maxPacketSz;

wolfssh/ssh.h

@@ -233,7 +233,7 @@ WOLFSSH_API WS_SessionType wolfSSH_ChannelGetSessionType(
         const WOLFSSH_CHANNEL* channel);
 WOLFSSH_API const char* wolfSSH_ChannelGetSessionCommand(
         const WOLFSSH_CHANNEL* channel);
-WOLFSSH_API int wolfSSH_ReceivedPtyReq(const WOLFSSH* ssh);
+WOLFSSH_API int wolfSSH_ChannelIsPty(WOLFSSH* ssh, WOLFSSH_CHANNEL* channel);
 
 /* Channel callbacks */
 typedef int (*WS_CallbackChannelOpen)(WOLFSSH_CHANNEL* channel, void* ctx);