Autenticación de funciones personalizadas

Overview

El proveedor de autenticación de función personalizada permite definir un flujo de autenticación personalizado utilizando una función sin servidor. Puede utilizar este proveedor para implementar su propio lógica de autenticación de usuario o integrar un sistema de autenticación externo.

Cuándo utilizar la autenticación de funciones personalizadas

La autenticación con funciones personalizadas es la forma más flexible de autenticación. Sin embargo, también requiere que usted mismo defina y configure manualmente el flujo de autenticación.

Antes de definir un proveedor de funciones personalizado, considere si puede utilizar uno de los proveedores de autenticación integrados.

Considera usar el proveedor de función personalizada en tu aplicación si:

• You want to use an external authentication service that does not have a built-in provider. If the service uses JSON web tokens, consider creating a Custom JWT provider instead.

• Desea personalizar el proceso de autenticación más allá de lo que ofrece un proveedor integrado. Por ejemplo, podría usar un servicio para enviar correos electrónicos de confirmación personalizados en lugar de los correos predeterminados del proveedor de correo electrónico/contraseña.

Importante

Atlas App Services no realiza ninguna validación de datos ni comprobaciones de autenticación para el proveedor de función personalizada.

Asegúrese de validar los datos entrantes y de que su sistema de autenticación realice las comprobaciones de autenticación adecuadas, como solicitar una contraseña, autenticación de dos factores, o un token de inicio de sesión único.

El siguiente diagrama muestra el proceso de inicio de sesión de una función personalizada:

La función de autenticación

La función de autenticación es una función JavaScript que contiene tu código personalizado de autenticación de usuario. Se ejecuta cada vez que un usuario inicia sesión a través del proveedor de función personalizada.

La función asigna los datos proporcionados al iniciar sesión, como el nombre de usuario y la contraseña o un token de acceso, a una cadena que identifica de forma única al usuario en su sistema de autenticación externo. Por ejemplo, podría usar los datos proporcionados para iniciar sesión en un servicio externo mediante HTTP o con un paquete de npm.

exports = async function (payload) {
  // 1. Parse the `payload` object, which holds data from the
  //    FunctionCredential sent by the SDK.
  const { username, password } = payload;
  // 2. Create a new user or log in an existing user in the external
  //    authentication service.
  // You can use a client library from npm
  const auth = require("fake-auth-service");
  const user = await auth.login({ username, password });
  // Or you can communicate directly over HTTP
  const userFromHttp = await context.http.post({
    url: "https://example.com/auth/login",
    headers: {
      Authorization: ["Basic bmlja0BleGFtcGxlLmNvbTpQYTU1dzByZA=="],
    },
    body: JSON.stringify({ username, password }),
  });
  // 3. Return a unique identifier for the user. Typically this is the
  //    user's ID in the external authentication system or the _id of a
  //    stored MongoDB document that describes them.
  //
  //    !!! This is NOT the user's internal account ID for your app !!!
  return user.id;
};

{
  "id": "<Internal User Account ID>",
  "identities": [
     {
       "providerType": "custom-function",
       "id": "<External User ID>",
     }
  ]
}

return "5f650356a8631da45dd4784c"

return { "id": "5f650356a8631da45dd4784c" }

return {
  "id": "5f650356a8631da45dd4784c",
  "name": "James Bond"
}

const auth = require("some-external-auth-system");
try {
  const user = await auth.login(payload);
  return user.id;
} catch (err) {
  throw new Error(`Authentication failed with reason: ${err.message}`);
}

Configurar el proveedor de función personalizada

You can configure custom function authentication using any supported deployment method.

App Services UI

App Services CLI

1

Habilitar el proveedor de funciones personalizadas

Para habilitar el proveedor:

1. Haga clic App Users en el menú de navegación de la izquierda.

2. Selecciona la pestaña Providers.

3. Haga clic en Custom Function Authentication.

4. En la pantalla de configuración del proveedor, cambie el interruptor Provider Enabled a On.

haga clic para ampliar

2

Define the Authentication Function

El proveedor utiliza una función normal para gestionar la autenticación. Esta función debe devolver una cadena de identificación externa única para identificar al usuario.

Para definir una nueva función de autenticación:

1. Haz clic en el desplegable Function y selecciona New Function.

2. Introduzca un nombre para la función. Este nombre debe ser único entre todas las funciones de la aplicación.

3. Define el código fuente en el editor de funciones.

4. Haga clic Save

haga clic para ampliar

3

Implementar la aplicación actualizada

