Skip to content

Commit 8b2c623

Browse files
committed
Add examples directory for advanced usage
1 parent c6aa34b commit 8b2c623

File tree

2 files changed

+8999
-0
lines changed

2 files changed

+8999
-0
lines changed

examples/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Malifiscan Examples
2+
3+
This directory provides advanced usage examples and configurations for Malifiscan, demonstrating different deployment scenarios and use cases beyond the basic setup.
4+
5+
## Available Examples
6+
7+
### config.shai-hulud-2.0.yaml
8+
9+
An example configuration that uses a hard-coded list of malicious packages instead of the default OSV feed. This demonstrates how to use the memory feed provider with a specific set of packages.
10+
11+
**Use Case**: Testing against a known set of malicious packages from security research.
12+
13+
**Package List Source**: This example includes packages identified in the [Shai-Hulud 2.0 supply chain attack research by Wiz](https://www.wiz.io/blog/shai-hulud-2-0-ongoing-supply-chain-attack).
14+
15+
**Features**:
16+
- Memory-based feed provider with pre-defined package list
17+
- JFrog registry integration enabled
18+
- Minimal logging (ERROR level only)
19+
- Storage service disabled for lightweight operation
20+
21+
**Usage**:
22+
```bash
23+
uv run python cli.py scan --config examples/config.shai-hulud-2.0.yaml
24+
```

0 commit comments

Comments
 (0)