Personalizzazione del flusso di autenticazione mediante funzioni di blocco

Questo documento spiega come estendere l'autenticazione di Identity Platform utilizzando le funzioni Cloud Run di blocco.

Le funzioni di blocco ti consentono di eseguire codice personalizzato che modifica il risultato della registrazione o dell'accesso di un utente alla tua app. Ad esempio, puoi impedire a un utente di autenticarsi se non soddisfa determinati criteri o aggiornare le informazioni di un utente prima di restituirle alla tua app client.

Prima di iniziare

Crea un'app con Identity Platform. Per scoprire come, consulta la guida rapida.

Informazioni sulle funzioni di blocco

Puoi registrare funzioni di blocco per due eventi:

  • beforeCreate: si attiva prima che un nuovo utente venga salvato nel database di Identity Platform e prima che un token venga restituito all'app client.

  • beforeSignIn: si attiva dopo la verifica delle credenziali di un utente, ma prima che Identity Platform restituisca un token ID alla tua app client. Se la tua app utilizza l'autenticazione a più fattori, la funzione si attiva dopo che l'utente ha verificato il secondo fattore. Tieni presente che la creazione di un nuovo utente attiva anche beforeSignIn, oltre a beforeCreate.

Tieni presente quanto segue quando utilizzi le funzioni di blocco:

  • La funzione deve rispondere entro 7 secondi. Dopo 7 secondi, Identity Platform restituisce un errore e l'operazione del client non va a buon fine.

  • I codici di risposta HTTP diversi da 200 vengono passati alle app client. Assicurati che il codice client gestisca eventuali errori che la funzione può restituire.

  • Le funzioni si applicano a tutti gli utenti del progetto, inclusi quelli contenuti in un tenant. Identity Platform fornisce alla tua funzione informazioni sugli utenti, inclusi gli eventuali tenant a cui appartengono, in modo da poter rispondere di conseguenza.

  • Il collegamento di un altro provider di identità a un account riattiva tutte le funzioni beforeSignIn registrate. Non sono inclusi i fornitori di email e password.

  • L'autenticazione anonima e personalizzata non supporta le funzioni di blocco.

  • Se utilizzi anche funzioni asincrone, l'oggetto utente ricevuto da una funzione asincrona non contiene aggiornamenti della funzione di blocco.

Creazione di una funzione di blocco

I passaggi riportati di seguito mostrano come creare una funzione di blocco:

  1. Vai alla pagina Impostazioni di Identity Platform nella consoleGoogle Cloud .

    Vai alla pagina Impostazioni

  2. Seleziona la scheda Trigger.

  3. Per creare una funzione di blocco per la registrazione degli utenti, seleziona il menu a discesa Funzione in Prima della creazione (beforeCreate) e poi fai clic su Crea funzione. Per creare una funzione di blocco per l'accesso degli utenti, crea una funzione in Prima dell'accesso (beforeSignIn).

  4. Crea una nuova funzione:

    1. Inserisci un nome per la funzione.

    2. Nel campo Trigger, seleziona HTTP.

    3. Nel campo Autenticazione, seleziona Consenti chiamate non autenticate.

    4. Fai clic su Avanti.

  5. Apri index.js utilizzando l'editor in linea. Elimina il codice helloWorld di esempio e sostituiscilo con uno dei seguenti:

    Per rispondere alla registrazione:

    import gcipCloudFunctions from 'gcip-cloud-functions';

const authClient = new gcipCloudFunctions.Auth();

exports.beforeCreate = authClient.functions().beforeCreateHandler((user, context) => {
  // TODO
});

    Per rispondere all'accesso:

    import gcipCloudFunctions from 'gcip-cloud-functions';

const authClient = new gcipCloudFunctions.Auth();

exports.beforeSignIn = authClient.functions().beforeSignInHandler((user, context) => {
  // TODO
});

  6. Apri package.json e aggiungi il seguente blocco delle dipendenze: Per la versione più recente dell'SDK, consulta gcip-cloud-functions.

    {
  "type": "module",
  "name": ...,
  "version": ...,

  "dependencies": {
    "gcip-cloud-functions": "^0.2.0"
  }
}

  7. Imposta l'entry point della funzione su beforeSignIn

  8. Fai clic su Esegui il deployment per pubblicare la funzione.

  9. Fai clic su Salva nella pagina delle funzioni di blocco di Identity Platform.

