MinHash-based Code Relationship & Investigation Toolkit (MCRIT)
MCRIT is a framework created to simplify the application of the MinHash algorithm in the context of code similarity. It can be used to rapidly implement "shinglers", i.e. methods which encode properties of disassembled functions, to then be used for similarity estimation via the MinHash algorithm. It is tailored to work with disassembly reports emitted by SMDA.
Usage
Dockerized Usage
We highly recommend to use the fully packaged docker-mcrit for trivial deployment and usage. First and foremost, this will ensure that you have fully compatible versions across all components, including a database for persistence and a web frontend for convenient interaction.
Standalone Usage
Installing MCRIT on its own will require some more steps. For the following, we assume Ubuntu as host operating system.
MCRIT requires Python 3.11 or newer. Its dependencies are declared in pyproject.toml and are installed together with the package:
# install python and MCRIT along with its dependencies
$ sudo apt install python3 python3-pip
$ pip install -e .
By default, MongoDB 5.0 is used as backend, which is also the recommended mode of operation as it provides a persistent data storage. The following commands outline an example installation on Ubuntu:
# fetch mongodb signing key
$ sudo apt-get install gnupg
$ wget -qO - https://www.mongodb.org/static/pgp/server-5.0.asc | sudo apt-key add -
# add package repository (Ubuntu 22.04)
$ echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-5.0.list
# OR add package repository (Ubuntu 20.04)
$ echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-5.0.list
# OR add package repository (Ubuntu 18.04)
$ echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu bionic/mongodb-org/5.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-5.0.list
# install mongodb
$ sudo apt-get update
$ sudo apt-get install -y mongodb-org
# start mongodb as a service
$ sudo systemctl start mongod
# optionally configure to start the service with system startup
$ sudo systemctl enable mongod
When doing the standalone installation, you possibly want to install the MCRIT module based on the cloned repository, like so:
$ pip install -e .
After this initial installation and if desired, MCRIT can be used without an internet connection.
Operation
The MCRIT backend is generally divided into two components, a server providing an API interface to work with and one or more workers processing queued jobs. They can be started in seperate shells using:
$ mcrit server
and
$ mcrit worker
By default, the REST API server will be listening on http://127.0.0.1:8000/.
Interaction
Regardless of your choice for installation, once running you can interact with the MCRIT backend.
MCRIT Client
We have created a Python client module that is capable of working with all available endpoints of the server. Documentation for this client module is currently in development.
MCRIT CLI
There is also a CLI which is based on this client package, examples:
# query some stats of the data stored in the backend
$ mcrit client status
{'status': {'db_state': 187, 'storage_type': 'mongodb', 'num_bands': 20, 'num_samples': 137, 'num_families': 14, 'num_functions': 129110, 'num_pichashes': 25385}}
# submit a malware sample with filename sample_unpacked, using family name "some_family"
$ mcrit client submit sample_unpacked -f some_family
1.039s -> (architecture: intel.32bit, base_addr: 0x10000000): 634 functions
A more extensive documentation of the MCRIT CLI is available here
MCRIT IDA Plugin
An IDA plugin is also currently under development. To use it, first create your own config.py and make required changes depending on the deployment of your MCRIT instance:
cp ./plugins/ida/template.config.py ./plugins/ida/config.py
nano ./plugins/ida/config.py
Then simply run the script found at
./plugins/ida/ida_mcrit.py
in IDA.
Reference Data
In July 2023, we started populating a Github repository which contains ready-to-use reference data for common compilers and libraries.
Version History
See CHANGELOG.md for the full release history.
Credits & Notes
Thanks to Steffen Enders and Paul Hordiienko for their contributions to the internal research prototype of this project! Thanks to Manuel Blatt for his extensive contributions to and refactorings of this project as well as for the client module!
Pull requests welcome! :)
License
MinHash-based Code Relationship & Investigation Toolkit (MCRIT)
Copyright (C) 2022 Daniel Plohmann, Manuel Blatt
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Some plug-ins and libraries may have different licenses.
If so, a license file is provided in the plug-in's folder.
1 maintainer
Release files for mcrit 1.9.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mcrit-1.9.0.tar.gz | 484.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mcrit-1.9.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 936.0 kB
Release files / mcrit-1.9.0.tar.gz
| Download URL | mcrit-1.9.0.tar.gz |
|---|---|
| Size | 484.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
31268b9d52ad287bbcb556a83e5685fff00709539923d4b68b76c57c8992c341
|
|
BLAKE2b-256 checksum How to use checksums |
1bee761aededa4c13fe484764f4243c6b56af644420b3368928c3acb9c831d6c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.4
|
Release files / mcrit-1.9.0-py3-none-any.whl
| Download URL | mcrit-1.9.0-py3-none-any.whl |
|---|---|
| Size | 451.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b12056b3510a89d697578038a8a9b4526a75217d436314d3dcd2bc7ddfbcfaeb
|
|
BLAKE2b-256 checksum How to use checksums |
6eada583178ab1b38e3c37c65f103432dc7759613127d0b1bddd21775d0d6ab5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.4
|
