github / github/ossar-action

Improve tool names in sarif output

Offen
#23 6 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
JavaScript
Sterne
100
Forks
29
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

@davidknise You seem to be the main maintainer of this repo.

Bandit and Gosec are using the name property for outputting a description (`Security audit for python by bandit` and `Golang security checks by gosec`).

At Github Code Scanning, we use those names for displaying the tool at the Security page. We added some internal logic for handling these special cases and rename them to the tool name, but we are in the process of cleaning up the code and removing it. We suggest using the name property for outputing the tool name (Bandit, and Gosec), and the [fullName](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012498) or [short](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012508)/[longDescription](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html#_Toc16012509) properties for storing the current long name.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Untersuche die SARIF-Generierung und die Verarbeitung von Tool-Metadaten für Bandit und Gosec und vergleiche anschließend die ausgegebenen Felder mit den verknüpften Eigenschaften der SARIF-Spezifikation. Als erledigt gilt die Aufgabe, wenn das Feld name den Namen des Tools enthält, während der vorhandene beschreibende Text in einem geeigneten Feld fullName, short oder longDescription gespeichert wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
security, tooling
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.