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

O Firebase Admin SDK oferece suporte à definição de atributos personalizados em contas de usuário. Isso permite implementar diversas estratégias de controle de acesso, incluindo controle de acesso baseado em função, em aplicativos do Firebase. Esses atributos personalizados podem fornecer aos usuários diferentes níveis de acesso (funções), que são impostos nas regras de segurança de um aplicativo.

As funções de usuário podem ser definidas para os seguintes casos comuns:

• Conceder privilégios administrativos a um usuário para acessar dados e recursos.
• Definir diferentes grupos aos quais um usuário pertence.
• Fornecimento de acesso multinível:
  • Diferenciando assinantes pagos/não pagos.
  • Diferenciando moderadores de usuários regulares.
  • Aplicação professor/aluno, etc.
• Adicione um identificador adicional a um usuário. Por exemplo, um usuário do Firebase poderia mapear para um UID diferente em outro sistema.

Vamos considerar um caso em que você deseja limitar o acesso ao nó 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, você pode atingir o mesmo objetivo com mais eficiência usando uma declaração de usuário personalizada chamada admin com a seguinte regra do Realtime Database:

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

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

Os exemplos de código e soluções descritos nesta página baseiam-se nas APIs Firebase Auth do lado do cliente e nas APIs Auth do lado do servidor fornecidas pelo Admin SDK .

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

As declarações personalizadas podem conter dados confidenciais e, portanto, só devem ser definidas em um ambiente de servidor privilegiado pelo SDK Admin do Firebase.

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

O objeto de declarações personalizado não deve conter nomes de chave reservados do OIDC ou nomes reservados do Firebase . A carga útil de declarações personalizadas não deve exceder 1.000 bytes.

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

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

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

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

Você pode excluir as declarações personalizadas de um usuário passando null para customClaims .

Propagar declarações personalizadas para o cliente

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

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

Acesse declarações personalizadas no cliente

As declarações personalizadas só podem ser recuperadas por meio do token de ID do usuário. O acesso a essas declarações pode ser necessário para modificar a interface do usuário do cliente com base na função ou no nível de acesso do usuário. No entanto, o acesso de back-end deve sempre ser aplicado por meio do token de ID após validá-lo e analisar suas declarações. As declarações personalizadas não devem ser enviadas diretamente para o back-end, pois não podem ser confiáveis ​​fora do token.

Depois que as declarações mais recentes forem propagadas para o token de ID de um usuário, você poderá obtê-las recuperando o token de ID:

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

Práticas recomendadas para declarações personalizadas

As declarações personalizadas são usadas apenas para fornecer controle de acesso. Eles não foram projetados para armazenar dados adicionais (como perfil e outros dados personalizados). Embora possa parecer um mecanismo conveniente para fazer isso, é fortemente desencorajado, pois essas declarações são armazenadas no token de ID e podem causar problemas de desempenho porque todas as solicitações autenticadas sempre contêm um token de ID do Firebase correspondente ao usuário conectado.

• Use declarações personalizadas para armazenar dados apenas para controlar o acesso do usuário. Todos os outros dados devem ser armazenados separadamente através do banco de dados em tempo real ou outro armazenamento no servidor.
• As reivindicações personalizadas são limitadas em tamanho. Passar uma carga útil de declarações personalizadas maior que 1.000 bytes gerará 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.

Definição de funções por meio do Firebase Functions na criação de usuários

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

Declarações personalizadas podem ser adicionadas usando o Cloud Functions e propagadas imediatamente com o Realtime Database. A função é chamada apenas na inscrição usando um gatilho onCreate . Depois que as declarações personalizadas forem definidas, elas serão propagadas para todas as sessões existentes e futuras. Na próxima vez que o usuário entrar com a credencial do usuário, 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 do Cloud Functions

Um novo nó 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 de 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
      }
    }
  }
}

Definindo funções por meio de uma solicitação HTTP

O exemplo a seguir define declarações de usuário personalizadas em um usuário recém-conectado por meio de 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 ao atualizar o nível de acesso de um usuário existente. Tomemos por exemplo um usuário gratuito atualizando para uma assinatura paga. O token de ID do usuário é enviado com as informações de pagamento ao servidor back-end por meio de uma solicitação HTTP. Quando o pagamento é processado com sucesso, o usuário é definido como assinante pago por meio do Admin SDK. Uma resposta HTTP bem-sucedida é retornada ao cliente para forçar a atualização do token.

Definindo funções por meio de script de back-end

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

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

As declarações personalizadas também podem ser modificadas de forma incremental por meio do 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);
}