From 72cae1f88b2b0f27e98ef75bd6e5ba308eb627ef Mon Sep 17 00:00:00 2001 From: PC-Admin Date: Fri, 18 Aug 2023 18:53:14 +0800 Subject: [PATCH] update README.md --- README.md | 62 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 33 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 14cdb70..1e22e25 100755 --- a/README.md +++ b/README.md @@ -15,14 +15,18 @@ This work is published under the MIT license, for more information on this licen *** ## Setup script -You can hard code the server URL, federation port and access token into the [hardcoded_variables.py](./hardcoded_variables.py) file for faster use, ~~it will prompt you for these values if you don't.~~ (Prompting is currently broken) +Firstly, you need hard code the 'server URL', 'federation port' and 'access token' into the [hardcoded_variables.py](./hardcoded_variables.py) file +``` +$ cp ./hardcoded_variables.py.sample ./hardcoded_variables.py +$ nano ./hardcoded_variables.py +``` Your access token can be found in Element > Settings > Help & About, your user account must first be upgraded to a server admin. This script also requires you to install the following PIP packages: ``` -pip3 install python-whois -pip3 install requests +$ pip3 install python-whois && \ +pip3 install requests && \ pip3 install matrix-nio ``` @@ -82,31 +86,6 @@ With the popular [matrix-docker-ansible-deploy](https://github.com/spantaleev/ma `matrix_synapse_admin_enabled: true` -*** -## Roadmap - -To do: -1) Add the following functions: -- https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#find-a-user-based-on-their-id-in-an-auth-provider -- https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#find-a-user-based-on-their-third-party-id-threepid-or-3pid -- https://github.com/matrix-org/synapse/blob/master/docs/admin_api/delete_group.md -2) Add fully automated (should just return a web link and decryption password) reporting functions for users: -- Description of why the report was made (what happened), include key information -- Any other usernames associated with that IP -- Timestamp for when illegal material was accessed -- Description of report format and contents (to guide the reader) -- Collect state event dumps of recently read rooms as well (as they may have looked at other suss rooms recently) -3) Have recommended rdlist function: -- return a list of offending accounts and the tags they accessed (for creating incident_dict's) - DONE -- add the shadowban function to prevent members alerting others after mass shutdowns - DONE -4) Only email reportID in incident report? -5) Add a room report function to create a properly formatted report for rdlist -6) Expand the incident reporting to also issue reports over Matrix -7) Automated public room joining and reminder if reporting email is not available? -8) Refine ipinfo module to also return extra details about the IP -9) Make existing functions compatible with JSON formatted inputs - - *** ## rdlist Functionality @@ -122,7 +101,7 @@ For more information on rdlist related function consult the [support document](. *** ## One-touch Reporting -WARNING: This section is under heavy development and shouldn't be used by anyone!!! +CAUTION: This section is under heavy development and probably shouldn't be used by anyone! This script can automatically generate reports about user accounts for law enforcement. @@ -144,3 +123,28 @@ You can send this .zip file and password when reporting a user to law enforcemen .zip file location: ./reports/pedobear_2023-07-23_02-21-56.zip .zip file size: 0.503927 MB ``` + + +*** +## Roadmap + +To do: +1) Add the following functions: +- https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#find-a-user-based-on-their-id-in-an-auth-provider +- https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#find-a-user-based-on-their-third-party-id-threepid-or-3pid +- https://github.com/matrix-org/synapse/blob/master/docs/admin_api/delete_group.md +2) Add fully automated (should just return a web link and decryption password) reporting functions for users: +- Description of why the report was made (what happened), include key information +- Any other usernames associated with that IP +- Timestamp for when illegal material was accessed +- Description of report format and contents (to guide the reader) +- Collect state event dumps of recently read rooms as well (as they may have looked at other suss rooms recently) +3) Have recommended rdlist function: +- return a list of offending accounts and the tags they accessed (for creating incident_dict's) - DONE +- add the shadowban function to prevent members alerting others after mass shutdowns - DONE +4) Only email reportID in incident report? +5) Add a room report function to create a properly formatted report for rdlist +6) Expand the incident reporting to also issue reports over Matrix +7) Automated public room joining and reminder if reporting email is not available? +8) Refine ipinfo module to also return extra details about the IP +9) Make existing functions compatible with JSON formatted inputs \ No newline at end of file