Skip to content

Commit

Permalink
Modify the OIDC Authenticator to support for the API Based Authentica…
Browse files Browse the repository at this point in the history 
…tion
  • Loading branch information
Hasanthi Dissanayake committed Oct 14, 2023
1 parent 8575ed5 commit 6494d89
Show file tree
Hide file tree
Showing 4 changed files with 118 additions and 2 deletions.
6 changes: 6 additions & 0 deletions ...a/org/wso2/carbon/identity/application/authenticator/oidc/OIDCAuthenticatorConstants.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,12 @@ private OIDCAuthenticatorConstants() {
public static final Pattern OIDC_BACKCHANNEL_LOGOUT_ENDPOINT_URL_PATTERN = Pattern.compile("(.*)/identity/oidc" +
"/slo(.*)");
public static final String OIDC_FEDERATION_NONCE = "oidc_federation_nonce";
public static final String AUTHENTICATOR_OIDC = "authenticator.oidc";
public static final String REQUIRED_PARAMS = "required_params";
public static final String REDIRECT_URL = "redirect_url";
public static final String ADDITIONAL_DATA = "_additional_data";
public static final String PROMPT_TYPE = "prompt_type";
public static final String REDIRECTION_PROMPT = "REDIRECTION_PROMPT";

public class AuthenticatorConfParams {

Expand Down
66 changes: 65 additions & 1 deletion ...a/org/wso2/carbon/identity/application/authenticator/oidc/OpenIDConnectAuthenticator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
import org.wso2.carbon.identity.application.authentication.framework.exception.AuthenticationFailedException;
import org.wso2.carbon.identity.application.authentication.framework.exception.LogoutFailedException;
import org.wso2.carbon.identity.application.authentication.framework.model.AuthenticatedUser;
import org.wso2.carbon.identity.application.authentication.framework.model.AuthenticatorData;
import org.wso2.carbon.identity.application.authentication.framework.util.FrameworkConstants;
import org.wso2.carbon.identity.application.authentication.framework.util.FrameworkUtils;
import org.wso2.carbon.identity.application.authenticator.oidc.internal.OpenIDConnectAuthenticatorDataHolder;
Expand Down Expand Up @@ -84,18 +85,25 @@
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.Optional;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.ADDITIONAL_DATA;
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.REQUIRED_PARAMS;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.REDIRECT_URL;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.PROMPT_TYPE;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.REDIRECTION_PROMPT;
import static org.wso2.carbon.identity.application.authenticator.oidc.OIDCAuthenticatorConstants.Claim.NONCE;
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.ActionIDs.INITIATE_OUTBOUND_AUTH_REQUEST;
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.OIDC_FEDERATION_NONCE;
import static org.wso2.carbon.identity.base.IdentityConstants.FEDERATED_IDP_SESSION_ID;

public class OpenIDConnectAuthenticator extends AbstractApplicationAuthenticator
Expand Down Expand Up @@ -493,6 +501,7 @@ protected void initiateAuthenticationRequest(HttpServletRequest request, HttpSer
loginPage = loginPage + queryString;
}
}
context.setProperty(OIDCAuthenticatorConstants.AUTHENTICATOR_NAME + ADDITIONAL_DATA, loginPage);
response.sendRedirect(loginPage);
if (LoggerUtils.isDiagnosticLogsEnabled() && diagnosticLogBuilder != null) {
diagnosticLogBuilder.resultMessage("Redirecting to the federated IDP login page.");
Expand Down Expand Up @@ -648,6 +657,17 @@ protected void processAuthenticationResponse(HttpServletRequest request, HttpSer
}
}

/**
* Get the i18n key defined to represent the authenticator name.
*
* @return the 118n key.
*/
@Override
public String getI18nKey() {

return AUTHENTICATOR_OIDC;
}

/**
* Retrieves or maps the ID token according to the flow supported by the authenticator.
* Overridden in Google Authenticator for Google one tap.
Expand Down Expand Up @@ -1116,6 +1136,50 @@ public List<Property> getConfigurationProperties() {
return configProperties;
}

/**
* This method is responsible for validating whether the authenticator is supported for API Based Authentication.
*
* @return true if the authenticator is supported for API Based Authentication.
*/
@Override
public boolean isAPIBasedAuthenticationSupported() {

return true;
}

/**
* This method is responsible for obtaining authenticator-specific data needed to
* initialize the authentication process within the provided authentication context.
*
* @param context The authentication context containing information about the current authentication attempt.
* @return An {@code Optional} containing an {@code AuthenticatorData} object representing the initiation data.
* If the initiation data is available, it is encapsulated within the {@code Optional}; otherwise,
* an empty {@code Optional} is returned.
*/
@Override
public Optional<AuthenticatorData> getAuthInitiationData(AuthenticationContext context) {

AuthenticatorData authenticatorData = new AuthenticatorData();
authenticatorData.setName(getName());
authenticatorData.setDisplayName(getFriendlyName());
authenticatorData.setI18nKey(getI18nKey());
String idpName = context.getExternalIdP().getIdPName();
authenticatorData.setIdp(idpName);

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

Map<String, String> additionalData = new HashMap<>();
additionalData.put(REQUIRED_PARAMS, requiredParameterList.toString());
additionalData.put(REDIRECT_URL,
(String) context.getProperty(OIDCAuthenticatorConstants.AUTHENTICATOR_NAME + ADDITIONAL_DATA));
additionalData.put(PROMPT_TYPE, REDIRECTION_PROMPT);
authenticatorData.setAdditionalData(additionalData);

return Optional.of(authenticatorData);
}

/**
* @subject
*/
Expand Down
46 changes: 46 additions & 0 deletions ...g/wso2/carbon/identity/application/authenticator/oidc/OpenIDConnectAuthenticatorTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@
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.AuthenticationRequest;
import org.wso2.carbon.identity.application.authentication.framework.model.AuthenticatorData;
import org.wso2.carbon.identity.application.authentication.framework.util.FrameworkConstants;
import org.wso2.carbon.identity.application.authentication.framework.util.FrameworkUtils;
import org.wso2.carbon.identity.application.authenticator.oidc.internal.OpenIDConnectAuthenticatorDataHolder;
Expand All @@ -67,7 +69,10 @@
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;
import javax.servlet.http.HttpServletResponse;

Expand All @@ -85,6 +90,7 @@
import static org.testng.Assert.assertNull;
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.REDIRECTION_PROMPT;

/***
* Unit test class for OpenIDConnectAuthenticatorTest class.
Expand Down Expand Up @@ -171,6 +177,7 @@ public class OpenIDConnectAuthenticatorTest extends PowerMockTestCase {
private static OAuthClientResponse token;
private Map<String, String> paramValueMap;
private int TENANT_ID = 1234;
private AuthenticationRequest mockAuthenticationRequest = new AuthenticationRequest();

@BeforeTest
public void init() {
Expand Down Expand Up @@ -706,6 +713,45 @@ private void mockAuthenticationRequestContext(AuthenticationContext mockAuthenti
when(mockAuthenticationContext.getProperty("oidc:param.map")).thenReturn(paramValueMap);
when(mockAuthenticationContext.getContextIdentifier()).thenReturn("");
when(mockAuthenticationContext.getExternalIdP()).thenReturn(getDummyExternalIdPConfig());
when(mockAuthenticationContext.getAuthenticationRequest()).thenReturn(mockAuthenticationRequest);
}

@Test
public void testIsAPIBasedAuthenticationSupported() {

boolean isAPIBasedAuthenticationSupported = openIDConnectAuthenticator.isAPIBasedAuthenticationSupported();
Assert.assertTrue(isAPIBasedAuthenticationSupported);
}

@Test
public void testGetAuthInitiationData() {

when(mockAuthenticationContext.getExternalIdP()).thenReturn(externalIdPConfig);
when(externalIdPConfig.getIdPName()).thenReturn("LOCAL");
when(mockAuthenticationContext.getAuthenticationRequest()).thenReturn(mockAuthenticationRequest);
Optional<AuthenticatorData> authenticatorData = openIDConnectAuthenticator.getAuthInitiationData
(mockAuthenticationContext);

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

Map<String, String> additionalData = new HashMap<>();
additionalData.put(OIDCAuthenticatorConstants.REQUIRED_PARAMS, requiredParameterList.toString());
additionalData.put(OIDCAuthenticatorConstants.PROMPT_TYPE, REDIRECTION_PROMPT);

Assert.assertTrue(authenticatorData.isPresent());
AuthenticatorData authenticatorDataObj = authenticatorData.get();
authenticatorDataObj.setAdditionalData(additionalData);
Assert.assertEquals(authenticatorDataObj.getName(), "OpenIDConnectAuthenticator");
Assert.assertEquals(authenticatorDataObj.getI18nKey(), "authenticator.oidc");
Assert.assertEquals(authenticatorDataObj.getDisplayName(), "openidconnect");

// Iterate through the map and assert values
for (Map.Entry<String, String> entry : additionalData.entrySet()) {
String key = entry.getKey();
Assert.assertTrue(authenticatorDataObj.getAdditionalData().containsKey(key));
}
}

private ExternalIdPConfig getDummyExternalIdPConfig() {
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@
<identity.application.auth.oidc.package.export.version>${project.version}
</identity.application.auth.oidc.package.export.version>

<carbon.identity.framework.version>5.25.260</carbon.identity.framework.version>
<carbon.identity.framework.version>5.25.386</carbon.identity.framework.version>
<oltu.version>1.0.0.wso2v3</oltu.version>
<json-smart.version>2.4.7</json-smart.version>
<json.wso2.version>3.0.0.wso2v2</json.wso2.version>
Expand Down

0 comments on commit 6494d89

Please sign in to comment.