did-document-ts

A library for DID Document creation.

The purpose of this library is to assist in the creation process of DID documents that comply with the decentralized identifier specification. It is also suitable to assist in the creation process of DID document templates, which are used by the bba DID method.

Table of Contents

Security

The DIDDocKey module uses Digital Bazaars crypto-ld library for key management. The key material exported by DIDDocKey's exportKeyMaterial function is compatible with the key material exported by LDKeyPairs export function. The generated keys can later be used within Digital Bazaars crypto suite.

crypto-ld is licensed under the new BSD License (3-clause).

Install

``
npm install @blobaa/did-document-ts
`

Usage

$3

``typescript
import { DIDDocKey, DIDDocKeyType } from "@blobaa/did-document-ts"


const didAlice = "did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f";
const didBob = "did:bba:0335f47981b5524ec7e441392961e383ec2cf2381c12fb0119a6782a00387868";
const didCharlie = "did:bba:0335f47981b5524ec7e441392961e3839ede9cf431d01dba07809314302e565f";


const DIDDocKeyHandling = async(): Promise => {

/ generate keys /
const keyEd25519 = new DIDDocKey({ did: didAlice });
await keyEd25519.generate();

const keyRsa = new DIDDocKey({
did: didAlice,
keyType: DIDDocKeyType.RSA,
controller: didBob
});
await keyRsa.generate();


/ export key material /
const keyRsaMaterial = await keyRsa.exportKeyMaterial();
const keyEd25519Material = await keyEd25519.exportKeyMaterial();
console.log(keyEd25519Material);
/*
{
id: 'did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f#z6MkgYRgvUMGeGApmqGQWzCi8UucQKky6x3sPcTM6YAYTNpX',
type: 'Ed25519VerificationKey2018',
controller: 'did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f',
publicKeyBase58: '36AeLE6qJigMfLRhqREsHPMcakV7h4oWhbYRGGCXYA39',
privateKeyBase58: '31MQ1dzHVcrk8YdvipnxRm4LvXT3NhJKPDRcGCAwWZgraTikhRRRdFX9rgPpVZ2GqGJXou4Cmcgx2Ztgp91MG271'
}
*/


/ import key material /
const newKeyEd25519 = new DIDDocKey({ did: "" });
newKeyEd25519.importKeyMaterial(keyEd25519Material);

const newKeyRsa = new DIDDocKey({
did: "",
keyType: DIDDocKeyType.RSA,
controller: didCharlie
});
newKeyRsa.importKeyMaterial(keyRsaMaterial);


/ publish public key /
const publicKeyRsa = newKeyRsa.publish();
console.log(publicKeyRsa);
/*
{
id: 'did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f#zAHd7WYR2n5BQCxX4U9Xdhn2gxN4bAgtS2ArnitgTyUjXhzDa',
type: 'RsaVerificationKey2018',
controller: 'did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f',
publicKeyPem: '-----BEGIN PUBLIC KEY-----\r\n' +
'MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA29r0GpDFx9pLaHJLlGGv\r\n' +
'vtf7oIMsaMAnQ+IRp/pO2FUPLf4jGpbnkUCYU+rSRUTPtnsj7Nw6jC4vU/zcc5qL\r\n' +
'PkooUWORcfmTXaKBBRrCQ+tQET1qGAhqVHPtp4kUohjOhFw3jR6vNU7WCOXxEskx\r\n' +
'8ICiju73b6eeD3lTKvXC7X6GkojKaEZKYi1F7SQm4WrbEkintIOV+SlfM5gvAZjL\r\n' +
'L8A0L44TXmMdW41pkKBE9IYoX+aDYbbWAfut7lKUHftqNs7yyHvrVdiA7euHigeD\r\n' +
'KeQ4QOS9ge7Mc0JjpZwv/p6mb6szN9kJTDWYeQK6PfuUJCEfRQqVFtwFqeW+ZzoA\r\n' +
'0wIDAQAB\r\n' +
'-----END PUBLIC KEY-----\r\n'
}
*/
};

DIDDocKeyHandling();
``

$3

``typescript
import { DIDDocKey, DIDDocRelationship, DIDDocRelationshipType, DIDDocService, DIDDocument } from "@blobaa/did-document-ts";


const didAlice = "did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f";
const didBob = "did:bba:0335f47981b5524ec7e441392961e383ec2cf2381c12fb0119a6782a00387868";


const createDIDDocument = async (): Promise => {

/ create or import DID Document public keys /
const key1 = new DIDDocKey({ did: didAlice });
const key2 = new DIDDocKey({ did: didAlice });
const key3 = new DIDDocKey({ did: didAlice });
const key4 = new DIDDocKey({ did: didAlice, controller: didBob });

await key1.generate();
await key2.generate();
await key3.generate();
await key4.generate();

const publicKey1 = key1.publish();
const publicKey2 = key2.publish();
const publicKey3 = key3.publish();
const publicKey4 = key4.publish();


/ create verification relationships (optional) /
const authentication = new DIDDocRelationship({
relationshipType: DIDDocRelationshipType.AUTHENTICATION,
publicKeysAsRef: [ publicKey1, publicKey2 ], // referenced public keys
publicKeys: [ publicKey3 ] // embedded public keys
});

const assertion = new DIDDocRelationship({
relationshipType: DIDDocRelationshipType.ASSERTION_METHOD,
publicKeysAsRef: [ publicKey1, publicKey1 ]
});

const invocation = new DIDDocRelationship({
relationshipType: DIDDocRelationshipType.CAPABILITY_INVOCATION,
publicKeys: [ publicKey4 ]
});


/ create services (optional) /
const vcService = new DIDDocService({
name: "vcs",
type: "VerifiableCredentialService",
serviceEndpoint: "https://example.com/vc/"
});

const myService = new DIDDocService({
name: "mys",
type: "MyService",
serviceEndpoint: "https://my.domain.com/mys/",
prop: "an additional custom property"
});


/ create creation and or update date (optional) /
const creationDate = new Date().toISOString();


/ create DID Document /
const document = new DIDDocument({
did: didAlice,
contexts: [ "https://my-new.awesome-context.com/my/context" ], // additional custom contexts (optional)
publicKeys: [ publicKey1, publicKey2 ], // referenced keys
relationships: [ authentication, assertion, invocation ],
services: [ vcService, myService ],
created: creationDate,
});


/ publish DID Document /
console.log(JSON.stringify(document.publish(), undefined, 4));
/*
{
"@context": [
"https://www.w3.org/ns/did/v1",
"https://w3id.org/security/v1",
"https://my-new.awesome-context.com/my/context"
],
"id": "did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f",
"publicKey": [
{
"id": "did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f#z6MkswMrgFNFvqZS5FqKMujZdVb4dunJGoYutaFLBTzeKEJK",
"type": "Ed25519VerificationKey2018",
"controller": "did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f",
"publicKeyBase58": "EV6p617pbJ4xxkzcgLminQ34pLWSrvJZCZLQMC2dQ1Ww"
},
{
"id": "did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f#z6MkpxDauiZnTaFtHE1c77YtLGXqzip9mVcVF23HxCP96vcr",
"type": "Ed25519VerificationKey2018",
"controller": "did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f",
"publicKeyBase58": "BVxYKUKM82mRAjAuRYb3VAyrB9YJMcN8Z18N7vR8BhqU"
}
],
"authentication": [
"did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f#z6MkswMrgFNFvqZS5FqKMujZdVb4dunJGoYutaFLBTzeKEJK",
"did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f#z6MkpxDauiZnTaFtHE1c77YtLGXqzip9mVcVF23HxCP96vcr",
{
"id": "did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f#z6MkohiQvyqaFmvViFjbAnHyw6EHD9pLpzcPKMyA9EM5VucU",
"type": "Ed25519VerificationKey2018",
"controller": "did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f",
"publicKeyBase58": "AFTNLjb8vES2bkttVDL95zgHPaYVR7N2dM4EJxP4agq6"
}
],
"assertionMethod": [
"did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f#z6MkswMrgFNFvqZS5FqKMujZdVb4dunJGoYutaFLBTzeKEJK",
"did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f#z6MkswMrgFNFvqZS5FqKMujZdVb4dunJGoYutaFLBTzeKEJK"
],
"capabilityInvocation": [
{
"id": "did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f#z6Mkmrjo2RqtcjRao2rhYDVD5WLKGxaGx41Ysyrgfn8Nuo76",
"type": "Ed25519VerificationKey2018",
"controller": "did:bba:0335f47981b5524ec7e441392961e383ec2cf2381c12fb0119a6782a00387868",
"publicKeyBase58": "8QUkSBbTHBw7gY1zreXNEQnKTPJRYAmCBxwkqWAMzaKi"
}
],
"service": [
{
"id": "did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f#vcs",
"type": "VerifiableCredentialService",
"serviceEndpoint": "https://example.com/vc/"
},
{
"id": "did:bba:5ca5fb0b6c59f126f674eb504b7302c69ede9cf431d01dba07809314302e565f#mys",
"type": "MyService",
"serviceEndpoint": "https://my.domain.com/mys/",
"prop": "an additional custom property"
}
],
"created": "2020-07-27T16:05:05.638Z"
}
*/
};

createDIDDocument();
``

$3

`typescript
import { DIDDocKey, DIDDocRelationship, DIDDocRelationshipType, DIDDocService, DIDDocument } from "@blobaa/did-document-ts";


