Skip to main content

Vibe Coding Security Protocol - Security & Quality Guardrails for AI Coding

Project description

🛡️ Vibe Coding Security Protocol (VCSP)

CI Status Latest Release Python Version License Security

Biblioteca segura para desenvolvimento ágil com IA (Vibe Coding). Já vem configurado com Scanner de Segredos, Pentest Lógico, Auditoria de Dependências, Quality Gate, Análise de IaC e Histórico de Logs.


🎯 Para que serve?

No mundo de hoje, com a crescente adoção das Inteligências Artificiais, muitos projetos ganharam um boost na produção e no lançamento de features. Porém, nem todo mundo está preocupado com a manutenção e segurança do próprio código, podendo ficar vulnerável caso não haja um revisor experiente para encontrar brechas que podem ser exploradas por atacantes.

Foi pensando nisso que criei essa ferramenta: ela vai varrer seu código, seja ele criado por IA ou não, em busca dessas potenciais falhas, atuando como uma camada de segurança automatizada.


🚀 Instalação e Uso

1. Instalação

Instale a biblioteca oficial via pip em seu ambiente virtual:

pip install vcsp-guard

Para incluir a geração de gráficos (estatísticas):

pip install "vcsp-guard[stats]"

2. Inicialização (Ativar Proteção)

Na raiz do seu projeto, execute o comando de inicialização. Isso configurará os hooks do Git e copiará os arquivos de configuração de IA necessários.

vcsp-init

O que o vcsp-init faz?

  1. Instala o Pre-Commit Hook: Cria um arquivo oculto em .git/hooks/ que intercepta todo comando git commit.
  2. Configura o Ambiente: Verifica se você tem as ferramentas de auditoria (Bandit, Ruff, Pip-Audit, Semgrep) e as instala se necessário.
  3. Menu de Seleção de IA: Pergunta qual IA você utiliza (Cursor, Cline, etc.) e aplica as regras de segurança correspondentes.

3. Configurar Ambiente

Crie um arquivo .env para suas variáveis de ambiente:

cp .env.example .env
# Edite o .env com suas chaves (ele já é ignorado pelo Git)

🤖 Automação de IA (Magic Files)

As configurações de IA e CI/CD estão organizadas na pasta .vibe/ para manter a raiz limpa. Se você rodou o vcsp-init (Passo 2), a configuração da sua IA já foi aplicada automaticamente!

Caso queira trocar de IA ou configurar manualmente, basta rodar novamente o vcsp-init, e selecionar a opção correspondente a IA que está usando. Caso queira excluir o arquivo de configuração da raiz, rode o vcsp-init e selecione a opção 99 para limpar os arquivos da raiz.

⚠️ Nota: Lembre-se de adicionar o arquivo de configuração da sua IA (ex: .cursorrules, .clinerules) ao seu .gitignore caso não queira que ele suba para o GitHub junto com o projeto.

Ferramenta Arquivo (em .vibe/) Função
Cursor .cursorrules Regras de segurança e estilo.
Cline .clinerules Agente autônomo com foco em qualidade.
Qodo Gen .codiumai.toml Testes focados em falhas e edge cases.
Copilot .github/... Instruções globais.
Gemini GEMINI.md Prompt otimizado para Google AI Studio / Vertex AI.
GitHub .github/workflows CI/CD Pipeline.

🧠 ChatGPT, Perplexity & Claude

Para IAs de chat que não aceitam arquivos de configuração (como ChatGPT ou Perplexity), copie o conteúdo de .vibe/AUDITORIA_IA.md (System Prompt) e cole no início da conversa.

Isso garante que a IA siga as mesmas regras de segurança e estilo do restante do projeto.


⚡ O Fluxo de Trabalho (Vibe Coding)

Como este kit protege você enquanto a IA codifica?

  1. Você pede: "Crie uma conexão com o banco AWS." (no Cursor/Copilot/ChatGPT).
  2. A IA gera: Um código funcional, mas coloca a AWS_ACCESS_KEY direto no arquivo python.
  3. Você commita: git commit -m "add db connection"
  4. O Guardião Atua: O hook (instalado no passo 2) intercepta o commit antes dele ser salvo.
  5. Bloqueio: O terminal exibe: ❌ [BLOQUEADO] AWS Access Key encontrada.
  6. Correção: Você move a chave para o .env (como deve ser) e tenta de novo.

Resultado: Você codifica na velocidade da IA, mas com a segurança de um sênior revisando cada linha em tempo real.


🕵️ Varredura e Histórico (Scanner)

Para que serve o vcsp-scan? Enquanto o vcsp-init protege o futuro (novos commits), o vcsp-scan protege o passado. Ele serve para varrer todo o código que já existe no projeto em busca de vulnerabilidades antigas que passaram despercebidas.