Consulta le sezioni seguenti per scoprire come implementare la funzione. Devi eseguire nuovamente il deployment della funzione ogni volta che la aggiorni.

Puoi anche creare e gestire le funzioni utilizzando Google Cloud CLI o l'API REST. Consulta la documentazione di Cloud Run Functions per scoprire come utilizzare Google Cloud CLI per eseguire il deployment di una funzione.

Ottenere informazioni sugli utenti e sul contesto

Gli eventi beforeSignIn e beforeCreate forniscono oggetti User e EventContext che contengono informazioni sull'accesso dell'utente. Utilizza questi valori nel codice per determinare se consentire o meno il proseguimento di un'operazione.

Per un elenco delle proprietà disponibili nell'oggetto User, consulta il riferimento all'API UserRecord.

L'oggetto EventContext contiene le seguenti proprietà:

Nome Descrizione Esempio
locale La lingua dell'applicazione. Puoi impostare le impostazioni internazionali utilizzando l'SDK client o passando l'intestazione delle impostazioni internazionali nell'API REST. fr o sv-SE
ipAddress L'indirizzo IP del dispositivo da cui l'utente finale sta effettuando la registrazione o l'accesso. 114.14.200.1
userAgent L'agente utente che attiva la funzione di blocco. Mozilla/5.0 (X11; Linux x86_64)
eventId L'identificatore univoco dell'evento. rWsyPtolplG2TBFoOkkgyg
eventType Il tipo di evento. Fornisce informazioni sul nome dell'evento, ad esempio beforeSignIn o beforeCreate, e sul metodo di accesso associato utilizzato, ad esempio Google o email/password. providers/cloud.auth/eventTypes/user.beforeSignIn:password
authType Sempre USER. USER
resource Il progetto o il tenant di Identity Platform. projects/project-id/tenants/tenant-id
timestamp L'ora in cui è stato attivato l'evento, formattata come stringa RFC 3339. Tue, 23 Jul 2019 21:10:57 GMT
additionalUserInfo Un oggetto contenente informazioni sull'utente. AdditionalUserInfo
credential Un oggetto contenente informazioni sulle credenziali dell'utente. AuthCredential

Blocco della registrazione o dell'accesso

Per bloccare un tentativo di registrazione o accesso, lancia un HttpsError nella funzione. Ad esempio:

Node.js 

throw new gcipCloudFunctions.https.HttpsError('permission-denied');

Nella tabella seguente sono elencati gli errori che puoi sollevare, insieme al relativo messaggio di errore predefinito:

Nome Codice Messaggio
invalid-argument 400 Il client ha specificato un argomento non valido.
failed-precondition 400 La richiesta non può essere eseguita nello stato attuale del sistema.
out-of-range 400 Il client ha specificato un intervallo non valido.
unauthenticated 401 Token OAuth mancante, non valido o scaduto.
permission-denied 403 Il client non dispone di autorizzazioni sufficienti.
not-found 404 La risorsa specificata non è stata trovata.
aborted 409 Conflitto di concorrenza, ad esempio un conflitto di lettura, modifica e scrittura.
already-exists 409 La risorsa che un client ha cercato di creare esiste già.
resource-exhausted 429 Quota di risorse esaurita o vicina alla limitazione della frequenza.
cancelled 499 La richiesta è stata annullata dal client.
data-loss 500 Perdita di dati non recuperabili o danneggiamento dei dati.
unknown 500 Errore sconosciuto del server.
internal 500 Errore interno del server.
not-implemented 501 Metodo API non implementato dal server.
unavailable 503 Servizio non disponibile.
deadline-exceeded 504 Scadenza richiesta superata.

Puoi anche specificare un messaggio di errore personalizzato:

Node.js 

throw new gcipCloudFunctions.https.HttpsError('permission-denied', 'Unauthorized request origin!');

L'esempio seguente mostra come impedire agli utenti che non si trovano in un dominio specifico di registrarsi alla tua app:

Node.js 

