Kontrollieren Sie den Zugriff mit benutzerdefinierten Ansprüchen und Sicherheitsregeln

Das Firebase Admin SDK unterstützt das Definieren benutzerdefinierter Attribute für Benutzerkonten. Dies bietet die Möglichkeit, verschiedene Zugriffskontrollstrategien, einschließlich rollenbasierter Zugriffskontrolle, in Firebase-Apps zu implementieren. Diese benutzerdefinierten Attribute können Benutzern unterschiedliche Zugriffsebenen (Rollen) geben, die in den Sicherheitsregeln einer Anwendung erzwungen werden.

Benutzerrollen können für die folgenden häufigen Fälle definiert werden:

  • Gewähren von Administratorrechten für den Zugriff auf Daten und Ressourcen.
  • Definieren verschiedener Gruppen, denen ein Benutzer angehört.
  • Bereitstellung eines mehrstufigen Zugriffs:
    • Unterscheidung von bezahlten/unbezahlten Abonnenten.
    • Unterscheidung von Moderatoren von normalen Benutzern.
    • Bewerbung für Lehrer/Schüler usw.
  • Fügen Sie einem Benutzer eine zusätzliche Kennung hinzu. Ein Firebase-Benutzer könnte beispielsweise einer anderen UID in einem anderen System zugeordnet werden.

Betrachten wir einen Fall, in dem Sie den Zugriff auf den Datenbankknoten "adminContent" einschränken möchten. Sie können dies mit einer Datenbanksuche in einer Liste von Administratorbenutzern tun. Sie können jedoch die gleiche Ziel effizienter mit einem benutzerdefinierten Benutzer Anspruch namens erreichen admin mit der folgenden Realtime - Datenbank - Regel:

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

Auf benutzerdefinierte Benutzeransprüche kann über die Authentifizierungstoken des Benutzers zugegriffen werden. In dem obigen Beispiel nur Benutzer mit admin - Satz auf true in ihrem Token Anspruch würden zu Lese- / Schreibzugriff haben adminContent - Knoten. Da das ID-Token diese Zusicherungen bereits enthält, ist keine zusätzliche Verarbeitung oder Suche erforderlich, um nach Administratorberechtigungen zu suchen. Darüber hinaus ist das ID-Token ein vertrauenswürdiger Mechanismus zum Zustellen dieser benutzerdefinierten Ansprüche. Jeder authentifizierte Zugriff muss das ID-Token validieren, bevor die zugehörige Anfrage verarbeitet wird.

Die Codebeispiele und Lösungen in dieser Seite beschrieben sowohl Zug von der clientseitigen Firebase Auth APIs und dem serverseitige Authentifizierungs APIs bereitgestellt durch das Admin SDK .

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

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

Node.js

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

admin
  .auth()
  .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.

Gehen

// 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 benutzerdefinierten Ansprüche Objekt nicht enthält jede OIDC reserviert Schlüsselnamen oder Firebase reservierte Namen. Die Nutzlast der benutzerdefinierten Ansprüche darf 1.000 Byte nicht überschreiten.

Ein an einen Back-End-Server gesendetes ID-Token kann die Identität und Zugriffsebene des Benutzers mithilfe des Admin-SDK wie folgt bestätigen:

Node.js

// Verify the ID token first.
admin
  .auth()
  .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

Gehen

// 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 Ansprüche eines Benutzers überprüfen, die als Eigenschaft für das Benutzerobjekt verfügbar sind:

Node.js

// Lookup the user associated with the specified uid.
admin
  .auth()
  .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'))

Gehen

// 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 , indem null für einen Benutzer benutzerdefinierter Ansprüche löschen customClaims .

Benutzerdefinierte Ansprüche an den Kunden weitergeben

Nachdem neue Ansprüche für einen Benutzer über das Admin SDK geändert wurden, werden sie auf der Clientseite über das ID-Token wie folgt an einen authentifizierten Benutzer weitergegeben:

  • Ein Benutzer meldet sich an oder authentifiziert sich erneut, nachdem die benutzerdefinierten Ansprüche geändert wurden. Das als Ergebnis ausgestellte ID-Token enthält die neuesten Ansprüche.
  • Das ID-Token einer vorhandenen Benutzersitzung wird aktualisiert, nachdem ein älteres Token abläuft.
  • Eine ID - Token Kraft ist aufgefrischt durch den Aufruf currentUser.getIdToken(true) .

