Merge of krvss fork

README.rst

@@ -49,6 +49,8 @@ credentials, some features are:
     * `Skyrock OAuth`_
     * `Yahoo OAuth`_
     * `Evernote OAuth`_
+    * `Mail.ru OAuth`_
+    * `Odnoklassniki OAuth`_
 
 - Basic user data population and signaling, to allows custom fields values
   from providers response
@@ -745,6 +747,9 @@ http://127.0.0.1:8000 or http://localhost:8000 because it won't work when
 testing. Instead I define http://myapp.com and setup a mapping on /etc/hosts
 or use dnsmasq_.
 
+If you need to perform authentication from Facebook Canvas application, take a
+look to `Facebook Canvas Application Authentication`_.
+
 Orkut
 ^^^^^
 
@@ -952,6 +957,11 @@ Vkontakte uses OAuth v2 for Authentication
 
   See the `names of the privileges VKontakte`_.
 
+You can also use Vkontakte's own OpenAPI to log in, but you need to provide a HTML template
+with JavaScript code to authenticate. See vkontakte.html in templates folder for details.
+
+To support authentication for VKontakte applications see `authentication for VKontakte applications`_.
+
 MSN Live Connect
 ^^^^^^^^^^^^^^^^
 
@@ -1009,6 +1019,33 @@ Evernote OAuth 1.0 workflow.
       EVERNOTE_CONSUMER_KEY = ''
       EVERNOTE_CONSUMER_SECRET = ''
 
+Yandex OAuth and OpenID
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Yandex uses OAuth 2.0 workflow, fill and YANDEX_APP_ID and YANDEX_API_SECRET settings to log in.
+Currently there are 2 backends for Yandex, one is Yaru to log in using Ya.ru service and another one is
+YandexOAuth that could use service API from settings. Use YANDEX_OAUTH2_API_URL to set up which service to use.
+Tested with 'https://api-yaru.yandex.ru/me/' for Ya.ru and 'http://api.moikrug.ru/v1/my/' for Moi Krug.
+
+Yandex also uses OpenID 2.0. You do not need to provide user's name because Yandex will do it for you.
+
+Mail.ru OAuth
+^^^^^^^^^^^^^
+
+Mail.ru uses OAuth2 workflow, to use it fill in settings
+
+MAILRU_OAUTH2_CLIENT_KEY   		  = ''
+MAILRU_OAUTH2_APP_KEY      		  = ''
+MAILRU_OAUTH2_CLIENT_SECRET       = ''
+
+Odnoklassniki.ru
+^^^^^^^^^^^^^^^^
+
+Odnoklassniki.ru uses OAuth2 workflow, to use it fill in settings
+
+ODNOKLASSNIKI_OAUTH2_CLIENT_KEY    = ''
+ODNOKLASSNIKI_OAUTH2_APP_KEY       = ''
+ODNOKLASSNIKI_OAUTH2_CLIENT_SECRET = ''
 
 Testing
 -------
@@ -1156,6 +1193,10 @@ Attributions to whom deserves:
 - krvss_ (Stas Kravets):
 
   - Initial setup.py configuration
+  - LiveJournal support
+  - Mail.ru, Odnoklassniki support
+  - Yandex OpenID support
+  - VKontakte OpenAPI support
 
 - jezdez_ (Jannis Leidel):
 
@@ -1309,3 +1350,7 @@ Base work is copyrighted by:
 .. _Yahoo Developer Center: https://developer.apps.yahoo.com/projects/
 .. _Evernote API Key form: http://dev.evernote.com/support/api_key.php
 .. _hassek: https://github.com/hassek
+.. _Mail.ru OAuth: http://api.mail.ru/docs/guides/oauth/
+.. _Odnoklassniki OAuth: http://dev.odnoklassniki.ru/wiki/display/ok/The+OAuth+2.0+Protocol
+.. _authentication for VKontakte applications: http://www.ikrvss.ru/2011/11/08/django-social-auh-and-vkontakte-application/
+.. _Facebook Canvas Application Authentication: http://www.ikrvss.ru/2011/09/22/django-social-auth-and-facebook-canvas-applications/