// Import the Cloud Auth Admin module.
import gcipCloudFunctions from 'gcip-cloud-functions';
// Initialize the Auth client.
const authClient = new gcipCloudFunctions.Auth();
// Http trigger with Cloud Run functions.
exports.beforeCreate = authClient.functions().beforeCreateHandler((user, context) => {
  // If the user is authenticating within a tenant context, the tenant ID can be determined from
  // user.tenantId or from context.resource, eg. 'projects/project-id/tenant/tenant-id-1'
  // Only users of a specific domain can sign up.
  if (!user.email.endsWith('@acme.com')) {
    throw new gcipCloudFunctions.https.HttpsError('invalid-argument', `Unauthorized email "${user.email}"`);
  }
});

Indipendentemente dall'utilizzo di un messaggio predefinito o personalizzato, le funzioni Cloud Run avvolgono l'errore e lo restituiscono al client come errore interno. Ad esempio, se nella funzione viene visualizzato il seguente errore:

throw new gcipCloudFunctions.https.HttpsError('invalid-argument', `Unauthorized email user@evil.com}`);

All'app client viene restituito un errore simile al seguente (se utilizzi l'SDK client, l'errore viene inserito come errore interno):

{
  "error": {
    "code": 400,
    "message": "BLOCKING_FUNCTION_ERROR_RESPONSE : HTTP Cloud Function returned an error. Code: 400, Status: \"INVALID_ARGUMENT\", Message: \"Unauthorized email user@evil.com\"",
    "errors": [
      {
        "message": "BLOCKING_FUNCTION_ERROR_RESPONSE : HTTP Cloud Function returned an error. Code: 400, Status: \"INVALID_ARGUMENT\", Message: \"Unauthorized email user@evil.com\"",
        "domain": "global",
        "reason": "invalid"
      }
    ]
  }
}

L'app dovrebbe rilevare l'errore e gestirlo di conseguenza. Ad esempio:

JavaScript 

// Blocking functions can also be triggered in a multi-tenant context before user creation.
// firebase.auth().tenantId = 'tenant-id-1';
firebase.auth().createUserWithEmailAndPassword('johndoe@example.com', 'password')
  .then((result) => {
    result.user.getIdTokenResult()
  })
  .then((idTokenResult) => {
    console.log(idTokenResult.claim.admin);
  })
  .catch((error) => {
    if (error.code !== 'auth/internal-error' && error.message.indexOf('Cloud Function') !== -1) {
      // Display error.
    } else {
      // Registration succeeds.
    }
  });

Modificare un utente

Invece di bloccare un tentativo di registrazione o accesso, puoi consentire la prosecuzione dell'operazione, ma modificare l'oggetto User salvato nel database di Identity Platform e restituito al client.

Per modificare un utente, restituisci un oggetto dal gestore di eventi contenente i campi da modificare. Puoi modificare i seguenti campi:

  • displayName
  • disabled
  • emailVerified
  • photoURL
  • customClaims
  • sessionClaims (solo beforeSignIn)

Ad eccezione di sessionClaims, tutti i campi modificati vengono salvati nel database di Identity Platform, il che significa che sono inclusi nel token di risposta e rimangono invariati tra le sessioni utente.

L'esempio seguente mostra come impostare un nome visualizzato predefinito:

Node.js 

exports.beforeCreate = authClient.functions().beforeCreateHandler((user, context) => {
  return {
    // If no display name is provided, set it to "guest".
    displayName: user.displayName || 'guest'
  };
});

Se registri un gestore di eventi sia per beforeCreate che per beforeSignIn, tieni presente che beforeSignIn viene eseguito dopo beforeCreate. I campi utente aggiornati in beforeCreate sono visibili in beforeSignIn. Se imposti un campo diverso da sessionClaims in entrambi i gestori eventi, il valore impostato in beforeSignIn sovrascrive il valore impostato in beforeCreate. Solo per sessionClaims, vengono propagati ai claim dei token della sessione corrente, ma non vengono mantenuti o memorizzati nel database.

Ad esempio, se sono impostati valori sessionClaims, beforeSignIn li restituirà insieme a eventuali rivendicazioni beforeCreate e verranno uniti. Quando vengono unite, se una chiave sessionClaims corrisponde a una chiave in customClaims, la chiave customClaims corrispondente verrà sovrascritta nei claim del token dalla chiave sessionClaims. Tuttavia, la chiave customClaims sovrascritta persiste nel database per le richieste future.

