Kontrola dostępu za pomocą żądań niestandardowych i reguł zabezpieczeń

Pakiet Firebase Admin SDK umożliwia definiowanie niestandardowych atrybutów na kontach użytkowników. Umożliwia to wdrażanie w aplikacjach Firebase różnych strategii kontroli dostępu, w tym kontroli dostępu opartej na rolach. Te atrybuty niestandardowe mogą przyznawać użytkownikom różne poziomy dostępu (role), które są egzekwowane w ramach reguł bezpieczeństwa aplikacji.

Role użytkowników można zdefiniować w tych typowych przypadkach:

  • Przyznawanie użytkownikowi uprawnień administracyjnych do dostępu do danych i zasobów.
  • definiowanie różnych grup, do których należy użytkownik;
  • Przyznawanie dostępu na wielu poziomach:
    • odróżnianie płatnych i bezpłatnych subskrybentów.
    • odróżnianie moderatorów od zwykłych użytkowników.
    • Aplikacja dla nauczycieli/uczniów itp.
  • Dodaj dodatkowy identyfikator użytkownika. Na przykład użytkownik Firebase może być mapowany na inny identyfikator UID w innym systemie.

Rozważmy przypadek, w którym chcesz ograniczyć dostęp do węzła bazy danych „adminContent”. Możesz to zrobić, wyszukując w bazie danych listę użytkowników z poziomem dostępu administratora. Możesz jednak osiągnąć ten sam cel bardziej efektywnie, używając niestandardowego roszczenia dotyczącego użytkownika o nazwie admin z taką regułą Realtime Database:

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

Za pomocą tokenów uwierzytelniania użytkownika można uzyskać dostęp do niestandardowych informacji o użytkowniku. W powyższym przykładzie tylko użytkownicy, którzy w swoim tokenie mają wartość „true” dla atrybutu admin, mieliby dostęp do odczytu i zapisu do węzła adminContent. Ponieważ token identyfikacyjny zawiera już te oświadczenia, nie trzeba przeprowadzać dodatkowej analizy ani wyszukiwania w celu sprawdzenia uprawnień administratora. Dodatkowo token identyfikatora to zaufany mechanizm dostarczania tych niestandardowych informacji. Wszystkie uwierzytelnione dostępy muszą potwierdzić token identyfikacyjny przed przetworzeniem powiązanego żądania.

Przykłady kodu i rozwiązania opisane na tej stronie korzystają zarówno z interfejsów API Firebase Auth po stronie klienta, jak i z interfejsów Auth po stronie serwera udostępnianych przez pakiet Admin SDK.

Ustawianie i weryfikowanie niestandardowych oświadczeń użytkownika za pomocą pakietu Admin SDK

Zasoby niestandardowe mogą zawierać dane wrażliwe, dlatego powinny być ustawiane tylko przez pakiet Firebase Admin SDK z uprzywilejowanego środowiska serwera.

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.

Obiekt roszczeń niestandardowych nie powinien zawierać nazw kluczy zarezerwowanych przez OIDC ani nazwy zarezerwowanej przez Firebase. Dane w zapytaniu niestandardowym nie mogą przekraczać 1000 bajtów.

Token identyfikatora wysłany na serwer backendu może potwierdzić tożsamość użytkownika i poziom dostępu za pomocą pakietu Admin SDK w następujący sposób:

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

Możesz też sprawdzić dotychczasowe oświadczenia niestandardowe użytkownika, które są dostępne jako właściwości obiektu użytkownika:

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"]);

Aby usunąć niestandardowe oświadczenia użytkownika, prześlij wartość null dla argumentu customClaims.

Rozsyłanie zaświadczeń niestandardowych do klienta

Gdy nowe oświadczenia zostaną zmodyfikowane w pakiecie Admin SDK, zostaną one przekazane uwierzytelnionemu użytkownikowi po stronie klienta za pomocą tokena ID w następujący sposób:

  • Użytkownik loguje się lub ponownie uwierzytelnia po zmodyfikowaniu niestandardowych oświadczeń. Wygenerowany w ten sposób token tożsamości będzie zawierać najnowsze deklaracje.
  • Po wygaśnięciu starszego tokena istniejąca sesja użytkownika jest odświeżana za pomocą tokena identyfikacyjnego.
  • Token identyfikatora jest wymuszająco odświeżany przez wywołanie funkcji currentUser.getIdToken(true).

