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 in Firebase-Apps verschiedene Zugriffssteuerungsstrategien implementieren, einschließlich der rollenbasierten Zugriffssteuerung. Mit diesen benutzerdefinierten Attributen können Sie Nutzern unterschiedliche 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.
• Definition verschiedener Gruppen, zu denen ein Nutzer gehört.
• Zugriff auf mehreren Ebenen bereitstellen:
  • Unterscheiden zwischen zahlenden und nicht zahlenden Abonnenten
  • Moderatoren von normalen Nutzern unterscheiden
  • Anwendung für Lehrer/Schüler usw.
• Einem Nutzer eine zusätzliche Kennung hinzufügen Ein Firebase-Nutzer könnte beispielsweise einer anderen UID in einem anderen System zugeordnet werden.

Angenommen, Sie möchten den Zugriff auf den Datenbankknoten „adminContent“. Sie könnten dies mit einer Datenbanksuche in einer Liste von Administratoren. Sie können dasselbe Ziel jedoch effizienter erreichen, wenn Sie eine benutzerdefinierte Nutzeranforderung namens admin mit der folgenden Realtime Database-Regel:

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

Auf benutzerdefinierte Nutzeranforderungen kann über die Authentifizierungstoken des Nutzers zugegriffen werden. Im obigen Beispiel sind nur Nutzer, bei denen admin im Tokenanspruch auf „true“ gesetzt ist, hätte Lese-/Schreibzugriff Zugriff auf adminContent Knoten. Da das ID-Token diese Assertions erstellen, ist keine weitere Verarbeitung oder Suche zur Prüfung auf Berechtigungen. Darüber hinaus ist das ID-Token ein vertrauenswürdiger Mechanismus für diese benutzerdefinierten Behauptungen. Bei jedem authentifizierten Zugriff muss das ID-Token validiert werden, bevor Anfrage bearbeitet wird.

Hinweis: Auch wenn sie zusammenhängen, solltest du benutzerdefinierte Nutzeraussagen nicht mit benutzerdefinierte Authentifizierung. Die benutzerdefinierte Authentifizierung wird im Allgemeinen bei Verwendung eines Authentifizierungssystem mit Firebase-Diensten Firebase Auth mit Anbietern, die standardmäßig nicht unterstützt werden. Benutzerdefiniert Die Ansprüche gelten für Nutzer, die bereits über unterstützte Anbieter angemeldet sind. (E-Mail-Adresse/Passwort, Google, Facebook, Telefon usw.). Beispiel: Ein Nutzer hat sich mit dem E-Mail-/Passwortanbieter von Firebase Auth kann die Zugriffssteuerung definieren mithilfe von benutzerdefinierten Ansprüchen.

Die auf dieser Seite beschriebenen Codebeispiele und Lösungen basieren auf clientseitigen Firebase Auth APIs und die serverseitigen Auth APIs, die von das Admin SDK

Benutzerdefinierte Nutzeranforderungen über das Admin SDK festlegen und validieren

Benutzerdefinierte Ansprüche können sensible Daten enthalten und sollten daher nur festgelegt werden über das Firebase Admin SDK von einer privilegierten Serverumgebung gehostet wird.

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: Durch diesen Vorgang werden die vorhandenen benutzerdefinierten Berechtigungen des Nutzers immer überschrieben. Wenn jedoch für einen Nutzer, der angemeldet ist über Benutzerdefinierte Authentifizierung, die sich überschneidenden Ansprüche im benutzerdefinierten Token haben eine höhere Priorität und überschreiben immer den benutzerdefinierten Nutzer Anforderungen, die über diese API für einen Nutzer definiert wurden.
Beispiel: setCustomUserClaims(uid, {foo: 'bar', key1: 'value1'}) aufrufen und sich mit dem benutzerdefinierten Token anmelden, createCustomToken(uid, {foo: 'overwrite', key2: 'value2'}) Ergebnisse in folgenden Ansprüchen auf den Nutzer {foo: 'overwrite', key2: 'value2', key1: 'value1'})

Das Objekt für benutzerdefinierte Ansprüche sollte keine Reservierte OIDC-Schlüsselnamen oder reservierte Namen in Firebase. Die Nutzlast für benutzerdefinierte Ansprüche darf 1.000 Byte nicht überschreiten.

