{"id":23649271,"url":"https://github.com/cyb3rko/matrix-guardian","last_synced_at":"2026-04-17T16:32:11.728Z","repository":{"id":268070337,"uuid":"900355235","full_name":"cyb3rko/matrix-guardian","owner":"cyb3rko","description":"A friendly, lightweight Matrix bot for protecting the people","archived":false,"fork":false,"pushed_at":"2025-12-27T05:13:41.000Z","size":105,"stargazers_count":4,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-28T21:26:45.466Z","etag":null,"topics":["docker","go","golang","guardian","matrix","security"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cyb3rko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-12-08T15:12:41.000Z","updated_at":"2025-12-27T05:13:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"55f7153c-4ef7-4162-aaee-96b13d805f90","html_url":"https://github.com/cyb3rko/matrix-guardian","commit_stats":null,"previous_names":["cyb3rko/matrix-guardian"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cyb3rko/matrix-guardian","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyb3rko%2Fmatrix-guardian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyb3rko%2Fmatrix-guardian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyb3rko%2Fmatrix-guardian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyb3rko%2Fmatrix-guardian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cyb3rko","download_url":"https://codeload.github.com/cyb3rko/matrix-guardian/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyb3rko%2Fmatrix-guardian/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31936586,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-17T12:37:54.787Z","status":"ssl_error","status_checked_at":"2026-04-17T12:37:25.095Z","response_time":62,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","go","golang","guardian","matrix","security"],"created_at":"2024-12-28T15:24:50.512Z","updated_at":"2026-04-17T16:32:11.718Z","avatar_url":"https://github.com/cyb3rko.png","language":"Go","funding_links":[],"categories":["Bots"],"sub_categories":["Moderation"],"readme":"### ⚠️ Experimental; do not use in production yet\n\n# 🛡️ Matrix Guardian 🛡️\n\n[![github](https://img.shields.io/github/release/cyb3rko/matrix-guardian.svg?logo=github)](https://github.com/cyb3rko/matrix-guardian/releases/latest)\n[![last commit](https://img.shields.io/github/last-commit/cyb3rko/matrix-guardian?color=FE5196\u0026logo=git\u0026logoColor=white)](https://github.com/cyb3rko/matrix-guardian/commits/main)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits\u0026logoColor=white)](https://conventionalcommits.org)\n[![license](https://img.shields.io/github/license/cyb3rko/matrix-guardian?color=1BCC1B\u0026logo=apache)](https://www.mozilla.org/en-US/MPL/2.0/)\n\n- [Disclaimer](#disclaimer)\n- [Features](#features)\n  - [URL Filter 🌐](#url-filter-)\n  - [URL Phishing Check 🗡️](#url-phishing-check-)\n    - [VirusTotal](#virustotal)\n    - [FishFish](#fishfish)\n  - [File MIME Type Filter 📎](#file-mime-type-filter-)\n  - [File Virus Scan 🦠](#file-virus-scan-)\n    - [VirusTotal](#virustotal-1)\n  - [planned] *Keyword Filter* 📄\n- [Flowchart](#flowchart)\n- [Protected Public Rooms (Mentions)](#protected-public-rooms-mentions)\n- [License](#license)\n\n---\n\n## Disclaimer\n\nGuardian is not a user moderation bot and only analyzes messages themselves.  \nIf you are looking for user moderation, check out [the-draupnir-project/Draupnir](https://github.com/the-draupnir-project/Draupnir) or [matrix-org/mjolnir](https://github.com/matrix-org/mjolnir).\n\n---\n\n## Features\n\n### URL Filter 🌐\n\n**Activation (default: true)**: `GUARDIAN_URL_FILTER: true|false`  \n**Help Command**: `!gd url`\n\nGuardian supports URL filtering based on a customizable domain list.\n\n**Examples**:\n- `!gd url block t.me`\n- `!gd url unblock t.me`\n- `!gd url list`\n\n### URL Phishing Check 🗡\n\nGuardian supports checking URLs in messages for suspicious content.  \nThe analysis can be powered by the following providers:\n\n#### VirusTotal\n\n**Reference**: https://docs.virustotal.com/reference/url-info  \n**API-Key (required)**: `GUARDIAN_VIRUS_TOTAL_KEY: \u003ckey\u003e`  \n**Activation (default: false)**: `GUARDIAN_URL_CHECK_VIRUS_TOTAL: true|false`\n\nVirusTotal allows scanning a full URL and returning a very comprehensive scan report.  \nGuardian rates a URL \"suspicious\" if the statistics `malicious` and `suspicious` have a combined score of 3 or more.\n\n#### FishFish\n\n**Reference**: https://fishfish.gg  \n**Activation (default: false)**: `GUARDIAN_URL_CHECK_FISHFISH: true|false`\n\nFishFish allows scanning a domain and returning a rating, if found in their reports.  \nGuardian rates a URL \"suspicious\" if the FishFish rating is `malware` or `phishing` rather than `safe`.\n\n### File MIME Type Filter 📎\n\n**Activation (default: true)**: `GUARDIAN_MIME_FILTER: true|false`  \n**Help Command**: `!gd mime`\n\nGuardian supports file MIME type filtering based on a customizable MIME type list.\n\n**Examples**:\n- `!gd mime block application/zip`\n- `!gd mime unblock application/zip`\n- `!gd mime list`\n\n### File Virus Scan 🦠\n\nGuardian supports checking message attachments for malware.  \n(Currently this is limited to hash-based lookup, the long delay of live scans is a problem).  \nThe analysis can be powered by the following providers:\n\n#### VirusTotal\n\n**Reference**: https://docs.virustotal.com/reference/file-info   \n**API-Key (required)**: `GUARDIAN_VIRUS_TOTAL_KEY: \u003ckey\u003e`  \n**Activation (default: false)**: `GUARDIAN_VIRUS_CHECK_VIRUS_TOTAL: true|false`\n\nVirusTotal allows passing a hash (Guardian uses sha256) and returning a related report if one exists.  \nGuardian rates a URL \"suspicious\" if the statistic `malicious` is \u003e1 or `suspicious` is \u003e3.\n\n## Flowchart\n\nThe following chart explains how the Guardian handles messages and checks them step by step.\n\n```mermaid\nflowchart TB\n    classDef optional stroke-dasharray: 4 4\n\n    A@{ shape: rounded, label: \"Receive new message\" } --\u003e B{\"Message type\"}\n    B -- Text --\u003e D:::optional@{ shape: subproc, label: \"URL filter\" }\n    D -- Okay --\u003e C:::optional@{ shape: subproc, label: \"URL check (VirusTotal)\" }\n    D -- Contains blocklisted URL --\u003e Z@{ shape: dbl-circ, label: \"Redact\" }\n    C -- Okay --\u003e F:::optional@{ shape: subproc, label: \"URL check (FishFish)\" }\n    C -- Contains suspicious URL --\u003e Z\n    F -- Okay --\u003e G@{ shape: dbl-circ, label: \"Approve\" }\n    F -- Contains suspicious URL --\u003e Z\n    B -- Other --\u003e E:::optional@{ shape: subproc, label: \"MIME type filter\" }\n    E -- Blocklisted MIME type --\u003e Z\n    E -- Okay --\u003e H:::optional@{ shape: subproc, label: \"File virus scan (VirusTotal)\" }\n    H -- Malicious file --\u003e Z\n    H -- Okay --\u003e I@{ shape: dbl-circ, label: \"Approve\" }\n```\n\n## Protected Public Rooms (Mentions)\n\nThis list showcases some of the rooms who use the Matrix Guardian 🛡️:  \n*If you would like to add a room, please open an [issue](https://github.com/cyb3rko/matrix-guardian/issues)*\n\n- [CachyOS Community (tchncs.de)](https://matrix.to/#/#cachyos:tchncs.de)\n\n## License\n\n    This Source Code Form is subject to the terms of the Mozilla Public\n    License, v. 2.0. If a copy of the MPL was not distributed with this\n    file, You can obtain one at https://mozilla.org/MPL/2.0/.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyb3rko%2Fmatrix-guardian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyb3rko%2Fmatrix-guardian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyb3rko%2Fmatrix-guardian/lists"}