Greifen Sie auf benutzerdefinierte Ansprüche auf dem Client zu

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 Benutzers zu ändern. Der Back-End-Zugriff sollte jedoch immer über das ID-Token erzwungen werden, nachdem es validiert und seine Ansprüche analysiert wurden. Benutzerdefinierte Ansprüche sollten nicht direkt an das Back-End gesendet werden, da ihnen außerhalb des Tokens nicht vertraut werden kann.

Sobald die neuesten Ansprüche an das ID-Token eines Benutzers 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();
    }
  }
});

Schnell

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()
  }
})

Ziel 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 verwendet, um die Zugriffskontrolle bereitzustellen. Sie sind nicht dafür ausgelegt, zusätzliche Daten (wie Profil- und andere benutzerdefinierte Daten) zu speichern. Dies mag zwar ein bequemer Mechanismus sein, es wird jedoch dringend davon abgeraten, da diese Ansprüche im ID-Token gespeichert werden und Leistungsprobleme verursachen können, da alle authentifizierten Anforderungen immer ein Firebase-ID-Token enthalten, das dem angemeldeten Benutzer entspricht.

  • Verwenden Sie benutzerdefinierte Ansprüche, um Daten nur zum Steuern des Benutzerzugriffs zu speichern. Alle anderen Daten sollten separat über die Echtzeitdatenbank oder einen anderen serverseitigen Speicher gespeichert werden.
  • Benutzerdefinierte Ansprüche sind in der Größe begrenzt. Die Übergabe einer benutzerdefinierten Anspruchsnutzlast von mehr als 1000 Byte führt zu einem Fehler.

Beispiele und Anwendungsfälle

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

Definieren von Rollen über Firebase Functions bei der Benutzererstellung

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

Benutzerdefinierte Ansprüche können mit Cloud Functions hinzugefügt und sofort mit Realtime Database verbreitet werden. Die Funktion wird nur auf die Registrierung mit einem genannt onCreate Trigger. Sobald die benutzerdefinierten Ansprüche festgelegt wurden, werden sie auf alle vorhandenen und zukünftigen Sitzungen übertragen. Wenn sich der Benutzer das nächste Mal mit den Benutzeranmeldeinformationen 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

Ein neuer Datenbankknoten (metadata/($uid)} mit Lese-/Schreibzugriff auf den authentifizierten Benutzer wird hinzugefügt.

const functions = require('firebase-functions');

const admin = require('firebase-admin');
admin.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 admin.auth().setCustomUserClaims(user.uid, customClaims);

      // Update real-time database to notify client to force refresh.
      const metadataRef = admin.database().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 Benutzeransprüche für einen neu angemeldeten Benutzer über eine HTTP-Anforderung 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);
});

Back-End-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 admin.auth().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 admin.auth().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' }));
  }
});

Der gleiche Ablauf kann verwendet werden, wenn die Zugriffsebene eines vorhandenen Benutzers aktualisiert wird. Nehmen Sie zum Beispiel ein kostenloses Upgrade auf ein kostenpflichtiges Abonnement. Der ID-Token des Benutzers wird mit den Zahlungsinformationen über eine HTTP-Anfrage an den Backend-Server gesendet. Wenn die Zahlung erfolgreich verarbeitet wurde, wird der Benutzer über das Admin SDK als bezahlter Abonnent festgelegt. Eine erfolgreiche HTTP-Antwort wird an den Client zurückgegeben, um die Tokenaktualisierung zu erzwingen.

Rollen über Backend-Skript definieren

Ein wiederkehrendes Skript (nicht vom Client initiiert) könnte so eingerichtet werden, dass es ausgeführt wird, um benutzerdefinierte Ansprüche des Benutzers zu aktualisieren:

Node.js

admin
  .auth()
  .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 admin.auth().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
    })

Gehen

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 Ansprüche können auch inkrementell über das Admin SDK geändert werden:

Node.js

admin
  .auth()
  .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 admin.auth().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)

Gehen

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 = new Dictionary<string, object>(user.CustomClaims);
    // Add level.
    claims["level"] = 10;
    // Add custom claims for additional privileges.
    await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(user.Uid, claims);
}