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

Add multiOptionURI parsing for additional query parameters #191

Merged
merged 1 commit into from
Dec 17, 2024
Merged

Add multiOptionURI parsing for additional query parameters #191

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
4 changes: 4 additions & 0 deletions ...a/org/wso2/carbon/identity/application/authenticator/oidc/OIDCAuthenticatorConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ private OIDCAuthenticatorConstants() {
public static final String POST_LOGOUT_REDIRECT_URI = "post_logout_redirect_uri";
public static final String ID_TOKEN_HINT = "id_token_hint";

public static final String MULTI_OPTION_URI = "multiOptionURI";
public static final String URI_QUERY_PARAM_DELIMITER = "&";
public static final String QUERY_PARAM_KEY_VALUE_DELIMITER = "=";

public static final String AUTH_PARAM = "$authparam";
public static final String DYNAMIC_AUTH_PARAMS_LOOKUP_REGEX = "\\$authparam\\{(\\w+)\\}";

Expand Down
53 changes: 49 additions & 4 deletions ...a/org/wso2/carbon/identity/application/authenticator/oidc/OpenIDConnectAuthenticator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,13 @@
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.LogConstants.ActionIDs.INITIATE_OUTBOUND_AUTH_REQUEST;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.LogConstants.ActionIDs.PROCESS_AUTHENTICATION_RESPONSE;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.LogConstants.OUTBOUND_AUTH_OIDC_SERVICE;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.MULTI_OPTION_URI;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.OIDC_FEDERATION_NONCE;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.QUERY_PARAM_KEY_VALUE_DELIMITER;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.REDIRECT_URL_SUFFIX;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.SCOPE_PARAM_SUFFIX;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.STATE_PARAM_SUFFIX;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.URI_QUERY_PARAM_DELIMITER;
import static org.wso2.carbon.identity.base.IdentityConstants.FEDERATED_IDP_SESSION_ID;

/**
Expand Down Expand Up @@ -2033,10 +2036,10 @@ private String interpretQueryString(AuthenticationContext context, String queryS
Matcher matcher = pattern.matcher(queryString);
while (matcher.find()) {
String name = matcher.group(1);
String[] values = parameters.get(name);
String value = "";
if (values != null && values.length > 0) {
value = values[0];
String value = getParameterFromParamMap(parameters, name);
if (StringUtils.isBlank(value)) {
String multiOptionURI = getParameterFromParamMap(parameters, MULTI_OPTION_URI);
value = getParameterFromURIString(multiOptionURI, name);
}
if (LOG.isDebugEnabled()) {
LOG.debug("InterpretQueryString name: " + name + ", value: " + value);
Expand All @@ -2049,6 +2052,48 @@ private String interpretQueryString(AuthenticationContext context, String queryS
return queryString;
}

/**
* Gets the value of the parameter corresponding to the given parameter
* name from the request's parameter map.
*
* @param parameters The parameter map of the request.
* @param parameterName The name of the parameter to be retrieved.
* @return The value of the parameter if it is present in the parameter map.
* If it is not present, an empty String is returned instead.
*/
private String getParameterFromParamMap(Map<String, String[]> parameters, String parameterName) {

String[] parameterValueMap = parameters.get(parameterName);
if (parameterValueMap != null && parameterValueMap.length > 0) {
return parameterValueMap[0];
}
return StringUtils.EMPTY;
}

/**
* Parses the given URI String to get the parameter value corresponding to the
* given parameter name.
*
* @param uriString The URI String to be parsed.
* @param parameterName The name of the parameter to be retrieved.
* @return The value of the parameter if it is present in the URI String.
* If it is not present, an empty String is returned instead.
*/
private String getParameterFromURIString(String uriString, String parameterName) {

if (StringUtils.isNotBlank(uriString)) {
String[] queryParams = uriString.split(URI_QUERY_PARAM_DELIMITER, -1);
DilshanSenarath marked this conversation as resolved.
Show resolved Hide resolved
for (String queryParam: queryParams) {
String[] queryParamComponents = queryParam.split(QUERY_PARAM_KEY_VALUE_DELIMITER);
if (queryParamComponents.length == 2 && queryParamComponents[0].equalsIgnoreCase(parameterName)) {
return queryParamComponents[1];
}
}
}
return StringUtils.EMPTY;
}


/**
* Evaluate the query string for additional query params with actual key and value.
*
Expand Down
Loading