Cómo autenticar mediante GitHub con JavaScript

Puedes integrar la autenticación de GitHub a tu app para permitir que los usuarios se autentiquen con Firebase mediante sus cuentas de GitHub. Si quieres darles esa opción, puedes usar el SDK de Firebase para llevar a cabo el flujo de acceso o puedes realizar el flujo de acceso de GitHub OAuth 2.0 de forma manual y transferir el token de acceso resultante a Firebase.

Antes de comenzar

  1. Agrega Firebase a tu proyecto de JavaScript.
  2. Registra tu app como una aplicación de desarrollador en GitHub y obtén el ID de cliente y el Secreto de cliente de OAuth 2.0 de tu app.
  3. Habilita la autenticación de GitHub:
    1. En Firebase console, abre la sección Auth.
    2. En la pestaña Método de acceso, habilita el método de acceso de GitHub y especifica el ID de Cliente y el Secreto de cliente de OAuth 2.0 que obtuviste de GitHub.
    3. Luego, asegúrate de que tu URI de redireccionamiento de OAuth de Firebase (p. ej., my-app-12345.firebaseapp.com/__/auth/handler) esté configurado como URL de devolución de llamada de autorización en la página de configuración de la app, en la configuración de tu app de GitHub.

Maneja el flujo de acceso con el SDK de Firebase

Si estás compilando una app web, la manera más sencilla de autenticar a tus usuarios con Firebase mediante sus cuentas de GitHub es manejar el flujo de acceso con el SDK de Firebase para JavaScript. Si deseas autenticar a un usuario en Node.js o algún otro entorno que no sea de un navegador, debes manejar el flujo de acceso manualmente.

Para manejar el flujo de acceso con el SDK de Firebase para JavaScript, sigue estos pasos:

  1. Crea una instancia del objeto del proveedor de GitHub:
    var provider = new firebase.auth.GithubAuthProvider();
    
  2. Opcional: Especifica los alcances adicionales de OAuth 2.0 que deseas solicitarle al proveedor de autenticación. Para agregar un alcance, invoca a addScope. Por ejemplo:
    provider.addScope('repo');
    
    Consulta la documentación del proveedor de autenticación.
  3. Opcional: Especifica los parámetros personalizados adicionales del proveedor de OAuth que deseas enviar junto con la solicitud de OAuth. Para agregar un parámetro personalizado, llama a setCustomParameters en el proveedor inicializado con un objeto que contenga la clave que se indica en la documentación del proveedor de OAuth y su valor correspondiente. Por ejemplo:
    provider.setCustomParameters({
      'allow_signup': 'false'
    });
    
    No se permiten los parámetros de OAuth necesarios reservados y se ignorarán. Consulta la referencia del proveedor de autenticación para obtener más información.
  4. Autentica con Firebase a través del objeto del proveedor de GitHub. Puedes pedirles a los usuarios que accedan con sus cuentas de GitHub a través de una ventana emergente o mediante un redireccionamiento a la página de acceso. En dispositivos móviles, se prefiere el método de redireccionamiento.
    • Para ofrecer acceso con una ventana emergente, llama a signInWithPopup:
      firebase.auth().signInWithPopup(provider).then(function(result) {
        // This gives you a GitHub Access Token. You can use it to access the GitHub API.
        var token = result.credential.accessToken;
        // The signed-in user info.
        var user = result.user;
        // ...
      }).catch(function(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;
        // ...
      });
      
      Además, ten en cuenta que puedes recuperar el token de OAuth del proveedor de GitHub, que se puede usar para obtener datos adicionales con las API de GitHub.

      Aquí también puedes detectar y manejar errores. Para obtener una lista de códigos de error, consulta los documentos de referencia de autenticación.

    • Para acceder mediante el redireccionamiento a la página de acceso, llama a signInWithRedirect:
      firebase.auth().signInWithRedirect(provider);
      
      También puedes llamar a getRedirectResult cuando se cargue la página para obtener el token de OAuth del proveedor de GitHub:
      firebase.auth().getRedirectResult().then(function(result) {
        if (result.credential) {
          // This gives you a GitHub Access Token. You can use it to access the GitHub API.
          var token = result.credential.accessToken;
          // ...
        }
        // The signed-in user info.
        var user = result.user;
      }).catch(function(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;
        // ...
      });
      
      Aquí también puedes detectar y manejar errores. Para obtener una lista de códigos de error, consulta los documentos de referencia de autenticación.

Maneja el flujo de acceso de manera manual

También puedes autenticar con Firebase a través de una cuenta de GitHub. Para hacerlo, debes llamar a los extremos de GitHub OAuth 2.0 a fin de manejar el flujo de acceso:

  1. Para integrar la autenticación de GitHub en la app, sigue las indicaciones que se brindan en la documentación para programadores. Al final del flujo de acceso de GitHub, recibirás un token de acceso de OAuth 2.0.
  2. Si necesitas acceder a una aplicación de Node.js, envía el token de acceso de OAuth a la aplicación de Node.js.
  3. Una vez que un usuario acceda correctamente con GitHub, intercambia el token de acceso de OAuth 2.0 por una credencial de Firebase:
    var credential = firebase.auth.GithubAuthProvider.credential(token);
    
  4. Usa la credencial de Firebase para autenticar con Firebase:
    firebase.auth().signInAndRetrieveDataWithCredential(credential).catch(function(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;
      // ...
    });

Autentica con Firebase en una extensión de Chrome

Si estás compilando una app de extensión de Chrome, debes incluir en la lista blanca el ID de extensión de Chrome:

  1. Abre tu proyecto en Firebase console.
  2. En la sección Authentication, abre la página Método de acceso.
  3. Agrega un URI como el siguiente a la lista de dominios autorizados:
    chrome-extension://CHROME_EXTENSION_ID

Solo las operaciones con elementos emergentes (signInWithPopup y linkWithPopup) están disponibles para las extensiones de Chrome, ya que estas no pueden usar redireccionamientos HTTP. Deberías llamar a estos métodos desde una secuencia de comandos en segundo plano en lugar de una ventana emergente de acción en el navegador, ya que la ventana emergente de autenticación cancela la de acción del navegador.

Asegúrate de incluir la URL https://apis.google.com en la lista blanca content_security_policy en tu archivo de manifiesto de la extensión de Chrome.

Próximos pasos

Cuando un usuario accede por primera vez, se crea una cuenta de usuario nueva y se la vincula con las credenciales (el nombre de usuario y la contraseña, el número de teléfono o la información del proveedor de autenticación) con las que accedió el usuario. Esta cuenta nueva se almacena como parte del proyecto de Firebase y puede usarse para identificar a un usuario en todas las apps del proyecto, sin importar el método de acceso que se use.

  • En las apps, para conocer el estado de autenticación del usuario, te recomendamos configurar un observador en el objeto Auth. Puedes obtener la información básica de perfil del usuario a partir del objeto User. Consulta Cómo administrar usuarios.

  • En tus reglas de seguridad de Firebase Realtime Database y Cloud Storage, puedes obtener el ID del usuario único que accedió a partir de la variable auth y usarlo para controlar los datos a los que tiene acceso.

Para permitir que los usuarios accedan a tu app con varios proveedores de autenticación, puedes vincular las credenciales de proveedores de autenticación con una cuenta de usuario existente.

Para salir de la sesión de un usuario, llama a signOut:

firebase.auth().signOut().then(function() {
  // Sign-out successful.
}).catch(function(error) {
  // An error happened.
});

Enviar comentarios sobre…

¿Necesitas ayuda? Visita nuestra página de asistencia.