Zugriff mit benutzerdefinierten Ansprüchen und Sicherheitsregeln steuern

Das Firebase Admin SDK unterstützt die Definition benutzerdefinierter Attribute in Nutzerkonten. So können Sie verschiedene Zugriffssteuerungsstrategien, einschließlich der rollenbasierten Zugriffssteuerung, in Firebase-Apps implementieren. Mit diesen benutzerdefinierten Attributen können Sie Nutzern verschiedene Zugriffsebenen (Rollen) zuweisen, die dann 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 erteilen.
• Sie können verschiedene Gruppen definieren, zu denen ein Nutzer gehört.
• Zugriff auf mehreren Ebenen gewähren:
  • Unterscheidung zwischen zahlenden und nicht zahlenden Abonnenten
  • Unterscheidung von Moderatoren und regulären Nutzern
  • Antrag von Lehrkräften/Schülern und Studenten usw.
• Fügen Sie einem Nutzer eine zusätzliche Kennung hinzu. Ein Firebase-Nutzer kann beispielsweise in einem anderen System einer anderen UID zugeordnet werden.

Angenommen, Sie möchten den Zugriff auf den Datenbankknoten „adminContent“ einschränken. Das ist beispielsweise mit einer Datenbanksuche in einer Liste von Administratornutzern möglich. Sie können dasselbe Ziel jedoch effizienter mit einem benutzerdefinierten Nutzer-Claim namens admin und der folgenden Realtime Database-Regel erreichen:

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

Benutzerdefinierte Nutzer-Claims sind über die Authentifizierungstokens des Nutzers zugänglich. Im obigen Beispiel haben nur Nutzer, deren Token-Claim admin auf „true“ gesetzt ist, Lese-/Schreibzugriff auf den Knoten adminContent. Da das ID-Token diese Zusicherungen 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 zum Senden dieser benutzerdefinierten Anforderungen. Der authentifizierte Zugriff muss das ID-Token vor der Verarbeitung der zugehörigen Anfrage validieren.

Hinweis :Obwohl sie miteinander in Verbindung stehen, sollten Sie benutzerdefinierte Nutzeransprüche nicht mit der benutzerdefinierten Authentifizierung verwechseln. Die benutzerdefinierte Authentifizierung wird in der Regel verwendet, wenn ein anderes Authentifizierungssystem mit Firebase-Diensten verwendet wird oder wenn Firebase Auth mit Anbietern erweitert werden soll, die nicht standardmäßig unterstützt werden. Benutzerdefinierte Ansprüche gelten für Nutzer, die bereits mit unterstützten Anbietern angemeldet sind (E‑Mail/Passwort, Google, Facebook, Telefon usw.). Beispielsweise kann ein Nutzer, der mit dem E-Mail-Adresse/Passwort-Anbieter von Firebase Auth angemeldet ist, die Zugriffssteuerung mithilfe benutzerdefinierter Anforderungen definieren.

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 sensible Daten enthalten, daher sollten sie nur mithilfe des Firebase Admin SDK über eine privilegierte Serverumgebung 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.
auth.go

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.

Hinweis :Bei diesem Vorgang werden die vorhandenen benutzerdefinierten Ansprüche des Nutzers immer überschrieben. Wenn jedoch dieselben benutzerdefinierten Nutzeransprüche für einen Nutzer definiert sind, der über die benutzerdefinierte Authentifizierung angemeldet ist, haben die sich überschneidenden Ansprüche im benutzerdefinierten Token eine höhere Priorität und überschreiben immer die benutzerdefinierten Nutzeransprüche, die für einen Nutzer über diese API definiert sind.
Wenn Sie beispielsweise setCustomUserClaims(uid, {foo: 'bar', key1: 'value1'}) aufrufen und den Nutzer mit dem benutzerdefinierten Token createCustomToken(uid, {foo: 'overwrite', key2: 'value2'}) anmelden, ergeben sich die folgenden Anforderungen für den Nutzer: {foo: 'overwrite', key2: 'value2', key1: 'value1'}).

Das Objekt für benutzerdefinierte Ansprüche darf keine reservierten OIDC-Schlüsselnamen oder reservierten Firebase-Namen enthalten. Die Nutzlast benutzerdefinierter Ansprüche darf nicht größer als 1.000 Byte sein.

Mit einem ID-Token, das an einen Back-End-Server gesendet wird, können die Identität und die Zugriffsebene des Nutzers mit dem Admin SDK so bestätigt werden:

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.
	}
}
auth.go

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 für das 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)
	}
}
auth.go

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 Ansprüche eines Nutzers löschen, indem Sie „null“ für customClaims übergeben.

