fix(#1107): Support non Unicode remote file handle on SFTP server

- Take care of non Unicode characters that get created on FTPS server for a remote file handle - Avoid to break the XML/JSON marshal serialization of incoming put commands
citrusframework · Jan 21, 2024 · ef11818 · ef11818
1 parent f6078de
commit ef11818
Showing 1 changed file with 11 additions and 9 deletions.
diff --git a/endpoints/citrus-ftp/src/main/java/org/citrusframework/ftp/server/SftpServer.java b/endpoints/citrus-ftp/src/main/java/org/citrusframework/ftp/server/SftpServer.java
@@ -16,12 +16,21 @@
 
 package org.citrusframework.ftp.server;
 
+import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
 import java.nio.file.attribute.PosixFilePermission;
 import java.util.Arrays;
 import java.util.Optional;
 import java.util.Set;
 
+import org.apache.commons.net.ftp.FTPCmd;
+import org.apache.ftpserver.ftplet.DataType;
+import org.apache.sshd.common.session.Session;
+import org.apache.sshd.common.util.buffer.BufferUtils;
+import org.apache.sshd.scp.common.ScpTransferEventListener;
+import org.apache.sshd.server.session.ServerSession;
+import org.apache.sshd.sftp.server.FileHandle;
+import org.apache.sshd.sftp.server.SftpEventListener;
 import org.citrusframework.endpoint.AbstractPollableEndpointConfiguration;
 import org.citrusframework.exceptions.CitrusRuntimeException;
 import org.citrusframework.ftp.client.SftpEndpointConfiguration;
@@ -30,13 +39,6 @@
 import org.citrusframework.ftp.model.CommandResult;
 import org.citrusframework.ssh.server.SshServer;
 import org.citrusframework.xml.StringResult;
-import org.apache.commons.net.ftp.FTPCmd;
-import org.apache.ftpserver.ftplet.DataType;
-import org.apache.sshd.common.session.Session;
-import org.apache.sshd.scp.common.ScpTransferEventListener;
-import org.apache.sshd.server.session.ServerSession;
-import org.apache.sshd.sftp.server.FileHandle;
-import org.apache.sshd.sftp.server.SftpEventListener;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -127,15 +129,15 @@ public void initialized(ServerSession session, int version) {
 
     @Override
     public void reading(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen) {
-        FtpMessage response = handleMessage(FtpMessage.get(localHandle.getFile().toString(), remoteHandle, DataType.ASCII));
+        FtpMessage response = handleMessage(FtpMessage.get(localHandle.getFile().toString(), BufferUtils.toHex(BufferUtils.EMPTY_HEX_SEPARATOR, remoteHandle.getBytes(StandardCharsets.UTF_8)), DataType.ASCII));
         if (response.hasException()) {
             throw new CitrusRuntimeException(response.getPayload(CommandResult.class).getException());
         }
     }
 
     @Override
     public void writing(ServerSession session, String remoteHandle, FileHandle localHandle, long offset, byte[] data, int dataOffset, int dataLen) {
-        FtpMessage response = handleMessage(FtpMessage.put(remoteHandle, localHandle.getFile().toString(), DataType.ASCII));
+        FtpMessage response = handleMessage(FtpMessage.put(BufferUtils.toHex(BufferUtils.EMPTY_HEX_SEPARATOR, remoteHandle.getBytes(StandardCharsets.UTF_8)), localHandle.getFile().toString(), DataType.ASCII));
         if (response.hasException()) {
             throw new CitrusRuntimeException(response.getPayload(CommandResult.class).getException());
         }