Controlar o acesso com declarações personalizadas e regras de segurança

O SDK Admin do Firebase é compatível com a definição de atributos do cliente nas contas de usuários. Com isso, é possível implementar várias estratégias de controle de acesso em apps do Firebase, incluindo controle de acesso baseado em papéis. Esses atributos do cliente podem oferecer aos usuários diferentes níveis de acesso (papéis), que são aplicados nas regras de segurança de um aplicativo.

Os papéis do usuário podem ser definidos para os seguintes casos comuns:

  • Oferecer a um usuário privilégios administrativos para acessar dados e recursos.
  • Definir diferentes grupos aos quais um usuário pertence.
  • Fornecer acesso em vários níveis:
    • Diferenciar inscritos pagos/não pagos.
    • Diferenciar moderadores de usuários comuns.
    • Aplicativo de professor/aluno etc.
  • Adicionar um identificador em um usuário. Por exemplo, um usuário do Firebase pode mapear para um UID diferente em outro sistema.

Pense no seguinte caso: você quer limitar o acesso ao node do banco de dados "adminContent". Você poderia fazer isso com uma pesquisa de banco de dados em uma lista de usuários administradores. No entanto, é possível alcançar o mesmo objetivo com mais eficiência usando uma declaração de usuário personalizada chamada admin com a seguinte regra Realtime Database:

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

As declarações personalizadas dos usuários podem ser acessadas usando os tokens de autenticação. No exemplo acima, apenas os usuários com admin definido como verdadeiro na declaração do token têm acesso de leitura/gravação ao nó adminContent. Como o token de ID já contém essas afirmações, nenhum processamento ou pesquisa adicional é necessário para verificar as permissões de administrador. Além disso, o token de código é um mecanismo confiável para entregar essas declarações personalizadas. Todo acesso autenticado precisa validar o token de ID antes de processar a solicitação associada.

Os exemplos de código e soluções descritos nesta página são extraídos das APIs do Firebase Auth tanto do lado do cliente quanto do servidor, que são fornecidas pelo SDK Admin.

Definir e validar declarações personalizadas do usuário por meio do SDK Admin

As declarações personalizadas podem conter dados confidenciais. Portanto, elas devem ser definidas apenas em um ambiente de servidor privilegiado pelo SDK Admin do Firebase.

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.

O objeto de declarações personalizadas não pode conter nenhum nome de chave reservado do OIDC (em inglês) ou nomes reservados do Firebase. O payload de declarações personalizadas não pode exceder 1.000 bytes.

Um token de ID enviado para um servidor de back-end pode confirmar a identidade e o nível de acesso do usuário usando o SDK Admin da seguinte maneira:

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

Você também pode verificar as declarações personalizadas de um usuário, que estão disponíveis como uma propriedade no objeto do usuário:

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

É possível excluir as declarações personalizadas de um usuário ao transmitir um valor nulo para customClaims.

Propagar declarações personalizadas para o cliente

Depois que novas declarações são modificadas em um usuário usando o SDK Admin, elas são propagadas para um usuário autenticado do lado do cliente utilizando o token de ID das seguintes maneiras:

  • Um usuário faz login ou se autentica novamente depois que as declarações personalizadas são modificadas. O token de código emitido como resultado conterá as declarações mais recentes.
  • Uma sessão de usuário existente tem o token de ID atualizado depois que um token antigo expira.
  • Um token de ID é atualizado à força ao chamar currentUser.getIdToken(true).

Acessar declarações personalizadas no cliente

As declarações personalizadas só podem ser recuperadas usando o token de ID do usuário. O acesso a essas declarações pode ser necessário para modificar a IU do cliente com base no nível de acesso ou do papel do usuário. No entanto, o acesso ao back-end precisa ser aplicado sempre por meio do token de código após a validação dele e a análise das declarações dele. As declarações personalizadas não podem ser enviadas diretamente para o back-end, já que não podem ser confiáveis fora do token.

Depois que as declarações mais recentes forem propagadas para o token de ID do usuário, recupere esse token para consegui-las:

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

Práticas recomendadas para declarações personalizadas

As declarações personalizadas são usadas apenas para fornecer controle de acesso. Elas não foram projetadas para armazenar dados adicionais (como perfil e outros dados personalizados). Esse mecanismo pode parecer conveniente para fazer isso, mas não é recomendável, uma vez que essas declarações são armazenadas no token de ID e podem causar problemas de desempenho, já que todas as solicitações autenticadas contêm sempre um token de ID do Firebase correspondente ao usuário que fez login.

  • Use declarações personalizadas somente para armazenar dados de controle do acesso do usuário. Todos os outros dados precisam ser armazenados separadamente por meio do banco de dados em tempo real ou outro armazenamento do lado do servidor.
  • As declarações personalizadas são de tamanho limitado. Passar um payload de declarações personalizadas superior a 1.000 bytes provocará um erro.

Exemplos e casos de uso

Os exemplos a seguir ilustram declarações personalizadas no contexto de casos de uso específicos do Firebase.

Como definir papéis usando o Firebase Functions na criação de usuários

Neste exemplo, as declarações personalizadas são definidas para um usuário na criação usando Cloud Functions.

As declarações personalizadas podem ser adicionadas usando Cloud Functions e propagadas imediatamente com Realtime Database. A função é chamada apenas ao fazer login usando um acionador onCreate. Depois que as declarações personalizadas são definidas, elas se propagam para todas as sessões atuais e futuras. Na próxima vez que o usuário entrar com a credencial, o token conterá as declarações personalizadas.

Implementação do lado do cliente (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);
  }
});

Lógica Cloud Functions

Um novo node de banco de dados (metadados/($uid)} com leitura/gravação restrita ao usuário autenticado é adicionado.

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

Regras do banco de dados

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

Como definir papéis usando uma solicitação HTTP

No exemplo a seguir, definimos declarações personalizadas em um usuário que acabou de fazer login usando uma solicitação HTTP.

Implementação do lado do cliente (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);
});

Implementação de back-end (SDK Admin)

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

O mesmo fluxo pode ser usado durante o upgrade do nível de acesso de um usuário existente. Tome como exemplo um usuário que usa a versão sem custos fazendo upgrade para uma assinatura paga. O token de ID do usuário é enviado com as informações de pagamento para o servidor de back-end usando uma solicitação HTTP. Quando o pagamento é processado, o usuário é definido como assinante por meio do SDK Admin. Uma resposta HTTP bem-sucedida é retornada ao cliente para forçar a atualização do token.

Como definir papéis por meio do script de back-end

Um script recorrente (não iniciado do cliente) pode ser configurado para ser executado a fim de atualizar declarações personalizadas do usuário:

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

As declarações personalizadas também podem ser modificadas de modo incremental por meio do SDK Admin:

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