scan action

Action de scan de sécurité Salus

Cette action utilise Salus de Coinbase pour exécuter les analyses de sast et de dépendance.

Scanners soutenus

Nom	Langue
Vérification du lackage	Rubis
Frein	Rubis
Audit NPM	Javascrip
audit de fil	Javascrip
Gosec	Aller
Bandit	Python
Audit de cargaison	Rouiller
semgrep	Beaucoup
Recherche de modèle	n / a (utilise sift)

Exemple d'utilisation

.github/workflows/example.yml

Par défaut

 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 unique

 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"

Pas de scanners forcés

 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"

Configuration personnalisée

 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"

Entrées

attribut	description	défaut	options
active_scanrs	Scanners à courir	tous	Brakeman, Patternsearch, Bundleaudit, npmaudit, gosec
forcé_ccanners	Les scanners qui bloc sont construits	tous	Brakeman, Patternsearch, Bundleaudit, npmaudit, gosec
report_uri	Où envoyer des rapports Salus	fichier: //salus-report.json	N'importe quel uri
report_format	Quel format utiliser pour le rapport	json	JSON, YAML, TXT
report_verbosity	S'il faut activer un rapport verbeux	vrai	Vrai, faux
Salus_configuration	Où trouver la configuration de Salus	fichier: //../salus-configuration.yaml	N'importe quel uri

Remarque: Active_SCanners et EFORCED_SCANNERS DOIT être formaté YAML pour le fichier de configuration SALUS.

Sorties

Aucun.

Variables d'environnement GitHub

Stocké dans Custom_info d'un scan SALUS.

Clé	Variable GitHub	Description
sha1	Github_sha	Hachage du dernier engagement dans la construction
nommer	Github_repository	Nom du référentiel
référence	Github_ref	Réf qui a déclenché le flux (branche ou étiquette)
CI_USERNAME	Github_actor	Nom d'utilisateur GitHub de l'utilisateur qui a déclenché la construction
github_action	Github_action	Nom de l'action
github_workflow	Github_workflow	Nom du workflow
github_event_name	Github_event_name	Nom de l'événement qui a déclenché un workflow
github_event_path	Github_event_path	Path de charge utile de l'événement
github_workspace	Github_workspace	Chemin du répertoire de l'espace de travail
github_head_ref	Github_head_ref	Réf du référentiel de tête, s'il est fourchu
github_base_ref	Github_base_ref	Réf du référentiel de base, s'il est fourchu
github_home	MAISON	Path to Home Directory utilisé par GitHub

Contributeurs

Chris Czub
Andre Azzolini
Quentin le Sceller