mPass SSO

Modified on Wed, 27 Mar 2024 at 04:50 PM

This document is the property of Cerebra Technologies and may not be reproduced, by any means, in whole or in part, without prior permission of Cerebra Technologies. The document is provided on the understanding that its use will be confined to the officers of your Company and that no part of its contents will be disclosed to third parties without the prior written consent of Cerebra Technologies.

2. Introduction

mPassSSO is an Identity and Access Management Application. We can secure the services with a minimum of time and add authentication to the applications. The mPassSSO supports single sign-on and single sign-out fully.

The purpose of this document is to demonstrate the installation steps of mPassSSO.

3. Features of mPass SSO

mPassSSO supports multiple protocols like OpenID Connect, OAuth 2.0, and SAML.
A separate web UI for the admin portal is available. We can configure the server from the portal by clicking the options.
User Identity and Access – mPassSSO is a standalone tool for identity and access management that permits to creation of a user database with custom roles and groups.
Identity brokering- mPassSSO plays the role of a proxy between users and some external Identity providers.
The most important feature is that it allows us to use social identity providers such as Facebook, Google, Twitter, and stack overflow.

4. Pre-requisites

To install the mPassSSO successfully on your machine, the following prerequisites must be met.

1. At least 512 MB RAM

2. At least 1GB of disk space

3. A shared external database like Postgres

4. SQL SERVER should be installed before starting the installation.

5. Installation Steps

5.1 pre-installation steps

Install any relational database like Postgresql, MySQL, etc.. on your machine and create the database mPassSSO (the database name must be the same as the Keycloak config file). In this guide, the PostgreSQL database is being used. The pictorial representation is shown below.

5.2 Installation on Windows server

Download mPassSSO from the cerebra website
Double-click the mPass_SSO_v1.0.2.exe file and click next to start the installation.

The next Wizard will be about the License Agreement of the mPassSSO software. Read the content fully and accept the terms and conditions click next to continue the installation.

The installation files will be placed inside the ProgramFiles folder and we can change the directory as per our need.

After choosing the destination path for the installation files, the Ready to Install wizard will be shown below. Click the install button.

After clicking the install button the following wizard will be shown. It will install Java and mPassSSO in the ProgramFiles directory.

Click Finish to complete the installation. Now the project mPassSSO and java are being installed in Program Files under the folders mpass and java respectively. We can see the mPassSSO server is running on Windows services.

5.3 Installation On Linux Machine

1. Make sure Java 17(JDK 17) is installed before start the mPassSSO server.

2. Download mPassSSO from the cerebra website and extract it. After extracting it the folder named mPass-SSO-1.0.2.

3. Open the mPass-SSO-1.0.2\mPass-SSO-1.0.2\bin folder from a terminal

Run below command

kc.sh start

By running kc.sh start we are starting the mPassSSO in production mode.

6. Post Installation Steps

The mPassSSO config file must be modified before starting the server.

Open the mPassSSO config folder which resides inside the config folder. The path for the conf folder is shown below

C:\Program Files\mPass\mPass-SSO\conf\keycloak

Edit the client machine’s IP address in the keycloak.conf file for the variables hostname, and database host URL.

After editing the Keycloak conf file, go to the Windows services and restart the mPassSSO server. This will start the server on the above-mentioned IP address. By default, once installation is done the mPassSSO server will be started automatically. Here we are restarting the server once again to apply the changes of keycloak.conf file.

After the successful installation use the below format of the link to open the server.

https:// {Ip address}

When you enter the above link you will be directed to the below page.

We need to create an admin user first and start using the mPassSSO server for your single sign-on and sign-out purpose.

1. Go to the mPass admin console.

2. Login with the username and password that we created earlier.

Create a Realm

Realm allows an administrator to create isolated groups of applications and users. Initially, a master realm is created which is useful for managing mPassSSO, not for managing any applications.

Use the below steps to create a realm

1. open the admin console.

2. click the master word in the left corner, the below you can see the Create realm button. Click the Create Realm.

3. Enter realmName in the realm name field.

4. Click Create.

Create a user

Initially, the realm has no users. Use these steps to create a user:

Click the word master in the top-left corner, then click myRealm.
Click Users in the left-hand menu.
Click Add User.
Fill in the form with the following values:
- Username: myuser
- First name: any first name
- Last name: any last name
Click Create.

This user needs a password to log in. To set the initial password:

Click Credentials at the top of the page.
Fill in the Set password form with a password.
Toggle Temporary to Off so that the user does not need to update this password at the first login.