Zugriff mit benutzerdefinierten Ansprüchen und Sicherheitsregeln steuern

Das Firebase Admin SDK unterstützt die Definition benutzerdefinierter Attribute für Nutzerkonten. So können Sie verschiedene Zugriffssteuerungsstrategien, einschließlich der rollenbasierten Zugriffssteuerung, in Firebase-Apps implementieren. Diese benutzerdefinierten Attribute können Nutzern unterschiedliche Zugriffsebenen (Rollen) gewähren, die in den Sicherheitsregeln einer Anwendung erzwungen werden.

Nutzerrollen können für die folgenden gängigen Fälle definiert werden:

  • Einem Nutzer Administratorberechtigungen für den Zugriff auf Daten und Ressourcen gewähren.
  • Definieren verschiedener Gruppen, zu denen ein Nutzer gehört.
  • Zugriff auf mehreren Ebenen:
    • Unterscheidung zwischen zahlenden und nicht zahlenden Abonnenten
    • Moderatoren von normalen Nutzern unterscheiden
    • Anwendung für Lehrkräfte/Schüler und Studenten usw.
  • Fügen Sie einem Nutzer eine zusätzliche Kennung hinzu. Ein Firebase-Nutzer könnte beispielsweise in einem anderen System einer anderen UID zugeordnet sein.

Angenommen, Sie möchten den Zugriff auf den Datenbankknoten „adminContent“ einschränken. Dazu könnten Sie eine Datenbankabfrage für eine Liste von Administratornutzern durchführen. Sie können dasselbe Ziel jedoch effizienter mit einer benutzerdefinierten Nutzeranforderung namens admin mit der folgenden Realtime Database-Regel erreichen:

{
  "rules": {
    "adminContent": {
      ".read": "auth.token.admin === true",
      ".write": "auth.token.admin === true",
    }
  }
}

Benutzerdefinierte Nutzeransprüche sind über die Authentifizierungstokens des Nutzers zugänglich. Im obigen Beispiel haben nur Nutzer, bei denen admin in der Tokenforderung auf „true“ gesetzt ist, Lese-/Schreibzugriff auf den Knoten adminContent. Da das ID-Token diese Assertions bereits enthält, ist keine zusätzliche Verarbeitung oder Suche erforderlich, um die Administratorberechtigungen zu prüfen. Außerdem ist das ID-Token ein vertrauenswürdiger Mechanismus für die Bereitstellung dieser benutzerdefinierten Anforderungen. Bei jedem authentifizierten Zugriff muss das ID-Token validiert werden, bevor die zugehörige Anfrage verarbeitet wird.

Die auf dieser Seite beschriebenen Codebeispiele und Lösungen basieren sowohl auf den clientseitigen Firebase Auth APIs als auch auf den serverseitigen Auth APIs, die vom Admin SDK bereitgestellt werden.

Benutzerdefinierte Nutzeransprüche über das Admin SDK festlegen und validieren

Benutzerdefinierte Anforderungen können vertrauliche Daten enthalten. Daher sollten sie nur über eine privilegierte Serverumgebung vom Firebase Admin SDK festgelegt werden.

Node.js

// Set admin privilege on the user corresponding to uid.

getAuth()
  .setCustomUserClaims(uid, { admin: true })
  .then(() => {
    // The new custom claims will propagate to the user's ID token the
    // next time a new one is issued.
  });

Java

// Set admin privilege on the user corresponding to uid.
Map<String, Object> claims = new HashMap<>();
claims.put("admin", true);
FirebaseAuth.getInstance().setCustomUserClaims(uid, claims);
// The new custom claims will propagate to the user's ID token the
// next time a new one is issued.

Python

# Set admin privilege on the user corresponding to uid.
auth.set_custom_user_claims(uid, {'admin': True})
# The new custom claims will propagate to the user's ID token the
# next time a new one is issued.

Go