Credenziali e dati OAuth supportati

Puoi passare le credenziali OAuth e i dati alle funzioni di blocco di vari fornitori di identità. La tabella seguente mostra le credenziali e i dati supportati per ciascun provider di identità:

Provider di identità Token ID Token di accesso Data di scadenza Secret del token Aggiorna token Claim di accesso
Google Sì Sì Sì No Sì No
Facebook No Sì Sì No No No
Twitter No Sì No Sì No No
GitHub No Sì No No No No
Microsoft Sì Sì Sì No Sì No
LinkedIn No Sì Sì No No No
Yahoo Sì Sì Sì No Sì No
Apple Sì Sì Sì No Sì No
SAML No No No No No Sì
OIDC Sì Sì Sì No Sì Sì

Token di aggiornamento

Per utilizzare un token di aggiornamento in una funzione di blocco, devi prima selezionare la casella di controllo nella sezione Trigger del menu a discesa Includi credenziali token nella Google Cloud console.

I token di aggiornamento non verranno restituiti da nessun provider di identità quando accedi direttamente con una credenziale OAuth, ad esempio un token ID o un token di accesso. In questa situazione, la stessa credenziale OAuth lato client verrà passata alla funzione di blocco. Tuttavia, per i flussi a tre passaggi, potrebbe essere disponibile un token di aggiornamento se il provider di identità lo supporta.

Le sezioni seguenti descrivono ogni tipo di provider di identità e le relative credenziali e i dati supportati.

Provider OIDC generici

Quando un utente accede con un provider OIDC generico, vengono trasmesse le seguenti credenziali:

  • Token ID: fornito se è selezionato il flusso id_token.
  • Token di accesso: fornito se è selezionato il flusso di codice. Tieni presente che il flusso di codice è attualmente supportato solo tramite l'API REST.
  • Token di aggiornamento: fornito se è selezionato offline_access ambito.

Esempio:

const provider = new firebase.auth.OAuthProvider('oidc.my-provider');
provider.addScope('offline_access');
firebase.auth().signInWithPopup(provider);

Google

Quando un utente accede con Google, vengono trasmesse le seguenti credenziali:

  • Token ID
  • Token di accesso
  • Token di aggiornamento: fornito solo se vengono richiesti i seguenti parametri personalizzati:
    • access_type=offline
    • prompt=consent, se l'utente ha già dato il consenso e non è stato richiesto un nuovo ambito

Esempio:

const provider = new firebase.auth.GoogleAuthProvider();
provider.setCustomParameters({
  'access_type': 'offline',
  'prompt': 'consent'
});
firebase.auth().signInWithPopup(provider);

Scopri di più sui token di aggiornamento di Google.

Facebook

Quando un utente accede con Facebook, viene passata la seguente credenziale:

  • Token di accesso: viene restituito un token di accesso che può essere scambiato per un altro token di accesso. Scopri di più sui diversi tipi di token di accesso supportati da Facebook e su come scambiarli con token di lunga durata.

GitHub

Quando un utente accede con GitHub, viene passata la seguente credenziale:

  • Token di accesso: non scade, a meno che non venga revocato.

Microsoft

Quando un utente accede con Microsoft, vengono trasmesse le seguenti credenziali:

  • Token ID
  • Token di accesso
  • Token di aggiornamento: viene passato alla funzione di blocco se è selezionato l'ambito offline_access.

Esempio:

const provider = new firebase.auth.OAuthProvider('microsoft.com');
provider.addScope('offline_access');
firebase.auth().signInWithPopup(provider);

Yahoo

Quando un utente accede con Yahoo, vengono trasmesse le seguenti credenziali senza parametri o ambiti personalizzati:

  • Token ID
  • Token di accesso
  • Token di aggiornamento

LinkedIn

Quando un utente accede con LinkedIn, viene passata la seguente credenziale:

  • Token di accesso

Apple

Quando un utente accede con Apple, vengono trasmesse le seguenti credenziali senza parametri o ambiti personalizzati:

  • Token ID
  • Token di accesso
  • Token di aggiornamento

