Как управлять доступом с помощью специальных утверждений и правил безопасности

Firebase Admin SDK позволяет определять настраиваемые атрибуты в аккаунтах пользователей. Это позволяет реализовывать различные стратегии контроля доступа, включая контроль доступа на основе ролей, в приложениях Firebase. Эти настраиваемые атрибуты могут предоставлять пользователям разные уровни доступа (роли), которые применяются в правилах безопасности приложения.

Роли пользователей можно определить для следующих распространенных случаев:

  • Предоставление пользователю прав администратора для доступа к данным и ресурсам.
  • Определение разных групп, к которым принадлежит пользователь.
  • Предоставление многоуровневого доступа:
    • Различать платных и бесплатных подписчиков.
    • Отличие модераторов от обычных пользователей.
    • Заявка преподавателя/учащегося и т. д.
  • Добавьте дополнительный идентификатор пользователя. Например, пользователь Firebase может быть сопоставлен с другим UID в другой системе.

Рассмотрим случай, когда вы хотите ограничить доступ к узлу базы данных adminContent. Вы можете сделать это с помощью поиска в базе данных по списку администраторов. Однако вы можете достичь той же цели более эффективно, используя настраиваемое утверждение пользователя с именем admin и следующим правилом Realtime Database:

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

Специальные утверждения пользователей доступны через токены аутентификации пользователей. В приведенном выше примере только пользователи, у которых в утверждении токена для admin задано значение true, будут иметь доступ на чтение и запись к узлу adminContent. Поскольку токен идентификации уже содержит эти утверждения, для проверки разрешений администратора не требуется дополнительная обработка или поиск. Кроме того, токен идентификации – это надежный механизм для передачи таких специальных утверждений. При любом доступе с аутентификацией необходимо проверять токен идентификации перед обработкой связанного запроса.

Примеры кода и решения, описанные на этой странице, основаны на клиентских API Firebase Auth и серверных API Auth, предоставляемых Admin SDK.

Как задавать и проверять настраиваемые утверждения пользователей с помощью Admin SDK

Пользовательские утверждения могут содержать конфиденциальные данные, поэтому их следует задавать только из привилегированной серверной среды с помощью Firebase Admin SDK.

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.

Проложить маршрут

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

Объект пользовательских утверждений не должен содержать зарезервированные имена ключей OIDC или зарезервированные имена Firebase. Размер полезной нагрузки не должен превышать 1000 байт. Специальные утверждения должны быть сериализуемыми в JSON. Поддерживаются строки, числа, логические значения, массивы, объекты и null. Неподдерживаемые типы, такие как Date, undefined, функции или другие значения, не относящиеся к JSON, вызовут ошибки.

Токен идентификатора, отправленный на бэкенд-сервер, может подтвердить личность пользователя и уровень доступа с помощью Admin SDK следующим образом:

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

Проложить маршрут

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

Вы также можете проверить существующие пользовательские утверждения, которые доступны как свойство объекта пользователя:

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

Проложить маршрут

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

Вы можете удалить пользовательские утверждения, передав значение null для customClaims.

Передавать клиенту настраиваемые утверждения

После того как новые утверждения будут изменены в аккаунте пользователя с помощью Admin SDK, они будут переданы аутентифицированному пользователю на стороне клиента с помощью токена идентификации следующими способами:

  • Пользователь выполняет вход или повторную аутентификацию после изменения настраиваемых утверждений. Токен идентификатора, выпущенный в результате, будет содержать последние утверждения.
  • Токен идентификации существующего сеанса пользователя обновляется после истечения срока действия старого токена.
  • Токен идентификатора принудительно обновляется путем вызова currentUser.getIdToken(true).

Как получить доступ к пользовательским утверждениям на клиенте

