wolfsftp, port: apply the attributes SETSTAT and FSETSTAT acknowledge

- SFTP_SetFileAttributes() and SFTP_SetFileAttributesHandle() carry
  out the size, ownership, permission and timestamp requests while ret
  is WS_SUCCESS, bound the size with wResolveOffset() against
  WOLFSSH_MAX_FILE_OFFSET, and set WS_UNIMPLEMENTED_E where the port
  defines no wrapper.
- wolfSSH_SFTP_RecvSetSTAT() and wolfSSH_SFTP_RecvFSetSTAT() answer
  WOLFSSH_FTP_UNSUPPORTED for WS_UNIMPLEMENTED_E; wolfSSH_SFTP_CHMOD()
  sets the attribute flags to WOLFSSH_FILEATRB_PERM before sending.
- port.h adds WTRUNCATE, WFTRUNCATE, WCHOWN and WFCHOWN for the POSIX
  port, and defines WSETTIME and WFSETTIME over the existing WUTIMES
  and WFUTIMES helpers in place of their (0) definitions.
- SFTP_SetMode() guards on _WIN32_WCE in place of USE_WINDOWS_API, and
  port.c adds WS_ChmodA(), which trims the SFTP leading root and calls
  _wchmod(); it and the WCHMOD mapping to it are left out under
  _WIN32_WCE, which keeps the _chmod mapping.
- tests/regress.c adds TestSftpSetStatAttributes(); tests/sftp.c adds
  a chmod of a directory and installs SFTP_TEST_UMASK in place of the
  sftpTestUmask static; the STATE_SET_ATR_SEND case in tests/api.c
  sets atr.flags to WOLFSSH_FILEATRB_PERM.

Issue: F-11658

Author: yosuke-wolfssl

src/port.c

@@ -542,6 +542,44 @@ int WS_DeleteFileA(const char* fileName, void* heap)
 }
 
 
+
+#ifndef _WIN32_WCE
+
+int WS_ChmodA(const char* fileName, int mode, void* heap)
+{
+    int ret = -1;
+    wchar_t* unicodeFileName;
+    size_t unicodeFileNameSz = 0;
+    size_t returnSz = 0;
+    size_t fileNameSz = 0;
+    errno_t error;
+
+    fileNameSz = WSTRLEN(fileName);
+    fileName = TrimFileName(fileName, &fileNameSz);
+
+    error = mbstowcs_s(&unicodeFileNameSz, NULL, 0, fileName, 0);
+    if (error != 0)
+        return -1;
+
+    unicodeFileName = (wchar_t*)WMALLOC((unicodeFileNameSz+1)*sizeof(wchar_t),
+            heap, PORT_DYNTYPE_STRING);
+    if (unicodeFileName == NULL)
+        return -1;
+
+    error = mbstowcs_s(&returnSz, unicodeFileName, unicodeFileNameSz,
+        fileName, fileNameSz);
+
+    if (error == 0) {
+        ret = _wchmod(unicodeFileName, mode);
+    }
+
+    WFREE(unicodeFileName, heap, PORT_DYNTYPE_STRING);
+
+    return ret;
+}
+
+#endif /* !_WIN32_WCE */
+
 #endif /* USE_WINDOWS_API WOLFSSH_SFTP WOLFSSH_SCP */
 
 #if !defined(NO_FILESYSTEM) && \

src/wolfsftp.c

@@ -6046,7 +6046,7 @@ int wolfSSH_SFTP_RecvLSTAT(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
     return ret;
 }
 
-#if !defined(USE_WINDOWS_API) && !defined(WOLFSSH_ZEPHYR) \
+#if !defined(_WIN32_WCE) && !defined(WOLFSSH_ZEPHYR) \
     && !defined(WOLFSSH_SFTP_SETMODE) && !defined(WOLFSSH_FATFS)
 /* Set the files mode
  * return WS_SUCCESS on success */
