@ clerk/ 后端核心
折旧警告
这个软件包已经贬值了,有利于异形 @clerk/backend 它现在用于所有服务器启用的办事员软件包。 此软件包今后不会收到任何更新 。 不应直接使用----请仅作为参考.
概览
此软件包为 Clave 后端 API 提供了核心资源,并为 JavaScript 环境提供了低级认证功能. 它大多被作为其他Clear SDK的基地.
开始
安装
npm install @clerk/backend-core
构建
要用 TypeScript 编译器在本地构建软件包, 请运行 :
npm run build
建筑
@clerk/backend-core 包含基本办事员功能的所有逻辑,而不作为平台/环境,具体包括:
- 确定会话的认证状态 .
- 正在验证一个办事员标志状态 .
- 办事员 API 资源管理.
如何运作
此软件包被作为Clave JavaScript SDK和环境的基础构件. 如果客户只执行一些针对环境的公用事业,则通过提供所需的所有业务逻辑来实现这一点.
实质上,客户应在办事员中提供这些关键职能 基础 财务报告和审定财务报表 办事员备份Api 类 :
- 公钥导入
importKeyFunction。 。 。 . - JWT 签字核查
verifySignatureFunction。 。 。 . - Base64 解码
decodeBase64Function。 。 。 . - HTTP 获取 API 资源管理的工具
ClerkFetcher。 。 。 .
在提供这些在 Base 财务报告和审定财务报表 ClerkBackendApi 类,您可以使用 SDK 业务逻辑所需的所有办事员公用事业.
使用量
为新的 SDK 创建基础
const importKey = async (jwk: JsonWebKey, algorithm: Algorithm) => {
// ...
};
const verifySignature = async (algorithm: Algorithm, key: CryptoKey, signature: Uint8Array, data: Uint8Array) => {
// ...
};
const decodeBase64 = (base64: string) => {
// ...
};
/** Base initialization */
const examplePlatformBase = new Base(importKey, verifySignature, decodeBase64);
创建后 Base 例如:
examplePlatformBase.verifySessionToken(...);
examplePlatformBase.getAuthState(...);
这个 Base 公用事业包括开发目标平台所需的任何额外逻辑和中间软件的构件.
验证会议标志的核准缔约方
办事员的JWT会话代号,包含azp请求,在代号生成时等于请求的起源. 您可以提供一份白名单的来源清单, 用于在每次象征性的验证中进行验证, 以保护您对子域饼干泄漏攻击的应用。 以下为例:
const authorizedParties = ['http://localhost:3000', 'https://example.com'];
examplePlatformBase.verifySessionToken(token > { authorizedParties });
API 资源
API 资源管理也由该软件包通过 办事员备份Api 课。 有关API 资源的更多信息,请查看 资源文件页面。 。 。 .
要在 JavaScript 平台上使用 Clave 后端 API 包装器, 您需要提供一些特定的 SDK 信息和 HTTP 获取工具 。 看见更多在 办事员后端 APIProps 执行.
支助
你可以以下列任何方式与我们联系:
- 加入我们的官方社团 Discord 服务器
- 打开 a GitHub 支持问题
- 列出的联系选项 我们的支持页面
捐款
我们欢迎所有社区的贡献! 如果你想以任何方式作出贡献,请阅读 我们的捐款准则。 。 。 .
警卫
@clerk/backend-core 遵循安全方面的良好做法,但不能保证100%的安全.
@clerk/backend-core 提供 "就这样" 没有 保证. 冒险使用.
欲了解更多信息并报告安全问题,请参见我们 安全记录。 。 。 .
许可证
本项目根据以下规定获得许可证: 麻省理工学院许可证。 。 。 .
见 自由主义 更多信息.