https.CallableOptions interface

可在 Callable HTTPS 函数上设置的选项。

签名

export interface CallableOptions extends HttpsOptions 

扩展HttpsOptions

属性

属性 类型 说明
consumeAppCheckToken 布尔值 确定是否根据请求使用 Firebase App Check 令牌。默认值为 false。
enforceAppCheck 布尔值 确定是否强制执行 Firebase AppCheck。如果为 true,包含无效令牌的请求会自动响应 401(未授权)错误。如果为 false,包含无效令牌的请求会将 event.app 设置为“undefiend”。

https.CallableOptions.consumeAppCheckToken

确定是否根据请求使用 Firebase App Check 令牌。默认值为 false。

将此项设为 true 即可通过对可调用的请求使用 App Check 令牌,启用 App Check 重放攻击保护功能。如果发现令牌已被使用,则 request.app.AlreadyConsumed 属性设置为 true。

仅当令牌发送到 App Check 服务时(将此选项设置为 true),令牌才会被视为已使用。使用其他令牌时不会消耗令牌。

此重放攻击防范功能需要对 App Check 后端进行额外的网络调用,并强制客户端从所选证明提供方获取新的证明。因此可能会对性能产生负面影响,并可能耗尽证明提供方的更快获得配额仅将此功能用于保护数量较少、对安全性要求至关重要或成本高昂的操作。

此选项不会影响 executeAppCheck 选项。如果将后者设置为 true,则当请求包含无效的 App Check 令牌时,Callable 函数会自动返回 401 Unauthorized 状态代码。如果请求包含有效但已使用的 App Check 令牌,系统不会自动拒绝请求。相反, request.app. alreadyConsumed 属性将设置为 true,并将执行传递给处理程序代码以做出进一步决策,例如要求进行额外的安全检查或拒绝请求。

签名

consumeAppCheckToken?: boolean;

https.CallableOptions.enforceAppCheck

确定是否强制执行 Firebase AppCheck。如果为 true,包含无效令牌的请求会自动响应 401(未授权)错误。如果为 false,包含无效令牌的请求会将 event.app 设置为“undefiend”。

签名

enforceAppCheck?: boolean;