doc/backends/facebook.rst

@@ -32,7 +32,10 @@ http://127.0.0.1:8000 or http://localhost:8000 because it won't work when
 testing. Instead I define http://myapp.com and setup a mapping on /etc/hosts
 or use dnsmasq_.
 
+If you need to perform authentication from Facebook Canvas application, take a
+look to `Facebook Canvas Application Authentication`_.
 
 .. _dnsmasq: http://www.thekelleys.org.uk/dnsmasq/doc.html
 .. _Facebook development resources: http://developers.facebook.com/docs/authentication/
 .. _Facebook App Creation: http://developers.facebook.com/setup/
+.. _Facebook Canvas Application Authentication: http://www.ikrvss.ru/2011/09/22/django-social-auth-and-facebook-canvas-applications/

doc/backends/vkontakte.rst

@@ -15,6 +15,12 @@ Vkontakte uses OAuth v2 for Authentication
 
   See the `names of the privileges VKontakte`_.
 
+You can also use Vkontakte's own OpenAPI to log in, but you need to provide HTML template
+with JavaScript code to authenticate. See vkontakte.html in templates folder for details.
+
+To support authentication for VKontakte applications see `authentication for VKontakte applications`_
+
 .. _Vkontakte OAuth: http://vk.com/developers.php?oid=-1&p=%D0%90%D0%B2%D1%82%D0%BE%D1%80%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D1%81%D0%B0%D0%B9%D1%82%D0%BE%D0%B2
 .. _names of the privileges VKontakte: http://vk.com/developers.php?oid=-1&p=%D0%9F%D1%80%D0%B0%D0%B2%D0%B0_%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0_%D0%BF%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D0%B9
 .. _Vkontakte API: http://vk.com/developers.php
+.. _authentication for VKontakte applications: http://www.ikrvss.ru/2011/11/08/django-social-auh-and-vkontakte-application/

example/local_settings.py.template

@@ -15,14 +15,34 @@ SOCIAL_AUTH_FORCE_RANDOM_USERNAME = False
 SOCIAL_AUTH_DEFAULT_USERNAME      = 'socialauth_user'
 SOCIAL_AUTH_COMPLETE_URL_NAME     = 'socialauth_complete'
 LOGIN_ERROR_URL                   = '/login/error/'
+VKONTAKTE_APP_ID                  = ''
+VKONTAKTE_APP_SECRET              = ''
+# Usage for applications auth: {'key': application_key, 'user_mode': 0 (default) | 1 (check) | 2 (online check) }
+# 0 means is_app_user request parameter is ignored, 1 - must be = 1, 2 - checked via VK API request (useful when user
+# connects to your application on app page and you reload the iframe)
+VKONTAKTE_APP_AUTH                = None
+ODNOKLASSNIKI_OAUTH2_CLIENT_KEY   = ''
+ODNOKLASSNIKI_OAUTH2_APP_KEY      = ''
+ODNOKLASSNIKI_OAUTH2_CLIENT_SECRET = ''
+MAILRU_OAUTH2_CLIENT_KEY   		  = ''
+MAILRU_OAUTH2_APP_KEY      		  = ''
+MAILRU_OAUTH2_CLIENT_SECRET       = ''
 #SOCIAL_AUTH_USER_MODEL            = 'app.CustomUser'
 SOCIAL_AUTH_ERROR_KEY             = 'socialauth_error'
 GITHUB_APP_ID                     = ''
 GITHUB_API_SECRET                 = ''
 FOURSQUARE_CONSUMER_KEY           = ''
 FOURSQUARE_CONSUMER_SECRET        = ''