// Get an auth client from the firebase.App
client, err := app.Auth(ctx)
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

// Set admin privilege on the user corresponding to uid.
claims := map[string]interface{}{"admin": true}
err = client.SetCustomUserClaims(ctx, uid, claims)
if err != nil {
	log.Fatalf("error setting custom claims %v\n", err)
}
// The new custom claims will propagate to the user's ID token the
// next time a new one is issued.

C#

// Set admin privileges on the user corresponding to uid.
var claims = new Dictionary<string, object>()
{
    { "admin", true },
};
await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(uid, claims);
// The new custom claims will propagate to the user's ID token the
// next time a new one is issued.

Das Objekt für benutzerdefinierte Anforderungen darf keine reservierten OIDC-Schlüsselnamen oder reservierten Firebase-Namen enthalten. Die Nutzlast darf 1.000 Byte nicht überschreiten. Benutzerdefinierte Anforderungen müssen JSON-serialisierbar sein. Zu den unterstützten Typen gehören Strings, Zahlen, boolesche Werte, Arrays, Objekte und Null. Nicht unterstützte Typen wie „Date“, „undefined“, Funktionen oder andere Nicht-JSON-Werte verursachen Fehler.

Ein an einen Backend-Server gesendetes ID-Token kann die Identität und Zugriffsebene des Nutzers mithilfe des Admin SDK so bestätigen:

Node.js

// Verify the ID token first.
getAuth()
  .verifyIdToken(idToken)
  .then((claims) => {
    if (claims.admin === true) {
      // Allow access to requested admin resource.
    }
  });

Java

// Verify the ID token first.
FirebaseToken decoded = FirebaseAuth.getInstance().verifyIdToken(idToken);
if (Boolean.TRUE.equals(decoded.getClaims().get("admin"))) {
  // Allow access to requested admin resource.
}

Python

# Verify the ID token first.
claims = auth.verify_id_token(id_token)
if claims['admin'] is True:
    # Allow access to requested admin resource.
    pass

Go

// Verify the ID token first.
token, err := client.VerifyIDToken(ctx, idToken)
if err != nil {
	log.Fatal(err)
}

claims := token.Claims
if admin, ok := claims["admin"]; ok {
	if admin.(bool) {
		//Allow access to requested admin resource.
	}
}

C#

// Verify the ID token first.
FirebaseToken decoded = await FirebaseAuth.DefaultInstance.VerifyIdTokenAsync(idToken);
object isAdmin;
if (decoded.Claims.TryGetValue("admin", out isAdmin))
{
    if ((bool)isAdmin)
    {
        // Allow access to requested admin resource.
    }
}

Sie können auch die vorhandenen benutzerdefinierten Anforderungen eines Nutzers prüfen, die als Attribut im Nutzerobjekt verfügbar sind:

Node.js

// Lookup the user associated with the specified uid.
getAuth()
  .getUser(uid)
  .then((userRecord) => {
    // The claims can be accessed on the user record.
    console.log(userRecord.customClaims['admin']);
  });

Java

// Lookup the user associated with the specified uid.
UserRecord user = FirebaseAuth.getInstance().getUser(uid);
System.out.println(user.getCustomClaims().get("admin"));

Python

# Lookup the user associated with the specified uid.
user = auth.get_user(uid)
# The claims can be accessed on the user record.
print(user.custom_claims.get('admin'))

Go

// Lookup the user associated with the specified uid.
user, err := client.GetUser(ctx, uid)
if err != nil {
	log.Fatal(err)
}
// The claims can be accessed on the user record.
if admin, ok := user.CustomClaims["admin"]; ok {
	if admin.(bool) {
		log.Println(admin)
	}
}

C#

// Lookup the user associated with the specified uid.
UserRecord user = await FirebaseAuth.DefaultInstance.GetUserAsync(uid);
Console.WriteLine(user.CustomClaims["admin"]);

