yahdlp/README.md

Enterprise-grade PII detection and redaction tool by Yahya Enterprises

# yahDLP 

Enterprise-grade PII detection and redaction tool [dlp.yah.qa](https://dlp.yah.qa/) automatically detect and redact sensitive information.

![Version](https://img.shields.io/npm/v/yahdlp)
![License](https://img.shields.io/npm/l/yahdlp)
![Downloads](https://img.shields.io/npm/dt/yahdlp)

## Features

- 🔍 Accurate email and phone number detection
- 🛡️ Smart redaction system
- ✨ Visual confirmation overlays
- 🎯 Targeted redaction based on inspected values
- 🏢 Enterprise-ready processing

## Installation

```bash
npm install -g yahdlp
```

## Usage Guide

### PII Inspection

```bash
# Inspect for email
yahdlp inspect -t "dev@Yayha.com" -e

# Inspect for phone number
yahdlp inspect -t "+99999999" -p

# Inspect for both email and phone
yahdlp inspect -t "Email: dev@Yayha.com Phone: +99999999"
```


## Image Redaction `No` Demo

Introducing the asset in question:

![The cloud beast himself!](https://raw.githubusercontent.com/yaya2devops/yahdlp/refs/heads/main/redact/yahAPPROACH.png)

Always inspect first, then redact:

```bash
# Demo No redaction workflow
yahdlp inspect -t "dev@Yayha.com" -e
yahdlp redact yahAPPROACH.png output.png -e

No matching PII found
```

### Result:

![Not Found](https://raw.githubusercontent.com/yaya2devops/yahdlp/refs/heads/main/redact/test-not-found/better.png)

## Image Redaction `Yes` Demo

```bash
# Demo Yes redaction workflow
yahdlp inspect -t "dev@yahya-abulhaj.dev" -e
yahdlp redact yahAPPROACH.png output.png -e

Found and redacted PII
```

### Result:

![It is found](https://raw.githubusercontent.com/yaya2devops/yahdlp/refs/heads/main/redact/output.png)


#### Phone Numbers Considerations


- SMS Example [is here](sms/README.md).

```bash
# Complete redaction workflow
yahdlp inspect -t "+4131313131315" -p
yahdlp redact yahAPPROACH.png output.png
No matching PII found

yahdlp inspect -t "+252525252531" -p
yahdlp redact sms-wa-test.png output.png
No matching PII found
```


- WhatsApp Example [is here](whatsapp/README.md).
```bash
# Phone redaction workflow
yahdlp inspect -t "+4131313131315" -p
yahdlp redact input.png output.png -p
```


## How It Works

1. **Inspection Phase**
   - Analyzes provided text for PII patterns
   - Stores detected values securely for redaction

2. **Redaction Phase**
   - Scans image for matching PII
   - Applies enterprise-grade redaction
   - Adds visual confirmation overlay

## Output States

- **PII Found**: Full redaction with clear overlay
- **No PII Match**: Transparent overlay with notification

## Security Notes

- Only redacts when inspected PII matches image content
- Non-matching PII remains visible but marked as inspected
- No sensitive data stored between sessions

## License

MIT © Yahya Entreprises built with ❤️ - Crafting privacy-first solutions for a secure digital world.


> [🍍 Fruits](https://dlp.yahya-abulhaj.dev/)