scan action

Ação de varredura de segurança salus

Essa ação utiliza salus da Coinbase para executar verificações de SAST e dependência.

Scanners apoiados

Nome	Linguagem
Auditoria de pacote	Rubi
Brakeman	Rubi
Auditoria do NPM	JavaScript
Auditoria de fios	JavaScript
Gosec	Ir
Bandido	Python
Auditoria de carga	Ferrugem
sêmep	Muitos
PatternSearch	N/A (usa SIFT)

Exemplo de uso

.github/workflows/example.yml

Padrões

 on: [push]

jobs:
  salus_scan_job:
    runs-on: ubuntu-latest
    name: Salus Security Scan Example
    steps:
    - uses: actions/checkout@v1
    - name: Salus Scan
      id: salus_scan
      uses: federacy/[email protected]

Scanner único

 on: [push]

jobs:
  salus_scan_job:
    runs-on: ubuntu-latest
    name: Salus Security Scan Example
    steps:
    - uses: actions/checkout@v1
    - name: Salus Scan
      id: salus_scan
      uses: federacy/[email protected]
      with:
          active_scanners: "n  - Brakeman"
          enforced_scanners: "n  - Brakeman"

Sem scanners forçados

 on: [push]

jobs:
  salus_scan_job:
    runs-on: ubuntu-latest
    name: Salus Security Scan Example
    steps:
    - uses: actions/checkout@v1
    - name: Salus Scan
      id: salus_scan
      uses: federacy/[email protected]
      with:
          enforced_scanners: "none"

Configuração personalizada

 on: [push]

jobs:
  salus_scan_job:
    runs-on: ubuntu-latest
    name: Salus Security Scan Example
    steps:
    - uses: actions/checkout@v1
    - name: Salus Scan
      id: salus_scan
      uses: federacy/[email protected]
      env:
        SALUS_CONFIGURATION: "file://../salus-configuration.yaml file://config/pattern_search.yaml"

Entradas

atributo	descrição	padrão	opções
Active_Scanners	Scanners para correr	todos	Brakeman, PatternSearch, Bundleaudit, Npmaudit, Gosec
APLECCED_ANGERS	Scanners que bloqueiam construções	todos	Brakeman, PatternSearch, Bundleaudit, Npmaudit, Gosec
Relatório_uri	Onde enviar relatórios salus	Arquivo: //salus-report.json	Qualquer URI
Relatório_format	Qual formato usar para relatório	JSON	JSON, YAML, TXT
Relatório_verbosidade	Se deve habilitar um relatório detalhado	verdadeiro	Verdadeiro, falso
salus_configuration	Onde encontrar a configuração de salus	Arquivo: //../salus-configuration.yaml	Qualquer URI

NOTA: Active_Scanners e aplicados_nscanners devem ser formatados YAML para o arquivo de configuração do Salus.

Saídas

Nenhum.

Variáveis ​​de ambiente do GitHub

Armazenado em Custom_info de uma varredura de salus.

Chave	GitHub Variável	Descrição
SHA1	Github_sha	Hash of Last Commit em Build
revogar	Github_repository	Nome do repositório
Ref	Github_ref	Referência que desencadeou o fluxo (ramificação ou tag)
ci_username	Github_actor	Nome de usuário do GitHub do usuário que desencadeou a construção
github_action	Github_action	Nome da ação
github_workflow	Github_workflow	Nome do fluxo de trabalho
github_event_name	Github_event_name	Nome do evento que desencadeou o fluxo de trabalho
github_event_path	Github_event_path	Caminho da carga útil do evento
github_workspace	Github_workspace	Caminho do diretório do espaço de trabalho
github_head_ref	Github_head_ref	Referência do repositório principal, se forçado
github_base_ref	Github_base_ref	Referência do repositório base, se forçado
github_home	LAR	Caminho para o diretório doméstico usado pelo github

Colaboradores

Chris Czub
Andre Azzolini
Quentin Le Sceler