This commit is the 12th commit of a comprehensive refactor of our HTTP framework. See odoo/odoo#78857 for complete historic, discussions and rationnals. The web module is twofold, on one side there are many controllers: /, /web, /web/login, /web/database/selector, /web/dataset/call_kw, etc, on the other side there is `session_info`: the method responsible to create the web client's environ. This module is kinda an exception as it is (with base) a server wide module. In the case of the HTTP framework, it means that the controllers of web are always accessible, i.e. going to / or /web/login will never return a 404 Not Found even if the user is not connected to a database. This is both a blessing and a curse. It is a blessing because the controllers are always accessible it means that a new users can freely access those routes. It is a curse because *any* user can access them, even user who don't have a session yet thus who are not connected to a database yet. From a developer standpoint, we have to put extra care to correct serve users with and without a database. An example is the /web/login route, the login/password pair is stored in a database, without database it is impossible to validate a user login but users can still access this route without db. To solve this problem, there is the `ensure_db` function. This function attempts to find a database using various sources (?db= query-string, session db, mono db) and to save it on the user session. In case no db is found, the user is redirected to the database selector. In a way, this function grants a database to the user in a seamingly experience. In a way, this function brings a welcome differentiation between `auth='none'` with a database and `auth='none'` without a database. Such differentiation only matters for the server wide modules as "regular" module controllers are only accessible via the ir.http routing map, i.e. it is not possible to declare a nodb controller outside of server wide modules. An important changement is the `session.authenticate` method, before it was possible to call the method when the cursor was not yet initialized, authenticate would open a cursor against the given database, setup a registry and an environment and ultimately save everything on the current request. Because the cursor is now greedily created, it is no more possible to update the request environment when authenticating on another database. PR: odoo#78857 Task: 2571224
204 lines
7.6 KiB
Python
204 lines
7.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Part of Odoo. See LICENSE file for full copyright and licensing details.
|
|
|
|
import functools
|
|
import logging
|
|
|
|
import json
|
|
|
|
import werkzeug.urls
|
|
import werkzeug.utils
|
|
from werkzeug.exceptions import BadRequest
|
|
|
|
from odoo import api, http, SUPERUSER_ID, _
|
|
from odoo.exceptions import AccessDenied
|
|
from odoo.http import request
|
|
from odoo import registry as registry_get
|
|
|
|
from odoo.addons.auth_signup.controllers.main import AuthSignupHome as Home
|
|
from odoo.addons.web.controllers.main import ensure_db, _get_login_redirect_url
|
|
|
|
|
|
_logger = logging.getLogger(__name__)
|
|
|
|
|
|
#----------------------------------------------------------
|
|
# helpers
|
|
#----------------------------------------------------------
|
|
def fragment_to_query_string(func):
|
|
@functools.wraps(func)
|
|
def wrapper(self, *a, **kw):
|
|
kw.pop('debug', False)
|
|
if not kw:
|
|
return """<html><head><script>
|
|
var l = window.location;
|
|
var q = l.hash.substring(1);
|
|
var r = l.pathname + l.search;
|
|
if(q.length !== 0) {
|
|
var s = l.search ? (l.search === '?' ? '' : '&') : '?';
|
|
r = l.pathname + l.search + s + q;
|
|
}
|
|
if (r == l.pathname) {
|
|
r = '/';
|
|
}
|
|
window.location = r;
|
|
</script></head><body></body></html>"""
|
|
return func(self, *a, **kw)
|
|
return wrapper
|
|
|
|
|
|
#----------------------------------------------------------
|
|
# Controller
|
|
#----------------------------------------------------------
|
|
class OAuthLogin(Home):
|
|
def list_providers(self):
|
|
try:
|
|
providers = request.env['auth.oauth.provider'].sudo().search_read([('enabled', '=', True)])
|
|
except Exception:
|
|
providers = []
|
|
for provider in providers:
|
|
return_url = request.httprequest.url_root + 'auth_oauth/signin'
|
|
state = self.get_state(provider)
|
|
params = dict(
|
|
response_type='token',
|
|
client_id=provider['client_id'],
|
|
redirect_uri=return_url,
|
|
scope=provider['scope'],
|
|
state=json.dumps(state),
|
|
)
|
|
provider['auth_link'] = "%s?%s" % (provider['auth_endpoint'], werkzeug.urls.url_encode(params))
|
|
return providers
|
|
|
|
def get_state(self, provider):
|
|
redirect = request.params.get('redirect') or 'web'
|
|
if not redirect.startswith(('//', 'http://', 'https://')):
|
|
redirect = '%s%s' % (request.httprequest.url_root, redirect[1:] if redirect[0] == '/' else redirect)
|
|
state = dict(
|
|
d=request.session.db,
|
|
p=provider['id'],
|
|
r=werkzeug.urls.url_quote_plus(redirect),
|
|
)
|
|
token = request.params.get('token')
|
|
if token:
|
|
state['t'] = token
|
|
return state
|
|
|
|
@http.route()
|
|
def web_login(self, *args, **kw):
|
|
ensure_db()
|
|
if request.httprequest.method == 'GET' and request.session.uid and request.params.get('redirect'):
|
|
# Redirect if already logged in and redirect param is present
|
|
return request.redirect(request.params.get('redirect'))
|
|
providers = self.list_providers()
|
|
|
|
response = super(OAuthLogin, self).web_login(*args, **kw)
|
|
if response.is_qweb:
|
|
error = request.params.get('oauth_error')
|
|
if error == '1':
|
|
error = _("Sign up is not allowed on this database.")
|
|
elif error == '2':
|
|
error = _("Access Denied")
|
|
elif error == '3':
|
|
error = _("You do not have access to this database or your invitation has expired. Please ask for an invitation and be sure to follow the link in your invitation email.")
|
|
else:
|
|
error = None
|
|
|
|
response.qcontext['providers'] = providers
|
|
if error:
|
|
response.qcontext['error'] = error
|
|
|
|
return response
|
|
|
|
def get_auth_signup_qcontext(self):
|
|
result = super(OAuthLogin, self).get_auth_signup_qcontext()
|
|
result["providers"] = self.list_providers()
|
|
return result
|
|
|
|
|
|
class OAuthController(http.Controller):
|
|
|
|
@http.route('/auth_oauth/signin', type='http', auth='none')
|
|
@fragment_to_query_string
|
|
def signin(self, **kw):
|
|
state = json.loads(kw['state'])
|
|
dbname = state['d']
|
|
if not http.db_filter([dbname]):
|
|
return BadRequest()
|
|
provider = state['p']
|
|
context = state.get('c', {})
|
|
registry = registry_get(dbname)
|
|
with registry.cursor() as cr:
|
|
try:
|
|
env = api.Environment(cr, SUPERUSER_ID, context)
|
|
db, login, key = env['res.users'].sudo().auth_oauth(provider, kw)
|
|
cr.commit()
|
|
action = state.get('a')
|
|
menu = state.get('m')
|
|
redirect = werkzeug.urls.url_unquote_plus(state['r']) if state.get('r') else False
|
|
url = '/web'
|
|
if redirect:
|
|
url = redirect
|
|
elif action:
|
|
url = '/web#action=%s' % action
|
|
elif menu:
|
|
url = '/web#menu_id=%s' % menu
|
|
|
|
pre_uid = request.session.authenticate(db, login, key)
|
|
resp = request.redirect(_get_login_redirect_url(pre_uid, url), 303)
|
|
resp.autocorrect_location_header = False
|
|
|
|
# Since /web is hardcoded, verify user has right to land on it
|
|
if werkzeug.urls.url_parse(resp.location).path == '/web' and not request.env.user.has_group('base.group_user'):
|
|
resp.location = '/'
|
|
return resp
|
|
except AttributeError:
|
|
# auth_signup is not installed
|
|
_logger.error("auth_signup not installed on database %s: oauth sign up cancelled." % (dbname,))
|
|
url = "/web/login?oauth_error=1"
|
|
except AccessDenied:
|
|
# oauth credentials not valid, user could be on a temporary session
|
|
_logger.info('OAuth2: access denied, redirect to main page in case a valid session exists, without setting cookies')
|
|
url = "/web/login?oauth_error=3"
|
|
redirect = request.redirect(url, 303)
|
|
redirect.autocorrect_location_header = False
|
|
return redirect
|
|
except Exception as e:
|
|
# signup error
|
|
_logger.exception("OAuth2: %s" % str(e))
|
|
url = "/web/login?oauth_error=2"
|
|
|
|
redirect = request.redirect(url, 303)
|
|
redirect.autocorrect_location_header = False
|
|
return redirect
|
|
|
|
@http.route('/auth_oauth/oea', type='http', auth='none')
|
|
def oea(self, **kw):
|
|
"""login user via Odoo Account provider"""
|
|
dbname = kw.pop('db', None)
|
|
if not dbname:
|
|
dbname = request.db
|
|
if not dbname:
|
|
raise BadRequest()
|
|
if not http.db_filter([dbname]):
|
|
raise BadRequest()
|
|
|
|
registry = registry_get(dbname)
|
|
with registry.cursor() as cr:
|
|
try:
|
|
env = api.Environment(cr, SUPERUSER_ID, {})
|
|
provider = env.ref('auth_oauth.provider_openerp')
|
|
except ValueError:
|
|
redirect = request.redirect(f'/web?db={dbname}', 303)
|
|
redirect.autocorrect_location_header = False
|
|
return redirect
|
|
assert provider._name == 'auth.oauth.provider'
|
|
|
|
state = {
|
|
'd': dbname,
|
|
'p': provider.id,
|
|
'c': {'no_user_creation': True},
|
|
}
|
|
|
|
kw['state'] = json.dumps(state)
|
|
return self.signin(**kw)
|