diff options
Diffstat (limited to 'mediagoblin/plugins/oauth/__init__.py')
-rw-r--r-- | mediagoblin/plugins/oauth/__init__.py | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/mediagoblin/plugins/oauth/__init__.py b/mediagoblin/plugins/oauth/__init__.py new file mode 100644 index 00000000..af39ae93 --- /dev/null +++ b/mediagoblin/plugins/oauth/__init__.py @@ -0,0 +1,90 @@ +# GNU MediaGoblin -- federated, autonomous media hosting +# Copyright (C) 2011, 2012 MediaGoblin contributors. See AUTHORS. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +import os +import logging + +from routes.route import Route +from webob import exc + +from mediagoblin.tools import pluginapi +from mediagoblin.tools.response import render_to_response +from mediagoblin.plugins.oauth.models import OAuthToken + +_log = logging.getLogger(__name__) + +PLUGIN_DIR = os.path.dirname(__file__) + + +def setup_plugin(): + config = pluginapi.get_config('mediagoblin.plugins.oauth') + + _log.info('Setting up OAuth...') + _log.debug('OAuth config: {0}'.format(config)) + + routes = [ + Route('mediagoblin.plugins.oauth.authorize', '/oauth/authorize', + controller='mediagoblin.plugins.oauth.views:authorize'), + Route('mediagoblin.plugins.oauth.test', '/api/test', + controller='mediagoblin.plugins.oauth.views:api_test'), + Route('mediagoblin.plugins.oauth.access_token', '/oauth/access_token', + controller='mediagoblin.plugins.oauth.views:access_token')] + + pluginapi.register_routes(routes) + pluginapi.register_template_path(os.path.join(PLUGIN_DIR, 'templates')) + + +class OAuthAuth(object): + ''' + An object with two significant methods, 'trigger' and 'run'. + + Using a similar object to this, plugins can register specific + authentication logic, for example the GET param 'access_token' for OAuth. + + - trigger: Analyze the 'request' argument, return True if you think you + can handle the request, otherwise return False + - run: The authentication logic, set the request.user object to the user + you intend to authenticate and return True, otherwise return False. + + If run() returns False, an HTTP 403 Forbidden error will be shown. + + You may also display custom errors, just raise them within the run() + method. + ''' + def __init__(self): + pass + + def trigger(self, request): + return True + + def __call__(self, request, *args, **kw): + access_token = request.GET.get('access_token') + if access_token: + token = OAuthToken.query.filter(OAuthToken.token == access_token)\ + .first() + + if not token: + return False + + request.user = token.user + + return True + + +hooks = { + 'setup': setup_plugin, + 'auth': OAuthAuth() + } |