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

Improve getAuthInitiationData Method to Support Native SDK Based Federation #158

Merged
merged 2 commits into from
Oct 25, 2023
Merged

Improve getAuthInitiationData Method to Support Native SDK Based Federation #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a84696
Improve getAuthInitiationData() method to support native SDK based fe…
dhaura Oct 25, 2023
118af13
Improve code formatting
dhaura Oct 25, 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
1 change: 1 addition & 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 @@ -30,6 +30,7 @@ public class OIDCAuthenticatorConstants {
public static final String CODE_PARAM = "code.param";
public static final String ID_TOKEN_PARAM = "idToken";
public static final String SESSION_DATA_KEY_PARAM = "sessionDataKey";
public static final String CLIENT_ID_PARAM = "clientId";

private OIDCAuthenticatorConstants() {

Expand Down
36 changes: 28 additions & 8 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 @@ -1290,21 +1290,41 @@ public Optional<AuthenticatorData> getAuthInitiationData(AuthenticationContext c
authenticatorData.setIdp(idpName);

List<String> requiredParameterList = new ArrayList<>();
requiredParameterList.add(OIDCAuthenticatorConstants.OAUTH2_GRANT_TYPE_CODE);
requiredParameterList.add(OIDCAuthenticatorConstants.OAUTH2_PARAM_STATE);

if (isTrustedTokenIssuer(context)) {
requiredParameterList.add(ACCESS_TOKEN_PARAM);
requiredParameterList.add(ID_TOKEN_PARAM);
authenticatorData.setPromptType(FrameworkConstants.AuthenticatorPromptType.INTERNAL_PROMPT);
authenticatorData.setAdditionalData(getAdditionalData(context, true));
} else {
requiredParameterList.add(OIDCAuthenticatorConstants.OAUTH2_GRANT_TYPE_CODE);
requiredParameterList.add(OIDCAuthenticatorConstants.OAUTH2_PARAM_STATE);
authenticatorData.setPromptType(FrameworkConstants.AuthenticatorPromptType.REDIRECTION_PROMPT);
authenticatorData.setAdditionalData(getAdditionalData(context, false));
}
authenticatorData.setRequiredParams(requiredParameterList);
authenticatorData.setPromptType(FrameworkConstants.AuthenticatorPromptType.REDIRECTION_PROMPT);
authenticatorData.setAdditionalData(getAdditionalData(context));

return Optional.of(authenticatorData);
}

private static AdditionalData getAdditionalData(AuthenticationContext context) {
private static AdditionalData getAdditionalData(
AuthenticationContext context, boolean isNativeSDKBasedFederationCall) {

AdditionalData additionalData = new AdditionalData();
additionalData.setRedirectUrl((String) context.getProperty(OIDCAuthenticatorConstants.AUTHENTICATOR_NAME +
REDIRECT_URL_SUFFIX));

if (isNativeSDKBasedFederationCall) {
Map<String, String> additionalAuthenticationParams = new HashMap<>();

String nonce = (String) context.getProperty(OIDC_FEDERATION_NONCE);
if (StringUtils.isNotBlank(nonce)) {
additionalAuthenticationParams.put(NONCE, nonce);
}
additionalAuthenticationParams.put(OIDCAuthenticatorConstants.CLIENT_ID_PARAM,
context.getAuthenticatorProperties().get(OIDCAuthenticatorConstants.CLIENT_ID));
additionalData.setAdditionalAuthenticationParams(additionalAuthenticationParams);
} else {
additionalData.setRedirectUrl((String) context.getProperty(OIDCAuthenticatorConstants.AUTHENTICATOR_NAME +
REDIRECT_URL_SUFFIX));
}
return additionalData;
}

Expand Down
62 changes: 54 additions & 8 deletions ...g/wso2/carbon/identity/application/authenticator/oidc/OpenIDConnectAuthenticatorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@
import org.wso2.carbon.identity.application.authentication.framework.context.AuthenticationContext;
import org.wso2.carbon.identity.application.authentication.framework.exception.AuthenticationFailedException;
import org.wso2.carbon.identity.application.authentication.framework.exception.FrameworkException;
import org.wso2.carbon.identity.application.authentication.framework.model.AdditionalData;
import org.wso2.carbon.identity.application.authentication.framework.model.AuthenticationRequest;
import org.wso2.carbon.identity.application.authentication.framework.model.AuthenticatorData;
import org.wso2.carbon.identity.application.authentication.framework.util.FrameworkConstants;
Expand Down Expand Up @@ -72,8 +71,6 @@
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.HashMap;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.util.Optional;
import javax.servlet.http.HttpServletRequest;
Expand All @@ -94,10 +91,10 @@
import static org.testng.Assert.assertTrue;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.OIDC_FEDERATION_NONCE;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.AUTHENTICATOR_OIDC;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.REDIRECTION_PROMPT;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.AUTHENTICATOR_NAME;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.
AUTHENTICATOR_FRIENDLY_NAME;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.Claim.NONCE;

/***
* Unit test class for OpenIDConnectAuthenticator class.
Expand Down Expand Up @@ -172,6 +169,7 @@ public class OpenIDConnectAuthenticatorTest extends PowerMockTestCase {

private static Map<String, String> authenticatorProperties;
private static Map<String, String> authenticatorParamProperties;
private static String clientId = "DpPQt4KnvcehtUuQ0Jf6i0gl0E0a";
private static String accessToken = "4952b467-86b2-31df-b63c-0bf25cec4f86s";
private static String idToken = "eyJ4NXQiOiJOVEF4Wm1NeE5ETXlaRGczTVRVMVpHTTBNekV6T0RKaFpXSTRORE5" +
"sWkRVMU9HRmtOakZpTVEiLCJraWQiOiJOVEF4Wm1NeE5ETXlaRGczTVRVMVpHTTBNekV6T0RKaFpXSTRORE5sWkRVMU9" +
Expand All @@ -186,6 +184,10 @@ public class OpenIDConnectAuthenticatorTest extends PowerMockTestCase {
private static String sessionDataKey = "7b1c8131-c6bd-4682-892e-1a948a9e57e8";
private static String nonce = "0ed8f1b3-e83f-46c0-8d52-f0d2e7925f98";
private static String invalidNonce = "7ed8f1b3-e83f-46c0-8d52-f0d2e7925f98";
private static String redirectUrl = "https://accounts.google.com/o/oauth2/v2/auth?scope=openid&" +
"response_type=code&redirect_uri=https%3A%2F%2Flocalhost%3A9443%2Fcommonauth&" +
"state=958e9049-8cd2-4580-8745-6679ac8d33f6%2COIDC&nonce=0ed8f1b3-e83f-46c0-8d52-f0d2e7925f98&" +
"client_id=sample.client-id";
private static OAuthClientResponse token;
private Map<String, String> paramValueMap;
private int TENANT_ID = 1234;
Expand Down Expand Up @@ -823,13 +825,12 @@ public void testGetAuthInitiationData() {
when(mockAuthenticationContext.getExternalIdP()).thenReturn(externalIdPConfig);
when(externalIdPConfig.getIdPName()).thenReturn("LOCAL");
when(mockAuthenticationContext.getAuthenticationRequest()).thenReturn(mockAuthenticationRequest);
when(mockAuthenticationContext.getProperty(
OIDCAuthenticatorConstants.AUTHENTICATOR_NAME + OIDCAuthenticatorConstants.REDIRECT_URL_SUFFIX))
.thenReturn(redirectUrl);
Optional<AuthenticatorData> authenticatorData = openIDConnectAuthenticator.getAuthInitiationData
(mockAuthenticationContext);

List<String> requiredParameterList = new ArrayList<>();
requiredParameterList.add(OIDCAuthenticatorConstants.OAUTH2_GRANT_TYPE_CODE);
requiredParameterList.add(OIDCAuthenticatorConstants.OAUTH2_PARAM_STATE);

Assert.assertTrue(authenticatorData.isPresent());
AuthenticatorData authenticatorDataObj = authenticatorData.get();

Expand All @@ -840,7 +841,52 @@ public void testGetAuthInitiationData() {
2);
Assert.assertEquals(authenticatorDataObj.getPromptType(),
FrameworkConstants.AuthenticatorPromptType.REDIRECTION_PROMPT);
Assert.assertTrue(authenticatorDataObj.getRequiredParams()
.contains(OIDCAuthenticatorConstants.OAUTH2_GRANT_TYPE_CODE));
Assert.assertTrue(authenticatorDataObj.getRequiredParams()
.contains(OIDCAuthenticatorConstants.OAUTH2_PARAM_STATE));
Assert.assertEquals(authenticatorDataObj.getAdditionalData().getRedirectUrl(), redirectUrl);
}

@Test
public void testGetAuthInitiationDataForNativeSDKBasedFederation() {

IdentityProviderProperty property = new IdentityProviderProperty();
property.setName(IdPManagementConstants.IS_TRUSTED_TOKEN_ISSUER);
property.setValue("true");
IdentityProviderProperty[] identityProviderProperties = new IdentityProviderProperty[1];
identityProviderProperties[0] = property;

when(mockAuthenticationContext.getExternalIdP()).thenReturn(externalIdPConfig);
when(externalIdPConfig.getIdPName()).thenReturn("LOCAL");
when(externalIdPConfig.getIdentityProvider()).thenReturn(identityProvider);
when(identityProvider.getIdpProperties()).thenReturn(identityProviderProperties);
when(mockAuthenticationContext.getAuthenticationRequest()).thenReturn(mockAuthenticationRequest);
when(mockAuthenticationContext.getProperty(OIDC_FEDERATION_NONCE)).thenReturn(nonce);
when(mockAuthenticationContext.getAuthenticatorProperties()).thenReturn(authenticatorProperties);
authenticatorProperties.put(OIDCAuthenticatorConstants.CLIENT_ID, clientId);

Optional<AuthenticatorData> authenticatorData = openIDConnectAuthenticator.getAuthInitiationData
(mockAuthenticationContext);

Assert.assertTrue(authenticatorData.isPresent());
AuthenticatorData authenticatorDataObj = authenticatorData.get();

Assert.assertEquals(authenticatorDataObj.getName(), AUTHENTICATOR_NAME);
Assert.assertEquals(authenticatorDataObj.getI18nKey(), AUTHENTICATOR_OIDC);
Assert.assertEquals(authenticatorDataObj.getDisplayName(), AUTHENTICATOR_FRIENDLY_NAME);
Assert.assertEquals(authenticatorDataObj.getRequiredParams().size(),
2);
Assert.assertEquals(authenticatorDataObj.getPromptType(),
FrameworkConstants.AuthenticatorPromptType.INTERNAL_PROMPT);
Assert.assertTrue(authenticatorDataObj.getRequiredParams()
.contains(OIDCAuthenticatorConstants.ACCESS_TOKEN_PARAM));
Assert.assertTrue(authenticatorDataObj.getRequiredParams()
.contains(OIDCAuthenticatorConstants.ID_TOKEN_PARAM));
Assert.assertEquals(authenticatorDataObj.getAdditionalData()
.getAdditionalAuthenticationParams().get(NONCE), nonce);
Assert.assertEquals(authenticatorDataObj.getAdditionalData()
.getAdditionalAuthenticationParams().get(OIDCAuthenticatorConstants.CLIENT_ID_PARAM), clientId);
}

private ExternalIdPConfig getDummyExternalIdPConfig() {
Expand Down
Loading