Oggetto SARIFlog esegui un oggetto Oggetto ToolComponent Oggetto ReportingDescriptor oggetto risultato oggetto di localizzazione Oggetto PhysicLocation Oggetto LogicAllocation oggetto fisso

Proprietà SARIF supportate

Lo Static Analysis Results Interchange Format (SARIF) è un formato di file di output disponibile nell'analisi della composizione software (SCA) e nei report di analisi statica in Amazon. CodeCatalyst L'esempio seguente mostra come configurare manualmente il SARIF in un report di analisi statica:


Reports:
MySAReport:
Format: SARIFSA
IncludePaths:
    - output/sa_report.json
SuccessCriteria:
    StaticAnalysisFinding:
    Number: 25
    Severity: HIGH

CodeCatalyst supporta le seguenti proprietà SARIF che possono essere utilizzate per ottimizzare la visualizzazione dei risultati dell'analisi nei report.

`Oggetto SARIFlog`

Nome	Richiesto	Descrizione
`$schema`	Sì	L'URI dello schema JSON SARIF per la versione 2.1.0. https://json.schemastore.org/sarif-2.1.0.json
`version`	Sì	CodeCatalyst supporta solo la versione SARIF 2.1.0.
`runs[]`	Sì	Un file SARIF contiene un array di una o più esecuzioni, ognuna delle quali rappresenta una singola esecuzione dello strumento di analisi.

`esegui un oggetto`

Nome	Richiesto	Descrizione
`tool.driver`	Sì	Un `toolComponent` oggetto che descrive lo strumento di analisi.
`tool.name`	No	Una proprietà che indica il nome dello strumento utilizzato per eseguire l'analisi.
`results[]`	Sì	I risultati dello strumento di analisi visualizzati su CodeCatalyst.

`Oggetto ToolComponent`

Nome	Richiesto	Descrizione
`name`	Sì	Il nome dello strumento di analisi.
`properties.artifactScanned`	No	Un numero totale di artefatti analizzati dallo strumento.
`rules[]`	Sì	Una serie di `reportingDescriptor` oggetti che rappresentano regole. In base a queste regole, lo strumento di analisi individua i problemi nel codice analizzato.

`Oggetto ReportingDescriptor`

Nome	Richiesto	Descrizione
`id`	Sì	L'identificatore univoco della regola utilizzato per fare riferimento a un risultato. Lunghezza massima: 1.024 caratteri
`name`	No	Il nome visualizzato della regola. Lunghezza massima: 1.024 caratteri
`shortDescription.text`	No	Una descrizione abbreviata della regola. Lunghezza massima: 3.000 caratteri
`fullDescription.text`	No	Una descrizione completa della regola. Lunghezza massima: 3.000 caratteri
`helpUri`	No	Una stringa che può essere localizzata per contenere l'URI assoluto della documentazione primaria della regola. Lunghezza massima: 3.000 caratteri
`properties.unscore`	No	Un contrassegno che indica se il risultato della scansione è stato valutato.
`properties.score.severity`	No	Un set fisso di stringhe che specificano il livello di gravità del risultato. Lunghezza massima: 1.024 caratteri
`properties.cvssv3_baseSeverity`	No	Una valutazione di gravità qualitativa del Common Vulnerability Scoring System v3.1.
`properties.cvssv3_baseScore`	No	Un punteggio base CVSS v3 compreso tra 0,0 e 10,0. https://nvd.nist.gov/vuln-metrics/cvss
`properties.cvssv2_severity`	No	Se i valori CVSS v3 non sono disponibili, cerca i valori CVSS v2. CodeCatalyst
`properties.cvssv2_score`	No	Un punteggio base CVSS v2 compreso tra 0,0 e 10,0. https://nvd.nist.gov/vuln-metrics/cvss
`properties.severity`	No	Un set fisso di stringhe che specifica il livello di gravità del risultato. Lunghezza massima: 1.024 caratteri
`defaultConfiguration.level`	No	La severità predefinita di una regola.

oggetto risultato

