Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: validate websocket request #7317

Open
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

hi-ogawa
Copy link
Contributor

@hi-ogawa hi-ogawa commented Jan 21, 2025

Description

summary

Adds ?token=xxx requirement for websocket upgrade request on __vitest__api__ and __vitest_browser_api__. Token is randomly generated on the server and it's injected in ui, tester, and orchestrator html, which are not accessible from cross origin.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

fix: shouldHandle cannot be async

wip: copy isHostAllowed

chore: move code

chore: comment

wip: allow only same origin

chore: cleanup

wip: isApiRequestAllowed

chore: cleanup

wip: switch to token check

chore: unused

fix: inject VITEST_API_TOKEN in orchestrator ui

docs: add api.allowedHosts

fix: require token for __vitest_browser_api__ request

chore: cleanup

refactor: combine to isWebsocketRequestAllowed
Copy link

netlify bot commented Jan 21, 2025

Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 209bf3d
🔍 Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/679192ed55a9110008dceb49
😎 Deploy Preview https://deploy-preview-7317--vitest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@hi-ogawa hi-ogawa marked this pull request as ready for review January 21, 2025 03:40
AriPerkkio
AriPerkkio previously approved these changes Jan 21, 2025
Copy link
Member

@AriPerkkio AriPerkkio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The token protection looks good to me.

The allowedHosts part is something I don't really understand. The WS endpoints will still be responding to any client that has the token. We are not passing allowedHosts anywhere else, so users still won't be able to open Vitest UI or browser from these. I don't understand why allowedHosts is needed here.

docs/config/index.md Outdated Show resolved Hide resolved
@hi-ogawa hi-ogawa mentioned this pull request Jan 22, 2025
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants