An attribute store is a user store that stores the user’s attributes(eg: email, mobile, address, etc). This kind of scenario comes in when we have the users’ credentials store in one user store(credential store) and the user attribute details store in the attribute store. So all the authentication, claim handling are not mapped into one user store.
Let's take a scenario like below.
For the demonstration purpose, I‘ll use two secondary LDAP user stores.
- LDAP : This will act as the credential store where the credentials of the user stored.
- LDAP-ATTRIBUTE-STORE : This will be the attribute store where the user attributes stored.
I‘ll use two identity servers that run on two different ports. You can set up this by downloading the identity server zip archive from here. After clicking the “TRY IT NOW” button, click the ZIP ARCHIVE option. Then what we need to do is to extract that zip as three instances(three extractions).
If you already have a WSO2IS instance, only need another two extractions. Then run it on different ports using the below command to run two other instances in different ports.
./wso2server.sh -DportOffset = 1 (instance will run on 9444 port and embedded LDAP server will run on 10390)
./wso2server.sh -DportOffset = 2 (instance will run on 9445 port and embedded LDAP server will run on 10391)
Now we need to add these two embedded LDAP servers as secondary user stores. Log in to the management console running on the 9443 port and add configurations.
I will name the LDAP server running on 10390 as LDAP and the server running on 10391 as LDAP-ATTRIBUTE-STORE. The suffix of the attribute store name can be used to identify the particular user store is an attribute store or not at the code level.
As we use a separate user store for attributes we need to implement functionality to retrieve and set the user claims to our attribute store.
We can do this by extending the functionality of AbstractIdentityUserOperationEventListener . If you not already read about extending user operation event listeners, check out my previous article.
WRITING CUSTOM USER OPERATION EVENT LISTENER -WSO2 IDENTITY SERVER
In this article, I'm going to show you how to write a custom user operation event listener. We have main two ways to do…
Now it is time to discuss what functionalities should we need to extend.
- Setting up the user claims
- Retrieving the user claims
The implemented sample scenario can be found below.
Contribute to DimuthuKasunWP/custom-attribute-store development by creating an account on GitHub.
In this codebase, I have already implemented some extended functionalities like,
- skip the user authentication from the attribute user stores.
- Add the user to the attribute user store when creating a new user in the credential user store.
- Delete the user in the attribute user store when deleting a user from the credential user store.
- Remove the names of the users in the attribute user stores when listing the users in all user stores.
Make sure to build the extension and put the jar file in <IS_HOME>/repository/components/dropins directory. Then restart the server running on the 9443 port.
I hope you got an idea about how to configure an attribute store in the WSO2 Identity Server. Thank you for reading.