O script vcsp-scan executa 6 camadas de verificação e salva tudo na pasta logs_scan_vcsp/:

  1. Busca de Segredos: Identifica chaves de API, tokens e senhas hardcoded (Regex).
  2. Segurança Lógica (SAST): Analisa vulnerabilidades no código Python usando Ruff (regras de segurança S).
  3. Auditoria de Dependências (SCA): Verifica vulnerabilidades conhecidas (CVEs) nas bibliotecas instaladas usando Pip-Audit.
  4. Qualidade de Código: Linting e padronização PEP 8 via Ruff.
  5. Infraestrutura como Código (IaC): Escaneia arquivos Docker, Kubernetes e Terraform usando Semgrep.
  6. Dependências Não Utilizadas: Verifica se as libs do requirements.txt são realmente importadas no projeto.

⚠️ Usuários Windows: Para a análise de infraestrutura (Docker/Terraform), é necessário ter o Docker Desktop instalado e rodando. O VCSP detecta automaticamente e usa um container para realizar a varredura, já que o Semgrep não roda nativamente no Windows.

Para rodar a auditoria:

vcsp-scan

📊 Gráficos e Estatísticas

Para visualizar a evolução da segurança do seu projeto (Bug Trend), você pode gerar o gráfico localmente baseado nos logs de varredura.

vcsp-stats

Isso irá:

  1. Ler o histórico da pasta logs/.
  2. Gerar um gráfico em .vibe/assets/bug_trend.png.

Confira seu progresso: Abra a pasta logs/ para ver o histórico de correções e garantir que você não está repetindo erros antigos.

📅 Relatório Semanal Automático

O VCSP já vem configurado para rodar uma auditoria completa toda segunda-feira às 08:00 UTC via GitHub Actions.

  • Objetivo: Gerar um relatório de tudo que foi produzido na semana anterior.
  • Benefício: Permite que você revise e corrija dívidas técnicas ou de segurança antes de iniciar o novo ciclo de desenvolvimento.

Bug Trend


Saiba mais sobre o Dependabot e como este projeto o utiliza: DEPENDABOT_NOTE.md

🚨 PROTOCOLO DE PÂNICO (Vazamento de Credenciais)

Se você acidentalmente comitou uma chave de API ou senha:

  1. REVOGUE a chave imediatamente no painel do fornecedor (AWS, OpenAI, etc).
  2. NÃO tente apenas apagar o arquivo e comitar de novo (o histórico do Git mantém o segredo).
  3. Rotacione todas as credenciais que possam ter sido expostas.

🔓 Bypass (Ignorar Verificações)

Se o hook bloquear um arquivo legítimo (falso-positivo) ou você precisar forçar um commit urgente:

git commit -m "mensagem" --no-verify

Aviso: Isso desativa todas as verificações de segurança para aquele commit.


🤝 Contribuições e Novas IAs

Caso queira sugerir arquivos de configuração para outras IAs, mande um email para giordano.alves9@gmail.com, ou submeta uma PR solicitando a criação de mais modelos de IA para esse projeto.


👨‍💻 Sobre o Mantenedor

Este projeto foi criado e é mantido por Giordano Alves, Desenvolvedor Backend Python especialista em Infraestrutura, Linux e Segurança.

O objetivo deste template é permitir que desenvolvedores usem o poder da IA ("Vibe Coding") sem sacrificar a solidez e a segurança da engenharia de software tradicional.

"Codifique na velocidade da luz, mas com a segurança de um cofre."

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vcsp_guard-1.0.3.4.tar.gz (24.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vcsp_guard-1.0.3.4-py3-none-any.whl (25.0 kB view details)

Uploaded Python 3

File details

Details for the file vcsp_guard-1.0.3.4.tar.gz.

File metadata

  • Download URL: vcsp_guard-1.0.3.4.tar.gz
  • Upload date:
  • Size: 24.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for vcsp_guard-1.0.3.4.tar.gz
Algorithm Hash digest
SHA256 f14de70682a8724f788a2d0cd2c3914dc08f7580f5f57ecebcbef19aea501d72
MD5 872353460d8809f4e20308c607586f8e
BLAKE2b-256 1392fa0429f3612fe03514aab26fe1e7d9bc0ac755f367f1e99edaf1e540218b

See more details on using hashes here.

Provenance

The following attestation bundles were made for vcsp_guard-1.0.3.4.tar.gz:

Publisher: publish_release.yml on Giordano10/VCSP

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vcsp_guard-1.0.3.4-py3-none-any.whl.

File metadata

  • Download URL: vcsp_guard-1.0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 25.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for vcsp_guard-1.0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d45a5cc94236c066b140c9af0a1a88bb2a45debf1a95df277bcf5bb3ea87f5d9
MD5 cfc3f417566ea6eddfc0000671d776ba
BLAKE2b-256 59389e43d16d8185d48e634ab1c0f5191103f4198df1bcd08c0f029dc35f8514

See more details on using hashes here.

Provenance

The following attestation bundles were made for vcsp_guard-1.0.3.4-py3-none-any.whl:

Publisher: publish_release.yml on Giordano10/VCSP

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page