Autenticazione con OpenID Connect (OIDC)

Scopri come configurare GKE su AWS in modo da utilizzare OpenID Connect (OIDC) per l'autenticazione ai cluster utente. Questo argomento illustra la procedura per configurare GKE su AWS con qualsiasi provider OpenID.

Per eseguire l'upgrade di un cluster che utilizza l'autenticazione OIDC a Kubernetes 1.21, consulta Eseguire l'upgrade a 1.21.

Per una panoramica del flusso di autenticazione di GKE su AWS, consulta Autenticazione.

Panoramica

GKE su AWS supporta OIDC come uno dei meccanismi di autenticazione per interagire con il server API Kubernetes di un cluster utente. Con OIDC, puoi gestire l'accesso ai cluster Kubernetes utilizzando le procedure standard della tua organizzazione per creare, attivare e disattivare gli account utente.

Prima di iniziare

• Questo argomento presuppone che tu abbia familiarità con i seguenti concetti di autenticazione e OpenID:

  • OAuth 2.0
  • OpenID Connect
  • ambiti
  • claims

• L'interfaccia a riga di comando Google Cloud deve essere installata sulla macchina locale di ogni sviluppatore.

• I sistemi headless non sono supportati. Per autenticarti, devi aprire un browser sulla macchina locale su cui è in esecuzione gcloud CLI. Il browser ti chiede di autorizzare il tuo account utente.

• Per eseguire l'autenticazione tramite la Google Cloud console, ogni cluster che vuoi configurare per l'autenticazione OIDC deve essere registrato in Google Cloud.

Utenti tipo

Questo argomento fa riferimento a tre persone:

• Amministratore dell'organizzazione: questa persona sceglie un provider OpenID e registra le applicazioni client con il provider.

• Amministratore del cluster: questa persona crea uno o più cluster utente e crea file di configurazione dell'autenticazione per gli sviluppatori che utilizzano i cluster.

• Sviluppatore: questa persona esegue carichi di lavoro su uno o più cluster e utilizza OIDC per l'autenticazione.

Scegli un provider OpenID

Questa sezione è rivolta agli amministratori dell'organizzazione.

Puoi utilizzare qualsiasi provider OpenID a tua scelta. Per un elenco dei fornitori certificati, consulta la Certificazione OpenID.

Creare URL di reindirizzamento

Questa sezione è rivolta agli amministratori dell'organizzazione.

Il provider OpenID utilizza gli URL di reindirizzamento per restituire i token ID. Devi creare URL di reindirizzamento sia per gcloud CLI sia per la consoleGoogle Cloud .

Impostare l'URL di reindirizzamento della gcloud CLI

Quando configuri il provider OpenID, specifica l'URL di reindirizzamento della CLI comehttp://localhost:PORT/callback

Sostituisci PORT con il numero di porta maggiore di 1024.

Imposta l' Google Cloud URL di reindirizzamento della console

L'URL di reindirizzamento per la Google Cloud console è:

https://console.cloud.google.com/kubernetes/oidc

Quando configuri il provider OIDC, specifica https://console.cloud.google.com/kubernetes/oidc come uno dei tuoi URL di reindirizzamento.

Registra le tue applicazioni client con il provider OpenID

Questa sezione è rivolta agli amministratori dell'organizzazione.

Prima che gli sviluppatori possano utilizzare Google Cloud CLI o la Google Cloud console con il tuo provider OpenID, devi registrare questi due client con il provider OpenID. La registrazione include i seguenti passaggi:

• Scopri l'URI dell'emittente del tuo fornitore. La gcloud CLI o la consoleGoogle Cloud invia richieste di autenticazione a questo URI.

• Configura il tuo provider con l'URL di reindirizzamento, incluso il numero di porta, per gcloud CLI.

• Configura il tuo provider con l'URL di reindirizzamento per la Google Cloud console, https://console.cloud.google.com/kubernetes/oidc.

• Crea un singolo ID client che il tuo provider utilizza per identificare sia Google Cloud CLI sia la consoleGoogle Cloud .

• Crea un singolo client secret che l'gcloud CLI e la Google Cloud console utilizzano per effettuare l'autenticazione al provider OpenID.

