From a699acc04931cf0b1f07c1d25c0eb7e5ec66ff13 Mon Sep 17 00:00:00 2001 From: Tulir Asokan Date: Fri, 19 Nov 2021 23:08:41 +0200 Subject: [PATCH] Allow setting initial device name in mbc auth --- maubot/cli/commands/auth.py | 7 ++-- maubot/cli/commands/upload.py | 1 - maubot/management/api/client_auth.py | 49 +++++++++++++++------------- 3 files changed, 32 insertions(+), 25 deletions(-) diff --git a/maubot/cli/commands/auth.py b/maubot/cli/commands/auth.py index 3534485..28afafb 100644 --- a/maubot/cli/commands/auth.py +++ b/maubot/cli/commands/auth.py @@ -54,9 +54,12 @@ async def list_servers(server: str, sess: aiohttp.ClientSession) -> None: "create or update a client in maubot using it", is_flag=True, default=False) @click.option("-l", "--list", help="List available homeservers", is_flag=True, default=False) +@click.option("-n", "--device-name", help="The initial e2ee device displayname (only for login)", + default="Maubot", required=False) @cliq.with_authenticated_http async def auth(homeserver: str, username: str, password: str, server: str, register: bool, - list: bool, update_client: bool, sess: aiohttp.ClientSession) -> None: + list: bool, update_client: bool, device_name: str, sess: aiohttp.ClientSession + ) -> None: if list: await list_servers(server, sess) return @@ -64,7 +67,7 @@ async def auth(homeserver: str, username: str, password: str, server: str, regis url = URL(server) / "_matrix/maubot/v1/client/auth" / homeserver / endpoint if update_client: url = url.with_query({"update_client": "true"}) - req_data = {"username": username, "password": password} + req_data = {"username": username, "password": password, "device_name": device_name} async with sess.post(url, json=req_data) as resp: if resp.status == 200: diff --git a/maubot/cli/commands/upload.py b/maubot/cli/commands/upload.py index 698dc2f..e02ad4a 100644 --- a/maubot/cli/commands/upload.py +++ b/maubot/cli/commands/upload.py @@ -33,7 +33,6 @@ class UploadError(Exception): @click.option("-s", "--server", help="The maubot instance to upload the plugin to") @cliq.with_authenticated_http async def upload(path: str, server: str, sess: aiohttp.ClientSession) -> None: - print("hmm") with open(path, "rb") as file: await upload_file(sess, file, server) diff --git a/maubot/management/api/client_auth.py b/maubot/management/api/client_auth.py index abd5246..863767d 100644 --- a/maubot/management/api/client_auth.py +++ b/maubot/management/api/client_auth.py @@ -47,6 +47,7 @@ class AuthRequestInfo(NamedTuple): username: str password: str user_type: str + device_name: str update_client: bool @@ -69,11 +70,15 @@ async def read_client_auth_request(request: web.Request) -> Tuple[Optional[AuthR base_url = server["url"] except KeyError: return None, resp.invalid_server - secret = server.get("secret") - api = ClientAPI(base_url=base_url, loop=get_loop()) - user_type = body.get("user_type", "bot") - update_client = request.query.get("update_client", "").lower() in ("1", "true", "yes") - return AuthRequestInfo(api, secret, username, password, user_type, update_client), None + return AuthRequestInfo( + client=ClientAPI(base_url=base_url, loop=get_loop()), + secret=server.get("secret"), + username=username, + password=password, + user_type=body.get("user_type", "bot"), + device_name=body.get("device_name", "Maubot"), + update_client=request.query.get("update_client", "").lower() in ("1", "true", "yes"), + ), None def generate_mac(secret: str, nonce: str, username: str, password: str, admin: bool = False, @@ -94,23 +99,23 @@ def generate_mac(secret: str, nonce: str, username: str, password: str, admin: b @routes.post("/client/auth/{server}/register") async def register(request: web.Request) -> web.Response: - info, err = await read_client_auth_request(request) + req, err = await read_client_auth_request(request) if err is not None: return err - if not info.secret: + if not req.secret: return resp.registration_secret_not_found path = SynapseAdminPath.v1.register - res = await info.client.api.request(Method.GET, path) + res = await req.client.api.request(Method.GET, path) content = { "nonce": res["nonce"], - "username": info.username, - "password": info.password, + "username": req.username, + "password": req.password, "admin": False, - "user_type": info.user_type, + "user_type": req.user_type, } - content["mac"] = generate_mac(**content, secret=info.secret) + content["mac"] = generate_mac(**content, secret=req.secret) try: - raw_res = await info.client.api.request(Method.POST, path, content=content) + raw_res = await req.client.api.request(Method.POST, path, content=content) except MatrixRequestError as e: return web.json_response({ "errcode": e.errcode, @@ -118,9 +123,9 @@ async def register(request: web.Request) -> web.Response: "http_status": e.http_status, }, status=HTTPStatus.INTERNAL_SERVER_ERROR) login_res = LoginResponse.deserialize(raw_res) - if info.update_client: + if req.update_client: return await _create_client(login_res.user_id, { - "homeserver": str(info.client.api.base_url), + "homeserver": str(req.client.api.base_url), "access_token": login_res.access_token, "device_id": login_res.device_id, }) @@ -129,23 +134,23 @@ async def register(request: web.Request) -> web.Response: @routes.post("/client/auth/{server}/login") async def login(request: web.Request) -> web.Response: - info, err = await read_client_auth_request(request) + req, err = await read_client_auth_request(request) if err is not None: return err device_id = ''.join(random.choices(string.ascii_uppercase + string.digits, k=8)) - client = info.client try: - res = await client.login(identifier=info.username, login_type=LoginType.PASSWORD, - password=info.password, device_id=f"maubot_{device_id}", - initial_device_display_name="Maubot", store_access_token=False) + res = await req.client.login(identifier=req.username, login_type=LoginType.PASSWORD, + password=req.password, device_id=f"maubot_{device_id}", + initial_device_display_name=req.device_name, + store_access_token=False) except MatrixRequestError as e: return web.json_response({ "errcode": e.errcode, "error": e.message, }, status=e.http_status) - if info.update_client: + if req.update_client: return await _create_or_update_client(res.user_id, { - "homeserver": str(client.api.base_url), + "homeserver": str(req.client.api.base_url), "access_token": res.access_token, "device_id": res.device_id, }, is_login=True)