Configura la autenticación para Go

Autenticar tu entorno de cliente con Artifact Registry te permite almacenar módulos de Go privados y recuperarlos como dependencias de compilación.

Opciones de autenticación

La configuración de la autenticación varía según si se suben o descargan paquetes.

Autenticación para cargas

Cuando empaquetas y subes un módulo de Go a Artifact Registry, la herramienta de gcloud CLI busca credenciales en tu entorno para configurar la autenticación en el siguiente orden, a menos que se pase la marca --json_key para usar una clave de cuenta de servicio.

  1. Las credenciales predeterminadas de la aplicación (ADC), que es una estrategia que busca credenciales en el siguiente orden:

    1. Credenciales definidas en la variable de entorno GOOGLE_APPLICATION_CREDENTIALS

    2. Credenciales que proporciona la cuenta de servicio predeterminada para Compute Engine, Google Kubernetes Engine, Cloud Run, App Engine o Cloud Run Functions.

  2. Credenciales proporcionadas por Google Cloud CLI, incluidas las credenciales de usuario del comando gcloud auth application-default login.

La variable GOOGLE_APPLICATION_CREDENTIALS hace que la cuenta para la autenticación sea explícita, lo que facilita la solución de problemas. Si no usas la variable, verifica que las cuentas que ADC podría usar tengan los permisos necesarios. Por ejemplo, la cuenta de servicio predeterminada para las VMs de Compute Engine, los nodos de Google Kubernetes Engine y las revisiones de Cloud Run tiene acceso de solo lectura a los repositorios. Si planeas subir contenido desde estos entornos con la cuenta de servicio predeterminada, debes modificar los permisos.

Autenticación para descargas

Cuando descargas módulos de Go empaquetados para usarlos como dependencias de Artifact Registry, el objeto binario de Go usa las credenciales de tu archivo netrc para autenticarse en Artifact Registry. Para simplificar el proceso de autenticación, puedes usar el auxiliar de credenciales de Go para actualizar los tokens en tu archivo netrc para la autenticación en Artifact Registry.

La ubicación de tu archivo netrc se puede establecer con la variable de entorno netrc. Si no se establece la variable NETRC, el comando go leerá $HOME/.netrc en plataformas similares a UNIX o %USERPROFILE%\_netrc en Windows.

Artifact Registry admite los siguientes métodos de autenticación cuando usas credenciales en tu archivo netrc:

Credenciales de corta duración (recomendado)
Usa la herramienta auxiliar de credenciales de Go de Artifact Registry para actualizar los tokens de autenticación en tu archivo netrc con las credenciales de tu entorno, o agrega manualmente tus credenciales de Artifact Registry al archivo netrc.
Usa una clave de cuenta de servicio
Usa esta opción cuando no puedas usar credenciales en tu entorno para la autenticación. Puedes usar la herramienta auxiliar de credenciales de Go de Artifact Registry para agregar la clave de cuenta de servicio sin encriptar a tu archivo netrc o agregarla de forma manual al archivo.

Antes de comenzar

  1. Instala Go 1.15 o una versión posterior.
  2. Instala el complemento de gcloud CLI package-go-module:

    gcloud components install package-go-module

