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

feat: added checkAudience and validateToken methods #3

Merged
merged 3 commits into from
Apr 23, 2024

Conversation

DanielRivers
Copy link
Contributor

@DanielRivers DanielRivers commented Apr 23, 2024

Explain your changes

  • Feat: Adds helper methods checkAudience and validateToken
  • small refactors
  • fix: expired token check

Checklist

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

Summary by CodeRabbit

  • New Features

    • Introduced new functions to check token audience and validate JWT tokens, enhancing security and usability.
    • Added a new dependency to support JWT token validation.
  • Bug Fixes

    • Corrected the property naming and initialization for domain configuration to ensure consistency and correct usage of environment variables.
    • Updated token expiration logic to accurately determine if a token has expired.
  • Refactor

    • Updated import paths and methods for better code maintainability and clarity.

@DanielRivers DanielRivers merged commit 2a206ca into main Apr 23, 2024
@DanielRivers DanielRivers deleted the feat/add-helper-methods branch April 23, 2024 15:23
Copy link
Contributor

coderabbitai bot commented Apr 23, 2024

Walkthrough

The recent updates focus on improving consistency in naming conventions and enhancing security features in the codebase. Key changes include renaming a configuration property, updating import paths, adding new utility functions, and improving token validation logic. Additionally, a new dependency has been introduced to assist with JWT verification, ensuring robust authentication mechanisms.

Changes

File Change Summary
lib/config.ts Updated kinde_domain to kindeDomain and corrected its assignment to process.env.KINDE_DOMAIN.
lib/utilities/getToken.ts Changed import path for hasTokenExpired function.
lib/utilities/index.ts Added checkAudience and validateToken to exports.
.../token/checkAudience.ts Added a check for decoded.aud presence before using includes.
.../token/hasTokenExpired.ts Revised token expiration check logic to compare against current time.
.../token/validateToken.ts Introduced JWT validation using RSA verification.
package.json Added aws-jwt-verify version ^4.0.1.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between aaac9ba and 86583bf.
Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !pnpm-lock.yaml
Files selected for processing (7)
  • lib/config.ts (2 hunks)
  • lib/utilities/getToken.ts (1 hunks)
  • lib/utilities/index.ts (1 hunks)
  • lib/utilities/token/checkAudience.ts (1 hunks)
  • lib/utilities/token/hasTokenExpired.ts (1 hunks)
  • lib/utilities/token/validateToken.ts (1 hunks)
  • package.json (1 hunks)
Additional comments not posted (7)
lib/utilities/index.ts (2)

4-5: Imports for checkAudience and validateToken are correctly added. Ensure these modules are properly implemented.


7-7: Export statement correctly includes the new functions. Ensure that all dependent modules update their imports accordingly.

lib/utilities/token/hasTokenExpired.ts (1)

12-12: The updated expiration check logic is correct and aligns with standard practices for JWT expiration handling.

lib/utilities/token/checkAudience.ts (1)

18-18: The addition of a safe navigation operator (?.) before calling includes on decoded.aud is a good practice to prevent runtime errors.

package.json (1)

32-32: The addition of aws-jwt-verify at version ^4.0.1 is appropriate for JWT verification functionality. Ensure compatibility with other project dependencies.

lib/config.ts (1)

10-23: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [13-33]

The update to use kindeDomain and its assignment from an environment variable enhances configuration consistency and security by not hardcoding sensitive information.

lib/utilities/getToken.ts (1)

7-7: Correct update of the import statement for hasTokenExpired. This change ensures that the correct module is used for token expiration checks.


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
Contributor

@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

Out of diff range and nitpick comments (1)
lib/utilities/token/validateToken.ts (1)

4-26: The implementation of validateToken correctly sets up and uses JwtRsaVerifier. Ensure that error handling is robust and consider enhancing the log statement to include more context about the error.

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.

1 participant