[bugfix] Windows paths don’t work with Server #445
Conversation
| @@ -288,9 +288,9 @@ func cleanPath(p string) string { | |||
| } | |||
|
|
|||
| func cleanPathWithBase(base, p string) string { | |||
| p = filepath.ToSlash(p) | |||
| p = filepath.ToSlash(filepath.Clean(p)) | |||
There was a problem hiding this comment.
The order here really doesn’t matter except for Windows, and only for UNC paths. “Let’s just not support UNC paths“ doesn’t work, because OpenSSH’s client does not sanitize the path first, so UNC paths would still work with that client anyways. 😭
There was a problem hiding this comment.
linux-machine $ sftp -P 31337 windows-machine
sftp> ls //wsl$/openSUSE-Leap-15.3
//wsl$/openSUSE-Leap-15.3/bin //wsl$/openSUSE-Leap-15.3/dev //wsl$/openSUSE-Leap-15.3/etc
//wsl$/openSUSE-Leap-15.3/home //wsl$/openSUSE-Leap-15.3/init //wsl$/openSUSE-Leap-15.3/lib
//wsl$/openSUSE-Leap-15.3/lib64 //wsl$/openSUSE-Leap-15.3/lost+found //wsl$/openSUSE-Leap-15.3/mnt
//wsl$/openSUSE-Leap-15.3/opt //wsl$/openSUSE-Leap-15.3/proc //wsl$/openSUSE-Leap-15.3/root
//wsl$/openSUSE-Leap-15.3/run //wsl$/openSUSE-Leap-15.3/sbin //wsl$/openSUSE-Leap-15.3/selinux
//wsl$/openSUSE-Leap-15.3/srv //wsl$/openSUSE-Leap-15.3/sys //wsl$/openSUSE-Leap-15.3/tmp
//wsl$/openSUSE-Leap-15.3/usr //wsl$/openSUSE-Leap-15.3/var
🤷♀️ alright.
| if !path.IsAbs(p) { | ||
| return path.Join(base, p) | ||
| } | ||
| return path.Clean(p) | ||
| return p |
There was a problem hiding this comment.
I did some basic tests and all worked, anyway since path.Join calls Clean internally, I'll leave path.Clean(p) here too
There was a problem hiding this comment.
Hm… the point here in removing this path.Clean() is that PuTTY sftp sanitizes names with FXP_REALPATH and this removes the double slash at the start of a //UNC/Path this means that while on my Linux machine, I could do ls //wsl$/openSUSE-Leap-15.3 attempting to do the same on my PuTTY sftp client, resulted in the path being cleaned in the FXP_REALPATH, and then failing with cannot open: /wsl$/openSUSE-Leap-15.3
There was a problem hiding this comment.
So we could have the same issue if the path is not absolute and we hit return path.Join(base, p)
There was a problem hiding this comment.
True, but this should only apply in the case where the base being added is a UNC address. So, for example cleanPathWithBase("//wsl$/openSUSE-Leap-15.3", aPath)
I think in this case, we’re kind of a bit stuck on “having a non-default base paths is not particularly robust and a little bit of a hack”. 🤔 For this particular case, I’m a bit more willing to let the inconsistent behavior slide.
There was a problem hiding this comment.
Allowing non cleaned paths could break some usages, let's merge this patch and see if someone complaints. I'll try to do some tests myself using wsl (I never tested it) as soon as I have some free time, it could take a while
There was a problem hiding this comment.
Right, this is why I think keeping the path.Join which will auto-clean as well is the better choice for now, even though it would break UNC base paths. Getting some sort of logic to correctly handle all the nuances of properly rooting all reasonable base/path combos would be 😩 .
It’s at least pretty nice that we can do UNC paths with a “local” datastore with WSL, if I had to setup a remote SMB server to test any of this, I might very well tear my hair out. 😆
Change uses of direct paths in
Serverto usetoLocalPathto deconvert encoded absolute paths.For Windows:
FromSlashremoving the leading backslashes produces an absolute path. If it does, then we return that instead.filepath.Cleanfirst beforefilepath.ToSlashso that clients work consistently. (\\UNC\Pathpaths work on clients that do notFXP_REALPATHsanitize first, while for those that do,path.Cleanwould otherwise strip out the double slash start.)For Plan9:
#) get prefixed with a slash incleanPath, usingfilepath.Cleanfirst should avoid accidentally dropping the#, and then we make sure a leading/will get removed if added from the “add a starting slash” encoding .s_ISVTXwas typoed asS_ISVTXAll other OSes:
toLocalPathjust returns the path. There’s nothing further to be done for it.