SFTP List

Updated from peer review comments.

Author: ejohnstown

examples/echoserver/echoserver.c

@@ -2031,6 +2031,16 @@ static int wsUserAuth(byte authType,
 
 
 #ifdef WOLFSSH_SFTP
+/*
+ * Sets the WOLFSSH object's default SFTP path to the value provided by
+ * defaultSftpPath, or uses the current working directory from where the
+ * echoserver is run. The new default path is cleaned up with the real
+ * path function.
+ *
+ * @param ssh             WOLFSSH object to update
+ * @param defaultSftpPath command line provided default SFTP path
+ * @return                0 for success or error code
+ */
 static int SetDefaultSftpPath(WOLFSSH* ssh, const char* defaultSftpPath)
 {
     char path[WOLFSSH_MAX_FILENAME];
@@ -2039,26 +2049,31 @@ static int SetDefaultSftpPath(WOLFSSH* ssh, const char* defaultSftpPath)
 
     if (defaultSftpPath == NULL) {
     #ifdef USE_WINDOWS_API
-        if (GetCurrentDirectoryA(sizeof(path), path) == 0) {
-            ret = -1;
+        if (GetCurrentDirectoryA(sizeof(path)-1, path) == 0) {
+            ret = WS_INVALID_PATH_E;
         }
     #else
-        if (getcwd(path, sizeof(path)) == NULL) {
-            ret = -1;
+        if (getcwd(path, sizeof(path)-1) == NULL) {
+            ret = WS_INVALID_PATH_E;
         }
     #endif
     }
     else {
-        WSTRNCPY(path, defaultSftpPath, sizeof(path));
-        path[sizeof(path) - 1] = 0;
+        if (WSTRLEN(defaultSftpPath) >= sizeof(path)) {
+            ret = WS_INVALID_PATH_E;
+        }
+        else {
+            WSTRNCPY(path, defaultSftpPath, sizeof(path));
+        }
     }
 
     if (ret == 0) {
         path[sizeof(path) - 1] = 0;
-        wolfSSH_RealPath(NULL, path, realPath, sizeof(realPath));
-        if (wolfSSH_SFTP_SetDefaultPath(ssh, realPath) != WS_SUCCESS) {
-            ret = -1;
-        }
+        ret = wolfSSH_RealPath(NULL, path, realPath, sizeof(realPath));
+    }
+
+    if (ret == WS_SUCCESS) {
+        ret = wolfSSH_SFTP_SetDefaultPath(ssh, realPath);
     }
 
     return ret;

src/port.c

@@ -166,6 +166,16 @@ int wfopen(WFILE** f, const char* filename, const char* mode)
 
 #if defined(USE_WINDOWS_API) && (defined(WOLFSSH_SFTP) || defined(WOLFSSH_SCP))
 
+/*
+ * SFTP paths all start with a leading root "/". Most Windows file routines
+ * expect a drive letter when dealing with an absolute path. If the provided
+ * path, f, is of the form "/C:...", adjust the pointer f to point to the "C",
+ * and decrement the file path size, fSz, by one.
+ *
+ * @param f    pointer to a file name
+ * @param fSz  size of f in bytes
+ * @return     pointer to somewhere in f
+ */
 static const char* TrimFileName(const char* f, size_t* fSz)
 {
     if (f != NULL && fSz != NULL && *fSz >= 3 && f[0] == '/' && f[2] == ':') {

src/wolfsftp.c

@@ -1553,16 +1553,28 @@ int wolfSSH_SFTP_CreateStatus(WOLFSSH* ssh, word32 status, word32 reqId,
 }
 
 
-static int GetAndCleanPath(const char* dP, const byte* data, word32 sz,
-        char* s, word32 sSz)
+/*
+ * This is a wrapper around the function wolfSSH_RealPath. Since it modifies
+ * the source path value, copy the path from the data stream into a local
+ * array and use that as the source.
+ *
+ * @param defaultPath pointer to the defaultPath
+ * @param data        input data stream at the location of the path name
+ * @param sz          size of the path name in bytes
+ * @param s           destination buffer for the Real Path
+ * @param sSz         size of s in bytes
+ * @return            0 for success or negative error code
+ */
+static int GetAndCleanPath(const char* defaultPath,
+        const byte* data, word32 sz, char* s, word32 sSz)
 {
     char r[WOLFSSH_MAX_FILENAME];
 
     if (sz > sizeof r) sz = sizeof r;
     WMEMCPY(r, data, sz);
     r[sz] = '\0';
 
-    return wolfSSH_RealPath(dP, r, s, sSz);
+    return wolfSSH_RealPath(defaultPath, r, s, sSz);
 }
 
 
@@ -1673,7 +1685,7 @@ int wolfSSH_SFTP_RecvMKDIR(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
     ret = GetAndCleanPath(ssh->sftpDefaultPath,
             data + idx, sz, dir, sizeof(dir));
     if (ret != WS_SUCCESS) {
-        return WS_BUFFER_E;
+        return ret;
     }
 
     idx += sz;

tests/api.c

@@ -1077,12 +1077,12 @@ static void DoRealPathTestCase(const char* path, struct RealPathTestCase* tc)
     err = wolfSSH_RealPath(path, testPath,
             checkPath, sizeof checkPath);
     if (err || WSTRCMP(tc->exp, checkPath) != 0) {
-        printf("RealPath failure (%d)\n"
-               "    defaultPath: %s\n"
-               "          input: %s\n"
-               "       expected: %s\n"
-               "         output: %s\n", err,
-               path, tc->in, tc->exp, checkPath);
+        fprintf(stderr, "RealPath failure (%d)\n"
+                        "    defaultPath: %s\n"
+                        "          input: %s\n"
+                        "       expected: %s\n"
+                        "         output: %s\n", err,
+                        path, tc->in, tc->exp, checkPath);
     }
 }