Switched to library version of strict-url-sanitise

Author: geelen

package.json

@@ -9,7 +9,7 @@
     "remote",
     "oauth"
   ],
-  "author": "Glen Maddern <glen@cloudflare.com>",
+  "author": "Glen Maddern <glen@glenmaddern.com>",
   "repository": "https://github.com/geelen/mcp-remote",
   "type": "module",
   "files": [
@@ -32,7 +32,8 @@
   },
   "dependencies": {
     "express": "^4.21.2",
-    "open": "^10.1.0"
+    "open": "^10.1.0",
+    "strict-url-sanitise": "^0.0.1"
   },
   "devDependencies": {
     "@modelcontextprotocol/sdk": "https://pkg.pr.new/geelen/typescript-sdk/@modelcontextprotocol/sdk@cdf3508",

pnpm-lock.yaml

@@ -9,7 +9,8 @@ import {
 import type { OAuthProviderOptions, StaticOAuthClientMetadata } from './types'
 import { readJsonFile, writeJsonFile, readTextFile, writeTextFile, deleteConfigFile } from './mcp-auth-config'
 import { StaticOAuthClientInformationFull } from './types'
-import { getServerUrlHash, log, debugLog, DEBUG, MCP_REMOTE_VERSION, sanitizeUrl } from './utils'
+import { getServerUrlHash, log, debugLog, DEBUG, MCP_REMOTE_VERSION } from './utils'
+import { sanitizeUrl } from 'strict-url-sanitise'
 import { randomUUID } from 'node:crypto'
 
 /**

src/lib/node-oauth-client-provider.ts

@@ -1,147 +1,3 @@
 import { describe, it, expect } from 'vitest'
-import { sanitizeUrl } from './utils'
 
-describe('sanitizeUrl', () => {
-  describe('should allow valid URLs', () => {
-    const testCases = [
-      { input: 'http://example.com', expected: 'http://example.com/' },
-      { input: 'https://www.google.com', expected: 'https://www.google.com/' },
-      { input: 'http://test.com/path/to/resource', expected: 'http://test.com/path/to/resource' },
-      { input: 'https://api.github.com/users/octocat', expected: 'https://api.github.com/users/octocat' },
-      {
-        input: 'https://subdomain.example.com/page?param=value#section',
-        expected: 'https://subdomain.example.com/page?param=value#section',
-      },
-      { input: 'http://localhost:3000', expected: 'http://localhost:3000/' },
-      { input: 'https://127.0.0.1:8080', expected: 'https://127.0.0.1:8080/' },
-    ]
-
-    testCases.forEach(({ input, expected }) => {
-      it(`should sanitize: ${input}`, () => {
-        const result = sanitizeUrl(input)
-        expect(result).toBe(expected)
-      })
-    })
-  })
-
-  describe('should reject invalid protocols', () => {
-    const invalidProtocolUrls = [
-      'ftp://example.com/test',
-      'ssh://test.com/whoami',
-      'telnet://malicious.com/dir',
-      'file:///C:/Windows/System32/calc.exe',
-      'file://localhost/etc/passwd',
-      'file://c:/windows/system32/calc.exe',
-      'javascript:alert("XSS")',
-      'javascript:eval("malicious code")',
-      'javascript:$(calc.exe)?response_type=code.....',
-      'javascript:$(cmd /c whoami > c:\\temp\\pwned.txt)',
-      'data:text/html,<script>alert("XSS")</script>',
-    ]
-
-    invalidProtocolUrls.forEach((url) => {
-      it(`should reject: ${url}`, () => {
-        expect(() => sanitizeUrl(url)).toThrow('Invalid url to pass to open()')
-      })
-    })
-  })
-
-  describe('should reject malicious hosts', () => {
-    const invalidProtocolUrls = [
-      'https://www.$(calc.exe).com/foo',
-      'https://www.example.com:$(calc.exe)/foo',
-    ]
-
-    invalidProtocolUrls.forEach((url) => {
-      it(`should reject: ${url}`, () => {
-        expect(() => sanitizeUrl(url)).toThrow('Invalid url to pass to open()')
-      })
-    })
-  })
-
-  describe('should properly encode URL components', () => {
-    it('should reject URLs with spaces in hostname', () => {
-      // URLs with spaces in hostname are invalid
-      expect(() => sanitizeUrl('https://exam ple.com')).toThrow()
-    })
-
-    it('should encode special characters in pathname', () => {
-      const result = sanitizeUrl('https://example.com/path with spaces')
-      expect(result).toBe('https://example.com/path%2520with%2520spaces')
-    })
-
-    it('should encode query parameters', () => {
-      const result = sanitizeUrl('https://example.com?key=value with spaces&another=test')
-      expect(result).toBe('https://example.com/?key=value%20with%20spaces&another=test')
-    })
-
-    it('should encode hash fragments', () => {
-      const result = sanitizeUrl('https://example.com#section with spaces')
-      expect(result).toBe('https://example.com/#section%2520with%2520spaces')
-    })
-
-    it('should handle empty query parameter values', () => {
-      const result = sanitizeUrl('https://example.com?empty&hasvalue=test')
-      expect(result).toBe('https://example.com/?empty&hasvalue=test')
-    })
-
-    it('should encode basic auth', () => {
-      const result = sanitizeUrl('http://user$(calc)r:pass$(calc)[email protected]')
-      expect(result).toBe('http://user%24(calc)r:pass%24(calc)[email protected]/')
-    })
-  })
-
-  describe('should handle complex URLs', () => {
-    it('should handle URL with all components', () => {
-      const complexUrl = 'https://user:[email protected]:8080/path/to/resource?param=value&other=test#fragment'
-      const result = sanitizeUrl(complexUrl)
-      expect(result).toBe('https://user:[email protected]:8080/path/to/resource?param=value&other=test#fragment')
-    })
-
-    it('should preserve valid URL structure', () => {
-      const url = 'https://api.example.com/v1/users?limit=10&offset=0#results'
-      const result = sanitizeUrl(url)
-      expect(result).toBe('https://api.example.com/v1/users?limit=10&offset=0#results')
-    })
-  })
-
-  describe('should handle edge cases', () => {
-    it('should handle URLs with port numbers', () => {
-      const result = sanitizeUrl('http://localhost:3000/api')
-      expect(result).toBe('http://localhost:3000/api')
-    })
-
-    it('should handle URLs with authentication info', () => {
-      const result = sanitizeUrl('https://user:[email protected]/secure')
-      expect(result).toBe('https://user:[email protected]/secure')
-    })
-
-    it('should handle minimal URLs', () => {
-      const result = sanitizeUrl('http://a.com')
-      expect(result).toBe('http://a.com/')
-    })
-  })
-
-  describe('malformed or suspicious URLs', () => {
-    it('should handle URLs with suspicious query parameters', () => {
-      // These should be encoded properly, not blocked
-      const result = sanitizeUrl('https://example.com?param=$(calc.exe)')
-      expect(result).toBe('https://example.com/?param=%24(calc.exe)')
-    })
-
-    it('should handle URLs with suspicious fragments', () => {
-      const result = sanitizeUrl('https://example.com#$(calc)')
-      expect(result).toBe('https://example.com/#%24(calc)')
-    })
-
-    it('should handle URLs with command injection attempts in path', () => {
-      const result = sanitizeUrl('https://example.com/$(calc.exe)')
-      expect(result).toBe('https://example.com/%24(calc.exe)')
-    })
-
-    it('should handle specific malicious URL with calc.exe in path', () => {
-      const result = sanitizeUrl('http://www.a.com/$(calc.exe)')
-      expect(result).toBe('http://www.a.com/%24(calc.exe)')
-    })
-  })
-})
+// All sanitizeUrl tests have been moved to the strict-url-sanitise package

src/lib/utils.test.ts

@@ -704,32 +704,3 @@ export function setupSignalHandlers(cleanup: () => Promise<void>) {
 export function getServerUrlHash(serverUrl: string): string {
   return crypto.createHash('md5').update(serverUrl).digest('hex')
 }
-
-export function sanitizeUrl(raw: string) {
-  const abort = () => {
-    throw new Error(`Invalid url to pass to open(): ${raw}`)
-  }
-  let url!: URL
-  try {
-    url = new URL(raw)
-  } catch (_) {
-    abort()
-  }
-
-  // Don't allow any other scheme than http(s)
-  if (url.protocol !== 'https:' && url.protocol !== 'http:') abort()
-  // Hostnames can't be updated, but let's reject if they contain anything suspicious
-  if (url.hostname !== encodeURIComponent(url.hostname)) abort()
-
-  // Forcibly sanitise all the pieces of the URL
-  if (url.username) url.username = encodeURIComponent(url.username)
-  if (url.password) url.password = encodeURIComponent(url.password)
-  url.pathname = url.pathname.slice(0, 1) + encodeURIComponent(url.pathname.slice(1)).replace(/%2f/ig,'/')
-  url.search = url.search.slice(0, 1) + Array.from(url.searchParams.entries()).map(sanitizeParam).join('&')
-  url.hash = url.hash.slice(0, 1) + encodeURIComponent(url.hash.slice(1))
-  return url.href
-}
-
-function sanitizeParam([k, v]: [string, string]) {
-  return `${encodeURIComponent(k)}${v.length > 0 ? `=${encodeURIComponent(v)}` : ''}`
-}