Sie können die benutzerdefinierten Anforderungen eines Nutzers löschen, indem Sie „null“ für customClaims übergeben.

Benutzerdefinierte Anforderungen an den Client weitergeben

Nachdem neue Anforderungen für einen Nutzer über das Admin SDK geändert wurden, werden sie über das ID-Token auf folgende Weise an einen authentifizierten Nutzer auf der Clientseite weitergegeben:

  • Ein Nutzer meldet sich an oder authentifiziert sich neu, nachdem die benutzerdefinierten Anforderungen geändert wurden. Das als Ergebnis ausgestellte ID-Token enthält die neuesten Anforderungen.
  • Das ID-Token einer bestehenden Nutzersitzung wird aktualisiert, nachdem ein älteres Token abgelaufen ist.
  • Ein ID-Token wird durch Aufrufen von currentUser.getIdToken(true) erzwungen aktualisiert.

Auf benutzerdefinierte Anforderungen auf dem Client zugreifen

Benutzerdefinierte Anforderungen können nur über das ID-Token des Nutzers abgerufen werden. Der Zugriff auf diese Anforderungen kann erforderlich sein, um die Client-UI basierend auf der Rolle oder Zugriffsebene des Nutzers zu ändern. Der Zugriff auf das Backend sollte jedoch immer über das ID-Token erzwungen werden, nachdem es validiert und seine Anforderungen geparst wurden. Benutzerdefinierte Anforderungen sollten nicht direkt an das Backend gesendet werden, da sie außerhalb des Tokens nicht vertrauenswürdig sind.

Sobald die neuesten Anforderungen an das ID-Token eines Nutzers weitergegeben wurden, können Sie sie durch Abrufen des ID-Tokens abrufen:

JavaScript

import { getAuth } from "firebase/auth";
getAuth().currentUser?.getIdTokenResult()
  .then((idTokenResult) => {
     // Confirm the user is an Admin.
     if (!!idTokenResult.claims.admin) {
       // Show admin UI.
       showAdminUI();
     } else {
       // Show regular user UI.
       showRegularUI();
     }
  })
  .catch((error) => {
    console.log(error);
  });

Android

user.getIdToken(false).addOnSuccessListener(new OnSuccessListener<GetTokenResult>() {
  @Override
  public void onSuccess(GetTokenResult result) {
    boolean isAdmin = result.getClaims().get("admin");
    if (isAdmin) {
      // Show admin UI.
      showAdminUI();
    } else {
      // Show regular user UI.
      showRegularUI();
    }
  }
});

Swift

user.getIDTokenResult(completion: { (result, error) in
  guard let admin = result?.claims?["admin"] as? NSNumber else {
    // Show regular user UI.
    showRegularUI()
    return
  }
  if admin.boolValue {
    // Show admin UI.
    showAdminUI()
  } else {
    // Show regular user UI.
    showRegularUI()
  }
})

Objective-C

user.getIDTokenResultWithCompletion:^(FIRAuthTokenResult *result,
                                      NSError *error) {
  if (error != nil) {
    BOOL *admin = [result.claims[@"admin"] boolValue];
    if (admin) {
      // Show admin UI.
      [self showAdminUI];
    } else {
      // Show regular user UI.
      [self showRegularUI];
    }
  }
}];

Best Practices für benutzerdefinierte Ansprüche

Benutzerdefinierte Anforderungen werden nur für die Zugriffssteuerung verwendet. Sie sind nicht dafür ausgelegt, zusätzliche Daten (z. B. Profil- und andere benutzerdefinierte Daten) zu speichern. Dies mag zwar wie ein praktischer Mechanismus erscheinen, wird jedoch dringend davon abgeraten, da diese Anforderungen im ID-Token gespeichert werden und Leistungsprobleme verursachen können, da alle authentifizierten Anfragen immer ein Firebase-ID-Token enthalten, das dem angemeldeten Nutzer entspricht.

  • Verwenden Sie benutzerdefinierte Anforderungen nur zum Speichern von Daten für die Steuerung des Nutzerzugriffs. Alle anderen Daten sollten separat über die Echtzeitdatenbank oder einen anderen serverseitigen Speicher gespeichert werden.
  • Benutzerdefinierte Anforderungen sind in ihrer Größe begrenzt. Wenn eine Nutzlast für benutzerdefinierte Anforderungen mit mehr als 1.000 Byte übergeben wird, wird ein Fehler ausgegeben.