Nome	Richiesto	Descrizione
`ruleId`	Sì	L'identificatore univoco della regola utilizzato per fare riferimento a un risultato. Lunghezza massima: 1.024 caratteri
`ruleIndex`	Sì	L'indice della regola associata nel componente `rules[]` utensile.
`message.text`	Sì	Un messaggio che descrive il risultato e visualizza il messaggio per ogni risultato. Lunghezza massima: 3.000 caratteri
`rank`	No	Un valore compreso tra 0,0 e 100,0 inclusi che rappresenta la priorità o l'importanza del risultato. In questa scala i valori 0.0 rappresentano la priorità più bassa e 100.0 la priorità più alta.
`level`	No	La gravità del risultato. Lunghezza massima: 1.024 caratteri
`properties.unscore`	No	Un contrassegno che indica se il risultato della scansione è stato valutato.
`properties.score.severity`	No	Un set fisso di stringhe che specificano il livello di gravità del risultato. Lunghezza massima: 1.024 caratteri
`properties.cvssv3_baseSeverity`	No	Una valutazione di gravità qualitativa del Common Vulnerability Scoring System v3.1.
`properties.cvssv3_baseScore`	No	Un punteggio base CVSS v3 compreso tra 0,0 e 10,0. https://nvd.nist.gov/vuln-metrics/cvss
`properties.cvssv2_severity`	No	Se i valori CVSS v3 non sono disponibili, cerca i valori CVSS v2. CodeCatalyst
`properties.cvssv2_score`	No	Un punteggio base CVSS v2 compreso tra 0,0 e 10,0. https://nvd.nist.gov/vuln-metrics/cvss
`properties.severity`	No	Un set fisso di stringhe che specifica il livello di gravità del risultato. Lunghezza massima: 1.024 caratteri
`locations[]`	Sì	L'insieme di posizioni in cui è stato rilevato il risultato. È necessario includere una sola posizione, a meno che il problema non possa essere corretto solo apportando una modifica in ogni posizione specificata. CodeCatalyst utilizza il primo valore nell'array delle posizioni per annotare il risultato. Numero massimo di `location` oggetti: 10
`relatedLocations[]`	No	Un elenco di riferimenti aggiuntivi alle località presenti nel ritrovamento. Numero massimo di `location` oggetti: 50
`fixes[]`	No	Una serie di `fix` oggetti che rappresentano la raccomandazione fornita dallo strumento di scansione. CodeCatalyst utilizza la prima raccomandazione dell'`fixes`array.

oggetto di localizzazione

Nome	Richiesto	Descrizione
`physicalLocation`	Sì	Identifica l'artefatto e la regione.
`logicalLocations[]`	No	L'insieme di posizioni descritte per nome senza riferimento all'artefatto.

`Oggetto PhysicLocation`

Nome	Richiesto	Descrizione
`artifactLocation.uri`	Sì	L'URI che indica la posizione di un artefatto, in genere un file nel repository o generato durante una compilazione.
`fileLocation.uri`	No	L'URI di ripiego che indica la posizione del file. Viene utilizzato se il risultato `artifactLocation.uri` è vuoto.
`region.startLine`	Sì	Il numero di riga del primo carattere della regione.
`region.startColumn`	Sì	Il numero di colonna del primo carattere della regione.
`region.endLine`	Sì	Il numero di riga dell'ultimo carattere della regione.
`region.endColumn`	Sì	Il numero di colonna dell'ultimo carattere della regione.

`Oggetto LogicAllocation`

Nome Richiesto Description

Nome	Richiesto	Description
`fullyQualifiedName`	No	Informazioni aggiuntive che descrivono la posizione del risultato. Lunghezza massima: 1.024 caratteri

fullyQualifiedName

Informazioni aggiuntive che descrivono la posizione del risultato.

Lunghezza massima: 1.024 caratteri

`oggetto fisso`

Nome Richiesto Description

Nome	Richiesto	Description
`description.text`	No	Un messaggio che mostra una raccomandazione per ogni risultato. Lunghezza massima: 3.000 caratteri
`artifactChanges.[0].artifactLocation.uri`	No	L'URI che indica la posizione dell'artefatto che deve essere aggiornato.

description.text

Un messaggio che mostra una raccomandazione per ogni risultato.

Lunghezza massima: 3.000 caratteri

artifactChanges.[0].artifactLocation.uri

L'URI che indica la posizione dell'artefatto che deve essere aggiornato.

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

Le migliori pratiche per i test

Implementazione con flussi di lavoro