Configurar o Login do SO

Neste documento, descrevemos como configurar o Login do SO e o Login do SO com autenticação de dois fatores (2FA, na sigla em inglês).

Com o Login do SO, você controla o acesso a instâncias de máquina virtual (VM) com base nas permissões do IAM. É possível usar o Login do SO com ou sem autenticação de dois fatores, mas não é possível usar esse recurso sem usar o Login do SO. Para saber mais sobre o Login do SO e a autenticação de dois fatores do Login do SO, incluindo quais tipos de desafio são compatíveis, consulte Sobre o Login do SO.

Antes de começar

  • Se você quiser usar a autenticação de dois fatores do Login do SO, ative o recurso no domínio ou na conta:
  • Configure a autenticação, caso ainda não tenha feito isso. A autenticação é o processo de verificação da sua identidade para acesso a serviços e APIs do Google Cloud. Para executar códigos ou amostras de um ambiente de desenvolvimento local, autentique-se no Compute Engine da seguinte maneira.

    Select the tab for how you plan to use the samples on this page:

    Console

    When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

    gcloud

    1. Install the Google Cloud CLI, then initialize it by running the following command: 

      gcloud init
    2. Set a default region and zone.

      3. Terraform

      Para usar os exemplos do Terraform nesta página em um ambiente de desenvolvimento local, instale e inicialize a gcloud CLI e, em seguida, configure o Application Default Credentials com suas credenciais de usuário.

      1. Install the Google Cloud CLI.

      2. To initialize the gcloud CLI, run the following command: 

        gcloud init

      3. If you're using a local shell, then create local authentication credentials for your user account: 

        gcloud auth application-default login

        You don't need to do this if you're using Cloud Shell.

      Confira mais informações em Set up authentication for a local development environment.

Limitações

As VMs a seguir não são compatíveis com o Login do SO:

Atribuir papéis do IAM para o Login do SO

Atribua todos os papéis do IAM necessários aos usuários que se conectam a VMs com o Login do SO ativado.

Papel Usuários obrigatórios Nível da concessão
roles/compute.osLogin ou roles/compute.osAdminLogin Todos os usuários

No projeto ou na instância.

Se um usuário precisar de acesso SSH pelo console do Google Cloud ou pela Google Cloud CLI, conceda esses papéis para envolvidos no projeto ou, de forma complementar, um papel para envolvidos no projeto que contenha a permissão compute.projects.get.
roles/iam.serviceAccountUser Todos os usuários, se a VM tiver uma conta de serviço Na conta de serviço.
roles/compute.osLoginExternalUser Usuários de uma organização diferente da VM a que estão se conectando

Na organização.

Esse papel precisa ser concedido por um administrador da organização.

Ativar a OS Login API

É possível ativar o Login do SO ou o Login do SO com a autenticação de dois fatores para uma única VM ou todas as VMs de um projeto. Basta definir os metadados do Login do SO.

Quando você define os metadados do Login do SO, o Compute Engine exclui os arquivos authorized_keys da VM e não aceita mais conexões das chaves SSH armazenadas nos metadados do projeto ou da instância.

Ativar o Login do SO para todas as VMs de um projeto

Para ativar o Login do SO em todas as VMs de um projeto, defina os seguintes valores nos metadados do projeto:

  1. Ative o Login do SO:
    • Chave: enable-oslogin
    • Valor: TRUE
  2. (Opcional) Ative a autenticação de dois fatores:
    • Chave: enable-oslogin-2fa
    • Valor: TRUE

Ativar o Login do SO para uma única VM

Para ativar o Login do SO em uma única VM, defina os seguintes valores nos metadados da instância:

  1. Ative o Login do SO:
    • Chave: enable-oslogin
    • Valor: TRUE
  2. (Opcional) Ative a autenticação de dois fatores:
    • Chave: enable-oslogin-2fa
    • Valor: TRUE

Ativar o Login do SO durante a criação da VM

Ative o Login do SO (opcionalmente, com a verificação em duas etapas) ao criar uma VM usando o console do Google Cloud ou a CLI gcloud.

Console