Beispiele und Anwendungsfälle

Die folgenden Beispiele veranschaulichen benutzerdefinierte Anforderungen im Kontext bestimmter Firebase-Anwendungsfälle.

Rollen über Firebase Functions bei der Nutzererstellung definieren

In diesem Beispiel werden benutzerdefinierte Anforderungen für einen Nutzer bei der Erstellung mit Cloud Functions festgelegt.

Benutzerdefinierte Anforderungen können mit Cloud Functions hinzugefügt und mit Realtime Database sofort weitergegeben werden. Die Funktion wird nur bei der Registrierung mit einem onCreate-Trigger aufgerufen. Sobald die benutzerdefinierten Anforderungen festgelegt sind, werden sie an alle vorhandenen und zukünftigen Sitzungen weitergegeben. Wenn sich der Nutzer das nächste Mal mit den Nutzeranmeldedaten anmeldet, enthält das Token die benutzerdefinierten Anforderungen.

Clientseitige Implementierung (JavaScript)

import { GoogleAuthProvider, signInWithPopup, getAuth, onAuthStateChanged } from "firebase/auth";
import { getDatabase, onValue, ref } from "firebase/database";

const auth = getAuth();
const database = getDatabase();

const provider = new GoogleAuthProvider();

signInWithPopup(auth, provider).catch(error => {
  console.log(error);
});

let unsubscribeFn = null;
let metadataRef = null;
onAuthStateChanged(auth, user => {
  // Remove previous listener.
  if (unsubscribeFn) {
    unsubscribeFn();
  }
  // On user login add new listener.
  if (user) {
    // Check if refresh is required.
    metadataRef = ref(database, 'metadata/' + user.uid + '/refreshTime');
    // Subscribe new listener to changes on that node.
    unsubscribeFn = onValue(metadataRef, async (snapshot) => {
      // Force refresh to pick up the latest custom claims changes.
      // Note this is always triggered on first call. Further optimization could be
      // added to avoid the initial trigger when the token is issued and already contains
      // the latest claims.
      user.getIdToken(true);
    });
  }
});

Cloud Functions-Logik

Ein neuer Datenbankknoten (metadata/($uid)} mit Lese-/Schreibzugriff, der auf den authentifizierten Nutzer beschränkt ist, wird hinzugefügt.

const functions = require('firebase-functions');
const { initializeApp } = require('firebase-admin/app');
const { getAuth } = require('firebase-admin/auth');
const { getDatabase } = require('firebase-admin/database');

initializeApp();

// On sign up.
exports.processSignUp = functions.auth.user().onCreate(async (user) => {
  // Check if user meets role criteria.
  if (
    user.email &&
    user.email.endsWith('@admin.example.com') &&
    user.emailVerified
  ) {
    const customClaims = {
      admin: true,
      accessLevel: 9
    };

    try {
      // Set custom user claims on this newly created user.
      await getAuth().setCustomUserClaims(user.uid, customClaims);

      // Update real-time database to notify client to force refresh.
      const metadataRef = getDatabase().ref('metadata/' + user.uid);

      // Set the refresh time to the current UTC timestamp.
      // This will be captured on the client to force a token refresh.
      await  metadataRef.set({refreshTime: new Date().getTime()});
    } catch (error) {
      console.log(error);
    }
  }
});

Datenbankregeln

