Hawk-eye 使用与启动教程

Hawk-eye 使用与启动教程

hawk-eye A powerful scanner to scan your Filesystem, S3, MySQL, Redis, Google Cloud Storage and Firebase storage for PII and sensitive data. 项目地址: https://gitcode.com/gh_mirrors/ha/hawk-eye

1. 项目介绍

Hawk-eye 是一个强大的命令行工具，旨在保护数据免受泄露和网络威胁。它能够快速扫描多个数据源（如 S3、MySQL、PostgreSQL、MongoDB、CouchDB、Google Drive、Slack、Redis、Firebase 和文件系统等），寻找个人信息（PII）和秘密信息。Hawk-eye 使用高级文本分析和 OCR 技术深入各种文档格式，如 docx、xlsx、pptx、pdf、图片（jpg、png、gif）、压缩文件（zip、tar、rar）甚至视频文件，确保跨平台的数据得到全面保护。

2. 项目快速启动

安装

通过 pip 安装 hawk-scanner：

pip3 install hawk-scanner

使用 Docker

运行以下命令来使用 Docker：

docker run --rm \
--platform linux/amd64 \
-v /path/to/your/connection.yml:/app/connection.yml \
-v /path/to/your/fingerprint.yml:/app/fingerprint.yml \
rohitcoder/hawk-eye \
slack --connection /app/connection.yml --fingerprint /app/fingerprint.yml

确保将 /path/to/your/connection.yml 和 /path/to/your/fingerprint.yml 替换为你的配置文件路径。

使用二进制文件

以下是一个使用 hawk-scanner 二进制文件的例子：

hawk_scanner all --connection connection.yml --fingerprint fingerprint.yml --json output.json --debug

你还可以将连接数据作为 CLI 输入，输出为 JSON 数据：

hawk_scanner fs --connection-json '{
    "sources": {
        "fs": {
            "fs1": {
                "quick_scan": true,
                "path": "/path/to/your/data/file"
            }
        }
    }
}' --stdout --quiet --fingerprint fingerprint.yml

确保将 /path/to/your/data/file 替换为你想要扫描的文件路径。

在 Python 脚本中使用

你还可以在 Python 脚本中导入 Hawk-eye：

from hawk_scanner.internals import system

pii = system.scan_file("/path/to/your/data/file")
print(pii)

同样，确保将 /path/to/your/data/file 替换为你想要扫描的文件路径。

3. 应用案例和最佳实践

• 扫描敏感文件：使用 Hawk-eye 对存储的文件进行定期扫描，以发现可能包含敏感信息的文件。
• 集成到 CI/CD：在持续集成和持续部署的流程中加入 Hawk-eye 的扫描步骤，以确保代码库的安全性。
• 实时监控：结合实时监控工具，如 Slack，以实时接收潜在的数据泄露警报。

4. 典型生态项目

• 用于敏感数据保护的工具集：例如，结合 Data Loss Prevention (DLP) 工具一起使用。
• 安全审计平台：将 Hawk-eye 集成到安全审计平台中，以增强审计流程。
• 云服务安全扫描：针对云存储服务进行定制化的安全扫描。

hawk-eye A powerful scanner to scan your Filesystem, S3, MySQL, Redis, Google Cloud Storage and Firebase storage for PII and sensitive data. 项目地址: https://gitcode.com/gh_mirrors/ha/hawk-eye