mirror of
https://mau.dev/maunium/synapse.git
synced 2024-10-01 01:36:05 -04:00
266 lines
10 KiB
Python
266 lines
10 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2014, 2015 OpenMarket Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
from twisted.internet import defer
|
|
|
|
from synapse.api.errors import SynapseError, LoginError, Codes
|
|
from synapse.http.client import SimpleHttpClient
|
|
from synapse.types import UserID
|
|
from base import ClientV1RestServlet, client_path_pattern
|
|
|
|
import simplejson as json
|
|
import urllib
|
|
|
|
import logging
|
|
from saml2 import BINDING_HTTP_POST
|
|
from saml2 import config
|
|
from saml2.client import Saml2Client
|
|
|
|
import xml.etree.ElementTree as ET
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class LoginRestServlet(ClientV1RestServlet):
|
|
PATTERN = client_path_pattern("/login$")
|
|
PASS_TYPE = "m.login.password"
|
|
SAML2_TYPE = "m.login.saml2"
|
|
CAS_TYPE = "m.login.cas"
|
|
|
|
def __init__(self, hs):
|
|
super(LoginRestServlet, self).__init__(hs)
|
|
self.idp_redirect_url = hs.config.saml2_idp_redirect_url
|
|
self.saml2_enabled = hs.config.saml2_enabled
|
|
self.cas_enabled = hs.config.cas_enabled
|
|
|
|
self.cas_server_url = hs.config.cas_server_url
|
|
self.servername = hs.config.server_name
|
|
|
|
def on_GET(self, request):
|
|
flows = [{"type": LoginRestServlet.PASS_TYPE}]
|
|
if self.saml2_enabled:
|
|
flows.append({"type": LoginRestServlet.SAML2_TYPE})
|
|
if self.cas_enabled:
|
|
flows.append({"type": LoginRestServlet.CAS_TYPE})
|
|
return (200, {"flows": flows})
|
|
|
|
def on_OPTIONS(self, request):
|
|
return (200, {})
|
|
|
|
@defer.inlineCallbacks
|
|
def on_POST(self, request):
|
|
login_submission = _parse_json(request)
|
|
try:
|
|
if login_submission["type"] == LoginRestServlet.PASS_TYPE:
|
|
result = yield self.do_password_login(login_submission)
|
|
defer.returnValue(result)
|
|
elif self.saml2_enabled and (login_submission["type"] ==
|
|
LoginRestServlet.SAML2_TYPE):
|
|
relay_state = ""
|
|
if "relay_state" in login_submission:
|
|
relay_state = "&RelayState="+urllib.quote(
|
|
login_submission["relay_state"])
|
|
result = {
|
|
"uri": "%s%s" % (self.idp_redirect_url, relay_state)
|
|
}
|
|
defer.returnValue((200, result))
|
|
elif self.cas_enabled and (login_submission["type"] ==
|
|
LoginRestServlet.CAS_TYPE):
|
|
# TODO: get this from the homeserver rather than creating a new one for
|
|
# each request
|
|
http_client = SimpleHttpClient(self.hs)
|
|
uri = "%s/proxyValidate" % (self.cas_server_url,)
|
|
args = {
|
|
"ticket": login_submission["ticket"],
|
|
"service": login_submission["service"]
|
|
}
|
|
body = yield http_client.get_raw(uri, args)
|
|
result = yield self.do_cas_login(body)
|
|
defer.returnValue(result)
|
|
else:
|
|
raise SynapseError(400, "Bad login type.")
|
|
except KeyError:
|
|
raise SynapseError(400, "Missing JSON keys.")
|
|
|
|
@defer.inlineCallbacks
|
|
def do_password_login(self, login_submission):
|
|
if 'medium' in login_submission and 'address' in login_submission:
|
|
user_id = yield self.hs.get_datastore().get_user_id_by_threepid(
|
|
login_submission['medium'], login_submission['address']
|
|
)
|
|
else:
|
|
user_id = login_submission['user']
|
|
|
|
if not user_id.startswith('@'):
|
|
user_id = UserID.create(
|
|
user_id, self.hs.hostname
|
|
).to_string()
|
|
|
|
auth_handler = self.handlers.auth_handler
|
|
user_id, access_token, refresh_token = yield auth_handler.login_with_password(
|
|
user_id=user_id,
|
|
password=login_submission["password"])
|
|
|
|
result = {
|
|
"user_id": user_id, # may have changed
|
|
"access_token": access_token,
|
|
"refresh_token": refresh_token,
|
|
"home_server": self.hs.hostname,
|
|
}
|
|
|
|
defer.returnValue((200, result))
|
|
|
|
@defer.inlineCallbacks
|
|
def do_cas_login(self, cas_response_body):
|
|
root = ET.fromstring(cas_response_body)
|
|
if not root.tag.endswith("serviceResponse"):
|
|
raise LoginError(401, "Invalid CAS response", errcode=Codes.UNAUTHORIZED)
|
|
if not root[0].tag.endswith("authenticationSuccess"):
|
|
raise LoginError(401, "Unsuccessful CAS response", errcode=Codes.UNAUTHORIZED)
|
|
for child in root[0]:
|
|
if child.tag.endswith("user"):
|
|
user = child.text
|
|
user_id = UserID.create(user, self.hs.hostname).to_string()
|
|
auth_handler = self.handlers.auth_handler
|
|
user_exists = yield auth_handler.does_user_exist(user_id)
|
|
if user_exists:
|
|
user_id, access_token, refresh_token = (
|
|
yield auth_handler.login_with_cas_user_id(user_id)
|
|
)
|
|
result = {
|
|
"user_id": user_id, # may have changed
|
|
"access_token": access_token,
|
|
"refresh_token": refresh_token,
|
|
"home_server": self.hs.hostname,
|
|
}
|
|
|
|
else:
|
|
user_id, access_token = (
|
|
yield self.handlers.registration_handler.register(localpart=user)
|
|
)
|
|
result = {
|
|
"user_id": user_id, # may have changed
|
|
"access_token": access_token,
|
|
"home_server": self.hs.hostname,
|
|
}
|
|
|
|
defer.returnValue((200, result))
|
|
|
|
raise LoginError(401, "Invalid CAS response", errcode=Codes.UNAUTHORIZED)
|
|
|
|
|
|
class LoginFallbackRestServlet(ClientV1RestServlet):
|
|
PATTERN = client_path_pattern("/login/fallback$")
|
|
|
|
def on_GET(self, request):
|
|
# TODO(kegan): This should be returning some HTML which is capable of
|
|
# hitting LoginRestServlet
|
|
return (200, {})
|
|
|
|
|
|
class PasswordResetRestServlet(ClientV1RestServlet):
|
|
PATTERN = client_path_pattern("/login/reset")
|
|
|
|
@defer.inlineCallbacks
|
|
def on_POST(self, request):
|
|
reset_info = _parse_json(request)
|
|
try:
|
|
email = reset_info["email"]
|
|
user_id = reset_info["user_id"]
|
|
handler = self.handlers.login_handler
|
|
yield handler.reset_password(user_id, email)
|
|
# purposefully give no feedback to avoid people hammering different
|
|
# combinations.
|
|
defer.returnValue((200, {}))
|
|
except KeyError:
|
|
raise SynapseError(
|
|
400,
|
|
"Missing keys. Requires 'email' and 'user_id'."
|
|
)
|
|
|
|
|
|
class SAML2RestServlet(ClientV1RestServlet):
|
|
PATTERN = client_path_pattern("/login/saml2")
|
|
|
|
def __init__(self, hs):
|
|
super(SAML2RestServlet, self).__init__(hs)
|
|
self.sp_config = hs.config.saml2_config_path
|
|
|
|
@defer.inlineCallbacks
|
|
def on_POST(self, request):
|
|
saml2_auth = None
|
|
try:
|
|
conf = config.SPConfig()
|
|
conf.load_file(self.sp_config)
|
|
SP = Saml2Client(conf)
|
|
saml2_auth = SP.parse_authn_request_response(
|
|
request.args['SAMLResponse'][0], BINDING_HTTP_POST)
|
|
except Exception, e: # Not authenticated
|
|
logger.exception(e)
|
|
if saml2_auth and saml2_auth.status_ok() and not saml2_auth.not_signed:
|
|
username = saml2_auth.name_id.text
|
|
handler = self.handlers.registration_handler
|
|
(user_id, token) = yield handler.register_saml2(username)
|
|
# Forward to the RelayState callback along with ava
|
|
if 'RelayState' in request.args:
|
|
request.redirect(urllib.unquote(
|
|
request.args['RelayState'][0]) +
|
|
'?status=authenticated&access_token=' +
|
|
token + '&user_id=' + user_id + '&ava=' +
|
|
urllib.quote(json.dumps(saml2_auth.ava)))
|
|
request.finish()
|
|
defer.returnValue(None)
|
|
defer.returnValue((200, {"status": "authenticated",
|
|
"user_id": user_id, "token": token,
|
|
"ava": saml2_auth.ava}))
|
|
elif 'RelayState' in request.args:
|
|
request.redirect(urllib.unquote(
|
|
request.args['RelayState'][0]) +
|
|
'?status=not_authenticated')
|
|
request.finish()
|
|
defer.returnValue(None)
|
|
defer.returnValue((200, {"status": "not_authenticated"}))
|
|
|
|
|
|
class CasRestServlet(ClientV1RestServlet):
|
|
PATTERN = client_path_pattern("/login/cas")
|
|
|
|
def __init__(self, hs):
|
|
super(CasRestServlet, self).__init__(hs)
|
|
self.cas_server_url = hs.config.cas_server_url
|
|
|
|
def on_GET(self, request):
|
|
return (200, {"serverUrl": self.cas_server_url})
|
|
|
|
|
|
def _parse_json(request):
|
|
try:
|
|
content = json.loads(request.content.read())
|
|
if type(content) != dict:
|
|
raise SynapseError(400, "Content must be a JSON object.")
|
|
return content
|
|
except ValueError:
|
|
raise SynapseError(400, "Content not JSON.")
|
|
|
|
|
|
def register_servlets(hs, http_server):
|
|
LoginRestServlet(hs).register(http_server)
|
|
if hs.config.saml2_enabled:
|
|
SAML2RestServlet(hs).register(http_server)
|
|
if hs.config.cas_enabled:
|
|
CasRestServlet(hs).register(http_server)
|
|
# TODO PasswordResetRestServlet(hs).register(http_server)
|