-VK_APP_ID                         = ''
-VK_API_SECRET                     = ''
+YANDEX_OAUTH2_CLIENT_KEY          = ''
+YANDEX_OAUTH2_CLIENT_SECRET       = ''
+YANDEX_OAUTH2_API_URL             = 'https://api-yaru.yandex.ru/me/' # http://api.moikrug.ru/v1/my/ for Moi Krug
+
+# Backward compatibility
+YANDEX_APP_ID = YANDEX_OAUTH2_CLIENT_KEY
+YANDEX_API_SECRET = YANDEX_OAUTH2_CLIENT_SECRET
+
+VK_APP_ID = VKONTAKTE_APP_ID
+VK_API_SECRET = VKONTAKTE_APP_SECRET
 
 SOCIAL_AUTH_PIPELINE = (
     'social_auth.backends.pipeline.social.social_auth_user',

example/settings.py

@@ -79,13 +79,17 @@
     'social_auth.backends.contrib.flickr.FlickrBackend',
     'social_auth.backends.contrib.instagram.InstagramBackend',
     'social_auth.backends.contrib.github.GithubBackend',
-    'social_auth.backends.contrib.vkontakte.VkontakteBackend',
     'social_auth.backends.contrib.yandex.YandexBackend',
-    'social_auth.backends.contrib.yandex.YaruBackend',
     'social_auth.backends.contrib.yahoo.YahooOAuthBackend',
     'social_auth.backends.OpenIDBackend',
     'social_auth.backends.contrib.livejournal.LiveJournalBackend',
     'social_auth.backends.browserid.BrowserIDBackend',
+    'social_auth.backends.contrib.vkontakte.VKontakteBackend',
+    'social_auth.backends.contrib.yandex.YandexOAuth2Backend',
+    'social_auth.backends.contrib.yandex.YaruBackend',
+    'social_auth.backends.contrib.odnoklassniki.OdnoklassnikiBackend',
+    'social_auth.backends.contrib.vkontakte.VKontakteOAuth2Backend',
+    'social_auth.backends.contrib.mailru.MailruBackend',
     'django.contrib.auth.backends.ModelBackend',
 )
 

example/templates/home.html

@@ -87,4 +87,11 @@ <h3>Login using <a href="https://browserid.org/" title="BrowserID">BrowserID</a>
     </script>
   </form>
 </div>
+
+<div>
+  <h3>Login using other authentication systems:</h3>
+  	<ul>
+  		<li><a rel="nofollow" href="{% url socialauth_begin "vkontakte" %}">VKontakte OpenAPI</a></li>
+	</ul>
+</div>
 {% endblock %}

example/templates/vkontakte.html

@@ -0,0 +1,39 @@
+{% extends "base.html" %}
+
+{% block heading %}<a href="http://www.vkontakte.ru">VKontakte</a> login{% endblock %}
+
+{% block content %}
+
+<script src="http://vkontakte.ru/js/api/openapi.js" type="text/javascript"></script>
+
+<script type="text/javascript">
+	var vkAppId = {{ VK_APP_ID|default:"null" }};
+
+	if (vkAppId)
+  		VK.init({ apiId: vkAppId });
+
+	function authVK() {
+		if (!vkAppId) {
+			alert ("Please specify VKontakte APP ID in your local settings file");
+			return false;
+		}
+
+		VK.Auth.login(function(response) {
+			var params = "";
+			if (response.session) {
+				params = "first_name=" + encodeURI(response.session.user.first_name) + "&last_name=" + encodeURI(response.session.user.last_name);
+				params += "&nickname=" + encodeURI(response.session.user.nickname) + "&id=" + encodeURI(response.session.user.id);
+			}
+			window.location = "{{ VK_COMPLETE_URL }}?" + params;
+
+		});
+
+		return false;
+	}
+
+</script>
+
+<p>
+    <a href="javascript:void(0);" onclick="authVK();">Click to authorize</a>
+</p>
+{% endblock %}

setup.py

@@ -37,6 +37,7 @@ def long_description():
                 'social_auth.backends',
                 'social_auth.backends.contrib',
                 'social_auth.backends.pipeline'],
