refactor: support percent-encoded /unix paths#10833
Draft
Conversation
This is a PoC that aims to support multiformats/multiaddr#174 while not breaking existing Kubo users. See TODO in daemon.go – likely we want to move this to https://github.com/multiformats/go-multiaddr
lidel
commented
Jun 9, 2025
Comment on lines
+709
to
+726
| // TODO: should a version of this live in https://github.com/multiformats/go-multiaddr | ||
| // so we dont need to duplicate code here and in client/rpc/api.go ? | ||
| func NormalizeUnixMultiaddr(address string) string { | ||
| // Support legacy and modern /unix addrs | ||
| // https://github.com/multiformats/multiaddr/pull/174 | ||
| socketPath, err := url.PathUnescape(address) | ||
| if err != nil { | ||
| return address // nil, fmt.Errorf("failed to unescape /unix socket path: %w", err) | ||
| } | ||
| // Ensure the path is absolute | ||
| if !strings.HasPrefix(socketPath, string(filepath.Separator)) { | ||
| socketPath = string(filepath.Separator) + socketPath | ||
| } | ||
| // Normalize path | ||
| socketPath = filepath.Clean(socketPath) | ||
| return socketPath | ||
| } | ||
|
|
Member
Author
There was a problem hiding this comment.
IF It does not live in https://github.com/multiformats/go-multiaddr then multiformats/multiaddr#174 is effectively a dead spec IMO, because nobody will use percent-encoded version.
Contributor
There was a problem hiding this comment.
I agree. If we are going to support multiformats/multiaddr#174 then this should live in go-multiaddr
achingbrain
reviewed
Jun 12, 2025
| if err != nil { | ||
| return address // nil, fmt.Errorf("failed to unescape /unix socket path: %w", err) | ||
| } | ||
| // Ensure the path is absolute |
Member
There was a problem hiding this comment.
N.b. in the latest version of the spec pr, relative paths are supported
gammazero
reviewed
Jul 9, 2025
| return address // nil, fmt.Errorf("failed to unescape /unix socket path: %w", err) | ||
| } | ||
| // Ensure the path is absolute | ||
| if !strings.HasPrefix(socketPath, string(filepath.Separator)) { |
Contributor
There was a problem hiding this comment.
Suggested change
| if !strings.HasPrefix(socketPath, string(filepath.Separator)) { | |
| if !filepath.IsAbs(socketPath) { |
| } | ||
| // Ensure the path is absolute | ||
| if !strings.HasPrefix(socketPath, string(filepath.Separator)) { | ||
| socketPath = string(filepath.Separator) + socketPath |
Contributor
There was a problem hiding this comment.
Is it correct to prepend a separator, or should the current directory be prepended?
See filepath.Abs
Comment on lines
+723
to
+724
| socketPath = filepath.Clean(socketPath) | ||
| return socketPath |
Contributor
There was a problem hiding this comment.
Suggested change
| socketPath = filepath.Clean(socketPath) | |
| return socketPath | |
| return filepath.Clean(socketPath) |
Comment on lines
+709
to
+726
| // TODO: should a version of this live in https://github.com/multiformats/go-multiaddr | ||
| // so we dont need to duplicate code here and in client/rpc/api.go ? | ||
| func NormalizeUnixMultiaddr(address string) string { | ||
| // Support legacy and modern /unix addrs | ||
| // https://github.com/multiformats/multiaddr/pull/174 | ||
| socketPath, err := url.PathUnescape(address) | ||
| if err != nil { | ||
| return address // nil, fmt.Errorf("failed to unescape /unix socket path: %w", err) | ||
| } | ||
| // Ensure the path is absolute | ||
| if !strings.HasPrefix(socketPath, string(filepath.Separator)) { | ||
| socketPath = string(filepath.Separator) + socketPath | ||
| } | ||
| // Normalize path | ||
| socketPath = filepath.Clean(socketPath) | ||
| return socketPath | ||
| } | ||
|
|
Contributor
There was a problem hiding this comment.
I agree. If we are going to support multiformats/multiaddr#174 then this should live in go-multiaddr
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
/unixmultiformats/multiaddr#174is breaking spec change that is incompatible with existing feature in Kubo, where users were able to provide old notation of
/unixmultiaddrs in both Addresses.API and Addresses.Gateway.How
This is a PoC that aims to support
multiformats/multiaddr#174 while not breaking existing Kubo users.
TODO