const createDIDDocumentTemplate = async (): Promise => {

/ create DID Document public keys /
const key1 = new DIDDocKey();
const key2 = new DIDDocKey();

await key1.generate();
await key2.generate();

const publicKey1 = key1.publish();
const publicKey2 = key2.publish();


/ create verification relationships /
const authentication = new DIDDocRelationship({
relationshipType: DIDDocRelationshipType.AUTHENTICATION,
publicKeysAsRef: [ publicKey1 ], // referenced public keys
publicKeys: [ publicKey2 ] // embedded public keys
});


/ create services /
const myService = new DIDDocService({
name: "mys",
type: "MyService",
serviceEndpoint: "https://my.domain.com/mys/",
prop: "an additional custom property"
});


/ create DID Document /
const document = new DIDDocument({
contexts: [ "https://my-new.awesome-context.com/my/context" ],
publicKeys: [ publicKey1 ],
relationships: [ authentication ],
services: [ myService ],
});


/ publish DID Document Template /
console.log(JSON.stringify(document.publish(), undefined, 4));
/*
{
"@context": [
"https://www.w3.org/ns/did/v1",
"https://w3id.org/security/v1",
"https://my-new.awesome-context.com/my/context"
],
"id": "",
"publicKey": [
{
"id": "#z6MkoZy5Zb2RhHHJ6Ut4smTRWVzBc9HZGCNKUHxp5u7sNsrk",
"type": "Ed25519VerificationKey2018",
"publicKeyBase58": "A7i2yLmzMjnpyz3NCCVafQSBna1hrK7xnH3tFd9rTf5N"
}
],
"authentication": [
"#z6MkoZy5Zb2RhHHJ6Ut4smTRWVzBc9HZGCNKUHxp5u7sNsrk",
{
"id": "#z6MkhuK2biLQuNj4vUKZpqrWBCB4Nu9qoWnK3peNjJueWv5o",
"type": "Ed25519VerificationKey2018",
"publicKeyBase58": "4T3z1U5yZqEboyUs9GtfL6d4ZKszPdXxMojSu2wdbhJR"
}
],
"service": [
{
"id": "#mys",
"type": "MyService",
"serviceEndpoint": "https://my.domain.com/mys/",
"prop": "an additional custom property"
}
]
}
*/
};

createDIDDocumentTemplate();
`

API