Esta é a documentação não oficial do n8n em português brasileiro, criada pela comunidade brasileira. Este repositório contém apenas documentação e não inclui código executável do n8n.

Este projeto de documentação é mantido de forma contínua. Reportamos vulnerabilidades relacionadas à:

Objetivo: Detectar secrets, tokens e credenciais expostas no código e documentação.

Configuração: .gitleaks.toml

• Regras customizadas para CPF/CNPJ brasileiros
• Detecção de senhas e tokens em português
• Whitelist para placeholders seguros
• Configuração específica para documentação

Uso:

# Escanear todo o repositório
npm run security:scan

# Escanear apenas arquivos modificados
gitleaks protect --config .gitleaks.toml --verbose

# Escanear commit específico
gitleaks detect --config .gitleaks.toml --source . --log-opts="--since=2024-01-01"

Objetivo: Verificações automáticas antes de cada commit.

Configuração: .pre-commit-config.yaml

• Gitleaks para detecção de secrets
• Script personalizado para conteúdo sensível
• MarkdownLint para qualidade da documentação
• ESLint e TypeScript checking

Instalação:

# Instalar pre-commit
pip install pre-commit

# Instalar hooks no repositório
pre-commit install

# Executar em todos os arquivos
pre-commit run --all-files

Objetivo: Detectar e corrigir informações sensíveis específicas do projeto.

Localização: scripts/fix-sensitive-content.js

Funcionalidades:

• Detecta senhas fracas comuns
• Identifica tokens e API keys expostos
• Substitui por placeholders seguros
• Modo de verificação (--check)

Uso:

# Corrigir automaticamente
npm run fix-sensitive-content

# Apenas verificar (não corrigir)
npm run security:check

# Verificação completa
npm run security:full

Objetivo: Verificações automáticas em pull requests e pushes.

Localização: .github/workflows/code-quality.yml

Verificações incluídas:

• Trivy para vulnerabilidades de dependências
• Gitleaks para detecção de secrets
• Script personalizado de conteúdo sensível
• Auditoria de dependências (npm audit)

Se você encontrar vulnerabilidades de segurança neste projeto de documentação, por favor:

1. Abra uma issue no repositório: GitHub Issues
2. Use o prefixo [SECURITY] no título
3. Descreva o problema detalhadamente
4. Inclua passos para reproduzir se aplicável

Para este projeto de documentação, consideramos relevantes:

• Informações Sensíveis Expostas: Senhas, tokens ou credenciais reais na documentação
• Vulnerabilidades de Dependências: Problemas de segurança nas dependências do Docusaurus
• Cross-Site Scripting (XSS): Potencial execução de scripts maliciosos
• Configurações Inseguras: Exemplos de configuração que possam comprometer segurança

1. Confirmação: Resposta inicial em até 48 horas
2. Análise: Investigação completa em até 7 dias
3. Correção: Implementação de fix em até 14 dias
4. Publicação: Release da correção em até 21 dias

1. Senhas Comuns:

   • senha123, admin123, password
   • Senhas específicas do contexto brasileiro

2. Tokens e API Keys:

   • Tokens JWT reais
   • API keys do Google, AWS, etc.
   • Client secrets OAuth

3. Dados Pessoais:

   • CPF e CNPJ brasileiros
   • Informações de identificação pessoal

4. Configurações Inseguras:

   • URLs de produção em exemplos
   • Credenciais hardcoded

1. Detecção Automática: As ferramentas identificam potenciais problemas
2. Bloqueio: Pre-commit hooks impedem commits inseguros
3. Correção: Script automatizado substitui por placeholders
4. Verificação: CI/CD valida que correções foram aplicadas

# Verificar apenas conteúdo sensível
npm run security:check

# Scan completo com Gitleaks
npm run security:scan

# Verificação completa
npm run security:full

# Corrigir informações sensíveis
npm run fix-sensitive-content

# Aplicar correções do linter
npm run lint:fix

# Executar Gitleaks com mais detalhes
gitleaks detect --config .gitleaks.toml --verbose --log-level debug

# Verificar configuração do pre-commit
pre-commit run --all-files --verbose

# Testar hook específico
pre-commit run gitleaks --all-files

Edite scripts/fix-sensitive-content.js:

const replacements = {
  'novo-padrao-sensivel': 'PLACEHOLDER_SEGURO',
  // ... outros padrões
};

Edite .gitleaks.toml:

[[rules]]
id = "custom-rule"
description = "Minha regra personalizada"
regex = '''pattern-regex'''
tags = ["custom", "sensitive"]

Edite .pre-commit-config.yaml:

- repo: local
  hooks:
    - id: minha-verificacao
      name: Minha Verificação Personalizada
      entry: meu-script.sh
      language: script

# 1. Instalar dependências
npm install

# 2. Instalar pre-commit (Python)
pip install pre-commit

# 3. Instalar Gitleaks
# Linux/macOS:
brew install gitleaks
# Windows: baixar do GitHub releases

# 4. Configurar hooks
pre-commit install

# 5. Executar verificação inicial
npm run security:full

• Número de secrets detectados por scan
• Tipos mais comuns de violações
• Arquivos mais problemáticos
• Tempo de execução das verificações

• Gitleaks: gitleaks-report.json
• CI/CD: Artifacts do GitHub Actions
• Pre-commit: Logs locais

1. Sempre execute npm run security:check antes de commit
2. Use placeholders seguros em exemplos
3. Não desabilite verificações de segurança
4. Reporte falsos positivos

1. Verifique se CI passou em todas as verificações
2. Confirme que placeholders são adequados
3. Teste exemplos de configuração
4. Valide que secrets não foram expostos

• ✅ Placeholders Seguros: Uso de SUA_SENHA_AQUI em vez de senhas reais
• ✅ Verificação Automática: Pipeline CI/CD com verificação de conteúdo sensível
• ✅ Auditoria de Dependências: npm audit automatizado
• ✅ Escaneamento de Vulnerabilidades: Trivy integrado ao CI/CD

• Nunca inclua credenciais reais nos exemplos
• Use placeholders descritivos e seguros
• Revise exemplos antes de submeter PR
• Execute npm run fix-sensitive-content antes do commit

Para questões de segurança urgentes ou sensíveis:

• GitHub Issues: Reportar Issue
• Discussões: GitHub Discussions

⚠️ Importante: Estas ferramentas são configuradas para documentação. Para código de produção, considere ferramentas adicionais como SonarQube, Snyk, ou OWASP Dependency-Check.

Nota: Para vulnerabilidades do n8n (software principal), reporte diretamente ao repositório oficial do n8n.