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: adding support for refresh tokens #51

Merged
merged 2 commits into from
Jun 27, 2024

Conversation

aversini
Copy link
Collaborator

@aversini aversini commented Jun 27, 2024

Summary by CodeRabbit

  • New Features

    • Added support for authorization code flow with PKCE in the authentication process.
    • Introduced support for refresh tokens to prolong sessions without re-authentication.
  • Enhancements

    • Login functionality now accepts an additional AUTH_TYPES.CODE parameter for enhanced security.
    • Service calls now include a clientId parameter for better client-specific authentication handling.
  • Bug Fixes

    • Improved the reliability of PKCE challenge verification by optimizing the comparison logic.
    • Refined the logout process to manage refresh tokens along with access and id tokens.

Copy link

coderabbitai bot commented Jun 27, 2024

Warning

Review failed

The pull request is closed.

Walkthrough

The recent updates enhance authentication by incorporating refresh tokens, adding new constants, and reorganizing code for better clarity and functionality. Key changes involve updating function signatures, adjusting the login process to include AUTH_TYPES.CODE, and modifying the way token challenges are verified. Additionally, a new constant REFRESH was added for token expiration, and the authentication workflow was expanded to handle refresh tokens more robustly.

Changes

Files Change Summary
examples/code-flow/src/main.tsx Added AUTH_TYPES.CODE to login function and updated useAuth import.
packages/auth-common/src/components/constants.ts Introduced REFRESH constant to TOKEN_EXPIRATION object.
packages/auth-common/src/components/pkce.ts Reordered comparison in verifyChallenge function for direct comparison.
packages/auth-provider/src/common/types.d.ts Added clientId field to ServiceCallProps type.
packages/auth-provider/src/common/utilities.ts Added API_TYPE, updated serviceCall, logoutUser, authenticateUser, and introduced getPreAuthCode.
packages/auth-provider/src/components/AuthContext.ts Removed idTokenClaims from AuthContext.
packages/auth-provider/src/components/AuthProvider.tsx Imported AUTH_TYPES, pkceChallengePair, getPreAuthCode; adjusted authentication and logout processes.

Sequence Diagrams

Login and Token Handling Flow

sequenceDiagram
    participant User as User
    participant App as App
    participant AuthProvider as Auth Provider
    participant AuthBackend as Auth Backend

    User->>App: Initiates Login
    App->>AuthProvider: Call login with AUTH_TYPES.CODE
    AuthProvider->>AuthBackend: Request PreAuth Code
    AuthBackend-->>AuthProvider: Returns PreAuth Code
    AuthProvider->>AuthBackend: Request Access and Refresh Tokens
    AuthBackend-->>AuthProvider: Returns Access and Refresh Tokens
    AuthProvider-->>App: Provides Tokens
    App-->>User: Tokens Stored (Login Successful)
Loading

Token Verification and Refresh Flow

sequenceDiagram
    participant App as App
    participant AuthProvider as Auth Provider
    participant AuthBackend as Auth Backend

    App->>AuthProvider: Initiates Token Verification
    AuthProvider->>AuthBackend: Verifies Access Token
    AuthBackend-->>AuthProvider: Token Verification Result
    AuthProvider->>AuthBackend: Refresh Token (if necessary)
    AuthBackend-->>AuthProvider: Returns New Tokens
    AuthProvider-->>App: Updated Tokens
    App-->>User: Session Continued
Loading

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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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: 1

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1e41e4a and 2b566bc.

Files selected for processing (6)
  • examples/code-flow/src/main.tsx (2 hunks)
  • packages/auth-common/src/components/constants.ts (1 hunks)
  • packages/auth-common/src/components/pkce.ts (1 hunks)
  • packages/auth-provider/src/common/types.d.ts (1 hunks)
  • packages/auth-provider/src/common/utilities.ts (7 hunks)
  • packages/auth-provider/src/components/AuthProvider/AuthProvider.tsx (9 hunks)
Files skipped from review due to trivial changes (1)
  • packages/auth-common/src/components/constants.ts
Additional context used
Learnings (1)
packages/auth-provider/src/components/AuthProvider/AuthProvider.tsx (1)
User: aversini
PR: aversini/auth-client#21
File: packages/auth-provider/src/components/AuthProvider/AuthProvider.tsx:1-89
Timestamp: 2024-06-24T18:39:55.099Z
Learning: Avoid detailed error logging in security-sensitive components like authentication to prevent giving potential attackers insights into the system.
Additional comments not posted (4)
packages/auth-provider/src/common/types.d.ts (1)

3-3: Addition of clientId to ServiceCallProps is appropriate.

This change is crucial for enhancing the tracking and management of client-specific data in service calls, aligning well with the PR's objectives to improve authentication mechanisms.

packages/auth-common/src/components/pkce.ts (1)

79-79: Refactoring of verifyChallenge enhances clarity.

The updated comparison logic is more concise and straightforward, improving readability and potentially efficiency in the PKCE flow.

examples/code-flow/src/main.tsx (1)

1-1: Inclusion of AUTH_TYPES in imports and use in login enhances security.

The addition of AUTH_TYPES.CODE to the login process supports a more robust and secure authentication mechanism, likely utilizing PKCE. This is a significant enhancement in line with modern security practices.

Also applies to: 15-15

packages/auth-provider/src/common/utilities.ts (1)

2-2: Enhancements in utilities.ts support new refresh token functionality and client-specific handling.

The addition of clientId and refreshToken in various function signatures, and the introduction of API_TYPE constants, significantly bolster the authentication and service call mechanisms. These changes are crucial for supporting the new refresh token functionality and enhancing client-specific data handling.

Also applies to: 15-19, 28-28, 49-60, 64-68, 88-111, 123-123, 139-164

Copy link

Bundle Size

Status File Size (Gzip) Limits
index.js 8.84 KB (+668 B +7.97%) 9 kb

Overall bundle size: 8.84 KB (+668 B +7.97%)
Overall status: ✅

@aversini aversini merged commit 93c70b5 into main Jun 27, 2024
4 checks passed
@aversini aversini deleted the feat-adding-support-for-refresh-tokens branch June 27, 2024 22:50
@aversini aversini mentioned this pull request Jun 27, 2024
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