Специальные утверждения можно получить только через токен идентификатора пользователя. Доступ к этим утверждениям может потребоваться для изменения пользовательского интерфейса клиента в зависимости от роли или уровня доступа пользователя. Однако доступ к серверной части всегда должен осуществляться через токен идентификации после его проверки и анализа утверждений. Специальные утверждения не следует отправлять непосредственно в серверную часть, поскольку им нельзя доверять за пределами токена.

Когда последние утверждения будут переданы в токен идентификатора пользователя, вы сможете получить их, извлекая токен идентификатора:

JavaScript

import { getAuth } from "firebase/auth";
getAuth().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];
    }
  }
}];

Рекомендации по работе с заявками, созданными вручную

Специальные утверждения используются только для контроля доступа. Они не предназначены для хранения дополнительных данных, например профилей и других пользовательских данных. Хотя это может показаться удобным механизмом, делать это настоятельно не рекомендуется, поскольку эти утверждения хранятся в токене идентификатора и могут вызвать проблемы с производительностью, поскольку все аутентифицированные запросы всегда содержат токен идентификатора Firebase, соответствующий вошедшему в систему пользователю.

  • Используйте настраиваемые утверждения только для хранения данных, необходимых для управления доступом пользователей. Все остальные данные должны храниться отдельно в базе данных реального времени или другом хранилище на стороне сервера.
  • Размер пользовательских утверждений ограничен. Если размер полезной нагрузки превышает 1000 байт, будет возвращена ошибка.

Примеры и варианты использования

Ниже приведены примеры использования пользовательских утверждений в Firebase.

Определение ролей с помощью Firebase Functions при создании пользователя

В этом примере пользовательские утверждения задаются для пользователя при создании с помощью Cloud Functions.

Специальные утверждения можно добавлять с помощью Cloud Functions и сразу же распространять с помощью Realtime Database. Функция вызывается только при регистрации с помощью триггера onCreate. После настройки пользовательские утверждения распространяются на все существующие и будущие сеансы. При следующем входе пользователя с его учетными данными токен будет содержать настраиваемые утверждения.

Реализация на стороне клиента (JavaScript)

import { GoogleAuthProvider, signInWithPopup, getAuth, onAuthStateChanged } from "firebase/auth";
import { getDatabase, onValue, ref } from "firebase/database";

const auth = getAuth();
const database = getDatabase();

const provider = new GoogleAuthProvider();

signInWithPopup(auth, provider).catch(error => {
  console.log(error);
});

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

Логика Cloud Functions

Добавлен новый узел базы данных (metadata/($uid)} с доступом на чтение и запись, ограниченным аутентифицированным пользователем.

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

Правила базы данных

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

Определение ролей с помощью HTTP-запроса

В примере ниже показано, как задать пользовательские утверждения для пользователя, который только что вошел в систему, с помощью HTTP-запроса.

Реализация на стороне клиента (JavaScript)

import { GoogleAuthProvider, signInWithPopup, getAuth, onAuthStateChanged } from "firebase/auth";
import { getDatabase, onValue, ref } from "firebase/database";

const auth = getAuth();
const database = getDatabase();

const provider = new GoogleAuthProvider();

signInWithPopup(auth, 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.
          auth.currentUser.getIdToken(true);
        }
      }
    });
}).catch((error) => {
  console.log(error);
});

Реализация на сервере (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' }));
  }
});

Аналогичным образом можно повысить уровень доступа существующего пользователя. Например, пользователь переходит с бесплатной версии на платную подписку. Токен идентификатора пользователя отправляется вместе с платежными данными на бэкенд-сервер через HTTP-запрос. После успешной обработки платежа пользователь получает статус платного подписчика через Admin SDK. Клиенту возвращается успешный HTTP-ответ, чтобы принудительно обновить токен.

Определение ролей с помощью серверного скрипта

Для обновления пользовательских утверждений можно настроить повторяющийся скрипт (не инициируемый клиентом):

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

Проложить маршрут

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

Пользовательские утверждения также можно изменять постепенно с помощью 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)

Проложить маршрут

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