Accedi ai metadati di sicurezza e verifica i pacchetti

Questa pagina descrive come accedere ai metadati per la sicurezza dal bucket Cloud Storage assuredoss-metadata. Per una descrizione dei metadati di sicurezza, consulta Campi dei metadati di sicurezza.

Questa pagina si applica solo al livello a pagamento di Assured OSS. Per il livello gratuito, consulta Verificare le firme nel livello gratuito di Assured OSS.

Prima di iniziare

Configura l'autenticazione.

Estrarre i metadati

Puoi utilizzare i comandi gsutil o curl per scaricare i metadati. Crea l'URL per entrambi utilizzando le seguenti informazioni:

  • Lingua: java, python o javascript. Il valore deve essere in minuscolo.
  • Package_ID: per Java, è groupId:artifactId, per Python è packageName e per JavaScript è @org-name/package-name, @username/package-name o package-name. Il valore deve essere in minuscolo.
  • Versione:la versione del pacchetto.

L'URL deve avere il seguente formato:

gsutil

gs://assuredoss-metadata/language/package_id/version/metadata.json

L'URL deve essere in minuscolo.

URL Python di esempio: gs://assuredoss-metadata/python/blessed/1.20.0/metadata.json

URL Java di esempio: gs://assuredoss-metadata/java/org.apache.logging.log4j:log4j-core/2.17.1/metadata.json

URL JavaScript di esempio: gs://assuredoss-metadata/javascript/@stoplight/spectral-core/0.0.0/metadata.json

arricciatura

https://storage.googleapis.com/assuredoss-metadata/language/package_id/version/metadata.json

L'URL deve essere in minuscolo.

URL Python di esempio: https://storage.googleapis.com/assuredoss-metadata/python/blessed/1.20.0/metadata.json

URL Java di esempio: https://storage.googleapis.com/assuredoss-metadata/java/org.apache.logging.log4j:log4j-core/2.17.1/metadata.json

URL JavaScript di esempio: https://storage.googleapis.com/assuredoss-metadata/javascript/@stoplight/spectral-core/0.0.0/metadata.json

  1. Scarica i metadati:

gsutil

gsutil -m cp  "gs://assuredoss-metadata/language/package_id/version/metadata.json" outputFolderLocation

arricciatura

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -L https://storage.googleapis.com/assuredoss-metadata/language/package_id/version/metadata.json -o metadata.json

Ora puoi verificare le firme. Le opzioni disponibili sono due:

Verificare le firme dei pacchetti scaricati utilizzando lo strumento aoss-verifica

Usa lo strumento aoss-verifier per verificare i metadati del pacchetto.

Prima di utilizzare questo strumento, installa Go.

  1. Installa lo strumento aoss-verifica.

  2. Esporta $(go env GOPATH)/bin.

  3. Esegui il comando aoss-verifier verify-metadata.

    aoss-verifier verify-metadata \
       --metadata_type TYPE \
       --language LANGUAGE \
       --package_id PACKAGE_ID \
       --version VERSION \
       [--disable_certificate_verification] \
       [--temp_downloads_path TEMP_DOWNLOADS_DIR_PATH] \
       [--disable_deletes]
    

    Sostituisci quanto segue:

    • TYPE: i valori possibili sono premiuminfo.
    • LANGUAGE: la lingua del pacchetto. Il valore deve essere in minuscolo.
    • PACKAGE_ID: per Java, il formato è groupId:artifactId. Per Python, il formato è packageName. Il valore deve essere in minuscolo.
    • VERSION: la versione del pacchetto.

    --disable_certificate_verification è un flag facoltativo che ignora la corrispondenza tra certificato radice e certificato radice tramite la catena di certificati, se utilizzato.

    --temp_downloads_path è un flag facoltativo per impostare il percorso in cui vuoi scaricare i file (sostituisci TEMP_DOWNLOADS_DIR_PATH). Se il flag non è impostato, i file vengono scaricati nella cartella tmp_downloads della directory corrente.

    --disable_deletes è un flag facoltativo che conserva i file scaricati. Per impostazione predefinita, lo strumento cancella tutti i file scaricati.

Per ulteriori informazioni, consulta il file README.

