Documentação do Oracle Cloud Infrastructure

Chaves e OCIDs Necessários

Quer você esteja usando um cliente Oracle (consulte SDKs (Software Development Kits) e a CLI (Command Line Interface)) ou um cliente criado por você mesmo, faça o seguinte:

  1. Crie um usuário no serviço IAM para a pessoa ou para o sistema que chamará a API e coloque esse usuário em pelo menos um grupo do serviço IAM com as permissões necessárias. Consulte Adicionando Usuários. Você poderá ignorar essa opção se o usuário já existir.

  2. Obtenha estes itens:

  3. Faça o upload da chave pública do par de chaves na Console. Consulte Como Fazer o Upload da Chave Pública.
    Observação

    Recomendamos adicionar uma tag a cada chave privada.
  4. Se você estiver usando um dos SDKs ou uma das ferramentas da Oracle, forneça as credenciais necessárias listadas acima em um arquivo de configuração ou um objeto de configuração no código. Consulte Arquivo de Configuração da CLI e do SDK. Se, em vez disso, você estiver criando o seu próprio cliente, consulte Assinaturas das Solicitações.
Importante

Esse par de chaves não é a chave SSH usada para acessar instâncias de computação. Consulte Credenciais de Segurança.

A chave privada e a chave pública devem estar no formato PEM (não no formato SSH-RSA). A chave pública no formato PEM é semelhante a esta:

-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQE...
...
-----END PUBLIC KEY-----
OCI_PRIVATE_KEY

Recomendamos que você inclua um rótulo no final da chave. Por exemplo, OCI_PRIVATE_KEY.

Como Gerar uma Chave de Assinatura de API

Observação

Você pode usar a Console ou as ferramentas de linha de comando disponíveis para Linux, Mac OS ou Windows para gerar uma chave de assinatura de API.

Gerando uma Chave de Assinatura de API (Console)

Você pode usar a Console para gerar o par chaves pública/privada para você. Caso já tenha um par de chaves, poderá optar por fazer upload da chave pública. Quando você usa a Console para adicionar o par de chaves, a Console também gera um snippet de visualização do arquivo de configuração para você.

Os procedimentos a seguir funciona para um usuário comum ou um administrador. Os administradores podem gerenciar chaves de API para outro usuário ou para si mesmos.

Sobre o Snippet do Arquivo de Configuração

Quando você usa a Console para adicionar o par de chaves de assinatura de API, um snippet de visualização do arquivo de configuração é gerado com as seguintes informações:

  • user - o OCID do usuário para quem o par de chaves está sendo adicionado.
  • fingerprint - a impressão digital da chave que acabou de ser adicionada.
  • tenancy - OCID da sua tenancy.
  • region - a região atualmente selecionada na Console.
  • key_file- o caminho para o arquivo de chave privada baixado. Atualize esse valor para o caminho no sistema de arquivos em que salvou o arquivo de chave privada.

Se o arquivo de configuração tiver um perfil PADRÃO, execute um dos seguintes procedimentos:

  • Substitua o perfil existente e seu conteúdo.
  • Renomeie o perfil existente.
  • Renomeie esse perfil para outro nome depois de colá-lo no arquivo de configuração.

Você pode copiar este snippet em seu arquivo de configuração para ajuda inicial. Se você ainda não tiver um arquivo de configuração, consulte Arquivo de Configuração do SDK e da CLI para obter detalhes sobre como criar um. Você também poderá recuperar o snippet do arquivo de configuração posteriormente para uma chave de assinatura de API sempre que precisar. Consulte: Para obter o snippet do arquivo de configuração de uma chave de assinatura de API.

Para gerar um par de chaves de assinatura de API