Configura el entorno de Go

  1. Indica a Go que descargue módulos de Artifact Registry, el proxy de módulo de Go público y, luego, la fuente en ese orden:

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

    Reemplaza lo siguiente:

    • LOCATION es la ubicación regional o multirregional del repositorio.
    • PROJECT es el ID del proyecto de Google Cloud.
    • REPOSITORY es el nombre del repositorio en el que se almacena el paquete.
  2. Excluye tu módulo de la comprobación con la base de datos pública de sumas de comprobación:

      export GONOSUMDB=MODULE_PATH_REGEX
    

    Reemplaza MODULE_PATH_REGEX por la ruta de acceso de tu módulo o una expresión regular si quieres excluir varios módulos.

    Por ejemplo, para excluir el módulo example.com/foo de la comprobación con la base de datos pública de sumas de comprobación, ejecuta el siguiente comando:

      export GONOSUMDB=example.com/foo
    

    El siguiente comando excluye de la comprobación con la base de datos pública de sumas de comprobación todos los módulos con rutas de acceso que comienzan con example.com:

      export GONOSUMDB=example.com/*
    

Agrega credenciales de Artifact Registry a tu archivo netrc

  1. Ejecuta el siguiente comando para agregar tus credenciales de Artifact Registry a tu archivo netrc con el asistente de credenciales de Go:

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

    Aquí:

    • LOCATION es la ubicación regional o multirregional de tu repositorio. Para agregar varias ubicaciones, ingrésalas como una lista separada por comas.
    • PATH_TO_JSON_KEY (opcional): Es la ruta de acceso a la clave de tu cuenta de servicio.

      El asistente de credenciales de Go agrega parámetros de configuración a tu archivo netrc para autenticarte en Artifact Registry. Si pasas la marca --json_key, la clave se agrega a tu archivo netrc para la autenticación con contraseña.

  2. Si usas credenciales de corta duración para autenticarte en Artifact Registry, deberás actualizar tu token de OAuth ejecutando el siguiente comando antes de usar tu módulo como dependencia:

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

Autentica con una clave de cuenta de servicio

Usa este enfoque cuando necesites autenticación con un nombre de usuario y una contraseña.

Las claves de la cuenta de servicio son credenciales de larga duración. Usa los siguientes lineamientos para limitar el acceso a tus repositorios:

  • Considera usar una cuenta de servicio dedicada para interactuar con los repositorios.
  • Otorga la función mínima de Artifact Registry que requiera la cuenta de servicio. Por ejemplo, asigna la función de lector de Artifact Registry a una cuenta de servicio que solo descargue artefactos.
  • Si los grupos de tu organización requieren diferentes niveles de acceso a repositorios específicos, otorga acceso a nivel de repositorio en lugar de a nivel de proyecto.
  • Sigue las prácticas recomendadas para administrar credenciales.

Para configurar la autenticación, sigue estos pasos:

  1. Crea una cuenta de servicio que actúe en nombre de tu aplicación o elige una cuenta de servicio existente que uses para la automatización.

    Necesitarás la ubicación del archivo de claves de la cuenta de servicio para configurar la autenticación con Artifact Registry. En las cuentas existentes, puedes ver claves y crear claves nuevas en la página Cuentas de servicio.

    Ir a la página Cuentas de servicio

  2. Otorga el rol de Artifact Registry adecuado a la cuenta de servicio para proporcionar acceso al repositorio.

  3. Ejecuta el siguiente comando para agregar las credenciales de tu cuenta de servicio al archivo netrc con el auxiliar de credenciales de Go:

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

    Aquí:

    • LOCATION es la ubicación regional o multirregional de tu repositorio. Para agregar varias ubicaciones, ingrésalas como una lista separada por comas.
    • PATH_TO_JSON_KEY es la ruta de acceso al archivo de claves JSON de la cuenta de servicio.

      El asistente de credenciales de Go agrega la clave de la cuenta de servicio a tu archivo netrc para la autenticación con contraseña.

También puedes agregar de forma manual la clave de tu cuenta de servicio al archivo netrc con el siguiente formato:

machine LOCATION.pkg.dev
login _json_key_base64
password KEY

Reemplaza lo siguiente:

  • LOCATION por la ubicación regional o multirregional de tu repositorio.
  • KEY por la clave codificada en Base64 en el archivo de claves de tu cuenta de servicio.

Agrega el asistente de credenciales de Go a GONOPROXY

Antes de usar el asistente de credenciales de Go, debes agregarlo a la lista GONOPROXY para forzar a Go a descargarlo directamente desde GitHub. Si tienes otros módulos que quieres descargar directamente desde la fuente, puedes agregarlos en una lista separada por comas, como se muestra en el siguiente ejemplo:

  export GONOPROXY=MODULE_PATH1, MODULE_PATH2

Donde MODULE_PATH1 y MODULE_PATH2 son rutas de acceso de los módulos que se descargarán desde la fuente.

Para agregar el asistente de credenciales de Go a tu lista de GONOPROXY y ejecutarlo para configurar tus credenciales, haz lo siguiente:

  1. Agrega el asistente de credenciales de Go a tu GONOPROXY

      export GONOPROXY=github.com/GoogleCloudPlatform/artifact-registry-go-tools
    
  2. Ejecuta el siguiente comando para agregar tus credenciales de Artifact Registry a tu archivo netrc con la herramienta de paquetes de módulos de Go:

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

    Donde LOCATION es la ubicación regional o multirregional de tu repositorio. Para agregar varias ubicaciones, ingrésalas como una lista separada por comas.

    El asistente de credenciales de Go agrega parámetros de configuración a tu archivo netrc para autenticarte en Artifact Registry. Si pasas la marca --json_key, la clave se agrega a tu archivo netrc para la autenticación con contraseña.

¿Qué sigue?