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.

Sign up for GitHub

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

Jump to bottom

1771 - Set id_token_hint when logging out #1780

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+39 −3
Open

1771 - Set id_token_hint when logging out #1780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a56d70a
Add tests to verify id_token_hint
simon-debruijn Oct 16, 2024
66cbfd5
Include id_token_hint in searchParams for endSessionUrl
simon-debruijn Oct 16, 2024
f3ca537
Run pretty
simon-debruijn Oct 16, 2024
38851fd
Remove newline
simon-debruijn Oct 16, 2024
8523ff4
Merge branch 'main' into 1771-set-idtokenhint-when-logging-out
simon-debruijn Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/auth0-session/client/edge-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ export class EdgeClient extends AbstractClient {
this.config.idpLogout &&
(this.config.auth0Logout || (issuerUrl.hostname.match('\\.auth0\\.com$') && this.config.auth0Logout !== false))
) {
const { id_token_hint, post_logout_redirect_uri, ...extraParams } = parameters;
const { post_logout_redirect_uri, ...extraParams } = parameters;
const auth0LogoutUrl: URL = new URL(urlJoin(as.issuer, '/v2/logout'));
post_logout_redirect_uri && auth0LogoutUrl.searchParams.set('returnTo', post_logout_redirect_uri);
auth0LogoutUrl.searchParams.set('client_id', this.config.clientID);
Expand Down
2 changes: 1 addition & 1 deletion src/auth0-session/client/node-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ export class NodeClient extends AbstractClient {
) {
Object.defineProperty(this.client, 'endSessionUrl', {
value(params: EndSessionParameters) {
const { id_token_hint, post_logout_redirect_uri, ...extraParams } = params;
const { post_logout_redirect_uri, ...extraParams } = params;
const parsedUrl = new URL(urlJoin(issuer.metadata.issuer, '/v2/logout'));
parsedUrl.searchParams.set('client_id', config.clientID);
post_logout_redirect_uri && parsedUrl.searchParams.set('returnTo', post_logout_redirect_uri);
Expand Down
18 changes: 18 additions & 0 deletions tests/auth0-session/client/edge-client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,24 @@ describe('edge client', function () {
);
});

it('should create custom logout for auth0 with id_token_hint', async function () {
nock('https://test.eu.auth0.com')
.get('/.well-known/openid-configuration')
.reply(200, { ...wellKnown, issuer: 'https://test.eu.auth0.com/', end_session_endpoint: undefined });
nock('https://test.eu.auth0.com').get('/.well-known/jwks.json').reply(200, jwks);

const client = await getClient({
issuerBaseURL: 'https://test.eu.auth0.com',
idpLogout: true,
});

const idToken = await makeIdToken()

await expect(client.endSessionUrl({ post_logout_redirect_uri: 'foo', id_token_hint: idToken })).resolves.toEqual(
`https://test.eu.auth0.com/v2/logout?returnTo=foo&client_id=__test_client_id__&id_token_hint=${idToken}`
);
});

it('should remove null params from oidc logout endpoint', async function () {
const client = await getClient({ ...defaultConfig, idpLogout: true });
await expect(client.endSessionUrl({ foo: null } as any)).resolves.toEqual(
Expand Down
20 changes: 19 additions & 1 deletion tests/auth0-session/client/node-client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import nock from 'nock';
import { getConfig, ConfigParameters } from '../../../src/auth0-session';
import { jwks } from '../fixtures/cert';
import { jwks, makeIdToken } from '../fixtures/cert';
import pkg from '../../../package.json';
import wellKnown from '../fixtures/well-known.json';
import version from '../../../src/version';
Expand Down Expand Up @@ -180,6 +180,24 @@ describe('node client', function () {
);
});

it('should create custom logout for auth0 with id_token_hint', async function () {
nock('https://test.eu.auth0.com')
.get('/.well-known/openid-configuration')
.reply(200, { ...wellKnown, issuer: 'https://test.eu.auth0.com/', end_session_endpoint: undefined });
nock('https://test.eu.auth0.com').get('/.well-known/jwks.json').reply(200, jwks);

const client = await getClient({
issuerBaseURL: 'https://test.eu.auth0.com',
idpLogout: true,
});

const idToken = await makeIdToken()

await expect(client.endSessionUrl({ post_logout_redirect_uri: 'foo', id_token_hint: idToken })).resolves.toEqual(
`https://test.eu.auth0.com/v2/logout?client_id=__test_client_id__&returnTo=foo&id_token_hint=${idToken}`
);
});

it('should handle limited openid-configuration', async function () {
nock('https://op2.example.com')
.get('/.well-known/openid-configuration')
Expand Down