+      package_data={'social_auth':['locale/*/LC_MESSAGES/*']},
       long_description=long_description(),
       install_requires=['django>=1.2.5',
                         'oauth2>=1.5.167',

social_auth/backends/contrib/mailru.py

@@ -0,0 +1,98 @@
+"""
+Mail.ru OAuth2 support
+
+Take a look to http://api.mail.ru/docs/guides/oauth/
+
+You need to register OAuth site here:
+http://api.mail.ru/sites/my/add
+
+Then update your settings values using registration information
+
+"""
+
+from django.conf import settings
+from django.utils import simplejson
+
+from urllib import urlencode, unquote
+from urllib2 import Request, urlopen, HTTPError
+from hashlib import md5
+
+from social_auth.backends import OAuthBackend, BaseOAuth2, USERNAME
+from social_auth.utils import setting, log
+
+MAILRU_API_URL       = 'http://www.appsmail.ru/platform/api'
+MAILRU_OAUTH2_SCOPE  = ['']
+
+EXPIRES_NAME = getattr(settings, 'SOCIAL_AUTH_EXPIRATION', 'expires')
+
+class MailruBackend(OAuthBackend):
+    """Mail.ru authentication backend"""
+    name = 'mailru-oauth2'
+    EXTRA_DATA = [('refresh_token', 'refresh_token'),
+                  ('expires_in', EXPIRES_NAME)]
+
+    def get_user_id(self, details, response):
+        """Return user unique id provided by Mail.ru"""
+        return response['uid']
+
+    def get_user_details(self, response):
+        """Return user details from Mail.ru request"""
+        values = { USERNAME: unquote(response['nick']), 'email': unquote(response['email']),
+                  'first_name': unquote(response['first_name']), 'last_name': unquote(response['last_name'])}
+
+        if values['first_name'] and values['last_name']:
+            values['fullname'] = "%s %s" % (values['first_name'], values['last_name'])
+        return values
+
+
+class MailruOAuth2(BaseOAuth2):
+    """Mail.ru OAuth2 support"""
+    AUTH_BACKEND = MailruBackend
+    AUTHORIZATION_URL = 'https://connect.mail.ru/oauth/authorize'
+    ACCESS_TOKEN_URL = 'https://connect.mail.ru/oauth/token'
+    SETTINGS_KEY_NAME = 'MAILRU_OAUTH2_CLIENT_KEY'
+    SETTINGS_SECRET_NAME = 'MAILRU_OAUTH2_CLIENT_SECRET'
+
+    def get_scope(self):
+        return setting('MAILRU_OAUTH2_EXTRA_SCOPE', [])
+
+    def auth_complete(self, *args, **kwargs):
+        try:
+            auth_result = super(MailruOAuth2, self).auth_complete(*args, **kwargs)
+        except HTTPError: # Mail.ru returns HTTPError 400 if cancelled
+            raise ValueError('Authentication cancelled')
+
+        return auth_result
+
+    def user_data(self, access_token, *args, **kwargs):
+        """Return user data from Mail.ru REST API"""
+        data = {'method': 'users.getInfo', 'session_key': access_token}
+        return mailru_api(data)[0]
+
+def mailru_sig(data):
+    """ Calculates signature of request data """
+
+    param_list = sorted(list(item + '=' + data[item] for item in data))
+
+    return md5(''.join(param_list) + settings.MAILRU_OAUTH2_CLIENT_SECRET).hexdigest() 
+
+def mailru_api(data):
+    """ Calls Mail.ru REST API method
+        http://api.mail.ru/docs/guides/restapi/
+    """
+    data.update({'app_id': settings.MAILRU_OAUTH2_CLIENT_KEY, 'secure': '1'})
+    data['sig'] = mailru_sig(data)
+
+    params = urlencode(data)
+    request = Request(MAILRU_API_URL, params)
+    try:
+        return simplejson.loads(urlopen(request).read())
+    except (TypeError, KeyError, IOError, ValueError, IndexError):
+        log('error', 'Could not load data from Mail.ru.', exc_info=True, extra=dict(data=params))
+        return None
+
+
+# Backend definition
+BACKENDS = {
+    'mailru-oauth2': MailruOAuth2
+}