• Crea un ambito personalizzato che gcloud CLI o Google Cloud Console puoi utilizzare per richiedere i gruppi di sicurezza dell'utente.

• Crea un nome di rivendicazione personalizzato utilizzato dal provider per restituire i gruppi di sicurezza dell'utente.

Configura il cluster

Questa sezione è rivolta agli amministratori di cluster.

Per configurare l'autenticazione OIDC, devi configurare la risorsa AWSCluster del cluster utente con i dettagli di autenticazione per un cluster. I dettagli di AWSCluster vengono utilizzati per configurare OIDC sia per la Google Cloud console sia per il plug-in di autenticazione per GKE Enterprise. La configurazione include le seguenti informazioni OIDC:

authentication:
  awsIAM:
    adminIdentityARNs:
      - AWS_IAM_ARN
  oidc:
  -   certificateAuthorityData: CERTIFICATE_STRING
      clientID: CLIENT_ID
      clientSecret: CLIENT_SECRET 
      extraParams:  EXTRA_PARAMS
      groupsClaim:  GROUPS_CLAIM
      groupPrefix:  GROUP_PREFIX
      issuerURI:  ISSUER_URI
      kubectlRedirectURI:  KUBECTL_REDIRECT_URI
      scopes:  SCOPES
      userClaim:  USER_CLAIM
      userPrefix:  USER_PREFIX

Campi di autenticazione

La tabella seguente descrive i campi dell'oggetto authentication.awsIAM.adminIdentityARNs.

Esempio: autorizzazione di utenti e gruppi

Molti provider codificano in un token le proprietà che consentono di identificare l'utente, ad esempio l'email e gli ID utente. Tuttavia, queste proprietà presentano rischi impliciti per le norme di autenticazione:

• Gli ID utente possono rendere i criteri difficili da leggere e controllare.
• L'utilizzo degli indirizzi email può comportare sia un rischio di disponibilità (se un utente cambia il proprio indirizzo email principale) sia un rischio per la sicurezza (se un indirizzo email può essere riassegnato).

Anziché assegnare ID utente, consigliamo i criteri di gruppo, che possono essere sia permanenti sia più facili da controllare.

Supponiamo che il tuo provider crei token di identità che includono i seguenti campi:

{
  'iss': 'https://server.example.com'
  'sub': 'u98523-4509823'
  'groupList': ['developers@example.corp', 'us-east1-cluster-admins@example.corp']
  ...
}

Dato questo formato del token, compila la specifica oidc del file di configurazione nel seguente modo:

issuerURL: 'https://server.example.com'
username: 'sub'
usernamePrefix: 'uid-'
group: 'groupList'
groupPrefix: 'gid-'
extraParams: 'resource=token-groups-claim'
...

Dopo aver creato il cluster utente, utilizza il controllo degli accessi basato su ruoli (RBAC) di Kubernetes per concedere l'accesso privilegiato agli utenti autenticati.

Nell'esempio seguente, crei un ClusterRole che concede ai suoi utenti l'accesso di sola lettura ai secret del cluster e una risorsa ClusterRoleBinding per associare il ruolo al gruppo autenticato.

1. Definisci un ClusterRole. Copia il seguente codice YAML in un file denominato secret-reader-role.yaml.

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRole
   metadata:
     name: secret-reader
   rules:
   - apiGroups: [""]
     # The resource type for which access is granted
     resources: ["secrets"]
     # The permissions granted by the ClusterRole
     verbs: ["get", "watch", "list"]
   

2. Definisci un ClusterRoleBinding. Copia il seguente codice YAML in un file denominato secret-reader-admins.yaml.

   apiVersion: rbac.authorization.k8s.io/v1
   kind: ClusterRoleBinding
   metadata:
     name: read-secrets-admins
   subjects:
     # Allows anyone in the "us-east1-cluster-admins" group to
     # read Secrets in any namespace within this cluster.
   - kind: Group
     name: gid-us-east1-cluster-admins # Name is case sensitive
     apiGroup: rbac.authorization.k8s.io
     # Allows this specific user to read Secrets in any
     # namespace within this cluster
   - kind: User
     name: uid-u98523-4509823
     apiGroup: rbac.authorization.k8s.io
   roleRef:
     kind: ClusterRole
     name: secret-reader
     apiGroup: rbac.authorization.k8s.io
   