Pré-requisito: Antes de gerar um par de chaves, crie o diretório .oci no diretório home para armazenar as credenciais. Consulte Arquivo de Configuração do SDK e da CLI para obter mais detalhes.

  1. Exiba os detalhes do usuário:
    • Se estiver adicionando uma chave de API para você mesmo:

      Abra o menu Perfil e clique em Meu perfil.

    • Se você for um administrador que está adicionando uma chave de API para outro usuário: Abra o menu de navegação e clique em Identidade e Segurança. Em Identidade, clique em Usuários. Localize o usuário na lista e clique no nome do usuário para exibir os detalhes.
  2. Na seção Recursos na parte inferior esquerda, clique em Chaves de API
  3. Clique em Adicionar Chave de API no canto superior esquerdo da lista Chaves de API. A caixa de diálogo Adicionar Chave de API é exibida.

  4. Clique em Fazer Download da Chave Privada e salve a chave no diretório .oci. Na maioria dos casos, você não precisa fazer download da chave pública.

    Observação: Se o browser fizer download da chave privada para outro diretório, certifique-se de movê-la para o diretório .oci.

  5. Clique em Adicionar.

    A chave é adicionada e a Visualização do Arquivo de Configuração é exibida. O snippet do arquivo inclui parâmetros e valores obrigatórios que você precisará para criar o arquivo de configuração. Copie e cole o snippet do arquivo de configuração da caixa de texto para ~/.oci/config file. (Se você ainda não tiver criado esse arquivo, consulte Arquivo de Configuração do SDK e da CLI para obter detalhes sobre como criar um.)

    Depois de colar o conteúdo do arquivo, você precisará atualizar o parâmetro key_file para o local onde salvou seu arquivo de chave privada.

    Se o arquivo de configuração tiver um perfil PADRÃO, execute um dos seguintes procedimentos:
    • Substitua o perfil existente e seu conteúdo.
    • Renomeie o perfil existente.
    • Renomeie esse perfil para outro nome depois de colá-lo no arquivo de configuração.
  6. Atualize as permissões no arquivo de chave privada baixado para que somente você possa exibi-lo:
    1. Vá para o diretório .oci no qual você colocou o arquivo de chave privada.
    2. Use o comando chmod go-rwx ~/.oci/<oci_api_keyfile>.pem para definir as permissões no arquivo.

Para fazer upload ou colar uma chave de API

Pré-requisito: Você gerou uma chave RSA pública no formato PEM (mínimo de 2048 bits). O formato PEM é semelhante a este:

-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoTFqF...
...
-----END PUBLIC KEY——
  1. Exiba os detalhes do usuário:
    • Se estiver adicionando uma chave de API para você mesmo:

      Abra o menu Perfil e clique em Meu perfil.

    • Se você for um administrador que está adicionando uma chave de API para outro usuário: Abra o menu de navegação e clique em Identidade e Segurança. Em Identidade, clique em Usuários. Localize o usuário na lista e clique no nome do usuário para exibir os detalhes.
  2. Na seção Recursos na parte inferior esquerda, clique em Chaves de API
  3. Clique em Adicionar Chave de API no canto superior esquerdo da lista Chaves de API. A caixa de diálogo Adicionar Chave de API é exibida.
  4. Na caixa de diálogo, selecione Escolher Arquivo de Chave Pública para fazer upload do arquivo ou Colar Chave Pública, se preferir colá-lo em uma caixa de texto
  5. Clique em Adicionar.

    A chave é adicionada e a Visualização do Arquivo de Configuração é exibida. O snippet do arquivo inclui parâmetros e valores obrigatórios que você precisará para criar o arquivo de configuração. Copie e cole o snippet do arquivo de configuração da caixa de texto para ~/.oci/config file. (Se você ainda não tiver criado esse arquivo, consulte Arquivo de Configuração do SDK e da CLI para obter detalhes sobre como criar um.)

    Depois de colar o conteúdo do arquivo, você precisará atualizar o parâmetro key_file para o local onde salvou seu arquivo de chave privada.

    Se o arquivo de configuração tiver um perfil PADRÃO, execute um dos seguintes procedimentos:

    • Substitua o perfil existente e seu conteúdo.
    • Renomeie o perfil existente.
    • Renomeie esse perfil para outro nome depois de colá-lo no arquivo de configuração.
