SARIFPropriedades suportadas - Amazon CodeCatalyst
Objeto sarifLogObjeto runObjeto toolComponentObjeto reportingDescriptorObjeto resultObjeto locationObjeto physicalLocationObjeto logicalLocationObjeto fix

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

SARIFPropriedades suportadas

O Static Analysis Results Interchange Format (SARIF) é um formato de arquivo de saída que está disponível em análise de composição de software (SCA) e relatórios de análise estática na Amazon CodeCatalyst. O exemplo a seguir mostra como configurar manualmente SARIF em um relatório de análise estática:

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

CodeCatalyst suporta as seguintes SARIF propriedades que podem ser usadas para otimizar a forma como os resultados da análise aparecerão em seus relatórios.

Objeto sarifLog

Nome Obrigatório Descrição

$schema

Sim

O URI do SARIF JSON esquema para a versão 2.1.0.

version

Sim

CodeCatalyst suporta apenas a SARIF versão 2.1.0.

runs[]

Sim

Um SARIF arquivo contém uma matriz de uma ou mais execuções, cada uma representando uma única execução da ferramenta de análise.

Objeto run

Nome Obrigatório Descrição

tool.driver

Sim

Um toolComponent objeto que descreve a ferramenta de análise.

tool.name

Não

Uma propriedade que indica o nome da ferramenta usada para realizar a análise.

results[]

Sim

Os resultados da ferramenta de análise que são exibidos em CodeCatalyst.

Objeto toolComponent

Nome Obrigatório Descrição

name

Sim

O nome da ferramenta de análise.

properties.artifactScanned

Não

Um número total de artefatos analisados pela ferramenta.

rules[]

Sim

Uma matriz de reportingDescriptor objetos que representam regras. Com base nessas regras, a ferramenta de análise encontra problemas no código que é analisado.

Objeto reportingDescriptor

Nome Obrigatório Descrição

id

Sim

O identificador exclusivo da regra usada para referenciar uma descoberta.

Tamanho máximo: 1.024 caracteres

name

Não

O nome de exibição da regra.

Tamanho máximo: 1.024 caracteres

shortDescription.text

Não

Uma descrição resumida da regra.

Tamanho máximo: 3.000 caracteres

fullDescription.text

Não

Uma descrição completa da regra.

Tamanho máximo: 3.000 caracteres

helpUri

Não

Uma string que pode ser localizada para conter o absoluto URI da documentação primária da regra.

Tamanho máximo: 3.000 caracteres

properties.unscore

Não

Uma bandeira que indica se a descoberta do escaneamento foi pontuada.

properties.score.severity

Não

Um conjunto fixo de sequências de caracteres que especificam o nível de severidade da descoberta.

Tamanho máximo: 1.024 caracteres

properties.cvssv3_baseSeverity

Não

Uma classificação de severidade qualitativa do Common Vulnerability Scoring System v3.1.

properties.cvssv3_baseScore

Não

Uma pontuação básica CVSS v3 variando de 0,0 a 10,0.

properties.cvssv2_severity

Não

Se os valores da CVSS v3 não estiverem disponíveis, CodeCatalyst pesquisa os valores da CVSS v2.

properties.cvssv2_score

Não

Uma pontuação base CVSS v2 variando de 0,0 a 10,0.

properties.severity

Não

Um conjunto fixo de sequências de caracteres que especificam o nível de severidade da descoberta.

Tamanho máximo: 1.024 caracteres

defaultConfiguration.level

Não

A severidade padrão de uma regra.

Objeto result

Nome Obrigatório Descrição

ruleId

Sim

O identificador exclusivo da regra usada para referenciar uma descoberta.

Tamanho máximo: 1.024 caracteres

ruleIndex

Sim

O índice da regra associada no componente da ferramentarules[].

message.text

Sim

Uma mensagem que descreve o resultado e exibe a mensagem de cada descoberta.

Tamanho máximo: 3.000 caracteres

rank

Não

Um valor entre 0,0 e 100,0, inclusive, que representa a prioridade ou importância do resultado. Essa escala valoriza 0,0 sendo a prioridade mais baixa e 100,0 sendo a prioridade mais alta.

level

Não

A gravidade do resultado.

Tamanho máximo: 1.024 caracteres

properties.unscore

Não

Uma bandeira que indica se a descoberta do escaneamento foi pontuada.

properties.score.severity

Não

Um conjunto fixo de sequências de caracteres que especificam o nível de severidade da descoberta.

Tamanho máximo: 1.024 caracteres

properties.cvssv3_baseSeverity

Não

Uma classificação de severidade qualitativa do Common Vulnerability Scoring System v3.1.

properties.cvssv3_baseScore

Não

Uma pontuação básica CVSS v3 variando de 0,0 a 10,0.

properties.cvssv2_severity

Não

Se os valores da CVSS v3 não estiverem disponíveis, CodeCatalyst pesquisa os valores da CVSS v2.

properties.cvssv2_score

Não

Uma pontuação base CVSS v2 variando de 0,0 a 10,0.

properties.severity

Não

Um conjunto fixo de sequências de caracteres que especificam o nível de severidade da descoberta.

Tamanho máximo: 1.024 caracteres

locations[]

Sim

O conjunto de locais em que o resultado foi detectado. Somente um local deve ser incluído, a menos que o problema só possa ser corrigido fazendo uma alteração em cada local especificado. CodeCatalyst usa o primeiro valor na matriz de localização para anotar o resultado.

Número máximo de location objetos: 10

relatedLocations[]

Não

Uma lista de referências de localizações adicionais na descoberta.

Número máximo de location objetos: 50

fixes[]

Não

Uma matriz de fix objetos que representam a recomendação fornecida pela ferramenta de digitalização. CodeCatalyst usa a primeira recomendação na fixes matriz.

Objeto location

Nome Obrigatório Descrição

physicalLocation

Sim

Identifica o artefato e a região.

logicalLocations[]

Não

O conjunto de locais descritos pelo nome sem referência ao artefato.

Objeto physicalLocation

Nome Obrigatório Descrição

artifactLocation.uri

Sim

A URI indicação da localização de um artefato, geralmente um arquivo no repositório ou gerado durante uma construção.

fileLocation.uri

Não

O retorno URI indicando a localização do arquivo. Isso é usado se artifactLocation.uri retornar vazio.

region.startLine

Sim

O número da linha do primeiro caractere na região.

region.startColumn

Sim

O número da coluna do primeiro caractere na região.

region.endLine

Sim

O número da linha do último caractere na região.

region.endColumn

Sim

O número da coluna do último caractere na região.

Objeto logicalLocation

Nome Obrigatório Descrição

fullyQualifiedName

Não

Informações adicionais que descrevem a localização do resultado.

Tamanho máximo: 1.024 caracteres

Objeto fix

Nome Obrigatório Descrição

description.text

Não

Uma mensagem que exibe uma recomendação para cada descoberta.

Tamanho máximo: 3.000 caracteres

artifactChanges.[0].artifactLocation.uri

Não

A URI indicação da localização do artefato que precisa ser atualizado.