S'authentifier avec Apple avec JavaScript

Vous pouvez permettre à vos utilisateurs de s'authentifier auprès de Firebase à l'aide de leur identifiant Apple en utilisant le SDK Firebase pour effectuer le flux de connexion OAuth 2.0 de bout en bout.

Avant de commencer

Pour permettre aux utilisateurs de se connecter avec Apple, configurez d'abord Se connecter avec Apple sur le site pour les développeurs d'Apple, puis activez Apple en tant que fournisseur de connexion pour votre projet Firebase.

Rejoindre l'Apple Developer Program

Seuls les membres de l'Apple Developer Program peuvent configurer Se connecter avec Apple.

Configurer Se connecter avec Apple

Sur le site pour les développeurs d'Apple, procédez comme suit :

1. Associez votre site Web à votre application, comme décrit dans la première section de Configurer Se connecter avec Apple pour le Web. Lorsque vous y êtes invité, enregistrez l' URL suivante comme URL de retour :

   https://YOUR_FIREBASE_PROJECT_ID.firebaseapp.com/__/auth/handler

   Vous trouverez l'ID de votre projet Firebase dans les settings Paramètres > Général tab de la Firebase console.

   Une fois que vous avez terminé, notez votre nouvel ID de service, dont vous aurez besoin dans la section suivante.

2. Créez une clé privée Se connecter avec Apple. Vous aurez besoin de votre nouvelle clé privée et de votre ID de clé dans la section suivante.

