JSON- LD 文档装入器 (@数字证书/安全-文件装入器)

一个安全而方便的JSON-LD文档加载器,用于Node.js,浏览器和React Introduct.

目录

• 背景情况
• 警卫
• 安装
• 使用量
• 贡献
• 许可证

背景情况

包含的功能 :

• 封装上下文 :
  • Did, VC 1.0, DCC, 打开徽章 v3, ed25519 和 x25519 密码套件上下文
• 解析器用于 did:key 财务报告和审定财务报表 did:web
• 可选地从网络上加载任意背景(参见 Usage).

警卫

传统发展

安装

• 建议节点.js 16+.

国家预防机制

通过国家预防机制安装:

npm install @digitalcredentials/security-document-loader

发展

在当地安装(用于开发):

git clone https://github.com/digitalcredentials/security-document-loader.git
cd security-document-loader
npm install

使用量

要获得默认的文档加载器( 包含捆绑上下文的库存) :

import { securityLoader } from '@digitalcredentials/security-document-loader'

const documentLoader = securityLoader().build()

添加其他上下文:

import { securityLoader } from '@digitalcredentials/security-document-loader'

const loader = securityLoader()
loader.addStatic('https://example.com/my-context/v1', contextObject)

const documentLoader = loader.build()

从网络获取

允许从网络获取任意背景( 如果您可以, 不推荐) 避开它:

const documentLoader = securityLoader({ fetchRemoteContexts: true }).build()

支持的 URL 协议处理器

在框外,此库支持加载以下文档:

• 从静态本地缓存中明确添加 URL( 即您需要的) 明确通过 loader.addStatic(中文(简体) )
• 文件是否使用 did:key 财务报告和审定财务报表 did:web 方法。 。 .

另外,如果你的用例允许的话,你可以启用 fetchRemoteContexts, (中文(简体) ), 将使用 http 财务报告和审定财务报表 https 协议(见 上一节).

添加自定义协议处理器

有时您需要与其他 URL 协议一起添加文档 。 如果你有的话 解决这些协议的内部代码(例如,你可以获取一些 urn: 来自本地数据库的文档,您可以编写自定义协议 处理器 :

import { securityLoader } from '@digitalcredentials/security-document-loader'

function getDocument (url) {
  // Some internal function that fetches or creates documents
}

const customResolver = {
  /**
   * @param {object} options - Options hashmap.
   * @param {string} options.url - Document URL (here `urn:...` key id)
   * @returns {Promise<object>} - Resolves with key object document.
   */
  async get(params: Record<string, string>): Promise<unknown> {
    let document
    try {
      document = await getDocument(params.url)
    } catch(e) {
      throw new Error('NotFoundError')
    }

    return document
  }
};

// For example, use your `getDocument` function to resolve all `urn:` URIs:
securityLoader.setProtocolHandler({protocol: 'urn', handler: customResolver})

const documentLoader = securityLoader().build()

贡献

公关接受.

请遵照 标准读取 规格.

许可证

MIT 许可证 2022数字地证集团.