可以在可调用 HTTPS 函数上设置的选项。
签名:
export interface CallableOptions extends HttpsOptions
扩展: HttpsOptions
特性
财产 | 类型 | 描述 |
---|---|---|
消耗AppCheckToken | 布尔值 | 确定是否根据请求使用 Firebase App Check 令牌。默认为 false。 |
强制应用程序检查 | 布尔值 | 确定是否强制执行 Firebase AppCheck。如果为 true,则具有无效令牌的请求会自动响应 401(未经授权)错误。如果为 false,则带有无效令牌的请求会将 event.app 设置为 undefiend。 |
https.CallableOptions.consumeAppCheckToken
确定是否根据请求使用 Firebase App Check 令牌。默认为 false。
将此设置为 true 可通过在可调用请求上使用 App Check 令牌来启用 App Check 重播保护功能。发现已被消耗的令牌会将 request.app.alreadyConsumed 属性设置为 true。
仅当通过将此选项设置为 true 将令牌发送到 App Check 服务时,令牌才被视为已消耗。令牌的其他用途不会消耗它。
此重放保护功能需要对 App Check 后端进行额外的网络调用,并强制客户端从所选证明提供商处获取新的证明。因此,这可能会对性能产生负面影响,并且可能会更快地耗尽证明提供商的配额。仅使用此功能来保护小批量、安全关键或昂贵的操作。
此选项不会影响 enforceAppCheck 选项。当请求包含无效的 App Check 令牌时,将后者设置为 true 将导致可调用函数自动响应 401 Unauthorized 状态代码。当请求包含有效但已消耗的 App Check 令牌时,请求不会被自动拒绝。相反, request.app.alreadyConsumed 属性将设置为 true 并将执行传递给处理程序代码以做出进一步的决策,例如需要额外的安全检查或拒绝请求。
签名:
consumeAppCheckToken?: boolean;
https.CallableOptions.enforceAppCheck
确定是否强制执行 Firebase AppCheck。如果为 true,则具有无效令牌的请求会自动响应 401(未经授权)错误。如果为 false,则带有无效令牌的请求会将 event.app 设置为 undefiend。
签名:
enforceAppCheck?: boolean;