checkov vscode

Aviso de arquivo

Este repositório não é mais mantido nem a extensão do código VS que encapsula.

A extensão de código vs vs foi renomeada como o plug -in PRISMA Cloud vs Code e agora pode ser encontrada aqui

Extensão de checkov para código do Visual Studio

O Checkov é uma ferramenta de análise de código estático para análise de infraestrutura como código, segredos e composição de software.

A extensão do checkov para o código do Visual Studio permite que os desenvolvedores obtenham resultados de varredura em tempo real, bem como sugestões de correção embutida à medida que desenvolvem infraestrutura em nuvem.

Atualmente, a extensão está disponível para download diretamente no Marketplace de Extensão do Visual Studio e seu código -fonte está disponível em um repositório licenciado Apache 2.0. O desenvolvimento da extensão está em andamento e está disponível para uso pré-lançamento? .

A ativação da extensão requer uma chave de acesso à nuvem PRISMA e API. Ele usa as APIs do Prisma Cloud para avaliar o código e oferecer correções embutidas automatizadas. Para obter mais informações sobre dados compartilhados com o Prisma Cloud, consulte a seção de isenção de responsabilidade abaixo).

Os recursos de extensão incluem:

• Mais de 1000 políticas incorporadas, cobrindo as melhores práticas de segurança e conformidade para a AWS, Azure e Google Cloud.
• Terraform, Plano Terraform, CloudFormation, Kubernetes, leme, sem servidor e varredura de modelo de braço.
• Detecta credenciais da AWS nos dados do usuário do EC2, variáveis ​​de ambiente Lambda e fornecedores de terraforma.
• Na Terraform, os cheques suportam a avaliação de argumentos expressos em variáveis ​​e módulos remotos para seus valores reais.
• Suporta a supressão embutida por meio de comentários.
• Links para descrições de políticas, justificativas, bem como instruções passo a passo para corrigir equívocas conhecidas.
• Corrija sugestões para atributos de Terraform e CloudFormation comumente configurados.

Começando

Instalar

Abra a extensão checkov para código do Visual Studio no mercado do Visual Studio.

Dependências

• Python> = 3,7 ou daemon do Pipenv ou Docker

A extensão de checkov invocará a versão mais recente do Checkov .

Configuração

• Na nuvem PRISMA, vá para Configurações> Controle de Acesso> Adicionar> Chave de Acesso e copie as teclas.

• No código do Visual Studio, insira suas teclas e endpoint da API na página Configurações de extensão do checkov.

• Usando um certificado CA personalizado é possível. Se necessário, defina o caminho para o arquivo de certificado na página Configurações de extensão do checkov.

• Se você encontrar a mensagem de erro barulhenta, poderá desativá -lo completamente selecionando Disable error message na página Configurações de extensão do checkov.

Uso

• Abra um arquivo que você deseja digitalizar com o checkov no vscode.
• Abra a paleta de comando (⇧⌘P) e execute a Checkov Scan comando.
• Os resultados da varredura agora devem aparecer em seu editor.
• Clique em uma varredura para ver seus detalhes. Os detalhes incluirão a política violadora e um link para diretrizes passo a passo.
• Na maioria dos casos, os detalhes incluirão uma opção de correção. Isso adicionará, removerá ou substituirá uma configuração indesejada, com base nos dicionários de correção de checkov.
• Você pode pular os cheques adicionando um checkov:skip=<check_id>:<suppression_comment> . Para mais detalhes, consulte os documentos.
• A extensão continuará a digitalizar modificações de arquivos e destacar erros em seu editor em todas as modificações de recursos materiais.

Solucionando logs

Para acessar o diretório de logs checkov-vscode, abra a paleta de comando vscode (Ctrl+Shift+P) ou (Command+Shift+P) e execute o comando Open Checkov Log . É útil se você excluir o arquivo de log e re-tratar de qualquer operação que não estivesse falhando para produzir logs limpos.

Questões comuns

Permissões de acesso ao arquivo do docker no macOS

Se você estiver obtendo falhas e estiver executando a extensão do checkov via Docker, é possível que o MacOS precise dar à permissão do Docker para acessar o local do diretório do seu código. Nas System Preferences > Privacy and Security > Privacy Encontre a seção Files and Folders da lista e verifique se Docker tem acesso ao seu local de código.

Os sintomas deste problema podem ser encontrados nos registros de extensão, você verá [info]: Running Checkov com executablePath: docker e depois a saída mostrando zero passados, falhados ou pulsos de cheques e mais de 1 panificação, como abaixo:

[info]: Running checkov {“executablePath”:“docker”,“arguments”
...
...
[debug]: Checkov task output:
...
 “ passed “ : 0, rn        “ failed “ : 0, rn        “ skipped “ : 0, rn        “ parsing_errors “ : 1, rn        “ checkov_version “ : “ 1.0.770 “rn    }

Contribuindo

A contribuição é bem -vinda!

Comece revisando as diretrizes de contribuição. Depois disso, dê uma olhada em uma boa primeira edição.

Procurando contribuir com novos cheques? Aprenda a escrever um novo cheque (também conhecido como política) aqui.

Isenção de responsabilidade

Para usar este plug -in, você precisará de uma conta do Prisma Cloud. O plug -in usa a API Fixes da Prisma Cloud para analisar e produzir correções de código e enriquecer os resultados fornecidos no IDE. Observe a Política de Privacidade do Prisma Cloud para obter mais detalhes. Para gerar correções, os arquivos encontrados para acionar violações de checkov são disponibilizadas à API Fixes com o único objetivo de gerar recomendações de código de correções embutidas.