Benutzerdefinierte Ansprüche an den Client weitergeben

Wenn neue Anforderungen für einen Nutzer über das Admin SDK geändert wurden, werden sie über das ID-Token auf die Client-Seite übertragen:

• Ein Nutzer meldet sich an oder authentifiziert sich noch einmal, nachdem die benutzerdefinierten Ansprüche geändert wurden. Das resultierende ID-Token enthält die neuesten Ansprüche.
• Das ID-Token einer bestehenden Nutzersitzung wird aktualisiert, nachdem ein altes Token abgelaufen ist.
• Ein ID-Token wird durch Aufrufen von currentUser.getIdToken(true) aktualisiert.

Auf benutzerdefinierte Ansprüche auf dem Client zugreifen

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

Sobald die neuesten Ansprüche an das ID-Token eines Nutzers weitergegeben wurden, können Sie sie abrufen, indem Sie das ID-Token abrufen:

JavaScript

firebase.auth().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 Ansprüche werden nur zur Zugriffssteuerung verwendet. Sie sind nicht dafür vorgesehen, zusätzliche Daten wie Profil- und andere benutzerdefinierte Daten zu speichern. Das mag zwar ein praktischer Mechanismus sein, wird aber dringend abgeraten, da diese Ansprüche im ID-Token gespeichert werden und Leistungsprobleme verursachen können, weil alle authentifizierten Anfragen immer ein Firebase-ID-Token enthalten, das dem angemeldeten Nutzer entspricht.

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

Beispiele und Anwendungsfälle

Die folgenden Beispiele veranschaulichen benutzerdefinierte Ansprüche im Kontext bestimmter Firebase-Anwendungsfälle.

Rollen beim Erstellen von Nutzern über Firebase Functions definieren

In diesem Beispiel werden beim Erstellen eines Nutzers mit Cloud Functions benutzerdefinierte Ansprüche für den Nutzer festgelegt.

Benutzerdefinierte Ansprüche 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 auf alle vorhandenen und zukünftigen Sitzungen übertragen. Wenn sich der Nutzer das nächste Mal mit den Nutzeranmeldedaten anmeldet, enthält das Token die benutzerdefinierten Ansprüche.

Clientseitige Implementierung (JavaScript)

const provider = new firebase.auth.GoogleAuthProvider();
firebase.auth().signInWithPopup(provider)
.catch(error => {
  console.log(error);
});

let callback = null;
let metadataRef = null;
firebase.auth().onAuthStateChanged(user => {
  // Remove previous listener.
  if (callback) {
    metadataRef.off('value', callback);
  }
  // On user login add new listener.
  if (user) {
    // Check if refresh is required.
    metadataRef = firebase.database().ref('metadata/' + user.uid + '/refreshTime');
    callback = (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);
    };
    // Subscribe new listener to changes on that node.
    metadataRef.on('value', callback);
  }
});

Cloud Functions-Logik

Es wird ein neuer Datenbankknoten (metadata/($uid)} mit Lese-/Schreibzugriff nur für den authentifizierten Nutzer 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)

const provider = new firebase.auth.GoogleAuthProvider();
firebase.auth().signInWithPopup(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.
          firebase.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 auch verwendet werden, wenn die Zugriffsebene eines vorhandenen Nutzers aktualisiert wird. Ein Beispiel: Ein Nutzer mit einem kostenlosen Konto führt ein Upgrade auf ein kostenpflichtiges Abo durch. 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 bezahlter Abonnent festgelegt. Eine erfolgreiche HTTP-Antwort wird an den Client zurückgegeben, um eine Aktualisierung des Tokens zu erzwingen.

Rollen über ein Backend-Skript definieren

Ein wiederkehrendes Skript (nicht vom Client initiiert) kann so eingerichtet werden, dass es ausgeführt wird, um benutzerdefinierte Nutzeransprüche zu aktualisieren:

Node.js

getAuth()
  .getUserByEmail('[e-mail]')
  .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("[e-mail]");
// 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('[e-mail]')
# 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, "[e-mail]")
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)
	}

}
auth.go

C#

UserRecord user = await FirebaseAuth.DefaultInstance
    .GetUserByEmailAsync("[e-mail]");
// 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 inkrementell über das Admin SDK geändert werden:

Node.js

getAuth()
  .getUserByEmail('[e-mail]')
  .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("[e-mail]");
// 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('[e-mail]')
# 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, "[e-mail]")
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)
	}

}
auth.go

C#

UserRecord user = await FirebaseAuth.DefaultInstance
    .GetUserByEmailAsync("[e-mail]");
// 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);
}