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

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

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

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

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

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

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

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

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

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

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

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

# 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

// 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 байт.

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

// Verify the ID token first.
getAuth()
  .verifyIdToken(idToken)
  .then((claims) => {
    if (claims.admin === true) {
      // Allow access to requested admin resource.
    }
  });

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

# 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

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

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

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

// Lookup the user associated with the specified uid.
UserRecord user = FirebaseAuth.getInstance().getUser(uid);
System.out.println(user.getCustomClaims().get("admin"));

# 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

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

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

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

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

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

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

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.

Пользовательские претензии можно добавлять с помощью облачных функций и немедленно распространять с помощью базы данных реального времени. Функция вызывается только при регистрации с использованием триггера 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);
  }
});

Логика облачных функций

Добавлен новый узел базы данных (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 возвращается клиенту, чтобы принудительно обновить токен.

Определение ролей через внутренний скрипт

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

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

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

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

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:

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

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

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

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