3. Si vous utilisez l'une des fonctionnalités de Firebase Authentication qui envoie des e-mails aux utilisateurs, y compris la connexion par lien, la validation d'adresse e-mail, la révocation de modification de compte, et autres, configurez le service de relais d'e-mails privés d'Apple et enregistrez noreply@YOUR_FIREBASE_PROJECT_ID.firebaseapp.com (ou le domaine de votre modèle d'e-mail personnalisé) afin qu'Apple puisse relayer les e-mails envoyés par Firebase Authentication vers des adresses e-mail Apple anonymisées.

Activer Apple en tant que fournisseur de connexion

1. Ajoutez Firebase à votre projet.
2. Dans la console Firebase, accédez à Sécurité > Authentification.
3. Dans l'onglet Méthode de connexion, activez le fournisseur de connexion Apple. Spécifiez l'ID de service que vous avez créé dans la section précédente. Dans la section Configuration du flux de code OAuth, spécifiez également votre ID d'équipe Apple, ainsi que la clé privée et l'ID de clé que vous avez créés dans la section précédente.

Respecter les exigences d'Apple concernant les données anonymisées

Se connecter avec Apple permet aux utilisateurs d'anonymiser leurs données, y compris leur adresse e-mail, lors de la connexion. Les utilisateurs qui choisissent cette option ont des adresses e-mail avec le domaine privaterelay.appleid.com. Lorsque vous utilisez Se connecter avec Apple dans votre application, vous devez respecter toutes les règles ou conditions applicables d'Apple concernant ces identifiants Apple anonymisés.

Cela inclut l'obtention de tout consentement utilisateur requis avant d'associer des informations personnelles permettant de vous identifier directement à un identifiant Apple anonymisé. Lorsque vous utilisez Firebase Authentication, cela peut inclure les actions suivantes :

• Associer une adresse e-mail à un identifiant Apple anonymisé ou inversement.
• Associer un numéro de téléphone à un identifiant Apple anonymisé ou inversement.
• Associer des identifiants sociaux non anonymes (Facebook, Google, etc.) à un identifiant Apple anonymisé ou inversement.

La liste ci-dessus n'est pas exhaustive. Consultez le contrat de licence de l'Apple Developer Program dans la section "Membership" (Adhésion) de votre compte de développeur pour vous assurer que votre application répond aux exigences d'Apple.

Gérer le flux de connexion avec le SDK Firebase

Si vous créez une application Web, le moyen le plus simple d'authentifier vos utilisateurs auprès de Firebase à l'aide de leurs comptes Apple consiste à gérer l'intégralité du flux de connexion avec le SDK JavaScript Firebase.

Pour gérer le flux de connexion avec le SDK JavaScript Firebase, procédez comme suit :

1. Créez une instance d'OAuthProvider à l'aide de l'ID de fournisseur correspondant apple.com.

   Web

   import { OAuthProvider } from "firebase/auth";
   
   const provider = new OAuthProvider('apple.com');
   auth_apple_provider_create.js

   Web

   var provider = new firebase.auth.OAuthProvider('apple.com');
   apple.js

2. Facultatif : Spécifiez des niveaux d'accès OAuth 2.0 supplémentaires au-delà de ceux par défaut que vous souhaitez demander au fournisseur d'authentification.

   Web

   provider.addScope('email');
   provider.addScope('name');
   auth_apple_provider_scopes.js

   Web

   provider.addScope('email');
   provider.addScope('name');
   apple.js

   Par défaut, lorsque l'option Un compte par adresse e-mail est activée, Firebase demande les niveaux d'accès "email" et "name". Si vous remplacez ce paramètre par Plusieurs comptes par adresse e-mail, Firebase ne demande aucun niveau d'accès à Apple sauf si vous les spécifiez.

3. Facultatif : Si vous souhaitez afficher l'écran de connexion d'Apple dans une autre langue que l'anglais, définissez le paramètre locale. Consultez la documentation Se connecter avec Apple pour connaître les paramètres régionaux compatibles.

   Web

   provider.setCustomParameters({
     // Localize the Apple authentication screen in French.
     locale: 'fr'
   });
   auth_apple_provider_params.js

   Web

   provider.setCustomParameters({
     // Localize the Apple authentication screen in French.
     locale: 'fr'
   });
   apple.js

4. Authentifiez-vous auprès de Firebase à l'aide de l'objet fournisseur OAuth. Vous pouvez inviter vos utilisateurs à se connecter avec leurs comptes Apple en ouvrant une fenêtre pop-up ou en les redirigeant vers la page de connexion. La méthode de redirection est préférable sur les appareils mobiles.

   • Pour vous connecter avec une fenêtre pop-up, appelez signInWithPopup() :

     Web

     import { getAuth, signInWithPopup, OAuthProvider } from "firebase/auth";
     
     const auth = getAuth();
     signInWithPopup(auth, provider)
       .then((result) => {
         // The signed-in user info.
         const user = result.user;
     
         // Apple credential
         const credential = OAuthProvider.credentialFromResult(result);
         const accessToken = credential.accessToken;
         const idToken = credential.idToken;
     
         // IdP data available using getAdditionalUserInfo(result)
         // ...
       })
       .catch((error) => {
         // Handle Errors here.
         const errorCode = error.code;
         const errorMessage = error.message;
         // The email of the user's account used.
         const email = error.customData.email;
         // The credential that was used.
         const credential = OAuthProvider.credentialFromError(error);
     
         // ...
       });
     auth_apple_signin_popup.js

     Web

     firebase
       .auth()
       .signInWithPopup(provider)
       .then((result) => {
         /** @type {firebase.auth.OAuthCredential} */
         var credential = result.credential;
     
         // The signed-in user info.
         var user = result.user;
     
         // You can also get the Apple OAuth Access and ID Tokens.
         var accessToken = credential.accessToken;
         var idToken = credential.idToken;
     
         // IdP data available using getAdditionalUserInfo(result)
       // ...
       })
       .catch((error) => {
         // Handle Errors here.
         var errorCode = error.code;
         var errorMessage = error.message;
         // The email of the user's account used.
         var email = error.email;
         // The firebase.auth.AuthCredential type that was used.
         var credential = error.credential;
     
         // ...
       });
     apple.js

   • Pour vous connecter en redirigeant vers la page de connexion, appelez signInWithRedirect() :

   Suivez les bonnes pratiques lorsque vous utilisez signInWithRedirect, linkWithRedirect, ou reauthenticateWithRedirect.

   Web

   import { getAuth, signInWithRedirect } from "firebase/auth";
   
   const auth = getAuth();
   signInWithRedirect(auth, provider);
   auth_apple_signin_redirect.js

   Web

   firebase.auth().signInWithRedirect(provider);
   apple.js

   Une fois que l'utilisateur s'est connecté et est revenu sur la page, vous pouvez obtenir le résultat de la connexion en appelant getRedirectResult() :

   Web

   import { getAuth, getRedirectResult, OAuthProvider } from "firebase/auth";
   
   // Result from Redirect auth flow.
   const auth = getAuth();
   getRedirectResult(auth)
     .then((result) => {
       const credential = OAuthProvider.credentialFromResult(result);
       if (credential) {
         // You can also get the Apple OAuth Access and ID Tokens.
         const accessToken = credential.accessToken;
         const idToken = credential.idToken;
       }
       // The signed-in user info.
       const user = result.user;
     })
     .catch((error) => {
       // Handle Errors here.
       const errorCode = error.code;
       const errorMessage = error.message;
       // The email of the user's account used.
       const email = error.customData.email;
       // The credential that was used.
       const credential = OAuthProvider.credentialFromError(error);
   
       // ...
     });
   auth_apple_signin_redirect_result.js

   Web

   // Result from Redirect auth flow.
   firebase
     .auth()
     .getRedirectResult()
     .then((result) => {
       if (result.credential) {
         /** @type {firebase.auth.OAuthCredential} */
         var credential = result.credential;
   
         // You can get the Apple OAuth Access and ID Tokens.
         var accessToken = credential.accessToken;
         var idToken = credential.idToken;
   
         // IdP data available in result.additionalUserInfo.profile.
         // ...
       }
       // The signed-in user info.
       var user = result.user;
     })
     .catch((error) => {
       // Handle Errors here.
       var errorCode = error.code;
       var errorMessage = error.message;
       // The email of the user's account used.
       var email = error.email;
       // The firebase.auth.AuthCredential type that was used.
       var credential = error.credential;
   
       // ...
     });
   apple.js

   C'est également là que vous pouvez détecter et gérer les erreurs. Pour obtenir la liste des codes d'erreur, consultez la documentation de référence de l'API.

   Contrairement aux autres fournisseurs compatibles avec Firebase Auth, Apple ne fournit pas d'URL de photo.

   De plus, lorsque l'utilisateur choisit de ne pas partager son adresse e-mail avec l'application, Apple lui fournit une adresse e-mail unique (au format xyz@privaterelay.appleid.com), qu'il partage avec votre application. Si vous avez configuré le service de relais d'e-mails privés, Apple transfère les e-mails envoyés à l'adresse anonymisée vers l'adresse e-mail réelle de l'utilisateur.

   Apple ne partage les informations utilisateur, telles que le nom à afficher, avec les applications que la première fois qu'un utilisateur se connecte. En règle générale, Firebase stocke le nom à afficher la première fois qu'un utilisateur se connecte avec Apple, que vous pouvez obtenir avec firebase.auth().currentUser.displayName. Toutefois, si vous avez déjà utilisé Apple pour connecter un utilisateur à l'application sans utiliser Firebase, Apple ne fournira pas le nom à afficher de l'utilisateur à Firebase.

Réauthentification et association de comptes

Le même schéma peut être utilisé avec reauthenticateWithPopup() et reauthenticateWithRedirect(), que vous pouvez utiliser pour récupérer des identifiants récents pour les opérations sensibles qui nécessitent une connexion récente :

import { getAuth, reauthenticateWithPopup, OAuthProvider } from "firebase/auth";

// Result from Redirect auth flow.
const auth = getAuth();
const provider = new OAuthProvider('apple.com');

reauthenticateWithPopup(auth.currentUser, provider)
  .then((result) => {
    // User is re-authenticated with fresh tokens minted and can perform
    // sensitive operations like account deletion, or updating their email
    // address or password.

    // The signed-in user info.
    const user = result.user;

    // You can also get the Apple OAuth Access and ID Tokens.
    const credential = OAuthProvider.credentialFromResult(result);
    const accessToken = credential.accessToken;
    const idToken = credential.idToken;

    // ...
  })
  .catch((error) => {
    // Handle Errors here.
    const errorCode = error.code;
    const errorMessage = error.message;
    // The email of the user's account used.
    const email = error.customData.email;
    // The credential that was used.
    const credential = OAuthProvider.credentialFromError(error);

    // ...
  });
auth_apple_reauthenticate_popup.js

const provider = new firebase.auth.OAuthProvider('apple.com');

firebase
  .auth()
  .currentUser
  .reauthenticateWithPopup(provider)
  .then((result) => {
    // User is re-authenticated with fresh tokens minted and can perform
    // sensitive operations like account deletion, or updating their email
    // address or password.
    /** @type {firebase.auth.OAuthCredential} */
    var credential = result.credential;

    // The signed-in user info.
    var user = result.user;
     // You can also get the Apple OAuth Access and ID Tokens.
    var accessToken = credential.accessToken;
    var idToken = credential.idToken;

    // IdP data available in result.additionalUserInfo.profile.
      // ...
  })
  .catch((error) => {
    // Handle Errors here.
    var errorCode = error.code;
    var errorMessage = error.message;
    // The email of the user's account used.
    var email = error.email;
    // The firebase.auth.AuthCredential type that was used.
    var credential = error.credential;

    // ...
  });
apple.js

Vous pouvez également utiliser linkWithPopup() et linkWithRedirect() pour associer différents fournisseurs d'identité à des comptes existants.

Notez qu'Apple vous demande d'obtenir le consentement explicite des utilisateurs avant d'associer leurs comptes Apple à d'autres données.

Par exemple, pour associer un compte Facebook au compte Firebase actuel, utilisez le jeton d'accès que vous avez obtenu en connectant l'utilisateur à Facebook :

import { getAuth, linkWithPopup, FacebookAuthProvider } from "firebase/auth";

const auth = getAuth();
const provider = new FacebookAuthProvider();
provider.addScope('user_birthday');

// Assuming the current user is an Apple user linking a Facebook provider.
linkWithPopup(auth.currentUser, provider)
    .then((result) => {
      // Facebook credential is linked to the current Apple user.
      // ...

      // The user can now sign in to the same account
      // with either Apple or Facebook.
    })
    .catch((error) => {
      // Handle error.
    });
auth_apple_link_facebook.js

const provider = new firebase.auth.FacebookAuthProvider();
provider.addScope('user_birthday');

// Assuming the current user is an Apple user linking a Facebook provider.
firebase.auth().currentUser.linkWithPopup(provider)
    .then((result) => {
      // Facebook credential is linked to the current Apple user.
      // Facebook additional data available in result.additionalUserInfo.profile,

      // Additional Facebook OAuth access token can also be retrieved.
      // result.credential.accessToken

      // The user can now sign in to the same account
      // with either Apple or Facebook.
    })
    .catch((error) => {
      // Handle error.
    });
apple.js

S'authentifier auprès de Firebase dans une extension Chrome

Si vous créez une application d'extension Chrome, consultez le guide Documents hors écran.

Notez que vous devez toujours valider le domaine personnalisé auprès d'Apple de la même manière que le domaine firebaseapp.com par défaut :

http://auth.custom.example.com/.well-known/apple-developer-domain-association.txt

Révocation de jeton

Apple exige que les applications qui acceptent la création de comptes permettent aux utilisateurs de lancer la suppression de leur compte dans l'application, comme décrit dans les Règles d'examen de l'App Store

Pour répondre à cette exigence, procédez comme suit :

1. Assurez-vous d'avoir rempli les sections ID de service et Configuration du flux de code OAuth de la configuration du fournisseur Se connecter avec Apple, comme indiqué dans la section Configurer Se connecter avec Apple.

2. Étant donné que Firebase ne stocke pas les jetons utilisateur lorsque les utilisateurs sont créés avec Se connecter avec Apple, vous devez demander à l'utilisateur de se connecter à nouveau avant de révoquer son jeton et de supprimer le compte.

   Ensuite, obtenez le jeton d'accès OAuth Apple à partir de OAuthCredential, puis utilisez-le pour appeler revokeAccessToken(auth, token) afin de révoquer le jeton d'accès OAuth Apple.

   const provider = new OAuthProvider('apple.com');
   provider.addScope('email');
   provider.addScope('name');
   
   const auth = getAuth();
   signInWithPopup(auth, provider).then(result => {
     // Get the Apple OAuth access token.
     const credential = OAuthProvider.credentialFromResult(result);
     const accessToken = credential.accessToken;
   
     // Revoke the Apple OAuth access token.
     revokeAccessToken(auth, accessToken)
       .then(() => {
         // Token revoked.
   
         // Delete the user account.
         // ...
       })
       .catch(error => {
         // An error happened.
         // ...
       });
   });
   

3. Enfin, supprimez le compte utilisateur (et toutes les données associées).

Avancé : S'authentifier auprès de Firebase dans Node.js

Pour vous authentifier auprès de Firebase dans une application Node.js :

1. Connectez l'utilisateur avec son compte Apple et obtenez son jeton d'ID Apple. Vous pouvez le faire de plusieurs manières. Par exemple, si votre application Node.js dispose d'une interface de navigateur :

   1. Sur votre backend, générez une chaîne aléatoire (un "nonce") et calculez son hachage SHA256. Le nonce est une valeur à usage unique que vous utilisez pour valider un aller-retour unique entre votre backend et les serveurs d'authentification d'Apple.

      Web

      const crypto = require("crypto");
      const string_decoder = require("string_decoder");
      
      // Generate a new random string for each sign-in
      const generateNonce = (length) => {
        const decoder = new string_decoder.StringDecoder("ascii");
        const buf = Buffer.alloc(length);
        let nonce = "";
        while (nonce.length < length) {
          crypto.randomFillSync(buf);
          nonce = decoder.write(buf);
        }
        return nonce.slice(0, length);
      };
      
      const unhashedNonce = generateNonce(10);
      
      // SHA256-hashed nonce in hex
      const hashedNonceHex = crypto.createHash('sha256')
        .update(unhashedNonce).digest().toString('hex');
      auth_apple_nonce_node.js

      Web

      const crypto = require("crypto");
      const string_decoder = require("string_decoder");
      
      // Generate a new random string for each sign-in
      const generateNonce = function(length) {
        const decoder = new string_decoder.StringDecoder("ascii");
        const buf = Buffer.alloc(length);
        var nonce = "";
        while (nonce.length < length) {
          crypto.randomFillSync(buf);
          nonce = decoder.write(buf);
        }
        return nonce.slice(0, length);
      };
      
      const unhashedNonce = generateNonce(10);
      
      // SHA256-hashed nonce in hex
      const hashedNonceHex = crypto.createHash('sha256')
        .update(unhashedNonce).digest().toString('hex');
      apple.js

   2. Sur votre page de connexion, spécifiez le nonce haché dans votre configuration Se connecter avec Apple :

      <script src="https://appleid.cdn-apple.com/appleauth/static/jsapi/appleid/1/en_US/appleid.auth.js"></script>
      <div id="appleid-signin" data-color="black" data-border="true" data-type="sign in"></div>
      <script>
          AppleID.auth.init({
              clientId: YOUR_APPLE_CLIENT_ID,
              scope: 'name email',
              redirectURI: URL_TO_YOUR_REDIRECT_HANDLER,  // See the next step.
              state: '[STATE]',  // Optional value that Apple will send back to you
                                 // so you can return users to the same context after
                                 // they sign in.
              nonce: HASHED_NONCE  // The hashed nonce you generated in the previous step.
          });
      </script>
      

   3. Obtenez le jeton d'ID Apple à partir du serveur de réponse d'authentification POSTé côté serveur :

      app.post('/redirect', (req, res) => {
        const savedState = req.cookies.__session;
        const code = req.body.code;
        const state = req.body.state;
        const appleIdToken = req.body.id_token;
        if (savedState !== state || !code) {
          res.status(403).send('403: Permission denied');
        } else {
          // Sign in with Firebase using appleIdToken. (See next step).
        }
      });
      

   Consultez également Configurer votre page Web pour Se connecter avec Apple.

2. Une fois que vous avez obtenu le jeton d'ID Apple de l'utilisateur, utilisez-le pour créer un objet Credential, puis connectez l'utilisateur avec les identifiants :

   Web

   import { getAuth, signInWithCredential, OAuthProvider } from "firebase/auth";
   
   const auth = getAuth();
   
   // Build Firebase credential with the Apple ID token.
   const provider = new OAuthProvider('apple.com');
   const authCredential = provider.credential({
     idToken: appleIdToken,
     rawNonce: unhashedNonce,
   });
   
   // Sign in with credential form the Apple user.
   signInWithCredential(auth, authCredential)
     .then((result) => {
       // User signed in.
     })
     .catch((error) => {
       // An error occurred. If error.code == 'auth/missing-or-invalid-nonce',
       // make sure you're sending the SHA256-hashed nonce as a hex string
       // with your request to Apple.
       console.log(error);
     });
   auth_apple_signin_nonce.js

   Web

   // Build Firebase credential with the Apple ID token.
   const provider = new firebase.auth.OAuthProvider('apple.com');
   const authCredential = provider.credential({
     idToken: appleIdToken,
     rawNonce: unhashedNonce,
   });
   
   // Sign in with credential form the Apple user.
   firebase.auth().signInWithCredential(authCredential)
     .then((result) => {
       // User signed in.
     })
     .catch((error) => {
       // An error occurred. If error.code == 'auth/missing-or-invalid-nonce',
       // make sure you're sending the SHA256-hashed nonce as a hex string
       // with your request to Apple.
       console.log(error);
     });
   apple.js

Étapes suivantes

Lorsqu'un utilisateur se connecte pour la première fois, un nouvel utilisateur est créé et associé aux identifiants (nom d'utilisateur et mot de passe, numéro de téléphone ou informations du fournisseur d'authentification) avec lesquels il s'est connecté. Ce nouveau compte est stocké dans votre projet Firebase et peut être utilisé pour identifier un utilisateur dans toutes les applications de votre projet, quelle que soit la manière dont il se connecte.

• Dans vos applications, la méthode recommandée pour connaître l'état d'authentification de votre utilisateur consiste à définir un observateur sur l'objet Auth. Vous pouvez ensuite obtenir les informations de base du profil de l'utilisateur à partir de l'objet User. Consultez Gérer les utilisateurs.

• Dans vos Firebase Realtime Database et Cloud Storage règles de sécurité, vous pouvez obtenir l'ID utilisateur unique de l'utilisateur connecté à partir de la variable auth, et l'utiliser pour contrôler les données auxquelles un utilisateur peut accéder.

Vous pouvez autoriser les utilisateurs à se connecter à votre application à l'aide de plusieurs fournisseurs d'authentification en associant les identifiants du fournisseur d'authentification à un compte utilisateur existant.

Pour déconnecter un utilisateur, appelez signOut :

import { getAuth, signOut } from "firebase/auth";

const auth = getAuth();
signOut(auth).then(() => {
  // Sign-out successful.
}).catch((error) => {
  // An error happened.
});
auth_sign_out.js

firebase.auth().signOut().then(() => {
  // Sign-out successful.
}).catch((error) => {
  // An error happened.
});
index.js