node-restify icon indicating copy to clipboard operation
node-restify copied to clipboard

fix: handle trailing slashes on root route and avoid crashes due to `AssertionError`s thrown by odd requests

Open nexdrew opened this issue 1 year ago • 0 comments

Pre-Submission Checklist

  • [x] Opened an issue discussing these changes before opening the PR
  • [x] Ran the linter and tests via make prepush
  • [x] Included comprehensive and convincing tests for changes

Issues

Closes:

  • Issue #1959
  • Issue #1953

Summarize the issues that discussed these changes

The issues demonstrate how restify can crash the node process when using server.pre(restify.pre.sanitizePath()) and a request with trailing slashes on root is received. I experienced this via intruder.io scanning against my production API application that uses restify. Please see the repro case here as referenced in #1959.

Changes

What does this PR do?

This PR makes 3 basic changes, each with at least one new unit test:

  1. Changes the sanitizePath middleware in lib/plugins/pre/prePath.js to return a root url (/) instead of an empty string in the case where the actual url consists of more than one slash e.g. // or ///. This helps avoid numbers 2 and 3 below.

  2. Changes the lookup method in lib/router.js to return undefined when req.getUrl().pathname is falsy. This helps avoid calling this._registry.lookup(req.method, pathname) which will result in an AssertionError in the case that the pathname is falsy, for whatever reason.

  3. Changes the defaultRoute method in lib/router.js to expect/handle a falsy pathname by skipping registry lookup (which would throw an AssertionError) and raising the standard ResourceNotFoundError (which results in 404 response) with the message "Requested path does not exist". This, along with number 2, allows restify to gracefully handle a falsy pathname for whatever reason.

All changes are covered by unit tests, namely:

  1. sanitizePath in test/plugins/plugins.test.js
  2. GH-1959: lookup returns undefined when no handler found in test/router.test.js
  3. GH-1959: route handles 404 when pathname invalid in test/router.test.js

This is an attempt to make restify more robust and avoid crashes due to odd requests, if possible.

Please let me know if you have any questions or if you'd like me to change anything. Thanks!

nexdrew avatar Jul 03 '23 20:07 nexdrew