Skip to content

Fix the resources management #905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yosuke-wolfssl wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix the resources management #905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2276d94
Move out buffer allocation and Add cleanup phase for resource manage…
yosuke-wolfssl Apr 2, 2026
494b1da
Add test for non-existing file
yosuke-wolfssl Apr 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions scripts/sftp.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,32 @@ if [ $nonblockingOnly = 0 ]; then
fi
fi

# Test SFTP status failure for non-existing file
if [ $nonblockingOnly = 0 ]; then
echo "Test SFTP status failure for non-existing file"
./examples/echoserver/echoserver -N -1 -R $ready_file &
server_pid=$!
create_port
./examples/sftpclient/wolfsftp -N -u jill -P upthehill -p $port -G -r $PWD/this_file_does_not_exist_12345.txt -l $PWD/test_output.txt > sftp_status_failure.log 2>&1
RESULT=$?
grep "Unable to copy remote file" sftp_status_failure.log > /dev/null
RESULT_MSG=$?
remove_ready_file
rm -f sftp_status_failure.log
rm -f $PWD/test_output.txt
if [ $RESULT -eq 0 ]; then
echo -e "\n\nERROR: Should have failed for non-existing file"
do_cleanup
exit 1
fi
if [ $RESULT_MSG -ne 0 ]; then
echo -e "\n\nERROR: Unexpected failure path while testing missing remote file"
do_cleanup
exit 1
fi
echo "Successfully received failure status packet"
fi

echo -e "\nALL Tests Passed"

