Visão Geral

Nesta seção, você vai encontrar alguns conceitos básicos sobre o Horusec-CLI.

O que é?

A CLI (sigla para interface de linha de comando) é o programa que processa os comandos de um software ou qualquer programa computacional por meio de texto.

Horusec-CLI é a parte de código que permite você rodar os comandos de análise de segurança e de identificação e/ou classificação de vulnerabilidades.

Como a análise funciona?

O Horusec realiza uma análise SAST do seu projeto e observa apenas o código, não é necessário nenhuma execução ou build e isso aumenta a velocidade da sua análise.

As ferramentas de mercado tem sua própria saída de dados, desse modo o Horusec faz a leitura e padroniza no formato ideal. Com isso ele consegue um dado centralizado independente das ferramentas que você está utilizando na análise.

O que o Horusec-CLI faz?

O Horusec-CLI envia o relatório da análise para o Horusec-Platform, e a partir desse momento você tem uma visão analítica das vulnerabilidades encontradas e elas podem ser agrupadas por:

  • Repositório;
  • Autor do commit;
  • Linguagem;
  • Uma linha do tempo de vulnerabilidades.

Depois disso, você pode fazer a gestão de vulnerabilidade trocando os tipos por falso positivo, risco aceito ou outros. É possível alterar também a severidade a partir da última análise por repositório, por exemplo, para crítica, média, etc;.

Como fazer uma análise?

Siga os passos abaixo:

Passo 1. Instale o Horusec no seu computador;

Passo 2. Verifique os requisitos e rode o comando abaixo no local onde está seu projeto:

horusec start

Passo 3. O Horusec-CLI retorna uma mensagem de confirmação para saber se o diretório atual está correto:

✔ The folder selected is: [/home/your-user/Projects/project-name]. Proceed? [Y/n]: Y

Selecione o Y para continuar e aperte o ENTER. Agora a ferramenta inicia a análise e a partir disso mostra as vulnerabilidades do seu projeto.

Como trocar de diretório?

Se você quiser trocar o diretório atual, adicione o diretório que você deseja logo após o símbolo ./

Exemplo

  1. Nesse exemplo, a substituição é para um diretório chamado -latest-project. Para trocar, rode o comando:
horusec start -p ./latest-project
  1. Você também pode colocar o diretório completo onde está o seu projeto. Nesse caso, o comando é:
horusec start -p /home/user-name/folder-name/file-name

Leia mais


Última modificação 21.10.2021: added docker information (#124) (ace337fc)