Verificare manualmente le firme dei pacchetti scaricati

Puoi verificare la firma dell'artefatto solo per i programmi binari creati in modo sicuro da Assured OSS, non per quelli forniti da Assured OSS tramite proxy.

Per verificare le firme manualmente, puoi utilizzare vari strumenti. I passaggi seguenti utilizzano gcloud CLI, OpenSSL (versione 3.0.1 o successive) e jq (1.7.1 o versioni successive) per verificare le firme su Linux.

  1. Scarica il file dei metadati. Come descritto in Accedere ai metadati utilizzando Cloud Storage, il file di metadati contiene un campo SBOM all'interno del campo buildInfo. L'SBOM contiene l'artefatto (ad esempio, un file JAR o EGG) che è stato creato insieme a un'annotazione che rappresenta la firma. Questo artefatto consente di determinare l'ID SPDX.

    Ad esempio, se il nome dell'artefatto è artifact_name, spdx_id è SPDXRef-Package-artifact_name. Per convalidare un pacchetto denominato gradio-3.30.0-py3-none-any.whl, spdx_id è SPDXRef-Package-gradio-3.30.0-py3-none-any.whl.

  2. Estrai il digest SHA-256 dal file di metadati:

    cat METADATA_FILENAME | jq -rj '.buildInfo' | jq -rj '.sbom' | jq -rj '.packages' | jq '.[] | select(.SPDXID=="SPDX_ID")' | jq -rj '.annotations[0].comment' | jq -rj '.digest[0].digest' | cut -d ' ' -f1 > expectedDigest.txt
    

    Sostituisci quanto segue:

    • METADATA_FILENAME: il nome del file dei metadati di sicurezza.

    • SPDX_ID: l'identificatore SPDX.

  3. Calcola il digest dell'artefatto:

    sha256sum ARTIFACT_FILE | cut -d ' ' -f1 > actualDigest.txt
    

    Sostituisci ARTIFACT_FILE con il nome del file dell'artefatto.

  4. Verifica la presenza di eventuali differenze tra i due.

    diff actualDigest.txt expectedDigest.txt
    

    In assenza di differenze, non viene restituito alcun output.

  5. Estrai il digest del campo in un file .bin:

    cat METADATA_FILENAME | jq -rj '.buildInfo' | jq -rj '.sbom' | jq -rj '.packages' | jq '.[] | select(.SPDXID=="SPDX_ID")' | jq -rj '.annotations[0].comment' | jq -rj '.digest[0].digest' | cut -d ':' -f2 | xxd -r -p > digest.bin
    
  6. Estrai la firma del digest in un file .sig:

    cat METADATA_FILENAME | jq -rj '.buildInfo' | jq -rj '.sbom' | jq -rj '.packages' | jq '.[] | select(.SPDXID=="SPDX_ID")' | jq -rj '.annotations[0].comment' | jq -rj '.signature[0].signature' | xxd -r -p > sig.sig
    
  7. Estrai il certificato pubblico in un file .pem:

    cat METADATA_FILENAME | jq -rj '.buildInfo' | jq -rj '.sbom' | jq -rj '.packages' | jq '.[] | select(.SPDXID=="SPDX_ID")' | jq -rj '.annotations[0].comment' | jq -rj '.certInfo.cert' | openssl x509 -pubkey -noout  > pubKey.pem
    
  8. Verifica la firma del digest utilizzando il certificato:

    openssl pkeyutl -in digest.bin -inkey pubKey.pem -pubin -verify -sigfile sig.sig
    

    Se l'esito è positivo, questo comando restituisce Signature Verified Successfully. Ora puoi verificare il certificato.

  9. Estrai la catena di certificati pubblici in un file .pem:

    cat METADATA_FILENAME | jq -rj '.buildInfo' | jq -rj '.sbom' | jq -rj '.packages' | jq '.[] | select(.SPDXID=="SPDX_ID")' | jq -rj '.annotations[0].comment' | jq -rj '.certInfo.certChain' | openssl x509 -pubkey -noout  > pubKeyChain.pem
    
  10. Scarica il certificato radice (ca.crt nel comando seguente):

    curl -o ca.crt https://privateca-content-6333d504-0000-2df7-afd6-30fd38154590.storage.googleapis.com/a2c725a592f1d586f1f8/ca.crt
    
  11. Verifica il certificato utilizzando la catena di certificati e il certificato radice:

    openssl verify -verbose -CAfile ca.crt -untrusted pubKeyChain.pem pubKey.pem
    

    Se l'esito è positivo, questo comando restituisce pubKey.pem: OK.

