matrix-org/synapse

Cannot search for non-ascii displaynames using the admin API

Open

#16,370 opened on Sep 23, 2023

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (11,713 stars) (2,196 forks)batch import
A-Admin-APIO-UncommonS-MinorT-Defectgood first issue

Description

I searched for Chinese nicknames in the background and reported an error. {errcode: "M_UNKNOWN", error: "Query parameter 'name' must be ascii"} errcode : "M_UNKNOWN" error : "Query parameter 'name' must be ascii"

Contributor guide

Tech stack
pythonrest api
Domain
backendapi
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python basicsREST API concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
The issue is that the admin API endpoint for searching users, likely in synapse/rest/admin/users.py (e.g., SearchUsersRestServlet.on GET), validates that the 'name' query parameter is ASCII. The fix is to remove or modify this ASCII check to accept Unicode strings. Ensure proper URL encoding is used when constructing the database query. Look at the relevant handler and change the validation logic to allow non ASCII characters.
Cannot search for non-ascii displaynames using the admin API · matrix-org/synapse#16370 | Good First Issue