Configura l'autenticazione per Go

L'autenticazione ad Artifact Registry è diversa per il caricamento e il download di moduli Go in pacchetti. Durante la pacchettizzazione e il caricamento di un modulo Go in Artifact Registry, lo strumento gcloud CLI cerca le credenziali nel tuo ambiente per configurare l'autenticazione nel seguente ordine, a meno che il flag --json_key non venga passato per utilizzare una chiave dell'account di servizio.

  1. Credenziali predefinite dell'applicazione (ADC), una strategia che cerca le credenziali nel seguente ordine:

    1. Credenziali definite nella variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS.

    2. Credenziali fornite dall'account di servizio predefinito per Compute Engine, Google Kubernetes Engine, Cloud Run, App Engine o Cloud Functions.

  2. Credenziali fornite da Google Cloud CLI, incluse le credenziali utente del comando gcloud auth application-default login.

La variabile GOOGLE_APPLICATION_CREDENTIALS rende l'account esplicito per l'autenticazione, il che semplifica la risoluzione dei problemi. Se non utilizzi la variabile, verifica che tutti gli account che ADC potrebbe utilizzare abbiano le autorizzazioni richieste. Ad esempio, l'account di servizio predefinito per le VM di Compute Engine, i nodi di Google Kubernetes Engine e le revisioni Cloud Run ha accesso di sola lettura ai repository. Se intendi caricare da questi ambienti utilizzando l'account di servizio predefinito, devi modificare le autorizzazioni.

Durante il download dei moduli Go pacchettizzati da utilizzare come dipendenze da Artifact Registry, il file binario Go utilizza le credenziali nel file netrc per eseguire l'autenticazione in Artifact Registry. Per semplificare il processo di autenticazione, puoi utilizzare l'assistente per le credenziali Go per aggiornare i token nel file netrc per l'autenticazione in Artifact Registry.

La posizione del file netrc può essere impostata con la variabile di ambiente netrc. Se la variabile NETRC non è impostata, il comando go leggerà $HOME/.netrc su piattaforme simili a UNIX o %USERPROFILE%\_netrc su Windows.

Quando utilizzi le credenziali nel file netrc, Artifact Registry supporta i seguenti metodi di autenticazione:

Credenziali di breve durata (consigliato)
Utilizza lo strumento di supporto delle credenziali di Artifact Registry per aggiornare i token di autenticazione nel file netrc utilizzando le credenziali del tuo ambiente oppure aggiungi manualmente le credenziali di Artifact Registry al file netrc.
Usa una chiave dell'account di servizio
Utilizza questa opzione quando non puoi utilizzare le credenziali nel tuo ambiente per l'autenticazione. Puoi utilizzare lo strumento di supporto delle credenziali Go di Artifact Registry per aggiungere la chiave dell'account di servizio non criptata al file netrc o aggiungerla manualmente al file.

Prima di iniziare

  1. Installa Go 1.15 o versioni successive.
  2. Installa il componente aggiuntivo gcloud CLI package-go-module:

    gcloud components install package-go-module

