SOAuth httpx client hardcodes an internal NERSC identity server URL
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 58/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- python
- Domain
- authentication, documentation
Research direction
Start with soauth/toolkit/client.py around the SOAuth identity_server default and compare it with the docs/api_keys.md example at lines 130–136. Determine how deployments should provide the identity server, then update the client behavior and documentation so non-NERSC users are not directed to an undocumented internal URL.
Written by the indexing model from the issue text.
Description
Summary: soauth/toolkit/client.py's SOAuth class defaults the identity_server to a hardcoded internal NERSC URL. The documentation for using SOAuth never mentions this parameter, making the client unusable out-of-the-box for any other SOAuth deployment.
Details:
soauth/toolkit/client.py (line 109): identity_server = "https://ingress.simonsobs-identity.production.svc.spin.nersc.org"
docs/api_keys.md example (lines 130–136):
Python
client = httpx.Client(
base_url="https://hippo.simonsobs.org",
auth=SOAuth(TOKEN_TAG)
)
— No mention of identity_server parameter
Any user not on NERSC's internal network would need to pass identity_server=... explicitly, but this is not documented at all. The token tag registered via soauth register also stores no identity server information.
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from simonsobs/soauth
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
All issues in simonsobs/soauth
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100