Ein ID-Token, das an einen Backend-Server gesendet wird, kann die Identität und den Zugriff des Nutzers bestätigen mit dem Admin SDK an:

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

Du kannst auch die bestehenden benutzerdefinierten Ansprüche eines Nutzers prüfen, die als beim Nutzerobjekt:

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

Benutzerdefinierte Anforderungen an den Kunden weitergeben

Neue Ansprüche, die für einen Nutzer über das Admin SDK geändert wurden, werden weitergegeben. auf der Clientseite über das ID-Token Möglichkeiten:

• Ein Nutzer meldet sich an oder authentifiziert sich noch einmal, nachdem die benutzerdefinierten Anforderungen geändert wurden. Das ID-Token, das daraufhin ausgestellt wird, enthält die neuesten Anforderungen.
• Das ID-Token einer vorhandenen Nutzersitzung wird aktualisiert, nachdem ein älteres Token abgelaufen ist.
• Die Aktualisierung eines ID-Tokens wird durch Aufrufen von currentUser.getIdToken(true) erzwungen.

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 Berechtigungen kann erforderlich sein, um die Client-Benutzeroberfläche entsprechend der Rolle oder Zugriffsebene des Nutzers zu ändern. Der Back-End-Zugriff sollte jedoch immer über die ID erzwungen werden. nach der Validierung und dem Parsen der Anforderungen. Benutzerdefinierte Ansprüche sollten nicht direkt an das Back-End gesendet, da sie außerhalb des Tokens nicht als vertrauenswürdig eingestuft werden können.

Sobald die neuesten Ansprüche an das ID-Token eines Nutzers weitergegeben wurden, kannst du sie abrufen, indem du das ID-Token abrufst:

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 für die Zugriffssteuerung verwendet. Sie sind nicht für die Speicherung zusätzlicher Daten wie Profil- und anderer benutzerdefinierter Daten vorgesehen. Dies kann zwar eine bequeme Methode zu sein scheinen, wird dringend davon abgeraten, da diese Anforderungen werden im ID-Token gespeichert und können Leistungsprobleme verursachen, authentifizierte Anfragen enthalten immer ein Firebase-ID-Token, das dem angemeldeten Nutzer.

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

Beispiele und Anwendungsfälle

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

Rollen über Firebase-Funktionen bei der Nutzererstellung definieren

In diesem Beispiel werden benutzerdefinierte Ansprüche auf einen Nutzer bei der Erstellung mit festgelegt. Cloud Functions

Benutzerdefinierte Ansprüche können mit Cloud Functions hinzugefügt und sofort weitergegeben werden mit Realtime Database. Die Funktion wird nur bei der Registrierung über einen onCreate-Trigger aufgerufen. Sobald die benutzerdefinierten Ansprüche festgelegt sind, werden sie für alle bestehenden und für zukünftige Sitzungen. Wenn sich der Nutzer das nächste Mal mit seinen Anmeldedaten anmeldet, das Token die benutzerdefinierten Anforderungen enthält.

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

Einen neuen Datenbankknoten (metadata/($uid)} mit Lese-/Schreibzugriff auf die authentifizierter 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 über eine HTTP-Anfrage für einen neu angemeldeten Nutzer 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 beim Upgraden der Zugriffsebene eines vorhandenen Nutzers verwendet werden. Beispiel: Ein kostenloser Nutzer führt ein Upgrade auf ein kostenpflichtiges Abo durch. ID des Nutzers mit den Zahlungsinformationen über HTTP an den Backend-Server gesendet, Wenn die Zahlung erfolgreich verarbeitet wurde, wird der Nutzer als bezahlter Nutzer festgelegt. Abonnent über das Admin SDK an. Eine erfolgreiche HTTP-Antwort wird an den Client zurückgegeben, um die Tokenaktualisierung zu erzwingen.

Rollen über Back-End-Skript definieren

Ein wiederkehrendes Skript (nicht vom Client initiiert) könnte so eingestellt werden, dass es Benutzerdefinierte Ansprüche von Nutzern 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 Ansprüche 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);
}