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

bug: prevent expiry exception when reading id token claims #61

Merged
merged 1 commit into from
May 15, 2024

Conversation

coel
Copy link
Member

@coel coel commented May 15, 2024

Explain your changes

Since changes in #46 there is potential to exception when the ID token has expired when we previously did not. It is not necessarily wrong to read from an expired ID token as long as it was valid when the session started. A future feature would be to query for fresh data when expired.

Checklist

🛟 If you need help, consider asking for advice over in the Kinde community.

Copy link

coderabbitai bot commented May 15, 2024

Walkthrough

The update to the getClaimValue function in token-claims.ts introduces a conditional argument to the jwtVerify function call. This change ensures that when the token type is id_token, an additional option { currentDate: new Date(0) } is passed to the verification process, enhancing the flexibility and accuracy of the token validation based on its type.

Changes

File Path Change Summary
lib/sdk/utilities/token-claims.ts Modified getClaimValue to include a conditional argument in the jwtVerify function call for id_token.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 264baaa and 93ff59e.
Files selected for processing (1)
  • lib/sdk/utilities/token-claims.ts (1 hunks)
Additional comments not posted (6)
lib/sdk/utilities/token-claims.ts (6)

21-21: Ensure the currentDate option is used correctly to prevent expiry exceptions.

The change to include { currentDate: new Date(0) } when the type is 'id_token' ensures that the token verification does not fail due to expiry. This is a valid approach to handle the described issue.


Line range hint 31-35: Function getClaim correctly integrates with the modified getClaimValue.

The function correctly calls getClaimValue and returns the expected object structure.


Line range hint 45-54: Function getPermission correctly integrates with the modified getClaimValue.

The function correctly retrieves permissions and organization code using getClaimValue.


Line range hint 63-67: Function getOrganization correctly integrates with the modified getClaimValue.

The function correctly retrieves the organization code using getClaimValue.


Line range hint 76-85: Function getPermissions correctly integrates with the modified getClaimValue.

The function correctly retrieves permissions and organization code using getClaimValue.


Line range hint 94-98: Function getUserOrganizations correctly integrates with the modified getClaimValue.

The function correctly retrieves organization codes using getClaimValue.

@DanielRivers DanielRivers merged commit 2b2a26d into main May 15, 2024
2 checks passed
@DanielRivers DanielRivers deleted the leo/id_expiry branch May 15, 2024 10:03
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.

2 participants