mirror of
https://github.com/chanzuckerberg/cellxgene.git
synced 2026-09-17 05:47:58 +08:00
5285556415
* Add basic authentication in the server A pattern for creating authentication methods is introduced, with three authentication types defined: none - no authentication session - like the current session based auth used for user annotations test - used to test the login/logout process end to end The config endpoint now returns informations about the authentication, like if the user is authenticated and their username. The redirect uri's for login and logout are also returned if the authentication type requires login This is the first a several PRs for authentication. *. Update server tests to avoid hardcoded ports test_api and test_nan_rest now use a common function for starting a test server, than will initially choose a random port.
70 lines
2.2 KiB
Python
70 lines
2.2 KiB
Python
from server.auth.auth import AuthTypeClientBase, AuthTypeFactory
|
|
from flask import session, request, redirect, current_app
|
|
|
|
|
|
class AuthTypeTest(AuthTypeClientBase):
|
|
"""An authentication type for testing client based logins. When the login route is accessed
|
|
the user is automatically logged in with a default or configured username"""
|
|
|
|
# key in session token with userid and username
|
|
CXGUID = "cxguid_test"
|
|
CXGUNAME = "cxguname_test"
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
self.username = "test_account"
|
|
self.userid = "id0001"
|
|
|
|
def is_valid(self):
|
|
return True
|
|
|
|
def requires_client_login(self):
|
|
return True
|
|
|
|
def add_url_rules(self, app):
|
|
app.add_url_rule("/login", "login", self.login, methods=["GET"])
|
|
app.add_url_rule("/logout", "logout", self.logout, methods=["GET"])
|
|
|
|
def set_params(self, params):
|
|
if params:
|
|
self.username = params.get("username", self.username)
|
|
self.userid = params.get("userid", self.userid)
|
|
|
|
def is_authenticated(self):
|
|
return self.CXGUID in session
|
|
|
|
def get_userid(self):
|
|
return session.get(self.CXGUID)
|
|
|
|
def get_username(self):
|
|
return session.get(self.CXGUNAME)
|
|
|
|
def login(self):
|
|
args = request.args
|
|
return_to = args.get("dataset", "/")
|
|
session[self.CXGUID] = args.get("userid", self.userid)
|
|
session[self.CXGUNAME] = args.get("username", self.username)
|
|
return redirect(return_to)
|
|
|
|
def logout(self):
|
|
session.clear()
|
|
return_to = request.args.get("dataset", "/")
|
|
return redirect(return_to)
|
|
|
|
def get_login_url(self, data_adaptor):
|
|
"""Return the url for the login route"""
|
|
if current_app.app_config.is_multi_dataset():
|
|
return f"/login?dataset={data_adaptor.uri_path}"
|
|
else:
|
|
return "/login"
|
|
|
|
def get_logout_url(self, data_adaptor):
|
|
"""Return the url for the logout route"""
|
|
if current_app.app_config.is_multi_dataset():
|
|
return f"/logout?dataset={data_adaptor.uri_path}"
|
|
else:
|
|
return "/logout"
|
|
|
|
|
|
AuthTypeFactory.register("test", AuthTypeTest)
|