Para obter o snippet do arquivo de configuração para uma chave de assinatura de API
O procedimento a seguir funciona para um usuário regular ou um administrador.
  1. Exiba os detalhes do usuário:
    • Se você estiver obtendo um snippet de arquivo de configuração de chave de API para você mesmo:

      Abra o menu Perfil e clique em Meu perfil.

    • Se você for um administrador que está obtendo um snippet do arquivo de configuração da chave de API para outro usuário: Abra o menu de navegação e clique em Identidade e Segurança. Em Identidade, clique em Usuários. Localize o usuário na lista e clique no nome do usuário para exibir os detalhes.
  2. Na seção Recursos, na parte inferior esquerda, clique em Chaves de API
  3. No lado esquerdo da página, clique em Chaves de API. A lista de impressões digitais de chave de API é exibida.
  4. Clique no menu Ações (Menu Ações) da impressão digital e selecione Exibir arquivo de configuração.

    A Visualização do Arquivo de Configuração é exibida. O snippet do arquivo inclui parâmetros e valores obrigatórios que você precisará para criar o arquivo de configuração. Copie e cole o snippet do arquivo de configuração da caixa de texto para ~/.oci/config file. (Se você ainda não tiver criado esse arquivo, consulte Arquivo de Configuração do SDK e da CLI para obter detalhes sobre como criar um.) Depois de colar o conteúdo do arquivo, você precisará atualizar o parâmetro key_file para o local onde salvou seu arquivo de chave privada.

    Se o arquivo de configuração tiver um perfil PADRÃO, execute um dos seguintes procedimentos:
    • Substitua o perfil existente e seu conteúdo.
    • Renomeie o perfil existente.
    • Renomeie esse perfil para outro nome depois de colá-lo no arquivo de configuração.

Gerando uma Chave de Assinatura de API (Linux e Mac OS X)

Use os comandos do OpenSSL a seguir para gerar o par de chaves no formato PEM necessário.

  1. Se você não tiver feito isso ainda, crie um diretório .oci para armazenar as credenciais:

    mkdir ~/.oci

  2. Gere a chave privada com um dos comandos a seguir.

    • Para gerar a chave, criptografada com uma frase-senha que você fornece quando solicitado:
      Observação

      Recomendamos que você use uma frase-senha para sua chave.
      openssl genrsa -out ~/.oci/oci_api_key.pem -aes128 2048

    • Para gerar a chave sem uma frase-senha:

      openssl genrsa -out ~/.oci/oci_api_key.pem 2048

  3. Altere a permissão do arquivo para garantir que somente você possa ler o arquivo de chaves privadas:

    chmod go-rwx ~/.oci/oci_api_key.pem

  4. Gere a chave pública com base em sua nova chave privada:

    openssl rsa -pubout -in ~/.oci/oci_api_key.pem -out ~/.oci/oci_api_key_public.pem

  5. Copie o conteúdo da chave pública para a área de transferência usando pbcopy, xclip ou uma ferramenta semelhante (você precisará colar o valor na Console posteriormente). Por exemplo:

    cat ~/.oci/oci_api_key_public.pem | pbcopy

As suas solicitações de API serão assinadas com a sua chave privada, e o sistema Oracle usará a chave pública para verificar a autenticidade da solicitação. Você deve fazer o upload da chave pública para o serviço IAM (instruções abaixo).

Gerando uma Chave de Assinatura de API (Windows)

Se você estiver usando o Windows, será necessário instalar o Git Bash for Windows antes de executar os comandos a seguir.
Observação

Certifique-se de incluir o binário openssl no caminho do Windows. Nas instalações padrão, o arquivo openssl.exe pode ser encontrado em C:\Program Files\Git\mingw64\bin.

Use os comandos do OpenSSL a seguir para gerar o par de chaves no formato PEM necessário.

  1. Caso ainda não tenha feito isso, crie um diretório .oci para armazenar as credenciais. Por exemplo:

    mkdir %HOMEDRIVE%%HOMEPATH%\.oci

  2. Gere a chave privada com um dos comandos a seguir:

    • Para gerar a chave que é criptografada com uma frase-senha que você fornece quando solicitado:
      Observação

      Recomendamos que você use uma frase-senha para sua chave.
      openssl genrsa -out %HOMEDRIVE%%HOMEPATH%\.oci\oci_api_key.pem -aes128 -passout stdin 2048

    • Para gerar a chave sem uma frase-senha:

      openssl genrsa -out %HOMEDRIVE%%HOMEPATH%\.oci\oci_api_key.pem 2048

  3. Gere a chave pública com base em sua nova chave privada:

    openssl rsa -pubout -in %HOMEDRIVE%%HOMEPATH%\.oci\oci_api_key.pem -out %HOMEDRIVE%%HOMEPATH%\.oci\oci_api_key_public.pem

  4. Copie o conteúdo da chave pública para a área de transferência (será necessário colar o valor na Console posteriormente). Por exemplo:

    type \.oci\oci_api_key_public.pem

