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

Resolve console & myaccount callback urls based on a toml config #2301

Merged
merged 5 commits into from
Jan 1, 2024
Merged

Resolve console & myaccount callback urls based on a toml config #2301

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8452d67
Resolve console & myaccount callback urls based on a toml config
UdeshAthukorala Dec 13, 2023
66e9b32
Refactor the callback url resolving logic
UdeshAthukorala Dec 15, 2023
9ea5cd2
Bump framework version
UdeshAthukorala Dec 29, 2023
b30b60f
Add test dependency
UdeshAthukorala Dec 29, 2023
d132be0
Merge branch 'master' of https://github.com/wso2-extensions/identity-…
UdeshAthukorala Dec 30, 2023
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
66 changes: 66 additions & 0 deletions ...2.carbon.identity.oauth/src/main/java/org/wso2/carbon/identity/oauth/dao/OAuthAppDAO.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@
import static org.wso2.carbon.identity.oauth.common.OAuthConstants.OIDCConfigProperties.TOKEN_REVOCATION_WITH_IDP_SESSION_TERMINATION;
import static org.wso2.carbon.identity.oauth.common.OAuthConstants.OIDCConfigProperties.TOKEN_TYPE;
import static org.wso2.carbon.identity.oauth2.util.OAuth2Util.OPENID_CONNECT_AUDIENCE;
import static org.wso2.carbon.identity.oauth2.util.OAuth2Util.getConsoleCallbackFromServerConfig;
import static org.wso2.carbon.identity.oauth2.util.OAuth2Util.getMyAccountCallbackFromServerConfig;

