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. Pozwala to wdrażać różne strategie kontroli dostępu, w tym kontrolę dostępu opartą na rolach, w aplikacjach Firebase. 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żytkownika można zdefiniować w tych typowych przypadkach:

  • Przyznawanie użytkownikowi uprawnień administratora z dostępem do danych i zasobów.
  • Definiowanie różnych grup, do których należy użytkownik.
  • Zapewnianie dostępu wielopoziomowego:
    • Rozróżnianie płatnych i bezpłatnych subskrybentów
    • odróżnianie moderatorów od zwykłych użytkowników.
    • Zgłoszenie nauczyciela/ucznia itp.
  • Dodaj dodatkowy identyfikator użytkownika. Na przykład użytkownik Firebase może zmapować go na inny identyfikator UID w innym systemie.

Przeanalizujmy przypadek, w którym chcesz ograniczyć dostęp do węzła bazy danych „adminContent”. Można to zrobić, wyszukując w bazie danych listę administratorów. Możesz jednak efektywniej osiągnąć ten sam cel, wykorzystując niestandardowe roszczenie użytkownika o nazwie admin z następującą regułą Realtime Database:

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

Niestandardowe deklaracje użytkowników są dostępne za pomocą tokenów uwierzytelniania użytkownika. W powyższym przykładzie tylko użytkownicy, którzy w deklaracji tokena admin mają wartość „true” (prawda). miałby odczyt/zapis dostęp do węzła adminContent. Token identyfikatora zawiera już te wartości asercji, nie jest potrzebne dodatkowe przetwarzanie ani wyszukiwanie w celu uprawnień. Token identyfikatora to zaufany mechanizm dostarczania tych niestandardowych roszczeń. Każdy uwierzytelniony dostęp musi weryfikować token tożsamości przed do przetwarzania powiązanego żądania.

Przykłady kodu i rozwiązania opisane na tej stronie pochodzą zarówno z kodu, Interfejsy API uwierzytelniania Firebase po stronie klienta oraz interfejsy Auth API po stronie serwera dostarczane przez pakiet Admin SDK.

Ustawiaj i weryfikuj niestandardowe roszczenia użytkowników 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 deklaracji niestandardowych nie powinien zawierać żadnych Zarezerwowane nazwy kluczy OIDC lub nazwy zarezerwowane w Firebase. Ładunek roszczeń niestandardowych nie może przekraczać 1000 bajtów.

Token identyfikatora wysyłany do serwera backendu może potwierdzić tożsamość i dostęp użytkownika za pomocą pakietu Admin SDK w ten 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ć istniejące roszczenia niestandardowe użytkownika, które są dostępne w obiekcie 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"]);

Możesz usunąć żądania niestandardowe użytkownika, przekazując w polu customClaims wartość null.

Rozpowszechniaj żądania niestandardowe klientowi

Nowe roszczenia, które zostaną zmodyfikowane na koncie użytkownika za pomocą pakietu Admin SDK, są rozpowszechniane. do uwierzytelnionego użytkownika po stronie klienta za pomocą tokena identyfikatora w następujących sposoby:

  • Po zmodyfikowaniu deklaracji niestandardowych użytkownik loguje się lub ponownie uwierzytelnia. Token identyfikatora wystawiony w wyniku będzie zawierać najnowsze deklaracje.
  • Token identyfikatora istniejącej sesji użytkownika jest odświeżany po wygaśnięciu starego tokena.
  • Odświeżenie tokena identyfikatora jest wymuszane przez wywołanie metody currentUser.getIdToken(true).

Dostęp do zapytań niestandardowych na kliencie

Deklaracje niestandardowe można pobierać tylko za pomocą tokena identyfikatora użytkownika. Dostęp do tych mogą być konieczne do zmodyfikowania UI klienta w zależności od roli użytkownika lub poziom dostępu. Jednak dostęp do backendu powinien być zawsze wymuszany za pomocą identyfikatora po zweryfikowaniu go i przeanalizowaniu jego deklaracji. Niestandardowe żądania nie powinny być wysyłane bezpośrednio do backendu, ponieważ nie można ich ufać poza tokenem.

Gdy najnowsze roszczenia zostaną rozpowszechnione w tokenie identyfikatora użytkownika, możesz je pobrać przez pobieranie tokena identyfikatora:

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

Roszczenia niestandardowe są używane tylko do zapewnienia kontroli dostępu. Nie są przeznaczone do: przechowywać dodatkowe dane (takie jak profil i inne dane niestandardowe). Choć może to wydaje się wygodnym mechanizmem, zdecydowanie odradzamy, ponieważ są przechowywane w tokenie identyfikatora i mogą powodować problemy z wydajnością, ponieważ wszystkie uwierzytelnione żądania zawsze zawierają token identyfikatora Firebase odpowiadający zalogowanego użytkownika.

  • Używaj deklaracji niestandardowych do przechowywania danych tylko w celu kontrolowania dostępu użytkowników. Wszystkie pozostałe dane powinny być przechowywane oddzielnie za pomocą bazy danych czasu rzeczywistego lub innej pamięci po stronie serwera.
  • Rozmiar zastrzeżeń niestandardowych jest ograniczony. Przekazywanie niestandardowego ładunku deklaracji o rozmiarze większym 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 przy użyciu funkcji Firebase podczas tworzenia użytkowników

W tym przykładzie roszczenia niestandardowe są ustawiane względem użytkownika przy tworzeniu za pomocą polecenia Cloud Functions

Roszczenia niestandardowe można dodawać za pomocą Cloud Functions i rozpowszechniać je natychmiast dzięki Realtime Database. Funkcja jest wywoływana tylko podczas rejestracji przy użyciu funkcji onCreate . Po ustawieniu roszczeń niestandardowych zostaną one zastosowane do wszystkich istniejących kolejnych sesji. Gdy następnym razem użytkownik zaloguje się za pomocą danych logowania, token zawiera deklaracje 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

Nowy węzeł bazy danych (metadata/($uid)} z odczytem/zapisem ograniczonym do uwierzytelniony użytkownik został dodany.

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

Poniżej znajduje się przykład ustawiania niestandardowych deklaracji użytkowników dotyczących nowo zalogowanego użytkownika za pomocą Żądanie HTTP.

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

W ten sam sposób można zmieniać 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 token jest wysyłany z danymi karty do serwera backendu przez HTTP użytkownika. Jeśli płatność zostanie przetworzona, użytkownik zostanie ustawiony jako płatny subskrybenta za pomocą pakietu Admin SDK. Odpowiedź HTTP jest zwracana do aby wymusić odświeżenie tokena.

Definiowanie ról za pomocą skryptu backendu

Można ustawić uruchamianie skryptu cyklicznego (niezainicjowanego przez klienta) zaktualizuj roszczenia niestandardowe użytkownika:

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

Roszczenia niestandardowe można też modyfikować stopniowo za pomocą pakietu Admin SDK:

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