Dostęp do zapytań niestandardowych w kliencie

Zasoby niestandardowe można pobrać tylko za pomocą tokena identyfikacyjnego użytkownika. Dostęp do tych roszczeń może być konieczny do modyfikowania interfejsu klienta na podstawie roli użytkownika lub poziomu dostępu. Jednak dostęp do zaplecza powinien być zawsze wymuszany za pomocą tokena identyfikacyjnego po jego zweryfikowaniu i przeanalizowaniu informacji. Niestandardowych roszczeń nie należy wysyłać bezpośrednio do backendu, ponieważ nie można im ufać poza tokenem.

Gdy najnowsze oświadczenia zostaną rozpowszechnione w tokenie identyfikacyjnym użytkownika, możesz je uzyskać, pobierając token identyfikacyjny:

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];
    }
  }
}];

Sprawdzone metody dotyczące roszczeń niestandardowych

Zasady niestandardowe są używane tylko do kontrolowania dostępu. Nie są one przeznaczone do przechowywania dodatkowych danych (takich jak dane profilu i inne dane niestandardowe). Może się to wydawać wygodnym mechanizmem, ale zdecydowanie odradzamy to, ponieważ te oświadczenia są przechowywane w identyfikatorze ID i mogą powodować problemy z wydajnością, ponieważ wszystkie uwierzytelnione żądania zawsze zawierają identyfikator Firebase ID odpowiadający zalogowanemu użytkownikowi.

  • Używaj niestandardowych roszczeń, aby przechowywać dane tylko do kontrolowania dostępu użytkowników. Wszystkie inne dane powinny być przechowywane oddzielnie w bazie danych w czasie rzeczywistym lub w innej pamięci po stronie serwera.
  • Wielkość powiadomień niestandardowych jest ograniczona. Przekazywanie ładunku niestandardowych roszczeń o rozmiary większych niż 1000 bajtów spowoduje błąd.

Przykłady i przypadki użycia

Poniższe przykłady pokazują oświadczenia niestandardowe w kontekście konkretnych zastosowań Firebase.

Definiowanie ról za pomocą funkcji Firebase podczas tworzenia użytkownika

W tym przykładzie roszczenia niestandardowe są ustawiane dla użytkownika podczas tworzenia za pomocą elementu Cloud Functions.

Zastrzeżenia niestandardowe można dodawać za pomocą elementu Cloud Functions i rozpowszechniać natychmiast za pomocą elementu Realtime Database. Funkcja jest wywoływana tylko podczas rejestracji za pomocą onCreate triggera. Po ustawieniu niestandardowych roszczeń są one propagowane do wszystkich istniejących i przyszłych sesji. Gdy użytkownik zaloguje się ponownie, token będzie zawierać oświadczenia niestandardowe.

Implementacja po stronie klienta (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 Functionslogika

Dodawany jest nowy węzeł bazy danych (metadata/($uid)) z ograniczonym dostępem do odczytu/zapisu tylko dla uwierzytelnionego użytkownika.

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

Reguły bazy danych

{
  "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
      }
    }
  }
}

Definiowanie ról za pomocą żądania HTTP

W tym przykładzie za pomocą żądania HTTP ustawiasz niestandardowe oświadczenia użytkownika dotyczące nowo zalogowanego użytkownika.

Implementacja po stronie klienta (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);
});

Implementacja backendu (pakiet 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' }));
  }
});

Tego samego procesu możesz użyć, aby podnieść poziom dostępu istniejącego użytkownika. Weźmy na przykład użytkownika, który korzysta z bezpłatnej wersji aplikacji, a chce przejść na płatną subskrypcję. Identyfikator użytkownika jest wysyłany wraz z informacjami o płatności do serwera backendu za pomocą żądania HTTP. Gdy płatność zostanie przetworzona, użytkownik zostanie oznaczony jako płatny subskrybent za pomocą interfejsu Admin SDK. Klientowi zwracana jest pomyślna odpowiedź HTTP, aby wymusić odświeżenie tokena.

Definiowanie ról za pomocą skryptu backendu

Aby zaktualizować niestandardowe oświadczenia użytkownika, możesz uruchomić skrypt cykliczny (nieinicjowany przez klienta):

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

}
auth.go

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

Za pomocą pakietu Admin SDK możesz też modyfikować atrybuty niestandardowe:

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

}
auth.go

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