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

Resolved NPE in self-registering a user to an invalid user realm through API #833

Merged
merged 5 commits into from
Jul 22, 2024
Merged

Resolved NPE in self-registering a user to an invalid user realm through API #833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cbda7c3
Fixed NPE in self-registering a user to an invalid user realm through…
KaveeshaPiumini Jul 10, 2024
4e1212a
Refactor code
KaveeshaPiumini Jul 11, 2024
ace5130
Add unit test
KaveeshaPiumini Jul 12, 2024
efe29a8
Refactor test and improve method
KaveeshaPiumini Jul 22, 2024
49edb6a
Merge branch 'refs/heads/master' into issue-#20480-NPE-self-register-…
KaveeshaPiumini Jul 22, 2024
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
19 changes: 15 additions & 4 deletions ....carbon.identity.recovery/src/main/java/org/wso2/carbon/identity/recovery/util/Utils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
import org.wso2.carbon.user.api.UserStoreManager;
import org.wso2.carbon.user.core.UserCoreConstants;
import org.wso2.carbon.user.core.UserRealm;
import org.wso2.carbon.user.core.UserStoreClientException;
import org.wso2.carbon.user.core.common.AbstractUserStoreManager;
import org.wso2.carbon.user.core.constants.UserCoreErrorConstants;
import org.wso2.carbon.user.core.service.RealmService;
Expand All @@ -90,6 +91,7 @@
import java.util.regex.Pattern;

import static org.wso2.carbon.identity.auth.attribute.handler.AuthAttributeHandlerConstants.ErrorMessages.ERROR_CODE_AUTH_ATTRIBUTE_HANDLER_NOT_FOUND;
import static org.wso2.carbon.identity.core.util.IdentityUtil.getPrimaryDomainName;
import static org.wso2.carbon.identity.recovery.IdentityRecoveryConstants.ErrorMessages.ERROR_CODE_INVALID_REGISTRATION_OPTION;
import static org.wso2.carbon.identity.recovery.IdentityRecoveryConstants.ErrorMessages.ERROR_CODE_INVALID_USER_ATTRIBUTES_FOR_REGISTRATION;
import static org.wso2.carbon.identity.recovery.IdentityRecoveryConstants.ErrorMessages.ERROR_CODE_UNEXPECTED_ERROR_VALIDATING_ATTRIBUTES;
Expand Down Expand Up @@ -823,16 +825,25 @@ public static void checkPasswordPatternViolation(UserStoreException exception, U
private static RealmConfiguration getRealmConfiguration(User user) throws IdentityRecoveryClientException {

int tenantId = IdentityTenantUtil.getTenantId(user.getTenantDomain());
UserStoreManager userStoreManager;
try {
userStoreManager = IdentityRecoveryServiceDataHolder.getInstance().getRealmService().
UserStoreManager userStoreManager = IdentityRecoveryServiceDataHolder.getInstance().getRealmService().
ImalshaG marked this conversation as resolved.
Show resolved Hide resolved
getTenantUserRealm(tenantId).getUserStoreManager();
if (StringUtils.equals(user.getUserStoreDomain(), getPrimaryDomainName())) {
return ((org.wso2.carbon.user.core.UserStoreManager) userStoreManager).getRealmConfiguration();
}
UserStoreManager secondaryUserStoreManager =
((org.wso2.carbon.user.core.UserStoreManager) userStoreManager).getSecondaryUserStoreManager(
user.getUserStoreDomain());
if (secondaryUserStoreManager != null) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's return exception if null first and return the result at the end.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Returning exception at the end of the logic given a wrong expression.

return ((org.wso2.carbon.user.core.UserStoreManager) userStoreManager).getRealmConfiguration();
}
throw Utils.handleClientException(IdentityRecoveryConstants.ErrorMessages.ERROR_CODE_DOMAIN_VIOLATED,
user.getUserStoreDomain(),
new UserStoreClientException("Invalid domain " + user.getUserStoreDomain() + " provided."));
} catch (UserStoreException userStoreException) {
throw Utils.handleClientException(IdentityRecoveryConstants.ErrorMessages.ERROR_CODE_UNEXPECTED,
null, userStoreException);
}
return ((org.wso2.carbon.user.core.UserStoreManager) userStoreManager)
.getSecondaryUserStoreManager(user.getUserStoreDomain()).getRealmConfiguration();
}

