summary refs log tree commit diff
path: root/synapse/rest/client/password_policy.py
diff options
context:
space:
mode:
Diffstat (limited to 'synapse/rest/client/password_policy.py')
-rw-r--r--synapse/rest/client/password_policy.py61
1 files changed, 61 insertions, 0 deletions
diff --git a/synapse/rest/client/password_policy.py b/synapse/rest/client/password_policy.py
new file mode 100644

index 0000000000..6d64efb165 --- /dev/null +++ b/synapse/rest/client/password_policy.py
@@ -0,0 +1,61 @@ +# Copyright 2019 The Matrix.org Foundation C.I.C. +# +# 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. + +import logging +from typing import TYPE_CHECKING, Tuple + +from twisted.web.server import Request + +from synapse.http.server import HttpServer +from synapse.http.servlet import RestServlet +from synapse.types import JsonDict + +from ._base import client_patterns + +if TYPE_CHECKING: + from synapse.server import HomeServer + +logger = logging.getLogger(__name__) + + +class PasswordPolicyServlet(RestServlet): + PATTERNS = client_patterns("/password_policy$") + + def __init__(self, hs: "HomeServer"): + super().__init__() + + self.policy = hs.config.password_policy + self.enabled = hs.config.password_policy_enabled + + def on_GET(self, request: Request) -> Tuple[int, JsonDict]: + if not self.enabled or not self.policy: + return (200, {}) + + policy = {} + + for param in [ + "minimum_length", + "require_digit", + "require_symbol", + "require_lowercase", + "require_uppercase", + ]: + if param in self.policy: + policy["m.%s" % param] = self.policy[param] + + return (200, policy) + + +def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None: + PasswordPolicyServlet(hs).register(http_server)