e04ed9c211
CF: Deploy Dev Docs / deploy (push) Has been cancelled
Sync Labels / build (push) Has been cancelled
tests / unit tests (macos-latest) (push) Has been cancelled
tests / unit tests (windows-latest) (push) Has been cancelled
tests / unit tests (ubuntu-latest) (push) Has been cancelled
202 lines
5.2 KiB
Go
202 lines
5.2 KiB
Go
// Copyright 2026 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package http
|
|
|
|
import (
|
|
"net/url"
|
|
"testing"
|
|
|
|
"github.com/googleapis/mcp-toolbox/internal/util/parameters"
|
|
)
|
|
|
|
func TestGetURLHostOverride(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
pathParam string
|
|
expectError bool
|
|
expectedHost string
|
|
}{
|
|
{
|
|
name: "at sign in path is not a host override",
|
|
pathParam: "@evil.com/v1",
|
|
expectError: false,
|
|
expectedHost: "api.good.com",
|
|
},
|
|
{
|
|
name: "absolute url in path is rejected",
|
|
pathParam: "https://evil.com/v1",
|
|
expectError: true,
|
|
},
|
|
{
|
|
name: "authority override in path is rejected",
|
|
pathParam: "//evil.com/v1",
|
|
expectError: true,
|
|
},
|
|
}
|
|
|
|
baseURL := "https://api.good.com"
|
|
path := "{{.pathParam}}"
|
|
pathParams := parameters.Parameters{parameters.NewStringParameter("pathParam", "path")}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
paramsMap := map[string]any{"pathParam": tc.pathParam}
|
|
|
|
urlString, err := getURL(baseURL, path, pathParams, nil, nil, paramsMap)
|
|
if tc.expectError {
|
|
if err == nil {
|
|
t.Fatalf("expected error but got none")
|
|
}
|
|
return
|
|
}
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
|
|
parsed, err := url.Parse(urlString)
|
|
if err != nil {
|
|
t.Fatalf("failed to parse URL: %v", err)
|
|
}
|
|
|
|
if parsed.Host != tc.expectedHost {
|
|
t.Fatalf("expected host to be %q, got %q", tc.expectedHost, parsed.Host)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestGetURLPathValidation(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
baseURL string
|
|
pathParam string
|
|
expectError bool
|
|
expectedPath string
|
|
}{
|
|
{
|
|
name: "valid subpath stays within base path",
|
|
baseURL: "https://api.good.com/base/",
|
|
pathParam: "v1",
|
|
expectError: false,
|
|
expectedPath: "/base/v1",
|
|
},
|
|
{
|
|
name: "path with dot segments is rejected",
|
|
baseURL: "https://api.good.com/base/",
|
|
pathParam: "../v1",
|
|
expectError: true,
|
|
},
|
|
{
|
|
name: "absolute path escaping base path scope is rejected",
|
|
baseURL: "https://api.good.com/base/",
|
|
pathParam: "/v1",
|
|
expectError: true,
|
|
},
|
|
{
|
|
name: "absolute path for root base path is allowed",
|
|
baseURL: "https://api.good.com/",
|
|
pathParam: "/v1",
|
|
expectError: false,
|
|
expectedPath: "/v1",
|
|
},
|
|
{
|
|
name: "path with url-encoded dot segments is rejected",
|
|
baseURL: "https://api.good.com/base/",
|
|
pathParam: "%2e%2e/v1",
|
|
expectError: true,
|
|
},
|
|
{
|
|
name: "sibling path traversal via simple prefix matching is rejected",
|
|
baseURL: "https://api.good.com/base",
|
|
pathParam: "/base-private",
|
|
expectError: true,
|
|
},
|
|
{
|
|
name: "exact match of base path without trailing slash is allowed",
|
|
baseURL: "https://api.good.com/base",
|
|
pathParam: "",
|
|
expectError: false,
|
|
expectedPath: "/base",
|
|
},
|
|
{
|
|
name: "double dots in query parameters are allowed",
|
|
baseURL: "https://api.good.com/base/",
|
|
pathParam: "v1?date=2023-01-01..2023-01-31",
|
|
expectError: false,
|
|
expectedPath: "/base/v1",
|
|
},
|
|
{
|
|
name: "double dots in non-dot segments are allowed",
|
|
baseURL: "https://api.good.com/base/",
|
|
pathParam: "file..txt",
|
|
expectError: false,
|
|
expectedPath: "/base/file..txt",
|
|
},
|
|
}
|
|
|
|
path := "{{.pathParam}}"
|
|
pathParams := parameters.Parameters{parameters.NewStringParameter("pathParam", "path")}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
paramsMap := map[string]any{"pathParam": tc.pathParam}
|
|
|
|
urlString, err := getURL(tc.baseURL, path, pathParams, nil, nil, paramsMap)
|
|
if tc.expectError {
|
|
if err == nil {
|
|
t.Fatalf("expected error but got none")
|
|
}
|
|
return
|
|
}
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
|
|
parsed, err := url.Parse(urlString)
|
|
if err != nil {
|
|
t.Fatalf("failed to parse URL: %v", err)
|
|
}
|
|
|
|
if parsed.Path != tc.expectedPath {
|
|
t.Fatalf("expected path to be %q, got %q", tc.expectedPath, parsed.Path)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestGetURLCustomFuncs(t *testing.T) {
|
|
baseURL := "https://api.good.com/v1/"
|
|
path := "users/{{pathEscape .name}}/details?q={{queryEscape .query}}"
|
|
pathParams := parameters.Parameters{
|
|
parameters.NewStringParameter("name", "user name"),
|
|
parameters.NewStringParameter("query", "search query"),
|
|
}
|
|
|
|
paramsMap := map[string]any{
|
|
"name": "john/doe",
|
|
"query": "hello world",
|
|
}
|
|
|
|
urlString, err := getURL(baseURL, path, pathParams, nil, nil, paramsMap)
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
|
|
expected := "https://api.good.com/v1/users/john%2Fdoe/details?q=hello+world"
|
|
if urlString != expected {
|
|
t.Fatalf("expected %q, got %q", expected, urlString)
|
|
}
|
|
}
|