3. Applica secret-reader-role.yaml e secret-reader-admins.yaml al tuo cluster con kubectl.

   env HTTPS_PROXY=http://localhost:8118 \
     kubectl apply -f secret-reader-role.yaml && \
     kubectl apply -f secret-reader-admins.yaml
   

   Gli utenti a cui è stato concesso l'accesso in read-secrets-admins ora possono leggere i segreti nel tuo cluster.

Crea una configurazione di accesso

Questa sezione è rivolta agli amministratori di cluster.

Dopo aver creato un cluster utente, devi generare un file di configurazione per il cluster utilizzando gcloud anthos create-login-config.

1. Dalla directory anthos-aws, utilizza anthos-gke per cambiare contesto e passare al cluster di utenti.

   cd anthos-aws
   env HTTPS_PROXY=http://localhost:8118 \
     anthos-gke aws clusters get-credentials CLUSTER_NAME

   Sostituisci CLUSTER_NAME con il nome del cluster di utenti.

2. Crea la configurazione con gcloud anthos.

   gcloud anthos create-login-config --kubeconfig usercluster-kubeconfig
   

   Sostituisci usercluster-kubeconfig con il percorso del file kubeconfig del tuo cluster di utenti. Su Linux e macOS, per impostazione predefinita questo file si trova in ~/.kube/config.

Questo comando genera un file (kubectl-anthos-config.yaml) contenente le informazioni di configurazione utilizzate dagli sviluppatori per autenticarsi nel cluster con gcloud CLI. Non modificare questo file.

Per saperne di più sui contenuti di kubectl-anthos-config.yaml, consulta la appendice.

Distribuisci la configurazione di accesso

Distribuisci il file di configurazione agli utenti che devono autenticarsi nei tuoi cluster di utenti. Puoi distribuire la configurazione:

• Posiziona il file nella directory predefinita.
• Distribuzione sicura del file.
• Ospitare il file su un server HTTPS.

Directory predefinite della configurazione di accesso

Le posizioni predefinite per l'archiviazione del file di configurazione per ciascun sistema operativo sono:

Linux

$HOME/.config/google/anthos/kubectl-anthos-config.yaml, dove $HOME è la home directory dell'utente.

macOS

$HOME/Library/Preferences/google/anthos/kubectl-anthos-config.yaml, dove $HOME è la home directory dell'utente.

Finestre

%APPDATA%/google/anthos/kubectl-anthos-config.yaml, dove %APPDATA% è la directory dei dati dell'applicazione dell'utente.

Dopo aver distribuito la configurazione di accesso, gli sviluppatori possono configurare gcloud CLI per accedere al cluster.

Modificare il cluster dopo l'upgrade a Kubernetes 1.21

Dopo aver eseguito l'upgrade del cluster a Kubernetes 1.21, devi configurare GKE Identity Service e rimuovere le informazioni OIDC dalla configurazione del cluster. Per aggiornare la configurazione, svolgi i seguenti passaggi:

1. Segui i passaggi descritti in Eseguire l'upgrade del cluster.

2. Dalla directory anthos-aws, utilizza anthos-gke per cambiare contesto e passare al cluster di utenti.

   cd anthos-aws
   env HTTPS_PROXY=http://localhost:8118 \
     anthos-gke aws clusters get-credentials CLUSTER_NAME

   Sostituisci CLUSTER_NAME con il nome del cluster di utenti.

3. Apri il manifest che contiene AWSCluster in un editor di testo. Mantieni aperto il file e utilizza i valori dell'oggetto oidc per seguire i passaggi descritti in Configurazione dei cluster per GKE Identity Service.

4. Dalla directory anthos-aws, utilizza anthos-gke per cambiare contesto e passare al servizio di gestione.

   cd anthos-aws
   anthos-gke aws management get-credentials

5. Apri il file YAML che ha creato il tuo AWSCluster in un editor di testo. Se non hai il file YAML iniziale, puoi utilizzare kubectl edit.

   Modifica YAML

   Se hai seguito le istruzioni riportate in Creazione di un cluster utente, il file YAML si chiama cluster-0.yaml. Apri questo file in un editor di testo.

   kubectl edit

   Per utilizzare kubectl edit per modificare AWSCluster, esegui il seguente comando:

   env HTTPS_PROXY=http://localhost:8118 \
     kubectl edit awscluster cluster-name
   

   Sostituisci cluster-name con il tuo AWSCluster. Ad esempio, per modificare il cluster predefinito cluster-0, esegui il seguente comando:

   env HTTPS_PROXY=http://localhost:8118 \
     kubectl edit awscluster cluster-0
   

