Skip to content

fix(credentials): preserve non-default SSH ports in remote URLs #5945

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
immanuwell wants to merge 1 commit into
base: v2
Choose a base branch
from
Open

fix(credentials): preserve non-default SSH ports in remote URLs #5945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 12 additions & 8 deletions internal/credentials/sshurl.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ var sshURLRegex = regexp.MustCompile(`^([^@]+)@([^:]+):(.+)$`)
// NormalizeSSHRemoteURL transforms a remote URL for use with SSH credentials.
// It handles the following cases:
// 1. Strips https:// or http:// protocol if present (SSH doesn't use HTTP(S) URLs)
// 2. Converts ssh:// protocol URLs to SCP-style format
// 2. Converts ssh:// protocol URLs to SCP-style format when possible
// 3. Prepends the SSH user to the URL if not already present
// 4. Returns an error if the URL contains a user that differs from sshUser
//
Expand All @@ -26,6 +26,7 @@ var sshURLRegex = regexp.MustCompile(`^([^@]+)@([^:]+):(.+)$`)
// - git@github.com:org/repo.git + user="git" -> git@github.com:org/repo.git (unchanged)
// - git@github.com:org/repo.git + user="other" -> error (conflicting users)
// - ssh://git@github.com/org/repo.git + user="git" -> git@github.com:org/repo.git
// - ssh://git@example.com:2222/org/repo.git + user="git" -> ssh://git@example.com:2222/org/repo.git
func NormalizeSSHRemoteURL(remoteURL, sshUser string) (string, error) {
if sshUser == "" {
sshUser = "git"
Expand Down Expand Up @@ -84,8 +85,9 @@ func NormalizeSSHRemoteURL(remoteURL, sshUser string) (string, error) {
return sshUser + "@" + host + ":" + path, nil
}

// convertSSHProtocolURL converts ssh:// protocol URLs to SCP-style format.
// ssh://[user@]host[:port]/path -> user@host:path
// convertSSHProtocolURL converts ssh:// protocol URLs for use with SSH credentials.
// It emits SCP-style syntax for the default SSH port and preserves ssh:// syntax
// for non-default ports because SCP-style URLs cannot encode custom ports.
func convertSSHProtocolURL(url, sshUser string) (string, error) {
url = strings.TrimPrefix(url, "ssh://")

Expand Down Expand Up @@ -114,13 +116,15 @@ func convertSSHProtocolURL(url, sshUser string) (string, error) {
hostPort := hostPortAndPath[:slashIndex]
path := hostPortAndPath[slashIndex+1:]

// Strip port from host if present (e.g., github.com:22 -> github.com)
host := hostPort
// Preserve ssh:// syntax for non-default ports because SCP-style remotes
// cannot represent a custom port without changing the repository path.
if colonIndex := strings.LastIndex(hostPort, ":"); colonIndex != -1 {
if hostPort[colonIndex+1:] == "22" {
host = hostPort[:colonIndex]
if hostPort[colonIndex+1:] != "22" {
return "ssh://" + sshUser + "@" + hostPort + "/" + path, nil
}

hostPort = hostPort[:colonIndex]
}

return sshUser + "@" + host + ":" + path, nil
return sshUser + "@" + hostPort + ":" + path, nil
}
10 changes: 8 additions & 2 deletions internal/credentials/sshurl_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,10 +159,16 @@ func TestNormalizeSSHRemoteURL(t *testing.T) {
want: "git@gitlab.com:group/subgroup/project.git",
},
{
name: "ssh with self-holted gitlab",
name: "ssh:// with non-default port preserves protocol URL",
remoteURL: "ssh://git@gitlab.localhost:6022/root/demo.git",
sshUser: "git",
want: "git@gitlab.localhost:6022:root/demo.git",
want: "ssh://git@gitlab.localhost:6022/root/demo.git",
},
{
name: "ssh:// without user and non-default port preserves protocol URL",
remoteURL: "ssh://gitlab.localhost:6022/root/demo.git",
sshUser: "git",
want: "ssh://git@gitlab.localhost:6022/root/demo.git",
},

// Error cases
Expand Down
Loading