create support user

docs/admin_api/register_api.rst

@@ -39,8 +39,8 @@ As an example::
     }
 
 The MAC is the hex digest output of the HMAC-SHA1 algorithm, with the key being
-the shared secret and the content being the nonce, user, password, user_type
-(or string "no_user_type" if None) and either the string "admin" or "notadmin",
+the shared secret and the content being the nonce, user, password, either the
+string "admin" or "notadmin", and optionally the user_type
 each separated by NULs. For an example of generation in Python::
 
   import hmac, hashlib
@@ -60,6 +60,7 @@ each separated by NULs. For an example of generation in Python::
       mac.update(b"\x00")
       mac.update(b"admin" if admin else b"notadmin")
       mac.update(b"\x00")
-      mac.update(user_type.encode('utf8') if user_type else b"no_user_type")
+      if user_type:
+        mac.update(user_type.encode('utf8'))
 
       return mac.hexdigest()

synapse/_scripts/register_new_matrix_user.py

@@ -66,8 +66,9 @@ def request_registration(
     mac.update(password.encode('utf8'))
     mac.update(b"\x00")
     mac.update(b"admin" if admin else b"notadmin")
-    mac.update(b"\x00")
-    mac.update(user_type.encode('utf8') if user_type else b"no_user_type")
+    if user_type:
+        mac.update(b"\x00")
+        mac.update(user_type.encode('utf8'))
 
     mac = mac.hexdigest()
 

synapse/handlers/register.py

@@ -142,7 +142,8 @@ def register(
               since it offers no means of associating a device_id with the
               access_token. Instead you should call auth_handler.issue_access_token
               after registration.
-            user_type (api.constants.UserTypes) - type of user
+            user_type (str|None): type of user. One of the values from
+              api.constants.UserTypes, or None for a normal user.
             default_display_name (unicode|None): if set, the new user's displayname
               will be set to this. Defaults to 'localpart'.
         Returns:

synapse/rest/client/v1/admin.py

@@ -160,7 +160,7 @@ def on_POST(self, request):
         admin = body.get("admin", None)
         user_type = body.get("user_type", None)
 
-        if user_type and user_type not in UserTypes.ALL_USER_TYPES:
+        if user_type is not None and user_type not in UserTypes.ALL_USER_TYPES:
             raise SynapseError(400, "Invalid user type")
 
         got_mac = body["mac"]
@@ -176,8 +176,9 @@ def on_POST(self, request):
         want_mac.update(password)
         want_mac.update(b"\x00")
         want_mac.update(b"admin" if admin else b"notadmin")
-        want_mac.update(b"\x00")
-        want_mac.update(user_type.encode('utf8') if user_type else b"no_user_type")
+        if user_type:
+            want_mac.update(b"\x00")
+            want_mac.update(user_type.encode('utf8'))
         want_mac = want_mac.hexdigest()
 
         if not hmac.compare_digest(

synapse/storage/monthly_active_users.py

@@ -222,7 +222,7 @@ def upsert_monthly_active_user_txn(self, txn, user_id):
         for cases where upsert_monthly_active_user_txn is called directly,
         like _initialise_reserved_users
 
-        In short, don't call this method with support users. (Support users 
+        In short, don't call this method with support users. (Support users
         should not appear in the MAU stats).
 
         Args:

synapse/storage/registration.py

@@ -186,7 +186,8 @@ def register(self, user_id, token=None, password_hash=None,
             create_profile_with_displayname (unicode): Optionally create a profile for
                 the user, setting their displayname to the given value
             admin (boolean): is an admin user?
-            user_type (synapse.api.constants.UserTypes): type of user
+            user_type (str|None): type of user. One of the values from 
+                api.constants.UserTypes, or None for a normal user.
 
         Raises:
             StoreError if the user_id could not be registered.

tests/rest/client/v1/test_admin.py

@@ -120,7 +120,7 @@ def test_register_incorrect_nonce(self):
         nonce = channel.json_body["nonce"]
 
         want_mac = hmac.new(key=b"shared", digestmod=hashlib.sha1)
-        want_mac.update(b"notthenonce\x00bob\x00abc123\x00admin\x00no_user_type")
+        want_mac.update(b"notthenonce\x00bob\x00abc123\x00admin")
         want_mac = want_mac.hexdigest()
 
         body = json.dumps(
@@ -179,7 +179,7 @@ def test_nonce_reuse(self):
 
         want_mac = hmac.new(key=b"shared", digestmod=hashlib.sha1)
         want_mac.update(
-            nonce.encode('ascii') + b"\x00bob\x00abc123\x00admin\x00no_user_type"
+            nonce.encode('ascii') + b"\x00bob\x00abc123\x00admin"
         )
         want_mac = want_mac.hexdigest()
 

tests/unittest.py

@@ -373,7 +373,7 @@ def register_user(self, username, password, admin=False):
             nonce_str += b"\x00admin"
         else:
             nonce_str += b"\x00notadmin"
-        nonce_str += b"\00no_user_type"
+
         want_mac.update(nonce.encode('ascii') + b"\x00" + nonce_str)
         want_mac = want_mac.hexdigest()