Skip to content

fix: correct the JWK env var examples/docs #2022

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.

Sign up for GitHub

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

Merged
pjenvey merged 1 commit into from
Jan 26, 2026
Merged

fix: correct the JWK env var examples/docs #2022

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions tools/tokenserver/loadtests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,16 +77,16 @@ Ex. `poetry run python locustfile.py`

```sh
# Should be set to the "n" component of the JWK
SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK_N
SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__N
# Should be set to the "e" component of the JWK (this value should almost always be "AQAB")
SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK_E
SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK_KTY=RSA
SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK_USE=sig
SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK_ALG=RS256
SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__E
SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__KTY=RSA
SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__USE=sig
SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__ALG=RS256

# These two environment variables don't affect the load tests, but they need to be set:
SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK_KID=""
SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK_FXA_CREATED_AT=0
SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__KID=""
SYNC_TOKENSERVER__FXA_OAUTH_PRIMARY_JWK__FXA_CREATED_AT=0
```

Note that, because these settings cache the JWK used to verify OAuth tokens, no verification requests will be made to FxA, so the value of `SYNC_TOKENSERVER__FXA_OAUTH_VERIFIER_URL` does not matter; however, Tokenserver expects it to be set, so setting it to something like `http://localhost` will suffice.
Expand Down
2 changes: 1 addition & 1 deletion tools/tokenserver/loadtests/locustfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
TOKENSERVER_PATH = "/1.0/sync/1.5"

# This is a private key used to "forge" valid tokens. The associated public
# key must be set using the SYNC_TOKENSERVER__FXA_PRIMARY_JWK_* environment
# key must be set using the SYNC_TOKENSERVER__FXA_PRIMARY_JWK__* environment
# variables on Tokenserver.
VALID_OAUTH_PRIVATE_KEY = private_key = serialization.load_pem_private_key(
open(os.environ["OAUTH_PEM_FILE"], "rb").read(),
Expand Down
Loading