Skip to content

Commit

Permalink
Merge pull request #21449 from Thumimku/improv-cc
Browse files Browse the repository at this point in the history 
Improve Client Credential automation test cases
  • Loading branch information
@Thumimku
Thumimku authored Oct 23, 2024
2 parents c2d0aa2 + b171a8e commit 2ad7041
Showing 1 changed file with 150 additions and 6 deletions.
156 changes: 150 additions & 6 deletions ...java/org/wso2/identity/integration/test/oauth2/OAuth2ServiceClientCredentialTestCase.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@
import com.nimbusds.oauth2.sdk.AccessTokenResponse;
import com.nimbusds.oauth2.sdk.AuthorizationGrant;
import com.nimbusds.oauth2.sdk.ClientCredentialsGrant;
import com.nimbusds.oauth2.sdk.ErrorObject;
import com.nimbusds.oauth2.sdk.Scope;
import com.nimbusds.oauth2.sdk.TokenErrorResponse;
import com.nimbusds.oauth2.sdk.TokenRequest;
import com.nimbusds.oauth2.sdk.TokenResponse;
import com.nimbusds.oauth2.sdk.auth.ClientAuthentication;
Expand All @@ -30,8 +32,16 @@
import com.nimbusds.oauth2.sdk.http.HTTPResponse;
import com.nimbusds.oauth2.sdk.id.ClientID;
import com.nimbusds.openid.connect.sdk.OIDCTokenResponse;
import org.apache.http.Header;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.NameValuePair;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.message.BasicHeader;
import org.apache.http.message.BasicNameValuePair;
import org.apache.http.util.EntityUtils;
import org.json.JSONObject;
import org.testng.Assert;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
Expand All @@ -41,20 +51,33 @@
import org.wso2.carbon.automation.engine.context.AutomationContext;
import org.wso2.carbon.automation.engine.context.TestUserMode;
import org.wso2.carbon.automation.engine.context.beans.Tenant;
import org.wso2.identity.integration.test.rest.api.server.application.management.v1.model.AccessTokenConfiguration;
import org.wso2.identity.integration.test.rest.api.server.application.management.v1.model.ApplicationResponseModel;
import org.wso2.identity.integration.test.rest.api.server.application.management.v1.model.OpenIDConnectConfiguration;
import org.wso2.identity.integration.test.restclients.OAuth2RestClient;
import org.wso2.identity.integration.test.utils.CarbonUtils;
import org.wso2.identity.integration.test.utils.OAuth2Constant;

import java.net.URI;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertTrue;
import static org.wso2.identity.integration.test.utils.OAuth2Constant.ACCESS_TOKEN_ENDPOINT;
import static org.wso2.identity.integration.test.utils.OAuth2Constant.AUTHORIZATION_HEADER;
import static org.wso2.identity.integration.test.utils.OAuth2Constant.OAUTH2_SCOPE_OPENID;

