---

🚀 O que é o Vulfy?

O Vulfy é um scanner de vulnerabilidades ultrarrápido que verifica as dependências do seu projeto em busca de problemas de segurança conhecidos em 9 linguagens de programação. Construído com Rust para máxima performance, ele se integra ao banco de dados OSV.dev para fornecer informações precisas e atualizadas sobre vulnerabilidades.

✨ Principais Características

• 🔥 Extremamente Rápido - Performance assíncrona em Rust com escaneamento concorrente
• 🌍 Suporte a Múltiplos Ecossistemas - npm, Python, Rust, Java, Go, Ruby, C/C++, PHP, .NET
• 📊 Múltiplos Formatos de Saída - Tabela, JSON, CSV, SARIF para diferentes casos de uso
• 🎯 Integração com OSV.dev - Dados reais de vulnerabilidades do banco de Vulnerabilidades de Código Aberto do Google
• ⚡ Zero Configuração - Funciona imediatamente, configure apenas o que precisar
• 🔄 Pronto para CI/CD - Códigos de saída e formatos perfeitos para pipelines automatizados
• 🤖 Automação e Monitoramento - Monitoramento contínuo de repositórios Git com notificações inteligentes
• 📋 Mecanismo de Políticas Avançado - Filtragem personalizada de vulnerabilidades e políticas de segurança
• 🔔 Notificações Multiplataforma - Integrações com Discord, Slack e webhooks

---

📚 Documentação

📖 Documentação Completa - Guias abrangentes, tutoriais e referência da API

Navegação Rápida

• 🚀 Início Rápido em 5 Minutos - Comece a escanear imediatamente
• ⚙️ Guia de Instalação - Todos os métodos de instalação
• 📋 Referência da CLI - Documentação completa dos comandos
• 🤖 Configuração de Automação - Monitoramento contínuo
• 🔧 Esquema de Configuração - Referência completa da configuração

---

📦 Instalação

Opção 1: Binários Pré-construídos (Recomendado)

# Linux/WSL
curl -LO https://github.com/mindPatch/vulfy/releases/latest/download/vulfy-linux-x86_64.tar.gz
tar -xzf vulfy-linux-x86_64.tar.gz
sudo mv vulfy /usr/local/bin/

# macOS (Intel)
curl -LO https://github.com/mindPatch/vulfy/releases/latest/download/vulfy-macos-x86_64.tar.gz
tar -xzf vulfy-macos-x86_64.tar.gz
sudo mv vulfy /usr/local/bin/

# macOS (Apple Silicon)
curl -LO https://github.com/mindPatch/vulfy/releases/latest/download/vulfy-macos-aarch64.tar.gz
tar -xzf vulfy-macos-aarch64.tar.gz
sudo mv vulfy /usr/local/bin/

Opção 2: Usando Cargo

cargo install vulfy

Opção 3: A partir do Código Fonte

git clone https://github.com/mindPatch/vulfy.git
cd vulfy
cargo build --release
sudo cp target/release/vulfy /usr/local/bin/

Verificar Instalação:

vulfy --version
# Deve exibir: vulfy 0.1.0

---

🏃‍♂️ Início Rápido

Escaneamento Básico de Vulnerabilidades

# Escanear o diretório atual
vulfy scan packages

# Escanear um diretório específico
vulfy scan packages --path /caminho/para/projeto

# Mostrar apenas vulnerabilidades de alta gravidade
vulfy scan packages --high-only

Gerar Relatórios

# JSON para automação/CI
vulfy scan packages --format json --output security-report.json

# CSV para análise em planilhas
vulfy scan packages --format csv --output vulnerabilities.csv

# SARIF para a aba de Segurança do GitHub
vulfy scan packages --format sarif --output vulfy.sarif

Integração CI/CD

# Falhar o build se vulnerabilidades de alta gravidade forem encontradas
vulfy scan packages --high-only --quiet || exit 1

# Escanear apenas ecossistemas específicos
vulfy scan packages --ecosystems npm,pypi --no-dev-deps

---

🎯 Ecossistemas Suportados

Ecossistema	Arquivos de Pacote	Status
📦 npm	package-lock.json, yarn.lock, pnpm-lock.yaml, package.json	✅
🐍 Python	requirements.txt, Pipfile.lock, poetry.lock, pyproject.toml	✅
🦀 Rust	Cargo.lock, Cargo.toml	✅
☕ Java	pom.xml, build.gradle, build.gradle.kts	✅
🐹 Go	go.mod, go.sum, go.work	✅
💎 Ruby	Gemfile.lock, Gemfile, *.gemspec	✅
⚙️ C/C++	vcpkg.json, CMakeLists.txt, conanfile.txt	🆕 NOVO!
🐘 PHP	composer.json, composer.lock	🆕 NOVO!
🔷 .NET	*.csproj, packages.config, *.nuspec	🆕 NOVO!

---

📋 Exemplo de Saída

Formato de Tabela Bonito (Padrão)

🔍 Escaneando arquivos de pacote...
📦 Encontrados 6 arquivos de pacote em 4 ecossistemas

🛡️  RELATÓRIO DE VULNERABILIDADES
┌─────────────────────────────────────────┬──────────────┬──────────┬─────────────────┬──────┐
│ Título                                  │ ID CVE       │ Severidade │ Pacote         │ Ano  │
├─────────────────────────────────────────┼──────────────┼──────────┼─────────────────┼──────┤
│ Execução Remota de Código no lodash    │ CVE-2021-123 │ 🔥 Alta  │ [email protected]   │ 2021 │
│ Path Traversal no express              │ CVE-2022-456 │ 🟡 Média │ [email protected]  │ 2022 │
│ Injeção de SQL no sequelize            │ CVE-2020-789 │ 🔥 Alta  │ [email protected] │ 2020 │
└─────────────────────────────────────────┴──────────────┴──────────┴─────────────────┴──────┘

📊 RESUMO DO ESCANEAMENTO
• Total de pacotes escaneados: 42
• Pacotes vulneráveis: 8
• Total de vulnerabilidades: 12
• 🔥 Alta gravidade: 4
• 🟡 Média gravidade: 6
• 🟢 Baixa gravidade: 2

📖 Ver Todos os Formatos de Saída - Exemplos em JSON, CSV, SARIF

---

🤖 Automação e Monitoramento

O Vulfy inclui um sistema de automação poderoso para monitoramento contínuo de segurança de repositórios Git.

Principais Recursos de Automação

• 📂 Monitoramento de Múltiplos Repositórios - Acompanhe vários repositórios Git com escaneamento por branch
• ⏰ Agendamento Flexível - Horário, diário, semanal ou expressões cron personalizadas
• 🔔 Notificações Inteligentes - Alertas ricos no Discord/Slack com filtragem por gravidade
• 📋 Mecanismo de Políticas Avançado - Filtragem personalizada de vulnerabilidades com correspondência de palavras-chave
• 🔐 Suporte a Autenticação - Tokens do GitHub, chaves SSH, acesso a repositórios privados
• 🏗️ Filtragem por Ecossistema - Segmentação de ecossistemas por repositório para escaneamentos focados

Configuração Rápida de Automação

# Inicializar automação com configuração de exemplo
vulfy automation init --with-examples

# Validar configuração
vulfy automation validate

# Executar escaneamento manual usando a configuração de automação
vulfy automation run

# Iniciar monitoramento contínuo
vulfy automation start --foreground

Exemplo de Configuração