8000 Allow Keycloak JS to be initialized without passing options by jonkoops · Pull Request #33950 · keycloak/keycloak · GitHub
[go: up one dir, main page]
Skip to content

Allow Keycloak JS to be initialized without passing options #33950

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

Merged
jonkoops merged 1 commit into from
Oct 15, 2024
Merged

Allow Keycloak JS to be initialized without passing options #33950

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
2 changes: 1 addition & 1 deletion js/libs/keycloak-js/lib/keycloak.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@ declare class Keycloak {
* @param initOptions Initialization options.
* @returns A promise to set functions to be invoked on success or error.
*/
init(initOptions: KeycloakInitOptions): Promise<boolean>;
init(initOptions?: KeycloakInitOptions): Promise<boolean>;

/**
* Redirects to login form.
Expand Down
218 changes: 107 additions & 111 deletions js/libs/keycloak-js/lib/keycloak.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ function Keycloak (config) {
);
}

kc.init = function (initOptions) {
kc.init = function (initOptions = {}) {
if (kc.didInitialize) {
throw new Error("A 'Keycloak' instance can only be initialized once.");
}
Expand All @@ -72,9 +72,9 @@ function Keycloak (config) {
callbackStorage = createCallbackStorage();
var adapters = ['default', 'cordova', 'cordova-native'];

if (initOptions && adapters.indexOf(initOptions.adapter) > -1) {
if (adapters.indexOf(initOptions.adapter) > -1) {
adapter = loadAdapter(initOptions.adapter);
} else if (initOptions && typeof initOptions.adapter === "object") {
} else if (typeof initOptions.adapter === "object") {
adapter = initOptions.adapter;
} else {
if (window.Cordova || window.cordova) {
Expand All @@ -84,101 +84,99 @@ function Keycloak (config) {
}
}

if (initOptions) {
if (typeof initOptions.useNonce !== 'undefined') {
useNonce = initOptions.useNonce;
}

if (typeof initOptions.checkLoginIframe !== 'undefined') {
loginIframe.enable = initOptions.checkLoginIframe;
}
if (typeof initOptions.useNonce !== 'undefined') {
useNonce = initOptions.useNonce;
}

if (initOptions.checkLoginIframeInterval) {
loginIframe.interval = initOptions.checkLoginIframeInterval;
}
if (typeof initOptions.checkLoginIframe !== 'undefined') {
loginIframe.enable = initOptions.checkLoginIframe;
}

if (initOptions.onLoad === 'login-required') {
kc.loginRequired = true;
}
if (initOptions.checkLoginIframeInterval) {
loginIframe.interval = initOptions.checkLoginIframeInterval;
}

if (initOptions.responseMode) {
if (initOptions.responseMode === 'query' || initOptions.responseMode === 'fragment') {
kc.responseMode = initOptions.responseMode;
} else {
throw 'Invalid value for responseMode';
}
}
if (initOptions.onLoad === 'login-required') {
kc.loginRequired = true;
}

if (initOptions.flow) {
switch (initOptions.flow) {
case 'standard':
kc.responseType = 'code';
break;
case 'implicit':
kc.responseType = 'id_token token';
break;
case 'hybrid':
kc.responseType = 'code id_token token';
break;
default:
throw 'Invalid value for flow';
}
kc.flow = initOptions.flow;
if (initOptions.responseMode) {
if (initOptions.responseMode === 'query' || initOptions.responseMode === 'fragment') {
kc.responseMode = initOptions.responseMode;
} else {
throw 'Invalid value for responseMode';
}
}

if (initOptions.timeSkew != null) {
kc.timeSkew = initOptions.timeSkew;
if (initOptions.flow) {
switch (initOptions.flow) {
case 'standard':
kc.responseType = 'code';
break;
case 'implicit':
kc.responseType = 'id_token token';
break;
case 'hybrid':
kc.responseType = 'code id_token token';
break;
default:
throw 'Invalid value for flow';
}
kc.flow = initOptions.flow;
}

if(initOptions.redirectUri) {
kc.redirectUri = initOptions.redirectUri;
}
if (initOptions.timeSkew != null) {
kc.timeSkew = initOptions.timeSkew;
}

if (initOptions.silentCheckSsoRedirectUri) {
kc.silentCheckSsoRedirectUri = initOptions.silentCheckSsoRedirectUri;
}
if(initOptions.redirectUri) {
kc.redirectUri = initOptions.redirectUri;
}

if (typeof initOptions.silentCheckSsoFallback === 'boolean') {
kc.silentCheckSsoFallback = initOptions.silentCheckSsoFallback;
} else {
kc.silentCheckSsoFallback = true;
}
if (initOptions.silentCheckSsoRedirectUri) {
kc.silentCheckSsoRedirectUri = initOptions.silentCheckSsoRedirectUri;
}

if (typeof initOptions.pkceMethod !== "undefined") {
if (initOptions.pkceMethod !== "S256" && initOptions.pkceMethod !== false) {
throw new TypeError(`Invalid value for pkceMethod', expected 'S256' or false but got ${initOptions.pkceMethod}.`);
}
if (typeof initOptions.silentCheckSsoFallback === 'boolean') {
kc.silentCheckSsoFallback = initOptions.silentCheckSsoFallback;
} else {
kc.silentCheckSsoFallback = true;
}

kc.pkceMethod = initOptions.pkceMethod;
} else {
kc.pkceMethod = "S256";
if (typeof initOptions.pkceMethod !== "undefined") {
if (initOptions.pkceMethod !== "S256" && initOptions.pkceMethod !== false) {
throw new TypeError(`Invalid value for pkceMethod', expected 'S256' or false but got ${initOptions.pkceMethod}.`);
}

if (typeof initOptions.enableLogging === 'boolean') {
kc.enableLogging = initOptions.enableLogging;
} else {
kc.enableLogging = false;
}
kc.pkceMethod = initOptions.pkceMethod;
} else {
kc.pkceMethod = "S256";
}

if (initOptions.logoutMethod === 'POST') {
kc.logoutMethod = 'POST';
} else {
kc.logoutMethod = 'GET';
}
if (typeof initOptions.enableLogging === 'boolean') {
kc.enableLogging = initOptions.enableLogging;
} else {
kc.enableLogging = false;
}

if (typeof initOptions.scope === 'string') {
kc.scope = initOptions.scope;
}
if (initOptions.logoutMethod === 'POST') {
kc.logoutMethod = 'POST';
} else {
kc.logoutMethod = 'GET';
}

if (typeof initOptions.acrValues === 'string') {
kc.acrValues = initOptions.acrValues;
}
if (typeof initOptions.scope === 'string') {
kc.scope = initOptions.scope;
}

if (typeof initOptions.messageReceiveTimeout === 'number' && initOptions.messageReceiveTimeout > 0) {
kc.messageReceiveTimeout = initOptions.messageReceiveTimeout;
} else {
kc.messageReceiveTimeout = 10000;
}
if (typeof initOptions.acrValues === 'string') {
kc.acrValues = initOptions.acrValues;
}

if (typeof initOptions.messageReceiveTimeout === 'number' && initOptions.messageReceiveTimeout > 0) {
kc.messageReceiveTimeout = initOptions.messageReceiveTimeout;
} else {
kc.messageReceiveTimeout = 10000;
}

if (!kc.responseMode) {
Expand Down Expand Up @@ -207,7 +205,7 @@ function Keycloak (config) {
options.prompt = 'none';
}

if (initOptions && initOptions.locale) {
if (initOptions.locale) {
options.locale = initOptions.locale;
}
kc.login(options).then(function () {
Expand Down Expand Up @@ -281,42 +279,40 @@ function Keycloak (config) {
}).catch(function (error) {
initPromise.setError(error);
});
} else if (initOptions) {
if (initOptions.token && initOptions.refreshToken) {
setToken(initOptions.token, initOptions.refreshToken, initOptions.idToken);
}

if (loginIframe.enable) {
setupCheckLoginIframe().then(function() {
checkLoginIframe().then(function (unchanged) {
if (unchanged) {
kc.onAuthSuccess && kc.onAuthSuccess();
initPromise.setSuccess();
scheduleCheckIframe();
} else {
initPromise.setSuccess();
}
}).catch(function (error) {
initPromise.setError(error);
});
});
} else {
kc.updateToken(-1).then(function() {
kc.onAuthSuccess && kc.onAuthSuccess();
initPromise.setSuccess();
}).catch(function(error) {
kc.onAuthError && kc.onAuthError();
if (initOptions.onLoad) {
onLoad();
if (initOptions.token && initOptions.refreshToken) {
setToken(initOptions.token, initOptions.refreshToken, initOptions.idToken);

if (loginIframe.enable) {
setupCheckLoginIframe().then(function() {
checkLoginIframe().then(function (unchanged) {
if (unchanged) {
kc.onAuthSuccess && kc.onAuthSuccess();
initPromise.setSuccess();
scheduleCheckIframe();
} else {
initPromise.setError(error);
initPromise.setSuccess();
}
}).catch(function (error) {
initPromise.setError(error);
});
}
} else if (initOptions.onLoad) {
onLoad();
});
} else {
initPromise.setSuccess();
kc.updateToken(-1).then(function() {
kc.onAuthSuccess && kc.onAuthSuccess();
initPromise.setSuccess();
}).catch(function(error) {
kc.onAuthError && kc.onAuthError();
if (initOptions.onLoad) {
onLoad();
} else {
initPromise.setError(error);
}
});
}
} else if (initOptions.onLoad) {
onLoad();
} else {
initPromise.setSuccess();
}
Expand Down
2 changes: 1 addition & 1 deletion .../auth-server/services/testsuite-providers/src/main/resources/javascript/init-in-head.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
globalThis.output = output;
globalThis.event = event;

keycloak.init({}).then((authenticated) => {
keycloak.init().then((authenticated) => {
output('Init Success (' + (authenticated ? 'Authenticated' : 'Not Authenticated') + ')');
}).catch(function() {
output('Init Error');
Expand Down
8 changes: 4 additions & 4 deletions ...sts/base/src/main/java/org/keycloak/testsuite/util/javascript/JavascriptTestExecutor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ protected JavascriptTestExecutor(WebDriver driver, OIDCLogin loginPage) {
public JavascriptTestExecutor login() {
return login((String)null, null);
}

public JavascriptTestExecutor login(JavascriptStateValidator validator) {
return login((String)null, validator);
}
Expand Down Expand Up @@ -81,10 +81,10 @@ public JavascriptTestExecutor attachCheck3pCookiesIframeMutationObserver() {
"" +
" // Start observing the target node for configured mutations\n" +
" observer.observe(targetNode, config);");

return this;
}

public JavascriptTestExecutor login(JSObjectBuilder optionsBuilder, JavascriptStateValidator validator) {
return login(optionsBuilder.build(), validator);
}
Expand Down Expand Up @@ -203,7 +203,7 @@ public JavascriptTestExecutor init(JSObjectBuilder argumentsBuilder, JavascriptS
configure();
}

String arguments = argumentsBuilder.build();
String arguments = argumentsBuilder != null ? argumentsBuilder.build() : "";

String script = "var callback = arguments[arguments.length - 1];" +
" window.keycloak.init(" + arguments + ").then(function (authenticated) {" +
B1FE Expand Down
10 changes: 10 additions & 0 deletions ...ian/tests/base/src/test/java/org/keycloak/testsuite/javascript/JavascriptAdapterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,16 @@ public void testSilentCheckSsoWithFallbackDisabled() {
, SuiteContext.BROWSER_STRICT_COOKIES ? this::assertInitNotAuth : this::assertInitAuth);
}

@Test
public void testInitNoOptions() {
testExecutor.init(null, this::assertInitNotAuth)
.login(this::assertOnLoginPage)
.loginForm(testUser, this::assertOnTestAppUrl)
.init(null, this::assertInitAuth)
.logout(this::assertOnTestAppUrl)
.init(null, this::assertInitNotAuth);
}

@Test
public void testCheckSso() {
JSObjectBuilder checkSSO = defaultArguments().checkSSOOnLoad();
Expand Down
0