/**
Expand Down
114 changes: 114 additions & 0 deletions ...bon.identity.recovery/src/test/java/org/wso2/carbon/identity/recovery/util/UtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
/*
* Copyright (c) 2024, WSO2 LLC. (http://www.wso2.com).
*
* WSO2 LLC. licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

package org.wso2.carbon.identity.recovery.util;

import org.mockito.Mock;
import org.mockito.MockedStatic;
import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
import org.wso2.carbon.identity.application.common.model.User;
import org.wso2.carbon.identity.core.util.IdentityTenantUtil;
import org.wso2.carbon.identity.core.util.IdentityUtil;
import org.wso2.carbon.identity.recovery.IdentityRecoveryClientException;
import org.wso2.carbon.identity.recovery.IdentityRecoveryConstants;
import org.wso2.carbon.identity.recovery.internal.IdentityRecoveryServiceDataHolder;
import org.wso2.carbon.user.api.UserStoreException;
import org.wso2.carbon.user.core.UserRealm;
import org.wso2.carbon.user.core.UserStoreManager;
import org.wso2.carbon.user.core.service.RealmService;

import static org.mockito.Mockito.mockStatic;
import static org.mockito.Mockito.when;
import static org.testng.Assert.assertEquals;

public class UtilsTest {

private static final String TENANT_DOMAIN = "test.com";
private static final int TENANT_ID = 123;
private static final String USER_NAME = "testUser";
private static final String USER_STORE_DOMAIN = "TEST";
@Mock
private UserStoreManager userStoreManager;
@Mock
private UserRealm userRealm;
@Mock
private RealmService realmService;
@Mock
private IdentityRecoveryServiceDataHolder identityRecoveryServiceDataHolder;

private MockedStatic<IdentityTenantUtil> mockedStaticIdentityTenantUtil;
private MockedStatic<UserStoreManager> mockedStaticUserStoreManager;
private MockedStatic<IdentityRecoveryServiceDataHolder> mockedIdentityRecoveryServiceDataHolder;
private MockedStatic<IdentityUtil> mockedIdentityUtil;

@BeforeMethod
public void setUp() {

MockitoAnnotations.openMocks(this);
}

@BeforeClass
public void beforeTest() {

mockedStaticIdentityTenantUtil = mockStatic(IdentityTenantUtil.class);
mockedStaticUserStoreManager = mockStatic(UserStoreManager.class);
mockedIdentityRecoveryServiceDataHolder = Mockito.mockStatic(IdentityRecoveryServiceDataHolder.class);
mockedIdentityUtil = mockStatic(IdentityUtil.class);
}

@AfterClass
public void afterTest() {

mockedStaticIdentityTenantUtil.close();
mockedStaticUserStoreManager.close();
mockedIdentityRecoveryServiceDataHolder.close();
mockedIdentityUtil.close();
}

@Test(expectedExceptions = IdentityRecoveryClientException.class)
public void testCheckPasswordPatternViolationForInvalidDomain() throws Exception {

User user = new User();
user.setUserName(USER_NAME);
user.setTenantDomain(TENANT_DOMAIN);
user.setUserStoreDomain(USER_STORE_DOMAIN);

when(IdentityTenantUtil.getTenantId(user.getTenantDomain())).thenReturn(TENANT_ID);
mockedIdentityRecoveryServiceDataHolder.when(IdentityRecoveryServiceDataHolder::getInstance).thenReturn(
identityRecoveryServiceDataHolder);
when(identityRecoveryServiceDataHolder.getRealmService()).thenReturn(realmService);
when(realmService.getTenantUserRealm(TENANT_ID)).thenReturn(userRealm);
when(userRealm.getUserStoreManager()).thenReturn(userStoreManager);
mockedIdentityUtil.when(IdentityUtil::getPrimaryDomainName).thenReturn("PRIMARY");
when(userStoreManager.getSecondaryUserStoreManager(USER_STORE_DOMAIN)).thenReturn(null);

try {
Utils.checkPasswordPatternViolation(new UserStoreException("Invalid Domain Name"), user);
} catch (IdentityRecoveryClientException e) {
assertEquals(e.getErrorCode(),
IdentityRecoveryConstants.ErrorMessages.ERROR_CODE_DOMAIN_VIOLATED.getCode());
assertEquals(e.getMessage(), "Invalid domain " + user.getUserStoreDomain() + " provided.");
throw e;
}
}
}
1 change: 1 addition & 0 deletions components/org.wso2.carbon.identity.recovery/src/test/resources/testng.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
<class name="org.wso2.carbon.identity.recovery.connector.UserEmailVerificationConfigImplTest" />
<class name="org.wso2.carbon.identity.recovery.signup.UserSelfRegistrationManagerTest"/>
<class name="org.wso2.carbon.identity.recovery.internal.service.impl.UserAccountRecoveryManagerTest"/>
<class name="org.wso2.carbon.identity.recovery.util.UtilsTest"/>
</classes>
</test>
</suite>
Loading