2014-08-12 10:10:52 -04:00
|
|
|
# -*- coding: utf-8 -*-
|
2016-01-06 23:26:29 -05:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2014-08-12 10:10:52 -04:00
|
|
|
#
|
|
|
|
# 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.
|
2014-08-12 22:14:34 -04:00
|
|
|
|
2014-08-12 10:10:52 -04:00
|
|
|
from twisted.internet import defer
|
|
|
|
|
2015-10-07 09:45:57 -04:00
|
|
|
from synapse.api.errors import SynapseError, LoginError, Codes
|
2014-08-14 11:40:15 -04:00
|
|
|
from synapse.types import UserID
|
2016-02-12 08:46:59 -05:00
|
|
|
from synapse.http.server import finish_request
|
2016-03-09 06:26:26 -05:00
|
|
|
from synapse.http.servlet import parse_json_object_from_request
|
2017-03-13 13:27:51 -04:00
|
|
|
from synapse.util.msisdn import phone_number_to_msisdn
|
2016-02-12 08:46:59 -05:00
|
|
|
|
2016-03-08 06:45:50 -05:00
|
|
|
from .base import ClientV1RestServlet, client_path_patterns
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2015-02-11 09:23:10 -05:00
|
|
|
import simplejson as json
|
2015-07-07 08:10:30 -04:00
|
|
|
import urllib
|
2015-11-05 09:01:12 -05:00
|
|
|
import urlparse
|
2015-07-07 08:10:30 -04:00
|
|
|
|
|
|
|
import logging
|
|
|
|
from saml2 import BINDING_HTTP_POST
|
|
|
|
from saml2 import config
|
|
|
|
from saml2.client import Saml2Client
|
2015-07-09 03:28:15 -04:00
|
|
|
|
2015-10-07 09:45:57 -04:00
|
|
|
import xml.etree.ElementTree as ET
|
|
|
|
|
2017-03-14 09:37:36 -04:00
|
|
|
from twisted.web.client import PartialDownloadError
|
|
|
|
|
2015-07-09 03:28:15 -04:00
|
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
2014-08-12 10:10:52 -04:00
|
|
|
|
|
|
|
|
2017-03-13 13:27:51 -04:00
|
|
|
def login_submission_legacy_convert(submission):
|
|
|
|
"""
|
|
|
|
If the input login submission is an old style object
|
|
|
|
(ie. with top-level user / medium / address) convert it
|
|
|
|
to a typed object.
|
|
|
|
"""
|
|
|
|
if "user" in submission:
|
|
|
|
submission["identifier"] = {
|
|
|
|
"type": "m.id.user",
|
|
|
|
"user": submission["user"],
|
|
|
|
}
|
|
|
|
del submission["user"]
|
|
|
|
|
|
|
|
if "medium" in submission and "address" in submission:
|
|
|
|
submission["identifier"] = {
|
|
|
|
"type": "m.id.thirdparty",
|
|
|
|
"medium": submission["medium"],
|
|
|
|
"address": submission["address"],
|
|
|
|
}
|
|
|
|
del submission["medium"]
|
|
|
|
del submission["address"]
|
|
|
|
|
|
|
|
|
|
|
|
def login_id_thirdparty_from_phone(identifier):
|
|
|
|
"""
|
|
|
|
Convert a phone login identifier type to a generic threepid identifier
|
|
|
|
Args:
|
|
|
|
identifier(dict): Login identifier dict of type 'm.id.phone'
|
|
|
|
|
|
|
|
Returns: Login identifier dict of type 'm.id.threepid'
|
|
|
|
"""
|
|
|
|
if "country" not in identifier or "number" not in identifier:
|
|
|
|
raise SynapseError(400, "Invalid phone-type identifier")
|
|
|
|
|
|
|
|
msisdn = phone_number_to_msisdn(identifier["country"], identifier["number"])
|
|
|
|
|
|
|
|
return {
|
|
|
|
"type": "m.id.thirdparty",
|
|
|
|
"medium": "msisdn",
|
|
|
|
"address": msisdn,
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2015-01-23 09:09:51 -05:00
|
|
|
class LoginRestServlet(ClientV1RestServlet):
|
2016-01-02 12:24:28 -05:00
|
|
|
PATTERNS = client_path_patterns("/login$")
|
2015-07-07 08:10:30 -04:00
|
|
|
SAML2_TYPE = "m.login.saml2"
|
2015-10-07 09:45:57 -04:00
|
|
|
CAS_TYPE = "m.login.cas"
|
2015-11-05 09:01:12 -05:00
|
|
|
TOKEN_TYPE = "m.login.token"
|
2016-03-28 15:33:40 -04:00
|
|
|
JWT_TYPE = "m.login.jwt"
|
2015-07-07 08:10:30 -04:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
super(LoginRestServlet, self).__init__(hs)
|
2015-07-10 05:50:03 -04:00
|
|
|
self.idp_redirect_url = hs.config.saml2_idp_redirect_url
|
|
|
|
self.saml2_enabled = hs.config.saml2_enabled
|
2016-03-28 15:33:40 -04:00
|
|
|
self.jwt_enabled = hs.config.jwt_enabled
|
|
|
|
self.jwt_secret = hs.config.jwt_secret
|
|
|
|
self.jwt_algorithm = hs.config.jwt_algorithm
|
2015-10-07 09:45:57 -04:00
|
|
|
self.cas_enabled = hs.config.cas_enabled
|
2016-06-02 08:31:45 -04:00
|
|
|
self.auth_handler = self.hs.get_auth_handler()
|
2016-07-15 08:19:07 -04:00
|
|
|
self.device_handler = self.hs.get_device_handler()
|
2016-08-12 05:03:19 -04:00
|
|
|
self.handlers = hs.get_handlers()
|
2014-08-12 10:10:52 -04:00
|
|
|
|
|
|
|
def on_GET(self, request):
|
2015-10-22 05:37:04 -04:00
|
|
|
flows = []
|
2016-03-28 15:33:40 -04:00
|
|
|
if self.jwt_enabled:
|
|
|
|
flows.append({"type": LoginRestServlet.JWT_TYPE})
|
2015-07-09 04:04:47 -04:00
|
|
|
if self.saml2_enabled:
|
|
|
|
flows.append({"type": LoginRestServlet.SAML2_TYPE})
|
2015-10-07 09:45:57 -04:00
|
|
|
if self.cas_enabled:
|
|
|
|
flows.append({"type": LoginRestServlet.CAS_TYPE})
|
2015-11-20 09:05:22 -05:00
|
|
|
|
|
|
|
# While its valid for us to advertise this login type generally,
|
|
|
|
# synapse currently only gives out these tokens as part of the
|
|
|
|
# CAS login flow.
|
|
|
|
# Generally we don't want to advertise login flows that clients
|
|
|
|
# don't know how to implement, since they (currently) will always
|
|
|
|
# fall back to the fallback API if they don't understand one of the
|
|
|
|
# login flow types returned.
|
2015-11-19 11:16:49 -05:00
|
|
|
flows.append({"type": LoginRestServlet.TOKEN_TYPE})
|
2017-10-31 06:38:40 -04:00
|
|
|
|
|
|
|
flows.extend((
|
|
|
|
{"type": t} for t in self.auth_handler.get_supported_login_types()
|
|
|
|
))
|
2015-11-19 11:16:49 -05:00
|
|
|
|
2015-07-09 04:04:47 -04:00
|
|
|
return (200, {"flows": flows})
|
2014-08-12 10:10:52 -04:00
|
|
|
|
|
|
|
def on_OPTIONS(self, request):
|
|
|
|
return (200, {})
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request):
|
2016-03-09 06:26:26 -05:00
|
|
|
login_submission = parse_json_object_from_request(request)
|
2014-08-12 10:10:52 -04:00
|
|
|
try:
|
2017-10-31 06:38:40 -04:00
|
|
|
if self.saml2_enabled and (login_submission["type"] ==
|
|
|
|
LoginRestServlet.SAML2_TYPE):
|
2015-07-07 08:10:30 -04:00
|
|
|
relay_state = ""
|
|
|
|
if "relay_state" in login_submission:
|
2016-02-02 12:18:50 -05:00
|
|
|
relay_state = "&RelayState=" + urllib.quote(
|
2015-07-08 06:35:20 -04:00
|
|
|
login_submission["relay_state"])
|
2015-07-07 08:10:30 -04:00
|
|
|
result = {
|
2015-07-08 06:35:20 -04:00
|
|
|
"uri": "%s%s" % (self.idp_redirect_url, relay_state)
|
2015-07-07 08:10:30 -04:00
|
|
|
}
|
|
|
|
defer.returnValue((200, result))
|
2016-03-28 15:33:40 -04:00
|
|
|
elif self.jwt_enabled and (login_submission["type"] ==
|
|
|
|
LoginRestServlet.JWT_TYPE):
|
|
|
|
result = yield self.do_jwt_login(login_submission)
|
|
|
|
defer.returnValue(result)
|
2015-11-05 09:01:12 -05:00
|
|
|
elif login_submission["type"] == LoginRestServlet.TOKEN_TYPE:
|
|
|
|
result = yield self.do_token_login(login_submission)
|
|
|
|
defer.returnValue(result)
|
2014-08-12 10:10:52 -04:00
|
|
|
else:
|
2017-10-31 06:38:40 -04:00
|
|
|
result = yield self._do_other_login(login_submission)
|
|
|
|
defer.returnValue(result)
|
2014-08-12 10:10:52 -04:00
|
|
|
except KeyError:
|
|
|
|
raise SynapseError(400, "Missing JSON keys.")
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
2017-10-31 06:38:40 -04:00
|
|
|
def _do_other_login(self, login_submission):
|
|
|
|
"""Handle non-token/saml/jwt logins
|
|
|
|
|
|
|
|
Args:
|
|
|
|
login_submission:
|
2017-03-13 13:27:51 -04:00
|
|
|
|
2017-10-31 06:38:40 -04:00
|
|
|
Returns:
|
|
|
|
(int, object): HTTP code/response
|
|
|
|
"""
|
2017-11-01 09:58:01 -04:00
|
|
|
# Log the request we got, but only certain fields to minimise the chance of
|
|
|
|
# logging someone's password (even if they accidentally put it in the wrong
|
|
|
|
# field)
|
|
|
|
logger.info(
|
|
|
|
"Got login request with identifier: %r, medium: %r, address: %r, user: %r",
|
|
|
|
login_submission.get('identifier'),
|
|
|
|
login_submission.get('medium'),
|
|
|
|
login_submission.get('address'),
|
|
|
|
login_submission.get('user'),
|
2017-11-01 10:02:52 -04:00
|
|
|
)
|
2017-03-13 13:27:51 -04:00
|
|
|
login_submission_legacy_convert(login_submission)
|
|
|
|
|
|
|
|
if "identifier" not in login_submission:
|
|
|
|
raise SynapseError(400, "Missing param: identifier")
|
|
|
|
|
|
|
|
identifier = login_submission["identifier"]
|
|
|
|
if "type" not in identifier:
|
|
|
|
raise SynapseError(400, "Login identifier has no type")
|
|
|
|
|
|
|
|
# convert phone type identifiers to generic threepids
|
|
|
|
if identifier["type"] == "m.id.phone":
|
|
|
|
identifier = login_id_thirdparty_from_phone(identifier)
|
|
|
|
|
|
|
|
# convert threepid identifiers to user IDs
|
|
|
|
if identifier["type"] == "m.id.thirdparty":
|
|
|
|
if 'medium' not in identifier or 'address' not in identifier:
|
|
|
|
raise SynapseError(400, "Invalid thirdparty identifier")
|
|
|
|
|
|
|
|
address = identifier['address']
|
|
|
|
if identifier['medium'] == 'email':
|
2017-01-18 08:25:56 -05:00
|
|
|
# For emails, transform the address to lowercase.
|
|
|
|
# We store all email addreses as lowercase in the DB.
|
|
|
|
# (See add_threepid in synapse/handlers/auth.py)
|
|
|
|
address = address.lower()
|
2015-08-04 11:29:54 -04:00
|
|
|
user_id = yield self.hs.get_datastore().get_user_id_by_threepid(
|
2017-03-13 13:27:51 -04:00
|
|
|
identifier['medium'], address
|
2015-08-04 11:29:54 -04:00
|
|
|
)
|
2015-10-20 06:07:50 -04:00
|
|
|
if not user_id:
|
2015-10-21 04:42:07 -04:00
|
|
|
raise LoginError(403, "", errcode=Codes.FORBIDDEN)
|
2017-03-13 13:27:51 -04:00
|
|
|
|
|
|
|
identifier = {
|
|
|
|
"type": "m.id.user",
|
|
|
|
"user": user_id,
|
|
|
|
}
|
|
|
|
|
|
|
|
# by this point, the identifier should be an m.id.user: if it's anything
|
|
|
|
# else, we haven't understood it.
|
|
|
|
if identifier["type"] != "m.id.user":
|
|
|
|
raise SynapseError(400, "Unknown login identifier type")
|
|
|
|
if "user" not in identifier:
|
|
|
|
raise SynapseError(400, "User identifier is missing 'user' key")
|
|
|
|
|
2016-06-02 08:31:45 -04:00
|
|
|
auth_handler = self.auth_handler
|
2017-10-31 06:38:40 -04:00
|
|
|
canonical_user_id = yield auth_handler.validate_login(
|
|
|
|
identifier["user"],
|
|
|
|
login_submission,
|
|
|
|
)
|
|
|
|
|
|
|
|
device_id = yield self._register_device(
|
|
|
|
canonical_user_id, login_submission,
|
2016-07-15 07:34:23 -04:00
|
|
|
)
|
2016-11-28 04:52:02 -05:00
|
|
|
access_token = yield auth_handler.get_access_token_for_user_id(
|
2017-10-31 06:38:40 -04:00
|
|
|
canonical_user_id, device_id,
|
2016-11-28 04:52:02 -05:00
|
|
|
login_submission.get("initial_device_display_name"),
|
2016-07-15 07:34:23 -04:00
|
|
|
)
|
2017-10-31 06:38:40 -04:00
|
|
|
|
2014-08-12 10:10:52 -04:00
|
|
|
result = {
|
2017-10-31 06:38:40 -04:00
|
|
|
"user_id": canonical_user_id,
|
2015-08-20 11:21:35 -04:00
|
|
|
"access_token": access_token,
|
2014-08-12 10:10:52 -04:00
|
|
|
"home_server": self.hs.hostname,
|
2016-07-15 08:19:07 -04:00
|
|
|
"device_id": device_id,
|
2014-08-12 10:10:52 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
defer.returnValue((200, result))
|
|
|
|
|
2015-11-05 09:01:12 -05:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def do_token_login(self, login_submission):
|
|
|
|
token = login_submission['token']
|
2016-06-02 08:31:45 -04:00
|
|
|
auth_handler = self.auth_handler
|
2015-11-05 09:01:12 -05:00
|
|
|
user_id = (
|
|
|
|
yield auth_handler.validate_short_term_login_token_and_get_user_id(token)
|
|
|
|
)
|
2016-07-15 08:19:07 -04:00
|
|
|
device_id = yield self._register_device(user_id, login_submission)
|
2016-11-28 04:52:02 -05:00
|
|
|
access_token = yield auth_handler.get_access_token_for_user_id(
|
|
|
|
user_id, device_id,
|
|
|
|
login_submission.get("initial_device_display_name"),
|
2015-11-05 09:01:12 -05:00
|
|
|
)
|
|
|
|
result = {
|
|
|
|
"user_id": user_id, # may have changed
|
|
|
|
"access_token": access_token,
|
|
|
|
"home_server": self.hs.hostname,
|
2016-07-15 08:19:07 -04:00
|
|
|
"device_id": device_id,
|
2015-11-05 09:01:12 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
defer.returnValue((200, result))
|
|
|
|
|
2016-03-28 15:33:40 -04:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def do_jwt_login(self, login_submission):
|
2016-04-01 13:04:28 -04:00
|
|
|
token = login_submission.get("token", None)
|
2016-03-28 15:33:40 -04:00
|
|
|
if token is None:
|
2016-04-25 09:30:15 -04:00
|
|
|
raise LoginError(
|
|
|
|
401, "Token field for JWT is missing",
|
|
|
|
errcode=Codes.UNAUTHORIZED
|
|
|
|
)
|
|
|
|
|
|
|
|
import jwt
|
|
|
|
from jwt.exceptions import InvalidTokenError
|
2016-03-28 15:33:40 -04:00
|
|
|
|
|
|
|
try:
|
|
|
|
payload = jwt.decode(token, self.jwt_secret, algorithms=[self.jwt_algorithm])
|
2016-04-01 13:04:28 -04:00
|
|
|
except jwt.ExpiredSignatureError:
|
|
|
|
raise LoginError(401, "JWT expired", errcode=Codes.UNAUTHORIZED)
|
2016-03-28 15:33:40 -04:00
|
|
|
except InvalidTokenError:
|
|
|
|
raise LoginError(401, "Invalid JWT", errcode=Codes.UNAUTHORIZED)
|
|
|
|
|
2016-04-01 13:04:28 -04:00
|
|
|
user = payload.get("sub", None)
|
2016-03-28 15:33:40 -04:00
|
|
|
if user is None:
|
|
|
|
raise LoginError(401, "Invalid JWT", errcode=Codes.UNAUTHORIZED)
|
|
|
|
|
2017-10-20 11:33:15 -04:00
|
|
|
user_id = UserID(user, self.hs.hostname).to_string()
|
2016-06-02 08:31:45 -04:00
|
|
|
auth_handler = self.auth_handler
|
2016-07-15 07:34:23 -04:00
|
|
|
registered_user_id = yield auth_handler.check_user_exists(user_id)
|
|
|
|
if registered_user_id:
|
2016-07-15 08:19:07 -04:00
|
|
|
device_id = yield self._register_device(
|
|
|
|
registered_user_id, login_submission
|
|
|
|
)
|
2016-11-28 04:52:02 -05:00
|
|
|
access_token = yield auth_handler.get_access_token_for_user_id(
|
|
|
|
registered_user_id, device_id,
|
|
|
|
login_submission.get("initial_device_display_name"),
|
2016-03-28 15:33:40 -04:00
|
|
|
)
|
2016-11-28 04:52:02 -05:00
|
|
|
|
2016-03-28 15:33:40 -04:00
|
|
|
result = {
|
2016-07-15 07:34:23 -04:00
|
|
|
"user_id": registered_user_id,
|
2016-03-28 15:33:40 -04:00
|
|
|
"access_token": access_token,
|
|
|
|
"home_server": self.hs.hostname,
|
|
|
|
}
|
|
|
|
else:
|
2016-07-15 08:19:07 -04:00
|
|
|
# TODO: we should probably check that the register isn't going
|
|
|
|
# to fonx/change our user_id before registering the device
|
|
|
|
device_id = yield self._register_device(user_id, login_submission)
|
2016-03-28 15:33:40 -04:00
|
|
|
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))
|
|
|
|
|
2016-07-15 08:19:07 -04:00
|
|
|
def _register_device(self, user_id, login_submission):
|
|
|
|
"""Register a device for a user.
|
|
|
|
|
|
|
|
This is called after the user's credentials have been validated, but
|
|
|
|
before the access token has been issued.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
(str) user_id: full canonical @user:id
|
|
|
|
(object) login_submission: dictionary supplied to /login call, from
|
|
|
|
which we pull device_id and initial_device_name
|
|
|
|
Returns:
|
|
|
|
defer.Deferred: (str) device_id
|
|
|
|
"""
|
|
|
|
device_id = login_submission.get("device_id")
|
|
|
|
initial_display_name = login_submission.get(
|
|
|
|
"initial_device_display_name")
|
|
|
|
return self.device_handler.check_device_registered(
|
|
|
|
user_id, device_id, initial_display_name
|
|
|
|
)
|
|
|
|
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2015-07-07 08:10:30 -04:00
|
|
|
class SAML2RestServlet(ClientV1RestServlet):
|
2015-12-01 12:34:32 -05:00
|
|
|
PATTERNS = client_path_patterns("/login/saml2", releases=())
|
2015-07-07 08:10:30 -04:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
super(SAML2RestServlet, self).__init__(hs)
|
2015-07-10 05:50:03 -04:00
|
|
|
self.sp_config = hs.config.saml2_config_path
|
2016-08-12 05:03:19 -04:00
|
|
|
self.handlers = hs.get_handlers()
|
2015-07-07 08:10:30 -04:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request):
|
|
|
|
saml2_auth = None
|
|
|
|
try:
|
|
|
|
conf = config.SPConfig()
|
|
|
|
conf.load_file(self.sp_config)
|
|
|
|
SP = Saml2Client(conf)
|
2015-07-08 06:35:20 -04:00
|
|
|
saml2_auth = SP.parse_authn_request_response(
|
2015-07-09 03:28:15 -04:00
|
|
|
request.args['SAMLResponse'][0], BINDING_HTTP_POST)
|
2016-03-07 15:13:10 -05:00
|
|
|
except Exception as e: # Not authenticated
|
2015-07-07 08:10:30 -04:00
|
|
|
logger.exception(e)
|
2015-07-08 06:35:20 -04:00
|
|
|
if saml2_auth and saml2_auth.status_ok() and not saml2_auth.not_signed:
|
2015-07-07 08:10:30 -04:00
|
|
|
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:
|
2015-07-08 06:35:20 -04:00
|
|
|
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)))
|
2016-02-12 08:46:59 -05:00
|
|
|
finish_request(request)
|
2015-07-07 08:10:30 -04:00
|
|
|
defer.returnValue(None)
|
2015-07-08 06:35:20 -04:00
|
|
|
defer.returnValue((200, {"status": "authenticated",
|
|
|
|
"user_id": user_id, "token": token,
|
|
|
|
"ava": saml2_auth.ava}))
|
2015-07-07 08:10:30 -04:00
|
|
|
elif 'RelayState' in request.args:
|
2015-07-08 06:35:20 -04:00
|
|
|
request.redirect(urllib.unquote(
|
|
|
|
request.args['RelayState'][0]) +
|
|
|
|
'?status=not_authenticated')
|
2016-02-12 08:46:59 -05:00
|
|
|
finish_request(request)
|
2015-07-07 08:10:30 -04:00
|
|
|
defer.returnValue(None)
|
2015-07-08 06:35:20 -04:00
|
|
|
defer.returnValue((200, {"status": "not_authenticated"}))
|
|
|
|
|
2015-10-08 18:34:04 -04:00
|
|
|
|
2015-11-05 09:01:12 -05:00
|
|
|
class CasRedirectServlet(ClientV1RestServlet):
|
2015-12-01 12:34:32 -05:00
|
|
|
PATTERNS = client_path_patterns("/login/cas/redirect", releases=())
|
2015-11-05 09:01:12 -05:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
super(CasRedirectServlet, self).__init__(hs)
|
|
|
|
self.cas_server_url = hs.config.cas_server_url
|
|
|
|
self.cas_service_url = hs.config.cas_service_url
|
|
|
|
|
|
|
|
def on_GET(self, request):
|
|
|
|
args = request.args
|
|
|
|
if "redirectUrl" not in args:
|
|
|
|
return (400, "Redirect URL not specified for CAS auth")
|
2015-11-11 09:26:47 -05:00
|
|
|
client_redirect_url_param = urllib.urlencode({
|
2015-11-05 09:01:12 -05:00
|
|
|
"redirectUrl": args["redirectUrl"][0]
|
|
|
|
})
|
2015-11-11 09:26:47 -05:00
|
|
|
hs_redirect_url = self.cas_service_url + "/_matrix/client/api/v1/login/cas/ticket"
|
|
|
|
service_param = urllib.urlencode({
|
|
|
|
"service": "%s?%s" % (hs_redirect_url, client_redirect_url_param)
|
2015-11-05 09:01:12 -05:00
|
|
|
})
|
2016-09-09 14:39:30 -04:00
|
|
|
request.redirect("%s/login?%s" % (self.cas_server_url, service_param))
|
2016-02-12 08:46:59 -05:00
|
|
|
finish_request(request)
|
2015-11-05 09:01:12 -05:00
|
|
|
|
|
|
|
|
|
|
|
class CasTicketServlet(ClientV1RestServlet):
|
2015-12-01 12:34:32 -05:00
|
|
|
PATTERNS = client_path_patterns("/login/cas/ticket", releases=())
|
2015-11-05 09:01:12 -05:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
super(CasTicketServlet, self).__init__(hs)
|
|
|
|
self.cas_server_url = hs.config.cas_server_url
|
|
|
|
self.cas_service_url = hs.config.cas_service_url
|
|
|
|
self.cas_required_attributes = hs.config.cas_required_attributes
|
2016-08-08 12:01:30 -04:00
|
|
|
self.auth_handler = hs.get_auth_handler()
|
2016-08-12 05:03:19 -04:00
|
|
|
self.handlers = hs.get_handlers()
|
2017-02-02 05:53:36 -05:00
|
|
|
self.macaroon_gen = hs.get_macaroon_generator()
|
2015-11-05 09:01:12 -05:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_GET(self, request):
|
2015-11-11 06:20:23 -05:00
|
|
|
client_redirect_url = request.args["redirectUrl"][0]
|
|
|
|
http_client = self.hs.get_simple_http_client()
|
2015-11-05 09:01:12 -05:00
|
|
|
uri = self.cas_server_url + "/proxyValidate"
|
|
|
|
args = {
|
|
|
|
"ticket": request.args["ticket"],
|
|
|
|
"service": self.cas_service_url
|
|
|
|
}
|
2017-03-14 09:37:36 -04:00
|
|
|
try:
|
|
|
|
body = yield http_client.get_raw(uri, args)
|
|
|
|
except PartialDownloadError as pde:
|
|
|
|
# Twisted raises this error if the connection is closed,
|
|
|
|
# even if that's being used old-http style to signal end-of-data
|
|
|
|
body = pde.response
|
2015-11-11 06:20:23 -05:00
|
|
|
result = yield self.handle_cas_response(request, body, client_redirect_url)
|
2015-11-05 09:01:12 -05:00
|
|
|
defer.returnValue(result)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
2015-11-11 06:20:23 -05:00
|
|
|
def handle_cas_response(self, request, cas_response_body, client_redirect_url):
|
2015-11-05 09:01:12 -05:00
|
|
|
user, attributes = self.parse_cas_response(cas_response_body)
|
|
|
|
|
|
|
|
for required_attribute, required_value in self.cas_required_attributes.items():
|
|
|
|
# If required attribute was not in CAS Response - Forbidden
|
|
|
|
if required_attribute not in attributes:
|
|
|
|
raise LoginError(401, "Unauthorized", errcode=Codes.UNAUTHORIZED)
|
|
|
|
|
|
|
|
# Also need to check value
|
|
|
|
if required_value is not None:
|
|
|
|
actual_value = attributes[required_attribute]
|
|
|
|
# If required attribute value does not match expected - Forbidden
|
|
|
|
if required_value != actual_value:
|
|
|
|
raise LoginError(401, "Unauthorized", errcode=Codes.UNAUTHORIZED)
|
|
|
|
|
2017-10-20 11:33:15 -04:00
|
|
|
user_id = UserID(user, self.hs.hostname).to_string()
|
2016-06-02 08:31:45 -04:00
|
|
|
auth_handler = self.auth_handler
|
2016-07-15 07:34:23 -04:00
|
|
|
registered_user_id = yield auth_handler.check_user_exists(user_id)
|
|
|
|
if not registered_user_id:
|
|
|
|
registered_user_id, _ = (
|
2015-11-05 09:01:12 -05:00
|
|
|
yield self.handlers.registration_handler.register(localpart=user)
|
|
|
|
)
|
|
|
|
|
2017-02-02 05:53:36 -05:00
|
|
|
login_token = self.macaroon_gen.generate_short_term_login_token(
|
|
|
|
registered_user_id
|
|
|
|
)
|
2015-11-11 06:20:23 -05:00
|
|
|
redirect_url = self.add_login_token_to_redirect_url(client_redirect_url,
|
|
|
|
login_token)
|
|
|
|
request.redirect(redirect_url)
|
2016-02-12 08:46:59 -05:00
|
|
|
finish_request(request)
|
2015-11-05 09:01:12 -05:00
|
|
|
|
|
|
|
def add_login_token_to_redirect_url(self, url, token):
|
|
|
|
url_parts = list(urlparse.urlparse(url))
|
|
|
|
query = dict(urlparse.parse_qsl(url_parts[4]))
|
|
|
|
query.update({"loginToken": token})
|
|
|
|
url_parts[4] = urllib.urlencode(query)
|
|
|
|
return urlparse.urlunparse(url_parts)
|
|
|
|
|
|
|
|
def parse_cas_response(self, cas_response_body):
|
2016-08-08 12:17:25 -04:00
|
|
|
user = None
|
2016-09-09 14:39:30 -04:00
|
|
|
attributes = {}
|
2016-08-08 12:17:25 -04:00
|
|
|
try:
|
|
|
|
root = ET.fromstring(cas_response_body)
|
|
|
|
if not root.tag.endswith("serviceResponse"):
|
|
|
|
raise Exception("root of CAS response is not serviceResponse")
|
|
|
|
success = (root[0].tag.endswith("authenticationSuccess"))
|
|
|
|
for child in root[0]:
|
|
|
|
if child.tag.endswith("user"):
|
|
|
|
user = child.text
|
|
|
|
if child.tag.endswith("attributes"):
|
|
|
|
for attribute in child:
|
|
|
|
# ElementTree library expands the namespace in
|
|
|
|
# attribute tags to the full URL of the namespace.
|
|
|
|
# We don't care about namespace here and it will always
|
|
|
|
# be encased in curly braces, so we remove them.
|
|
|
|
tag = attribute.tag
|
|
|
|
if "}" in tag:
|
|
|
|
tag = tag.split("}")[1]
|
|
|
|
attributes[tag] = attribute.text
|
|
|
|
if user is None:
|
|
|
|
raise Exception("CAS response does not contain user")
|
|
|
|
except Exception:
|
|
|
|
logger.error("Error parsing CAS response", exc_info=1)
|
|
|
|
raise LoginError(401, "Invalid CAS response",
|
|
|
|
errcode=Codes.UNAUTHORIZED)
|
|
|
|
if not success:
|
|
|
|
raise LoginError(401, "Unsuccessful CAS response",
|
|
|
|
errcode=Codes.UNAUTHORIZED)
|
|
|
|
return user, attributes
|
2015-11-05 09:01:12 -05:00
|
|
|
|
|
|
|
|
2014-08-12 10:10:52 -04:00
|
|
|
def register_servlets(hs, http_server):
|
|
|
|
LoginRestServlet(hs).register(http_server)
|
2015-07-10 05:50:03 -04:00
|
|
|
if hs.config.saml2_enabled:
|
2015-07-09 04:04:47 -04:00
|
|
|
SAML2RestServlet(hs).register(http_server)
|
2015-10-07 09:45:57 -04:00
|
|
|
if hs.config.cas_enabled:
|
2015-11-05 09:01:12 -05:00
|
|
|
CasRedirectServlet(hs).register(http_server)
|
|
|
|
CasTicketServlet(hs).register(http_server)
|