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

Add support for Federated Connection Access Token #1911

Merged

Conversation

frederikprijck
Copy link
Member

@frederikprijck frederikprijck commented Feb 12, 2025

📋 Changes

This PR adds support for getFederatedConnectionAccessToken({ connection: string; login_hint?: string }), which can be used to obtain federated connection access token using the oauth/token endpoint.

In order to retrieve a federated connection access token, we call oauth/token using the following payload:

{
  "connection": "<connection(e.g. google-oauth2)>",
  "subject_token_type": "urn:ietf:params:oauth:token-type:refresh_token",
  "subject_token": "<refresh_token>",
  "requested_token_type": "http://auth0.com/oauth/token-type/federated-connection-access-token",
  "client_id": "<client_id>",
  "client_secret": "<client_secret>",
  "grant_type": "urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token"
}

The retrieved token will also be stored in the session store, comparable to regular session information.

Stateless
As the browser has a limit to the size of the cookie, each federated connection access token is stored in its own cookie, using the __FC_{index} name.

image

When an application needs to us many access tokens, it's recommended to consider using a stateful session store.

Stateful
For the stateful session store, nothing changes other than the fact that the provided SessionData, now has an additional federatedConnectionTokenSets property, being either undefined, or an array of FederatedConnectionTokenSet.

Just like getAccessToken(), the newly added getFederatedConnectionAccessToken() can not write to the cookies when called from a Server Component, and will log a warning when either of these two methods are called from such Server Component.

📎 References

N/A

🎯 Testing

I have tested this against the only environment that has the feature enabled, and I ensured the following scenario's:

  • When not logged in, calling getFederatedConnectionAccessToken throws the MISSING_REFRESH_TOKEN error.
  • When logged in, and no Federated Connection Access Token is in the cache, a call to oauth/token is mad, the resulting access token is stored in the stateless or stateful session store and returned.
  • When logged in, and a non expired Federated Connection Access token is in the cache, no call to oauth/token is made, and the access token from the cache is returned.
  • When logged in, and an expired Federated Connection Access token is in the cache, a call to oauth/token is mad, the resulting access token is stored in the stateless or stateful session store and returned.
  • When logging out, the __FC cookies are also removed.

@codecov-commenter
Copy link

codecov-commenter commented Feb 12, 2025

Codecov Report

Attention: Patch coverage is 50.88968% with 138 lines in your changes missing coverage. Please review.

Project coverage is 72.64%. Comparing base (6487987) to head (b800720).

Files with missing lines Patch % Lines
src/server/client.ts 0.00% 103 Missing ⚠️
src/server/session/stateless-session-store.ts 67.08% 26 Missing ⚠️
src/server/auth-client.ts 89.77% 9 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##               v4    #1911      +/-   ##
==========================================
- Coverage   74.69%   72.64%   -2.05%     
==========================================
  Files          19       19              
  Lines        1379     1601     +222     
  Branches      210      232      +22     
==========================================
+ Hits         1030     1163     +133     
- Misses        342      431      +89     
  Partials        7        7              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@frederikprijck frederikprijck force-pushed the feature/federatedConn-storage-final-proposal branch from d36bba5 to 953abba Compare February 12, 2025 23:23
@frederikprijck frederikprijck force-pushed the feature/federatedConn-storage-final-proposal branch from 953abba to 0a16564 Compare February 12, 2025 23:24
@frederikprijck frederikprijck marked this pull request as ready for review February 12, 2025 23:52
@frederikprijck frederikprijck requested a review from a team as a code owner February 12, 2025 23:52
@frederikprijck frederikprijck force-pushed the feature/federatedConn-storage-final-proposal branch from 6a3579d to b800720 Compare February 12, 2025 23:56
@nandan-bhat nandan-bhat merged commit 7a253a2 into auth0:v4 Feb 13, 2025
9 of 10 checks passed
tusharpandey13 added a commit that referenced this pull request Feb 13, 2025
add test for configured params

chore: prevent open redirect with returnTo

revert pnpm lock

chore: configure eslint

chore: wire up lint to ci

chore: update lint workflow

chore: address react version warning

chore: cleanup pnpm lock formatting

chore: CodeQL fix

chore: ensure example use latest version

4.0.1

Release v4.0.1 (#1900)

Fixing broken workflow `rl secure` (#1901)

Fix: Changing the SDK version in auth-client.ts (#1902)

fix: Fixing the action `npm-publish` (#1903)

Fix: fixing release workflow (#1904)

fix: Fix npm token issue using pnpm (#1905)

Adding initial docs setup (#1892)

Reverting the changes made for release on v4 (#1907)

Testing playwright workflow (#1909)

fix: Fixing broken coverage pipeline (#1910)

Add support for Federated Connection Access Token (#1911)

Co-authored-by: Tushar Pandey <[email protected]>
tusharpandey13 added a commit that referenced this pull request Feb 13, 2025
tusharpandey13 added a commit that referenced this pull request Feb 13, 2025
tusharpandey13 added a commit that referenced this pull request Feb 13, 2025
nandan-bhat added a commit that referenced this pull request Feb 14, 2025
nandan-bhat added a commit that referenced this pull request Feb 14, 2025
nandan-bhat pushed a commit that referenced this pull request Feb 17, 2025
frederikprijck added a commit to frederikprijck/nextjs-auth0 that referenced this pull request Feb 17, 2025
nandan-bhat pushed a commit that referenced this pull request Feb 17, 2025
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.

4 participants