OpenID-ATutor

Version: 1.0 Beta

License: GPL/ATutor

OpenID module for ATutor

The module  provides OpenID feature to the  ATutor.  Which enables

users to register and log in to the ATutor without much pain. They can manage their content without keeping a separate username password combination. This module can work with OAuth based Google app module to import Google services to the ATutor. The OpenID module for ATutor is an anytime pluggable module that can help the ATutor users to login from their Google account rather than registering a new account.

The  OpenID module  supports  Google, Facebook  and Twitter  based

INDEX

1.0 How to install OpenID Module? 2.0 How to configure OpenID Module? 3.0 How to use OpenID Module for Login?

1.0 How to install OpenID Module?

Copy the downloaded file into the ATutor mods/ directory and unzip it there. On Windows systems use and application like WinZip the extract the file into the mods/ directory. On Unix/Linux systems use the command:

unzip openid.zip
Login to ATutor as the administrator and run Install Module under the Modules tab, select the OpenID module, which should be listed as available to be installed when the module has been unzipped into the mods directory
Once the module has been installed, and enabled, goto "OpenID Settings" tab.
Configure the OpenID the way you want it to be. See "How to configure OpenID Module?".

2.0 How to configure OpenID Module?

Goto "OpenID Settings" tab.
Configure Google OpenID.

a). Enable Google OpenID : Choose to enable Google OpenID. If disabled the other Google OpenID settings are ignored.

b). Google OpenID Mode : Specifies whether Google may interact with the user to determine the outcome of the request. Valid values are:
```
                            "checkid_immediate" (No interaction
                                                       allowed)
                            "checkid_setup"        (Interaction
                                                       allowed)

                           Default  option   is "checkid_setup"
                           which is recommended over immediate.

                           CAUTION:
                           Selecting  "checkid_immediate"  mode
                           may block users from loging into the
                           ATutor with new Google ids.
```
c). Use PAPE : Use "OpenID Provider Authentication Policy Extension" which (optional) enables maximum authentication age. (Refer setting 2.d).

d). Maximum auth age(PAPE): Sets the maximum acceptable time (in seconds) since the user last authenticated. If the session is older, the user will be prompted to log in again. Setting the value to zero will force password re prompt regardless of session age.

e). UI mode : Specifies alternative user interface. Following values are valid:
```
                                "popup"
                                "x-has-session"
                                (indicate the  presence of an
                                authenticated session)
                           Default is "x-has-session".
```
f). Enable UI Icon : Displays the favicon of the referring domain in the OpenID approval page if set.

g). Query Country details : Fetches country details of the user from Google and saves it in the ATutor user preferences.

h). Use OAuth : Instead of Google OpenID, the Google OAuth will be used. This can work with ATutor Google Apps module. So that it eliminates the need of authenticating again for the Google Apps module.

i). OAuth consumer key : Consumer key provided by Google after registering the site. This is typically a DNS domain name. Refer https://accounts.google.com/ManageDomains
Configure Twitter OpenID.

a). Enable Twitter OpenID : Choose to enable Twitter OpenID. If disabled the other Twitter OpenID settings are ignored.

b). Enable Twitter mail confirmation : Select this to make sure that the (Recommended) mail id's registered under Twitter OpenID are verified by confirmation mails.
```
                           CAUTION : This feature  needs the
                           PHP to be configured to use  mail
                           function.
```
c). Twitter Consumer key & Secret Consumer Key : To setupTwitter OpenID you need to create an app in twitter
developer area. From there the consumer key and secret key are to be noted to configure the Twitter OpenID. See https://dev.twitter.com/apps/new
Configure Facebook OpenID.

a). Enable Facebook OpenID: Choose to enable Facebook OpenID. If disabled the other Facebook OpenID settings are ignored.

b). Facebook Consumer key & Secret Consumer Key : To setup Facebook OpenID you need to create an app in facebook developer area. From there the consumer key and secret key are to be noted to configure the Facebook OpenID. See https://developers.facebook.com/apps

For more information refer the docs in OpenID settings page.

3.0 How to use OpenID Module for Login?

Goto ATutor login page. and select "OpenID Login" tab.
OpenID will not work if the Master List is enabled. Else you can see the "Login with Google", "Login with Twitter" and "Login with Facebook" if they are enabled in OpenID settings page.
Click on the OpenID button that you want to login with. The user will be redirected to OpenID providers, where the user will be asked to login and grant access to the app.
After granting access the user will be redirected to ATutor site where the user will be registered and loged in to the ATutor. If the user is already registered he can login directly.
In case of Twitter OpenID the user is required to submit their mail id in the prompt screen on redirection from Twitter. If either "Twitter mail confirmation" setting is set from the OpenID settings or the "email confirmation" is enabled at System preferences of ATutor settings, then the user need to confirm his/her mail by clicking on the link in the registered mail.
Only instructors and students can login to the ATutor with OpenID. The administrators are required to take the login page with username, password combination.

atutor / openid