{
  "rules": {
    "metadata": {
      "$user_id": {
        // Read access only granted to the authenticated user.
        ".read": "$user_id === auth.uid",
        // Write access only via Admin SDK.
        ".write": false
      }
    }
  }
}

Rollen über eine HTTP-Anfrage definieren

Im folgenden Beispiel werden benutzerdefinierte Nutzeransprüche für einen neu angemeldeten Nutzer über eine HTTP-Anfrage festgelegt.

Clientseitige Implementierung (JavaScript)

import { GoogleAuthProvider, signInWithPopup, getAuth, onAuthStateChanged } from "firebase/auth";
import { getDatabase, onValue, ref } from "firebase/database";

const auth = getAuth();
const database = getDatabase();

const provider = new GoogleAuthProvider();

signInWithPopup(auth, provider)
.then((result) => {
  // User is signed in. Get the ID token.
  return result.user.getIdToken();
})
.then((idToken) => {
  // Pass the ID token to the server.
  $.post(
    '/setCustomClaims',
    {
      idToken: idToken
    },
    (data, status) => {
      // This is not required. You could just wait until the token is expired
      // and it proactively refreshes.
      if (status == 'success' && data) {
        const json = JSON.parse(data);
        if (json && json.status == 'success') {
          // Force token refresh. The token claims will contain the additional claims.
          auth.currentUser.getIdToken(true);
        }
      }
    });
}).catch((error) => {
  console.log(error);
});

Backend-Implementierung (Admin SDK)

app.post('/setCustomClaims', async (req, res) => {
  // Get the ID token passed.
  const idToken = req.body.idToken;

  // Verify the ID token and decode its payload.
  const claims = await getAuth().verifyIdToken(idToken);

  // Verify user is eligible for additional privileges.
  if (
    typeof claims.email !== 'undefined' &&
    typeof claims.email_verified !== 'undefined' &&
    claims.email_verified &&
    claims.email.endsWith('@admin.example.com')
  ) {
    // Add custom claims for additional privileges.
    await getAuth().setCustomUserClaims(claims.sub, {
      admin: true
    });

    // Tell client to refresh token on user.
    res.end(JSON.stringify({
      status: 'success'
    }));
  } else {
    // Return nothing.
    res.end(JSON.stringify({ status: 'ineligible' }));
  }
});

Derselbe Ablauf kann verwendet werden, wenn die Zugriffsebene eines vorhandenen Nutzers erhöht wird. Nehmen wir zum Beispiel einen Nutzer, der von einem kostenlosen zu einem kostenpflichtigen Abo wechselt. Das ID-Token des Nutzers wird zusammen mit den Zahlungsinformationen über eine HTTP-Anfrage an den Backend-Server gesendet. Wenn die Zahlung erfolgreich verarbeitet wurde, wird der Nutzer über das Admin SDK als zahlender Abonnent festgelegt. Eine erfolgreiche HTTP-Antwort wird an den Client zurückgegeben, um die Tokenaktualisierung zu erzwingen.

Rollen über ein Backend-Skript definieren

Ein wiederkehrendes Skript (nicht vom Client initiiert) könnte so eingerichtet werden, dass es die benutzerdefinierten Anforderungen des Nutzers aktualisiert:

Node.js

getAuth()
  .getUserByEmail('user@admin.example.com')
  .then((user) => {
    // Confirm user is verified.
    if (user.emailVerified) {
      // Add custom claims for additional privileges.
      // This will be picked up by the user on token refresh or next sign in on new device.
      return getAuth().setCustomUserClaims(user.uid, {
        admin: true,
      });
    }
  })
  .catch((error) => {
    console.log(error);
  });

Java

UserRecord user = FirebaseAuth.getInstance()
    .getUserByEmail("user@admin.example.com");
// Confirm user is verified.
if (user.isEmailVerified()) {
  Map<String, Object> claims = new HashMap<>();
  claims.put("admin", true);
  FirebaseAuth.getInstance().setCustomUserClaims(user.getUid(), claims);
}