/**
* JDBC Based data access layer for OAuth Consumer Applications.
Expand Down Expand Up @@ -332,6 +334,18 @@ public OAuthAppDO[] getOAuthConsumerAppsOfUser(String username, int tenantId) th
oauthApp.setCallbackUrl(
ApplicationMgtUtil.resolveOriginUrlFromPlaceholders(rSet.getString(5)));
}
if (ApplicationMgtUtil.isConsole(oauthApp.getApplicationName())) {
String consoleCallbackUrl = getConsoleCallbackFromServerConfig(tenantDomain);
if (StringUtils.isNotBlank(consoleCallbackUrl)) {
oauthApp.setCallbackUrl(consoleCallbackUrl);
}
}
if (ApplicationMgtUtil.isMyAccount(oauthApp.getApplicationName())) {
String myAccountCallbackUrl = getMyAccountCallbackFromServerConfig(tenantDomain);
if (StringUtils.isNotBlank(myAccountCallbackUrl)) {
oauthApp.setCallbackUrl(myAccountCallbackUrl);
}
}

oauthApp.setGrantTypes(rSet.getString(6));
oauthApp.setId(rSet.getInt(7));
Expand Down Expand Up @@ -440,6 +454,19 @@ public OAuthAppDO getAppInformation(String consumerKey, int tenantId) throws
oauthApp.setCallbackUrl(
ApplicationMgtUtil.resolveOriginUrlFromPlaceholders(rSet.getString(5)));
}
String tenantDomain = IdentityTenantUtil.getTenantDomain(tenantId);
if (ApplicationMgtUtil.isConsole(oauthApp.getApplicationName())) {
String consoleCallbackUrl = getConsoleCallbackFromServerConfig(tenantDomain);
if (StringUtils.isNotBlank(consoleCallbackUrl)) {
oauthApp.setCallbackUrl(consoleCallbackUrl);
}
}
if (ApplicationMgtUtil.isMyAccount(oauthApp.getApplicationName())) {
String myAccountCallbackUrl = getMyAccountCallbackFromServerConfig(tenantDomain);
if (StringUtils.isNotBlank(myAccountCallbackUrl)) {
oauthApp.setCallbackUrl(myAccountCallbackUrl);
}
}

authenticatedUser.setTenantDomain(IdentityTenantUtil.getTenantDomain(rSet.getInt(6)));
authenticatedUser.setUserStoreDomain(rSet.getString(7));
Expand Down Expand Up @@ -528,6 +555,19 @@ public OAuthAppDO getAppInformation(String consumerKey, AccessTokenDO accessToke
oauthApp.setCallbackUrl(
ApplicationMgtUtil.resolveOriginUrlFromPlaceholders(rSet.getString(CALLBACK_URL)));
}
String tenantDomain = IdentityTenantUtil.getTenantDomain(rSet.getInt(TENANT_ID));
if (ApplicationMgtUtil.isConsole(oauthApp.getApplicationName())) {
String consoleCallbackUrl = getConsoleCallbackFromServerConfig(tenantDomain);
if (StringUtils.isNotBlank(consoleCallbackUrl)) {
oauthApp.setCallbackUrl(consoleCallbackUrl);
}
}
if (ApplicationMgtUtil.isMyAccount(oauthApp.getApplicationName())) {
String myAccountCallbackUrl = getMyAccountCallbackFromServerConfig(tenantDomain);
if (StringUtils.isNotBlank(myAccountCallbackUrl)) {
oauthApp.setCallbackUrl(myAccountCallbackUrl);
}
}

authenticatedUser.setTenantDomain(IdentityTenantUtil.getTenantDomain(rSet.getInt(TENANT_ID)));
authenticatedUser.setUserStoreDomain(rSet.getString(USER_DOMAIN));
Expand Down Expand Up @@ -602,6 +642,19 @@ public OAuthAppDO[] getAppsForConsumerKey(String consumerKey)
oauthApp.setCallbackUrl(
ApplicationMgtUtil.resolveOriginUrlFromPlaceholders(rSet.getString(CALLBACK_URL)));
}
String tenantDomain = IdentityTenantUtil.getTenantDomain(rSet.getInt(TENANT_ID));
if (ApplicationMgtUtil.isConsole(oauthApp.getApplicationName())) {
String consoleCallbackUrl = getConsoleCallbackFromServerConfig(tenantDomain);
if (StringUtils.isNotBlank(consoleCallbackUrl)) {
oauthApp.setCallbackUrl(consoleCallbackUrl);
}
}
if (ApplicationMgtUtil.isMyAccount(oauthApp.getApplicationName())) {
String myAccountCallbackUrl = getMyAccountCallbackFromServerConfig(tenantDomain);
if (StringUtils.isNotBlank(myAccountCallbackUrl)) {
oauthApp.setCallbackUrl(myAccountCallbackUrl);
}
}

authenticatedUser.setTenantDomain(IdentityTenantUtil.getTenantDomain(rSet.getInt(TENANT_ID)));
authenticatedUser.setUserStoreDomain(rSet.getString(USER_DOMAIN));
Expand Down Expand Up @@ -686,6 +739,19 @@ public OAuthAppDO getAppInformationByAppName(String appName) throws
oauthApp.setCallbackUrl(
ApplicationMgtUtil.resolveOriginUrlFromPlaceholders(rSet.getString(6)));
}
String tenantDomain = IdentityTenantUtil.getTenantDomain(tenantID);
if (ApplicationMgtUtil.isConsole(oauthApp.getApplicationName())) {
String consoleCallbackUrl = getConsoleCallbackFromServerConfig(tenantDomain);
if (StringUtils.isNotBlank(consoleCallbackUrl)) {
oauthApp.setCallbackUrl(consoleCallbackUrl);
}
}
if (ApplicationMgtUtil.isMyAccount(oauthApp.getApplicationName())) {
String myAccountCallbackUrl = getMyAccountCallbackFromServerConfig(tenantDomain);
if (StringUtils.isNotBlank(myAccountCallbackUrl)) {
oauthApp.setCallbackUrl(myAccountCallbackUrl);
}
}

oauthApp.setGrantTypes(rSet.getString(7));
oauthApp.setId(rSet.getInt(8));
Expand Down
3 changes: 3 additions & 0 deletions ....carbon.identity.oauth/src/main/java/org/wso2/carbon/identity/oauth2/OAuth2Constants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ public static class TokenBinderType {
public static final String OAUTH_TOKEN_PERSISTENCE_ENABLE = "OAuth.TokenPersistence.Enable";
public static final String OAUTH_CODE_PERSISTENCE_ENABLE = "OAuth.EnableAuthCodePersistence";
public static final String OAUTH_ENABLE_REVOKE_TOKEN_HEADERS = "OAuth.EnableRevokeTokenHeadersInResponse";
public static final String CONSOLE_CALLBACK_URL_FROM_SERVER_CONFIGS = "Console.CallbackURL";
public static final String MY_ACCOUNT_CALLBACK_URL_FROM_SERVER_CONFIGS = "MyAccount.CallbackURL";
public static final String TENANT_DOMAIN_PLACEHOLDER = "{TENANT_DOMAIN}";

/**
* Constants for global role based scope issuer.
Expand Down
50 changes: 50 additions & 0 deletions ....carbon.identity.oauth/src/main/java/org/wso2/carbon/identity/oauth2/util/OAuth2Util.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5159,4 +5159,54 @@ public static boolean isApiBasedAuthSupportedGrant(HttpServletRequest request) {
return StringUtils.equals(OAuthConstants.CODE,
request.getParameter(OAuthConstants.OAuth20Params.RESPONSE_TYPE));
}

/**
* Resolve Console application callback url for a specific tenant based on the callback url configured in toml.
*
* @param tenantDomain Tenant domain.
* @return Console callback url.
*/
public static String getConsoleCallbackFromServerConfig(String tenantDomain) {

String callbackUrl = IdentityUtil.getProperty(OAuth2Constants.CONSOLE_CALLBACK_URL_FROM_SERVER_CONFIGS);
if (StringUtils.isNotBlank(callbackUrl)) {
// If callback is a regex pattern, return it as it is.
if (callbackUrl.startsWith(OAuthConstants.CALLBACK_URL_REGEXP_PREFIX)) {
return callbackUrl;
}

if (MultitenantConstants.SUPER_TENANT_DOMAIN_NAME.equals(tenantDomain)) {
callbackUrl = callbackUrl.replace("/t/" + OAuth2Constants.TENANT_DOMAIN_PLACEHOLDER, "");
} else {
callbackUrl = callbackUrl.replace(OAuth2Constants.TENANT_DOMAIN_PLACEHOLDER, tenantDomain);
}
return callbackUrl;
}
return null;
}

/**
* Resolve MyAccount application callback url for a specific tenant based on the callback url configured in toml.
*
* @param tenantDomain Tenant domain.
* @return MyAccount callback url.
*/
public static String getMyAccountCallbackFromServerConfig(String tenantDomain) {

String callbackUrl = IdentityUtil.getProperty(OAuth2Constants.MY_ACCOUNT_CALLBACK_URL_FROM_SERVER_CONFIGS);
if (StringUtils.isNotBlank(callbackUrl)) {
// If callback is a regex pattern, return it as it is.
if (callbackUrl.startsWith(OAuthConstants.CALLBACK_URL_REGEXP_PREFIX)) {
return callbackUrl;
}

if (MultitenantConstants.SUPER_TENANT_DOMAIN_NAME.equals(tenantDomain)) {
callbackUrl = callbackUrl.replace("/t/" + OAuth2Constants.TENANT_DOMAIN_PLACEHOLDER, "");
} else {
callbackUrl = callbackUrl.replace(OAuth2Constants.TENANT_DOMAIN_PLACEHOLDER, tenantDomain);
}
return callbackUrl;
}
return null;
}
}
Loading