Skip to content

Use OpenID Connect to login by leveraging the oxd client service demon.

Notifications You must be signed in to change notification settings

imsoftware/rcube_openid_connect_single_sign_on_plugin_by_gluu

Repository files navigation

RoundCube OpenID Connect Single Sign-On (SSO) Plugin by Gluu

image

RoundCube OpenID Connect Single Sign-On (SSO) Plugin by Gluu gives access for login to your RoundCube site, with the help of GLUU server.

Plugin will not be working if your host does not have https://.

Step 1. Install Gluu-server

(version 2.4.4)

If you want to use external gluu server, You can not do this step.

Gluu-server installation gide.

Step 2. Download oxd-server

Download oxd-server-2.4.4.Final.

Step 3. Unzip and run oxd-server

  1. Unzip your oxd-server.
  2. Open the command line and navigate to the extracted folder in the conf directory.
  3. Open oxd-conf.json file.
  4. If your server is using 8099 port, please change “port” number to free port, which is not used.
  5. Open the command line and navigate to the extracted folder in the bin directory.
  6. For Linux environment, run sh oxd-start.sh&.
  7. For Windows environment, run oxd-start.bat.
  8. After the server starts, go to Step 4.

Step 4. General

General

  1. Admin Email: please add your or admin email address for registrating site in Gluu server.
  2. After the server starts, set the port number, your Gluu server url and your email in this page and click Next.
  3. Port number: choose that port which is using oxd-server (see in oxd-server/conf/oxd-conf.json file).
  4. Click Next to continue.

If You are successfully registered in gluu server, you will see bottom page.

oxD_id

For making sure go to your gluu server / OpenID Connect / Clients and search for your oxd ID

If you want to reset configurations click on Reset configurations button.

Step 5. OpenID Connect Configuration

Scopes.

You can look all scopes in your gluu server / OpenID Connect / Scopes and understand the meaning of every scope. Scopes are need for getting loged in users information from gluu server. Pay attention to that, which scopes you are using that are switched on in your gluu server.

In version 2.4.4 you can add, enable, disable and delete scope. Scopes1

Custom scripts.

Customscripts

You can look all custom scripts in your gluu server / Configuration / Manage Custom Scripts / and enable login type, which type you want. Custom Script represent itself the type of login, at this moment gluu server supports (U2F, Duo, Google +, Basic) types.

Pay attention to that.

  1. Which custom script you enable in your RoundCube site in order it must be switched on in gluu server too.
  2. Which custom script you will be enable in OpenID Connect Configuration page, after saving that will be showed in RoundCube Configuration page too.
  3. When you create new custom script, both fields are required.

Step 6. RoundCube Configuration

Customize Login Icons

Pay attention to that, if custom scripts are not enabled, nothing will be showed. Customize shape, space between icons and size of the login icons.

RoundCubeConfiguration

Step 7. Show icons in frontend

frontend

About

Use OpenID Connect to login by leveraging the oxd client service demon.

Resources

Stars

Watchers

Forks

Packages

No packages published