Python

user = auth.get_user_by_email('user@admin.example.com')
# Confirm user is verified
if user.email_verified:
    # Add custom claims for additional privileges.
    # This will be picked up by the user on token refresh or next sign in on new device.
    auth.set_custom_user_claims(user.uid, {
        'admin': True
    })

Go

user, err := client.GetUserByEmail(ctx, "user@admin.example.com")
if err != nil {
	log.Fatal(err)
}
// Confirm user is verified
if user.EmailVerified {
	// Add custom claims for additional privileges.
	// This will be picked up by the user on token refresh or next sign in on new device.
	err := client.SetCustomUserClaims(ctx, user.UID, map[string]interface{}{"admin": true})
	if err != nil {
		log.Fatalf("error setting custom claims %v\n", err)
	}

}

C#

UserRecord user = await FirebaseAuth.DefaultInstance
    .GetUserByEmailAsync("user@admin.example.com");
// Confirm user is verified.
if (user.EmailVerified)
{
    var claims = new Dictionary<string, object>()
    {
        { "admin", true },
    };
    await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(user.Uid, claims);
}

Benutzerdefinierte Anforderungen können auch schrittweise über das Admin SDK geändert werden:

Node.js

getAuth()
  .getUserByEmail('user@admin.example.com')
  .then((user) => {
    // Add incremental custom claim without overwriting existing claims.
    const currentCustomClaims = user.customClaims;
    if (currentCustomClaims['admin']) {
      // Add level.
      currentCustomClaims['accessLevel'] = 10;
      // Add custom claims for additional privileges.
      return getAuth().setCustomUserClaims(user.uid, currentCustomClaims);
    }
  })
  .catch((error) => {
    console.log(error);
  });

Java

UserRecord user = FirebaseAuth.getInstance()
    .getUserByEmail("user@admin.example.com");
// Add incremental custom claim without overwriting the existing claims.
Map<String, Object> currentClaims = user.getCustomClaims();
if (Boolean.TRUE.equals(currentClaims.get("admin"))) {
  // Add level.
  currentClaims.put("level", 10);
  // Add custom claims for additional privileges.
  FirebaseAuth.getInstance().setCustomUserClaims(user.getUid(), currentClaims);
}

Python

user = auth.get_user_by_email('user@admin.example.com')
# Add incremental custom claim without overwriting existing claims.
current_custom_claims = user.custom_claims
if current_custom_claims.get('admin'):
    # Add level.
    current_custom_claims['accessLevel'] = 10
    # Add custom claims for additional privileges.
    auth.set_custom_user_claims(user.uid, current_custom_claims)

Go

user, err := client.GetUserByEmail(ctx, "user@admin.example.com")
if err != nil {
	log.Fatal(err)
}
// Add incremental custom claim without overwriting existing claims.
currentCustomClaims := user.CustomClaims
if currentCustomClaims == nil {
	currentCustomClaims = map[string]interface{}{}
}

if _, found := currentCustomClaims["admin"]; found {
	// Add level.
	currentCustomClaims["accessLevel"] = 10
	// Add custom claims for additional privileges.
	err := client.SetCustomUserClaims(ctx, user.UID, currentCustomClaims)
	if err != nil {
		log.Fatalf("error setting custom claims %v\n", err)
	}

}

C#

UserRecord user = await FirebaseAuth.DefaultInstance
    .GetUserByEmailAsync("user@admin.example.com");
// Add incremental custom claims without overwriting the existing claims.
object isAdmin;
if (user.CustomClaims.TryGetValue("admin", out isAdmin) && (bool)isAdmin)
{
    var claims = user.CustomClaims.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
    // Add level.
    var level = 10;
    claims["level"] = level;
    // Add custom claims for additional privileges.
    await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(user.Uid, claims);
}