mirror of
https://github.com/PC-Admin/matrix-moderation-tool.git
synced 2024-12-19 07:00:27 -05:00
add basic docs files, needs expanding
This commit is contained in:
PC-Admin
parent
771d1b78e4
commit
f3ed15068e
187
README.md
187
README.md
@ -116,189 +116,4 @@ This script can automatically load and block/purge abusive rooms from rdlist, ma
|
||||
|
||||
If you are running a public server, please dm me at [@michael:perthchat.org](https://matrix.to/#/@michael:perthchat.org) and I can invite you to the 'Legion of Janitors' room.
|
||||
|
||||
Once you have read access to the [rdlist repository](https://code.glowers.club/loj/rdlist), this script can be used for multiple rdlist related functions.
|
||||
|
||||
|
||||
***
|
||||
## Collect User Reports on local users in rdlist rooms
|
||||
|
||||
This script can automatically generate 'User Reports' for each one of your local users in rdlist rooms that have the 'recommended tags'.
|
||||
|
||||
These user reports can be given to law enforcement or shared in [#janitor-dumps](https://matrix.to/#/#janitor-dumps:glowers.club) to help us locate more abusive users/rooms.
|
||||
|
||||
```
|
||||
130
|
||||
|
||||
rdlist repo already cloned...
|
||||
Fetching origin
|
||||
Pulling latest changes from rdlist repo...
|
||||
|
||||
WARNING! The following local users are current members of rooms tagged in rdlist: ['@fatweeb23838:perthchat.org', '@somecreep29330:perthchat.org']
|
||||
|
||||
Do you want to generate a user report file for each of these users? y/n? y
|
||||
|
||||
Generating user report for fatweeb23838...
|
||||
Report generated successfully on user: "fatweeb23838"
|
||||
|
||||
You can send this .zip file when reporting a user to law enforcement.
|
||||
.zip file location: /home/pcadmin/projects/matrix-moderation-tool/reports/fatweeb23838_2023-08-01_23-19-24.zip
|
||||
.zip file size: 0.00966 MB
|
||||
|
||||
|
||||
Generating user report for somecreep29330...
|
||||
Report generated successfully on user: "somecreep29330"
|
||||
|
||||
You can send this .zip file when reporting a user to law enforcement.
|
||||
.zip file location: /home/pcadmin/projects/matrix-moderation-tool/reports/somecreep29330_2023-08-01_23-19-27.zip
|
||||
.zip file size: 0.29578 MB
|
||||
```
|
||||
|
||||
|
||||
***
|
||||
## Send Incident Reports for remote users in rdlist rooms
|
||||
|
||||
This script can automatically generate 'Incident Reports' for every remote homeserver admin with users in rdlist rooms that have the 'recommended tags'.
|
||||
|
||||
It examines the homeserver involved to find a admin contact method via [MSC1929](https://github.com/matrix-org/matrix-spec-proposals/pull/1929). If an MXID is returned it will attempt to send the Incident Report over Matrix. If an email is provided it will send the Incident Report over email. If neither is found a whois lookup is performed and the Incident Report are sent to the domain registrar via email.
|
||||
|
||||
```
|
||||
131
|
||||
|
||||
rdlist repo already cloned...
|
||||
Fetching origin
|
||||
Pulling latest changes from rdlist repo...
|
||||
|
||||
WARNING! The following remote users are current members of rooms tagged in rdlist: ['@pedobear:matrix.org', '@randomcreep:perthchat.org']
|
||||
|
||||
Do you want to send out incident reports for these users to every homeserver admin involved? y/n? y
|
||||
|
||||
Sending Incident Report for users from matrix.org to abuse@matrix.org
|
||||
|
||||
Sending Incident Report for users from perthchat.org to @michael:perthchat.org
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## rdlist Block/Purge all rooms with recommended rdlist tags
|
||||
|
||||
Finally this script can be used to shutdown rooms with the recommended rdlist tags.
|
||||
|
||||
This function is much larger and will ask you if you also want to create user/incident reports before the shutdowns. (Recommended) It'll also ask you if you want to shadowban the users in these rooms to prevent them from alerting others. (Recommended) Finally it'll ask if you want to shutdown the local accounts located in these rooms.
|
||||
|
||||
```
|
||||
$ python3 moderation_tool.py
|
||||
|
||||
Please select one of the following options:
|
||||
...
|
||||
Please enter a number from the above menu, or enter 'q' or 'e' to exit.
|
||||
|
||||
132
|
||||
|
||||
@mod_team:perthchat.org account already exists. Resetting account password.
|
||||
|
||||
Ensuring @mod_team:perthchat.org account is a server admin.
|
||||
|
||||
rdlist repo already cloned...
|
||||
Fetching origin
|
||||
rdlist repo is up-to-date, no need to pull changes.
|
||||
|
||||
Using recommended rdlist tags. Rooms matching the following tags will be purged and/or blocked:
|
||||
['hub_room_links', 'hub_room_trade', 'preban', 'degen_misc', 'beastiality', 'degen_porn', 'gore', 'snuff', 'degen_larp', 'hub_room_sussy', 'bot_spam', 'cfm', 'jailbait', 'bot_porn', 'toddlercon', 'loli', 'csam', 'tfm', 'degen_meet', 'stylized_3d_loli', '3d_loli']
|
||||
|
||||
WARNING! The following local users are current members of rooms tagged in rdlist: ['@***REDACTED***:perthchat.org']
|
||||
|
||||
Do you want to generate a user report file for each of these users? y/n? n
|
||||
|
||||
Skipping user report generation...
|
||||
|
||||
WARNING! The following remote users are current members of rooms tagged in rdlist: ['@***REDACTED***:matrix.org']
|
||||
|
||||
Do you want to send out incident reports for these users to every homeserver admin involved? y/n? n
|
||||
|
||||
Skipping incident report generation...
|
||||
|
||||
|
||||
Number of rdlist rooms being shutdown: 346
|
||||
|
||||
Are you sure you want to block/shutdown these rooms? y/n? y
|
||||
|
||||
|
||||
Skipping already blocked room: !***REDACTED***:matrix.org
|
||||
|
||||
|
||||
Skipping already blocked room: !***REDACTED***:matrix.org
|
||||
|
||||
|
||||
Skipping already blocked room: !***REDACTED***:matrix.org
|
||||
|
||||
|
||||
Blocking unknown room: !***REDACTED***:matrix.org
|
||||
Successfully blocked room !***REDACTED***:matrix.org
|
||||
|
||||
|
||||
Blocking unknown room: !***REDACTED***:matrix.org
|
||||
Successfully blocked room !***REDACTED***:matrix.org
|
||||
|
||||
|
||||
Skipping already blocked room: !***REDACTED***:matrix.org
|
||||
|
||||
|
||||
Shutting down known room: !***REDACTED***:sibnsk.net
|
||||
Sleeping for 2 seconds...
|
||||
Sleeping for 4 seconds...
|
||||
Sleeping for 8 seconds...
|
||||
!***REDACTED***:sibnsk.net has been successfully shutdown!
|
||||
List of kicked users:
|
||||
@***REDACTED***:perthchat.org
|
||||
|
||||
|
||||
Skipping already blocked room: !***REDACTED***:anontier.nl
|
||||
|
||||
|
||||
Room shutdowns completed!
|
||||
|
||||
User login details for your moderator account:
|
||||
|
||||
Username: mod_team
|
||||
Password: ***REDACTED***
|
||||
|
||||
Print rdlist statistics:
|
||||
|
||||
Number of rooms blocked: 4
|
||||
Number of rooms purged: 2
|
||||
Number of local users located in rdlist rooms and kicked: 1
|
||||
|
||||
The following users were current members of rooms tagged in rdlist: ['@***REDACTED***:perthchat.org']
|
||||
|
||||
Do you want to also deactivate all these accounts that were kicked from rdlist rooms? y/n?
|
||||
...
|
||||
```
|
||||
|
||||
|
||||
***
|
||||
## One-touch Reporting
|
||||
|
||||
WARNING: This section is under heavy development and shouldn't be used by anyone!!!
|
||||
|
||||
This script can automatically generate reports about user accounts for law enforcement.
|
||||
|
||||
It collects as much data about the target user account as possible, then packages it into an encrypted ZIP file that can be shared:
|
||||
```
|
||||
|
||||
Please enter a number from the above menu, or enter 'q' or 'e' to exit.
|
||||
|
||||
150
|
||||
|
||||
Please enter the username to automatically generate a report: pedobear
|
||||
|
||||
...
|
||||
|
||||
Report generated successfully on user: "pedobear"
|
||||
|
||||
You can send this .zip file and password when reporting a user to law enforcement.
|
||||
|
||||
.zip file location: ./reports/pedobear_2023-07-23_02-21-56.zip
|
||||
.zip file size: 0.503927 MB
|
||||
```
|
||||
For more information on rdlist related function consult the [support document](./docs/rdlist_functions.md).
|
||||
|
||||
193
docs/rdlist_functions.md
Normal file
193
docs/rdlist_functions.md
Normal file
@ -0,0 +1,193 @@
|
||||
|
||||
# rdlist Functions
|
||||
|
||||
***
|
||||
## Collect User Reports on local users in rdlist rooms
|
||||
|
||||
This script can automatically generate 'User Reports' for each one of your local users in rdlist rooms that have the 'recommended tags'.
|
||||
|
||||
These user reports can be given to law enforcement or shared in [#janitor-dumps](https://matrix.to/#/#janitor-dumps:glowers.club) to help us locate more abusive users/rooms.
|
||||
|
||||
```
|
||||
130
|
||||
|
||||
rdlist repo already cloned...
|
||||
Fetching origin
|
||||
Pulling latest changes from rdlist repo...
|
||||
|
||||
WARNING! The following local users are current members of rooms tagged in rdlist: ['@fatweeb23838:perthchat.org', '@somecreep29330:perthchat.org']
|
||||
|
||||
Do you want to generate a user report file for each of these users? y/n? y
|
||||
|
||||
Generating user report for fatweeb23838...
|
||||
Report generated successfully on user: "fatweeb23838"
|
||||
|
||||
You can send this .zip file when reporting a user to law enforcement.
|
||||
.zip file location: /home/pcadmin/projects/matrix-moderation-tool/reports/fatweeb23838_2023-08-01_23-19-24.zip
|
||||
.zip file size: 0.00966 MB
|
||||
|
||||
|
||||
Generating user report for somecreep29330...
|
||||
Report generated successfully on user: "somecreep29330"
|
||||
|
||||
You can send this .zip file when reporting a user to law enforcement.
|
||||
.zip file location: /home/pcadmin/projects/matrix-moderation-tool/reports/somecreep29330_2023-08-01_23-19-27.zip
|
||||
.zip file size: 0.29578 MB
|
||||
```
|
||||
|
||||
'rdlist' is a comprehensive list of child abuse related rooms on Matrix, it's a safety initiative led by the [Legion of Janitors](https://matrix.to/#/#janitors:glowers.club).
|
||||
|
||||
This script can automatically load and block/purge abusive rooms from rdlist, making it **very easy** for inexperienced administrators to block this harmful content.
|
||||
|
||||
If you are running a public server, please dm me at [@michael:perthchat.org](https://matrix.to/#/@michael:perthchat.org) and I can invite you to the 'Legion of Janitors' room.
|
||||
|
||||
Once you have read access to the [rdlist repository](https://code.glowers.club/loj/rdlist), this script can be used for multiple rdlist related functions.
|
||||
|
||||
***
|
||||
## Send Incident Reports for remote users in rdlist rooms
|
||||
|
||||
This script can automatically generate 'Incident Reports' for every remote homeserver admin with users in rdlist rooms that have the 'recommended tags'.
|
||||
|
||||
It examines the homeserver involved to find a admin contact method via [MSC1929](https://github.com/matrix-org/matrix-spec-proposals/pull/1929). If an MXID is returned it will attempt to send the Incident Report over Matrix. If an email is provided it will send the Incident Report over email. If neither is found a whois lookup is performed and the Incident Report are sent to the domain registrar via email.
|
||||
|
||||
```
|
||||
131
|
||||
|
||||
rdlist repo already cloned...
|
||||
Fetching origin
|
||||
Pulling latest changes from rdlist repo...
|
||||
|
||||
WARNING! The following remote users are current members of rooms tagged in rdlist: ['@pedobear:matrix.org', '@randomcreep:perthchat.org']
|
||||
|
||||
Do you want to send out incident reports for these users to every homeserver admin involved? y/n? y
|
||||
|
||||
Sending Incident Report for users from matrix.org to abuse@matrix.org
|
||||
|
||||
Sending Incident Report for users from perthchat.org to @michael:perthchat.org
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## rdlist Block/Purge all rooms with recommended rdlist tags
|
||||
|
||||
Finally this script can be used to shutdown rooms with the recommended rdlist tags.
|
||||
|
||||
This function is much larger and will ask you if you also want to create user/incident reports before the shutdowns. (Recommended) It'll also ask you if you want to shadowban the users in these rooms to prevent them from alerting others. (Recommended) Finally it'll ask if you want to shutdown the local accounts located in these rooms.
|
||||
|
||||
```
|
||||
$ python3 moderation_tool.py
|
||||
|
||||
Please select one of the following options:
|
||||
...
|
||||
Please enter a number from the above menu, or enter 'q' or 'e' to exit.
|
||||
|
||||
132
|
||||
|
||||
@mod_team:perthchat.org account already exists. Resetting account password.
|
||||
|
||||
Ensuring @mod_team:perthchat.org account is a server admin.
|
||||
|
||||
rdlist repo already cloned...
|
||||
Fetching origin
|
||||
rdlist repo is up-to-date, no need to pull changes.
|
||||
|
||||
Using recommended rdlist tags. Rooms matching the following tags will be purged and/or blocked:
|
||||
['hub_room_links', 'hub_room_trade', 'preban', 'degen_misc', 'beastiality', 'degen_porn', 'gore', 'snuff', 'degen_larp', 'hub_room_sussy', 'bot_spam', 'cfm', 'jailbait', 'bot_porn', 'toddlercon', 'loli', 'csam', 'tfm', 'degen_meet', 'stylized_3d_loli', '3d_loli']
|
||||
|
||||
WARNING! The following local users are current members of rooms tagged in rdlist: ['@***REDACTED***:perthchat.org']
|
||||
|
||||
Do you want to generate a user report file for each of these users? y/n? n
|
||||
|
||||
Skipping user report generation...
|
||||
|
||||
WARNING! The following remote users are current members of rooms tagged in rdlist: ['@***REDACTED***:matrix.org']
|
||||
|
||||
Do you want to send out incident reports for these users to every homeserver admin involved? y/n? n
|
||||
|
||||
Skipping incident report generation...
|
||||
|
||||
|
||||
Number of rdlist rooms being shutdown: 346
|
||||
|
||||
Are you sure you want to block/shutdown these rooms? y/n? y
|
||||
|
||||
|
||||
Skipping already blocked room: !***REDACTED***:matrix.org
|
||||
|
||||
|
||||
Skipping already blocked room: !***REDACTED***:matrix.org
|
||||
|
||||
|
||||
Skipping already blocked room: !***REDACTED***:matrix.org
|
||||
|
||||
|
||||
Blocking unknown room: !***REDACTED***:matrix.org
|
||||
Successfully blocked room !***REDACTED***:matrix.org
|
||||
|
||||
|
||||
Blocking unknown room: !***REDACTED***:matrix.org
|
||||
Successfully blocked room !***REDACTED***:matrix.org
|
||||
|
||||
|
||||
Skipping already blocked room: !***REDACTED***:matrix.org
|
||||
|
||||
|
||||
Shutting down known room: !***REDACTED***:sibnsk.net
|
||||
Sleeping for 2 seconds...
|
||||
Sleeping for 4 seconds...
|
||||
Sleeping for 8 seconds...
|
||||
!***REDACTED***:sibnsk.net has been successfully shutdown!
|
||||
List of kicked users:
|
||||
@***REDACTED***:perthchat.org
|
||||
|
||||
|
||||
Skipping already blocked room: !***REDACTED***:anontier.nl
|
||||
|
||||
|
||||
Room shutdowns completed!
|
||||
|
||||
User login details for your moderator account:
|
||||
|
||||
Username: mod_team
|
||||
Password: ***REDACTED***
|
||||
|
||||
Print rdlist statistics:
|
||||
|
||||
Number of rooms blocked: 4
|
||||
Number of rooms purged: 2
|
||||
Number of local users located in rdlist rooms and kicked: 1
|
||||
|
||||
The following users were current members of rooms tagged in rdlist: ['@***REDACTED***:perthchat.org']
|
||||
|
||||
Do you want to also deactivate all these accounts that were kicked from rdlist rooms? y/n?
|
||||
...
|
||||
```
|
||||
|
||||
|
||||
***
|
||||
## One-touch Reporting
|
||||
|
||||
WARNING: This section is under heavy development and shouldn't be used by anyone!!!
|
||||
|
||||
This script can automatically generate reports about user accounts for law enforcement.
|
||||
|
||||
It collects as much data about the target user account as possible, then packages it into an encrypted ZIP file that can be shared:
|
||||
```
|
||||
|
||||
Please enter a number from the above menu, or enter 'q' or 'e' to exit.
|
||||
|
||||
150
|
||||
|
||||
Please enter the username to automatically generate a report: pedobear
|
||||
|
||||
...
|
||||
|
||||
Report generated successfully on user: "pedobear"
|
||||
|
||||
You can send this .zip file and password when reporting a user to law enforcement.
|
||||
|
||||
.zip file location: ./reports/pedobear_2023-07-23_02-21-56.zip
|
||||
.zip file size: 0.503927 MB
|
||||
```
|
||||
63
docs/room_functions.md
Normal file
63
docs/room_functions.md
Normal file
@ -0,0 +1,63 @@
|
||||
#### Room Commands ####
|
||||
|
||||
50) **List details of a room.**
|
||||
- Shows comprehensive information about a specific room.
|
||||
|
||||
51) **List the members of a room.**
|
||||
- Displays all the members who are part of a particular room.
|
||||
|
||||
52) **Export the state events of a room.**
|
||||
- Retrieves and saves the state events (such as topic changes, member joins) of a specific room.
|
||||
|
||||
53) **Export the state events of multiple rooms.**
|
||||
- Gathers and saves the state events from several rooms simultaneously.
|
||||
|
||||
54) **List rooms in public directory.**
|
||||
- Displays all the rooms that are publicly available and listed in the directory.
|
||||
|
||||
55) **Remove a room from the public directory.**
|
||||
- Takes a specific room off the public directory, making it less accessible to users browsing the directory.
|
||||
|
||||
56) **Remove multiple rooms from the public directory.**
|
||||
- Removes several rooms from the public directory at once.
|
||||
|
||||
57) **Redact a room event.**
|
||||
- Conceals specific events in a room, such as messages or media, from being visible.
|
||||
|
||||
58) **List/Download all media in a room.**
|
||||
- Displays and offers the option to download all media files shared in a specific room.
|
||||
|
||||
59) **Download media from multiple rooms.**
|
||||
- Enables downloading of media files shared across several rooms.
|
||||
|
||||
60) **Quarantine all media in a room.**
|
||||
- Isolates and restricts access to all media files in a specific room, usually due to concerns over inappropriate content.
|
||||
|
||||
61) **Shutdown a room.**
|
||||
- Terminates a room, preventing further activities or messages in it.
|
||||
|
||||
62) **Shutdown multiple rooms.**
|
||||
- Closes several rooms simultaneously, halting any ongoing activity in them.
|
||||
|
||||
63) **Delete a room.**
|
||||
- Permanently removes a room and all its content.
|
||||
|
||||
64) **Delete multiple rooms.**
|
||||
- Erases several rooms and their content from the server at once.
|
||||
|
||||
65) **Purge the event history of a room to a specific timestamp.**
|
||||
- Deletes all events in a room up to a certain point in time, preserving events after that timestamp.
|
||||
|
||||
66) **Purge the event history of multiple rooms to a specific timestamp.**
|
||||
- Clears the events in several rooms up to a specified timestamp.
|
||||
|
||||
67) **Get blocked status for room.**
|
||||
- Checks if a room is blocked and restricted from user access.
|
||||
|
||||
68) **Block a room.**
|
||||
- Restricts access to a room, preventing users from joining or interacting in it.
|
||||
|
||||
69) **Unblock a room.**
|
||||
- Restores access to a previously blocked room, allowing users to join and participate once more.
|
||||
|
||||
> **Note:** Managing rooms is a sensitive operation, especially when dealing with content and user privacy. Ensure you have the required permissions and handle operations with care.
|
||||
67
docs/user_functions.md
Normal file
67
docs/user_functions.md
Normal file
@ -0,0 +1,67 @@
|
||||
|
||||
#### User Account Commands ####
|
||||
|
||||
1) **Deactivate a user account.**
|
||||
- This function disables a specific user's account, making it unusable for the owner.
|
||||
|
||||
2) **Deactivate multiple user accounts.**
|
||||
- Allows you to disable several user accounts at once.
|
||||
|
||||
3) **Create a user account.**
|
||||
- Use this to generate a new user account.
|
||||
|
||||
4) **Create multiple user accounts.**
|
||||
- This facilitates the creation of several user accounts simultaneously.
|
||||
|
||||
5) **Reset a user's password.**
|
||||
- If a user forgets their password, this function helps set a new one.
|
||||
|
||||
6) **Whois user account.**
|
||||
- Provides detailed information about a specific user's account.
|
||||
|
||||
7) **Whois multiple user accounts.**
|
||||
- Retrieves detailed information for multiple user accounts at once.
|
||||
|
||||
8) **Query user account.**
|
||||
- Allows you to get specific details or attributes of a user account.
|
||||
|
||||
9) **Query multiple user accounts.**
|
||||
- Retrieve specific details for several user accounts simultaneously.
|
||||
|
||||
10) **List room memberships of user.**
|
||||
- Displays the list of rooms that a user is a part of.
|
||||
|
||||
11) **Promote a user to server admin.**
|
||||
- Elevates a user's privileges, making them an administrator on the server.
|
||||
|
||||
12) **List all user accounts.**
|
||||
- Displays a comprehensive list of all user accounts on the server.
|
||||
|
||||
13) **Quarantine all media a user uploaded.**
|
||||
- Segregates and isolates all media files uploaded by a specific user. Useful for potential harmful or inappropriate content.
|
||||
|
||||
14) **Collect account data.**
|
||||
- Retrieves all available data associated with a user's account.
|
||||
|
||||
15) **List account pushers.**
|
||||
- Shows devices and services that have push access to a user's account.
|
||||
|
||||
16) **Get rate limit of a user account.**
|
||||
- Displays the frequency at which a user can make requests or actions.
|
||||
|
||||
17) **Set rate limit of a user account.**
|
||||
- Adjusts the frequency rate at which a user can make requests or actions.
|
||||
|
||||
18) **Delete rate limit of a user account.**
|
||||
- Removes any rate limits set on a user's account, granting them unrestricted action frequency.
|
||||
|
||||
19) **Check if user account exists.**
|
||||
- Verifies the existence of a specific user account on the server.
|
||||
|
||||
20) **Shadow ban a user.**
|
||||
- Discreetly prevents a user's activities from being visible to others, while appearing normal to the banned user.
|
||||
|
||||
21) **Find a user by their 3PID (Third-party ID).**
|
||||
- Allows you to locate a user based on their third-party identifiers, such as email or phone number.
|
||||
|
||||
> **Note:** All these commands utilize the Synapse API. Always exercise caution and ensure you have the necessary permissions when accessing and modifying user accounts.
|
||||
Loading…
Reference in New Issue
Block a user