magnet - GitLite

KO | EN

gitlite — search

#reactjs #monitoring #pytorch #chatgpt #gemini #data-science #vue #ai-agent #video #hacktoberfest

magnet

(★ 112)

Purple-team telemetry & simulation toolkit.

File Explorer

ZIP Download

- - release.yml
- launch.json
- logo.png
- ransom_note_unit_test.png
- video_demo_1.mp4
- - config.rs
  - logger.rs
  - mod.rs
  - runner.rs
  - simulation.rs
  - telemetry.rs
- - mod.rs
- lib.rs
- main.rs
- ransom_note_test.rs
.gitignore
Cargo.lock
Cargo.toml
LICENSE
README.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`cargo build`

View Details ▼

Compile a local package and all of its dependencies.

cargo {{[b|build]}}

Build the package or packages defined by the `Cargo.toml` manifest file in the local path:

cargo {{[b|build]}} {{[-r|--release]}}

Build artifacts in release mode, with optimizations:

cargo {{[b|build]}} --locked

Require that `Cargo.lock` is up to date:

🔍

`cargo test`

View Details ▼

Execute the unit and integration tests of a Rust package.

cargo {{[t|test]}} {{test_name}}

Only run tests containing a specific string in their names:

cargo {{[t|test]}} -- --test-threads {{count}}

Set the number of simultaneous running test cases:

cargo {{[t|test]}} {{[-r|--release]}}

Test artifacts in release mode, with optimizations:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Magnet

[![Release](https://github.com/R3DRUN3/magnet/actions/workflows/release.yml/badge.svg)](https://github.com/R3DRUN3/magnet/actions/workflows/release.yml) 
[![Latest Release](https://img.shields.io/github/v/release/r3drun3/magnet?logo=github)](https://github.com/r3drun3/magnet/releases/latest)  
[![License: Unlicense](https://img.shields.io/badge/license-Unlicense-blue.svg)](http://unlicense.org/) ![Purple Team Badge](https://img.shields.io/badge/Team-Purple-purple)

<img src="./media/logo.png" alt="Magnet Logo" width="200">

> Draw the Signals, Detect the Threats.

## Abstract

**Magnet** is Purple-team telemetry & simulation toolkit.  
**Purpose:** modular, cross-platform (eventually) generator for telemetry and malicious activity.  
> Why the name?    
> Because this attracts SOC analysts and detection rules! 😜

As a secondary use case, Magnet can also be used as a decoy during red team engagements, to generate false positive noise and distract defenders 😈    
From an architectural standpoint, Magnet is modular, allowing you to create as many modules as you like and modify existing ones without necessarily affecting the others.

> [!CAUTION]  
> The project is still in its early stages of development and may contain bugs: **contributions are very welcome!**  
> The tool is best suited for on-the-fly demonstration/detection testing and does not replace fully fledged purple-team exercises conducted by experienced red teamers.

## Ok, but why?  
What better way to assess the utility of this tool than by directly examining one of its modules?  
Consider, for example, the [*Ransomware Simulation for Windows*](./src/platforms/windows/actions/ransomware_sim.rs) action:   
It generates thousands of files and encrypts them, attempts to delete shadow copies with older timestamps, and finally places a ransom note on the desktop.    
This module demonstrates its value for testing detection rules and behavioral analytics specifically designed to identify ransomware activity.

## Quickstart

Download the [*release*](https://github.com/r3drun3/magnet/releases/) you need from github, for example:  
```bash
curl -L -o magnet.zip https://github.com/R3DRUN3/magnet/releases/download/v0.10.0/magnet-v0.10.0-windows-x86_64.zip
```  
Extract the archive, and you are ready to go!

Or compile locally:

For Windows: 
```bash
cargo build --target x86_64-pc-windows-msvc --release
```

For Linux (coming in the future): 
```bash
cargo build --target x86_64-unknown-linux-gnu --release
```

Each binary only includes the modules for that platform.

> [!WARNING]  
> First compilation will take some minutes.

As of now, this tool has been tested on the following OS:

- `Windows 11 Pro Education 10.0.22631 22631`

## Modules

Magnet modules are mapped to the [*MITRE ATT&CK*](https://attack.mitre.org/) framework.

list modules
```bash
magnet list
```

Run all Windows modules:  
```bash
magnet run windows all
```

Run some of the Windows modules:  
```bash
magnet run windows discovery_sim ransomware_sim high_cpu_miner_sim
```

> [!CAUTION]  
> **Some modules require administrative privileges to run**.  
> Magnet prioritizes non-intrusive modules that only aim to simulate suspicious or malicious activity, but EDRs may still detect some of the modules:       
> **USE WITH CAUTION AND RUN ONLY ON AUTHORIZED SYSTEMS !!**

> [!TIP]
> To add a module/action, follow these instructions:    
> - write the module inside the parent OS folder; for example, [*here*](./src/platforms/windows/actions/) contains all the Windows ones.  
> - add the module in [*mod.rs*](./src/platforms/windows/actions/mod.rs).  
> - register the runner in [*main.rs*](./src/main.rs).  
> **For seamless integration, make sure new modules follow the signatures and contracts of existing ones**

## Activity logs  
For each execution, Magnet writes detailed activity logs (in various formats) to a fixed path, for example, on Windows:  
`%USERPROFILE%\Documents\MagnetTelemetry`.  
Activity artifacts may also be created in that directory or in other locations, depending on the module:  
For example, in the ransomware simulation, the encrypted files are stored in the `MagnetTelemetry` folder, while the ransom note is placed on the user's `Desktop`.

## Tests  
Some modules already implement unit testing, for example:  
```bash
cargo test --test ransom_note_test
```

![ransom_note_test](https://raw.githubusercontent.com/R3DRUN3/magnet/main/media/ransom_note_unit_test.png)

## Video Demo

https://github.com/user-attachments/assets/3d9aa7a9-6a22-4e4b-86cd-f1761756b241

## To-Do

- [ ] Add other windows modules
- [ ] Add linux modules