Questo tutorial mostra come configurare e testare un criterio di Autorizzazione binaria che richiede attestations. Questo tipo di criterio protegge la catena di fornitura del software basata su container verificando che un'immagine container abbia un'attestazione firmata prima di consentire il deployment dell'immagine.
Al momento del deployment, Autorizzazione binaria utilizza gli attestatori per verificare le firme digitali nelle attestations. Le attestazioni vengono create dai significanti, di solito come parte di una pipeline di integrazione continua (CI).
In questo tutorial, il cluster GKE, le attestazioni e gli attestatori si trovano tutti in un singolo progetto. Una configurazione per un solo progetto è utile soprattutto per eseguire test o sperimentare con il servizio. Per un esempio più reale, consulta la pagina relativa alla configurazione multiprogetto.
I passaggi seguenti descrivono le attività eseguite dalla riga di comando. Per seguire questi passaggi utilizzando la console Google Cloud, consulta Iniziare a utilizzare la console Google Cloud.
Obiettivi
In questo tutorial imparerai a:
- Crea un cluster Google Kubernetes Engine (GKE) con Autorizzazione binaria abilitata
- Crea un attestatore utilizzato dall'autorità di applicazione di Autorizzazione binaria per verificare la firma su un'attestazione
- Configura un criterio che richiede un'attestazione
- Crea una coppia di chiavi di crittografia per firmare le attestazioni e verificarle in un secondo momento
- Firma un digest dell'immagine container, creando una firma
- Crea un'attestazione utilizzando la firma
- Testa il criterio eseguendo il deployment di un'immagine container in GKE
Costi
In questo documento vengono utilizzati i seguenti componenti fatturabili di Google Cloud:
- Artifact Registry or Container Registry
- Binary Authorization
- GKE
- Optional: Cloud Key Management Service
Per generare una stima dei costi in base all'utilizzo previsto,
utilizza il Calcolatore prezzi.
Prima di iniziare
- Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.
-
Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.
- Installa Google Cloud CLI.
-
Per initialize gcloud CLI, esegui questo comando:
gcloud init
-
Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.
- Installa Google Cloud CLI.
-
Per initialize gcloud CLI, esegui questo comando:
gcloud init
- Installa
kubectl
per interagire con GKE.
Attiva Autorizzazione binaria
Impostare il progetto predefinito
Il primo passaggio consiste nell'impostare il progetto Google Cloud predefinito utilizzato dal comando gcloud
:
PROJECT_ID=PROJECT_ID gcloud config set project ${PROJECT_ID}
dove PROJECT_ID è il nome del progetto.
Abilita le API richieste
Abilita API per:
Container Registry
gcloud --project=${PROJECT_ID} \ services enable\ container.googleapis.com\ containerregistry.googleapis.com\ binaryauthorization.googleapis.com
Artifact Registry
gcloud --project=${PROJECT_ID} \ services enable\ container.googleapis.com\ artifactregistry.googleapis.com\ binaryauthorization.googleapis.com
Crea un cluster con Autorizzazione binaria abilitata
Crea il cluster
Creare un cluster GKE con Autorizzazione binaria abilitata. Questo è il cluster in cui vuoi che vengano eseguite le immagini container di cui hai eseguito il deployment. Quando crei il cluster, passi il flag --binauthz-evaluation-mode=PROJECT_SINGLETON_POLICY_ENFORCE
al comando gcloud container clusters create
.
Per creare il cluster, segui questi passaggi:
gcloud container clusters create \ --binauthz-evaluation-mode=PROJECT_SINGLETON_POLICY_ENFORCE \ --zone us-central1-a \ test-cluster
Qui creerai un cluster denominato test-cluster
nella zona GKE us-central1-a
.
Configura kubectl
Devi anche aggiornare il file kubeconfig
locale per l'installazione di kubectl
. Fornisce le credenziali e le informazioni sugli endpoint
necessari per accedere al cluster in GKE.
Per aggiornare il file kubeconfig
locale:
gcloud container clusters get-credentials \ --zone us-central1-a \ test-cluster
Visualizza il criterio predefinito
Un criterio in Autorizzazione binaria è un insieme di regole che regolano il deployment delle immagini container. Puoi avere un criterio per progetto. Per impostazione predefinita, il criterio è configurato in modo da consentire il deployment di tutte le immagini container.
Autorizzazione binaria consente di esportare e importare un file di criteri in formato YAML. Questo formato riflette la struttura di un criterio così come viene archiviato dal servizio. Quando configuri un criterio utilizzando i comandi gcloud
, modifichi questo file.
Per visualizzare il criterio predefinito, esporta il file YAML del criterio:
gcloud container binauthz policy export
Per impostazione predefinita, il file ha i seguenti contenuti:
defaultAdmissionRule: enforcementMode: ENFORCED_BLOCK_AND_AUDIT_LOG evaluationMode: ALWAYS_ALLOW globalPolicyEvaluationMode: ENABLE name: projects/PROJECT_ID/policy
La regola predefinita è definita nel nodo defaultAdmissionRule
. evaluationMode
specifica che il criterio consente tutti i tentativi di deployment delle immagini. In questo tutorial aggiorni la regola predefinita
in modo che richiedano attestazioni.
globalPolicyEvaluationMode
esclude le immagini di sistema gestite da Google dall'applicazione di Autorizzazione binaria.
Per aggiungere un'immagine esente alla lista consentita, aggiungi quanto segue al file dei criteri:
admissionWhitelistPatterns: - namePattern: EXEMPT_IMAGE_PATH
Sostituisci EXEMPT_IMAGE_PATH
con il percorso dell'immagine da escludere. Per escludere altre immagini, aggiungi altre voci - namePattern
. Scopri di più su admissionWhitelistPatterns
.
Per ulteriori informazioni sulla struttura di un criterio, consulta il riferimento YAML dei criteri.
Crea un attestatore
Un attestatore è l'autorità di verifica che l'autorità di applicazione di Autorizzazione binaria utilizza al momento del deployment per decidere se consentire a GKE di eseguire il deployment dell'immagine del container firmata corrispondente. L'attestatore contiene la chiave pubblica ed è in genere gestito da personale dell'organizzazione responsabile della sicurezza della catena di fornitura del software.
Per creare un attestatore devi:
- Crea una nota in Artifact Analysis per archiviare i metadati attendibili utilizzati nel processo di autorizzazione
- Crea l'attestatore stesso in Autorizzazione binaria e associa la nota che hai creato
Per questo tutorial, avrai un attestatore denominato test-attestor
e una nota di analisi dei container denominata test-attestor-note
. In uno scenario reale, puoi avere un numero qualsiasi di attestatori, ognuno dei quali rappresenta la parte che partecipa alla procedura di autorizzazione per un'immagine container.
Crea la nota Artifact Analysis
Imposta le variabili che memorizzano il nome dell'attestatore e la nota di Artifact Analysis:
ATTESTOR_NAME=test-attestor NOTE_ID=test-attestor-note
Sostituisci:
- test-attestor: nome dell'attestatore a tua scelta.
- attestor-note: nome della nota dell'attestatore a tua scelta.
Crea in
/tmp/note_payload.json
un file JSON che descriva la nota di Analisi dei container:cat > /tmp/note_payload.json << EOM { "name": "projects/${PROJECT_ID}/notes/${NOTE_ID}", "attestation": { "hint": { "human_readable_name": "Attestor Note" } } } EOM
Crea la nota inviando una richiesta HTTP all'API REST di Artifact Analysis:
curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @/tmp/note_payload.json \ "https://containeranalysis.googleapis.com/v1/projects/${PROJECT_ID}/notes/?noteId=${NOTE_ID}"
Verifica che la nota sia stata creata:
curl \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://containeranalysis.googleapis.com/v1/projects/${PROJECT_ID}/notes/${NOTE_ID}"
Crea l'attestatore
Ora puoi creare l'attestatore:
Crea l'attestatore in Autorizzazione binaria:
gcloud container binauthz attestors create ${ATTESTOR_NAME} \ --attestation-authority-note=${NOTE_ID} \ --attestation-authority-note-project=${PROJECT_ID}
Verifica che l'attestatore sia stato creato:
gcloud container binauthz attestors list
L'attestatore che hai creato non è ancora utilizzabile senza una coppia di chiavi PKIX associata, creata di seguito.
Genera una coppia di chiavi
Autorizzazione binaria utilizza chiavi di crittografia per verificare in modo sicuro l'identità dei firmatori. Ciò garantisce che venga eseguito il deployment solo delle immagini container autorizzate. La coppia di chiavi è composta da una chiave privata e una chiave pubblica. Il signer usa la chiave privata per firmare il digest dell'immagine container, producendo una firma che viene quindi archiviata in una attestazione. La chiave pubblica è archiviata nell'attestatore. Al momento del deployment, l'applicatore di Autorizzazione binaria utilizza la chiave pubblica dell'attestatore per verificare la firma nell'attestazione prima di consentire il deployment del container.
In questo tutorial utilizzerai il formato Infrastruttura a chiave pubblica (X.509) (PKIX) per le chiavi di crittografia. Questo tutorial utilizza l'algoritmo di firma digitale Elliptic Curve (ECDSA), consigliato per generare una coppia di chiavi PKIX. Puoi anche utilizzare chiavi RSA o PGP per la firma.
Scopi e algoritmi chiave per ulteriori informazioni sugli algoritmi di firma.
Le chiavi generate e archiviate da Cloud Key Management Service (Cloud KMS) sono conformi a PKIX. Per ulteriori informazioni sull'utilizzo delle chiavi PKIX e di Cloud KMS, consulta Creazione di attestatori mediante gcloud CLI.
PKIX (Cloud KMS)
Per creare la coppia di chiavi in Cloud KMS, segui questi passaggi:
Configura le variabili di ambiente necessarie per creare la coppia di chiavi.
KMS_KEY_PROJECT_ID=${PROJECT_ID} KMS_KEYRING_NAME=my-binauthz-keyring KMS_KEY_NAME=my-binauthz-kms-key-name KMS_KEY_LOCATION=global KMS_KEY_PURPOSE=asymmetric-signing KMS_KEY_ALGORITHM=ec-sign-p256-sha256 KMS_PROTECTION_LEVEL=software KMS_KEY_VERSION=1
Per creare il keyring, esegui questo comando:
gcloud kms keyrings create ${KMS_KEYRING_NAME} \ --location ${KMS_KEY_LOCATION}
Per creare la chiave, esegui questo comando:
gcloud kms keys create ${KMS_KEY_NAME} \ --location ${KMS_KEY_LOCATION} \ --keyring ${KMS_KEYRING_NAME} \ --purpose ${KMS_KEY_PURPOSE} \ --default-algorithm ${KMS_KEY_ALGORITHM} \ --protection-level ${KMS_PROTECTION_LEVEL}
Per aggiungere la chiave pubblica all'attestatore, esegui questo comando:
gcloud --project="${PROJECT_ID}" \ container binauthz attestors public-keys add \ --attestor="${ATTESTOR_NAME}" \ --keyversion-project="${KMS_KEY_PROJECT_ID}" \ --keyversion-location="${KMS_KEY_LOCATION}" \ --keyversion-keyring="${KMS_KEYRING_NAME}" \ --keyversion-key="${KMS_KEY_NAME}" \ --keyversion="${KMS_KEY_VERSION}"
Recupera l'ID della chiave pubblica dall'attestatore come segue:
Puoi visualizzare l'ID della tua chiave pubblica in qualsiasi momento utilizzando il comando:
gcloud container binauthz attestors describe <var>ATTESTOR_NAME</var>
.Per salvare l'ID della chiave pubblica in una variabile di ambiente, inserisci questo comando:
PUBLIC_KEY_ID=$(gcloud container binauthz attestors describe ${ATTESTOR_NAME} \ --format='value(userOwnedGrafeasNote.publicKeys[0].id)' --project ${PROJECT_ID})
PKIX (chiave locale)
Per generare una coppia di chiavi PKIX:
Crea la chiave privata:
PRIVATE_KEY_FILE="/tmp/ec_private.pem" openssl ecparam -genkey -name prime256v1 -noout -out ${PRIVATE_KEY_FILE}
Estrai la chiave pubblica dalla chiave privata:
PUBLIC_KEY_FILE="/tmp/ec_public.pem" openssl ec -in ${PRIVATE_KEY_FILE} -pubout -out ${PUBLIC_KEY_FILE}
Aggiungi la chiave pubblica all'attestatore.
Ora aggiungi la chiave pubblica esportata nell'attestatore in modo che possa essere utilizzata da Autorizzazione binaria per la verifica dell'identità:
gcloud --project="${PROJECT_ID}" \ beta container binauthz attestors public-keys add \ --attestor="${ATTESTOR_NAME}" \ --pkix-public-key-file=${PUBLIC_KEY_FILE} \ --pkix-public-key-algorithm=ecdsa-p256-sha256
Salva l'ID della chiave pubblica.
Per salvare l'ID della chiave pubblica, puoi copiarlo dall'output di
public-keys add
sopra. Per visualizzare l'ID della chiave pubblica dell'attestatore dopo averlo aggiunto all'attestatore, utilizzagcloud container binauthz attestors describe ${ATTESTOR_NAME}
:PUBLIC_KEY_ID=$(gcloud container binauthz attestors describe ${ATTESTOR_NAME} \ --format='value(userOwnedGrafeasNote.publicKeys[0].id)')
Configura il criterio
Ora puoi configurare il criterio. In questo passaggio, esporterai il file YAML dei criteri nel tuo sistema locale e modificherai la regola predefinita in modo che richieda un'attestazione da parte dell'attestatore definito in precedenza.
Per configurare il criterio:
Crea un nuovo file dei criteri che consenta le immagini di sistema gestite da Google, imposta il valore
evaluationMode
suREQUIRE_ATTESTATION
e aggiunge un nodo denominatorequireAttestationsBy
che fa riferimento all'attestatore che hai creato:cat > /tmp/policy.yaml << EOM globalPolicyEvaluationMode: ENABLE defaultAdmissionRule: evaluationMode: REQUIRE_ATTESTATION enforcementMode: ENFORCED_BLOCK_AND_AUDIT_LOG requireAttestationsBy: - projects/${PROJECT_ID}/attestors/${ATTESTOR_NAME} name: projects/${PROJECT_ID}/policy EOM
Importa il file YAML del criterio in Autorizzazione binaria:
gcloud container binauthz policy import /tmp/policy.yaml
Per ulteriori informazioni sulla configurazione di un criterio, consulta Configurare un criterio utilizzando gcloud CLI.
Testa il criterio
Puoi testare il criterio configurato in precedenza provando a eseguire il deployment di un'immagine container di esempio nel cluster. Il criterio bloccherà il deployment perché non è stata effettuata l'attestazione richiesta.
Per questo tutorial, puoi utilizzare immagini di esempio da Container Registry e
Artifact Registry. L'immagine di Container Registry si trova nel percorso gcr.io/google-samples/hello-app:1.0
. L'immagine di Artifact Registry si trova
nel percorso us-docker.pkg.dev/google-samples/containers/gke/hello-app:1.0
.
Entrambi i percorsi contengono un'immagine pubblica creata da Google che contiene un'applicazione "Hello World!".
Innanzitutto, prova a eseguire il deployment dell'immagine:
kubectl run hello-server --image gcr.io/google-samples/hello-app:1.0 --port 8080
Ora verifica che il deployment sia stato bloccato da Autorizzazione binaria:
kubectl get pods
Il comando visualizza il seguente messaggio, che indica che il deployment dell'immagine non è stato eseguito:
No resources found.
Puoi ottenere ulteriori dettagli sul deployment:
kubectl get event --template \ '{{range.items}}{{"\033[0;36m"}}{{.reason}}:{{"\033[0m"}}\{{.message}}{{"\n"}}{{end}}'
Viene visualizzata una risposta simile alla seguente:
FailedCreate: Error creating: pods POD_NAME is forbidden: admission webhook "imagepolicywebhook.image-policy.k8s.io" denied the request: Image IMAGE_NAME denied by Binary Authorization default admission rule. Image IMAGE_NAME denied by attestor ATTESTOR_NAME: No attestations found
In questo output:
- POD_NAME: il nome del pod.
- IMAGE_NAME: il nome dell'immagine.
- ATTESTOR_NAME: il nome dell'attestatore.
Assicurati di eliminare il deployment per poter continuare con il passaggio successivo:
kubectl delete deployment hello-server
Crea un'attestazione
Un'attestazione è un documento digitale creato da un signer che certifica che GKE ha l'autorizzazione a eseguire il deployment dell'immagine container associata. Il processo di creazione di un'attestazione a volte è chiamato "firma dell'immagine". Un firmatario può essere una persona o, più spesso, un processo automatizzato che viene eseguito quando viene creata un'immagine container. La firma viene creata utilizzando la chiave privata di una coppia di chiavi. Al momento del deployment, l'autorità di applicazione di Autorizzazione binaria utilizza la chiave pubblica dell'attestatore per verificare la firma nell'attestazione.
In questo tutorial, l'attestazione indica semplicemente che autorizzi il deployment dell'immagine.
Per creare un'attestazione:
Imposta le variabili che archiviano il percorso del registro e il digest dell'immagine:
Container Registry
IMAGE_PATH="gcr.io/google-samples/hello-app" IMAGE_DIGEST="sha256:c62ead5b8c15c231f9e786250b07909daf6c266d0fcddd93fea882eb722c3be4" IMAGE_TO_ATTEST=${IMAGE_PATH}@${IMAGE_DIGEST}
Artifact Registry
IMAGE_PATH="us-docker.pkg.dev/google-samples/containers/gke/hello-app" IMAGE_DIGEST="sha256:37e5287945774f27b418ce567cd77f4bbc9ef44a1bcd1a2312369f31f9cce567" IMAGE_TO_ATTEST=${IMAGE_PATH}@${IMAGE_DIGEST}
Per creare l'attestazione:
Cloud KMS PKIX
Per creare l'attestazione utilizzando la chiave Cloud KMS, esegui questo comando:
gcloud beta container binauthz attestations sign-and-create \ --project="${PROJECT_ID}" \ --artifact-url="${IMAGE_TO_ATTEST}" \ --attestor="${ATTESTOR_NAME}" \ --attestor-project="${PROJECT_ID}" \ --keyversion-project="${KMS_KEY_PROJECT_ID}" \ --keyversion-location="${KMS_KEY_LOCATION}" \ --keyversion-keyring="${KMS_KEYRING_NAME}" \ --keyversion-key="${KMS_KEY_NAME}" \ --keyversion="${KMS_KEY_VERSION}"
PKIX (chiave locale)
Per creare l'attestazione utilizzando la chiave locale:
Genera il payload di attestazione:
gcloud container binauthz create-signature-payload \ --artifact-url=${IMAGE_TO_ATTEST} > /tmp/generated_payload.json
Il file JSON payload ha i seguenti contenuti:
{ "critical": { "identity": { "docker-reference": "gcr.io/google-samples/hello-app" }, "image": { "docker-manifest-digest": "sha256:c62ead5b8c15c231f9e786250b07909daf6c266d0fcddd93fea 882eb722c3be4" }, "type": "Google cloud binauthz container signature" } }
Per firmare il payload con la tua chiave privata PKIX e generare un file di firma, esegui questo comando:
openssl dgst -sha256 -sign ${PRIVATE_KEY_FILE} /tmp/generated_payload.json > /tmp/ec_signature
Il file di firma è la versione firmata del file JSON del payload che hai creato in precedenza in questa guida.
Crea e convalida l'attestazione:
gcloud container binauthz attestations create \ --project="${PROJECT_ID}" \ --artifact-url="${IMAGE_TO_ATTEST}" \ --attestor="projects/${PROJECT_ID}/attestors/${ATTESTOR_NAME}" \ --signature-file=/tmp/ec_signature \ --public-key-id="${PUBLIC_KEY_ID}" \ --validate
Sostituisci
PUBLIC_KEY_ID
con l'ID della chiave pubblica che hai trovato nella sezione Generare una coppia di chiavi PKIX qui sopra.Il flag
validate
verifica che l'attestazione possa essere verificata dall'attestatore configurato nel criterio.
Verifica che l'attestazione sia stata creata:
gcloud container binauthz attestations list \ --attestor=$ATTESTOR_NAME --attestor-project=$PROJECT_ID
Per saperne di più sulla creazione delle attestazioni, consulta Creazione delle attestazioni.
Ripeti il test delle norme.
Verifica di nuovo il criterio eseguendo il deployment di un'immagine container di esempio nel cluster.
Questa volta, devi eseguire il deployment dell'immagine utilizzando il digest anziché un tag come
1.0
o latest
, poiché Autorizzazione binaria utilizzerà il digest per cercare le
attestazioni. Qui, Autorizzazione binaria consente il deployment dell'immagine perché è stata effettuata l'attestazione richiesta.
Per eseguire il deployment dell'immagine:
kubectl run hello-server --image ${IMAGE_TO_ATTEST} --port 8080
Per verificare che sia stato eseguito il deployment dell'immagine:
kubectl get pods
Il comando stampa un messaggio simile al seguente, che indica che il deployment è riuscito:
NAME READY STATUS RESTARTS AGE hello-server-579859fb5b-h2k8s 1/1 Running 0 1m
Esegui la pulizia
Per evitare che al tuo Account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questo tutorial, elimina il progetto che contiene le risorse oppure mantieni il progetto ed elimina le singole risorse.
Elimina il cluster che hai creato in GKE:
gcloud container clusters delete \ --zone=us-central1-a \ test-cluster
Passaggi successivi
- Scopri di più su Autorizzazione binaria
- Scopri i concetti chiave utilizzati in Autorizzazione binaria
- Utilizza l'attestatore
built-by-cloud-build
per eseguire il deployment solo delle immagini create da Cloud Build (anteprima). - Abilita la modalità di prova per disabilitare l'applicazione
- Utilizzare il deployment di emergenza per bypassare l'applicazione forzata