Scenari comuni

I seguenti esempi mostrano alcuni casi d'uso comuni per le funzioni di blocco:

Consentire la registrazione solo da un dominio specifico

L'esempio seguente mostra come impedire agli utenti che non fanno parte del example.com dominio di registrarsi alla tua app:

Node.js 

exports.beforeCreate = authClient.functions().beforeCreateHandler((user, context) => {
  if (!user.email || user.email.indexOf('@example.com') === -1) {
    throw new gcipCloudFunctions.https.HttpsError(
      'invalid-argument', `Unauthorized email "${user.email}"`);
  }
});

Bloccare la registrazione degli utenti con indirizzi email non verificati

L'esempio seguente mostra come impedire agli utenti con email non verificate di registrarsi alla tua app:

Node.js 

exports.beforeCreate = authClient.functions().beforeCreateHandler((user, context) => {
  if (user.email && !user.emailVerified) {
    throw new gcipCloudFunctions.https.HttpsError(
      'invalid-argument', `Unverified email "${user.email}"`);
  }
});

Richiedere la verifica email al momento della registrazione

L'esempio seguente mostra come richiedere a un utente di verificare il proprio indirizzo email dopo la registrazione:

Node.js 

exports.beforeCreate = authClient.functions().beforeCreateHandler((user, context) => {
  const locale = context.locale;
  if (user.email && !user.emailVerified) {
    // Send custom email verification on sign-up.
    return admin.auth().generateEmailVerificationLink(user.email).then((link) => {
      return sendCustomVerificationEmail(user.email, link, locale);
    });
  }
});

exports.beforeSignIn = authClient.functions().beforeSignInHandler((user, context) => {
 if (user.email && !user.emailVerified) {
   throw new gcipCloudFunctions.https.HttpsError(
     'invalid-argument', `"${user.email}" needs to be verified before access is granted.`);
  }
});

Trattare determinate email dei provider di identità come verificate

L'esempio seguente mostra come trattare le email degli utenti di determinati fornitori di servizi di identità come verificate:

Node.js 

exports.beforeCreate = authClient.functions().beforeCreateHandler((user, context) => {
  if (user.email && !user.emailVerified && context.eventType.indexOf(':facebook.com') !== -1) {
    return {
      emailVerified: true,
    };
  }
});

Bloccare l'accesso da determinati indirizzi IP

L'esempio seguente mostra come bloccare l'accesso da determinati intervalli di indirizzi IP:

Node.js 

exports.beforeSignIn = authClient.functions().beforeSignInHandler((user, context) => {
  if (isSuspiciousIpAddress(context.ipAddress)) {
    throw new gcipCloudFunctions.https.HttpsError(
      'permission-denied', 'Unauthorized access!');
  }
});

Impostazione di attestazioni personalizzate e di sessione

L'esempio seguente mostra come impostare i claim personalizzati e di sessione:

Node.js 

exports.beforeCreate = authClient.functions().beforeCreateHandler((user, context) => {
  if (context.credential &&
      context.credential.providerId === 'saml.my-provider-id') {
    return {
      // Employee ID does not change so save in persistent claims (stored in
      // Auth DB).
      customClaims: {
        eid: context.credential.claims.employeeid,
      },
      // Copy role and groups to token claims. These will not be persisted.
      sessionClaims: {
        role: context.credential.claims.role,
        groups: context.credential.claims.groups,
      }
    }
  }
});

Monitoraggio degli indirizzi IP per rilevare attività sospette

