anonymousland-synapse/synapse/rest/client/v2_alpha/auth.py

269 lines
9.1 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
2016-01-06 23:26:29 -05:00
# Copyright 2015, 2016 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.
2018-07-09 02:09:20 -04:00
import logging
from synapse.api.constants import LoginType
from synapse.api.errors import SynapseError
from synapse.api.urls import CLIENT_API_PREFIX
from synapse.http.server import respond_with_html
2018-11-19 13:27:33 -05:00
from synapse.http.servlet import RestServlet, parse_string
from ._base import client_patterns
logger = logging.getLogger(__name__)
RECAPTCHA_TEMPLATE = """
<html>
<head>
<title>Authentication</title>
<meta name='viewport' content='width=device-width, initial-scale=1,
user-scalable=no, minimum-scale=1.0, maximum-scale=1.0'>
<script src="https://www.recaptcha.net/recaptcha/api.js"
async defer></script>
<script src="//code.jquery.com/jquery-1.11.2.min.js"></script>
<link rel="stylesheet" href="/_matrix/static/client/register/style.css">
<script>
function captchaDone() {
$('#registrationForm').submit();
}
</script>
</head>
<body>
<form id="registrationForm" method="post" action="%(myurl)s">
<div>
<p>
Hello! We need to prevent computer programs and other automated
things from creating accounts on this server.
</p>
<p>
Please verify that you're not a robot.
</p>
<input type="hidden" name="session" value="%(session)s" />
<div class="g-recaptcha"
data-sitekey="%(sitekey)s"
data-callback="captchaDone">
</div>
<noscript>
<input type="submit" value="All Done" />
</noscript>
</div>
</div>
</form>
</body>
</html>
"""
2018-10-03 17:54:19 -04:00
TERMS_TEMPLATE = """
<html>
<head>
<title>Authentication</title>
<meta name='viewport' content='width=device-width, initial-scale=1,
user-scalable=no, minimum-scale=1.0, maximum-scale=1.0'>
<link rel="stylesheet" href="/_matrix/static/client/register/style.css">
</head>
<body>
<form id="registrationForm" method="post" action="%(myurl)s">
<div>
<p>
Please click the button below if you agree to the
<a href="%(terms_url)s">privacy policy of this homeserver.</a>
</p>
<input type="hidden" name="session" value="%(session)s" />
<input type="submit" value="Agree" />
</div>
</form>
</body>
</html>
"""
SUCCESS_TEMPLATE = """
<html>
<head>
<title>Success!</title>
<meta name='viewport' content='width=device-width, initial-scale=1,
user-scalable=no, minimum-scale=1.0, maximum-scale=1.0'>
<link rel="stylesheet" href="/_matrix/static/client/register/style.css">
<script>
if (window.onAuthDone) {
window.onAuthDone();
} else if (window.opener && window.opener.postMessage) {
window.opener.postMessage("authDone", "*");
}
</script>
</head>
<body>
<div>
<p>Thank you</p>
<p>You may now close this window and return to the application</p>
</div>
</body>
</html>
"""
2015-04-02 12:06:17 -04:00
class AuthRestServlet(RestServlet):
"""
Handles Client / Server API authentication in any situations where it
cannot be handled in the normal flow (with requests to the same endpoint).
Current use is for web fallback auth.
"""
2019-06-20 05:32:02 -04:00
PATTERNS = client_patterns(r"/auth/(?P<stagetype>[\w\.]*)/fallback/web")
def __init__(self, hs):
super(AuthRestServlet, self).__init__()
self.hs = hs
self.auth = hs.get_auth()
2016-06-02 08:31:45 -04:00
self.auth_handler = hs.get_auth_handler()
self.registration_handler = hs.get_registration_handler()
# SSO configuration.
2020-04-03 15:35:05 -04:00
self._cas_enabled = hs.config.cas_enabled
if self._cas_enabled:
self._cas_handler = hs.get_cas_handler()
self._cas_server_url = hs.config.cas_server_url
self._cas_service_url = hs.config.cas_service_url
self._saml_enabled = hs.config.saml2_enabled
if self._saml_enabled:
self._saml_handler = hs.get_saml_handler()
self._oidc_enabled = hs.config.oidc_enabled
if self._oidc_enabled:
self._oidc_handler = hs.get_oidc_handler()
self._cas_server_url = hs.config.cas_server_url
self._cas_service_url = hs.config.cas_service_url
async def on_GET(self, request, stagetype):
2018-11-19 13:27:33 -05:00
session = parse_string(request, "session")
if not session:
raise SynapseError(400, "No session supplied")
2018-11-19 13:27:33 -05:00
if stagetype == LoginType.RECAPTCHA:
html = RECAPTCHA_TEMPLATE % {
2019-06-20 05:32:02 -04:00
"session": session,
"myurl": "%s/r0/auth/%s/fallback/web"
% (CLIENT_API_PREFIX, LoginType.RECAPTCHA),
"sitekey": self.hs.config.recaptcha_public_key,
}
elif stagetype == LoginType.TERMS:
2018-10-03 17:54:19 -04:00
html = TERMS_TEMPLATE % {
2019-06-20 05:32:02 -04:00
"session": session,
"terms_url": "%s_matrix/consent?v=%s"
% (self.hs.config.public_baseurl, self.hs.config.user_consent_version),
"myurl": "%s/r0/auth/%s/fallback/web"
% (CLIENT_API_PREFIX, LoginType.TERMS),
2018-10-03 17:54:19 -04:00
}
2020-04-03 15:35:05 -04:00
elif stagetype == LoginType.SSO:
# Display a confirmation page which prompts the user to
# re-authenticate with their SSO provider.
2020-04-03 15:35:05 -04:00
if self._cas_enabled:
# Generate a request to CAS that redirects back to an endpoint
# to verify the successful authentication.
sso_redirect_url = self._cas_handler.get_redirect_url(
{"session": session},
)
elif self._saml_enabled:
# Some SAML identity providers (e.g. Google) require a
# RelayState parameter on requests. It is not necessary here, so
# pass in a dummy redirect URL (which will never get used).
client_redirect_url = b"unused"
2020-04-03 15:35:05 -04:00
sso_redirect_url = self._saml_handler.handle_redirect_request(
client_redirect_url, session
)
elif self._oidc_enabled:
client_redirect_url = b""
sso_redirect_url = await self._oidc_handler.handle_redirect_request(
request, client_redirect_url, session
)
2020-04-03 15:35:05 -04:00
else:
raise SynapseError(400, "Homeserver not configured for SSO.")
html = await self.auth_handler.start_sso_ui_auth(sso_redirect_url, session)
2020-04-03 15:35:05 -04:00
else:
raise SynapseError(404, "Unknown auth stage type")
# Render the HTML and return.
respond_with_html(request, 200, html)
return None
2019-12-05 11:46:37 -05:00
async def on_POST(self, request, stagetype):
2018-11-19 13:27:33 -05:00
session = parse_string(request, "session")
if not session:
raise SynapseError(400, "No session supplied")
2018-10-03 17:54:19 -04:00
if stagetype == LoginType.RECAPTCHA:
2018-11-19 13:27:33 -05:00
response = parse_string(request, "g-recaptcha-response")
2018-11-19 13:27:33 -05:00
if not response:
raise SynapseError(400, "No captcha response supplied")
2019-06-20 05:32:02 -04:00
authdict = {"response": response, "session": session}
2019-12-05 11:46:37 -05:00
success = await self.auth_handler.add_oob_auth(
2019-06-20 05:32:02 -04:00
LoginType.RECAPTCHA, authdict, self.hs.get_ip_from_request(request)
)
if success:
html = SUCCESS_TEMPLATE
else:
html = RECAPTCHA_TEMPLATE % {
2019-06-20 05:32:02 -04:00
"session": session,
"myurl": "%s/r0/auth/%s/fallback/web"
% (CLIENT_API_PREFIX, LoginType.RECAPTCHA),
"sitekey": self.hs.config.recaptcha_public_key,
}
2018-10-03 17:54:19 -04:00
elif stagetype == LoginType.TERMS:
2019-06-20 05:32:02 -04:00
authdict = {"session": session}
2018-10-03 17:54:19 -04:00
2019-12-05 11:46:37 -05:00
success = await self.auth_handler.add_oob_auth(
2019-06-20 05:32:02 -04:00
LoginType.TERMS, authdict, self.hs.get_ip_from_request(request)
2018-10-03 17:54:19 -04:00
)
if success:
html = SUCCESS_TEMPLATE
else:
html = TERMS_TEMPLATE % {
2019-06-20 05:32:02 -04:00
"session": session,
"terms_url": "%s_matrix/consent?v=%s"
% (
2018-10-03 17:54:19 -04:00
self.hs.config.public_baseurl,
self.hs.config.user_consent_version,
2018-10-03 17:54:19 -04:00
),
2019-06-20 05:32:02 -04:00
"myurl": "%s/r0/auth/%s/fallback/web"
% (CLIENT_API_PREFIX, LoginType.TERMS),
2018-10-03 17:54:19 -04:00
}
elif stagetype == LoginType.SSO:
# The SSO fallback workflow should not post here,
raise SynapseError(404, "Fallback SSO auth does not support POST requests.")
else:
raise SynapseError(404, "Unknown auth stage type")
# Render the HTML and return.
respond_with_html(request, 200, html)
return None
def on_OPTIONS(self, _):
return 200, {}
def register_servlets(hs, http_server):
AuthRestServlet(hs).register(http_server)