Skip to content

Support non-JWT refresh tokens in Keycloak. #152

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
benzitohhh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support non-JWT refresh tokens in Keycloak. #152

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
6 changes: 6 additions & 0 deletions lib/keycloak.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,12 @@ export interface KeycloakInitOptions {
*/
messageReceiveTimeout?: number

/**
* Configures whether the adapter should include the refresh token in the JWT.
* @default true
*/
refreshTokenIsJWT?: boolean

/**
* When onLoad is 'login-required', sets the 'ui_locales' query param in compliance with section 3.1.2.1
* of the OIDC 1.0 specification.
Expand Down
12 changes: 11 additions & 1 deletion lib/keycloak.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ export default class Keycloak {
/** @type {string=} */
scope;
messageReceiveTimeout = 10000;
/** @type {boolean=} */
refreshTokenIsJWT;
/** @type {string=} */
idToken;
/** @type {KeycloakTokenParsed=} */
Expand Down Expand Up @@ -272,6 +274,12 @@ export default class Keycloak {
this.messageReceiveTimeout = initOptions.messageReceiveTimeout;
}

if (typeof initOptions.refreshTokenIsJWT === 'boolean') {
this.refreshTokenIsJWT = initOptions.refreshTokenIsJWT;
} else {
this.refreshTokenIsJWT = true;
}

await this.#loadConfig();
await this.#check3pCookiesSupported()
await this.#processInit(initOptions);
Expand Down Expand Up @@ -1535,7 +1543,9 @@ export default class Keycloak {

if (refreshToken) {
this.refreshToken = refreshToken;
this.refreshTokenParsed = decodeToken(refreshToken);
if (this.refreshTokenIsJWT === true) {
this.refreshTokenParsed = decodeToken(refreshToken);
}
} else {
delete this.refreshToken;
delete this.refreshTokenParsed;
Expand Down