Crie uma VM que ativa o Login do SO e a autenticação de dois fatores do Login do SO na inicialização (opcional) criando uma VM a partir de uma imagem pública e especificando as seguintes configurações:

  1. Na seção Rede, discos, segurança, gerenciamento, locatário único, expanda a seção Segurança.
  2. Expanda a seção Gerenciar acesso.
  3. Selecione Controlar o acesso à VM pelas permissões do IAM.
  4. Opcional: se você quiser ativar a autenticação de dois fatores do Login do SO, selecione Exigir verificação em duas etapas.
  5. Clique em Criar para criar e iniciar a VM.

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Crie uma VM que ativa o Login do SO e a autenticação de dois fatores do Login do SO na inicialização (opcional) executando um dos seguintes comandos gcloud compute instance create:

    • Para ativar apenas o Login do SO, execute este comando:

      gcloud compute instances create VM_NAME \
 --image-family=IMAGE_FAMILY \
 --image-project=IMAGE_PROJECT \
 --metadata enable-oslogin=TRUE

    • Para ativar a autenticação de dois fatores do Login do SO, execute este comando:

      gcloud compute instances create VM_NAME \
 --image-family=IMAGE_FAMILY \
 --image-project=IMAGE_PROJECT \
 --metadata enable-oslogin=TRUE,enable-oslogin-2fa=TRUE

    Substitua:

    • VM_NAME: o nome da nova VM.
    • IMAGE_FAMILY: a família de imagens de um SO Linux. Isso cria a VM a partir da imagem do SO mais recente e não obsoleta. Para todas as famílias de imagens públicas, consulte Detalhes do sistema operacional.
    • IMAGE_PROJECT: o projeto de imagem que contém a família de imagens. Cada SO tem o próprio projeto de imagem. Para todos os projetos de imagem pública, consulte Detalhes do sistema operacional.

Terraform

É possível aplicar os valores de metadados a projetos ou VMs usando uma das seguintes opções:

  • Opção 1: defina enable-oslogin nos metadados de todo o projeto para que isso se aplique a todas as VMs nele.

    Use o recurso google_compute_project_metadata do Terraform e defina um valor de metadados em que oslogin=TRUE:

    compute/os_login/main.tf 
    resource "google_compute_project_metadata" "default" {
  metadata = {
    enable-oslogin = "TRUE"
  }
}

    Se preferir, defina enable-oslogin como FALSE para desativar o login do SO.

  • Opção 2: defina enable-oslogin nos metadados de uma VM nova ou atual.

    Use o recurso google_compute_instance do Terraform e defina oslogin=TRUE. Substitua oslogin_instance_name pelo nome da VM.

    compute/os_login/main.tf 
    resource "google_compute_instance" "oslogin_instance" {
  name         = "oslogin-instance-name"
  machine_type = "f1-micro"
  zone         = "us-central1-c"
  metadata = {
    enable-oslogin : "TRUE"
  }
  boot_disk {
    initialize_params {
      image = "debian-cloud/debian-11"
    }
  }
  network_interface {
    # A default network is created for all GCP projects
    network = "default"
    access_config {
    }
  }
}

    Se preferir, defina enable-oslogin como FALSE para impedir que a VM use o Login do SO.

Conectar-se a VMs com o Login do SO ativado

Conecte-se a VMs que têm o login do SO ativado usando os métodos descritos em Conectar-se a VMs do Linux.

Quando você se conecta a VMs com o Login do SO ativado, o Compute Engine usa o nome de usuário que o administrador da organização configurou para você. Se o administrador da organização não tiver configurado um nome de usuário, o Compute Engine gerará um nome de usuário no formato USERNAME_DOMAIN_SUFFIX. Para mais informações sobre nomes de usuários, consulte Como funciona o Login do SO.

Ao se conectar a VMs com a autenticação de dois fatores do Login do SO ativada, você também vê uma mensagem com base no método de verificação em duas etapas ou tipo de desafio selecionado. Para o método de solicitação no smartphone, aceite as mensagens no smartphone ou tablet para continuar. Para outros métodos, insira o código de segurança ou a senha única.

Solução de problemas do Login do SO

Para encontrar métodos de diagnóstico e resolução de erros do Login do SO, consulte Solução de problemas do Login do SO.

A seguir