Run threaded api-test SFTP/SCP tests on Windows

Author: yosuke-wolfssl

.github/workflows/windows-check.yml

@@ -139,12 +139,13 @@ jobs:
       run: nuget restore ${{env.WOLFSSL_SOLUTION_FILE_PATH}}
 
     # These env paths already include the wolfssh/ and wolfssl/ checkout
-    # prefixes, so they must run from the workspace root (as the build job does).
-    - name: updated user_settings.h for sshd and x509
-      run: cp ${{env.USER_SETTINGS_H_NEW}} ${{env.USER_SETTINGS_H}}
-
-    - name: replace wolfSSL user_settings.h with wolfSSH user_settings.h
-      run: get-content ${{env.USER_SETTINGS_H_NEW}} | %{$_ -replace "if 0","if 1"}
+    # prefixes, so this runs from the default working directory, the workspace
+    # root.
+    - name: Enable wolfSSH options (sshd, sftp, x509) in user_settings.h
+      shell: bash
+      run: |
+        sed -i 's/#if 0/#if 1/g' ${{env.USER_SETTINGS_H_NEW}}
+        cp ${{env.USER_SETTINGS_H_NEW}} ${{env.USER_SETTINGS_H}}
 
     # WholeProgramOptimization=false disables /GL so the v142-independent objects
     # link without a cross-version code-generation requirement (C1047).

examples/echoserver/echoserver.c

