<!-- Provide a brief summary of your changes --> ## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> Follow up on #869 ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> ## Breaking Changes <!-- Will users need to update their code or configurations? --> ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [ ] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [ ] My code follows the repository's style guidelines - [ ] New and existing tests pass locally - [ ] I have added appropriate error handling - [ ] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions --> Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
256 lines
8.5 KiB
Go
256 lines
8.5 KiB
Go
package api_test
|
|
|
|
import (
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/modelcontextprotocol/registry/internal/api"
|
|
)
|
|
|
|
func TestNulByteValidationMiddleware(t *testing.T) {
|
|
// Create a simple handler that returns "OK"
|
|
handler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte("OK"))
|
|
})
|
|
|
|
// Wrap with our middleware
|
|
middleware := api.NulByteValidationMiddleware(handler)
|
|
|
|
t.Run("normal path should pass through", func(t *testing.T) {
|
|
req := httptest.NewRequest(http.MethodGet, "/v0/servers", nil)
|
|
w := httptest.NewRecorder()
|
|
middleware.ServeHTTP(w, req)
|
|
|
|
if w.Code != http.StatusOK {
|
|
t.Errorf("expected status %d, got %d", http.StatusOK, w.Code)
|
|
}
|
|
})
|
|
|
|
t.Run("path with query params should pass through", func(t *testing.T) {
|
|
req := httptest.NewRequest(http.MethodGet, "/v0/servers?cursor=abc123", nil)
|
|
w := httptest.NewRecorder()
|
|
middleware.ServeHTTP(w, req)
|
|
|
|
if w.Code != http.StatusOK {
|
|
t.Errorf("expected status %d, got %d", http.StatusOK, w.Code)
|
|
}
|
|
})
|
|
|
|
t.Run("path with NUL byte should return 400", func(t *testing.T) {
|
|
// Create request with NUL byte in path by manually setting URL
|
|
req := httptest.NewRequest(http.MethodGet, "/v0/servers/test", nil)
|
|
req.URL.Path = "/v0/servers/\x00"
|
|
w := httptest.NewRecorder()
|
|
middleware.ServeHTTP(w, req)
|
|
|
|
if w.Code != http.StatusBadRequest {
|
|
t.Errorf("expected status %d, got %d", http.StatusBadRequest, w.Code)
|
|
}
|
|
if !strings.Contains(w.Body.String(), "URL path contains null bytes") {
|
|
t.Errorf("expected body to contain error message, got %q", w.Body.String())
|
|
}
|
|
// Verify JSON response format
|
|
if w.Header().Get("Content-Type") != "application/json" {
|
|
t.Errorf("expected Content-Type application/json, got %q", w.Header().Get("Content-Type"))
|
|
}
|
|
})
|
|
|
|
t.Run("query with NUL byte should return 400", func(t *testing.T) {
|
|
// Create request with NUL byte in query by manually setting RawQuery
|
|
req := httptest.NewRequest(http.MethodGet, "/v0/servers", nil)
|
|
req.URL.RawQuery = "cursor=\x00"
|
|
w := httptest.NewRecorder()
|
|
middleware.ServeHTTP(w, req)
|
|
|
|
if w.Code != http.StatusBadRequest {
|
|
t.Errorf("expected status %d, got %d", http.StatusBadRequest, w.Code)
|
|
}
|
|
if !strings.Contains(w.Body.String(), "query parameters contain null bytes") {
|
|
t.Errorf("expected body to contain error message, got %q", w.Body.String())
|
|
}
|
|
})
|
|
|
|
t.Run("path with embedded NUL byte should return 400", func(t *testing.T) {
|
|
req := httptest.NewRequest(http.MethodGet, "/v0/servers/test", nil)
|
|
req.URL.Path = "/v0/servers/test\x00name"
|
|
w := httptest.NewRecorder()
|
|
middleware.ServeHTTP(w, req)
|
|
|
|
if w.Code != http.StatusBadRequest {
|
|
t.Errorf("expected status %d, got %d", http.StatusBadRequest, w.Code)
|
|
}
|
|
})
|
|
|
|
t.Run("query with URL-encoded NUL byte (%00) should return 400", func(t *testing.T) {
|
|
// This is the exact case from issue #862: ?cursor=%00
|
|
req := httptest.NewRequest(http.MethodGet, "/v0/servers?cursor=%00", nil)
|
|
w := httptest.NewRecorder()
|
|
middleware.ServeHTTP(w, req)
|
|
|
|
if w.Code != http.StatusBadRequest {
|
|
t.Errorf("expected status %d, got %d", http.StatusBadRequest, w.Code)
|
|
}
|
|
if !strings.Contains(w.Body.String(), "query parameters contain null bytes") {
|
|
t.Errorf("expected body to contain error message, got %q", w.Body.String())
|
|
}
|
|
})
|
|
|
|
t.Run("query with URL-encoded NUL byte followed by text should return 400", func(t *testing.T) {
|
|
req := httptest.NewRequest(http.MethodGet, "/v0/servers?cursor=%00test", nil)
|
|
w := httptest.NewRecorder()
|
|
middleware.ServeHTTP(w, req)
|
|
|
|
if w.Code != http.StatusBadRequest {
|
|
t.Errorf("expected status %d, got %d", http.StatusBadRequest, w.Code)
|
|
}
|
|
})
|
|
|
|
t.Run("query with embedded URL-encoded NUL byte should return 400", func(t *testing.T) {
|
|
req := httptest.NewRequest(http.MethodGet, "/v0/servers?cursor=abc%00def", nil)
|
|
w := httptest.NewRecorder()
|
|
middleware.ServeHTTP(w, req)
|
|
|
|
if w.Code != http.StatusBadRequest {
|
|
t.Errorf("expected status %d, got %d", http.StatusBadRequest, w.Code)
|
|
}
|
|
})
|
|
|
|
t.Run("query with double-encoded NUL byte (%2500) should pass through", func(t *testing.T) {
|
|
// %2500 decodes to %00 (literal string), not a NUL byte
|
|
// This is intentionally allowed - double-decoding is the caller's responsibility
|
|
req := httptest.NewRequest(http.MethodGet, "/v0/servers?cursor=%2500", nil)
|
|
w := httptest.NewRecorder()
|
|
middleware.ServeHTTP(w, req)
|
|
|
|
// This should pass - %2500 is not a NUL byte injection attempt
|
|
// When decoded once: %2500 -> %00 (the string "%00", not a NUL byte)
|
|
if w.Code != http.StatusOK {
|
|
t.Errorf("expected status %d, got %d (double-encoded should pass)", http.StatusOK, w.Code)
|
|
}
|
|
})
|
|
|
|
t.Run("query with valid percent-encoding should pass through", func(t *testing.T) {
|
|
// Ensure we don't false-positive on valid encodings like %20 (space)
|
|
req := httptest.NewRequest(http.MethodGet, "/v0/servers?search=hello%20world", nil)
|
|
w := httptest.NewRecorder()
|
|
middleware.ServeHTTP(w, req)
|
|
|
|
if w.Code != http.StatusOK {
|
|
t.Errorf("expected status %d, got %d", http.StatusOK, w.Code)
|
|
}
|
|
})
|
|
|
|
t.Run("path with URL-encoded NUL byte (%00) should return 400", func(t *testing.T) {
|
|
// Handlers call url.PathUnescape() which would decode %00 to \x00
|
|
req := httptest.NewRequest(http.MethodGet, "/v0/servers/%00/versions", nil)
|
|
w := httptest.NewRecorder()
|
|
middleware.ServeHTTP(w, req)
|
|
|
|
if w.Code != http.StatusBadRequest {
|
|
t.Errorf("expected status %d, got %d", http.StatusBadRequest, w.Code)
|
|
}
|
|
if !strings.Contains(w.Body.String(), "URL path contains null bytes") {
|
|
t.Errorf("expected body to contain error message, got %q", w.Body.String())
|
|
}
|
|
})
|
|
|
|
t.Run("path with URL-encoded NUL byte among other encodings should return 400", func(t *testing.T) {
|
|
// %0a is newline, %00 is NUL - should still catch the NUL
|
|
req := httptest.NewRequest(http.MethodGet, "/v0/servers/test%0a%00name/versions", nil)
|
|
w := httptest.NewRecorder()
|
|
middleware.ServeHTTP(w, req)
|
|
|
|
if w.Code != http.StatusBadRequest {
|
|
t.Errorf("expected status %d, got %d", http.StatusBadRequest, w.Code)
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestTrailingSlashMiddleware(t *testing.T) {
|
|
// Create a simple handler that returns "OK"
|
|
handler := http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
|
w.WriteHeader(http.StatusOK)
|
|
_, _ = w.Write([]byte("OK"))
|
|
})
|
|
|
|
// Wrap with our middleware
|
|
middleware := api.TrailingSlashMiddleware(handler)
|
|
|
|
tests := []struct {
|
|
name string
|
|
path string
|
|
expectedStatus int
|
|
expectedLocation string
|
|
expectRedirect bool
|
|
}{
|
|
{
|
|
name: "root path should not redirect",
|
|
path: "/",
|
|
expectedStatus: http.StatusOK,
|
|
expectRedirect: false,
|
|
},
|
|
{
|
|
name: "path without trailing slash should pass through",
|
|
path: "/v0/servers",
|
|
expectedStatus: http.StatusOK,
|
|
expectRedirect: false,
|
|
},
|
|
{
|
|
name: "path with trailing slash should redirect",
|
|
path: "/v0/servers/",
|
|
expectedStatus: http.StatusPermanentRedirect,
|
|
expectedLocation: "/v0/servers",
|
|
expectRedirect: true,
|
|
},
|
|
{
|
|
name: "nested path with trailing slash should redirect",
|
|
path: "/v0/servers/123/",
|
|
expectedStatus: http.StatusPermanentRedirect,
|
|
expectedLocation: "/v0/servers/123",
|
|
expectRedirect: true,
|
|
},
|
|
{
|
|
name: "deep nested path with trailing slash should redirect",
|
|
path: "/v0/auth/github/token/",
|
|
expectedStatus: http.StatusPermanentRedirect,
|
|
expectedLocation: "/v0/auth/github/token",
|
|
expectRedirect: true,
|
|
},
|
|
{
|
|
name: "path with query params and no trailing slash should pass through",
|
|
path: "/v0/servers?limit=10",
|
|
expectedStatus: http.StatusOK,
|
|
expectRedirect: false,
|
|
},
|
|
{
|
|
name: "path with query params and trailing slash should redirect preserving query params",
|
|
path: "/v0/servers/?limit=10",
|
|
expectedStatus: http.StatusPermanentRedirect,
|
|
expectedLocation: "/v0/servers?limit=10",
|
|
expectRedirect: true,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
req := httptest.NewRequest(http.MethodGet, tt.path, nil)
|
|
w := httptest.NewRecorder()
|
|
|
|
middleware.ServeHTTP(w, req)
|
|
|
|
if w.Code != tt.expectedStatus {
|
|
t.Errorf("expected status %d, got %d", tt.expectedStatus, w.Code)
|
|
}
|
|
|
|
if tt.expectRedirect {
|
|
location := w.Header().Get("Location")
|
|
if location != tt.expectedLocation {
|
|
t.Errorf("expected Location header %q, got %q", tt.expectedLocation, location)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
}
|