Verificare le firme per i campi dei metadati di sicurezza

Puoi verificare la firma dei seguenti campi nel file dei metadati per la sicurezza in modo indipendente:

  • buildInfo
  • vexInfo
  • healthInfo (se presente)

I dati all'interno dei campi vengono sottoposti ad hashing utilizzando il formato SHA-256, quindi l'hash viene firmato utilizzando l'algoritmo ECDSAP256_DER. Il certificato e la catena di certificati sono forniti all'interno dei metadati per consentirti di verificare la firma. Usa il seguente certificato radice per verificare la catena di certificati:

https://privateca-content-6333d504-0000-2df7-afd6-30fd38154590.storage.googleapis.com/a2c725a592f1d586f1f8/ca.crt

Puoi verificare le firme manualmente oppure puoi farlo utilizzando lo strumento di verifica OSS di Assured.

I passaggi seguenti descrivono come verificare manualmente la firma del campo buildInfo nel file metadata.json. Puoi utilizzare passaggi simili per verificare la firma del campo vexInfo o healthInfo.

Puoi verificare le firme utilizzando vari strumenti. L'esempio seguente utilizza gcloud CLI, OpenSSL (versione 3.0.1 o successive) e jq (1.7.1 o versioni successive) per verificare le firme su un sistema Linux.

  1. Genera il digest SHA-256 del campo:

    cat metadata.json | jq -rj '.buildInfo' | sha256sum | cut -d ' ' -f1 > actualDigest.txt
    
  2. Estrai il digest del campo fornito nel file metadata.json:

    cat metadata.json | jq -rj '.buildInfoSignature.digest[0].digest' | cut -d ':' -f2 > expectedDigest.txt
    
  3. Verifica la presenza di eventuali differenze tra i due digest:

    diff actualDigest.txt expectedDigest.txt
    

    Se non c'è alcuna differenza, non ci sarà alcun output, il che è il caso ideale. Ora puoi verificare la firma.

  4. Estrai il digest del campo in un file .bin:

    cat metadata.json | jq -rj '.buildInfoSignature.digest[0].digest' | cut -d ':' -f2 | xxd -r -p > digest.bin
    
  5. Estrai la firma del digest in un file .sig:

    cat metadata.json | jq -rj '.buildInfoSignature.signature[0].signature' | xxd -r -p > sig.sig
    
  6. Estrai il certificato pubblico in un file .pem:

    cat metadata.json | jq -rj '.buildInfoSignature.certInfo.cert' | openssl x509 -pubkey -noout  > pubKey.pem
    
  7. Verifica la firma del digest utilizzando il certificato:

    openssl pkeyutl -in digest.bin -inkey pubKey.pem -pubin -verify -sigfile sig.sig
    

    Se la verifica ha esito positivo, questo comando restituisce Signature Verified Successfully. Ora puoi verificare il certificato.

  8. Estrai il certificato pubblico in un file .pem:

    cat metadata.json | jq -rj '.buildInfoSignature.certInfo.cert' | openssl x509 -pubkey -noout  > pubKey.pem
    
  9. Estrai la catena di certificati pubblici in un file .pem:

    cat metadata.json | jq -rj '.buildInfoSignature.certInfo.certChain' | openssl x509 -pubkey -noout  > pubKeyChain.pem
    
  10. Scarica il certificato radice, denominato ca.crt nel seguente comando:

    curl -o ca.crt https://privateca-content-6333d504-0000-2df7-afd6-30fd38154590.storage.googleapis.com/a2c725a592f1d586f1f8/ca.crt
    
  11. Verifica il certificato utilizzando la catena di certificati e il certificato radice:

    openssl verify -verbose -CAfile ca.crt -untrusted pubKeyChain.pem pubKey.pem
    

    Se l'esito è positivo, il comando restituisce pubKey.pem: OK.