As suas solicitações de API serão assinadas com a sua chave privada, e o sistema Oracle usará a chave pública para verificar a autenticidade da solicitação. Você deve fazer o upload da chave pública para o serviço IAM (instruções abaixo).

Como Obter a Impressão Digital da Chave

Você pode obter a impressão digital da chave com o comando do OpenSSL a seguir.

Para Linux e Mac OS X:

openssl rsa -pubout -outform DER -in ~/.oci/oci_api_key.pem | openssl md5 -c
Para Windows:
Observação

Se você estiver usando o Windows, instale o Git Bash for Windows e execute o comando com essa ferramenta.
openssl rsa -pubout -outform DER -in \.oci\oci_api_key.pem | openssl md5 -c

Quando você faz o upload da chave pública na Console, a impressão digital também é exibida automaticamente. Esse valor pode ser semelhante a: 12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef

Onde Obter o OCID da Tenancy e o OCID do Usuário

Ambos os OCIDs estão na Console, que pode ser acessada: https://cloud.oracle.com. Se você não tiver um login e uma senha para a Console, entre em contato com um administrador. Se você não estiver familiarizado com OCIDs, consulte Identificadores de Recursos.

OCID da Tenancy

Obtenha o OCID da tenancy na Console do Oracle Cloud Infrastructure na página Detalhes da Tenancy:

  1. Selecione o menu Perfil (Ícone do menu Perfil), que está no lado superior direito da barra de navegação na parte superior da página, e clique em Tenancy: <your_tenancy_name>.

  2. O OCID da tenancy é mostrado em Informações da Tenancy. Clique em Copiar para copiá-lo para a área de transferência.

OCID do Usuário

Obtenha o OCID do usuário na Console, na página que mostra os detalhes do usuário. Para chegar a essa página:

  • Se você tiver acessado como usuário:

    Abra o menu Perfil e clique em Meu Perfil.

  • Se você for um administrador que está fazendo isso para outro usuário: Abra o menu de navegação e clique em Identidade e Segurança. Em Identidade, clique em Usuários. Selecione o usuário na lista.
  • O OCID do usuário é mostrado em Informações do Usuário. Clique em Copiar para copiá-lo para a área de transferência.

Como Fazer o Upload da Chave Pública

Você pode fazer upload da chave pública PEM na Console, que pode ser acessada aqui: https://cloud.oracle.com.
Observação

Se você não tiver um log-in e uma senha para a Console ou não estiver vendo um menu Perfil, entre em contato com um administrador.
  1. Abra a Console, e acesse o sistema.

  2. Exiba os detalhes do usuário que vai chamar a API com o par de chaves:

    • Se você tiver acessado como usuário:

      Abra o menu Profile e clique em My Profile.

    • Se você for um administrador que está fazendo isso para outro usuário: Abra o menu de navegação e clique em Identidade e Segurança. Em Identidade, clique em Usuários. Selecione o usuário na lista.
  3. Na seção Recursos na parte inferior esquerda, clique em Chaves de API
  4. Clique em Adicionar Chave de API no canto superior esquerdo da lista Chaves de API. A caixa de diálogo Adicionar Chave de API é exibida.
  5. Selecione o botão de opção Colar uma chave pública.
  6. Cole o conteúdo da chave pública do PEM na caixa de diálogo e clique em Adicionar.

A impressão digital da chave é exibida (por exemplo, 12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef).

Observe que após o upload da sua primeira chave pública, você também poderá usar a operação da API UploadApiKey para fazer o upload de chaves adicionais. Você pode ter até três pares de chaves de API por usuário. Em uma solicitação de API, você especifica a impressão digital da chave para indicar qual chave está sendo usada para assinar a solicitação.