https.CallableOptions interface

Opções que podem ser definidas em uma função HTTPS que pode ser chamada.

Assinatura:

export interface CallableOptions extends HttpsOptions 

Estende: HttpsOptions

Propriedades

Propriedade Tipo Descrição
consumirAppCheckToken boleano Determina se o token do Firebase App Check é consumido mediante solicitação. O padrão é falso.
imporAppCheck boleano Determina se o Firebase AppCheck é aplicado. Quando verdadeiro, as solicitações com tokens inválidos respondem automaticamente com um erro 401 (Não autorizado). Quando falso, solicitações com tokens inválidos definem event.app como indefeso.

https.CallableOptions.consumeAppCheckToken

Determina se o token do Firebase App Check é consumido mediante solicitação. O padrão é falso.

Defina como verdadeiro para ativar o recurso de proteção de reprodução do App Check consumindo o token do App Check na solicitação que pode ser chamada. Os tokens que já foram consumidos terão a propriedade request.app.alreadyConsumed definida como verdadeira.

Os tokens só são considerados consumidos se forem enviados ao serviço App Check configurando esta opção como true. Outros usos do token não o consomem.

Esse recurso de proteção de reprodução requer uma chamada de rede adicional para o back-end do App Check e força os clientes a obter um novo atestado dos provedores de atestado escolhidos. Isso pode, portanto, impactar negativamente o desempenho e potencialmente esgotar as cotas dos seus provedores de atestados mais rapidamente. Use esse recurso apenas para proteger operações de baixo volume, críticas de segurança ou caras.

Esta opção não afeta a opção aplicarAppCheck. Definir o último como verdadeiro fará com que a função que pode ser chamada responda automaticamente com um código de status 401 Não autorizado quando a solicitação incluir um token do App Check inválido. Quando a solicitação inclui tokens do App Check válidos, mas consumidos, as solicitações não serão rejeitadas automaticamente. Em vez disso, a propriedade request.app.alreadyConsumed será definida como true e passará a execução para o código do manipulador para tomar decisões adicionais, como exigir verificações de segurança adicionais ou rejeitar a solicitação.

Assinatura:

consumeAppCheckToken?: boolean;

https.CallableOptions.enforceAppCheck

Determina se o Firebase AppCheck é aplicado. Quando verdadeiro, as solicitações com tokens inválidos respondem automaticamente com um erro 401 (Não autorizado). Quando falso, solicitações com tokens inválidos definem event.app como indefeso.

Assinatura:

enforceAppCheck?: boolean;