matrix-org / matrix-org/matrix-spec
Send abuse reports to an appservice via the transations API
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
We have an API for submitting abuse reports to the homeserver, where reading those reports is left as an exercise the the reader. It would be nice if we could re-use the AS transactions API to push those abuse reports to an interested party (hey Mjolnir!).
Obviously I'd imagine some kind of opt-in flag rather than every appservice seeing abuse reports, for security purposes. Something like a push_reports: true in the registration file.
(This is crying out for an MSC, but I lack the time atm).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the existing abuse-report API and the appservice transactions API described in the issue. Determine the protocol and registration changes needed for an opt-in report destination, then document the behavior in an MSC and the Matrix specification; done means the proposal defines who receives reports and how the opt-in protects other appservices.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, security
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100