Hypatia/README.md

90 lines
3.5 KiB
Markdown
Raw Normal View History

![Banner](https://divestos.org/images/featureGraphics/Hypatia.png)
2018-07-25 21:08:35 -04:00
Hypatia
=======
2017-12-26 20:06:14 -05:00
Overview
--------
Hypatia is the world's first FOSS malware scanner for Android. It is powered by ClamAV style signature databases.
2017-12-26 20:06:14 -05:00
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
height="80">](https://f-droid.org/packages/us.spotco.malwarescanner/)
2017-12-26 20:06:14 -05:00
Features
--------
- Near zero battery impact: you'll never notice any impact on battery at all
- Extremely fast: it can scan small files (1MB) in <20ms, and even large files (40MB) in 1000ms.
- Memory efficient: with the default databases enabled it uses under 120MB.
- Regular scan: allowing selection of /system, internal storage, external storage, and installed apps
- Realtime scanner: can detect malware in realtime on write/rename in internal storage
- Completely offline: Internet is only used to download signature databases, files will never ever leave your device
2017-12-26 20:12:35 -05:00
- Persistence: will automatically restart on boot/update
2017-12-26 20:06:14 -05:00
- Tiny codebase: coming in at under 1000 sloc, it can be audited by even someone with basic programming experience
- Minimal dependencies: the app only uses libraries when necessary
- Signature databases can be enabled/disabled at the users demand
Technical Details
------------------
2019-09-22 21:17:21 -04:00
- Signature databases are ClamAV .hdb (MD5 hashes) and .hsb (SHA-1/SHA-256) format
2017-12-26 20:06:14 -05:00
- Signature databases will not be redownloaded if the file hasn't changed on the server (304 not modified)
- Signatures are stored using HashMaps for O(1) lookup
- Files have their MD5/SHA-1/SHA-256 hashes calculated in one pass
2017-12-26 20:12:35 -05:00
- Realtime scanner is multithreaded and will use half of the device's core count for scanning multiple files asynchronously
- Realtime scanning powered by a recursive FileObserver
2020-12-20 07:55:48 -05:00
- Network connections will be made to the following: https://divested.dev/MalwareScannerSignatures/*.h*b.gz
2017-12-26 20:12:35 -05:00
2017-12-26 20:21:10 -05:00
Planned Updates
----------------
2017-12-26 21:16:35 -05:00
- Option to scan on access
2018-07-25 21:08:35 -04:00
- Option to quarantine/delete on detection
2017-12-26 20:12:35 -05:00
- Scan files via share intent
- Scan newly installed/updated apps
2021-05-03 12:28:40 -04:00
- Option to let 3rd-party apps invoke scans
- Custom database support
- Automatic database updates
- Automatic database generation
- Client side database generation
- Database signature verification
- Database sanity checks
- Testing
2017-12-26 20:12:35 -05:00
- Better GUI
- Translations
- Scanning entire system using root (low priority)
2017-12-26 20:06:14 -05:00
2017-12-26 20:21:10 -05:00
Goals
-----
- Be fast
- Don't eat batteries
- Use minimal permissions
- Use libraries only when necessary
2017-12-26 20:06:14 -05:00
Credits
-------
2020-11-14 06:08:38 -05:00
- ClamAV for the databases (GPLv2)
- ESET for extra databases (BSD 2-Clause)
- Nex (@botherder) for extra databases (CC BY-SA 4.0)
- Amnesty International for extra databases (CC BY 2.0)
- Echap for extra databases (CC BY 4.0)
2017-12-26 20:06:14 -05:00
- RecursiveFileObserver.java (GPLv3): Daniel Gultsch, ownCloud Inc., Bartek Przybylski
2021-03-20 19:35:48 -04:00
- Petra Mirelli for the German/Spanish/Italian translations, the app banner/feature graphic, and various tweaks.
- Jean-Luc Tibaux and Petra Mirelli for the French translations.
2022-04-17 15:05:21 +02:00
- @srccrow for the Italian translations.
- @inkhorn for the Portuguese translations.
- @jontaix for Portuguese translations.
- @q1011 for the Russian translations.
- Oswald van Ginkel for the Afrikaans translations.
- huuhaa for the Finnish translations.
- Marcin Mikołajczak for Polish translations.
- @senpai33 for the Spanish translations.
- Icons: Google/Android/AOSP, License: Apache 2.0, https://google.github.io/material-design-icons/
2021-01-20 12:38:55 -05:00
Notices
-------
- Divested Computing Group is not affiliated with Cisco or ESET
- Hypatia is not sponsored or endorsed by Cisco or ESET
2021-07-02 17:31:44 -04:00
Donate
-------
2021-07-02 20:16:56 -04:00
- https://divested.dev/donate