Para que la autenticación de funciones personalizadas esté disponible para las aplicaciones cliente, implemente su aplicación.

1. Haga clic en Deploy en el menú de navegación de la izquierda

2. Busque el borrador en la tabla del historial de implementación y luego haga clic en Review & Deploy Changes.

3. Revise la diferencia de cambios y luego haga clic en Deploy.

1

Obtenga la última versión de su aplicación

Para extraer una copia local de la última versión de su aplicación, ejecute lo siguiente:

appservices pull --remote="<Your App ID>"

Tip

También puedes descargar una copia de los archivos de configuración de tu aplicación desde la pantalla Deploy > Export App en la Interfaz de usuario Realm.

2

Define the Authentication Function

El proveedor utiliza una función normal para gestionar la autenticación. Esta función debe devolver una cadena de identificación externa única para identificar al usuario.

Guarde el código de la función de autenticación en el functions directorio.

touch functions/handleCustomFunctionAuthentication.js

3

Add a Provider Configuration File

Para habilitar y configurar el proveedor de autenticación de función personalizada, defina un objeto de configuración para él /auth/providers.json en.

Las configuraciones del proveedor de funciones personalizadas tienen el siguiente formato:

/auth/proveedores.json

{
  "custom-function": {
    "name": "custom-function",
    "type": "custom-function",
    "config": {
      "authFunctionName": "<Authentication Function Name>"
    },
    "disabled": false
  }
}

4

Implementar la aplicación actualizada

Una vez creada la función de autenticación y configurado el proveedor, puede enviar las configuraciones actualizadas a su aplicación remota. La CLI de App Services implementa inmediatamente el nuevo esquema al enviarlo.

appservices push --remote="<Your App ID>"

Configure Custom User Data

Puedes asociar datos personalizados de una colección de MongoDB Atlas con cuentas de usuario en tu aplicación. Esto puede ser útil si necesitas acceder a los datos de un usuario con frecuencia, pero no es necesario usar el proveedor de funciones personalizadas.

A user's custom data document may contain any data. For apps that use the custom function provider, we recommend storing both the user's internal user account ID and their external ID.

Por ejemplo, podrías usar el siguiente formato:

{
  "_id": "<Generated ObjectId>",
  "user_id": "<Internal User ID>",
  "external_id": "<External User ID>"
}

You can use the following approach to create custom user documents for custom function provider users:

1. Configure datos de usuario personalizados para una colección en su clúster vinculado. El campo ID de usuario almacena el ID de cuenta interno del usuario.

   /auth/custom_user_data.json

   {
     "mongo_service_name": "mongodb-atlas",
     "database_name": "myApp",
     "collection_name": "users",
     "user_id_field": "user_id",
     "enabled": true
   }

2. Configure el proveedor de autenticación de la función personalizada y devuelva un ID de usuario externo único desde la función de autenticación. App Services almacena este ID en el campo id de la identidad custom-function del usuario.

   exports = async function handleCustomFunctionAuth(payload) {
     const auth = require("some-external-auth-system");
     const user = await auth.login(payload);
     return user.id;
   };

3. Configure un disparador de autenticación que detecte eventos CREATE del proveedor custom-function. En la función de disparo, añada un nuevo documento a la colección de datos de usuario personalizada que incluya tanto el ID interno como el externo del usuario.

   exports = async function onNewCustomFunctionUser({ user }) {
     // This is the user's internal account ID that was generated by your app
     const internalId = user.id;
     // This is the external ID returned from the authentication function
     const customFunctionIdentity = user.identities.find((id) => {
       return id.provider_type === "custom-function";
     });
     const externalId = customFunctionIdentity.id;
     // Create a custom user data document for the user
     const mdb = context.services.get("mongodb-atlas");
     const users = mdb.db("myApp").collection("users");
     return await users.insertOne({
       // Include both the internal ID and external ID
       user_id: internalId,
       external_id: externalId,
       // Add any other data you want to include
       created_at: new Date(),
     });
   };

Iniciar sesión desde un SDK de Realm

Para iniciar sesión desde una aplicación cliente, se debe utilizar una credencial de función personalizada que contenga los datos de la carga útil de inicio de sesión.

Para obtener ejemplos, consulte la documentación de un SDK específico:

• SDK de C++

• Flutter SDK

• Java SDK

• Kotlin SDK

• Kit de desarrollo de software .NET

• Node.js SDK

• React Native SDK

• Kit de desarrollo de software de Swift

• Web SDK