Configuration de l'authentification d'API pour OCI

Pour connecter un environnement local à une location OCI, configurez l'authentification d'API dans un fichier de configuration.

Généralités

Tâches clés :

  • Créez des clés d'API dans la console.
  • Configurez un fichier de configuration OCI pour l'authentification d'API à partir d'un environnement local.
  • Installer l'interface de ligne de commande OCI dans l'environnement local.

Pour plus d'informations, reportez-vous aux ressources suivantes :

Avant de commencer

Pour suivre ce tutoriel, vous devez avoir la configuration suivante en place.

  • Un navigateur pris en charge
  • Un environnement MacOS, Linux ou Windows avec le sous-système Windows pour Linux (WSL).
  • Python 3 est installé. Pour connaître les versions de Python prises en charge, reportez-vous à la documentation du kit SDK Python.
  • Python 3 est installé.
  • Effectuez le tutoriel Créer un utilisateur Sandbox pour les tutoriels et effectuez les opérations suivantes :
    • Préparez l'application Oracle Mobile Authenticator.
    • Notez les informations suivantes dans le tutoriel :
      • <nom_utilisateur_sandbox>
      • <mot de passe utilisateur-sandbox>
      • <nom-location>
      • <nom-domaine>
      • <compartiment du bac à sable>

1. Créer des clés d'API

Dans ce tutoriel, vous générez la paire de clés privée/publique pour l'utilisateur Sandbox dans la console. Lorsque vous utilisez la console pour ajouter la paire de clés, la console génère également pour vous un fragment de fichier d'aperçu de configuration.

  1. Connectez-vous à la console. Dans Nom du compte cloud, entrez <tenancy-name> et sélectionnez Suivant.
  2. Dans le champ Domaine d'identité, entrez <domain-name>. Par exemple, Par défaut, puis sélectionnez Suivant.
  3. Entrez <sandbox-username> et <sandbox-user-password>, puis sélectionnez Connexion.
  4. Ouvrez l'application Oracle Mobile Authenticator et, pour le compte <tenancy-name> <sandbox-username>, obtenez le code secret généré.
  5. Dans la console, dans la fenêtre Authentification à plusieurs facteurs, entrez le code secret et sélectionnez Connexion.
    Vous êtes dirigé vers la page d'accueil de la Console.
  6. Dans la barre de navigation supérieure, sélectionnez l'icône Profil, puis sélectionnez Paramètres utilisateur.
  7. Sélectionnez Jetons et clés.
  8. Sous Clés d'API, sélectionnez Ajouter une clé d'API.
  9. Générez ou fournissez des clés comme indiqué dans la boîte de dialogue.
    Important

    Si vous générez des clés, téléchargez les deux clés et enregistrez-les dans un emplacement sécurisé. Si vous perdez les clés, elles ne peuvent pas être recréées et vous devez les créer à nouveau.
  10. Sélectionnez Ajouter.
  11. Une boîte de dialogue affiche les paramètres de configuration. Copiez les informations de configuration dans un fichier de votre environnement local, appelé config, et enregistrez le fichier dans un fichier texte sécurisé.

Si vous avez besoin d'aide, reportez-vous à Clés et OCID requis pour la signature d'API.

2. Modifier les autorisations de clé

  1. Accédez au dossier dans lequel vous avez téléchargé les clés de la section précédente.
  2. (Facultatif) Modifiez le nom des clés. Par exemple, <sandbox-user-private-key.pem> et <sandbox-user-public-key.pem>.
  3. Depuis le terminal, accédez à votre répertoire personnel.
  4. Créez un répertoire .oci.
  5. Déplacez les clés publique et privée vers le répertoire .oci et notez <path-to-private-key.pem>.
    Exemple : <home-directory>/.oci/<sandbox-user-public-key.pem>
  6. Dans l'environnement local, modifiez le droit d'accès au fichier de clés privées à l'aide de la commande suivante :
    chmod 400 <path-to-private-key.pem>

4. Installer l'interface de ligne de commande OCI

  1. Installez l'interface de ligne de commande OCI et le kit SDK Python à l'aide de pip :
    pip install oci-cli

    Toutes les bibliothèques requises sont installées.

  2. Vérifiez que l'interface de ligne de commande OCI est installée. Entrez la commande suivante .
    pip list
    La commande répertorie les packages installés, y compris oci-cli. Par exemple :
    oci-cli                  <version>

4. Créer un fichier de configuration local

  1. Dans le répertoire .oci, entrez la commande suivante : touch config.
  2. Collez les données de configuration de clé d'API que vous avez copiées dans la section précédente dans le fichier config.

    Exemple de fichier config.

    [DEFAULT]
    user=<ocid1.user.oc1..xxx>
    fingerprint=<xx:xx:xx:xx>
    tenancy=<ocid1.tenancy.oc1..xxx>
    region=us-chicago-1
    key_file=<path-to-private-key.pem>       

    Cette configuration concerne le profil Default mentionné avec [Default].

5. Tester la configuration

Vérifiez que l'interface de ligne de commande OCI utilise le fichier de configuration et se connecte à votre location.
  1. Vérifiez que l'interface de ligne de commande OCI est installée.
    oci

    La commande répertorie les commandes disponibles pour la CLI.

  2. Vérifiez que le fichier de configuration fonctionne.
    oci os ns get

    Cette commande obtient l'espace de noms de la location.

    oci iam region list

    Cette commande répertorie les régions disponibles dans votre location.