@@ -6082,29 +6082,47 @@ static int SFTP_SetFileAttributes(WOLFSSH* ssh,
         char* name, WS_SFTP_FILEATRB* atr)
 {
     int ret = WS_SUCCESS;
+#ifdef WTRUNCATE
+    word64 sz;
+#endif
 
     /* check if size attribute present */
-    if (atr->flags & WOLFSSH_FILEATRB_SIZE) {
-        /* @TODO set file size */
+    if (ret == WS_SUCCESS && (atr->flags & WOLFSSH_FILEATRB_SIZE)) {
+#ifdef WTRUNCATE
+        if (wResolveOffset(atr->sz, WOLFSSH_MAX_FILE_OFFSET, &sz) != 0
+                || WTRUNCATE(ssh->fs, name, sz) != 0) {
+            ret = WS_BAD_FILE_E;
+        }
+#else
+        ret = WS_UNIMPLEMENTED_E;
+#endif
     }
 
     /* check if uid and gid attribute present */
-    if (atr->flags & WOLFSSH_FILEATRB_UIDGID) {
-        /* @TODO set group and user id */
+    if (ret == WS_SUCCESS && (atr->flags & WOLFSSH_FILEATRB_UIDGID)) {
+#ifdef WCHOWN
+        if (WCHOWN(ssh->fs, name, atr->uid, atr->gid) != 0) {
+            ret = WS_BAD_FILE_E;
+        }
+#else
+        ret = WS_UNIMPLEMENTED_E;
+#endif
     }
 
-#if !defined(USE_WINDOWS_API) && !defined(WOLFSSH_ZEPHYR)
     /* check if permissions attribute present */
-    if (atr->flags & WOLFSSH_FILEATRB_PERM) {
+    if (ret == WS_SUCCESS && (atr->flags & WOLFSSH_FILEATRB_PERM)) {
         ret = SFTP_SetMode(ssh->fs, name, WOLFSSH_SFTP_SAFE_MODE(atr->per));
     }
-#endif
 
     /* check if time attribute present */
     if (ret == WS_SUCCESS && (atr->flags & WOLFSSH_FILEATRB_TIME)) {
+#ifdef WSETTIME
         if (WSETTIME(ssh->fs, name, atr->atime, atr->mtime) != 0) {
             ret = WS_BAD_FILE_E;
         }
+#else
+        ret = WS_UNIMPLEMENTED_E;
+#endif
     }
 
     /* check if extended attributes are present */
@@ -6128,29 +6146,52 @@ static int SFTP_SetFileAttributesHandle(WOLFSSH* ssh,
         WS_SFTP_FILEATRB* atr)
 {
     int ret = WS_SUCCESS;
+#ifdef WFTRUNCATE
+    word64 sz;
+#endif
 
     /* check if size attribute present */
-    if (atr->flags & WOLFSSH_FILEATRB_SIZE) {
-        /* @TODO set file size */
+    if (ret == WS_SUCCESS && (atr->flags & WOLFSSH_FILEATRB_SIZE)) {
+#ifdef WFTRUNCATE
+        if (wResolveOffset(atr->sz, WOLFSSH_MAX_FILE_OFFSET, &sz) != 0
+                || WFTRUNCATE(ssh->fs, handle, sz) != 0) {
+            ret = WS_BAD_FILE_E;
+        }
+#else
+        ret = WS_UNIMPLEMENTED_E;
+#endif
     }
 
     /* check if uid and gid attribute present */
-    if (atr->flags & WOLFSSH_FILEATRB_UIDGID) {
-        /* @TODO set group and user id */
+    if (ret == WS_SUCCESS && (atr->flags & WOLFSSH_FILEATRB_UIDGID)) {
+#ifdef WFCHOWN
+        if (WFCHOWN(ssh->fs, handle, atr->uid, atr->gid) != 0) {
+            ret = WS_BAD_FILE_E;
+        }
+#else
+        ret = WS_UNIMPLEMENTED_E;
+#endif
     }
 
-#ifndef USE_WINDOWS_API
     /* check if permissions attribute present */
-    if (atr->flags & WOLFSSH_FILEATRB_PERM) {
-        ret = SFTP_SetModeHandle(ssh->fs, handle, WOLFSSH_SFTP_SAFE_MODE(atr->per));
-    }
+    if (ret == WS_SUCCESS && (atr->flags & WOLFSSH_FILEATRB_PERM)) {
+#ifndef USE_WINDOWS_API
+        ret = SFTP_SetModeHandle(ssh->fs, handle,
+                WOLFSSH_SFTP_SAFE_MODE(atr->per));
+#else
+        ret = WS_UNIMPLEMENTED_E;
 #endif
+    }
 
     /* check if time attribute present */
     if (ret == WS_SUCCESS && (atr->flags & WOLFSSH_FILEATRB_TIME)) {
+#ifdef WFSETTIME
         if (WFSETTIME(ssh->fs, handle, atr->atime, atr->mtime) != 0) {
             ret = WS_BAD_FILE_E;
         }
+#else
+        ret = WS_UNIMPLEMENTED_E;
+#endif
     }
 
     /* check if extended attributes are present */
@@ -6159,9 +6200,9 @@ static int SFTP_SetFileAttributesHandle(WOLFSSH* ssh,
     }
 
     (void)ssh;
-#ifdef USE_WINDOWS_API
-    /* On Windows the only consumers (SFTP_SetModeHandle / WFSETTIME) are
-     * compiled out or no-ops, so the handle goes unused here. */
+#if defined(USE_WINDOWS_API) && !defined(WFTRUNCATE) && !defined(WFCHOWN) \
+    && !defined(WFSETTIME)
+    /* no consumer of the handle is compiled in on this port */
     (void)handle;
 #endif
     return ret ;
@@ -6186,6 +6227,7 @@ int wolfSSH_SFTP_RecvSetSTAT(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
     char  ser[] = "Unable to set attributes error";
     char  per[] = "Unable to parse attributes error";
     char  pdn[] = "Permission denied";
+    char  uns[] = "Attribute not supported";
     char* res   = suc;
     byte  type  = WOLFSSH_FTP_OK;
 
@@ -6224,8 +6266,14 @@ int wolfSSH_SFTP_RecvSetSTAT(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
             != WS_SUCCESS) {
         /* tell peer that was not ok */
         WLOG(WS_LOG_SFTP, "Unable to get set attributes of file/directory");
-        type = WOLFSSH_FTP_FAILURE;
-        res  = ser;
+        if (ret == WS_UNIMPLEMENTED_E) {
+            type = WOLFSSH_FTP_UNSUPPORTED;
+            res  = uns;
+        }
+        else {
+            type = WOLFSSH_FTP_FAILURE;
+            res  = ser;
+        }
         ret  = WS_BAD_FILE_E;
     }
 
@@ -6261,6 +6309,7 @@ int wolfSSH_SFTP_RecvFSetSTAT(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
     char  suc[] = "Set Attributes";
     char  ser[] = "Unable to set attributes error";
     char  per[] = "Unable to parse attributes error";
+    char  uns[] = "Attribute not supported";
     char* res   = suc;
     byte  type  = WOLFSSH_FTP_OK;
 
@@ -6315,8 +6364,14 @@ int wolfSSH_SFTP_RecvFSetSTAT(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
             != WS_SUCCESS) {
         /* tell peer that was not ok */
         WLOG(WS_LOG_SFTP, "Unable to get set attributes of open file");
-        type = WOLFSSH_FTP_FAILURE;
-        res  = ser;
+        if (ret == WS_UNIMPLEMENTED_E) {
+            type = WOLFSSH_FTP_UNSUPPORTED;
+            res  = uns;
+        }
+        else {
+            type = WOLFSSH_FTP_FAILURE;
+            res  = ser;
+        }
         ret  = WS_BAD_FILE_E;
     }
 
@@ -7665,7 +7720,8 @@ int wolfSSH_SFTP_CHMOD(WOLFSSH* ssh, char* n, char* oct)
                 break;
             }
 
-            /* update permissions */
+            /* only the permissions change here */
+            state->atr.flags = WOLFSSH_FILEATRB_PERM;
             state->atr.per = mode;
             state->state = STATE_CHMOD_SEND;
             FALL_THROUGH;

tests/api.c

@@ -4848,6 +4848,9 @@ static void test_wolfSSH_SFTP_PartialSend(void)
         wolfSSH_SFTP_Close(ssh, handle, handleSz);
 
         if (wolfSSH_SFTP_STAT(ssh, atrName, &atr) == WS_SUCCESS) {
+            /* Send only the permissions back. A port without WTRUNCATE
+             * answers a size request with SSH_FX_OP_UNSUPPORTED. */
+            atr.flags = WOLFSSH_FILEATRB_PERM;
             AssertIntEQ(wolfSSH_TestSftpSendCap(ssh, 1), WS_SUCCESS);
             ret = WS_FATAL_ERROR;
             sawPartial = 0;