这是indexloc提供的服务，不要输入任何密码
Skip to content

fix(oidc): ensure unique tabIds when page is duplicated (beta) #1485

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(oidc): ensure unique tabIds when page is duplicated (beta) #1485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 2 additions & 11 deletions packages/oidc-client/src/initWorker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,17 +57,8 @@ export const defaultServiceWorkerUpdateRequireCallback =
location.reload();
};

const getTabId = (configurationName: string) => {
const tabId = sessionStorage.getItem(`oidc.tabId.${configurationName}`);

if (tabId) {
return tabId;
}

const newTabId = globalThis.crypto.randomUUID();
sessionStorage.setItem(`oidc.tabId.${configurationName}`, newTabId);
return newTabId;
};
const getTabId = (configurationName: string) =>
sessionStorage.getItem(`oidc.tabId.${configurationName}`);

const sendMessageAsync =
registration =>
Expand Down
1 change: 1 addition & 0 deletions packages/oidc-client/src/keepSession.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export const tryKeepSessionAsync = async (oidc: Oidc) => {
configuration.authority,
configuration.authority_configuration,
);
await oidc.ensureUniqueTabId();
serviceWorker = await initWorkerAsync(configuration, oidc.configurationName);
if (serviceWorker) {
const { tokens } = await serviceWorker.initAsync(
Expand Down
1 change: 1 addition & 0 deletions packages/oidc-client/src/login.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ export const loginCallbackAsync =
const href = oidc.location.getCurrentHref();
const queryParams = getParseQueryStringFromLocation(href);
const sessionState = queryParams.session_state;
await oidc.ensureUniqueTabId();
const serviceWorker = await initWorkerAsync(configuration, oidc.configurationName);
let storage;
let nonceData;
Expand Down
1 change: 1 addition & 0 deletions packages/oidc-client/src/logout.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export const destroyAsync = oidc => async status => {
if (oidc.checkSessionIFrame) {
oidc.checkSessionIFrame.stop();
}
await oidc.ensureUniqueTabId();
const serviceWorker = await initWorkerAsync(oidc.configuration, oidc.configurationName);
if (!serviceWorker) {
const session = initSession(oidc.configurationName, oidc.configuration.storage);
Expand Down
47 changes: 47 additions & 0 deletions packages/oidc-client/src/oidc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@ export class Oidc {
public checkSessionIFrame: CheckSessionIFrame;
public getFetch: () => Fetch;
public location: ILOidcLocation;
public tabId: string;
private channel: BroadcastChannel;
constructor(
configuration: OidcConfiguration,
configurationName = 'default',
Expand Down Expand Up @@ -158,9 +160,52 @@ export class Oidc {
this.destroyAsync.bind(this);
this.logoutAsync.bind(this);
this.renewTokensAsync.bind(this);
this.ensureUniqueTabId.bind(this);
this.initAsync(this.configuration.authority, this.configuration.authority_configuration);
}

async ensureUniqueTabId() {
const generateUniqueTabId = () => {
const newTabId = globalThis.crypto.randomUUID();
sessionStorage.setItem(`oidc.tabId.${this.configurationName}`, newTabId);
this.tabId = newTabId;
};

if (!this.channel) {
this.channel = new BroadcastChannel(`oidc.broadcast-channel.${this.configurationName}`);
this.channel.onmessage = msg => {
const type = msg?.data?.type;
const tabId = msg?.data?.tabId;

if (tabId === this.tabId) {
if (type === 'SEARCH') {
this.channel.postMessage({ type: 'FOUND', tabId });
} else if (type === 'FOUND') {
generateUniqueTabId();
}
}
};
}

const tabId = sessionStorage.getItem(`oidc.tabId.${this.configurationName}`);

if (!tabId) {
generateUniqueTabId();
return;
}

this.channel.postMessage({ type: 'SEARCH', tabId });
await new Promise<void>(resolve =>
setTimeout(() => {
// if there is no tabId, it means that duplicate wasn't found
if (!this.tabId) {
this.tabId = tabId;
}
resolve();
}, 500),
);
}

subscribeEvents(func): string {
const id = getRandomInt(9999999999999).toString();
this.events.push({ id, func });
Expand Down Expand Up @@ -252,6 +297,7 @@ Please checkout that you are using OIDC hook inside a <OidcProvider configuratio
});
}

await this.ensureUniqueTabId();
const serviceWorker = await initWorkerAsync(this.configuration, this.configurationName);
const storage = serviceWorker ? window.localStorage : null;
return await fetchFromIssuer(this.getFetch())(
Expand Down Expand Up @@ -311,6 +357,7 @@ Please checkout that you are using OIDC hook inside a <OidcProvider configuratio
if (this.loginPromise !== null) {
return this.loginPromise;
}
await this.ensureUniqueTabId();
if (silentLoginOnly) {
this.loginPromise = defaultSilentLoginAsync(
window,
Expand Down
5 changes: 5 additions & 0 deletions packages/oidc-client/src/renewTokens.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ async function syncTokens(oidc: Oidc, forceRefresh: boolean, extras: StringMap)
extras,
);

await oidc.ensureUniqueTabId();
const serviceWorker = await initWorkerAsync(oidc.configuration, oidc.configurationName);
if (!serviceWorker) {
const session = initSession(oidc.configurationName, oidc.configuration.storage);
Expand All @@ -41,6 +42,7 @@ export async function renewTokensAndStartTimerAsync(
const lockResourcesName = `${configuration.client_id}_${oidc.configurationName}_${configuration.authority}`;

let tokens: null;
await oidc.ensureUniqueTabId();
const serviceWorker = await initWorkerAsync(oidc.configuration, oidc.configurationName);

if ((configuration?.storage === window?.sessionStorage && !serviceWorker) || !navigator.locks) {
Expand Down Expand Up @@ -120,6 +122,7 @@ export const syncTokensInfoAsync =
configuration.authority,
configuration.authority_configuration,
);
await oidc.ensureUniqueTabId();
const serviceWorker = await initWorkerAsync(configuration, configurationName);
if (serviceWorker) {
const { status, tokens } = await serviceWorker.initAsync(
Expand Down Expand Up @@ -214,6 +217,7 @@ const synchroniseTokensAsync =
const localsilentLoginAsync = async () => {
try {
let loginParams;
await oidc.ensureUniqueTabId();
const serviceWorker = await initWorkerAsync(configuration, oidc.configurationName);
if (serviceWorker) {
loginParams = serviceWorker.getLoginParams();
Expand Down Expand Up @@ -376,6 +380,7 @@ const synchroniseTokensAsync =
}
updateTokens(tokenResponse.data);
if (tokenResponse.demonstratingProofOfPossessionNonce) {
await oidc.ensureUniqueTabId();
const serviceWorker = await initWorkerAsync(configuration, oidc.configurationName);
if (serviceWorker) {
await serviceWorker.setDemonstratingProofOfPossessionNonce(
Expand Down