Snyk Code CLI agora em beta pública
Frank Fischer
21 de setembro de 2021
0 minutos de leituraA missão da Snyk é fazer com que as ferramentas de Teste de Segurança de Aplicações Estáticas (SAST) funcionem para desenvolvedores em todo o pipeline de DevOps. O Snyk Code analisa o código em tempo real e com alta precisão — diretamente nas ferramentas e nos fluxos de trabalho que os desenvolvedores já usam. Por exemplo, os plugins de IDE para IntelliJ, PyCharm, WebStorm e Visual Studio Code facilitam a programação, a análise e a correção antes mesmo de o código chegar ao controle de versão. E, com a interface web, os desenvolvedores podem analisar código legado ou fazer uma revisão de código.
Além de tudo isso, é com satisfação que anunciamos que o Snyk Code agora faz parte da interface de linha de comando da Snyk (Snyk CLI) em beta pública. Agora você pode integrar facilmente o Snyk Code ao processo de CI/CD, com a flexibilidade de iniciar uma análise e trabalhar com os resultados de forma automatizada.
A Snyk oferece uma CLI para interagir com qualquer componente da plataforma Snyk. O Snyk Code amplia a funcionalidade da CLI existente. Este artigo é um guia para começar. Para uma explicação mais aprofundada, recomendamos que você consulte a documentação do Snyk Code CLI.
Como lembrete, o suporte à CLI está em beta por enquanto. Experimente e envie seu feedback para nos ajudar a melhorar ainda mais.
Instalação e configuração do Snyk CLI
O Snyk CLI é um aplicativo Node.js e, por isso, pode ser executado em qualquer sistema compatível com Node.js. Além disso, é fácil de instalar e configurar.
Você pode instalá-lo com o npm executando: npm install -g snyk
Para conhecer outras formas de instalação e saber mais sobre a instalação pelo npm, consulte a documentação completa do Snyk Code CLI.
Depois da instalação, o próximo passo é autenticar. Para isso, execute: snyk auth.
Isso iniciará o processo de autenticação e armazenará um token de identificação para você usar com a CLI daqui em diante.
Dica profissional: A CLI verifica se há atualizações sempre que é executada. Se houver uma atualização, ela notificará você e mostrará o comando necessário. Para garantir que você está usando a versão mais recente, também é possível atualizar manualmente com npm update -g snyk.
Como testar um projeto ou uma pasta
Para iniciar uma análise do Snyk Code pela CLI, use: snyk code test [my-folder-path]
Se você não informar o parâmetro de caminho, a CLI analisará a pasta atual. E sim, ela percorrerá a árvore de diretórios e analisará o conteúdo. Há muitos outros comandos e parâmetros disponíveis, que você encontra na nossa documentação.
Se você já usa a CLI, observe que esta versão beta não oferece suporte ao comando monitor para o Snyk Code.
Observação: A CLI agrupa e envia à Snyk os arquivos de código-fonte compatíveis para análise. Portanto, embora os dados em trânsito e em repouso sejam criptografados, o código-fonte sairá do seu ambiente. Antes de executar a CLI em um repositório, verifique se você está de acordo com isso.
Opções de formato dos resultados
A CLI pode apresentar os resultados de três maneiras. A primeira, e uma boa forma de começar a usar a CLI, é simplesmente executá-la. Ela retornará um relatório em um formato legível.
O nível de gravidade é indicado por cores, e o resultado traz uma explicação da vulnerabilidade e a correção recomendada.
Dica profissional: Como o Snyk Code é extremamente rápido, escolha qualquer projeto (ou repositório de código aberto clonado) e execute uma análise para verificar se está tudo funcionando.
Em seguida, a CLI oferece o formato de dados SARIF, que pode ser gerado com snyk code test --sarif:
Essa saída é detalhada e contém tudo — e até um pouco mais — do que você vê na interface do Snyk Code. Ela inclui até exemplos de correções e a pontuação de prioridade.
Dica profissional: Pegue uma xícara de café e explore o arquivo SARIF. Como ele está em JSON, não é tão difícil de entender. O arquivo contém muitas informações e prometo que você terá várias ideias de como usá-las nos seus processos ou para coletar estatísticas.
Por fim, a CLI fornece um código de saída que pode ser usado para controlar, por exemplo, um processo de CI/CD. Veja quais códigos de saída esperar:
3: falha, nenhum projeto compatível encontrado
2: falha, tente executar o comando novamente
1: ação necessária, vulnerabilidades encontradas
0: sucesso, nenhuma vulnerabilidade encontrada
Ao usar o parâmetro --severity-threshold=<low|medium|high> na chamada, você pode filtrar os resultados por nível de gravidade.
Experimente o Snyk Code CLI em beta
A CLI é uma ferramenta poderosa, e queremos convidar todas as pessoas a participar da beta pública. Basta ter a versão mais recente do Snyk CLI instalada, ativar o Snyk Code na sua organização e experimentar. Como esta é uma versão beta, adoraríamos que você nos ajudasse usando a ferramenta e enviando seu feedback.
E, se você ainda não conhece a Snyk, o primeiro passo é criar uma conta com o Snyk Code ativado! Cadastre-se gratuitamente hoje mesmo.
Comece a jogar Capture the Flag
Aprenda a resolver desafios de Capture the Flag assistindo à gravação sob demanda do nosso workshop virtual introdutório.

