Skip to content

Commit 8542676

Browse files
committed
fix(sdk/go): enforce Windows-safe gateway names
Signed-off-by: Sunil Kumar Vadlamani <[email protected]>
1 parent 9b71277 commit 8542676

2 files changed

Lines changed: 58 additions & 6 deletions

File tree

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

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,10 @@ func resolveGatewayDir(name string) (string, ConfigSource, error) {
9090
return "", "", fmt.Errorf("%w: %q", ErrGatewayNotFound, name)
9191
}
9292

93-
// validateGatewayName accepts a single safe path component,
94-
// matching the Rust CLI's gateway-name rules.
93+
// validateGatewayName accepts portable, single-component gateway names.
94+
// Host-derived FQDN and IPv4 names may contain dots. Windows device names,
95+
// reserved filename characters, and ambiguous dot components are rejected
96+
// on every platform to keep SDK behavior consistent.
9597
func validateGatewayName(name string) error {
9698
if name == "" {
9799
return fmt.Errorf("%w: name must not be empty", ErrInvalidGatewayName)
@@ -105,6 +107,33 @@ func validateGatewayName(name string) error {
105107
if strings.ContainsRune(name, '\x00') {
106108
return fmt.Errorf("%w: name must not contain NUL", ErrInvalidGatewayName)
107109
}
110+
if strings.HasPrefix(name, ".") || strings.HasSuffix(name, ".") || strings.Contains(name, "..") {
111+
return fmt.Errorf("%w: invalid dot placement", ErrInvalidGatewayName)
112+
}
113+
114+
// This ASCII-only grammar excludes Windows reserved filename characters
115+
// (including colons in raw IPv6 addresses), spaces, and control characters.
116+
for _, r := range name {
117+
if (r >= 'a' && r <= 'z') || (r >= 'A' && r <= 'Z') ||
118+
(r >= '0' && r <= '9') || r == '-' || r == '_' || r == '.' {
119+
continue
120+
}
121+
return fmt.Errorf("%w: non-portable character %q", ErrInvalidGatewayName, r)
122+
}
123+
124+
// Windows treats device names as reserved even with an extension:
125+
// e.g. CON.txt and COM1.example.com refer to device names.
126+
stem, _, _ := strings.Cut(name, ".")
127+
stem = strings.ToUpper(stem)
128+
switch stem {
129+
case "CON", "PRN", "AUX", "NUL":
130+
return fmt.Errorf("%w: reserved Windows device name", ErrInvalidGatewayName)
131+
}
132+
// Reject COM0/LPT0 conservatively too, for Windows portability.
133+
if len(stem) == 4 && (strings.HasPrefix(stem, "COM") || strings.HasPrefix(stem, "LPT")) &&
134+
stem[3] >= '0' && stem[3] <= '9' {
135+
return fmt.Errorf("%w: reserved Windows device name", ErrInvalidGatewayName)
136+
}
108137
return nil
109138
}
110139

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

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,13 @@ func TestValidateGatewayName_ValidNames(t *testing.T) {
115115
"A_B_C",
116116
"gw.example.com",
117117
"192.0.2.1",
118-
"[2001:db8::1]",
119-
".hidden",
120118
"foo.bar",
121119
"config.json",
120+
"gw-1.example.com",
121+
"COM10",
122+
"LPT10",
123+
"CONSOLE",
124+
"com1x.example.com",
122125
}
123126

124127
for _, name := range validNames {
@@ -223,13 +226,33 @@ func TestValidateGatewayName_SpecialCharacters(t *testing.T) {
223226
{"foo#bar", "hash"},
224227
{"café", "non-ASCII"},
225228
{"日本語", "unicode"},
226-
{"foo bar", "tab (space)"},
229+
{"foo\tbar", "tab"},
227230
}
228231

229232
for _, tc := range cases {
230233
t.Run(tc.desc, func(t *testing.T) {
231234
err := validateGatewayName(tc.name)
232-
assert.NoError(t, err)
235+
assert.ErrorIs(t, err, ErrInvalidGatewayName)
236+
})
237+
}
238+
}
239+
240+
// Windows filename rules apply regardless of the host operating system.
241+
func TestValidateGatewayName_WindowsFilenameRules(t *testing.T) {
242+
invalid := []string{
243+
"CON", "con.txt", "CON.example.com",
244+
"PRN", "prn.log", "AUX", "aux.json", "NUL", "nul.config",
245+
"COM0", "COM1", "com9.txt", "COM1.example.com",
246+
"LPT0", "LPT1", "lpt9.log",
247+
"gateway.", ".hidden", "foo..bar", "gw.example.com.",
248+
"gateway ", "foo bar", "foo:stream", "C:gateway",
249+
"foo|bar", "foo?bar", "foo*bar", "foo<bar", "foo>bar", "foo\"bar",
250+
"gw\x01bar", "[2001:db8::1]", "2001:db8::1",
251+
}
252+
for _, name := range invalid {
253+
t.Run(name, func(t *testing.T) {
254+
err := validateGatewayName(name)
255+
assert.ErrorIs(t, err, ErrInvalidGatewayName)
233256
})
234257
}
235258
}

0 commit comments

Comments
 (0)