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

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

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

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

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

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

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

Примеры кода и решения, описанные на этой странице, основаны как на клиентских API аутентификации Firebase, так и на серверных API аутентификации, предоставляемых 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.
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.

Объект пользовательских утверждений не должен содержать зарезервированных имен ключей 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.
	}
}
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.
    }
}

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

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

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 

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

Быстрый 

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

Передовые методы обработки таможенных деклараций

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

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

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

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

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

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

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

Реализация на стороне клиента (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

Добавлен новый узел базы данных (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) 

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

Реализация бэкэнда (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)
	}

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

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

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