feat: expose id token #68
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit exposes the id token in the callback method. The id token is useful because it acts as proof that the user has been authenticated by sgID. Some relying parties want to store the id token as part of their audit trail. This is why we're exposing the id token here.
This commit modifies the implementation for the check on whether the id token exists, or is valid, so that it is consistent with our implementation strategy detailed here: https://www.notion.so/opengov/SDK-implementation-requirements-1f9b7cbd2bd4406b85d6645fe3e365dd Mainly, it checks that the ID token is a non-empty string, and ensures that the error message thrown is the same.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR does 2 things:
1. Expose the ID token as part of the
callback()methodCurrently, we only expose the
suband access token after performing all the requisite checks on the ID token. But the id token is useful because it acts as proof that the user has been authenticated by sgID. Some relying parties want to storethe ID token as part of their audit trail. This is why we're exposing the ID token here.
2. Perform validation on the id token in a manner consistent across SDKs
Validation is done according to the SDK implementation strategy here: https://www.notion.so/opengov/SDK-implementation-requirements-1f9b7cbd2bd4406b85d6645fe3e365dd
Note that in this case, the
openid-clientlibrary does validation on the ID token for us, so behavior deviates from the Python SDK.Tests
idTokenis received with sgid-demo-frontend-spa and the Express example in this repo.