@@ -2249,6 +2249,11 @@ static int LoadPasswdList(StrList* strList, PwMapList* mapList)
     int count = 0;
 
     while (strList) {
+        if (WSTRLEN(strList->str) >= sizeof names - 1) {
+            fprintf(stderr, "Ignoring over-long entry: %.32s\n", strList->str);
+            strList = strList->next;
+            continue;
+        }
         WSTRNCPY(names, strList->str, sizeof names - 1);
         passwd = WSTRCHR(names, ':');
         if (passwd != NULL) {
@@ -2278,6 +2283,11 @@ static int LoadKeyboardList(StrList* strList, PwMapList* mapList,
     int count = 0;
 
     while (strList) {
+        if (WSTRLEN(strList->str) >= sizeof names - 1) {
+            fprintf(stderr, "Ignoring over-long entry: %.32s\n", strList->str);
+            strList = strList->next;
+            continue;
+        }
         WSTRNCPY(names, strList->str, sizeof names - 1);
         passwd = WSTRCHR(names, ':');
         if (passwd != NULL) {
@@ -2314,6 +2324,11 @@ static int LoadPubKeyList(StrList* strList, int format, PwMapList* mapList)
         buf = NULL;
         bufSz = 0;
 
+        if (WSTRLEN(strList->str) >= sizeof names - 1) {
+            fprintf(stderr, "Ignoring over-long entry: %.32s\n", strList->str);
+            strList = strList->next;
+            continue;
+        }
         WSTRNCPY(names, strList->str, sizeof names - 1);
         fileName = WSTRCHR(names, ':');
         if (fileName != NULL) {
@@ -2834,6 +2849,12 @@ static INLINE void SignalTcpReady(tcp_ready* ready, word16 port)
     ready->port = port;
     pthread_cond_signal(&ready->cond);
     pthread_mutex_unlock(&ready->mutex);
+#elif defined(USE_WINDOWS_API) && defined(NO_MAIN_DRIVER) && \
+    !defined(SINGLE_THREADED)
+    ready->ready = 1;
+    ready->port = port;
+    /* SetEvent is a full barrier; this one-shot signal needs no lock */
+    SetEvent(ready->readyEvent);
 #else
     WOLFSSH_UNUSED(ready);
     WOLFSSH_UNUSED(port);
@@ -2979,7 +3000,7 @@ THREAD_RETURN WOLFSSH_THREAD echoserver_test(void* args)
                     }
                     else {
                         port = (word16)atoi(myoptarg);
-                        #if !defined(NO_MAIN_DRIVER) || defined(USE_WINDOWS_API)
+                        #if !defined(NO_MAIN_DRIVER)
                             if (port == 0) {
                                 ES_ERROR("port number cannot be 0");
                             }

examples/sftpclient/sftpclient.c

@@ -156,6 +156,7 @@ static void myStatusCb(WOLFSSH* sshIn, word32* bytes, char* name)
     static word32 lastOutputTime = 0;
     static word32 lastPrintedBytes[2] = {0, 0};
     word32 elapsedTime;
+    word32 nameSz;
 #endif
     char buf[80];
     word64 longBytes = ((word64)bytes[1] << 32) | bytes[0];
@@ -181,8 +182,13 @@ static void myStatusCb(WOLFSSH* sshIn, word32* bytes, char* name)
         lastOutputTime = 0; /* Reset timer for new file transfer */
         lastPrintedBytes[0] = 0;
         lastPrintedBytes[1] = 0;
-        WMEMSET(currentFile, 0, WOLFSSH_MAX_FILENAME);
-        WSTRNCPY(currentFile, name, WOLFSSH_MAX_FILENAME);
+        WMEMSET(currentFile, 0, sizeof(currentFile));
+        nameSz = (word32)WSTRLEN(name);
+        /* clamp over-long names: returning would leave currentFile empty
+         * and suppress progress output for the rest of the transfer */
+        if (nameSz >= sizeof(currentFile))
+            nameSz = (word32)sizeof(currentFile) - 1;
+        WMEMCPY(currentFile, name, nameSz);
     }
     elapsedTime = currentTime - startTime;
     WSNPRINTF(buf, sizeof(buf), "Processed %8llu\t bytes in %d seconds\r",
@@ -191,7 +197,7 @@ static void myStatusCb(WOLFSSH* sshIn, word32* bytes, char* name)
     if (elapsedTime > TIMEOUT_VALUE) {
         WSNPRINTF(buf, sizeof(buf), "\nProcess timed out at %d seconds, "
                 "stopping\r", elapsedTime);
-        WMEMSET(currentFile, 0, WOLFSSH_MAX_FILENAME);
+        WMEMSET(currentFile, 0, sizeof(currentFile));
         wolfSSH_SFTP_Interrupt(ssh);
     }
 #endif
@@ -667,7 +673,7 @@ static int doCmds(func_args* args)
                     ret == WS_CHAN_RXD || ret == WS_REKEYING);
 
 #ifndef WOLFSSH_NO_TIMESTAMP
-            WMEMSET(currentFile, 0, WOLFSSH_MAX_FILENAME);
+            WMEMSET(currentFile, 0, sizeof(currentFile));
 #endif
 
             if (ret != WS_SUCCESS) {
@@ -778,7 +784,7 @@ static int doCmds(func_args* args)
                     ret == WS_CHAN_RXD || ret == WS_REKEYING);
 
 #ifndef WOLFSSH_NO_TIMESTAMP
-            WMEMSET(currentFile, 0, WOLFSSH_MAX_FILENAME);
+            WMEMSET(currentFile, 0, sizeof(currentFile));
 #endif
 
             if (ret != WS_SUCCESS) {
@@ -1445,6 +1451,7 @@ static int doAutopilot(int cmd, char* local, char* remote)
     int ret = WS_SUCCESS;
     char fullpath[128] = ".";
     WS_SFTPNAME* name  = NULL;
+    word32 remoteSz;
     byte remoteAbsPath = 0;
 
     /* check if is absolute path before making it one */
@@ -1462,8 +1469,11 @@ static int doAutopilot(int cmd, char* local, char* remote)
 
     if (remoteAbsPath) {
        /* use remote absolute path if provided */
+       remoteSz = (word32)WSTRLEN(remote);
+       if (remoteSz >= sizeof(fullpath))
+           return WS_BUFFER_E;
        WMEMSET(fullpath, 0, sizeof(fullpath));
-       WSTRNCPY(fullpath, remote, sizeof(fullpath) - 1);
+       WMEMCPY(fullpath, remote, remoteSz + 1);
     }
     else {
         err = doBuildRemotePath(remote, fullpath, sizeof(fullpath), &name);

src/wolfscp.c

@@ -1952,20 +1952,27 @@ int wolfSSH_SCP_connect(WOLFSSH* ssh, byte* cmd)
 }
 
 
+/* Shared format so the size probe and the write cannot drift. */
+#define SCP_CMD_FMT "scp -%c %s"
+
 static char* MakeScpCmd(const char* name, char dir, void* heap)
 {
     char* cmd;
     int sz;
 
-    sz = WSNPRINTF(NULL, 0, "scp -%c %s", dir, name) + 1;
+#ifdef USE_WINDOWS_API
+    sz = WSCPRINTF(SCP_CMD_FMT, dir, name) + 1;
+#else
+    sz = WSNPRINTF(NULL, 0, SCP_CMD_FMT, dir, name) + 1;
+#endif
     if (sz <= 0) {
         return NULL;
     }
     cmd = (char*)WMALLOC(sz, heap, DYNTYPE_STRING);
     if (cmd == NULL) {
         return NULL;
     }
-    sz = WSNPRINTF(cmd, sz, "scp -%c %s", dir, name);
+    sz = WSNPRINTF(cmd, sz, SCP_CMD_FMT, dir, name);
     if (sz <= 0) {
         WFREE(cmd, heap, DYNTYPE_STRING);
         return NULL;
@@ -2712,10 +2719,15 @@ static ScpDir* ScpNewDir(void *fs, const char* path, void* heap)
 int ScpPushDir(void *fs, ScpSendCtx* ctx, const char* path, void* heap)
 {
     ScpDir* entry;
+    word32  pathSz;
 
     if (ctx == NULL || path == NULL)
         return WS_BAD_ARGUMENT;
 
+    pathSz = (word32)WSTRLEN(path);
+    if (pathSz >= sizeof(ctx->dirName))
+        return WS_BUFFER_E;
+
     entry = ScpNewDir(fs, path, heap);
     if (entry == NULL) {
         return WS_FATAL_ERROR;
@@ -2729,9 +2741,9 @@ int ScpPushDir(void *fs, ScpSendCtx* ctx, const char* path, void* heap)
         ctx->currentDir = entry;
     }
 
-    /* append directory name to ctx->dirName */
-    WSTRNCPY(ctx->dirName, path, DEFAULT_SCP_FILE_NAME_SZ-1);
-    ctx->dirName[DEFAULT_SCP_FILE_NAME_SZ-1] = '\0';
+    /* append directory name to ctx->dirName, terminator included; the guard
+     * above bounds pathSz so the copy always fits */
+    WMEMCPY(ctx->dirName, path, pathSz + 1);
 
     return WS_SUCCESS;
 }