/**
* Tests for OAuth2 client credentials grant type.
*/
public class OAuth2ServiceClientCredentialTestCase extends OAuth2ServiceAbstractIntegrationTest {

public static final String SCIM2_BULK = "/scim2/Bulk";
public static final String OAUTH2_INTROSPECT = "/oauth2/introspect";
private static final String INTERNAL_BULK_RESOURCE_CREATE = "internal_bulk_resource_create";
private static final String INTERNAL_OFFLINE_INVITE = "internal_offline_invite";
private String accessToken;
private String consumerKey;
private String consumerSecret;
Expand All @@ -63,6 +86,7 @@ public class OAuth2ServiceClientCredentialTestCase extends OAuth2ServiceAbstract
private final AutomationContext context;
private Tenant tenantInfo;
private String applicationId;
private OpenIDConnectConfiguration oidcConfig;

private CloseableHttpClient client;

Expand Down Expand Up @@ -110,17 +134,22 @@ public void atEnd() throws Exception {
public void testRegisterApplication() throws Exception {

ApplicationResponseModel application = addApplication();

applicationId = application.getId();
if (!CarbonUtils.isLegacyAuthzRuntimeEnabled()) {
// Authorize few system APIs.
authorizeSystemAPIs(applicationId,
new ArrayList<>(Arrays.asList(SCIM2_BULK, OAUTH2_INTROSPECT)));
}
Assert.assertNotNull(application, "OAuth App creation failed.");

OpenIDConnectConfiguration oidcConfig = getOIDCInboundDetailsOfApplication(application.getId());
oidcConfig = getOIDCInboundDetailsOfApplication(application.getId());

consumerKey = oidcConfig.getClientId();
Assert.assertNotNull(consumerKey, "Application creation failed.");

consumerSecret = oidcConfig.getClientSecret();
Assert.assertNotNull(consumerSecret, "Application creation failed.");

applicationId = application.getId();
}

@Test(groups = "wso2.is", description = "Send client credentials token request.", dependsOnMethods = "testRegisterApplication")
Expand All @@ -130,13 +159,14 @@ public void testGetTokenUsingClientCredentialsGrant() throws Exception {
ClientID clientID = new ClientID(consumerKey);
Secret clientSecret = new Secret(consumerSecret);
ClientAuthentication clientAuth = new ClientSecretBasic(clientID, clientSecret);
Scope scope = new Scope(OAUTH2_SCOPE_OPENID, "xyz", VALID_RANDOM_SCOPE);
Scope scope = new Scope(OAUTH2_SCOPE_OPENID, "xyz", VALID_RANDOM_SCOPE, INTERNAL_BULK_RESOURCE_CREATE);

URI tokenEndpoint = new URI(getTenantQualifiedURL(OAuth2Constant.ACCESS_TOKEN_ENDPOINT, tenantInfo.getDomain()));
TokenRequest request = new TokenRequest(tokenEndpoint, clientAuth, clientCredentialsGrant, scope);
HTTPResponse tokenHTTPResp = request.toHTTPRequest().send();
Assert.assertNotNull(tokenHTTPResp, "Access token http response is null.");

Assert.assertEquals(tokenHTTPResp.getContentType().toString(), "application/json",
"Token response did not indicate correct token response.");
TokenResponse tokenResponse = TokenResponse.parse(tokenHTTPResp);
Assert.assertTrue(tokenResponse.indicatesSuccess(),
"Token response did not indicate success. Token request has failed.");
Expand All @@ -150,8 +180,13 @@ public void testGetTokenUsingClientCredentialsGrant() throws Exception {
Scope scopesInResponse = accessTokenResponse.getTokens().getAccessToken().getScope();
Assert.assertFalse(scopesInResponse.contains("xyz"), "Not allowed random scope is issued for client credential " +
"grant type.");
Assert.assertFalse(scopesInResponse.contains(INTERNAL_OFFLINE_INVITE), "Not allowed random scope is issued for client credential " +
"grant type.");

Assert.assertTrue(scopesInResponse.contains(VALID_RANDOM_SCOPE), "Allowed random scope is not issued for " +
"client credential grant type.");
Assert.assertTrue(scopesInResponse.contains(INTERNAL_BULK_RESOURCE_CREATE),
"Allowed bulk resource create scope is not issued for client credential grant type.");

// This ensures that openid scopes are not issued for client credential grant type.
Assert.assertFalse(accessTokenResponse instanceof OIDCTokenResponse, "Client credential grant type cannot " +
Expand All @@ -170,4 +205,113 @@ public void testValidateAccessToken() throws Exception {
Assert.assertNotNull(responseObj, "Validate access token failed. response is invalid.");
Assert.assertEquals(responseObj.get("active"), true, "Token Validation failed");
}

@Test(groups = "wso2.is", description = "Send client credentials token request with invalid client Id.",
dependsOnMethods = "testGetTokenUsingClientCredentialsGrant")
public void testGetTokenUsingCCGrantWithInvalidClientId() throws Exception {

AuthorizationGrant clientCredentialsGrant = new ClientCredentialsGrant();
ClientID clientID = new ClientID("invalidConsumerKey");
Secret clientSecret = new Secret(consumerSecret);
ClientAuthentication clientAuth = new ClientSecretBasic(clientID, clientSecret);
Scope scope = new Scope(OAUTH2_SCOPE_OPENID, "xyz", VALID_RANDOM_SCOPE, INTERNAL_BULK_RESOURCE_CREATE);

URI tokenEndpoint = new URI(getTenantQualifiedURL(OAuth2Constant.ACCESS_TOKEN_ENDPOINT, tenantInfo.getDomain()));
TokenRequest request = new TokenRequest(tokenEndpoint, clientAuth, clientCredentialsGrant, scope);
HTTPResponse tokenHTTPResp = request.toHTTPRequest().send();
Assert.assertNotNull(tokenHTTPResp, "Access token http response is null.");

TokenResponse tokenResponse = TokenResponse.parse(tokenHTTPResp);
Assert.assertFalse(tokenResponse.indicatesSuccess(),
"Token response indicated success. Token request should fail with invalid client id.");

TokenErrorResponse accessTokenResponse = (TokenErrorResponse) tokenResponse;
ErrorObject errorObject = accessTokenResponse.getErrorObject();
Assert.assertEquals(errorObject.getHTTPStatusCode(), HttpStatus.SC_UNAUTHORIZED,
"Invalid access token response doesn't contain bad request status code.");
Assert.assertEquals(errorObject.getCode(), "invalid_client",
"Invalid access token response doesn't contain required error message.");
Assert.assertEquals(errorObject.getDescription(),
"A valid OAuth client could not be found for client_id: invalidConsumerKey",
"Invalid access token response doesn't contain required error description.");
}

@Test(groups = "wso2.is", description = "Send client credentials token request with invalid client secret.",
dependsOnMethods = "testGetTokenUsingCCGrantWithInvalidClientId")
public void testGetTokenUsingCCGrantWithInvalidClientCredentials() throws Exception {

AuthorizationGrant clientCredentialsGrant = new ClientCredentialsGrant();
ClientID clientID = new ClientID(consumerKey);
Secret clientSecret = new Secret("invalidConsumerSecret");
ClientAuthentication clientAuth = new ClientSecretBasic(clientID, clientSecret);
Scope scope = new Scope(OAUTH2_SCOPE_OPENID, "xyz", VALID_RANDOM_SCOPE, INTERNAL_BULK_RESOURCE_CREATE);

URI tokenEndpoint = new URI(getTenantQualifiedURL(OAuth2Constant.ACCESS_TOKEN_ENDPOINT, tenantInfo.getDomain()));
TokenRequest request = new TokenRequest(tokenEndpoint, clientAuth, clientCredentialsGrant, scope);
HTTPResponse tokenHTTPResp = request.toHTTPRequest().send();
Assert.assertNotNull(tokenHTTPResp, "Access token http response is null.");

TokenResponse tokenResponse = TokenResponse.parse(tokenHTTPResp);
Assert.assertFalse(tokenResponse.indicatesSuccess(),
"Token response indicated success. Token request should fail with invalid client id.");

TokenErrorResponse accessTokenResponse = (TokenErrorResponse) tokenResponse;
ErrorObject errorObject = accessTokenResponse.getErrorObject();
Assert.assertEquals(errorObject.getHTTPStatusCode(), HttpStatus.SC_UNAUTHORIZED,
"Invalid access token response doesn't contain bad request status code.");
Assert.assertEquals(errorObject.getCode(), "invalid_client",
"Invalid access token response doesn't contain required error message.");
Assert.assertEquals(errorObject.getDescription(),
"Client credentials are invalid.",
"Invalid access token response doesn't contain required error description.");
}

@Test(groups = "wso2.is", description = "Send client credentials token request without client secret.",
dependsOnMethods = "testGetTokenUsingCCGrantWithInvalidClientCredentials")
public void testGetTokenUsingCCGrantWithoutCredentials() throws Exception {

List<NameValuePair> parameters = new ArrayList<>();
parameters.add(new BasicNameValuePair("grant_type", OAuth2Constant.OAUTH2_GRANT_TYPE_CLIENT_CREDENTIALS));

String scopes = "xyz " + VALID_RANDOM_SCOPE + " " + INTERNAL_BULK_RESOURCE_CREATE;
parameters.add(new BasicNameValuePair("scope", scopes));

List<Header> headers = new ArrayList<>();
headers.add(new BasicHeader(AUTHORIZATION_HEADER, OAuth2Constant.BASIC_HEADER + " " +
getBase64EncodedString("", "")));
headers.add(new BasicHeader("Content-Type", "application/x-www-form-urlencoded"));
headers.add(new BasicHeader("User-Agent", OAuth2Constant.USER_AGENT));

HttpResponse response = sendPostRequest(client, headers, parameters,
getTenantQualifiedURL(ACCESS_TOKEN_ENDPOINT, tenantInfo.getDomain()));

String responseString = EntityUtils.toString(response.getEntity(), "UTF-8");
JSONObject jsonResponse = new JSONObject(responseString);

assertTrue(jsonResponse.has("error"), "Invalid access token response doesn't contain" +
" error message.");
assertEquals(jsonResponse.getString("error"), "invalid_client",
"Invalid access token response doesn't contain required error message.");

assertTrue(jsonResponse.has("error_description"), "Error not found in the token response.");
assertEquals(jsonResponse.getString("error_description"), "Client ID not found in the request.",
"Invalid access token response doesn't contain required error description.");
}

@Test(groups = "wso2.is", description = "Perform client credentials token request tests for JWT token type.",
dependsOnMethods = "testGetTokenUsingCCGrantWithoutCredentials")
public void testGetTokenUsingCCGrantForJWTToken() throws Exception {

AccessTokenConfiguration accessTokenConfig = new AccessTokenConfiguration().type("JWT");
accessTokenConfig.setUserAccessTokenExpiryInSeconds(3600L);
accessTokenConfig.setApplicationAccessTokenExpiryInSeconds(3600L);

oidcConfig.setAccessToken(accessTokenConfig);
updateApplicationInboundConfig(applicationId, oidcConfig, OIDC);
testGetTokenUsingClientCredentialsGrant();
testValidateAccessToken();
testGetTokenUsingCCGrantWithInvalidClientId();
testGetTokenUsingCCGrantWithInvalidClientCredentials();
testGetTokenUsingCCGrantWithoutCredentials();
}
}

0 comments on commit 2ad7041

Please sign in to comment.