exit 0
Expand Down
135 changes: 91 additions & 44 deletions src/wolfsftp.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2026,6 +2026,8 @@ int wolfSSH_SFTP_RecvOpen(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
word32 idx = 0;
int m = 0;
int ret = WS_SUCCESS;
int fdOpened = 0;
int outOwnedBySsh = 0;

word32 outSz = sizeof(WFD) + UINT32_SZ + WOLFSSH_SFTP_HEADER;
byte* out = NULL;
Expand All @@ -2034,6 +2036,9 @@ int wolfSSH_SFTP_RecvOpen(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
char ier[] = "Internal Failure";
char oer[] = "Open File Error";
char naf[] = "Not A File";
#ifdef WOLFSSH_STOREHANDLE
int handleStored = 0;
#endif

if (ssh == NULL) {
return WS_BAD_ARGUMENT;
Expand Down Expand Up @@ -2065,7 +2070,8 @@ int wolfSSH_SFTP_RecvOpen(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
if (GetAndCleanPath(ssh->sftpDefaultPath,
data + idx, sz, dir, sizeof(dir)) != WS_SUCCESS) {
WLOG(WS_LOG_SFTP, "Creating path for file to open failed");
return WS_FATAL_ERROR;
ret = WS_FATAL_ERROR;
goto cleanup;
}
idx += sz;

Expand Down Expand Up @@ -2118,7 +2124,8 @@ int wolfSSH_SFTP_RecvOpen(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
res = naf;
if (wolfSSH_SFTP_CreateStatus(ssh, WOLFSSH_FTP_FAILURE, reqId,
res, "English", NULL, &outSz) != WS_SIZE_ONLY) {
return WS_FATAL_ERROR;
ret = WS_FATAL_ERROR;
goto cleanup;
}
ret = WS_FATAL_ERROR;
}
Expand Down Expand Up @@ -2146,10 +2153,14 @@ int wolfSSH_SFTP_RecvOpen(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
res = oer;
if (wolfSSH_SFTP_CreateStatus(ssh, WOLFSSH_FTP_FAILURE, reqId, res,
"English", NULL, &outSz) != WS_SIZE_ONLY) {
return WS_FATAL_ERROR;
ret = WS_FATAL_ERROR;
goto cleanup;
}
ret = WS_BAD_FILE_E;
}
else {
fdOpened = 1;
}
}

#ifdef WOLFSSH_STOREHANDLE
Expand All @@ -2160,58 +2171,59 @@ int wolfSSH_SFTP_RecvOpen(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
res = ier;
if (wolfSSH_SFTP_CreateStatus(ssh, WOLFSSH_FTP_FAILURE, reqId, res,
"English", NULL, &outSz) != WS_SIZE_ONLY) {
#ifdef MICROCHIP_MPLAB_HARMONY
WFCLOSE(ssh->fs, &fd);
#else
WCLOSE(ssh->fs, fd);
#endif
return WS_FATAL_ERROR;
ret = WS_FATAL_ERROR;
goto cleanup;
}
ret = WS_FATAL_ERROR;
}
else {
handleStored = 1;
}
}
#endif

if (ret == WS_SUCCESS) {
/* create packet */
out = (byte*)WMALLOC(outSz, ssh->ctx->heap, DYNTYPE_BUFFER);
if (out == NULL) {
#ifdef MICROCHIP_MPLAB_HARMONY
WFCLOSE(ssh->fs, &fd);
#else
WCLOSE(ssh->fs, fd);
#endif
return WS_MEMORY_E;
}
/* create packet */
out = (byte*)WMALLOC(outSz, ssh->ctx->heap, DYNTYPE_BUFFER);
if (out == NULL) {
ret = WS_MEMORY_E;
goto cleanup;
}

if (ret == WS_SUCCESS) {
if (SFTP_CreatePacket(ssh, WOLFSSH_FTP_HANDLE, out, outSz,
(byte*)&fd, sizeof(WFD)) != WS_SUCCESS) {
#ifdef MICROCHIP_MPLAB_HARMONY
WFCLOSE(ssh->fs, &fd);
#else
WCLOSE(ssh->fs, fd);
#endif
return WS_FATAL_ERROR;
ret = WS_FATAL_ERROR;
goto cleanup;
}
}
else {
if (wolfSSH_SFTP_CreateStatus(ssh, WOLFSSH_FTP_FAILURE, reqId, res,
"English", out, &outSz) != WS_SUCCESS) {
WFREE(out, ssh->ctx->heap, DYNTYPE_BUFFER);
if (fd >= 0) {
#ifdef MICROCHIP_MPLAB_HARMONY
WFCLOSE(ssh->fs, &fd);
#else
WCLOSE(ssh->fs, fd);
#endif
}
return WS_FATAL_ERROR;
ret = WS_FATAL_ERROR;
goto cleanup;
}
}

/* set send out buffer, "out" is taken by ssh */
wolfSSH_SFTP_RecvSetSend(ssh, out, outSz);
outOwnedBySsh = 1;

cleanup:
#ifdef WOLFSSH_STOREHANDLE
if (ret != WS_SUCCESS && handleStored) {
(void)SFTP_RemoveHandleNode(ssh, (byte*)&fd, sizeof(WFD));
}
#endif
if (!outOwnedBySsh && out != NULL) {
WFREE(out, ssh->ctx->heap, DYNTYPE_BUFFER);
}
if (ret != WS_SUCCESS && fdOpened) {
#ifdef MICROCHIP_MPLAB_HARMONY
WFCLOSE(ssh->fs, &fd);
#else
WCLOSE(ssh->fs, fd);
#endif
}

WOLFSSH_UNUSED(ier);
return ret;
Expand All @@ -2228,13 +2240,20 @@ int wolfSSH_SFTP_RecvOpen(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
DWORD creationDisp = 0;
DWORD flagsAndAttrs = 0;
int ret = WS_SUCCESS;
int fileHandleOpened = 0;
int outOwnedBySsh = 0;

word32 outSz = sizeof(HANDLE) + UINT32_SZ + WOLFSSH_SFTP_HEADER;
byte* out = NULL;

char* res = NULL;
char ier[] = "Internal Failure";
char oer[] = "Open File Error";
#ifdef WOLFSSH_STOREHANDLE
int handleStored = 0;
#endif

fileHandle = INVALID_HANDLE_VALUE;

if (ssh == NULL) {
return WS_BAD_ARGUMENT;
Expand All @@ -2260,7 +2279,8 @@ int wolfSSH_SFTP_RecvOpen(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
if (GetAndCleanPath(ssh->sftpDefaultPath, data + idx, sz, dir, sizeof(dir))
!= WS_SUCCESS) {
WLOG(WS_LOG_SFTP, "Creating path for file to open failed");
return WS_FATAL_ERROR;
ret = WS_FATAL_ERROR;
goto cleanup;
}
idx += sz;

Expand Down Expand Up @@ -2305,45 +2325,72 @@ int wolfSSH_SFTP_RecvOpen(WOLFSSH* ssh, int reqId, byte* data, word32 maxSz)
res = oer;
if (wolfSSH_SFTP_CreateStatus(ssh, WOLFSSH_FTP_FAILURE, reqId, res,
"English", NULL, &outSz) != WS_SIZE_ONLY) {
return WS_FATAL_ERROR;
ret = WS_FATAL_ERROR;
goto cleanup;
}
ret = WS_BAD_FILE_E;
}
else {
fileHandleOpened = 1;
}

#ifdef WOLFSSH_STOREHANDLE
if (SFTP_AddHandleNode(ssh,
(byte*)&fileHandle, sizeof(HANDLE), dir) != WS_SUCCESS) {
if (ret == WS_SUCCESS) {
if (SFTP_AddHandleNode(ssh,
(byte*)&fileHandle, sizeof(HANDLE), dir) != WS_SUCCESS) {
WLOG(WS_LOG_SFTP, "Unable to store handle");
res = ier;
if (wolfSSH_SFTP_CreateStatus(ssh, WOLFSSH_FTP_FAILURE, reqId, res,
"English", NULL, &outSz) != WS_SIZE_ONLY) {
return WS_FATAL_ERROR;
ret = WS_FATAL_ERROR;
goto cleanup;
}
ret = WS_FATAL_ERROR;
}
else {
handleStored = 1;
}
}
#endif

/* create packet */
out = (byte*)WMALLOC(outSz, ssh->ctx->heap, DYNTYPE_BUFFER);
if (out == NULL) {
return WS_MEMORY_E;
ret = WS_MEMORY_E;
goto cleanup;
}

if (ret == WS_SUCCESS) {
if (SFTP_CreatePacket(ssh, WOLFSSH_FTP_HANDLE, out, outSz,
(byte*)&fileHandle, sizeof(HANDLE)) != WS_SUCCESS) {
return WS_FATAL_ERROR;
ret = WS_FATAL_ERROR;
goto cleanup;
}
}
else {
if (wolfSSH_SFTP_CreateStatus(ssh, WOLFSSH_FTP_FAILURE, reqId, res,
"English", out, &outSz) != WS_SUCCESS) {
WFREE(out, ssh->ctx->heap, DYNTYPE_BUFFER);
return WS_FATAL_ERROR;
ret = WS_FATAL_ERROR;
goto cleanup;
}
}

/* set send out buffer, "out" is taken by ssh */
wolfSSH_SFTP_RecvSetSend(ssh, out, outSz);
outOwnedBySsh = 1;

cleanup:
#ifdef WOLFSSH_STOREHANDLE
if (ret != WS_SUCCESS && handleStored) {
(void)SFTP_RemoveHandleNode(ssh, (byte*)&fileHandle, sizeof(HANDLE));
}
#endif
if (!outOwnedBySsh && out != NULL) {
WFREE(out, ssh->ctx->heap, DYNTYPE_BUFFER);
}
if (ret != WS_SUCCESS && fileHandleOpened) {
CloseHandle(fileHandle);
}

WOLFSSH_UNUSED(ier);
return ret;
Expand Down
Loading