6. Elimina l'oggetto oidc dal file manifest del cluster.

7. Salva il file. Se utilizzi kubectl edit, kubectl applica le modifiche automaticamente. Se stai modificando il file YAML, applicalo al servizio di gestione con il seguente comando:

   env HTTPS_PROXY=http://localhost:8118 \
     kubectl apply -f cluster-0.yaml
   

   Il servizio di gestione aggiorna quindi AWSCluster.

Configurare gcloud per accedere al cluster

Questa sezione è rivolta a sviluppatori o amministratori di cluster.

Prerequisiti

Per completare questa sezione, devi completare quanto segue:

• Una configurazione di accesso.

• Una versione aggiornata dellgcloud CLI con i componenti anthos-auth.

  gcloud components update
  gcloud components install anthos-auth
  

• Verifica che gcloud CLI sia stata installata correttamente eseguendo il seguente comando, che dovrebbe rispondere con i dettagli degli argomenti richiesti e le opzioni disponibili.

  gcloud anthos auth
  

Esegui l'autenticazione al cluster

Puoi autenticarti nel cluster nei seguenti modi:

• Con lgcloud CLI sulla tua macchina locale.
• Con gcloud CLI su una macchina remota utilizzando un tunnel SSH.

• Con Connect sulla Google Cloud console.

gcloud anthos auth login --cluster CLUSTER_NAME

gcloud anthos auth login --cluster CLUSTER_NAME \
--user USERNAME --login-config ANTHOS_CONFIG_YAML \
--login-config-cert LOGIN_CONFIG_CERT_PEM \
--kubeconfig=KUBECONFIG --dry-run

env HTTPS_PROXY=http://localhost:8118 \
  kubectl get nodes --kubeconfig my.kubeconfig

ssh USERNAME@REMOTE_MACHINE -L LOCAL_PORT:localhost:REMOTE_PORT

gcloud anthos auth login --login-config AUTH_CONFIG_FILE

kubectl --kubeconfig USER_CLUSTER_KUBECONFIG get nodes

Aggiornamento della configurazione OIDC

Per aggiornare la configurazione OIDC nel cluster, utilizza il comando kubectl edit.

env HTTPS_PROXY=http://localhost:8118 \
  kubectl edit clientconfigs -n kube-public default

Lo strumento kubectl carica la risorsa ClientConfig nell'editor predefinito. Per aggiornare la configurazione, salva il file. Lo strumento kubectl aggiorna la risorsa ClientConfig nel cluster.

Per informazioni sui contenuti della risorsa ClientConfig, consulta la sezione seguente.

Appendice: configurazione di accesso di esempio

Di seguito è riportato un esempio kubectl-anthos-config.yaml. Questo esempio è incluso per comprendere i contenuti. Devi sempre generare il file con gcloud anthos create-login-config.

apiVersion: authentication.gke.io/v2alpha1
kind: ClientConfig
metadata:
 name: default
 namespace: kube-public
spec:
  authentication:
  - name: oidc
    oidc:
      clientID: CLIENT_CONFIG
      clientSecret: CLIENT_SECRET
      extraParams: resource=k8s-group-claim,domain_hint=consumers
      certificateAuthorityData:   CERTIFICATE_STRING
      issuerURI: https://adfs.contoso.com/adfs
      kubectlRedirectURI: http://redirect.kubectl.com/
      scopes: allatclaim,group
      userClaim: "sub"
      groupsClaim: "groups"
    proxy: PROXY_URL #Optional
  certificateAuthorityData: CERTIFICATE_AUTHORITY_DATA
  name: projects/my-project/locations/global/membership/cluster-0
  server: https://192.168.0.1:PORT
  preferredAuthentication: oidc

Per spiegazioni dei contenuti dei campi, consulta Campi di autenticazione.

Passaggi successivi

Esegui il deployment del tuo primo carico di lavoro in GKE su AWS.