Puoi impedire il furto di token monitorando l'indirizzo IP da cui un utente accede e confrontandolo con l'indirizzo IP nelle richieste successive. Se la richiesta sembra sospetta, ad esempio se gli IP provengono da regioni geografiche diverse, puoi chiedere all'utente di eseguire nuovamente l'accesso.

  1. Utilizza i claim di sessione per monitorare l'indirizzo IP con cui l'utente accede:

    Node.js 

    exports.beforeSignIn = authClient.functions().beforeSignInHandler((user, context) => {
  return {
    sessionClaims: {
      signInIpAddress: context.ipAddress,
    },
  };
});

  2. Quando un utente tenta di accedere alle risorse che richiedono l'autenticazione con Identity Platform, confronta l'indirizzo IP nella richiesta con quello utilizzato per accedere:

    Node.js 

    app.post('/getRestrictedData', (req, res) => {
  // Get the ID token passed.
  const idToken = req.body.idToken;
  // Verify the ID token, check if revoked and decode its payload.
  admin.auth().verifyIdToken(idToken, true).then((claims) => {
    // Get request IP address
    const requestIpAddress = req.connection.remoteAddress;
    // Get sign-in IP address.
    const signInIpAddress = claims.signInIpAddress;
    // Check if the request IP address origin is suspicious relative to
    // the session IP addresses. The current request timestamp and the
    // auth_time of the ID token can provide additional signals of abuse,
    // especially if the IP address suddenly changed. If there was a sudden
    // geographical change in a short period of time, then it will give
    // stronger signals of possible abuse.
    if (!isSuspiciousIpAddressChange(signInIpAddress, requestIpAddress)) {
      // Suspicious IP address change. Require re-authentication.
      // You can also revoke all user sessions by calling:
      // admin.auth().revokeRefreshTokens(claims.sub).
      res.status(401).send({error: 'Unauthorized access. Please login again!'});
    } else {
      // Access is valid. Try to return data.
      getData(claims).then(data => {
        res.end(JSON.stringify(data);
      }, error => {
        res.status(500).send({ error: 'Server error!' })
      });
    }
  });
});

Controllo delle foto degli utenti

L'esempio seguente mostra come eseguire la sanitizzazione delle foto del profilo degli utenti:

Node.js 

exports.beforeCreate = authClient.functions().beforeCreateHandler((user, context) => {
  if (user.photoURL) {
    return isPhotoAppropriate(user.photoURL)
      .then((status) => {
        if (!status) {
          // Sanitize inappropriate photos by replacing them with guest photos.
          // Users could also be blocked from sign-up, disabled, etc.
          return {
            photoURL: PLACEHOLDER_GUEST_PHOTO_URL,
          };
        }
      });
});

Per scoprire di più su come rilevare e sanificare le immagini, consulta la documentazione di Cloud Vision.

Accedere alle credenziali OAuth del provider di identità di un utente

L'esempio seguente mostra come ottenere un token di aggiornamento per un utente che ha eseguito l'accesso con Google e come utilizzarlo per chiamare le API Google Calendar. Il token di aggiornamento viene memorizzato per l'accesso offline.

Node.js 

const {OAuth2Client} = require('google-auth-library');
const {google} = require('googleapis');
const gcipCloudFunctions = require('gcip-cloud-functions');

// ...
// Initialize Google OAuth client.
const keys = require('./oauth2.keys.json');
const oAuth2Client = new OAuth2Client(
  keys.web.client_id,
  keys.web.client_secret
);

exports.beforeCreate = authClient.functions().beforeCreateHandler((user, context) => {
  if (context.credential &&
      context.credential.providerId === 'google.com') {
    // Store the refresh token for later offline use.
    // These will only be returned if refresh tokens credentials are included
    // (enabled by Cloud console).
    return saveUserRefreshToken(
        user.uid,
        context.credential.refreshToken,
        'google.com'
      )
      .then(() => {
        // Blocking the function is not required. The function can resolve while
        // this operation continues to run in the background.
        return new Promise((resolve, reject) => {
          // For this operation to succeed, the appropriate OAuth scope should be requested
          // on sign in with Google, client-side. In this case:
          // https://www.googleapis.com/auth/calendar
          // You can check granted_scopes from within:
          // context.additionalUserInfo.profile.granted_scopes (space joined list of scopes).

          // Set access token/refresh token.
          oAuth2Client.setCredentials({
            access_token: context.credential.accessToken,
            refresh_token: context.credential.refreshToken,
          });
          const calendar = google.calendar('v3');
          // Setup Onboarding event on user's calendar.
          const event = {/** ... */};
          calendar.events.insert({
            auth: oauth2client,
            calendarId: 'primary',
            resource: event,
          }, (err, event) => {
            // Do not fail. This is a best effort approach.
            resolve();
          });
      });
    })
  }
});

Passaggi successivi