hounddogai/hounddog

HoundDog.ai

概述与主要用途

HoundDog.ai 是一款源代码扫描器（SAST命令行工具），帮助组织实现以下应用场景：

• 主动PII泄露预防：在开发周期早期（如代码审查和构建流水线阶段）检测日志、文件、Cookie、令牌及第三方服务中的PII泄露，强化数据安全态势，避免生产环境中高昂的修复成本。
• 第三方风险缓解：跟踪第三方应用数据流，在新产品变更发布给用户前检测数据处理协议违规。
• 隐私合规自动数据映射：消除依赖电子表格和内部调查进行的手动且易错的处理活动文档记录。简化整个流程，跟上开发节奏，避免意外。

免费功能

• 通过https://github.com/hounddogai/hounddog/releases%E6%88%96https://hub.docker.com/r/hounddogai/hounddog%E8%BF%9B%E8%A1%8C%E6%BA%90%E4%BB%A3%E7%A0%81%E6%89%AB%E6%8F%8F%E3%80%82
• Markdown报告，提供代码库中PII数据元素的时点视图，包括敏感度级别、出现次数、文件位置和代码片段。

Starter与企业版功能

• 持续监控通过日志、文件、Cookie、令牌和第三方API以明文形式暴露PII的漏洞。
• 图形化可视化展示PII流向各数据接收器的过程。
• 与CI/CD集成，支持Azure Pipelines、BitBucket Pipelines、GitHub Actions、GitLab CI/CD、CircleCI、Jenkins等。
• 与GitHub Enterprise和GitLab Ultimate的安全仪表板集成。
• 访问HoundDog.ai云平台，用于问题分类、创建Jira任务、生成RoPA（处理活动记录）报告及扫描规则自定义。
• （即将推出）基于数据处理协议自动配置扫描规则，实现持续DPA合规和风险缓解。

与其他扫描器的区别

• 100%与其他扫描器互补：目标不是替代CodeQL、Semgrep、Snyk等，而是填补现有空白，成为PII检测领域的最佳工具。HoundDog.ai广泛且独特覆盖的常见弱点枚举包括：CWE-201、CWE-209、CWE-312、CWE-313、CWE-315、CWE-532、CWE-539。
• 隐私聚焦：默认情况下，HoundDog.ai代码扫描器仅在您的环境中运行，源代码不会离开您的 premises。
• 极速且轻量：采用以性能和内存安全著称的Rust语言编写，现代硬件上可在一分钟内扫描100万行代码，未压缩二进制文件大小小于25MB。致力于保持超轻量级，对构建流水线影响最小。
• 高精度：开箱即用地维护精心策划的多领域规则和定义集（如PII、PHI、PIFI），优先最小化误报。规则通过AI工作流持续改进，经人工专家审核并在真实代码库上测试。

系统要求

Docker镜像

• Linux上的Docker Engine或Windows/macOS上的Docker Desktop
• 内存：分配给Docker的空闲内存至少1GB

支持的编程语言

• C# / .NET
• Golang（即将支持）
• GraphQL
• Java
• JavaScript
• Kotlin
• OpenAPI / Swagger
• Python
• Ruby
• SQL
• TypeScript

使用方法

扫描文件或目录

使用Docker镜像扫描当前目录：

shell
docker run --pull=always -it --rm -v .:/data hounddogai/hounddog:latest hounddog scan

参数说明：

• --pull=always：始终拉取最新版本镜像
• -it：启用交互终端
• --rm：扫描完成后自动删除容器
• -v .:/data：将当前目录挂载到容器内的/data目录（扫描目标目录）

查看命令行选项

shell
docker run --rm hounddogai/hounddog:latest hounddog scan --help

忽略文件配置

扫描器会尊重项目中的.gitignore文件。如需排除额外文件和文件夹，可在项目根目录创建.hounddogignore文件，采用.gitignore格式指定匹配模式。示例：

shell
# 忽略依赖目录
node_modules/

# 忽略特定文件
config.js

# 忽略目录下所有文件
test/*

快速入门

为演示扫描器功能，HoundDog.ai提供一个包含故意安全缺陷的测试应用。首先克隆仓库：

shell
git clone https://github.com/hounddogai/hounddog-test-healthcare-app

使用Docker镜像扫描并生成Markdown报告：

shell
docker run --pull=always -it --rm -v $(pwd)/hounddog-test-healthcare-app:/data hounddogai/hounddog:latest hounddog scan --output-format=markdown

在浏览器中打开生成的报告文件：hounddog-test-healthcare-app/hounddog-{timestamp}.md。

注意：建议使用Google Chrome浏览器及Markdown Viewer扩展，并启用mermaid和toc设置（详见文档）。

许可证

查看HoundDog.ai软件许可信息。

联系信息

如需帮助或反馈，可创建https://github.com/hounddogai/hounddog/issues%E6%88%96%E5%8F%91%E9%80%81%E9%82%AE%E4%BB%B6%E8%87%B3***%E3%80%82