SFTP List

1. Add some more test cases to the RealPath() test.
2. Change the API for the function wolfSSH_RealPath(). It doesn't need
   the currentPath. Non-absolute paths are relative to defaultPath.
3. If defaultPath isn't present, use "/".

Author: ejohnstown

src/ssh.c

@@ -2275,51 +2275,47 @@ int wolfSSH_ChannelGetEof(WOLFSSH_CHANNEL* channel)
 #if (defined(WOLFSSH_SFTP) || defined(WOLFSSH_SCP)) && \
     !defined(NO_WOLFSSH_SERVER)
 /*
- * Paths starting with a slash are absolute, rooted at root. Any path that
- * doesn't have a starting slash is assumed to be relative to the current
+ * Paths starting with a slash are absolute, rooted at "/". Any path that
+ * doesn't have a starting slash is assumed to be relative to the default
  * path. If the path is empty, return the default path.
  *
  * The path "/." is stripped out. The path "/.." strips out the previous
  * path value. The root path, "/", is always present.
  *
  * Example: "/home/fred/frob/frizz/../../../barney/bar/baz/./././../.."
  * will return "/home/barney". "/../.." will return "/". "." will return
- * currentPath.
+ * the default path.
  *
  * Note, this function does not care about OS and filesystem issues. The
  * SFTP protocol describes how paths are handled in SFTP. Specialized
  * behaviors are handled when actually calling the OS functions. Paths
  * are further massaged there. For example, the C: drive is treated as
  * the path "/C:", and is a directory like any other.
  *
- * @param currentPath RealPath of the current working directory
  * @param defaultPath RealPath of the default directory, usually user's
  * @param in          requested new path
  * @param out         output of real path cleanup
  * @param outSz       size in bytes of buffer 'out'
  * @return            WS_SUCCESS, WS_BAD_ARGUMENT, or WS_INVALID_PATH_E
  */
-int wolfSSH_RealPath(const char* currentPath, const char* defaultPath,
-        char* in, char* out, word32 outSz)
+int wolfSSH_RealPath(const char* defaultPath, char* in,
+        char* out, word32 outSz)
 {
     char* tail = NULL;
     char* seg;
     word32 inSz, segSz, curSz;
 
-    if (currentPath == NULL || defaultPath == NULL ||
-            in == NULL || out == NULL || outSz == 0)
+    if (in == NULL || out == NULL || outSz == 0) {
         return WS_BAD_ARGUMENT;
+    }
 
     WMEMSET(out, 0, outSz);
     inSz = (word32)WSTRLEN(in);
-    if (inSz == 0) {
+    if ((inSz == 0 || in[0] != '/') && defaultPath != NULL){
         WSTRNCPY(out, defaultPath, outSz);
     }
-    else if (in[0] == '/') {
-        out[0] = '/';
-    }
     else {
-        WSTRNCPY(out, currentPath, outSz);
+        out[0] = '/';
     }
     out[outSz - 1] = 0;
     curSz = (word32)WSTRLEN(out);

tests/api.c

@@ -1021,7 +1021,7 @@ struct RealPathTestCase {
     const char* exp;
 };
 
-struct RealPathTestCase realPathTestCases[] = {
+struct RealPathTestCase realPathDefault[] = {
     { ".", "/C:/Users/fred" },
     { "", "/C:/Users/fred" },
     { "/C:/Users/fred/..", "/C:/Users" },
@@ -1042,33 +1042,57 @@ struct RealPathTestCase realPathTestCases[] = {
     { "/home/C:/ok", "/home/C:/ok" },
     { "/home/fred/frob/frizz/../../../barney/bar/baz/./././../..",
         "/home/barney" },
+    { "/home/fred/sample.", "/home/fred/sample." },
+    { "/home/fred/sample.jpg", "/home/fred/sample.jpg" },
+    { "/home/fred/sample./other", "/home/fred/sample./other" },
+    { "/home/fred/sample.dir/other", "/home/fred/sample.dir/other" },
+    { "./sample.", "/C:/Users/fred/sample." },
+    { "./sample.jpg", "/C:/Users/fred/sample.jpg" },
+    { "./sample./other", "/C:/Users/fred/sample./other" },
+    { "./sample.dir/other", "/C:/Users/fred/sample.dir/other" },
 };
-const char* defaultPath = "/C:/Users/fred";
 
-static void test_wolfSSH_RealPath(void)
+struct RealPathTestCase realPathNull[] = {
+    { ".", "/" },
+    { "", "/" },
+    { "..", "/" },
+    { "../barney", "/barney" },
+};
+
+static void DoRealPathTestCase(const char* path, struct RealPathTestCase* tc)
 {
-    struct RealPathTestCase* tc;
     char testPath[128];
     char checkPath[128];
-    word32 testCount =
-        (sizeof realPathTestCases)/(sizeof(struct RealPathTestCase));
-    word32 i;
     int err;
 
-    for (i = 0, tc = realPathTestCases; i < testCount; i++, tc++) {
-        WSTRNCPY(testPath, tc->in, sizeof(testPath) - 1);
-        testPath[sizeof(testPath) - 1] = 0;
-        WMEMSET(checkPath, 0, sizeof checkPath);
-        err = wolfSSH_RealPath(defaultPath, defaultPath, testPath,
-                checkPath, sizeof checkPath);
-        if (err || WSTRCMP(tc->exp, checkPath) != 0) {
-            printf("RealPath failure (case %u: %d)\n"
-                   "    defaultPath: %s\n"
-                   "          input: %s\n"
-                   "       expected: %s\n"
-                   "         output: %s\n", i, err,
-                   defaultPath, tc->in, tc->exp, checkPath);
-        }
+    WSTRNCPY(testPath, tc->in, sizeof(testPath) - 1);
+    testPath[sizeof(testPath) - 1] = 0;
+    WMEMSET(checkPath, 0, sizeof checkPath);
+    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);
+    }
+}
+
+static void test_wolfSSH_RealPath(void)
+{
+    word32 testCount;
+    word32 i;
+
+    testCount = (sizeof realPathDefault)/(sizeof(struct RealPathTestCase));
+    for (i = 0; i < testCount; i++) {
+        DoRealPathTestCase("/C:/Users/fred", realPathDefault + i);
+    }
+
+    testCount = (sizeof realPathNull)/(sizeof(struct RealPathTestCase));
+    for (i = 0; i < testCount; i++) {
+        DoRealPathTestCase(NULL, realPathNull + i);
     }
 }
 #else
@@ -1088,7 +1112,6 @@ int main(void)
     test_wolfSSH_SetUsername();
     test_wolfSSH_ConvertConsole();
     test_wolfSSH_CTX_UsePrivateKey_buffer();
-    test_wolfSSH_RealPath();
     test_wolfSSH_CTX_UseCert_buffer();
     test_wolfSSH_CertMan();
 
@@ -1098,6 +1121,8 @@ int main(void)
     /* SFTP tests */
     test_wolfSSH_SFTP_SendReadPacket();
 
+    /* Either SCP or SFTP */
+    test_wolfSSH_RealPath();
 
     AssertIntEQ(wolfSSH_Cleanup(), WS_SUCCESS);
 

wolfssh/ssh.h

@@ -339,8 +339,8 @@ enum WS_DisconnectReasonCodes {
 };
 
 
-WOLFSSH_API int wolfSSH_RealPath(const char* currentPath,
-        const char* defaultPath, char* in, char* out, word32 outSz);
+WOLFSSH_API int wolfSSH_RealPath(const char* defaultPath, char* in,
+        char* out, word32 outSz);
 
 
 WOLFSSH_API void wolfSSH_ShowSizes(void);