README

elgg_hybridauth is an authentication tool that allows users to create new Elgg accounts using their social media accounts.

Providers included by default:

AOL
Facebook
Foursquare
Google
LinkedIn
Live
MySpace
OpenID
Twitter
Yahoo

Visit http://hybridauth.sourceforge.net/ for more information about HybridAuth library and additional providers that can be added to this distribution.

Features

Allows a single Elgg profile to be connected to multiple provider accounts
Follows Elgg's native registration workflow
Allows users to authorize / deauthorize providers in their account settings
Optionally, allows administrators to import user settings from elgg_social_login and social_connect
Provides an interface to configure permissions scopes for each provider

Upgrades

When upgrading, disable the plugin first, upload the updated plugin files, and reenable for updated settings to take effect

Provider Setup

Setting up Facebook

Go to https://developers.facebook.com/apps
Create a new App
Select Website with Facebook Login and enter your site URL
Copy your App ID and App Secret to corresponding fields in the plugin settings
For more on permissions scope, visit https://developers.facebook.com/docs/reference/login/
Make sure you have added a Website with URL as a Platform in App Settings
Make sure you have added configured your domains in App Settings
In Facebook Login settings, Enable Embbeded Brwoser OAuth Login
Add http://SITE-URL/hybridauth/endpoint as a Valid OAuth Redirect URI

Setting up Twitter

Go to https://dev.twitter.com/apps/new
Create a new application
Enter a Callback URL: http://SITE-URL/hybridauth/endpoint?hauth.done=Twitter
Copy your Consumer Key and Consumer Secret to the corresponding fields in the plugin settings

Setting up Google

Go to https://code.google.com/apis/console/
Create a new project
Switch to the API Access tab
Click Create an OAauth 2.0 Client ID and fill out the form
In Client ID settings:

Application Type is Web Application Your Site or Hostname - click on More options Authorized Redirect URIs - enter the Authentication URL http://SITE-URL/hybridauth/endpoint?hauth.done=Google
Copy your Client ID and Client secret to corresponding fields in the plugin settings
For more on permissions scope, see https://developers.google.com/accounts/docs/OAuth2Login#consentpageexperience and https://developers.google.com/oauthplayground/
If you are experiencing difficulties with authorizing users using Google:

Ensure that you have activated APIs corresponding to the Permissions Scopes you have listed in the settings: https://developers.google.com/+/api/oauth#scopes Scopes listed by default will require Google+ and Contacts API to work

Setting up LinkedIn

Go to https://www.linkedin.com/secure/developer
Create new application

In OAuth User Agreement, update the default scope to your needs. If you are unsure, check r_basicprofile, r_emailaddress, rw_nus and r_network You do not need to fill out redirect URLs
Copy the API Key into the Public Key field in the plugin settings
Copy the Secret Key into the Private Key field in the plugin settings

Setting up Yahoo!

Go to https://developer.apps.yahoo.com/dashboard/
Create new Project

Fill out the project information In Access Scopes, select This app requires access to private user data. Application Domain - enter http://SITE-URL/hybridauth/endpoint?hauth.done=Yahoo Select APIs for private user data access: requires at least one API to be selected (Social Directory, for example)
Copy the Consumer Key and Consumer Secret to corresponding fields in the plugin settings

Set up Live

Go to https://account.live.com/developers/applications/create
Create you application

Set redirect domain to your site domain, i.e. http://SITE-URL/
Copy Client ID and Client Secret to corresponding fields in the plugin settings

Set up FourSquare

Go to https://foursquare.com/developers/apps
Create your application
Copy Client ID and Client Secret to corresponding fields in the plugin settings

Developer Notes

Since 1.1.1, you can make use of 'hybridauth:authenticate', $provider plugin hook to perform some actions, when the user is authenticated with a provider. This might be a good place to post stuff to user's wall or to grab a profile picture.

Example of how to post to the user's wall that the user Joined the site:

// do stuff when the user is authenticated with one of the providers
elgg_register_plugin_hook_handler('hybridauth:authenticate', 'all', 'elgg_hybridauth_on_authenticate');

function elgg_hybridauth_on_authenticate($hook, $provider, $return, $params) {

	$user = elgg_extract('entity', $params);

	try {
		$ha = new ElggHybridAuth();
		$adapter = $ha->getAdapter($provider);
		if ($adapter->isUserConnected()) {
			$status = $user->name . ' just joined ' . elgg_get_config('sitename') . ' at ' . elgg_get_site_url();
			$adapter->setUserStatus($status);
		}
	} catch (Exception $e) {
		// Something is wrong
	}
}

Upgrading

To 1.3

For performance reasons, HYBRIDAUTH_PUBLIC_AUTH is not longer defined. Call elgg_get_plugin_setting('public_auth', 'elgg_hybridauth') where needed.
base_url and debug_file are no longer set via plugin settings. They are set dynamically using current installation path and wwwroot.
Due to recent changes in LinkedIn scopes, HybridAuth was producing unreliable results. HA LinkedIn class and LinkedIn wrapper were replaced with custom implementation for the sake of stability. https://developer.linkedin.com/support/developer-program-transition

arckinteractive / elgg_hybridauth

Maintainers

Details