@digitalbazaar/security-document-loader

Core JSON-LD securityLoader (@digitalbazaar/security-document-loader)

A JSON-LD documentLoader library pre-loaded with commonly used security contexts (suites, VC, DIDs).

Table of Contents

• Background
• Security
• Install
• Usage
• Contribute
• Commercial Support
• License

Background

This is useful for unit tests, in Node.js and the browser. It includes several core contexts and DID resolvers that you might want when testing applications involving Verifiable Credentials, did:key or Veres One DIDs, as well as Ed25519 signing and verifying.

Note: This library plays a similar role to bedrock-security-context, but is intended for not just Bedrock style applications, but also for isomorphic libs, etc.

Included contexts:

• https://www.w3.org/ns/did/v1 DID Core Context v1
• https://w3id.org/veres-one/v1 Veres One DID Method Context v1
• https://www.w3.org/2018/credentials/v1 Verifiable Credentials v1
• https://w3id.org/security/suites/ed25519-2020/v1 Ed25519Signature2020 Crypto Suite
• https://w3id.org/security/suites/x25519-2020/v1 X25519VerificationKey2020 Crypto Suite

Included DID Method drivers:

• did:key (via @digitalbazaar/did-method-key)

Other required contexts and did drivers can easily be added (see Usage section below).

Security

TBD

Install

• Node.js 14+ is required.

NPM

To install via NPM:

npm install --save @digitalbazaar/security-document-loader

Development

To install locally (for development):

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

Usage

The core document loader is easily extensible. For example, to add more contexts:

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

import secCtx from '@digitalbazaar/security-context';
import webkmsCtx from 'webkms-context';
import zcapCtx from 'zcap-context';

const loader = securityLoader()
loader.addStatic(
  secCtx.SECURITY_CONTEXT_V2_URL,
  secCtx.contexts.get(secCtx.SECURITY_CONTEXT_V2_URL)
);
loader.addStatic(webkmsCtx.CONTEXT_URL, webkmsCtx.CONTEXT);
loader.addStatic(zcapCtx.CONTEXT_URL, zcapCtx.CONTEXT);

const documentLoader = loader.build();

Adding did resolvers

By default, securityLoader uses did-io's CachedResolver as a harness for multiple DID method drivers, and supports the did-method-key driver.

To add another did method driver to it:

import {securityLoader} from '@digitalbazaar/security-document-loader';
const loader = securityLoader()

loader.protocolHandlers.get('did').use(didMethodDriver);

Contribute

See the contribute file!

PRs accepted.

If editing the Readme, please conform to the standard-readme specification.

Commercial Support

Commercial support for this library is available upon request from Digital Bazaar: [e-mail]

License

New BSD License (3-clause) © Digital Bazaar

Changelog

3.0.0 - 2024-08-05

Changed

• BREAKING: Require Node.js >=18.
• Update dependencies.
  • Switch from credentials-context to @digitalbazaar/credentials-context for VC 2.0 support.
  • jsonld-document-loader@2.2.0.
  • Update minor, test, and dev dependencies.
• Use newer testing style to ensure all context packages are checked.
• Use addDocuments to simplify context loading.