configura l'ambiente Go

  1. Indica Go per scaricare i moduli da Artifact Registry, dal proxy del modulo Go pubblico, e quindi per eseguire l'origine in questo ordine:

      export GOPROXY=https://LOCATION-go.pkg.dev/PROJECT/REPOSITORY,https://proxy.golang.org,direct
    

    Sostituisci quanto segue:

    • LOCATION è la località a livello di una o più regioni del repository.
    • PROJECT è il tuo ID progetto Google Cloud.
    • REPOSITORY è il nome del repository in cui è archiviato il pacchetto.
  2. Escludi il modulo dal controllo utilizzando il database di checksum pubblico:

      export GONOSUMDB=MODULE_PATH_REGEX
    

    Sostituisci MODULE_PATH_REGEX con il percorso del modulo o con un'espressione regolare se vuoi escludere più moduli.

    Ad esempio, per escludere il modulo example.com/foo dal controllo utilizzando il database di checksum pubblico, esegui questo comando:

      export GONOSUMDB=example.com/foo
    

    Il seguente comando esclude che tutti i moduli con percorsi dei moduli che iniziano in example.com vengano controllati utilizzando il database di checksum pubblico:

      export GONOSUMDB=example.com/*
    

Aggiungi le credenziali Artifact Registry al file netrc

  1. Esegui questo comando per aggiungere le tue credenziali Artifact Registry al file netrc con l'helper credenziali Go:

      GOPROXY=proxy.golang.org \
          go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@v0.1.0 \
          add-locations --locations=LOCATION \
          --json_key=PATH_TO_JSON_KEY
    

    Dove:

    • LOCATION è la località regionale o multiregionale del tuo repository. Per aggiungere più località, inseriscile come elenco separato da virgole.
    • PATH_TO_JSON_KEY Facoltativa. Il percorso della chiave dell'account di servizio.

      L'assistente per le credenziali di Go aggiunge impostazioni al tuo file netrc per l'autenticazione in Artifact Registry. Se passi il flag --json_key, la chiave viene aggiunta al file netrc per l'autenticazione tramite password.

  2. Se utilizzi credenziali di breve durata per l'autenticazione in Artifact Registry, dovrai aggiornare il token OAuth eseguendo questo comando prima di utilizzare il modulo come dipendenza:

      GOPROXY=proxy.golang.org \
      go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@v0.1.0 refresh
    

Autenticazione con una chiave dell'account di servizio

Utilizza questo approccio quando richiedi l'autenticazione con nome utente e password.

Le chiavi dell'account di servizio sono credenziali di lunga durata. Usa le linee guida seguenti per limitare l'accesso ai tuoi repository:

  • Valuta la possibilità di utilizzare un account di servizio dedicato per interagire con i repository.
  • Concedi il ruolo Artifact Registry minimo richiesto dall'account di servizio. Ad esempio, assegna Artifact Registry Reader a un account di servizio che scarica solo gli artefatti.
  • Se i gruppi della tua organizzazione richiedono livelli di accesso diversi a repository specifici, concedi l'accesso a livello di repository anziché a livello di progetto.
  • Segui le best practice per la gestione delle credenziali.

Per configurare l'autenticazione:

  1. Crea un account di servizio per agire per conto della tua applicazione o scegli un account di servizio esistente da utilizzare per l'automazione.

    Per configurare l'autenticazione con Artifact Registry, avrai bisogno della posizione del file delle chiavi dell'account di servizio. Per gli account esistenti, puoi visualizzare le chiavi e crearne di nuove nella pagina Account di servizio.

    Vai alla pagina Account di servizio

  2. Concedi il ruolo Artifact Registry appropriato all'account di servizio per fornire l'accesso al repository.

  3. Esegui questo comando per aggiungere le credenziali dell'account di servizio al file netrc con l'helper delle credenziali Go:

      GOPROXY=proxy.golang.org \
          go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@v0.1.0 \
          add-locations --locations=LOCATION \
          --json_key=PATH_TO_JSON_KEY
    

    Dove:

    • LOCATION è la località regionale o multiregionale del tuo repository. Per aggiungere più località, inseriscile come elenco separato da virgole.
    • PATH_TO_JSON_KEY è il percorso del file di chiavi JSON dell'account di servizio.

      L'assistente per le credenziali Go aggiunge la chiave dell'account di servizio al file netrc per l'autenticazione della password.

È anche possibile aggiungere manualmente la chiave dell'account di servizio al file netrc nel seguente formato:

machine LOCATION.pkg.dev
login json_key_base64
password KEY

Sostituisci quanto segue:

  • LOCATION con la località a livello di una o più regioni del tuo repository.
  • KEY con la chiave con codifica base64 nel file della chiave dell'account di servizio.

Aggiungi l'assistente per le credenziali Go a GONOPROXY

Prima di utilizzare l'assistente per le credenziali Go, devi aggiungerlo all'elenco GONOPROXY per forzarne il download direttamente da GitHub. Se vuoi scaricare altri moduli direttamente dall'origine, puoi aggiungerli in un elenco separato da virgole, come mostrato nell'esempio seguente:

  export GONOPROXY=MODULE_PATH1, MODULE_PATH2

Dove MODULE_PATH1 e MODULE_PATH2 sono percorsi dei moduli da scaricare dall'origine.

Per aggiungere l'assistente per le credenziali Go al tuo elenco GONOPROXY ed eseguirlo per configurare le tue credenziali:

  1. Aggiungi l'assistente per le credenziali Go a GONOPROXY

      export GONOPROXY=github.com/GoogleCloudPlatform/artifact-registry-go-tools
    
  2. Esegui questo comando per aggiungere le tue credenziali Artifact Registry al file netrc con lo strumento del pacchetto del modulo Go:

      GOPROXY=proxy.golang.org \
          go run github.com/GoogleCloudPlatform/artifact-registry-go-tools/cmd/auth@v0.1.0 \
          add-locations --locations=LOCATION \
          [--json_key=path/to/service/account/key.json]
    

    Dove LOCATION è la località a livello di una o più regioni del tuo repository. Per aggiungere più località, inseriscile come elenco separato da virgole.

    L'assistente per le credenziali di Go aggiunge impostazioni al tuo file netrc per l'autenticazione in Artifact Registry. Se passi il flag --json_key, la chiave viene aggiunta al tuo file netrc per l'autenticazione tramite password.

Passaggi successivi