Instalação

Nesta seção, você vai encontrar todas as orientações para instalar o Horusec-CLI.

É possível instalar o Horusec-CLI de 4 maneiras:

Instalação Local
Instalação Manual
Instalação via Imagem Docker
Instalação via Pipeline

Veja abaixo cada um deles:

Requisitos

Veja abaixo os requisitos para usar o Horusec-CLI:

Docker (versão recomendada 19.03.11). Se você quiser desabilitar o Docker, veja como usar o Horusec sem o Docker, mas com isso, você pode perder dados nas análises feitas por outras ferramentas.
Git (versão recomendada 2.25.1). Se você quiser rodar análises com o Git, acesse o tutorial de como habilitar análise no histórico git, mas ele não é habilitado por padrão.

Instalação Local

Esta instalação é recomendada se você deseja usar o Horusec para fazer análises ou verificar as vulnerabilidades do seu projeto.

Veja abaixo os comandos necessários para instalar o Horusec localmente de acordo com o sistema operacional:

MAC ou Linux

Rode o comando abaixo no seu terminal:

curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest

Windows

Rode o comando abaixo no seu terminal:

Você precisa executar o comando sempre no local onde foi feito o download que está o executável.

curl -k "https://github.com/ZupIT/horusec/releases/latest/download/horusec_win_amd64.exe" -o "./horusec.exe" && ./horusec.exe version

No Horusec existe dois tipos de binários:

“Normal”: Neste tipo de binário você tem a execução padrão utilizando docker;
“StandAlone”: Neste tipo de binário você tem apenas ferramentas que utilizam Horusec-Engine sem dependencia com o docker.

👉A última versão disponível

👉Todas as versões disponíveis

Instalação Manual

A instalação manual é feita de acordo com o seu sistema operacional e a versão que deseja fazer download. Veja as últimas versões abaixo:

O Horusec tem suporte para:

Sistema Operacional	Arquitetura de processador	Tipo de Binário	Download
Linux	amd64	Binário normal	📥 Download
Linux	arm64	Binário normal	📥 Download
Linux	amd64	Instalador debian normal	📥 Download
Linux	arm64	Instalador debian normal	📥 Download
Linux	amd64	Instalador rpm normal	📥 Download
Linux	arm64	Instalador rpm normal	📥 Download
Linux	amd64	Binário Stand Alone	📥 Download
Linux	arm64	Binário Stand Alone	📥 Download
Mac	amd64	Binário normal	📥 Download
Mac	arm64	Binário normal	📥 Download
Mac	amd64	Binário Stand Alone	📥 Download
Mac	arm64	Binário Stand Alone	📥 Download
Windows	amd64	Binário normal	📥 Download
Windows	arm64	Binário normal	📥 Download
Windows	amd64	Binário Stand Alone	📥 Download
Windows	arm64	Binário Stand Alone	📥 Download

Se você quiser uma versão específica, troque a palavra latest no link pela versão que você precisa.

Após baixar os arquivos para Mac ou Linux será necessário tranformálos em executáveis através do comando chmod +x.

Baixe os arquivos;
Você precisa transformar esses arquivos em executáveis por meio do comando chmod +x:

chmod +x path/horusec_[your version here]

Agora, você pode abrir o arquivo para instalação manual.

👉A última versão disponível

👉Todas as versões disponíveis

Se você recebeu a seguinte mensagem em sua análise:

{HORUSEC_CLI} Nancy tool failed to query the GitHub API for updates.
This is most likely due to GitHub rate-limiting on unauthenticated requests.
To make authenticated requests please:
  1. Generate a token at https://github.com/settings/tokens
  2. Set the token by setting the GITHUB_TOKEN environment variable.
Instructions for generating a token can be found at:
https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line.

Não se preocupe, basta você adicionar a seguinte variável de ambiente GITHUB_TOKEN com seu valor como segue nesta documentação.

Instalação via Imagem Docker

Esta forma de instalação permite que você realize suas análises por meio de uma imagem docker, você pode rodar localmente ou utilizando sua pipeline.

Veja alguns casos de uso:

1. Iniciando imagem com comando run:

Quando você inicializa a imagem com o comando run, basta executar o Horusec com o comando que você deseja:

docker run -v /var/run/docker.sock:/var/run/docker.sock \
        -v $(pwd):/src/horusec \
        horuszup/horusec-cli:latest horusec start -p /src/horusec -P $(pwd) --config-file-path=/src/horusec/horusec-config.json

2. Instalação via Pipeline

Essa instalação garante que a entrega do seu projeto em produção seja segura, já que o Horusec é adicionado à sua pipeline.

Veja a seguir as formas de instalação considerando os diferentes tipos de pipeline:

Github Actions

name: SecurityPipeline

on: [push]

jobs:
  horusec-security:
    name: horusec-security
    runs-on: ubuntu-latest
    steps:
    - name: Check out code
      uses: actions/checkout@v2
      with: # Necessário quando habilitado o autores de commit
        fetch-depth: 0
    - name: Running Horusec Security
      run: |
        curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest
        horusec start -p="./" -e="true"

AWS Code Build

Origem
- Profundidade do clone de Git: Full
Ambiente:
- Imagem de ambiente: Imagem gerenciada
- Sistema operational: Ubuntu
- Tempo(s) de execução: Standard
- Imagem: aws/codebuild/standard:5.0
- Versão de imagem: Usar sempre a imagem mais recente para esta versão do tempo de execução
- Tipo de ambiente: Linux
- Habilite esse indicador se você quiser criar imagens do Docker ou quiser que suas compilações obtenham privilégios elevados: true
Buildspec:
- Alterne para o editor e inserira comandos de compilação:

version: 0.2

phases:
  build:
    commands:
      - docker run -v /var/run/docker.sock:/var/run/docker.sock -v $(pwd):/src/horusec horuszup/horusec-cli:latest horusec start -p /src/horusec -P $(pwd) --config-file-path=/src/horusec/horusec-config.json

Circle CI

version: 2.1

executors:
  horusec-executor:
    machine:
      image: ubuntu-1604:202004-01

jobs:
  horusec:
    executor: horusec-executor
    steps:
      - checkout
      - run:
          name: Horusec Security Test
          command: |
            curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest
            horusec start -p="./" -e="true"            
workflows:
  pipeline:
    jobs:
      - horusec

Jenkins

Em máquinas que utilizam Jenkins deve-se ter o docker e git instalado para que o Horusec tenha toda potencia em suas análises. Verifique mais informações na sessão de requisitos da CLI.

stages {
    stage('Security') {
        steps {
            sh 'curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest'
            sh 'horusec start -p="./" -e="true"'
        }
    }
}

Azure DevOps Pipeline

pool:
  vmImage: 'ubuntu-18.04'

steps:
- script: |
    curl -fsSL https://raw.githubusercontent.com/ZupIT/horusec/main/deployments/scripts/install.sh | bash -s latest
    horusec start -p ./

GitLab CI/CD

image: docker:latest

variables:
  GIT_DEPTH: 0 # Necessário quando habilitado o autores de commit

services:
  - docker:dind

build-code-job:
  stage: build
  script:
    - docker run -v /var/run/docker.sock:/var/run/docker.sock -v $(pwd):/src/horusec horuszup/horusec-cli:latest horusec start -p /src/horusec -P $(pwd)

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Última modificação 23.02.2022: installation:chore - Update version of Horusec-CLI to v2.7.0 (1ec2d320)