@digitalcredentials/data-integrity

中文文档
2.6.0发布于 2025/05/01MITES Module近 30 天下载 9901

用于Jsonld签名的数据完整性证明库.

中文使用文档
文档目录7 节
  1. 目录
  2. 背景情况
  3. 警卫
  4. 安装
  5. 使用量
  6. 贡献
  7. 许可证

数据完整性库 (@数字证书/数据集成)

Build status NPM Version

用于密码套件和jsonld签名的数据集库.

注意, 这是 @ digitalbazaar/ data- integrity 的分叉, 它通过在软件包中添加一个反应- native subject, 在本地兼容的sha256 digest 库中 shims。 它还将@digitalbazaar依赖性替换为@digitalcredential forks,它们反过来会支持本地反应.

目录

背景情况

用于与 https://github.com/数字证书/jsonld-签名 v11.0及以上编.

另见相关的规格:

警卫

传统发展

安装

  • 浏览器和Node.js 18+得到支持.

从国家预防机制安装:

npm install @digitalbazaar/data-integrity

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

git clone https://github.com/digitalbazaar/data-integrity.git
cd data-integrity
npm install

使用量

以下代码片段提供了一个完整的数字签名示例 使用此库的可核查证书:

import * as Ed25519Multikey from '@digitalcredentials/ed25519-multikey';
import {DataIntegrityProof} from '@digitalcredentials/data-integrity';
import {cryptosuite as eddsa2022CryptoSuite} from
  '@digitalcredentials/eddsa-2022-cryptosuite';
import jsigs from '@digitalcredentials/jsonld-signatures';
const {purposes: {AssertionProofPurpose}} = jsigs;


// create the unsigned credential
const unsignedCredential = {
  '@context': [
    'https://www.w3.org/2018/credentials/v1',
    {
      AlumniCredential: 'https://schema.org#AlumniCredential',
      alumniOf: 'https://schema.org#alumniOf'
    }
  ],
  id: 'http://example.edu/credentials/1872',
  type: [ 'VerifiableCredential', 'AlumniCredential' ],
  issuer: 'https://example.edu/issuers/565049',
  issuanceDate: '2010-01-01T19:23:24Z',
  credentialSubject: {
    id: 'https://example.edu/students/alice',
    alumniOf: 'Example University'
  }
};

// create the keypair to use when signing
const controller = 'https://example.edu/issuers/565049';
const keyPair = await Ed25519Multikey.from({
  '@context': 'https://w3id.org/security/multikey/v1',
  type: 'Multikey',
  controller,
  id: controller + '#z6MkwXG2WjeQnNxSoynSGYU8V9j3QzP3JSqhdmkHc6SaVWoT',
  publicKeyMultibase: 'z6MkwXG2WjeQnNxSoynSGYU8V9j3QzP3JSqhdmkHc6SaVWoT',
  secretKeyMultibase: 'zrv3rbPamVDGvrm7LkYPLWYJ35P9audujKKsWn3x29EUiGwwhdZQd' +
    '1iHhrsmZidtVALBQmhX3j9E5Fvx6Kr29DPt6LH'
});

// export public key and add to document loader
const publicKey = await keyPair.export({publicKey: true, includeContext: true});
addDocumentToLoader({url: publicKey.id, document: publicKey});

// create key's controller document
const controllerDoc = {
  '@context': [
    'https://www.w3.org/ns/did/v1',
    'https://w3id.org/security/multikey/v1'
  ],
  id: controller,
  assertionMethod: [publicKey]
};
addDocumentToLoader({url: controllerDoc.id, document: controllerDoc});

// create suite
const suite = new DataIntegrityProof({
  signer: keyPair.signer(), cryptosuite: eddsa2022CryptoSuite
});

// create signed credential
const signedCredential = await jsigs.sign(unsignedCredential, {
  suite,
  purpose: new AssertionProofPurpose(),
  documentLoader
});

// results in the following signed VC
{
  "@context": [
    "https://www.w3.org/2018/credentials/v1",
    {
      "AlumniCredential": "https://schema.org#AlumniCredential",
      "alumniOf": "https://schema.org#alumniOf"
    },
    "https://w3id.org/security/data-integrity/v2"
  ],
  "id": "http://example.edu/credentials/1872",
  "type": [
    "VerifiableCredential",
    "AlumniCredential"
  ],
  "issuer": "https://example.edu/issuers/565049",
  "issuanceDate": "2010-01-01T19:23:24Z",
  "credentialSubject": {
    "id": "https://example.edu/students/alice",
    "alumniOf": "Example University"
  },
  "proof": {
    "type": "DataIntegrityProof",
    "created": "2022-09-06T21:29:24Z",
    "verificationMethod": "https://example.edu/issuers/565049#z6MkwXG2WjeQnNxSoynSGYU8V9j3QzP3JSqhdmkHc6SaVWoT",
    "cryptosuite": "eddsa-2022",
    "proofPurpose": "assertionMethod",
    "proofValue": "zakT6XP6P7ZVAGJKjvnVi1YjC96RufyeasEEMkDQrCkvMnG3QeAqBuoVoWAWkEEd5w8FATEigPA5788ByuwnCZrd"
  }
}

注:要使用遗留的数据完整性套件创建或验证证明,请 必须通过 legacyContext: true 创建时 DataIntegrityProof 实例; 这将产生适当的遗留数据完整性背景( https://w3id.org/security/data-integrity/v1 (中文(简体) ))为用.

贡献

公关接受.

请遵照 标准读取 规格.

许可证

MIT 许可证 2025年数字证书联合会.

版本与发布记录

@digitalcredentials/data-integrity 共发布 3 个版本,首次发布于 2025/02/06;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.6.0latest2025/05/011.5 年前
2.6.0-beta.1beta2025/03/141.7 年前
2.5.1-beta.12025/02/061.8 年前

关于 @digitalcredentials/data-integrity 的常见问题

@digitalcredentials/data-integrity 是什么?

用于Jsonld签名的数据完整性证明库.

如何安装 @digitalcredentials/data-integrity?

在项目目录运行 npm install @digitalcredentials/data-integrity,或使用 pnpm add / yarn add / bun add。

@digitalcredentials/data-integrity 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/digitalcredentials__data-integrity 是否存在。

@digitalcredentials/data-integrity 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@digitalcredentials/data-integrity 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@digitalcredentials/data-integrity 可以商用吗?

@digitalcredentials/data-integrity 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@digitalcredentials/data-integrity 的下载量有多少?

根据 npm 官方下载统计,@digitalcredentials/data-integrity 在 2026/10/12 – 2026/11/10 这 30 天内被下载 9,901 次,日均约 330 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@digitalcredentials/data-integrity 还在维护吗?

最新版本 2.6.0 发布于 2025/05/01(1.5 年前);至今共发布 3 个版本,其中过去 12 个月发布了 0 个;首次发布于 2025/02/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。