semgrep-rules

Bem-vindo! Este repositório contém as regras da Edição Comunitária do Semgrep.

Além das regras neste repositório, o Semgrep Registry oferece regras Pro proprietárias que oferecem cobertura adicional de linguagens e desbloqueiam análise de fluxo de dados profunda e entre arquivos.

• Encontre regras: pesquise regras da Edição Comunitária e Pro por meio da pesquisa no Semgrep registry.
• Use regras: analise seu código com estas regras por meio do Semgrep AppSec Platform
• Contribua com regras: veja Contribuindo para as regras do Semgrep para mais informações.

Como usar o repositório de regras do Semgrep

Para começar a escrever e usar regras do Semgrep, consulte Aprenda a sintaxe do Semgrep e Escrevendo regras. Em seguida, execute regras do Semgrep existentes e personalizadas localmente com a interface de linha de comando do Semgrep (Semgrep CLI) ou continuamente com Semgrep na CI usando o Semgrep AppSec Platform.

Escrevendo regras do Semgrep

Consulte Escrevendo regras para obter informações, incluindo:

• Sintaxe de padrões, descrevendo em detalhes o que os padrões do Semgrep podem fazer, e exemplos de casos de uso do operador de reticências e metavariáveis.
• Sintaxe de regras, descrevendo os arquivos de regras YAML do Semgrep, que podem ter vários padrões, mensagens de saída detalhadas e correções automáticas. A sintaxe permite a composição de padrões individuais com operadores booleanos.

Você também pode aprender a escrever regras usando o tutorial interativo de regras do Semgrep baseado em exemplos.

Contribuindo

Aceitamos contribuições de regras do Semgrep diretamente neste repositório! Ao enviar sua contribuição, você concede à Semgrep, Inc. uma licença para usar, modificar e distribuir sua contribuição sob a Semgrep Rules License v. 1.0. Isso garante que sua regra possa ser compartilhada com outros usuários do Semgrep Registry.

Para contribuir, revise nossas diretrizes Contribuindo para as regras do Semgrep.

Você também pode entrar em contato conosco pelo e-mail [email protected], e ajudaremos a importar suas regras para que outras pessoas possam usá-las!

Informações adicionais

Ajuda

Entre no Slack para obter as respostas mais rápidas para suas dúvidas! Ou contate a equipe pelo e-mail [email protected].

Ação do GitHub para executar testes

Se você criar um fork deste repositório ou criar o seu próprio, você pode adicionar uma GitHub Action ao seu fluxo de trabalho que testará automaticamente suas regras usando a versão mais recente do Semgrep. Veja nosso exemplo de semgrep-rules-test.

Conjuntos de regras

Conjuntos de regras são grupos de regras organizados por finalidade, linguagem ou framework, provenientes do Semgrep Registry. Se você quiser modificar conjuntos de regras existentes ou criar os seus próprios, entre em contato conosco pelo e-mail [email protected].