Skip to content

Commit 9b71277

Browse files
committed
fix(sdk/go): accept CLI-compatible gateway names
Signed-off-by: Sunil Kumar Vadlamani <[email protected]>
1 parent 465324a commit 9b71277

2 files changed

Lines changed: 63 additions & 38 deletions

File tree

‎sdk/go/openshell/v1/gateway/paths.go‎

Lines changed: 8 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import (
88
"os"
99
"path/filepath"
1010
"strings"
11-
"unicode"
1211
)
1312

1413
const (
@@ -91,32 +90,21 @@ func resolveGatewayDir(name string) (string, ConfigSource, error) {
9190
return "", "", fmt.Errorf("%w: %q", ErrGatewayNotFound, name)
9291
}
9392

94-
// validateGatewayName checks that a gateway name is safe for use as a
95-
// directory component. It rejects:
96-
// - empty names
97-
// - names containing path separators (/ or \)
98-
// - names that are "." or ".." (directory traversal)
99-
// - names containing "." (prevents hidden files and extension confusion)
100-
// - names with characters outside ASCII alphanumerics, dashes, underscores
93+
// validateGatewayName accepts a single safe path component,
94+
// matching the Rust CLI's gateway-name rules.
10195
func validateGatewayName(name string) error {
10296
if name == "" {
10397
return fmt.Errorf("%w: name must not be empty", ErrInvalidGatewayName)
10498
}
105-
106-
if strings.ContainsAny(name, "/\\") {
107-
return fmt.Errorf("%w: name must not contain path separators", ErrInvalidGatewayName)
99+
if name == "." || name == ".." {
100+
return fmt.Errorf("%w: invalid path component", ErrInvalidGatewayName)
108101
}
109-
110-
if strings.Contains(name, ".") {
111-
return fmt.Errorf("%w: name must not contain dots", ErrInvalidGatewayName)
102+
if strings.ContainsAny(name, `/\`) {
103+
return fmt.Errorf("%w: name must not contain path separators", ErrInvalidGatewayName)
112104
}
113-
114-
for _, r := range name {
115-
if !isValidNameRune(r) {
116-
return fmt.Errorf("%w: name contains invalid character %q", ErrInvalidGatewayName, string(r))
117-
}
105+
if strings.ContainsRune(name, '\x00') {
106+
return fmt.Errorf("%w: name must not contain NUL", ErrInvalidGatewayName)
118107
}
119-
120108
return nil
121109
}
122110

@@ -167,15 +155,3 @@ func listGatewayDirs(base string) ([]string, error) {
167155
}
168156
return names, nil
169157
}
170-
171-
// isValidNameRune returns true if the rune is an ASCII letter, digit,
172-
// dash, or underscore.
173-
func isValidNameRune(r rune) bool {
174-
if r > unicode.MaxASCII {
175-
return false
176-
}
177-
return (r >= 'a' && r <= 'z') ||
178-
(r >= 'A' && r <= 'Z') ||
179-
(r >= '0' && r <= '9') ||
180-
r == '-' || r == '_'
181-
}

‎sdk/go/openshell/v1/gateway/paths_test.go‎

Lines changed: 55 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,12 @@ func TestValidateGatewayName_ValidNames(t *testing.T) {
113113
"a",
114114
"test-gateway-01",
115115
"A_B_C",
116+
"gw.example.com",
117+
"192.0.2.1",
118+
"[2001:db8::1]",
119+
".hidden",
120+
"foo.bar",
121+
"config.json",
116122
}
117123

118124
for _, name := range validNames {
@@ -147,13 +153,10 @@ func TestValidateGatewayName_PathSeparators(t *testing.T) {
147153
}
148154
}
149155

150-
func TestValidateGatewayName_Dots(t *testing.T) {
156+
func TestValidateGatewayName_DotComponents(t *testing.T) {
151157
cases := []string{
152158
".",
153159
"..",
154-
".hidden",
155-
"foo.bar",
156-
"config.json",
157160
}
158161

159162
for _, name := range cases {
@@ -226,8 +229,54 @@ func TestValidateGatewayName_SpecialCharacters(t *testing.T) {
226229
for _, tc := range cases {
227230
t.Run(tc.desc, func(t *testing.T) {
228231
err := validateGatewayName(tc.name)
229-
require.Error(t, err)
230-
assert.ErrorIs(t, err, ErrInvalidGatewayName)
232+
assert.NoError(t, err)
231233
})
232234
}
233235
}
236+
237+
func TestHostDerivedGatewayNames(t *testing.T) {
238+
tmp := t.TempDir()
239+
t.Setenv("XDG_CONFIG_HOME", tmp)
240+
t.Setenv(systemGatewayDirEnv, filepath.Join(tmp, "system"))
241+
242+
names := []string{"gw.example.com", "192.0.2.1"}
243+
for _, name := range names {
244+
dir := filepath.Join(tmp, "openshell", "gateways", name)
245+
require.NoError(t, os.MkdirAll(dir, 0o755))
246+
require.NoError(t, os.WriteFile(
247+
filepath.Join(dir, "metadata.json"),
248+
[]byte(`{"gateway_endpoint":"https://gw.example.com:443","auth_mode":"none"}`),
249+
0o600,
250+
))
251+
252+
cfg, err := LoadConfig(name)
253+
require.NoError(t, err)
254+
assert.Equal(t, name, cfg.Name)
255+
}
256+
257+
require.NoError(t, os.WriteFile(
258+
filepath.Join(tmp, "openshell", "active_gateway"),
259+
[]byte("gw.example.com"), 0o600,
260+
))
261+
262+
active, err := LoadConfig("")
263+
require.NoError(t, err)
264+
assert.Equal(t, "gw.example.com", active.Name)
265+
266+
gateways, err := ListGateways()
267+
require.NoError(t, err)
268+
got := make(map[string]bool)
269+
for _, gw := range gateways {
270+
got[gw.Name] = gw.Active
271+
}
272+
assert.Equal(t, map[string]bool{
273+
"gw.example.com": true,
274+
"192.0.2.1": false,
275+
}, got)
276+
}
277+
278+
func TestValidateGatewayName_NUL(t *testing.T) {
279+
err := validateGatewayName("gw\x00example")
280+
require.Error(t, err)
281+
assert.ErrorIs(t, err, ErrInvalidGatewayName)
282+
}

0 commit comments

Comments
 (0)