matrix-org / matrix-org/matrix-js-sdk

Authorization header would make a more sensible default than query parameter

Open
#1,658 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

T-Task X-Breaking-Change
Dominant language
TypeScript
Stars
2.2k
Forks
704
Avg merge
1d 20h
Merged PRs (30d)
40

Description

Suggestion: change the default of `useAuthorizationHeader` in client options to be `true` instead of `false`.

Access tokens going via query parameters are a risk due to them being logged in web server logs, unlike HTTP headers. It would be good to promote a more secure default while allowing query parameters to still be used if explicitly set.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the TypeScript client options definition and inspect how useAuthorizationHeader is currently applied. Confirm that the default becomes true while explicitly setting it to false still permits query parameters, then run the existing relevant tests and verify authorization tokens no longer use query parameters by default.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, authentication, security
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.